IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Overview Installation »

›

Getting started

edit

Getting started

edit

This page guides you through the installation process of the Go client, shows you how to instantiate the client, and how to perform basic Elasticsearch operations with it. You can use the client with either a low-level API or a fully typed API. This getting started shows you examples of both APIs.

Requirements

edit

Go version 1.21+

Installation

edit

To install the latest version of the client, run the following command:

go get github.com/elastic/go-elasticsearch/v8@latest

Refer to the Installation page to learn more.

Connecting

edit

You can connect to the Elastic Cloud using an API key and the Elasticsearch endpoint for the low level API:

client, err := elasticsearch.NewClient(elasticsearch.Config{
    CloudID: "<CloudID>",
    APIKey: "<ApiKey>",
})

You can connect to the Elastic Cloud using an API key and the Elasticsearch endpoint for the fully-typed API:

typedClient, err := elasticsearch.NewTypedClient(elasticsearch.Config{
    CloudID: "<CloudID>",
    APIKey:  "<ApiKey>",
})

Your Elasticsearch endpoint can be found on the My deployment page of your deployment:

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

For other connection options, refer to the Connecting section.

Operations

edit

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 Examples page.

Creating an index

edit

This is how you create the my_index index with the low level API:

client.Indices.Create("my_index")

This is how you create the my_index index with the fully-typed API:

typedClient.Indices.Create("my_index").Do(context.TODO())

Indexing documents

edit

This is a simple way of indexing a document by using the low-level API:

document := struct {
    Name string `json:"name"`
}{
    "go-elasticsearch",
}
data, _ := json.Marshal(document)
client.Index("my_index", bytes.NewReader(data))

This is a simple way of indexing a document by using the fully-typed API:

document := struct {
    Name string `json:"name"`
}{
    "go-elasticsearch",
}
typedClient.Index("my_index").
		Id("1").
		Request(document).
		Do(context.TODO())

Getting documents

edit

You can get documents by using the following code with the low-level API:

client.Get("my_index", "id")

This is how you can get documents by using the fully-typed API:

typedClient.Get("my_index", "id").Do(context.TODO())

Searching documents

edit

This is how you can create a single match query with the low-level API:

query := `{ "query": { "match_all": {} } }`
client.Search(
    client.Search.WithIndex("my_index"),
    client.Search.WithBody(strings.NewReader(query)),
)

This is how you can perform a single match query with the fully-typed API:

typedClient.Search().
    Index("my_index").
    Request(&search.Request{
        Query: &types.Query{MatchAll: &types.MatchAllQuery{}},
    }).
    Do(context.TODO())

Updating documents

edit

This is how you can update a document, for example to add a new field, by using the low-level API:

client.Update("my_index", "id", strings.NewReader(`{doc: { language: "Go" }}`))

This is how you can update a document with the fully-typed API:

typedClient.Update("my_index", "id").
	Request(&update.Request{
        Doc: json.RawMessage(`{ language: "Go" }`),
    }).Do(context.TODO())

Deleting documents

edit

client.Delete("my_index", "id")

typedClient.Delete("my_index", "id").Do(context.TODO())

Deleting an index

edit

client.Indices.Delete([]string{"my_index"})

typedClient.Indices.Delete("my_index").Do(context.TODO())

Getting started

Getting started

Requirements

Installation

Connecting

Operations

Creating an index

Indexing documents

Getting documents

Searching documents

Updating documents

Deleting documents

Deleting an index

Further reading