Skip to main content

"Elasticsearch Client builder, complete with schema validation"

Project description

You may wonder why this even exists, as at first glance it doesn’t seem to make anything any easier than just using the elasticsearch8 Python module to build a client connection. I needed to be able to reuse the more complex schema validation bits I was employing, namely:

  • master_only detection

  • Elasticsearch version checking and validation, and the option to skip this.

  • Configuration value validation, including file paths for SSL certificates, meaning:

    • No unknown keys or unacceptable parameter values are accepted

    • Acceptable values and ranges are established (where known)–and easy to amend, if necessary.

So, if you don’t need these, then this library probably isn’t what you’re looking for. If you want these features, then you’ve come to the right place.

Example Usage

from es_client import Builder

config = {
    'elasticsearch': {
        'client': {
            'hosts': '',
            'ca_certs': '/etc/elasticsearch/certs/ca.crt',
            'request_timeout': 60,
        'other_settings': {
            'master_only': True,
            'username': 'joe_user',
            'password': 'password',

    client = Builder(config).client
    # Do exception handling here...

Additionally, you can read from a YAML configuration file:

    ca_certs: /etc/elasticsearch/certs/ca.crt
    request_timeout: 60
    master_only: true
    username: joe_user
    password: password
from es_client import Builder
from es_client.exceptions import ConfigurationError
from es_client.helpers.utils import get_yaml

    client = Builder(get_yaml('/path/to/es_client.yml').client
    # Do exception handling here...

The same schema validations apply here as well.

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

es_client-8.6.0.post3.tar.gz (26.4 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page