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.

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

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

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

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");

Sample code

  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 self-signed certificates with a hostname mismatch.
  21.     // cert: fs.readFileSync(client_cert_path),
  22.     // key: fs.readFileSync(client_key_path)
  23.   },
  24. });
  26. async function search() {
  27.   // Create an index with non-default settings.
  28.   var index_name = "books";
  29.   var settings = {
  30.     settings: {
  31.       index: {
  32.         number_of_shards: 4,
  33.         number_of_replicas: 3,
  34.       },
  35.     },
  36.   };
  38.   var response = await client.indices.create({
  39.     index: index_name,
  40.     body: settings,
  41.   });
  43.   console.log("Creating index:");
  44.   console.log(response.body);
  46.   // Add a document to the index.
  47.   var document = {
  48.     title: "The Outsider",
  49.     author: "Stephen King",
  50.     year: "2018",
  51.     genre: "Crime fiction",
  52.   };
  54.   var id = "1";
  56.   var response = await client.index({
  57.     id: id,
  58.     index: index_name,
  59.     body: document,
  60.     refresh: true,
  61.   });
  63.   console.log("Adding document:");
  64.   console.log(response.body);
  66.   // Search for the document.
  67.   var query = {
  68.     query: {
  69.       match: {
  70.         title: {
  71.           query: "The Outsider",
  72.         },
  73.       },
  74.     },
  75.   };
  77.   var response = await client.search({
  78.     index: index_name,
  79.     body: query,
  80.   });
  82.   console.log("Search results:");
  83.   console.log(response.body.hits);
  85.   // Delete the document.
  86.   var response = await client.delete({
  87.     index: index_name,
  88.     id: id,
  89.   });
  91.   console.log("Deleting document:");
  92.   console.log(response.body);
  94.   // Delete the index.
  95.   var response = await client.indices.delete({
  96.     index: index_name,
  97.   });
  99.   console.log("Deleting index:");
  100.   console.log(response.body);
  101. }
  103. search().catch(console.log);

Circuit Breaker

The memoryCircuitBreaker parameter in the Cluster Settings API gives you the ability to reject large query responses where the size of the response could crash OpenSearch Dashboards. To set the Circuit Breaker setting, use the POST _cluster/settings API operation on your active JS OpenSearch cluster.

memoryCircuitBreaker 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. The input range must be between [0 ,1]. Any number that exceeds that range will correct to 1.0.

The following example turns on the Circuit Breaker and sets the maximum percentage of a query response to 80% of the cluster’s storage. You can customize this example for use in the POST _cluster/settings request body.

  1. memoryCircuitBreaker: {
  2.      enabled: true,
  3.      maxPercentage: 0.8
  4. }