Repository files navigation

The official Python client for Elasticsearch.

• Translating basic Python data types to and from JSON
• Configurable automatic discovery of cluster nodes
• Persistent connections
• Load balancing (with pluggable selection strategy) across available nodes
• Failed connection penalization (time based - failed connections won't beretried until a timeout is reached)
• Support for TLS and HTTP authentication
• Thread safety across requests
• Pluggable architecture
• Helper functions for idiomatically using APIs together

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

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

Language clients areforward compatible: each client version works with equivalent and later minor versions of Elasticsearch without breaking.

Compatibility does not imply full 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; however, it does not support new Elasticsearch 8.13 features. An 8.13 client fully supports Elasticsearch 8.13 features.

Elasticsearch language clients are alsobackward compatible across minor versions — with default distributions and without guarantees.

If you need to work with multiple client versions, note that older versions are also released aselasticsearch7 andelasticsearch8.

Documentation for the client isavailable on elastic.co andRead the Docs.

If you want to try Elasticsearch and Kibana locally, you can run the following command:

curl -fsSL https://elastic.co/start-local| sh

This will run Elasticsearch athttp://localhost:9200 and Kibana athttp://localhost:5601.

More information is availablehere.

SeeCONTRIBUTING.md

This software is licensed under theApache License 2.0. SeeNOTICE.