Getting started
editGetting started
editThis page guides you through the installation process of the Python client, shows you how to instantiate the client, and how to perform basic Elasticsearch operations with it.
Requirements
editInstallation
editTo install the latest version of the client, run the following command:
python -m pip install elasticsearch
Refer to the Installation page to learn more.
Connecting
editYou can connect to the Elastic Cloud using an API key and the Elasticsearch endpoint.
from elasticsearch import Elasticsearch client = Elasticsearch( "https://...", # Elasticsearch endpoint api_key="api_key", )
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
editTime 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
editThis is how you create the my_index
index:
client.indices.create(index="my_index")
Indexing documents
editThis is a simple way of indexing a document:
client.index( index="my_index", id="my_document_id", document={ "foo": "foo", "bar": "bar", } )
Getting documents
editYou can get documents by using the following code:
client.get(index="my_index", id="my_document_id")
Searching documents
editThis is how you can create a single match query with the Python client:
client.search(index="my_index", query={ "match": { "foo": "foo" } })
Updating documents
editThis is how you can update a document, for example to add a new field:
client.update(index="my_index", id="my_document_id", doc={ "foo": "bar", "new_field": "new value", })
Deleting documents
editclient.delete(index="my_index", id="my_document_id")
Deleting an index
editclient.indices.delete(index="my_index")
Further reading
edit- Use Client helpers for a more comfortable experience with the APIs.