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

Uploaded Source

Built Distribution

elasticsearch-8.1.3-py3-none-any.whl (373.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: elasticsearch-8.1.3.tar.gz
  • Upload date:
  • Size: 295.1 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.3.tar.gz
Algorithm Hash digest
SHA256 70d4ab4a4dcfc2631aaaf58853984b3e7658b85a490f4d2d2c657e91437bb620
MD5 2bcce7bdb54e8d490a691dbcc67ab065
BLAKE2b-256 e9054545641871eac94890c9ac85f363040f72eb86b895c2b0344630251ebadb

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for elasticsearch-8.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d092f4a0d3f4228753cd06d4f70438aec101e13206b31425910d807ec23f232b
MD5 bd3a4eb163ececd41a8d98d9e3e1e57e
BLAKE2b-256 94a651fd2afbc2110d34b6aa5347cbc06f08396f4bb7ee716e2886a521fc13dd

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