Skip to main content
All CollectionsWrk Action LibraryElasticsearch
Retrieve all documents from Elasticsearch
Retrieve all documents from Elasticsearch
Wrk Product avatar
Written by Wrk Product
Updated over a month ago

Retrieve all documents from Elasticsearch.

Application

  • Elasticsearch

Inputs (what you have)

Name

Description

Data Type

Required?

Example

Connected Account

The connected account to use for the request

Connected Account

Yes

Index ID

ID of the index containing the documents to retrieve

Text (Short)

Yes

Return all?

Whether to return all results or only up to a given limit

True/False

No

Limit

Max number of results to return

Number

No

Simplify?

Whether to return a simplified version of the response instead of the raw data

True/False

No

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 true

True/False

No

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 true

True/False

No

Batched reduce size

Number of shard results that should be reduced at once on the coordinating node. Defaults to 512

Number

No

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 true

True/False

No

Doc value fields

Comma-separated list of fields to return as the docvalue representation of a field for each hit

Text (Long)

No

Expand wildcards

Type of index that wildcard expressions can match. Defaults to "Open"

Predefined Choice List

No

Explain?

Whether to return detailed information about score computation as part of a hit. Defaults to false

True/False

No

Ignore throttled?

Whether concrete, expanded or aliased indices are ignored when frozen. Defaults to true

True/False

No

Ignore unavailable?

Whether missing or closed indices are not included in the response. Defaults to false

True/False

No

Max concurrent shard requests

Define the number of shard requests per node this search executes concurrently. Defaults to 5

Number

No

Pre-filter shard size

Define 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 threshold

Number

No

Query

Query in the Elasticsearch Query DSL

Text (Long)

No

Request cache?

Whether the caching of search results is enabled for requests where size is 0. See Elasticsearch shard request cache settings

True/False

No

Routing

Target this primary shard

Text (Short)

No

Search type

How distributed term frequencies are calculated for relevance scoring. Defaults to Query then Fetch

Predefined Choice List

No

Sequence number and primary term?

Whether to return the sequence number and primary term of the last modification of each hit. See Optimistic concurrency control

True/False

No

Sort

Comma-separated list of field:direction pairs

Text (Long)

No

Source excludes

Comma-separated list of source fields to exclude from the response

Text (Long)

No

Source includes

Comma-separated list of source fields to include in the response

Text (Long)

No

Stats

Tag of the request for logging and statistical purposes

Text (Short)

No

Stored fields?

Whether to retrieve the document fields stored in the index rather than the document _source. Defaults to false

True/False

No

Terminate after

Max number of documents to collect for each shard

Number

No

Timeout

Period to wait for active shards. Defaults to 1m (one minute). See the Elasticsearch time units reference

Text (Short)

No

Track scores?

Whether to calculate and return document scores, even if the scores are not used for sorting. Defaults to false

True/False

No

Track total hits

Number of hits matching the query to count accurately. Defaults to 10000

Number

No

Version?

Whether to return document version as part of a hit. Defaults to false

True/False

No

Outputs (what you get)

Name

Description

Data Type

Required?

Example

JSON Output

JSON output returned by the API

Text (Long)

No

Outcomes

Name

Description

Success

This status is selected if the job has successfully completed.

Unsuccessful

This status is selected if the job has completed unsuccessfully.

Requirements

  • N/A

Did this answer your question?