query-with-file

Estimated time to read: 1 minute

Experimental-feature notice

This page discusses experimental features. Experimental features are still in progress, and you may encounter bugs or unexpected behavior when using them.

If you experience an issue or want to know more about this feature's status, reach out to us at Era Software.

This command issues an index query by sending JSON-formatted query file to the EraSearch API.

Warning

This command requires read access to any indices queried against.

usage: eractl query-with-file [-h] [--url URL] [--key KEY] [-o OUTPUT_FILE] index file_path

positional arguments:
  index           EraSearch index name to query from
  file_path       Local path to JSON query data

optional arguments:
  -h, --help      show this help message and exit
  --url URL       EraSearch URL, set via environment with ERACTL_URL (default: http://localhost:9200)
  --key KEY       EraSearch API key, set via environment with ERACTL_API_KEY (default: None)
  -o OUTPUT_FILE  Output file path (default: None)

To run:

eractl query-with-file --url https://erasearch.example.com --key ****** my-index path/to/query.json

Or to pass arguments from the environment:

export ERACTL_URL="https://erasearch.example.com"
export ERACTL_API_KEY="******"
eractl query-with-file my-index path/to/query.json

Last update: October 6, 2022