Skip to main content

Elasticsearch Client builder, complete with schema validation

Project description

https://es-client.readthedocs.io/

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': 'https://10.0.0.123:9200',
            'ca_certs': '/etc/elasticsearch/certs/ca.crt',
            'request_timeout': 60,
        },
        'other_settings': {
            'master_only': false,
            'username': 'joe_user',
            'password': 'password',
        }
    },
    'logging': {
        'loglevel': 'INFO',
        'logfile': '/path/to/file.log',
        'logformat': 'default',
    }
}

builder = Builder(configdict=config)

try:
    builder.connect()
except:
    # Do exception handling here...

client = builder.client

Additionally, you can read from a YAML configuration file:

---
elasticsearch:
  client:
    hosts: https://10.0.0.123:9200
    ca_certs: /etc/elasticsearch/certs/ca.crt
    request_timeout: 60
  other_settings:
    master_only: false
    username: joe_user
    password: password
logging:
  loglevel: INFO
  logfile: /path/to/file.log
  logformat: default
from es_client import Builder

builder = Builder(configfile='/path/to/es_client.yml')

try:
    builder.connect()
except:
    # Do exception handling here...

client = builder.client

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

Uploaded Source

Built Distribution

es_client-8.12.1-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

Details for the file es_client-8.12.1.tar.gz.

File metadata

  • Download URL: es_client-8.12.1.tar.gz
  • Upload date:
  • Size: 24.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for es_client-8.12.1.tar.gz
Algorithm Hash digest
SHA256 b2f030a73a0e36890a1fe1a806d7c7149e62a379a935b88d7cc3943a18c6a854
MD5 fdb6001b213d2bb34eb52bd7d4328220
BLAKE2b-256 ff68f110c9e592e822e8db9fba20aa91e8025a94ccd2002af425af8e7a6ca7ec

See more details on using hashes here.

File details

Details for the file es_client-8.12.1-py3-none-any.whl.

File metadata

  • Download URL: es_client-8.12.1-py3-none-any.whl
  • Upload date:
  • Size: 27.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for es_client-8.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e148ce2f9d1d0617e5f29eb5254ceba90dc54e6e3ebc72a0de64755c78255c6c
MD5 2fa02a18bd8879bac001bc9f23c7628f
BLAKE2b-256 283ad2b64523d08d52634ce02a29b5034a0536bd463c786ae231e3a633a4e401

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page