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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elasticsearch8-8.8.2.tar.gz (312.2 kB view details)

Uploaded Source

Built Distribution

elasticsearch8-8.8.2-py3-none-any.whl (394.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for elasticsearch8-8.8.2.tar.gz
Algorithm Hash digest
SHA256 acc891cf9024294d2a094591070999ff97ff3966c5eb15513714a479e0013de0
MD5 5b9ddb3639b93521da5e8834a7254040
BLAKE2b-256 707bbd5df95ba47045221fdad2391ac7092f856c780f3b82683c93f628f07eb1

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for elasticsearch8-8.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d25776e7bf67330187affcb36d7340b80a9622160b49cd621d81878f868dd742
MD5 cc83609c6c9dd3e81749aabfd63218eb
BLAKE2b-256 de54a4282fd61426c3fd8820120c990c3e299f0332d22dd57495c5e6d67dba87

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