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+main/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

This version

8.2.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-8.2.1.tar.gz (300.5 kB view details)

Uploaded Source

Built Distribution

elasticsearch-8.2.1-py3-none-any.whl (378.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for elasticsearch-8.2.1.tar.gz
Algorithm Hash digest
SHA256 93b2bf3579129182220ba1eba390637e182def6f30c78be658c066ba928bf271
MD5 3d80cc4d1724eda0990b24281e28843e
BLAKE2b-256 4ef2e7af8a6d9e1ff99dd6d5664d2bf2ed13169715d1c70f31ab1ba54220ab83

See more details on using hashes here.

Provenance

File details

Details for the file elasticsearch-8.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for elasticsearch-8.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a9a955cb200b3b7d0c68dc500433d61e0e2fb35bedeb35ffd128a1faaf3a66c9
MD5 a26bccdaafff45ba96ba2ecc7a6792fc
BLAKE2b-256 f57cbb2263967705d1b0fdbcdd60a95179a08a878b470ff75e911d672012ad68

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