Skip to content

Commit 8fbd473

Browse files
committed
Added compatibility mode section in docs
1 parent ac049ea commit 8fbd473

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/connecting.asciidoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,21 @@ $client = ClientBuilder::create()
201201
----
202202

203203

204+
[discrete]
205+
[[client-comp]]
206+
=== Enabling the Compatibility Mode
207+
208+
The Elasticsearch server version 8.0 is introducing a new compatibility mode that
209+
allows you a smoother upgrade experience from 7 to 8. In a nutshell, you can use
210+
the latest 7.x Elasticsearch client with an 8.x Elasticsearch server, giving more
211+
room to coordinate the upgrade of your codebase to the next major version.
212+
213+
If you want to leverage this functionality, please make sure that you are using the
214+
latest 7.x client and set the environment variable `ELASTIC_CLIENT_APIVERSIONING`
215+
to `true`. The client is handling the rest internally. For every 8.0 and beyond
216+
client, you're all set! The compatibility mode is enabled by default.
217+
218+
204219
[discrete]
205220
[[client-usage]]
206221
=== Usage

0 commit comments

Comments
 (0)