Skip to main content

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 Elasticsearch 5.x. For Elasticsearch 2.x please use elasticsearch2 and for future releases use elasticsearcch.

Installation

Install the elasticsearch5 package with pip:

pip install 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)
{u'acknowledged': True}

# datetimes will be serialized
>>> es.index(index="my-index", doc_type="test-type", id=42, body={"any": "data", "timestamp": datetime.now()})
{u'_id': u'42', u'_index': u'my-index', u'_type': u'test-type', u'_version': 1, u'ok': True}

# but not deserialized
>>> es.get(index="my-index", doc_type="test-type", id=42)['_source']
{u'any': u'data', u'timestamp': u'2013-05-12T19:45:31.804229'}

Full documentation.

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 2017 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

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.

Build status

https://secure.travis-ci.org/elastic/elasticsearch-py.png

Release files for elasticsearch5 5.5.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for elasticsearch5 5.5.6
File Size Uploaded
elasticsearch5-5.5.6.tar.gz 69.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for elasticsearch5 5.5.6
File Interpreter ABI Platform
elasticsearch5-5.5.6-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 132.4 kB

Release files / elasticsearch5-5.5.6.tar.gz

Download URL elasticsearch5-5.5.6.tar.gz
Size 69.8 kB
Tags Source
SHA-256 checksum
How to use checksums
331ce226182c75cfdf6b823f9f30b5a555fa91b85f1d05ac9958758150e2e8c7
BLAKE2b-256 checksum
How to use checksums
7b884034caa9d9ed852e681d1ad1d374aa10046cc9e9cc41ebc70dbccd43ed11
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/3.7

Release files / elasticsearch5-5.5.6-py2.py3-none-any.whl

Download URL elasticsearch5-5.5.6-py2.py3-none-any.whl
Size 62.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
3d95aef3317b1e28288ab8dd2ee38e2a6aae96df14ffcd4ecbea4f681dc4891d
BLAKE2b-256 checksum
How to use checksums
de999cfd6881a4242a5d03c5c817b0f3231ba3afe5248118e2be465c29c51dce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/3.7

Release history Release notifications | RSS feed

This release

5.5.6 This release

2 release files

5.5.5

2 release files

5.5.4

2 release files

5.5.3

2 release files

5.5.2

2 release files

5.5.1

2 release files

5.5.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page