Skip to content

Commit 789df63

Browse files
committed
Update documentation
1 parent 2499997 commit 789df63

File tree

2 files changed

+19
-36
lines changed

2 files changed

+19
-36
lines changed

README.md

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
Repository for **Elastic.Clients.Elasticsearch** the official .NET client for
44
[Elasticsearch](https://github.com/elastic/elasticsearch).
5-
*Older branches include both previous clients, **NEST** and **Elasticsearch.Net**.*
65

76
**[Download the latest version of Elasticsearch](https://www.elastic.co/downloads/elasticsearch)**
87
or
@@ -61,40 +60,13 @@ for comprehensive information on installation, configuration and usage.
6160

6261
The API reference documentation is available [here](https://elastic.github.io/elasticsearch-net).
6362

64-
## Versions
65-
66-
### Elasticsearch 8.x Clusters
67-
68-
We have released the next generation of the .NET client for Elasticsearch, which
69-
aligns with v8 of Elasticsearch. We have renamed this library
70-
`Elastic.Clients.Elasticsearch`, and the packages are published on
71-
[NuGet](https://www.nuget.org/packages/Elastic.Clients.Elasticsearch/). The
72-
8.0.x versions do not offer complete feature parity with the existing `NEST`
73-
client. We therefore recommend you thoroughly review our
74-
[release notes and migration guidance](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/release-notes-8.0.0.html)
75-
before attempting to migrate existing applications to the
76-
`Elastic.Clients.Elasticsearch` library.
77-
78-
Until the new client supports all endpoints and features your application
79-
requires, you may continue to use the latest `7.17.x` client to communicate with
80-
Elasticsearch v8 servers. Please review
81-
[our documentation](https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17/connecting-to-elasticsearch-v8.html),
82-
which describes how to enable compatibility mode and secure communications with
83-
a v8 cluster.
84-
85-
### Elasticsearch 7.x Clusters
86-
87-
We recommend using the latest `7.17.x`
88-
[NEST client](https://www.nuget.org/packages/Nest) to communicate with
89-
Elasticsearch v7 servers.
90-
9163
## Contributing
9264

9365
See [CONTRIBUTING.md](./CONTRIBUTING.md)
9466

9567
## Copyright and License
9668

97-
This software is Copyright (c) 2014-2022 by Elasticsearch BV.
69+
This software is Copyright (c) 2014-2025 by Elasticsearch BV.
9870

9971
This is free software, licensed under
10072
[The Apache License Version 2.0](https://github.com/elastic/elasticsearch-net/blob/main/LICENSE.txt).

docs/reference/index.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,7 @@ mapped_pages:
1010

1111
Designed for .NET application developers, the .NET language client library provides a strongly typed API and query DSL for interacting with {{es}}. The .NET client includes higher-level abstractions, such as helpers for coordinating bulk indexing and update operations. It also comes with built-in, configurable cluster failover retry mechanisms.
1212

13-
The {{es}} .NET client is available as a [NuGet](https://www.nuget.org/packages/Elastic.Clients.Elasticsearch) package for use with .NET Core, .NET 5+, and .NET Framework (4.6.1 and later) applications.
14-
15-
*NOTE: This documentation covers the v8 .NET client for {{es}}, for use with {{es}} 8.x versions. To develop applications targeting {{es}} v7, use the [v7 (NEST) client](https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17).*
16-
13+
The {{es}} .NET client is available as a [NuGet](https://www.nuget.org/packages/Elastic.Clients.Elasticsearch) package
1714

1815
## Features [features]
1916

@@ -30,15 +27,29 @@ The .NET {{es}} client is built on the Elastic Transport library, which provides
3027
* Connection management and load balancing across all available nodes.
3128
* Request retries and dead connections handling.
3229

33-
3430
## {{es}} version compatibility [_es_version_compatibility]
3531

36-
Language clients are forward compatible: clients support communicating with current and later minor versions of {{es}}. {{es}} language clients are backward compatible with default distributions only and without guarantees.
32+
Language clients are **forward compatible**:
33+
34+
Given a constant major version of the client, each related minor version is compatible with its equivalent- and all later {{es}} minor versions of the **same or next higher** major version.
35+
36+
For example:
3737

38+
| Client Version | Compatible with {{es}} `8.x` | Compatible with {{es}} `9.x` | Compatible with {{es}} `10.x` |
39+
| ---: | :-- | :-- | :-- |
40+
| 9.x | ❌ no | ✅ yes | ✅ yes |
41+
| 8.x | ✅ yes | ✅ yes | ❌ no |
42+
43+
Language clients are also **backward compatible** across minor versions within the **same** major version (without strong guarantees), but **never** backward compatible with earlier {{es}} major versions.
44+
45+
:::{note}
46+
47+
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 {{es}} `8.13`.
48+
49+
:::
3850

3951
## Questions, bugs, comments, feature requests [_questions_bugs_comments_feature_requests]
4052

4153
To submit a bug report or feature request, use [GitHub issues](https://github.com/elastic/elasticsearch-net/issues).
4254

4355
For more general questions and comments, try the community forum on [discuss.elastic.co](https://discuss.elastic.co/c/elasticsearch). Mention `.NET` in the title to indicate the discussion topic.
44-

0 commit comments

Comments
 (0)