Python client for Elasticsearch
Project description
Elasticsearch Python Client
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
- Creating an index
- Indexing a document
- Getting documents
- Searching documents
- Updating documents
- Deleting documents
- Deleting an index
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.
Try Elasticsearch and Kibana locally
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 at http://localhost:9200 and Kibana at http://localhost:5601.
More information is available here.
Contributing
See CONTRIBUTING.md
License
This software is licensed under the Apache License 2.0. See NOTICE.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file elasticsearch-9.2.0.tar.gz.
File metadata
- Download URL: elasticsearch-9.2.0.tar.gz
- Upload date:
- Size: 875.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 99656baa34b10130402b6c38429feddf7aee1c3247566e8f95f0d0267fe9f9ab | |
| MD5 | 2d38707ffa864a8be29a347da9435b5f | |
| BLAKE2b-256 | 7c876e70b8dac9c781c53edba944b50545431e2bb937d21c06d6009ef18b5f91 |
File details
Details for the file elasticsearch-9.2.0-py3-none-any.whl.
File metadata
- Download URL: elasticsearch-9.2.0-py3-none-any.whl
- Upload date:
- Size: 960.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 87090fe98c515ec0fce82f633fe11d7e90e04d93581b6b3e05de29efe4cc8b74 | |
| MD5 | 591f36b2af6c36148e8b03507c97ac85 | |
| BLAKE2b-256 | 21f26b44ee99e90c9d9e183aafeea0c3af87176d4acef446c286223704ea8f2e |
