CLI reference

dots-es-cli [OPTIONS] COMMAND [ARGS]...

Options:
  --config [local|staging|prod]  select appropriate .yml file to use  [default: staging]
  --help                         Show this message and exit.

Commands:
  delete       Delete the indexes
  index        Rebuild the elasticsearch indexes
  search       Perform a search using the provided query.
  update-conf  Update the index configuration and mappings

The global --config option selects which YAML file is loaded. It must come before the command:

dots-es-cli --config=local index      # correct
dots-es-cli index --config=local      # not recognised

---

index

Crawls the DTS tree through ThunderDots and populates both indexes. See Indexing.

Option	Default	Effect
--collections, -c	none	Comma-separated collection ids to restrict the crawl. Case-sensitive.

dots-es-cli --config=local index
ES_PASSWORD=xxx dots-es-cli --config=prod index
dots-es-cli --config=staging index --collections=theater,ENCPOS

Missing indexes are created automatically from the mapping files before indexing starts.

---

update-conf

Applies the mapping files to one or both indexes.

Option	Default	Effect
--indexes	both indexes	Comma-separated index names.
--rebuild	off	Deletes the index before recreating it.

dots-es-cli --config=local update-conf --rebuild
ES_PASSWORD=xxx dots-es-cli --config=prod update-conf --rebuild --indexes=dots_document

Without --rebuild on an existing index, Elasticsearch answers resource_already_exists_exception and the CLI tells you to rerun with --rebuild.

Danger

--rebuild always destroys the data. A full reindex is required afterwards.

---

delete

Deletes indexes outright.

Option	Default	Effect
--indexes	required	Comma-separated index names.

dots-es-cli --config=local delete --indexes=dots_document

---

search

A convenience query runner; the result is pretty-printed to stdout.

Argument / option	Default	Effect
QUERY	required	The query string.
--indexes	both indexes	Comma-separated index names.
-t, --term	off	Switches from a match on content to a full Lucene query_string.

dots-es-cli --config=local search "Molière"
dots-es-cli search -t "content:tragédie AND type.keyword:fragment" --indexes=dots_document

--term is the broader mode

Despite its name, --term does not narrow the search to an exact term: it enables query_string, which accepts field prefixes, boolean operators and wildcards. Without it, the query is a simple match on content.

---

dots-api

dots-api [--config local|staging|prod]

Starts the Flask search API on port 5003. The SERVER_ENV_CONFIG environment variable overrides --config. See Search API.