es connectors
The config fields of a es connector, which backs Elasticsearch.
An Elasticsearch cluster driven by the portable dialect: data_query renders a Query DSL _search body; data_write renders _bulk, _update_by_query, _delete_by_query, and _update calls. Requests go over the shared HTTP client — there is no dedicated ES driver.
{
"name": "search-cluster",
"connector_type": "es",
"config": {
"type": "es",
"url": "http://localhost:9200",
"auth": { "type": "apikey", "header": "Authorization", "key": "env://ES_API_KEY" }
}
}
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
url | string | yes | — | Base URL of the cluster, for example http://localhost:9200 |
auth | object | no | — | Authentication: bearer, basic, or apikey |
request_timeout_ms | integer | no | — | Per-request timeout |
allow_private_urls | boolean | no | false | Allow private and internal IP addresses (SSRF protection) |
max_response_size | integer | no | 10485760 | Maximum response body size in bytes (10 MB) |
operations | object | no | all allowed | Same gate set as db — see Operation gates |
dialect | object | no | both guards off | Dialect guards |
There is no retry field. The dialect drives _bulk and the by-query mutations through this connector as well as _search, and none are safe to re-send blind. See Retries. ES-specific dialect semantics (the _id rename, forced refresh, capability limits) live in the Portable Data Dialect reference.
Related
- Connector types: every type, and the shared blocks all of them carry.
- Task functions: the functions that call through a connector.
- Portable data dialect: the language
data_queryanddata_writespeak. - Operation gates: the
operationsblock this type carries. - Definition and identity: the row the
configsits in.
Last verified 14 September 2026