Elasticsearch .NET Client

Repository for Elastic.Clients.Elasticsearch the official .NET client for Elasticsearch. Older branches include both previous clients, NEST and Elasticsearch.Net.

Download the latest version of Elasticsearch or sign-up 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 library, which takes care of all transport-level concerns (HTTP connection establishment and pooling, retries, etc.).

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 7.x	Compatible with Elasticsearch 8.x	Compatible with Elasticsearch 9.x
8.x	❌ no	✅ yes	✅ yes
7.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 of the getting started documentation.

Connecting

Refer to the Connecting section of the getting started documentation.

Usage

• Creating an index
• Indexing a document
• Getting documents
• Searching documents
• Updating documents
• Deleting documents
• Deleting an index

Documentation

Please refer to the full documentation on elastic.co for comprehensive information on installation, configuration and usage.

The API reference documentation is available here.

Versions

Elasticsearch 8.x Clusters

We have released the next generation of the .NET client for Elasticsearch, which aligns with v8 of Elasticsearch. We have renamed this library Elastic.Clients.Elasticsearch, and the packages are published on NuGet. The 8.0.x versions do not offer complete feature parity with the existing NEST client. We therefore recommend you thoroughly review our release notes and migration guidance before attempting to migrate existing applications to the Elastic.Clients.Elasticsearch library.

Until the new client supports all endpoints and features your application requires, you may continue to use the latest 7.17.x client to communicate with Elasticsearch v8 servers. Please review our documentation, which describes how to enable compatibility mode and secure communications with a v8 cluster.

Elasticsearch 7.x Clusters

We recommend using the latest 7.17.x NEST client to communicate with Elasticsearch v7 servers.

Contributing

See CONTRIBUTING.md

Copyright and License

This software is Copyright (c) 2014-2022 by Elasticsearch BV.

This is free software, licensed under The Apache License Version 2.0.