es_client
Documentation¶
You may wonder why this even exists, as at first glance it doesn’t seem to make
anything any easier than just using Elasticsearch
to
build a client connection. I needed to be able to reuse the more complex
schema validation bits I was employing, namely:
master_only
detectionElasticsearch 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': True,
'username': 'joe_user',
'password': 'password',
}
}
}
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: true
username: joe_user
password: password
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.
License¶
Copyright (c) 2022-2023 Aaron Mildenstein
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Contents¶
- ES Client API reference
- Example Script
- Default Values
- Helpers
- Exceptions
- Changelog
- 8.11.0 (15 November 2023)
- 8.10.3 (2 October 2023)
- 8.10.2 (2 October 2023)
- 8.10.1 (29 September 2023)
- 8.10.0 (25 September 2023)
- 8.9.0 (31 July 2023)
- 8.8.2.post1 (18 July 2023)
- 8.8.2 (12 July 2023)
- 8.7.0 (12 April 2023)
- 8.6.2.post1 (23 March 2023)
- 8.6.2 (19 February 2023)
- 8.6.1.post1 (30 January 2023)
- 8.6.1 (30 January 2023)
- 8.6.0.post6 (26 January 2023)
- 8.6.0.post5 (26 January 2023)
- 8.6.0.post4 (26 January 2023)
- 8.6.0.post3 (19 January 2023)
- 8.6.0.post2 (18 January 2023)
- 8.6.0.post1 (17 January 2023)
- 8.6.0+build.2 (17 January 2023)
- 8.6.0 (11 Janary 2023)
- 8.5.0 (11 January 2023)
- 8.1.0 (3 November 2022)
- 8.0.5 (28 October 2022)
- 8.0.4 (23 August 2022)
- 8.0.3 (23 August 2022)
- 8.0.2 (23 August 2022)
- 8.0.1 (23 August 2022)
- 8.0.0 (22 August 2022)
- 1.1.1 (19 April 2018)
- 1.1.0 (19 April 2018)
- 1.0.1 (12 April 2018)
- 1.0.0 (11 April 2018)