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

Uploaded Source

Built Distribution

elasticsearch-8.5.2-py3-none-any.whl (385.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for elasticsearch-8.5.2.tar.gz
Algorithm Hash digest
SHA256 7fd57b89b1dfc3c976a71af58376d300a4e40dfcdd22ea2573ce6a830c9ad7c2
MD5 9fd209b012fc391c5ecec7a808a8b2e7
BLAKE2b-256 4483d5acc769814c8c992306ec47ee0541b9ea1c9598851a589419be78a64034

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for elasticsearch-8.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 100ead24d2a20d40227bde9c586c9e32b820d15d3dfb4f12204d6b11841f029e
MD5 767662f5e3cc879c4141cfa2f4431754
BLAKE2b-256 27e59a1948bf444ed9382e82f8be375e661cb042e5aa86ef554a187f90b92455

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