iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update client name

This commit is contained in:
Liz Snyder 2021-09-22 12:26:41 -07:00
parent 18d3891879
commit 2d228a86ca
1 changed files with 80 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

163
_clients/javascript.md
View File

@ -10,19 +10,18 @@ The OpenSearch Javascript client provides a safer and easier way to interact wit
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:
```bash
npm install @opensearch/opensearch
npm install @opensearch-project/opensearch
```
To install a specific major version of the client, run the following command:
```bash
npm install @opensearch/opensearch@<version>
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](https://github.com/opensearch-project/opensearch-js) on GitHub.
@ -30,115 +29,113 @@ If you prefer to add the client manually or just want to examine the source code
Then require the client:
```javascript
const { Client } = require('@opensearch/opensearch')
const { Client } = require("@opensearch-project/opensearch");
```
## Sample code
```javascript
'use strict';
"use strict";
var host = 'localhost';
var protocol = 'https';
var host = "localhost";
var protocol = "https";
var port = 9200;
var auth = 'admin:admin'; // For testing only. Don't store credentials in code.
var ca_certs_path = '/full/path/to/root-ca.pem';
var auth = "admin:admin"; // For testing only. Don't store credentials in code.
var ca_certs_path = "/full/path/to/root-ca.pem";
// Optional client certificates if you don't want to use HTTP basic authentication.
// var client_cert_path = '/full/path/to/client.pem'
// var client_key_path = '/full/path/to/client-key.pem'
// Create a client with SSL/TLS enabled.
var { Client } = require('@opensearch/opensearch');
var fs = require('fs');
var { Client } = require("@opensearch/opensearch");
var fs = require("fs");
var client = new Client({
node: protocol + '://' + auth + '@' + host + ':' + port,
ssl: {
ca: fs.readFileSync(ca_certs_path),
// You can turn off certificate verification (rejectUnauthorized: false) if you're using self-signed certificates with a hostname mismatch.
// cert: fs.readFileSync(client_cert_path),
// key: fs.readFileSync(client_key_path)
}
})
node: protocol + "://" + auth + "@" + host + ":" + port,
ssl: {
ca: fs.readFileSync(ca_certs_path),
// You can turn off certificate verification (rejectUnauthorized: false) if you're using self-signed certificates with a hostname mismatch.
// cert: fs.readFileSync(client_cert_path),
// key: fs.readFileSync(client_key_path)
},
});
async function search() {
// Create an index with non-default settings.
var index_name = "books";
var settings = {
settings: {
index: {
number_of_shards: 4,
number_of_replicas: 3,
},
},
};
// Create an index with non-default settings.
var index_name = 'books'
var settings = {
'settings': {
'index': {
'number_of_shards': 4,
'number_of_replicas': 3
}
}
}
var response = await client.indices.create({
index: index_name,
body: settings,
});
var response = await client.indices.create({
index: index_name,
body: settings
})
console.log("Creating index:");
console.log(response.body);
console.log('Creating index:')
console.log(response.body)
// Add a document to the index.
var document = {
title: "The Outsider",
author: "Stephen King",
year: "2018",
genre: "Crime fiction",
};
// Add a document to the index.
var document = {
'title': 'The Outsider',
'author': 'Stephen King',
'year': '2018',
'genre': 'Crime fiction'
}
var id = "1";
var id = '1'
var response = await client.index({
id: id,
index: index_name,
body: document,
refresh: true,
});
var response = await client.index({
id: id,
index: index_name,
body: document,
refresh: true
})
console.log("Adding document:");
console.log(response.body);
console.log('Adding document:')
console.log(response.body)
// Search for the document.
var query = {
query: {
match: {
title: {
query: "The Outsider",
},
},
},
};
// Search for the document.
var query = {
'query': {
'match': {
'title': {
'query': 'The Outsider'
}
}
}
}
var response = await client.search({
index: index_name,
body: query,
});
var response = await client.search({
index: index_name,
body: query
})
console.log("Search results:");
console.log(response.body.hits);
console.log('Search results:')
console.log(response.body.hits)
// Delete the document.
var response = await client.delete({
index: index_name,
id: id,
});
// Delete the document.
var response = await client.delete({
index: index_name,
id: id
})
console.log("Deleting document:");
console.log(response.body);
console.log('Deleting document:')
console.log(response.body)
// Delete the index.
var response = await client.indices.delete({
index: index_name,
});
// Delete the index.
var response = await client.indices.delete({
index: index_name
})
console.log('Deleting index:')
console.log(response.body)
console.log("Deleting index:");
console.log(response.body);
}
search().catch(console.log)
search().catch(console.log);
```