| title | elasticsearch-execute-esql |
|---|---|
| type | docs |
| weight | 3 |
| description | Execute arbitrary ES|QL statements. |
Execute arbitrary ES|QL statements.
This tool allows you to execute arbitrary ES|QL statements against your Elasticsearch cluster at runtime. This is useful for ad-hoc queries where the statement is not known beforehand.
See the official documentation for more information.
{{< compatible-sources >}}
| name | type | required | description |
|---|---|---|---|
| query | string | true | The ES |
kind: tool
name: execute_ad_hoc_esql
type: elasticsearch-execute-esql
source: elasticsearch-source
description: Use this tool to execute arbitrary ES|QL statements.
format: json| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be "elasticsearch-execute-esql". |
| source | string | true | Name of the source the ES |
| description | string | true | Description of the tool that is passed to the LLM. |
| format | string | false | The format of the query. Default is json. Valid values are csv, json, tsv, txt, yaml, cbor, smile, or arrow. |