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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for es_client-8.15.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdb7e3c3a9c13cd7d1239572813c0de1dd6ee591f49ea830286931d9cd73705b |
|
MD5 | 6e5e1ee916467274277dd4f743348b74 |
|
BLAKE2b-256 | 11825113657ea43d07a4d89887cfdc325b69b0db9d138d11089770e07d8d1ec4 |