Development Status
- 5 - Production/Stable
License
- OSI Approved :: Apache Software License
Intended Audience
- Developers
Operating System
- OS Independent
Programming Language
- Python
- Python :: 3
- Python :: 3.7
- Python :: 3.8
- Python :: 3.9
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: Implementation :: CPython
- Python :: Implementation :: PyPy
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-py 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.
License
Copyright 2023 Elasticsearch B.V. Licensed under the Apache License, Version 2.0.
