Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update language around client version compatibility #6939

Merged
merged 6 commits into from
Apr 11, 2024
Merged

Update language around client version compatibility #6939

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
15db275
Update language around client version compatibility
hdhalter Apr 10, 2024
9a9ddc9
Update _clients/index.md
hdhalter Apr 11, 2024
1410a9f
Update _clients/index.md
hdhalter Apr 11, 2024
cce1040
Update _clients/index.md
hdhalter Apr 11, 2024
93d9a95
Update _clients/index.md
hdhalter Apr 11, 2024
9462b09
Update _clients/index.md
vagimeli Apr 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions _clients/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ redirect_from:

# OpenSearch language clients

OpenSearch provides clients in JavaScript, Python, Ruby, Java, PHP, .NET, Go and Rust.
OpenSearch provides clients in JavaScript, Python, Ruby, Java, PHP, .NET, Go, Hadoop, and Rust.

The OpenSearch Java high-level REST client will be deprecated starting with OpenSearch 3.0.0 and will be removed in a future release. Switching to the [Java client]({{site.url}}{{site.baseurl}}/clients/java/) is recommended.
{: .warning}

## OpenSearch clients

Expand Down Expand Up @@ -39,18 +42,14 @@ OpenSearch provides clients for the following programming languages and platform
* [OpenSearch Hadoop client](https://github.com/opensearch-project/opensearch-hadoop)


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]({{site.url}}{{site.baseurl}}/clients/java/) 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.
Most clients that work with Elasticsearch OSS 7.10.2 *should* work with OpenSearch 1.x, but the latest versions of those clients might include license or version checks that artificially break compatibility. The table that follows includes recommendations for which client versions to use for best compatibility with OpenSearch 1.x. From OpenSearch 2.0 and later, no Elasticsearch clients are fully compatible with OpenSearch.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

While OpenSearch and Elasticsearch share several core features, mixing and matching the client and server has a high risk of errors and unexpected results. As OpenSearch and Elasticsearch continue to diverge, such risks may increase. Although your Elasticsearch client may continue working with your OpenSearch cluster, using OpenSearch clients for OpenSearch clusters is recommended.
[: .warning]

For a client compatibility matrix, see the COMPATIBILITY.md file in the client's repository.
{: .note}
To view the compatibility matrix for a specific client, see the `COMPATIBILITY.md` file in the client's repository.

Client | Recommended version
:--- | :---
Expand Down
Loading