
OpenSearch Scroll
CertifiedScroll and store OpenSearch results
OpenSearch Scroll
Scroll and store OpenSearch results
Executes a scroll search with 60s keep-alive and streams all hits to an Internal Storage file; clears the scroll id when finished.
type: io.kestra.plugin.opensearch.ScrollExamples
id: opensearch_scroll
namespace: company.team
tasks:
- id: scroll
type: io.kestra.plugin.opensearch.Scroll
connection:
hosts:
- "http://localhost:9200"
indexes:
- "my_index"
request:
query:
term:
name:
value: 'john'
Installation
Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:
kestractl plugins get io.kestra.plugin:plugin-opensearch --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.
Properties
connection *
Configure OpenSearch connection
Hosts, auth headers, and TLS options reused by every task invocation.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150indexes array
Target indices
Optional list of indices; defaults to all when empty.
request object
Search request payload
JSON string or Map rendered then parsed into an OpenSearch SearchRequest.
routing string
Shard routing key
Hashes routing using this value instead of the document id to colocate related records.
Outputs
size integer
Number of rows fetched
uri string
uriURI of stored result