Elasticsearch Load

Elasticsearch Load

Certified

Bulk load from Kestra storage

Reads ION-serialized records from a Kestra internal storage file and sends them in bulk as INDEX, CREATE, UPDATE or DELETE operations, depending on opType. Uses the parent chunk size; set removeIdKey to keep or drop the id field after use.

yaml
type: io.kestra.plugin.elasticsearch.Load
yaml
id: elasticsearch_load
namespace: company.team

inputs:
  - id: file
    type: FILE

tasks:
  - id: load
    type: io.kestra.plugin.elasticsearch.Load
    connection:
      hosts:
       - "http://localhost:9200"
    from: "{{ inputs.file }}"
    index: "my_index"
yaml
id: elasticsearch_load_update
namespace: company.team

inputs:
  - id: file
    type: FILE

tasks:
  - id: update
    type: io.kestra.plugin.elasticsearch.Load
    connection:
      hosts:
       - "http://localhost:9200"
    from: "{{ inputs.file }}"
    index: "my_index"
    idKey: "id"
    opType: UPDATE
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-elasticsearch --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

Elasticsearch connection

Connection settings shared by tasks; hosts are required.

Definitions
hosts*array
SubTypestring
Min items1

Elasticsearch hosts

List of HTTP(S) endpoints including scheme and port, e.g. https://elasticsearch.com: 9200; at least one is required.

basicAuth

Basic authentication

Optional HTTP basic auth credentials rendered at runtime.

passwordstring

Basic auth password

Password for HTTP basic authentication.

usernamestring

Basic auth username

Username for HTTP basic authentication.

connectTimeoutstring

Connection timeout

Maximum time to wait to establish the TCP connection to an Elasticsearch host. When unset, the Elasticsearch client default applies (1 second). A value of PT0S means no timeout.

headersarray
SubTypestring

Custom HTTP headers

Headers sent on every request in Name: Value format, e.g. Authorization: Token XYZ.

pathPrefixstring

Request path prefix

Base path prepended to every Elasticsearch endpoint, e.g. /my/path. Use only when the cluster is served behind a proxy that requires a prefix; leave empty otherwise.

responseTimeoutstring

Response timeout

Maximum time to wait for a response once the request has been sent. When unset, the Elasticsearch client default applies (unbounded), so large bulk requests are not cut off. A value of PT0S means no timeout. Set a bound (e.g. PT60S) to protect against a hung cluster.

strictDeprecationModebooleanstring

Fail on warning headers

When true, any response containing Elasticsearch warning headers is treated as an error.

targetServerVersionintegerstring
Default8

Target Elasticsearch server major version

Major version used for compatibility headers (Accept and Content-Type). Set to 8 for Elasticsearch 8 clusters or 9 for Elasticsearch 9 clusters.

trustAllSslbooleanstring

Trust all SSL certificates

WARNING — SECURITY RISK: When enabled, disables BOTH TLS certificate validation (TrustAllStrategy) AND hostname verification (NoopHostnameVerifier). This makes the connection vulnerable to man-in-the-middle attacks and must never be used in production. Prefer configuring a proper truststore for self-signed certificates instead.

Source file

Kestra internal storage URI containing bulk payload; supports dynamic rendering.

The Elasticsearch index

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Default1000

Bulk chunk size

Number of operations per bulk request; default 1000.

Field used as document id

Name of the field to use as _id. Required when opType is UPDATE or DELETE; optional otherwise (Elasticsearch generates ids when unset).

Possible Values
INDEXCREATEUPDATEDELETE

Operation type

Bulk operation applied to each record: INDEX (default), CREATE, UPDATE (partial update, upserting the record if missing), or DELETE. CREATE fails the task if a document with the same id already exists. UPDATE and DELETE require idKey. The load is not atomic: records are validated while streaming, so a failure on a bad record (e.g. a missing idKey field) can leave earlier chunks already applied.

Defaulttrue

Remove id field from document

When true (default), drops the idKey field from the indexed document body.

Custom shard routing

Optional routing key hashed to pick the shard instead of using the document id.

Indexed document count

Total operations sent across all bulk requests.

Unitrecords

Number of records loaded

Number of bulk requests sent

Duration of bulk requests

More Plugins in this Category

OPA (Open Policy Agent)
OPA (Open Policy Agent)
Enterprise

Tasks to manage Open Policy Agent policies and decisions, including upload, evaluation, and partial evaluation.

Infrastructure

5 tasks

4 blueprints

Dataform
Dataform

Tasks that run Dataform data transformations through the Dataform CLI.

Data

1 tasks

6 blueprints