Get ES|QL datasets

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

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 authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

application/json

datasets object[] required: The matching datasets.

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"
      }
    }
  ]
}