Skip to content

Commit

Permalink
Update language around client version compatibility (#6939) (#6940)
Browse files Browse the repository at this point in the history
  • Loading branch information
opensearch-trigger-bot[bot] authored Apr 11, 2024
1 parent 939aa25 commit 694f352
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions _clients/index.md
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.
Clients that work with Elasticsearch OSS 7.10.2 should work with OpenSearch 1.x. The latest versions of those clients, however, might include license or version checks that artificially break compatibility. The following table provides recommendations for which client versions to use for best compatibility with OpenSearch 1.x. For OpenSearch 2.0 and later, no Elasticsearch clients are fully compatible with OpenSearch.

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

0 comments on commit 694f352

Please sign in to comment.