Python client for Elasticsearch
Project description
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.
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.
It provides a more convenient and idiomatic way to write and manipulate queries. It stays close to the Elasticsearch JSON DSL, mirroring its terminology and structure 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.
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 elasticsearch6>=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.
Installation
Install the elasticsearch package with pip:
pip install elasticsearch
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
License
Copyright 2019 Elasticsearch
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
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.
Build status
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
File details
Details for the file elasticsearch-7.0.5.tar.gz.
File metadata
- Download URL: elasticsearch-7.0.5.tar.gz
- Upload date:
- Size: 86.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 693935914d59a517dfffdaab547ff906712a386d9e25027517464960221cbd4c |
|
| MD5 | 194f564639a7aa7cf51ebe4b9a1597cf |
|
| BLAKE2b-256 | 0ef2e388e7b5878fe661eebe9ac0e87c69c3485b8c55a933eae55781e1f02c7b |
Provenance
File details
Details for the file elasticsearch-7.0.5-py2.py3-none-any.whl.
File metadata
- Download URL: elasticsearch-7.0.5-py2.py3-none-any.whl
- Upload date:
- Size: 83.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7644fa0a9ae524344185bda561826a781a5c6bd4d3eb98a24515c567aab88327 |
|
| MD5 | 8374020c6c818d3233981ce37718aee9 |
|
| BLAKE2b-256 | ecb9ff5793ee7cf7fd43ff9ae0b3c70d40485520296f03fb6b1afd65a4819c0e |
