mirror of
https://github.com/iSharkFly-Docs/opensearch-docs-cn
synced 2025-02-07 13:08:10 +00:00
1fb5252cd6
* Adds collections landing page configuration and navigation header linking Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes unnecessary collection property from the configuration. Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds links to navigation collection headers to collection index pages based on the collection name Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Hide index pages from view and add info to formatting guide Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
116 lines
3.5 KiB
Markdown
116 lines
3.5 KiB
Markdown
---
|
|
layout: default
|
|
title: Language clients
|
|
nav_order: 1
|
|
has_children: false
|
|
nav_exclude: true
|
|
redirect_from:
|
|
- /clients/
|
|
---
|
|
|
|
# OpenSearch language clients
|
|
|
|
OpenSearch provides clients in JavaScript, Python, Ruby, Java, PHP, .NET, Go and Rust.
|
|
|
|
## OpenSearch clients
|
|
|
|
OpenSearch provides clients for the following programming languages and platforms:
|
|
|
|
* **Python**
|
|
* [OpenSearch high-level Python client]({{site.url}}{{site.baseurl}}/clients/python-high-level/)
|
|
* [OpenSearch low-level Python client]({{site.url}}{{site.baseurl}}/clients/python-low-level/)
|
|
* [`opensearch-py-ml` client]({{site.url}}{{site.baseurl}}/clients/opensearch-py-ml/)
|
|
* **Java**
|
|
* [OpenSearch Java client]({{site.url}}{{site.baseurl}}/clients/java/)
|
|
* **JavaScript**
|
|
* [OpenSearch JavaScript (Node.js) client]({{site.url}}{{site.baseurl}}/clients/javascript/index)
|
|
* **Go**
|
|
* [OpenSearch Go client]({{site.url}}{{site.baseurl}}/clients/go/)
|
|
* **Ruby**
|
|
* [OpenSearch Ruby client]({{site.url}}{{site.baseurl}}/clients/ruby/)
|
|
* **PHP**
|
|
* [OpenSearch PHP client]({{site.url}}{{site.baseurl}}/clients/php/)
|
|
* **.NET**
|
|
* [OpenSearch .NET clients]({{site.url}}{{site.baseurl}}/clients/dot-net/)
|
|
* **Rust**
|
|
* [OpenSearch Rust client]({{site.url}}{{site.baseurl}}/clients/rust/)
|
|
|
|
All clients are compatible with any version of OpenSearch.
|
|
{: .note}
|
|
|
|
|
|
## Legacy clients
|
|
|
|
Most clients that work with Elasticsearch OSS 7.10.2 *should* work with OpenSearch, but the latest versions of those clients might include license or version checks that artificially break compatibility. This page includes recommendations around which versions of those clients to use for best compatibility with OpenSearch.
|
|
|
|
Client | Recommended version
|
|
:--- | :---
|
|
[Elasticsearch Java low-level REST client](https://search.maven.org/artifact/org.elasticsearch.client/elasticsearch-rest-client/7.13.4/jar) | 7.13.4
|
|
[Elasticsearch Java high-level REST client](https://search.maven.org/artifact/org.elasticsearch.client/elasticsearch-rest-high-level-client/7.13.4/jar) | 7.13.4
|
|
[Elasticsearch Python client](https://pypi.org/project/elasticsearch/7.13.4/) | 7.13.4
|
|
[Elasticsearch Node.js client](https://www.npmjs.com/package/@elastic/elasticsearch/v/7.13.0) | 7.13.0
|
|
[Elasticsearch Ruby client](https://rubygems.org/gems/elasticsearch/versions/7.13.0) | 7.13.0
|
|
|
|
If you test a legacy client and verify that it works, please [submit a PR](https://github.com/opensearch-project/documentation-website/pulls) and add it to this table.
|
|
|
|
|
|
{% comment %}
|
|
## Python 3 test code
|
|
|
|
This code indexes a single document and is equivalent to `PUT /python-test-index1/_doc/1`.
|
|
|
|
```python
|
|
from elasticsearch import Elasticsearch
|
|
|
|
host = 'localhost'
|
|
port = 9200
|
|
# For testing only. Do not store credentials in code.
|
|
auth = ('admin', 'admin')
|
|
|
|
es = Elasticsearch(
|
|
hosts = [{'host': host, 'port': port}],
|
|
http_auth = auth,
|
|
use_ssl = True,
|
|
verify_certs = False
|
|
)
|
|
|
|
document = {
|
|
"title": "Moneyball",
|
|
"director": "Bennett Miller",
|
|
"year": "2011"
|
|
}
|
|
|
|
response = es.index(index='python-test-index1', id='1', body=document, refresh=True)
|
|
|
|
print(response)
|
|
```
|
|
|
|
|
|
## Node.js test code
|
|
|
|
This code is equivalent to `GET /`.
|
|
|
|
```js
|
|
const { Client } = require('@elastic/elasticsearch')
|
|
const client = new Client({
|
|
node: 'https://localhost:9200',
|
|
auth: {
|
|
// For testing only. Don't store credentials in code.
|
|
username: 'admin',
|
|
password: 'admin'
|
|
},
|
|
ssl: {
|
|
// ca: fs.readFileSync('./cacert.pem'),
|
|
rejectUnauthorized: false
|
|
}
|
|
})
|
|
|
|
async function run () {
|
|
const { body } = await client.info();
|
|
console.log(body);
|
|
}
|
|
|
|
run().catch(console.log)
|
|
```
|
|
{% endcomment %}
|