Getting started

This page guides you through the installation process of the .NET client, shows you how to instantiate the client, and how to perform basic Elasticsearch operations with it.

Requirements

.NET Core, .NET 5+ or .NET Framework (4.6.1 and higher).

Installation

To install the latest version of the client for SDK style projects, run the following command:

dotnet add package Elastic.Clients.Elasticsearch

Refer to the Installation page to learn more.

Connecting

You can connect to Elastic Cloud using an API key and your deployment’s Elasticsearch endpoint URL.

		using Elastic.Clients.Elasticsearch;
using Elastic.Transport;

var settings = new ElasticsearchClientSettings(new Uri("<ELASTICSEARCH_ENDPOINT>"))
    .Authentication(new ApiKey("<API_KEY>"));

var client = new ElasticsearchClient(settings);

Replace <ELASTICSEARCH_ENDPOINT> with the URL shown for Elasticsearch on the deployment page (for example, the value you get when you choose Copy endpoint or Copy as curl). Replace <API_KEY> with an API key that your application is allowed to use.

In the Elastic Cloud console, open Deployments, select your deployment, and locate the Elasticsearch endpoint URL in the connection details:

Finding Elasticsearch endpoint

You can generate an API key on the Management page under Security.

Create API key

For other connection options, refer to the Connecting section.

Operations

Time to use Elasticsearch! This section walks you through the basic, and most important, operations of Elasticsearch. For more operations and more advanced examples, refer to the CRUD usage examples page.

Creating an index

This is how you create the my_index index:

var response = await client.Indices.CreateAsync("my_index");

Indexing documents

This is a simple way of indexing a document:

		var doc = new MyDoc
{
    Id = 1,
    User = "flobernd",
    Message = "Trying out the client, so far so good?"
};

var response = await client.IndexAsync(doc, x => x.Index("my_index"));
		
	

Getting documents

You can get documents by using the following code:

		var response = await client.GetAsync<MyDoc>("my-index", id);

if (response.IsValidResponse)
{
    var doc = response.Source;
}
		
	

Searching documents

This is how you can create a single match query with the .NET client:

		var response = await client.SearchAsync<Person>(s => s
    .Indices("my_index")
    .From(0)
    .Size(10)
    .Query(q => q
        .Term(t => t
            .Field(x => x.User)
            .Value("flobernd")
        )
    )
);

if (response.IsValidResponse)
{
    var doc = response.Documents.FirstOrDefault();
}
		
	

Updating documents

This is how you can update a document, for example to add a new field:

		doc.Message = "This is a new message";

var response = await client.UpdateAsync<MyDoc, MyDoc>("my_index", id, u => u
    .Doc(doc)
);

Deleting documents

var response = await client.DeleteAsync("my_index", id);

Deleting an index

var response = await client.Indices.DeleteAsync("my_index");