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 or equal minor versions of Elasticsearch. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.

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

Uploaded Source

Built Distribution

elasticsearch-7.17.5-py2.py3-none-any.whl (385.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: elasticsearch-7.17.5.tar.gz
  • Upload date:
  • Size: 247.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.3

File hashes

Hashes for elasticsearch-7.17.5.tar.gz
Algorithm Hash digest
SHA256 ad67d01f94443a821c8cd3b90c777946ff99c4cad1da26090c5171157b4a1008
MD5 1b639e6c40c2b200b9a24b7d7ea4cb83
BLAKE2b-256 dd56256e6e9f1d25db17bc0ef4c02cc01189dd045a4f10ee93f11610149bf6c6

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for elasticsearch-7.17.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1cca401df5ec5cf28c51dae21d11810e4f0289bd6e3985cbefe09c05e6428adb
MD5 1d10cdb233460f1c912de13ff37f2879
BLAKE2b-256 5e2f55b3da932a7aa844e9e790dc5d60c7bda4c6f0f0551802ea0dac54741ce4

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