Delete ES|QL datasets

Auth

Deletes one or more datasets used in ES|QL data federation. If any specified dataset does not exist, the request fails and no datasets are deleted.

Required privileges

name union string | string[] required: A comma-separated list of dataset names to delete.

master_timeout union oneOf · default: 30s: Period to wait for a connection to the master node.; Values: -1 0
timeout union oneOf · default: 30s: The time to wait for the request to be completed.; Values: -1 0

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE /_query/dataset/access_logs

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

client.esql().deleteDataset(d -> d
    .name("access_logs")
);

C# Elasticsearch .NET Client

var response = await client.Esql.DeleteDatasetAsync(name: new[] { "access_logs" });

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

The dataset definition was deleted successfully.

{
  "acknowledged": true
}