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


Release history Release notifications | RSS feed

Download files

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

Source Distribution

elasticsearch-8.15.0.tar.gz (412.9 kB view details)

Uploaded Source

Built Distribution

elasticsearch-8.15.0-py3-none-any.whl (523.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: elasticsearch-8.15.0.tar.gz
  • Upload date:
  • Size: 412.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for elasticsearch-8.15.0.tar.gz
Algorithm Hash digest
SHA256 d4702b4fa698ef154c6f1187988192343fb5505aee97fc4450a6d20df1683f35
MD5 a8b9491625b6f7d8b5f0b40f54af3b86
BLAKE2b-256 efb0735e07106fe67c20b95ac02feb3b843b5a36df95bdd79eac21b7d43fa34b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for elasticsearch-8.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7ec4d0771b8f6f76c6331e61b408261f9307264735ec7f2539f580824faaafe3
MD5 d9f67e8ef0a351528266be8716602b96
BLAKE2b-256 abdc87c47f9c42f8188d24f6c589ed0e8168a0fef7091e5ccffdbc950be7ab66

See more details on using hashes here.

Provenance

Supported by

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