AuthThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.AvailabilityExperimentalThis functionality is experimental and is not ready for production usage. Experimental features may change or be removed at any time. Elastic will work to fix any issues, but experimental features are not subject to the support SLA of official GA features. Specific Support terms apply.Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Creates or replaces a dataset that references a data source in ES|QL data federation.
Dataset names participate in the index namespace and must follow index or alias naming rules.
Returns 404 if the referenced data source does not exist.
The name of the referenced data source. The data source must already exist.
resourcestringrequired
The URI that identifies the data to read, resolved against the referenced data source.
It can include glob patterns. For example, a recursive pattern can match
all Parquet files under the s3://logs-bucket/access prefix.
descriptionstring
A free-text description of the dataset.
mappingsobject
User-declared mapping on the dataset definition
dynamicenum · default: true
The policy for columns that are not declared in properties.
true (the default) infers undeclared columns and overlays the declarations; false makes the declaration the entire schema, so undeclared columns are not queryable.
Values:truefalse
propertiesmapstring to object
The per-column declarations, keyed by logical column name.
<string>object
typestringrequired
The declared column type.
rename_fromstring
The underlying file column that this logical column reads from.
This is a read-path rename: the physical column becomes this single logical column.
Responses always use rename_from. path, the former name for this field, is still
accepted in requests and means the same thing.
formatstring
The date-parse pattern for a declared date column, mirroring the index date-field format.
_idobject
The _id meta-field configuration, sourcing the document identity from a column.
pathstringrequired
The name of the column that provides the document identity.
settingsmapstring to object
Format and parsing-specific settings that configure how the resource is read.
Common keys include format, which explicitly selects a registered format, and
partition_detection, which accepts auto, hive, template, or none. Additional
keys depend on the format reader. Compression can be inferred from the resource URI.