Skip to main content

Retrieve all documents from Elasticsearch

Retrieve all documents from Elasticsearch.

Application

  • Elasticsearch

Inputs (what you have)

NameDescriptionData TypeRequired?Example
Connected AccountThe connected account to use for the requestConnected AccountYes
Index IDID of the index containing the documents to retrieveText (Short)Yes
Return all?Whether to return all results or only up to a given limitTrue/FalseNo
LimitMax number of results to returnNumberNo
Simplify?Whether to return a simplified version of the response instead of the raw dataTrue/FalseNo
Allow no indices?If false, return an error if any of the following targets only missing/closed indices: wildcard expression, index alias, or _all value. Defaults to trueTrue/FalseNo
Allow partial search results?If true, return partial results if there are shard request timeouts or shard failures.If false, returns an error with no partial results. Defaults to trueTrue/FalseNo
Batched reduce sizeNumber of shard results that should be reduced at once on the coordinating node. Defaults to 512NumberNo
CCS minimize roundtrips?Whether network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. Defaults to trueTrue/FalseNo
Doc value fieldsComma-separated list of fields to return as the docvalue representation of a field for each hitText (Long)No
Expand wildcardsType of index that wildcard expressions can match. Defaults to "Open"Predefined Choice ListNo
Explain?Whether to return detailed information about score computation as part of a hit. Defaults to falseTrue/FalseNo
Ignore throttled?Whether concrete, expanded or aliased indices are ignored when frozen. Defaults to trueTrue/FalseNo
Ignore unavailable?Whether missing or closed indices are not included in the response. Defaults to falseTrue/FalseNo
Max concurrent shard requestsDefine the number of shard requests per node this search executes concurrently. Defaults to 5NumberNo
Pre-filter shard sizeDefine a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting. Only used if the number of shards the search request expands to exceeds the thresholdNumberNo
QueryQuery in the Elasticsearch Query DSLText (Long)No
Request cache?Whether the caching of search results is enabled for requests where size is 0. See Elasticsearch shard request cache settingsTrue/FalseNo
RoutingTarget this primary shardText (Short)No
Search typeHow distributed term frequencies are calculated for relevance scoring. Defaults to Query then FetchPredefined Choice ListNo
Sequence number and primary term?Whether to return the sequence number and primary term of the last modification of each hit. See Optimistic concurrency controlTrue/FalseNo
SortComma-separated list of field:direction pairsText (Long)No
Source excludesComma-separated list of source fields to exclude from the responseText (Long)No
Source includesComma-separated list of source fields to include in the responseText (Long)No
StatsTag of the request for logging and statistical purposesText (Short)No
Stored fields?Whether to retrieve the document fields stored in the index rather than the document _source. Defaults to falseTrue/FalseNo
Terminate afterMax number of documents to collect for each shardNumberNo
TimeoutPeriod to wait for active shards. Defaults to 1m (one minute). See the Elasticsearch time units referenceText (Short)No
Track scores?Whether to calculate and return document scores, even if the scores are not used for sorting. Defaults to falseTrue/FalseNo
Track total hitsNumber of hits matching the query to count accurately. Defaults to 10000NumberNo
Version?Whether to return document version as part of a hit. Defaults to falseTrue/FalseNo

Outputs (what you get)

NameDescriptionData TypeRequired?Example
JSON OutputJSON output returned by the APIText (Long)No

Outcomes

NameDescription
SuccessThis status is selected if the job has successfully completed.
UnsuccessfulThis status is selected if the job has completed unsuccessfully.

Requirements

  • N/A