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

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

Uploaded Source

Built Distribution

elasticsearch-8.1.2-py3-none-any.whl (372.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: elasticsearch-8.1.2.tar.gz
  • Upload date:
  • Size: 294.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.6

File hashes

Hashes for elasticsearch-8.1.2.tar.gz
Algorithm Hash digest
SHA256 bf031b44c483f6dc40d607186103d8a152ce4ade96e4ed4c656f2421f794e123
MD5 ab638ed6d3c58990020064c39efb7bfd
BLAKE2b-256 065ace95e5c6acbdeb53b0938e7dbe605da9f366b65fb9704cf71d90b0ad6cf2

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for elasticsearch-8.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2fd3c88bc5fef259ab936538287404b2c3c5956630944563722d5b16a4edc550
MD5 b0b8c60e148ef126c1d4481133653caa
BLAKE2b-256 a59315400de7f1c8b51cada8599d01dd0087a6c8aca7315469a82bb38ecaa8be

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