https://github.com/elastic/elasticsearch-net
This strongly-typed, client library enables working with Elasticsearch. It is the official client maintained and supported by Elastic.
https://github.com/elastic/elasticsearch-net
c-sharp client dot-net dot-net-client elasticsearch elasticsearch-net nest
Last synced: 2 months ago
JSON representation
This strongly-typed, client library enables working with Elasticsearch. It is the official client maintained and supported by Elastic.
- Host: GitHub
- URL: https://github.com/elastic/elasticsearch-net
- Owner: elastic
- License: apache-2.0
- Created: 2010-09-27T13:55:00.000Z (about 15 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T19:27:07.000Z (6 months ago)
- Last Synced: 2025-05-12T00:17:36.274Z (6 months ago)
- Topics: c-sharp, client, dot-net, dot-net-client, elasticsearch, elasticsearch-net, nest
- Language: C#
- Homepage: https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/index.html
- Size: 253 MB
- Stars: 3,624
- Watchers: 497
- Forks: 1,153
- Open Issues: 79
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.txt
Awesome Lists containing this project
- Awesome-Nuget-Packages - **Elastic**
- awesome-dotnet - elasticsearch-net - Repository for both NEST and Elasticsearch.Net, the two official Elasticsearch .NET clients. (Libraries, Frameworks and Tools / Searching)
- awesome-dotnet-core - Elasticsearch.Net & NEST - NEST和Elasticsearch.Net的存储库，这是两个官方Elasticsearch .NET客户端。 (框架, 库和工具 / 搜索)
- awesome-dot-dev - Elasticsearch .NET - Elasticsearch.Net & NEST (Search)
- fucking-awesome-dotnet-core - Elasticsearch.Net & NEST - Repository for both NEST and Elasticsearch.NET, the two official elasticsearch .NET clients. (Frameworks, Libraries and Tools / Searching)
- awsome-dotnet - Elasticsearch .NET - Elasticsearch.Net & NEST (Search)
- awesome-csharp - Elasticsearch .NET - Elasticsearch.Net & NEST (Search)
- awesome-dotnet-cn - Elasticsearch .NET - Elasticsearch.Net & NEST (Search)
- fucking-awesome-dotnet - Elasticsearch .NET - Elasticsearch.Net & NEST (Search / GUI - other)
- awesome-dotnet - Elasticsearch .NET - Elasticsearch.Net & NEST (Search)
- awesome-dotnet-core - Elasticsearch.Net & NEST - Repository for both NEST and Elasticsearch.NET, the two official elasticsearch .NET clients. (Frameworks, Libraries and Tools / Searching)
- awesome-dotnet - Elasticsearch .NET - Elasticsearch.Net & NEST (Search)
README
# Elasticsearch .NET Client
Repository for **Elastic.Clients.Elasticsearch** the official .NET client for
[Elasticsearch](https://github.com/elastic/elasticsearch).
**[Download the latest version of Elasticsearch](https://www.elastic.co/downloads/elasticsearch)**
or
**[sign-up](https://cloud.elastic.co/registration?elektra=en-ess-sign-up-page)**
**for a free trial of Elastic Cloud**.
The .NET client for Elasticsearch provides strongly typed requests and responses
for Elasticsearch APIs. It delegates protocol handling to the
[Elastic.Transport](https://github.com/elastic/elastic-transport-net) library,
which takes care of all transport-level concerns (HTTP connection establishment
and pooling, retries, etc.).
## Versioning
The *major* and *minor* version parts of the Elasticsearch .NET client are dictated by the version of the Elasticsearch server.
> [!WARNING]
> This means that the Elasticsearch .NET client **does not** strictly follows semantic versioning!
>
> Although we try to avoid this as much as possible, it can happen that a *minor* or even *patch* version contains breaking changes (see also: [breaking changes policy](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/breaking-changes-policy.html)). Please always check the [release notes](https://github.com/elastic/elasticsearch-net/releases) before updating the client package.
## Compatibility
Language clients are **forward compatible**:
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.
For example:
| Client Version | Compatible with Elasticsearch `8.x` | Compatible with Elasticsearch `9.x` | Compatible with Elasticsearch `10.x` |
| ---: | :-- | :-- | :-- |
| 9.x | ❌ no | ✅ yes | ✅ yes |
| 8.x | ✅ yes | ✅ yes | ❌ no |
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.
> [!NOTE]
> 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`.
## Installation
Refer to the [Installation section](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_installation)
of the getting started documentation.
## Connecting
Refer to the [Connecting section](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_connecting)
of the getting started documentation.
## Usage
- [Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_creating_an_index)
- [Indexing a document](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_indexing_documents)
- [Getting documents](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_getting_documents)
- [Searching documents](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_searching_documents)
- [Updating documents](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_updating_documents)
- [Deleting documents](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_deleting_documents)
- [Deleting an index](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_deleting_an_index)
## Documentation
Please refer to
[the full documentation on elastic.co](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/index.html)
for comprehensive information on installation, configuration and usage.
The API reference documentation is available [here](https://elastic.github.io/elasticsearch-net).
## Try Elasticsearch and Kibana locally
If you want to try Elasticsearch and Kibana locally, you can run the following command:
```bash
curl -fsSL https://elastic.co/start-local | sh
```
This will run Elasticsearch at [http://localhost:9200](http://localhost:9200) and Kibana at [http://localhost:5601](http://localhost:5601).
More information is available [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/run-elasticsearch-locally.html).
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md)
## Copyright and License
This software is Copyright (c) 2014-2025 by Elasticsearch BV.
This is free software, licensed under
[The Apache License Version 2.0](https://github.com/elastic/elasticsearch-net/blob/main/LICENSE.txt).