Skip to content

Commit 6e5b19e

Browse files
committed
Update README
1 parent 61ff828 commit 6e5b19e

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,21 @@ The .NET client for Elasticsearch provides strongly typed requests and responses
1717

1818
## Compatibility
1919

20-
Language clients are forward compatible; meaning that the clients support
21-
communicating with greater or equal minor versions of Elasticsearch without
22-
breaking. It does not mean that the clients automatically support new features
23-
of newer Elasticsearch versions; it is only possible after a release of a new
24-
client version. For example, a 8.12 client version won't automatically support
25-
the new features of the 8.13 version of Elasticsearch, the 8.13 client version
26-
is required for that. Elasticsearch language clients are only backwards
27-
compatible with default distributions and without guarantees made.
28-
29-
| Elasticsearch Version | Elasticsearch-NET Branch | Supported |
30-
| --------------------- | ------------------------- | --------- |
31-
| main | main | |
32-
| 8.x | 8.x | 8.x |
33-
| 7.x | 7.x | 7.17 |
20+
Language clients are **forward compatible**:
21+
22+
Given a constant major version of the client, each related minor version is compatible with its equivalent- and all later Elasticsearch minor versions of the **same or next higher** major version.
23+
24+
For example:
25+
26+
| Client Version | Compatible with Elasticsearch `7.x` | Compatible with Elasticsearch `8.x` | Compatible with Elasticsearch `9.x` |
27+
| ---: | :-- | :-- | :-- |
28+
| 8.x | ❌ no | ✅ yes | ✅ yes |
29+
| 7.x | ✅ yes | ✅ yes | ❌ no |
30+
31+
Language clients are also **backward compatible** across minor versions within the **same** major version (without strong guarantees), but **never** backward compatible with earlier Elasticsearch major versions.
32+
33+
> [!NOTE]
34+
> Compatibility does not imply feature parity. For example, an `8.12` client is compatible with `8.13`, but does not support any of the new features introduced in Elasticsearch `8.13`.
3435
3536
## Installation
3637

0 commit comments

Comments
 (0)