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; meaning that the clients support communicating with greater or equal minor versions of Elasticsearch without breaking. It does not mean that the clients automatically support new features of newer Elasticsearch versions; it is only possible after a release of a new client version. For example, a 8.12 client version won't automatically support the new features of the 8.13 version of Elasticsearch, the 8.13 client version is required for that. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.

Elasticsearch Version Elasticsearch-Python Branch Supported
main main
8.x 8.x 8.x
7.x 7.x 7.17

If you have a need to have multiple versions installed at the same time older versions are also released as elasticsearch7 and elasticsearch8.

Documentation

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

Feedback 🗣️

The engineering team here at Elastic is looking for developers to participate in research and feedback sessions to learn more about how you use our Python client and what improvements we can make to their design and your workflow. If you're interested in sharing your insights into developer experience and language client design, please fill out this short form. Depending on the number of responses we get, we may either contact you for a 1:1 conversation or a focus group with other developers who use the same client. Thank you in advance - your feedback is crucial to improving the user experience for all Elasticsearch developers!

License

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

Project details


Download files

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

Source Distribution

elasticsearch8-8.17.1.tar.gz (541.1 kB view details)

Uploaded Source

Built Distribution

elasticsearch8-8.17.1-py3-none-any.whl (654.2 kB view details)

Uploaded Python 3

File details

Details for the file elasticsearch8-8.17.1.tar.gz.

File metadata

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

File hashes

Hashes for elasticsearch8-8.17.1.tar.gz
Algorithm Hash digest
SHA256 bb414b7e3d8387697946208f0f0b6e5e79bcf165cd021234b2ec7e5200d33690
MD5 f44a884b0208cd04d6138f4a61661e3f
BLAKE2b-256 adacd3f6a356f773d5db93d44f5938b55e2cd5f5d7dd051bc96aa86bf6a272ae

See more details on using hashes here.

File details

Details for the file elasticsearch8-8.17.1-py3-none-any.whl.

File metadata

File hashes

Hashes for elasticsearch8-8.17.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c3e12138736c5614d9803016618a573effcf40bbb93838df14ae281680fe2260
MD5 a3d81e243f21ecced2edabcc818431b9
BLAKE2b-256 d212e602c3d591a0f1faa2124f0f08822e82e8882243c23d35d67d1a81d560f1

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