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

This version

8.8.2

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

Uploaded Source

Built Distribution

elasticsearch-8.8.2-py3-none-any.whl (393.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for elasticsearch-8.8.2.tar.gz
Algorithm Hash digest
SHA256 bed8cf8fcc6c3be7c254b579de4c29afab021f373c832246f912d37aef3c6bd5
MD5 9560d96a023475839fbf458bde4e275f
BLAKE2b-256 2301ce9679605aa17dfd256549480f6f05ba014e9ea5ee3594ec7fb78fe5484f

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for elasticsearch-8.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bffd6ce4faaacf90e6f617241773b3da8fb94e2e83554f5508e2fab92ca79643
MD5 73e2f68b745aa88ff1ec66e1bd843179
BLAKE2b-256 1d8fcc916b381db044072966510b4c4472773ee60dc6589e6f8856eaecfe4aa6

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