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 2023 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.8.0.tar.gz (312.2 kB view details)

Uploaded Source

Built Distribution

elasticsearch-8.8.0-py3-none-any.whl (393.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: elasticsearch-8.8.0.tar.gz
  • Upload date:
  • Size: 312.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for elasticsearch-8.8.0.tar.gz
Algorithm Hash digest
SHA256 6878313cd598c7c90079fed1d4be72e198da35cba57f4083e6bee91f9c70b0eb
MD5 92dd145459e17b8e0599d22860626ae3
BLAKE2b-256 abee0185edf87ae3049a1e7f0309f1bf2ba92640bef8073d980bae726cd15bd8

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for elasticsearch-8.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2223ee9daaa3c80c25b28ec3f7c48e66fce6b767a338333d9a81886046a07df6
MD5 0a77dadda916ee5f1c7a1b55f017c610
BLAKE2b-256 bd0cf2b42564ca8746a769487d3a7ab4f038b44498dfeaed684c58b0d075df6d

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