3.9 KiB
layout | title | nav_order | has_children | nav_exclude | redirect_from | |
---|---|---|---|---|---|---|
default | Language clients | 1 | false | true |
|
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
- Java
- JavaScript
- Go
- Ruby
- PHP
- .NET
- Rust
For a client compatibility matrix, see the COMPATIBILITY.md file in the client's repository. {: .note}
The OpenSearch Java high-level REST client will be deprecated starting with OpenSearch version 3.0.0 and will be removed in a future release. We recommend switching to the Java client instead. {: .warning}
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.
For a client compatibility matrix, see the COMPATIBILITY.md file in the client's repository. {: .note}
Client | Recommended version |
---|---|
Elasticsearch Java low-level REST client | 7.13.4 |
Elasticsearch Java high-level REST client | 7.13.4 |
Elasticsearch Python client | 7.13.4 |
Elasticsearch Node.js client | 7.13.0 |
Elasticsearch Ruby client | 7.13.0 |
If you test a legacy client and verify that it works, please submit a PR 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
.
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 /
.
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 %}