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


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

Uploaded Source

Built Distribution

elasticsearch8-8.3.3-py3-none-any.whl (382.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: elasticsearch8-8.3.3.tar.gz
  • Upload date:
  • Size: 303.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.3

File hashes

Hashes for elasticsearch8-8.3.3.tar.gz
Algorithm Hash digest
SHA256 3d9caf19219fcb688dca6a130c636c09cedf43ffa3a8d7617ec37888588aad32
MD5 e0751451b85564718100c468aa199ac4
BLAKE2b-256 c115e0384b57e392ed07467c762f754becd087b094a768f4a391de8392a5abad

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for elasticsearch8-8.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d21fa127425dd78aa63425d2352b691df228f14dec56938cdeed6e13a448a8dd
MD5 0a90d5122f18749607e295b7e8e63a13
BLAKE2b-256 a90b1b06a31559c7e51a67cda84f5bac8053dbf4aee3fa7e5196290d752b230c

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