Skip to content

Commit bd612f3

Browse files
ZachBrisson-Elasticpquentinmarciw
authored
Clarify Elasticsearch 9.x compatibility (#2928)
Co-authored-by: Quentin Pradet <[email protected]> Co-authored-by: Marci W <[email protected]>
1 parent 3f10e97 commit bd612f3

File tree

2 files changed

+33
-25
lines changed

2 files changed

+33
-25
lines changed

README.md

+17-18
Original file line numberDiff line numberDiff line change
@@ -63,24 +63,23 @@ of the getting started documentation.
6363

6464
## Compatibility
6565

66-
Language clients are forward compatible; meaning that the clients support
67-
communicating with greater or equal minor versions of Elasticsearch without
68-
breaking. It does not mean that the clients automatically support new features
69-
of newer Elasticsearch versions; it is only possible after a release of a new
70-
client version. For example, a 8.12 client version won't automatically support
71-
the new features of the 8.13 version of Elasticsearch, the 8.13 client version
72-
is required for that. Elasticsearch language clients are only backwards
73-
compatible with default distributions and without guarantees made.
74-
75-
| Elasticsearch Version | Elasticsearch-Python Branch | Supported |
76-
| --------------------- | ------------------------ | --------- |
77-
| main | main | |
78-
| 8.x | 8.x | 8.x |
79-
| 7.x | 7.x | 7.17 |
80-
81-
82-
If you have a need to have multiple versions installed at the same time older
83-
versions are also released as ``elasticsearch7`` and ``elasticsearch8``.
66+
Language clients are _forward compatible:_ each client version works with equivalent and later minor versions of Elasticsearch without breaking.
67+
68+
Compatibility does not imply full feature parity. New Elasticsearch features are supported only in equivalent client versions. For example, an 8.12 client fully supports Elasticsearch 8.12 features and works with 8.13 without breaking; however, it does not support new Elasticsearch 8.13 features. An 8.13 client fully supports Elasticsearch 8.13 features.
69+
70+
| Elasticsearch version | elasticsearch-py branch |
71+
| --- | --- |
72+
| main | main |
73+
| 9.x | 9.x |
74+
| 9.x | 8.x |
75+
| 8.x | 8.x |
76+
77+
Elasticsearch language clients are also _backward compatible_ across minor versions &mdash; with default distributions and without guarantees.
78+
79+
> [!TIP]
80+
> To upgrade to a new major version, first upgrade Elasticsearch, then upgrade the Python Elasticsearch client.
81+
82+
If you need to work with multiple client versions, note that older versions are also released as `elasticsearch7` and `elasticsearch8`.
8483

8584

8685
## Documentation

docs/reference/index.md

+16-7
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,21 @@ For a higher level access with more limited scope, have a look at the DSL module
5656

5757
## Compatibility [_compatibility]
5858

59-
Language clients are forward compatible; meaning that the clients support communicating with greater or equal minor versions of {{es}} without breaking. It does not mean that the clients automatically support new features of newer {{es}} versions; it is only possible after a release of a new client version. For example, a 8.12 client version won’t automatically support the new features of the 8.13 version of {{es}}, the 8.13 client version is required for that. {{es}} language clients are only backwards compatible with default distributions and without guarantees made.
59+
Language clients are _forward compatible:_ each client version works with equivalent and later minor versions of {{es}} without breaking.
6060

61-
| Elasticsearch version | elasticsearch-py branch | Supported |
62-
| --- | --- | --- |
63-
| main | main | |
64-
| 8.x | 8.x | 8.x |
65-
| 7.x | 7.x | 7.17 |
61+
Compatibility does not imply full feature parity. New {{es}} features are supported only in equivalent client versions. For example, an 8.12 client fully supports {{es}} 8.12 features and works with 8.13 without breaking; however, it does not support new {{es}} 8.13 features. An 8.13 client fully supports {{es}} 8.13 features.
6662

67-
If you have a need to have multiple versions installed at the same time older versions are also released as `elasticsearch7` and `elasticsearch8`.
63+
| Elasticsearch version | elasticsearch-py branch |
64+
| --- | --- |
65+
| main | main |
66+
| 9.x | 9.x |
67+
| 9.x | 8.x |
68+
| 8.x | 8.x |
69+
70+
{{es}} language clients are also _backward compatible_ across minor versions &mdash; with default distributions and without guarantees.
71+
72+
:::{tip}
73+
To upgrade to a new major version, first upgrade {{es}}, then upgrade the Python {{es}} client.
74+
:::
75+
76+
If you need to work with multiple client versions, note that older versions are also released as `elasticsearch7` and `elasticsearch8`.

0 commit comments

Comments
 (0)