Skip to content

Commit 5b2611b

Browse files
[7.14] Update compatibility matrix to reflect supported versions
Co-authored-by: Seth Michael Larson <[email protected]>
1 parent 584467d commit 5b2611b

File tree

3 files changed

+12
-88
lines changed

3 files changed

+12
-88
lines changed

README.rst

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -36,35 +36,11 @@ Read more about `how to use asyncio with this project <https://elasticsearch-py.
3636
Compatibility
3737
-------------
3838

39-
The library is compatible with all Elasticsearch versions since ``0.90.x`` but you
40-
**have to use a matching major version**:
39+
Language clients are forward compatible; meaning that clients support communicating
40+
with greater minor versions of Elasticsearch.
4141

42-
For **Elasticsearch 7.0** and later, use the major version 7 (``7.x.y``) of the
43-
library.
44-
45-
For **Elasticsearch 6.0** and later, use the major version 6 (``6.x.y``) of the
46-
library.
47-
48-
For **Elasticsearch 5.0** and later, use the major version 5 (``5.x.y``) of the
49-
library.
50-
51-
For **Elasticsearch 2.0** and later, use the major version 2 (``2.x.y``) of the
52-
library, and so on.
53-
54-
The recommended way to set your requirements in your `setup.py` or
55-
`requirements.txt` is::
56-
57-
# Elasticsearch 7.x
58-
elasticsearch>=7.0.0,<8.0.0
59-
60-
# Elasticsearch 6.x
61-
elasticsearch>=6.0.0,<7.0.0
62-
63-
# Elasticsearch 5.x
64-
elasticsearch>=5.0.0,<6.0.0
65-
66-
# Elasticsearch 2.x
67-
elasticsearch>=2.0.0,<3.0.0
42+
Elastic language clients are also backwards compatible with lesser supported
43+
minor Elasticsearch versions.
6844

6945
If you have a need to have multiple versions installed at the same time older
7046
versions are also released as ``elasticsearch2`` and ``elasticsearch5``.

docs/guide/overview.asciidoc

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -10,37 +10,11 @@ on https://elasticsearch-py.readthedocs.io[Read the Docs].
1010
[discrete]
1111
=== Compatibility
1212

13-
Current development happens in the master branch.
13+
Language clients are forward compatible; meaning that clients support communicating
14+
with greater minor versions of Elasticsearch.
1415

15-
The library is compatible with all Elasticsearch versions since `0.90.x` but you
16-
**have to use a matching major version**:
17-
18-
For **Elasticsearch 7.0** and later, use the major version 7 (`7.x.y`) of the
19-
library.
20-
21-
For **Elasticsearch 6.0** and later, use the major version 6 (`6.x.y`) of the
22-
library.
23-
24-
For **Elasticsearch 5.0** and later, use the major version 5 (`5.x.y`) of the
25-
library.
26-
27-
For **Elasticsearch 2.0** and later, use the major version 2 (`2.x.y`) of the
28-
library, and so on.
29-
30-
The recommended way to set your requirements in your `setup.py` or
31-
`requirements.txt` is::
32-
33-
# Elasticsearch 7.x
34-
elasticsearch>=7,<8
35-
36-
# Elasticsearch 6.x
37-
elasticsearch>=6,<7
38-
39-
# Elasticsearch 5.x
40-
elasticsearch>=5,<6
41-
42-
# Elasticsearch 2.x
43-
elasticsearch>=2,<3
16+
Elastic language clients are also backwards compatible with lesser supported
17+
minor Elasticsearch versions.
4418

4519
If you have a need to have multiple versions installed at the same time older
4620
versions are also released as `elasticsearch2` and `elasticsearch5`.

docs/sphinx/index.rst

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -29,37 +29,11 @@ Read more about `how to use asyncio with this project <async.html>`_.
2929
Compatibility
3030
-------------
3131

32-
The library is compatible with all Elasticsearch versions since ``0.90.x`` but you
33-
**have to use a matching major version**:
32+
Language clients are forward compatible; meaning that clients support communicating
33+
with greater minor versions of Elasticsearch.
3434

35-
For **Elasticsearch 7.0** and later, use the major version 7 (``7.x.y``) of the
36-
library.
37-
38-
For **Elasticsearch 6.0** and later, use the major version 6 (``6.x.y``) of the
39-
library.
40-
41-
For **Elasticsearch 5.0** and later, use the major version 5 (``5.x.y``) of the
42-
library.
43-
44-
For **Elasticsearch 2.0** and later, use the major version 2 (``2.x.y``) of the
45-
library, and so on.
46-
47-
The recommended way to set your requirements in your `setup.py` or
48-
`requirements.txt` is:
49-
50-
.. code-block:: python
51-
52-
# Elasticsearch 7.x
53-
elasticsearch>=7.0.0,<8.0.0
54-
55-
# Elasticsearch 6.x
56-
elasticsearch>=6.0.0,<7.0.0
57-
58-
# Elasticsearch 5.x
59-
elasticsearch>=5.0.0,<6.0.0
60-
61-
# Elasticsearch 2.x
62-
elasticsearch>=2.0.0,<3.0.0
35+
Elastic language clients are also backwards compatible with lesser supported
36+
minor Elasticsearch versions.
6337

6438
If you have a need to have multiple versions installed at the same time older
6539
versions are also released as ``elasticsearch2``, ``elasticsearch5`` and ``elasticsearch6``.

0 commit comments

Comments
 (0)