JavaScript client

The OpenSearch JavaScript (JS) client provides a safer and easier way to interact with your OpenSearch cluster. Rather than using OpenSearch from the browser and potentially exposing your data to the public, you can build an OpenSearch client that takes care of sending requests to your cluster. For the client’s complete API documentation and additional examples, see the JS client API documentation.

The client contains a library of APIs that let you perform different operations on your cluster and return a standard response body. The example here demonstrates some basic operations like creating an index, adding documents, and searching your data.

Setup

To add the client to your project, install it from npm:

  1. npm install @opensearch-project/opensearch

copy

To install a specific major version of the client, run the following command:

  1. npm install @opensearch-project/opensearch@<version>

copy

If you prefer to add the client manually or just want to examine the source code, see opensearch-js on GitHub.

Then require the client:

  1. const { Client } = require("@opensearch-project/opensearch");

copy

Connecting to OpenSearch

To connect to the default OpenSearch host, create a client object with the address https://localhost:9200 if you are using the Security plugin:

  1. var host = "localhost";
  2. var protocol = "https";
  3. var port = 9200;
  4. var auth = "admin:admin"; // For testing only. Don't store credentials in code.
  5. var ca_certs_path = "/full/path/to/root-ca.pem";
  7. // Optional client certificates if you don't want to use HTTP basic authentication.
  8. // var client_cert_path = '/full/path/to/client.pem'
  9. // var client_key_path = '/full/path/to/client-key.pem'
  11. // Create a client with SSL/TLS enabled.
  12. var { Client } = require("@opensearch-project/opensearch");
  13. var fs = require("fs");
  14. var client = new Client({
  15.   node: protocol + "://" + auth + "@" + host + ":" + port,
  16.   ssl: {
  17.     ca: fs.readFileSync(ca_certs_path),
  18.     // You can turn off certificate verification (rejectUnauthorized: false) if you're using 
  19.     // self-signed certificates with a hostname mismatch.
  20.     // cert: fs.readFileSync(client_cert_path),
  21.     // key: fs.readFileSync(client_key_path)
  22.   },
  23. });

copy

Creating an index

To create an OpenSearch index, use the indices.create() method. You can use the following code to construct a JSON object with custom settings:

  1. var index_name = "books";
  3. var settings = {
  4.   settings: {
  5.     index: {
  6.       number_of_shards: 4,
  7.       number_of_replicas: 3,
  8.     },
  9.   },
  10. };
  12. var response = await client.indices.create({
  13.   index: index_name,
  14.   body: settings,
  15. });

copy

Indexing a document

You can index a document into OpenSearch using the client’s index method:

  1. var document = {
  2.   title: "The Outsider",
  3.   author: "Stephen King",
  4.   year: "2018",
  5.   genre: "Crime fiction",
  6. };
  8. var id = "1";
  10. var response = await client.index({
  11.   id: id,
  12.   index: index_name,
  13.   body: document,
  14.   refresh: true,
  15. });

copy

Searching for documents

The easiest way to search for documents is to construct a query string. The following code uses a match query to search for “The Outsider” in the title field:

  1. var query = {
  2.   query: {
  3.     match: {
  4.       title: {
  5.         query: "The Outsider",
  6.       },
  7.     },
  8.   },
  9. };
  11. var response = await client.search({
  12.   index: index_name,
  13.   body: query,
  14. });

copy

Deleting a document

You can delete a document using the client’s delete method:

  1. var response = await client.delete({
  2.   index: index_name,
  3.   id: id,
  4. });

copy

Deleting an index

You can delete an index using the indices.delete() method:

  1. var response = await client.indices.delete({
  2.   index: index_name,
  3. });

copy

Sample program

The following sample program creates a client, adds an index with non-default settings, inserts a document, searches for the document, deletes the document, and then deletes the index:

  1. "use strict";
  3. var host = "localhost";
  4. var protocol = "https";
  5. var port = 9200;
  6. var auth = "admin:admin"; // For testing only. Don't store credentials in code.
  7. var ca_certs_path = "/full/path/to/root-ca.pem";
  9. // Optional client certificates if you don't want to use HTTP basic authentication.
  10. // var client_cert_path = '/full/path/to/client.pem'
  11. // var client_key_path = '/full/path/to/client-key.pem'
  13. // Create a client with SSL/TLS enabled.
  14. var { Client } = require("@opensearch-project/opensearch");
  15. var fs = require("fs");
  16. var client = new Client({
  17.   node: protocol + "://" + auth + "@" + host + ":" + port,
  18.   ssl: {
  19.     ca: fs.readFileSync(ca_certs_path),
  20.     // You can turn off certificate verification (rejectUnauthorized: false) if you're using 
  21.     // self-signed certificates with a hostname mismatch.
  22.     // cert: fs.readFileSync(client_cert_path),
  23.     // key: fs.readFileSync(client_key_path)
  24.   },
  25. });
  27. async function search() {
  28.   // Create an index with non-default settings.
  29.   var index_name = "books";
  31.   var settings = {
  32.     settings: {
  33.       index: {
  34.         number_of_shards: 4,
  35.         number_of_replicas: 3,
  36.       },
  37.     },
  38.   };
  40.   var response = await client.indices.create({
  41.     index: index_name,
  42.     body: settings,
  43.   });
  45.   console.log("Creating index:");
  46.   console.log(response.body);
  48.   // Add a document to the index.
  49.   var document = {
  50.     title: "The Outsider",
  51.     author: "Stephen King",
  52.     year: "2018",
  53.     genre: "Crime fiction",
  54.   };
  56.   var id = "1";
  58.   var response = await client.index({
  59.     id: id,
  60.     index: index_name,
  61.     body: document,
  62.     refresh: true,
  63.   });
  65.   console.log("Adding document:");
  66.   console.log(response.body);
  68.   // Search for the document.
  69.   var query = {
  70.     query: {
  71.       match: {
  72.         title: {
  73.           query: "The Outsider",
  74.         },
  75.       },
  76.     },
  77.   };
  79.   var response = await client.search({
  80.     index: index_name,
  81.     body: query,
  82.   });
  84.   console.log("Search results:");
  85.   console.log(response.body.hits);
  87.   // Delete the document.
  88.   var response = await client.delete({
  89.     index: index_name,
  90.     id: id,
  91.   });
  93.   console.log("Deleting document:");
  94.   console.log(response.body);
  96.   // Delete the index.
  97.   var response = await client.indices.delete({
  98.     index: index_name,
  99.   });
  101.   console.log("Deleting index:");
  102.   console.log(response.body);
  103. }
  105. search().catch(console.log);

copy

Authenticating with Amazon OpenSearch Service – AWS Sigv4

Use the following code to authenticate with AWS V2 SDK:

  1. const AWS = require('aws-sdk'); // V2 SDK.
  2. const { Client } = require('@opensearch-project/opensearch');
  3. const { AwsSigv4Signer } = require('@opensearch-project/opensearch/aws');
  5. const client = new Client({
  6.   ...AwsSigv4Signer({
  7.     region: 'us-east-1',
  8.     // Must return a Promise that resolve to an AWS.Credentials object.
  9.     // This function is used to acquire the credentials when the client start and
  10.     // when the credentials are expired.
  11.     // The Client will refresh the Credentials only when they are expired.
  12.     // With AWS SDK V2, Credentials.refreshPromise is used when available to refresh the credentials.
  14.     // Example with AWS SDK V2:
  15.     getCredentials: () =>
  16.       new Promise((resolve, reject) => {
  17.         // Any other method to acquire a new Credentials object can be used.
  18.         AWS.config.getCredentials((err, credentials) => {
  19.           if (err) {
  20.             reject(err);
  21.           } else {
  22.             resolve(credentials);
  23.           }
  24.         });
  25.       }),
  26.   }),
  27.   node: "https://search-xxx.region.es.amazonaws.com", // OpenSearch domain URL
  28. });

copy

Use the following code to authenticate with AWS V3 SDK:

  1. const { defaultProvider } = require("@aws-sdk/credential-provider-node"); // V3 SDK.
  2. const { Client } = require('@opensearch-project/opensearch');
  3. const { AwsSigv4Signer } = require('@opensearch-project/opensearch/aws');
  5. const client = new Client({
  6.   ...AwsSigv4Signer({
  7.     region: 'us-east-1',
  8.     // Must return a Promise that resolve to an AWS.Credentials object.
  9.     // This function is used to acquire the credentials when the client start and
  10.     // when the credentials are expired.
  11.     // The Client will refresh the Credentials only when they are expired.
  12.     // With AWS SDK V2, Credentials.refreshPromise is used when available to refresh the credentials.
  14.     // Example with AWS SDK V3:
  15.     getCredentials: () => {
  16.       // Any other method to acquire a new Credentials object can be used.
  17.       const credentialsProvider = defaultProvider();
  18.       return credentialsProvider();
  19.     },
  20.   }),
  21.   node: "https://search-xxx.region.es.amazonaws.com", // OpenSearch domain URL
  22. });

copy

Circuit breaker

The memoryCircuitBreaker option can be used to prevent errors caused by a response payload being too large to fit into the heap memory available to the client.

The memoryCircuitBreaker object contains two fields:

  • enabled: A Boolean used to turn the circuit breaker on or off. Defaults to false.
  • maxPercentage: The threshold that determines whether the circuit breaker engages. Valid values are floats in the [0, 1] range that represent percentages in decimal form. Any value that exceeds that range will correct to 1.0.

The following example instantiates a client with the circuit breaker enabled and its threshold set to 80% of the available heap size limit:

  1. var client = new Client({
  2.   memoryCircuitBreaker: {
  3.     enabled: true,
  4.     maxPercentage: 0.8,
  5.   },
  6. });

copy