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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: elasticsearch8-8.8.1.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.1.tar.gz
Algorithm Hash digest
SHA256 64ff2499e7adb6f82cd83b49a70ee661d2d149bd3af06655a44974e91d186f85
MD5 34f955a57c3b191b7783404256217c70
BLAKE2b-256 a738e8395425f3a4b313227e1cb31d8c716af7fe5b833b828a35a8bb4fc1ea6d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for elasticsearch8-8.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9d483115e5107d5add43245f05f661150dd2b811f0d19c8f701d2fe6f2614915
MD5 3e8faff5e085b355cf020c2099940fbb
BLAKE2b-256 6d280d6c4356251e041da4a8d4e72815243b648ddb4784abda708bb42787e407

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