Skip to main content

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.

Compatibility

The library is compatible with both Elasticsearch 1.x and 0.90.x but you have to use a matching version.

For Elasticsearch 1.0 and later, use the major version 1 (1.x.y) of the library.

For Elasticsearch 0.90.x, use a version from 0.4.x releases of the library.

The recommended way to set your requirements in your setup.py or requirements.txt is:

# Elasticsearch 1.0
elasticsearch>=1.0.0,<2.0.0

# Elasticsearch 0.90
elasticsearch<1.0.0

The development is happening on master and 0.4 branches, respectively.

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)
{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)

  • thread safety

  • pluggable architecture

License

Copyright 2013 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/elasticsearch/elasticsearch-py.png

Project details


Release history Release notifications | RSS feed

This version

1.2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elasticsearch-1.2.0.tar.gz (55.4 kB view details)

Uploaded Source

Built Distribution

elasticsearch-1.2.0-py2.py3-none-any.whl (51.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file elasticsearch-1.2.0.tar.gz.

File metadata

File hashes

Hashes for elasticsearch-1.2.0.tar.gz
Algorithm Hash digest
SHA256 bb93d85ca7e50d68e4197852bb6dba6098bb772500f82f5db2ff4a80711505c9
MD5 56f240ec92b7241bf3b9f37a497c307c
BLAKE2b-256 52a219467638f7b766ad9c9cbad3b16e0ecb3dd8a82f59f64386b57cb42138fa

See more details on using hashes here.

Provenance

File details

Details for the file elasticsearch-1.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for elasticsearch-1.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 53a822b01b0494df9658c04e87216180e5ecbe85b178673dd848b1f809d5c100
MD5 ca83e0d81a1813835fdb0be2a57e6557
BLAKE2b-256 ef7a423e66aaaddac747a3883775895f8de381a3d5f44c902c22ac834ba9774c

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page