Python Elasticsearch Client
Official low-level client for Elasticsearch. Its goal is to provide common ground for all Elasticsearch-related code in Python; because of this it tries to be opinion-free and very extendable.
Installation
Install the elasticsearch package with pip:
$ python -m pip install elasticsearch
If your application uses async/await in Python you can install with the async extra:
$ python -m pip install elasticsearch[async]
Read more about how to use asyncio with this project.
Compatibility
The library is compatible with all Elasticsearch versions since 0.90.x but you have to use a matching major version:
For Elasticsearch 7.0 and later, use the major version 7 (7.x.y) of the library.
For Elasticsearch 6.0 and later, use the major version 6 (6.x.y) of the library.
For Elasticsearch 5.0 and later, use the major version 5 (5.x.y) of the library.
For Elasticsearch 2.0 and later, use the major version 2 (2.x.y) of the library, and so on.
The recommended way to set your requirements in your setup.py or requirements.txt is:
# Elasticsearch 7.x elasticsearch>=7.0.0,<8.0.0 # Elasticsearch 6.x elasticsearch>=6.0.0,<7.0.0 # Elasticsearch 5.x elasticsearch>=5.0.0,<6.0.0 # Elasticsearch 2.x elasticsearch>=2.0.0,<3.0.0
If you have a need to have multiple versions installed at the same time older versions are also released as elasticsearch2 and elasticsearch5.
Example use
Simple use-case:
>>> from datetime import datetime
>>> from elasticsearch import Elasticsearch
# by default we connect to localhost:9200
>>> es = Elasticsearch()
# create an index in elasticsearch, ignore status code 400 (index already exists)
>>> es.indices.create(index='my-index', ignore=400)
{'acknowledged': True, 'shards_acknowledged': True, 'index': 'my-index'}
# datetimes will be serialized
>>> es.index(index="my-index", id=42, body={"any": "data", "timestamp": datetime.now()})
{'_index': 'my-index',
'_type': '_doc',
'_id': '42',
'_version': 1,
'result': 'created',
'_shards': {'total': 2, 'successful': 1, 'failed': 0},
'_seq_no': 0,
'_primary_term': 1}
# but not deserialized
>>> es.get(index="my-index", id=42)['_source']
{'any': 'data', 'timestamp': '2019-05-17T17:28:10.329598'}
Elastic Cloud (and SSL) use-case:
>>> from elasticsearch import Elasticsearch
>>> es = Elasticsearch(cloud_id="<some_long_cloud_id>", http_auth=('elastic','yourpassword'))
>>> es.info()
Using SSL Context with a self-signed cert use-case:
>>> from elasticsearch import Elasticsearch
>>> from ssl import create_default_context
>>> context = create_default_context(cafile="path/to/cafile.pem")
>>> es = Elasticsearch("https://elasticsearch.url:port", ssl_context=context, http_auth=('elastic','yourpassword'))
>>> es.info()
Features
The client's features include:
- translating basic Python data types to and from json (datetimes are not decoded for performance reasons)
- configurable automatic discovery of cluster nodes
- persistent connections
- load balancing (with pluggable selection strategy) across all available nodes
- failed connection penalization (time based - failed connections won't be retried until a timeout is reached)
- support for ssl and http authentication
- thread safety
- pluggable architecture
Elasticsearch-DSL
For a more high level client library with more limited scope, have a look at elasticsearch-dsl - a more pythonic library sitting on top of elasticsearch-py.
elasticsearch-dsl provides a more convenient and idiomatic way to write and manipulate queries by mirroring the terminology and structure of Elasticsearch JSON DSL while exposing the whole range of the DSL from Python either directly using defined classes or a queryset-like expressions.
It also provides an optional persistence layer for working with documents as Python objects in an ORM-like fashion: defining mappings, retrieving and saving documents, wrapping the document data in user-defined classes.
License
Copyright 2020 Elasticsearch B.V
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
![TransportError(406, 'Content-Type header [] is not supported') - where to find requirements.txt](https://avatars.githubusercontent.com/u/35953908?v=4)
![urllib3.exceptions.NewConnectionError: <urllib3.connection.HTTPConnection object at 0x7f9e5db5d208>: Failed to establish a new connection: [Errno 113] No route to host](https://avatars.githubusercontent.com/u/8775515?v=4)
![ConnectionResetError: [WinError 10054] An existing connection was forcibly closed by the remote host](https://avatars.githubusercontent.com/u/30790120?v=4)
3 Nov 15, 2021
45 Jan 02, 2023
348 Jan 03, 2023
33 Dec 08, 2022
9.7k Dec 30, 2022
554 Dec 04, 2022
2 Oct 05, 2022
1 Jan 09, 2022
253 Dec 31, 2022
12 Nov 23, 2022
2.1k Dec 26, 2022
17 Dec 25, 2022
251 Oct 25, 2022
1 Nov 30, 2021
6.9k Jan 03, 2023
3 Nov 04, 2022
5.5k Jan 08, 2023
185 Jan 01, 2023
2.1k Dec 30, 2022
205 Dec 16, 2022