File tree 2 files changed +33
-3
lines changed 2 files changed +33
-3
lines changed Original file line number Diff line number Diff line change @@ -21,6 +21,25 @@ of the getting started documentation.
21
21
Refer to the [ Connecting section] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_connecting )
22
22
of the getting started documentation.
23
23
24
+ ## Compatibility
25
+
26
+ The Elasticsearch client is compatible with currently maintained JS versions.
27
+
28
+ Language clients are forward compatible; meaning that clients support
29
+ communicating with greater or equal minor versions of Elasticsearch without
30
+ breaking. It does not mean that the client automatically supports new features
31
+ of newer Elasticsearch versions; it is only possible after a release of a new
32
+ client version. For example, a 8.12 client version won't automatically support
33
+ the new features of the 8.13 version of Elasticsearch, the 8.13 client version
34
+ is required for that. Elasticsearch language clients are only backwards
35
+ compatible with default distributions and without guarantees made.
36
+
37
+ | Elasticsearch Version | Elasticsearch-JS Branch | Supported |
38
+ | --------------------- | ------------------------ | --------- |
39
+ | main | main | |
40
+ | 8.x | 8.x | 8.x |
41
+ | 7.x | 7.x | 7.17 |
42
+
24
43
## Usage
25
44
26
45
* [ Creating an index] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_creating_an_index )
Original file line number Diff line number Diff line change @@ -74,25 +74,36 @@ of `^7.10.0`).
74
74
[[js-compatibility-matrix]]
75
75
=== Compatibility matrix
76
76
77
- Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch.
78
- Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.
77
+ Language clients are forward compatible; meaning that clients support
78
+ communicating with greater or equal minor versions of {es} without breaking. It
79
+ does not mean that the client automatically supports new features of newer {es}
80
+ versions; it is only possible after a release of a new client version. For
81
+ example, a 8.12 client version won't automatically support the new features of
82
+ the 8.13 version of {es}, the 8.13 client version is required for that.
83
+ {es} language clients are only backwards compatible with default distributions
84
+ and without guarantees made.
79
85
80
- [%header,cols=2 *]
86
+ [%header,cols=3 *]
81
87
|===
82
88
|{es} Version
83
89
|Client Version
90
+ |Supported
84
91
92
+ |`8.x`
85
93
|`8.x`
86
94
|`8.x`
87
95
88
96
|`7.x`
89
97
|`7.x`
98
+ |`7.17`
90
99
91
100
|`6.x`
92
101
|`6.x`
102
+ |
93
103
94
104
|`5.x`
95
105
|`5.x`
106
+ |
96
107
|===
97
108
98
109
You can’t perform that action at this time.
0 commit comments