PluginsElasticsearchTasksLoad

Load​Load

Load Load

yaml
type: "io.kestra.plugin.elasticsearch.Load"

Bulk load documents in ElasticSearch using Kestra Internal Storage file.

Examples

yaml
id: elasticsearch_load
namespace: company.team

inputs:
  - id: file
    type: FILE

tasks:
  - id: load
    type: io.kestra.plugin.elasticsearch.Load
    connection:
      hosts:
       - "https://localhost:9200"
    from: "{{ inputs.file }}"
    index: "my_index"

Properties

connection

The connection properties.

from

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The source file.

index

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The elasticsearch index.

chunk

  • Type: integer
  • Dynamic: ✔️
  • Required: ❌
  • Default: 1000

The chunk size for every bulk request.

idKey

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Use this key as id.

opType

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Possible Values:
    • INDEX
    • CREATE
    • UPDATE
    • DELETE

Sets the type of operation to perform.

removeIdKey

  • Type: boolean
  • Dynamic: ✔️
  • Required: ❌
  • Default: true

Remove idKey from the final document.

routing

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Controls the shard routing of the request.

Using this value to hash the shard and not the id.

Outputs

size

  • Type: integer
  • Required: ❌

The size of the rows fetched.

Definitions

io.kestra.plugin.elasticsearch.ElasticsearchConnection

Properties

hosts
  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min items: 1

List of HTTP ElasticSearch servers.

Must be an URI like https://elasticsearch.com:9200 with scheme and port.

basicAuth

Basic auth configuration.

headers
  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

List of HTTP headers to be send on every request.

Must be a string with key value separated with :, ex: Authorization: Token XYZ.

pathPrefix
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Sets the path's prefix for every request used by the HTTP client.

For example, if this is set to /my/path, then any client request will become /my/path/ + endpoint. In essence, every request's endpoint is prefixed by this pathPrefix. The path prefix is useful for when ElasticSearch is behind a proxy that provides a base path or a proxy that requires all paths to start with '/'; it is not intended for other purposes and it should not be supplied in other scenarios.

strictDeprecationMode
  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

Whether the REST client should return any response containing at least one warning header as a failure.

trustAllSsl
  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

Trust all SSL CA certificates.

Use this if the server is using a self signed SSL certificate.

io.kestra.plugin.elasticsearch.ElasticsearchConnection-BasicAuth

Properties

password
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Basic auth password.

username
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Basic auth username.

Was this page helpful?