Elasticsearch Python client

This documentation covers the official Python client for Elasticsearch. The Python client provides a comprehensive foundation for working with Elasticsearch in Python. The client is designed to be unopinionated and extensible.

Here's an example of basic Python client usage:

import os
from elasticsearch import Elasticsearch

def main():
    client = Elasticsearch(
        hosts=[os.getenv("ELASTICSEARCH_URL")],
        api_key=os.getenv("ELASTIC_API_KEY"),
    )

    resp = client.search(
        index="my-index-000001",
        from_=40,
        size=20,
        query={
            "term": {
                "user.id": "kimchy"
            }
        },
    )
    print(resp)
		

import os
from elasticsearch import AsyncElasticsearch

async def main():
    client = AsyncElasticsearch(
        hosts=[os.getenv("ELASTICSEARCH_URL")],
        api_key=os.getenv("ELASTIC_API_KEY"),
    )

    resp = await client.search(
        index="my-index-000001",
        from_=40,
        size=20,
        query={
            "term": {
                "user.id": "kimchy"
            }
        },
    )
    print(resp)
		

The Elasticsearch Python client package consists of several modules: the core client, a set of bulk helper functions, an ES|QL query builder, and a DSL module.

This module, also known as the low-level client, enables sending requests to Elasticsearch servers. The client provides access to the entire surface of the Elasticsearch API.

• Getting started
• Walkthrough: Ingest data with Python
• Reference documentation

The core client's features include:

• Translating basic Python data types to and from JSON
• Configurable automatic discovery of cluster nodes
• Persistent connections
• Load balancing (with pluggable selection strategy) across all available nodes
• Node timeouts on transient errors
• Thread safety
• Pluggable architecture

The bulk helpers simplify ingesting large amounts of data, by providing a high-level interface based on Python iterables.

• Client helpers > Bulk helpers
• Reference documentation

The ES|QL query builder offers an idiomatic interface for constructing ES|QL queries using Python expressions.

• ES|QL query builder
• Reference documentation

The DSL module can be thought of as a high-level client for Elasticsearch. It allows applications to manipulate documents and queries using Python classes and objects, instead of primitive types such as dictionaries and lists.

• Elasticsearch Python DSL
• Reference documentation

Compatibility does not imply feature parity. New Elasticsearch features are supported only in equivalent client versions. For example, an 8.12 client fully supports Elasticsearch 8.12 features and works with 8.13 without breaking, but it does not support new Elasticsearch 8.13 features. An 8.13 client fully supports Elasticsearch 8.13 features.

Elasticsearch language clients are also backward compatible across minor versions, with default distributions and without guarantees.

As of version 8.0, Elasticsearch offers a compatibility mode for smoother upgrades. In compatibility mode, you can upgrade your Elasticsearch cluster to the next major version while continuing to use your existing client during the transition.

For example, if you're upgrading Elasticsearch from 8.x to 9.x, you can continue to use the 8.x Python client during and after the Elasticsearch server upgrade, with the exception of breaking changes.

In the Python client, compatibility mode is always enabled.