Skip to content

Commit 1578eaa

Browse files
Update index and add compatibility mode to connection section (#6003) (#6004)
* Update connection section of getting started (cherry picked from commit 73b863f) * Generate updated getting started doc Co-authored-by: Steve Gordon <sgordon@hotmail.co.uk>
1 parent d4822b7 commit 1578eaa

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

docs/client-concepts/high-level/getting-started.asciidoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,17 @@ var settings = new ConnectionSettings(connectionPool)
7373
var client = new ElasticClient(settings);
7474
----
7575

76+
[float]
77+
==== Enabling the Compatibility Mode
78+
79+
The Elasticsearch server version 8.0 is introducing a new compatibility mode that allows you a smoother upgrade
80+
experience from 7 to 8. In a nutshell, you can use the latest 7.x Elasticsearch client with an 8.x Elasticsearch
81+
server, giving more room to coordinate the upgrade of your codebase to the next major version.
82+
83+
If you want to leverage this functionality, please make sure that you are using the latest 7.x client and set
84+
the environment variable `ELASTIC_CLIENT_APIVERSIONING` to `true`. The client is handling the rest internally.
85+
For every 8.0 and beyond client, you're all set! The compatibility mode is enabled by default.
86+
7687
[float]
7788
=== Using the Client in a Function-as-a-Service Environment
7889

tests/Tests/ClientConcepts/HighLevel/GettingStarted.doc.cs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,19 @@ public void UsingConnectionPool()
8282
var client = new ElasticClient(settings);
8383
}
8484

85+
/**[float]
86+
* ==== Enabling the Compatibility Mode
87+
*
88+
* The Elasticsearch server version 8.0 is introducing a new compatibility mode that allows you a smoother upgrade
89+
* experience from 7 to 8. In a nutshell, you can use the latest 7.x Elasticsearch client with an 8.x Elasticsearch
90+
* server, giving more room to coordinate the upgrade of your codebase to the next major version.
91+
92+
* If you want to leverage this functionality, please make sure that you are using the latest 7.x client and set
93+
* the environment variable `ELASTIC_CLIENT_APIVERSIONING` to `true`. The client is handling the rest internally.
94+
* For every 8.0 and beyond client, you're all set! The compatibility mode is enabled by default.
95+
*
96+
*/
97+
8598
/**[float]
8699
* === Using the Client in a Function-as-a-Service Environment
87100
*

0 commit comments

Comments
 (0)