An adept Python CLI utility designed for querying Elasticsearch and exporting result as a CSV file.
Project description
EsXport
An adept Python CLI utility designed for querying Elasticsearch and exporting result as a CSV file.
Requirements
- This tool should be used with Elasticsearch 8.x version.
- You also need >=
Python 3.8.x
.
Installation
From source:
pip install git+https://github.com/nikhilbadyal/esxport.git
Usage
esxport --help
Arguments
Options:
-q, --query JSON Query string in Query DSL syntax.
[required]
-o, --output-file PATH CSV file location. [required]
-i, --index-prefixes TEXT Index name prefix(es). [required]
-u, --url URL Elasticsearch host URL. [default:
https://localhost:9200]
-U, --user TEXT Elasticsearch basic authentication user.
[default: elastic]
-p, --password TEXT Elasticsearch basic authentication password.
[required]
-f, --fields TEXT List of _source fields to present be in
output. [default: _all]
-S, --sort ELASTIC SORT List of fields to sort on in form
<field>:<direction>
-d, --delimiter TEXT Delimiter to use in CSV file. [default: ,]
-m, --max-results INTEGER Maximum number of results to return.
[default: 10]
-s, --scroll-size INTEGER Scroll size for each batch of results.
[default: 100]
-e, --meta-fields [_id|_index|_score]
Add meta-fields in output.
--verify-certs Verify SSL certificates.
--ca-certs PATH Location of CA bundle.
--client-cert PATH Location of Client Auth cert.
--client-key PATH Location of Client Cert Key.
-v, --version Show version and exit.
--debug Debug mode on.
--help Show this message and exit.
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
esxport-8.9.0.2.tar.gz
(90.3 kB
view hashes)
Built Distribution
esxport-8.9.0.2-py3-none-any.whl
(19.2 kB
view hashes)
Close
Hashes for esxport-8.9.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85b5c50bcec9ea13fee5da2a548756eab77c66992f345229fcfd6847220580ce |
|
MD5 | e552ffce5c8d8b8ab34281c09fdc5f38 |
|
BLAKE2b-256 | 0679efcacd3ceaa8399797fb6d14eb9f3548809ec885775d3e75accd0c7d424f |