Files
opensearch-pyd/COMPATIBILITY.md
T
b4bfde0e0b Added new OpenSearch versions and updated compatibility matrix (#257)
* Added new OpenSearch versions and updated compatibility matrix

Signed-off-by: saimedhi <[email protected]>

* Compatibility with OpenSearch 2.1.0 - 2.4.1

Signed-off-by: saimedhi <[email protected]>

Signed-off-by: saimedhi <[email protected]>
Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
2023-01-05 15:46:52 -08:00

18 lines
1.1 KiB
Markdown

- [Compatibility with OpenSearch](#compatibility-with-opensearch)
- [Upgrading](#upgrading)
## Compatibility with OpenSearch
The below matrix shows the compatibility of the [`opensearch-py`](https://pypi.org/project/opensearch-py/) with versions of [`OpenSearch`](https://opensearch.org/downloads.html#opensearch).
| Client Version | OpenSearch Version | Notes |
| --- | --- | --- |
| 1.0.0 | 1.0.0-1.2.4 | |
| 1.1.0 | 1.3.0-1.3.7 | |
| 2.0.0 | 1.0.0-2.4.1 | client works against Opensearch Version 1.x as long as features removed in 2.0 are not used |
| 2.0.1 | 1.0.0-2.4.1 | client works against Opensearch Version 1.x as long as features removed in 2.0 are not used |
## Upgrading
Major versions of OpenSearch introduce breaking changes that require careful upgrades of the client. While `opensearch-py-client` 2.0.0 works against the latest OpenSearch 1.x, certain deprecated features removed in OpenSearch 2.0 have also been removed from the client. Please refer to the [OpenSearch documentation](https://opensearch.org/docs/latest/clients/index/) for more information.