Elasticsearch .NET Client

Repository for Elastic.Clients.Elasticsearch the official .NET client for
Elasticsearch.

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.).

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). Please always check the release notes 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
of the getting started documentation.

Connecting

Refer to the Connecting section
of the getting started documentation.

Usage

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.

Contributing

See CONTRIBUTING.md

Copyright and License

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