Skip to main content

Elasticsearch Serverless Python Client

https://img.shields.io/pypi/v/elasticsearch-serverless https://img.shields.io/conda/vn/conda-forge/elasticsearch-serverless?color=blue https://static.pepy.tech/badge/elasticsearch-serverless https://clients-ci.elastic.co/job/elastic+elasticsearch-serverless-python+main/badge/icon https://readthedocs.org/projects/elasticsearch-serverless-python/badge/?version=latest&style=flat

The official Python client for Elasticsearch Serverless.

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-serverless package with pip:

$ python -m pip install elasticsearch-serverless

If your application uses async/await in Python you can install with the async extra:

$ python -m pip install elasticsearch-serverless[async]

Read more about how to use asyncio with this project.

Compatibility

TODO

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_serverless 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.

Metadata

Release files for elasticsearch-serverless 0.6.0.20231031

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for elasticsearch-serverless 0.6.0.20231031
File Size Uploaded
elasticsearch_serverless-0.6.0.20231031.tar.gz 266.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for elasticsearch-serverless 0.6.0.20231031
File Interpreter ABI Platform
elasticsearch_serverless-0.6.0.20231031-py3-none-any.whl Python 3 none any Details

Total release size: 592.7 kB

Release files / elasticsearch_serverless-0.6.0.20231031.tar.gz

Download URL elasticsearch_serverless-0.6.0.20231031.tar.gz
Size 266.2 kB
Tags Source
SHA-256 checksum
How to use checksums
ea4521cd4f25309c004cd8adfb6cc45cfd48287c382b7f98595aca94aefe8adb
BLAKE2b-256 checksum
How to use checksums
055e04deee8cc25cfc7f507d73a27387a434c8d753cb6a1eb8f2d9042398f486
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / elasticsearch_serverless-0.6.0.20231031-py3-none-any.whl

Download URL elasticsearch_serverless-0.6.0.20231031-py3-none-any.whl
Size 326.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
002a59baecc56e63594f2f090645d782a6a60ad8ada2511eeca25fa240c67029
BLAKE2b-256 checksum
How to use checksums
f9c3168e7b1bca7c66b5815d7fc1ce586c9e76668e8546416a5888473bd35556
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.7
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page