Skip to main content

Python client for Elasticsearch

Project description

https://img.shields.io/pypi/v/elasticsearch https://img.shields.io/conda/vn/conda-forge/elasticsearch?color=blue https://pepy.tech/badge/elasticsearch https://clients-ci.elastic.co/job/elastic+elasticsearch-py+master/badge/icon https://readthedocs.org/projects/elasticsearch-py/badge/?version=latest&style=flat

The official Python client for Elasticsearch.

Features

  • Translating basic Python data types to and from JSON

  • Configurable automatic discovery of cluster nodes

  • Persistent connections

  • Load balancing (with pluggable selection strategy) across available nodes

  • Failed connection penalization (time based - failed connections won’t be retried until a timeout is reached)

  • Support for TLS and HTTP authentication

  • Thread safety across requests

  • Pluggable architecture

  • Helper functions for idiomatically using APIs together

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

Language clients are forward compatible; meaning that clients support communicating with greater minor versions of Elasticsearch. Elastic language clients are also backwards compatible with lesser supported minor Elasticsearch versions.

If you have a need to have multiple versions installed at the same time older versions are also released as elasticsearch2 and elasticsearch5.

Documentation

Documentation for the client is available on elastic.co and Read the Docs.

Quick Start

# Import the client from the 'elasticsearch' module
>>> from elasticsearch import Elasticsearch

# Instantiate a client instance
>>> client = Elasticsearch("http://localhost:9200")

# Call an API, in this example `info()`
>>> resp = client.info()

# View the result
>>> resp
{
  "name" : "instance-name",
  "cluster_name" : "cluster-name",
  "cluster_uuid" : "cluster-uuid",
  "version" : {
    "number" : "7.14.0",
    ...
  },
  "tagline" : "You know, for Search"
}

You can read more about configuring the client in the documentation.

License

Copyright 2021 Elasticsearch B.V. Licensed under the Apache License, Version 2.0.

Project details


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

elasticsearch-7.15.0a1.tar.gz (241.7 kB view details)

Uploaded Source

Built Distribution

elasticsearch-7.15.0a1-py2.py3-none-any.whl (377.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file elasticsearch-7.15.0a1.tar.gz.

File metadata

  • Download URL: elasticsearch-7.15.0a1.tar.gz
  • Upload date:
  • Size: 241.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.6

File hashes

Hashes for elasticsearch-7.15.0a1.tar.gz
Algorithm Hash digest
SHA256 8ece6152b4e4598c527a4ced6451e8ebddb1dcc16d2afc40b089207ad285ccea
MD5 b974359e57307be4d271f9a4e4c580d3
BLAKE2b-256 7595ea0299b34a47c4e16811d76b6792d1379dc72fd8767b2d1c8db01d682a92

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: elasticsearch-7.15.0a1-py2.py3-none-any.whl
  • Upload date:
  • Size: 377.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.6

File hashes

Hashes for elasticsearch-7.15.0a1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0498be231c1551b813f7f9c4c02f7e80e1bbb0f743898d2b143e3e2caf92f6d2
MD5 650d8b0aa82265099a8f6bdc2b471563
BLAKE2b-256 7e3d3eedaea7a53f1efd9976be8349bb74d2601acef089da90a462fe94158e38

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