Skip to main content

Python client for Elasticsearch

Project description

Elastic logo

Elasticsearch Python Client

PyPI Version Python Versions Conda Version Downloads
Build Status on GitHub Buildkite Status on Buildkite Documentation Status

The official Python client for Elasticsearch.

Features

  • 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 be retried until a timeout is reached)
  • Support for TLS and HTTP authentication
  • Thread safety across requests
  • Pluggable architecture
  • Helper functions for idiomatically using APIs together

Installation

Download the latest version of Elasticsearch or sign-up for a free trial of Elastic Cloud.

Refer to the Installation section of the getting started documentation.

Connecting

Refer to the Connecting section of the getting started documentation.

Usage


Compatibility

Language clients are forward 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 version elasticsearch-py branch
main main
9.x 9.x
9.x 8.x
8.x 8.x

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

[!TIP] To upgrade to a new major version, first upgrade Elasticsearch, then upgrade the Python Elasticsearch client.

If you need to work with multiple client versions, note that older versions are also released as elasticsearch7 and elasticsearch8.

Documentation

Documentation for the client is available on elastic.co and Read the Docs.

License

This software is licensed under the Apache License 2.0. See NOTICE.

Project details


Release history Release notifications | RSS feed

This version

9.0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elasticsearch-9.0.2.tar.gz (829.5 kB view details)

Uploaded Source

Built Distribution

elasticsearch-9.0.2-py3-none-any.whl (914.3 kB view details)

Uploaded Python 3

File details

Details for the file elasticsearch-9.0.2.tar.gz.

File metadata

  • Download URL: elasticsearch-9.0.2.tar.gz
  • Upload date:
  • Size: 829.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for elasticsearch-9.0.2.tar.gz
Algorithm Hash digest
SHA256 290e790153500d9f3cb66d74918ac70e9f96b5cd88147213859edca6ab5013f5
MD5 bbab1a5c6864c11f575214388e4ac395
BLAKE2b-256 7f63a296828c46fd162a95ed1c560a3fdcea6a68a3b7c45d2aa60594f33eaf1b

See more details on using hashes here.

File details

Details for the file elasticsearch-9.0.2-py3-none-any.whl.

File metadata

  • Download URL: elasticsearch-9.0.2-py3-none-any.whl
  • Upload date:
  • Size: 914.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for elasticsearch-9.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 47cac1f0e5e7be8d8c6751a5d7818d416adfc11eac72f1b59e145930a87de880
MD5 8d83caf8d3249ebf0cd15acc2499cb3e
BLAKE2b-256 3e81eadbbc38011dd3380dac72a142b175b4a174fa671c584ec38701995b1991

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page