Skip to main content
Version: 2.1.2

Elasticsearch

Description​

Read data from Elasticsearch

tip

Engine Supported and plugin name

  • Spark: Elasticsearch
  • Flink

Options​

nametyperequireddefault value
hostsarrayyes-
indexstringyes
es.*stringno
common-optionsstringyes-

hosts [array]​

ElasticSearch cluster address, the format is host:port, allowing multiple hosts to be specified. Such as ["host1:9200", "host2:9200"] .

index [string]​

ElasticSearch index name, support * fuzzy matching

es.* [string]​

Users can also specify multiple optional parameters. For a detailed list of parameters, see Parameters Supported by Elasticsearch.

For example, the way to specify es.read.metadata is: es.read.metadata = true . If these non-essential parameters are not specified, they will use the default values given in the official documentation.

common options [string]​

Source plugin common parameters, please refer to Source Plugin for details

Examples​

elasticsearch {
hosts = ["localhost:9200"]
index = "seatunnel-20190424"
result_table_name = "my_dataset"
}
elasticsearch {
hosts = ["localhost:9200"]
index = "seatunnel-*"
es.read.field.include = "name, age"
resulttable_name = "my_dataset"
}

Matches all indexes starting with seatunnel- , and only reads the two fields name and age .