stack es helpers scroll-search cli command
Auth required
Idempotent
Scope: global
elastic stack es helpers scroll-search --index <index> [options]
Scroll through all search results, streaming documents as NDJSON to stdout, or returning a single JSON object when --json is set.
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--indexstringrequired- Target index
--querystring- Query DSL clause as JSON (wrapped under "query"), e.g. '{"match_all":{}}'
--query-filestring- Path to a file containing the full search body JSON (may include query, sort, aggs, ...)
--scrollstring-
Scroll keep-alive duration
Default:
1m --sizenumber-
Documents per scroll batch
Default:
1000 --max-docsnumber- Maximum total documents to fetch (default: unlimited)
--input-filestring- path to a JSON file to use as command input
--dry-run- validate all inputs and exit without performing any action (preview changes without applying them)
--no-validate- skip input validation and send the request as-is
--output-fieldsstring- comma-separated list of fields to include in output (dot-notation supported)
--output-templatestring- Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")
--json-
output as JSON