Get ES|QL datasets

GET /_query/dataset/{name}
GET /_query/dataset

Auth

Returns one or more datasets used in ES|QL data federation. A concrete-name miss returns 404; a wildcard pattern or list-all request with no match returns 200 with an empty array.

ES|QL Data Federation

Required privileges

Index privileges manage

Path parameters

name union string | string[] optional

A comma-separated list of dataset names or wildcard patterns. Omit to return all datasets.

Leave it out to use /_query/dataset.

Query parameters

master_timeout union oneOf · default: 30s: Period to wait for a connection to the master node.; Values: -1 0

Response

application/json

datasets object[] required: The matching datasets.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_query/dataset/access_logs

JavaScript Elasticsearch JavaScript Client

const response = await client.esql.getDataset({
  name: "access_logs",
});

Python Elasticsearch Python Client

resp = client.esql.get_dataset(
    name="access_logs",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_query/dataset/access_logs" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.esql().getDataset(g -> g
    .name("access_logs")
);

C# Elasticsearch .NET Client

var response = await client.Esql
    .GetDatasetAsync(d1 => d1
        .Name(new[] { "access_logs" })
    );

PHP Elasticsearch PHP Client

$resp = $client->esql()->getDataset([
    "name" => "access_logs",
]);

Ruby Elasticsearch Ruby Client

response = client.esql.get_dataset(
  name: "access_logs"
)

Response

The response contains the requested dataset definition.

{
  "datasets": [
    {
      "name": "access_logs",
      "data_source": "prod_s3_logs",
      "resource": "s3://logs-bucket/access/**/*.parquet",
      "description": "Production access logs",
      "settings": {
        "partition_detection": "hive"
      }
    }
  ]
}