Repository files navigation

Repository forElastic.Clients.Elasticsearch the official .NET client forElasticsearch.Older branches include both previous clients,NEST andElasticsearch.Net.

Download the latest version of Elasticsearchorsign-upfor a free trial of Elastic Cloud.

The .NET client for Elasticsearch provides strongly typed requests and responsesfor Elasticsearch APIs. It delegates protocol handling to theElastic.Transport library,which takes care of all transport-level concerns (HTTP connection establishmentand pooling, retries, etc.).

Language clients are forward compatible; meaning that the clients supportcommunicating with greater or equal minor versions of Elasticsearch withoutbreaking. It does not mean that the clients automatically support new featuresof newer Elasticsearch versions; it is only possible after a release of a newclient version. For example, a 8.12 client version won't automatically supportthe new features of the 8.13 version of Elasticsearch, the 8.13 client versionis required for that. Elasticsearch language clients are only backwardscompatible with default distributions and without guarantees made.

Refer to theInstallation sectionof the getting started documentation.

Refer to theConnecting sectionof the getting started documentation.

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

Please refer tothe full documentation on elastic.cofor comprehensive information on installation, configuration and usage.

The API reference documentation is availablehere.

We have released the next generation of the .NET client for Elasticsearch, whichaligns with v8 of Elasticsearch. We have renamed this libraryElastic.Clients.Elasticsearch, and the packages are published onNuGet. The8.0.x versions do not offer complete feature parity with the existingNESTclient. We therefore recommend you thoroughly review ourrelease notes and migration guidancebefore attempting to migrate existing applications to theElastic.Clients.Elasticsearch library.

Until the new client supports all endpoints and features your applicationrequires, you may continue to use the latest7.17.x client to communicate withElasticsearch v8 servers. Please reviewour documentation,which describes how to enable compatibility mode and secure communications witha v8 cluster.

We recommend using the latest7.17.xNEST client to communicate withElasticsearch v7 servers.

SeeCONTRIBUTING.md

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

This is free software, licensed underThe Apache License Version 2.0.