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.1.1

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.1.1.tar.gz (52.7 kB view details)

Uploaded Source

Built Distribution

elasticsearch-1.1.1-py2.py3-none-any.whl (51.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for elasticsearch-1.1.1.tar.gz
Algorithm Hash digest
SHA256 6d86968b22f09a5e4f830ea3f3090c039ff5416146fa98b4a59a6b1dd5388759
MD5 9d096a1fcacd98c6b97d5478f0633d20
BLAKE2b-256 07ef437927cc0549ba8bce070a45323d016209f18b6eb8a7a9e1da9cdafedfe8

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for elasticsearch-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 93ab9d59dc38b4c9893aecf23a55ff88b237c3b876bce23b636a8a767f5729be
MD5 37d19cfce531d7a1bd39f938d82c95c4
BLAKE2b-256 44d3ac331a7595d2b6ae44840dbe5d7d62797ffb93d6cf6ec380ec72a48ba2b6

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