Data frame transform resourcesedit

Data frame transform resources relate to the Data frame transform APIs.

For more information, see Transforming your data with data frames.

Propertiesedit

description
(string) A description of the data frame transform.
dest
(object) The destination for the data frame transform. See Dest objects.
frequency
(time units) The interval between checks for changes in the source indices when the data frame transform is running continuously. Also determines the retry interval in the event of transient failures while the data frame transform is searching or indexing. The minimum value is 1s and the maximum is 1h. The default value is 1m.
id
(string) A unique identifier for the data frame transform.
pivot
(object) The method for transforming the data. See Pivot objects.
source
(object) The source of the data for the data frame transform. See Source objects.

Dest objectsedit

Data frame transform resources contain dest objects. For example, when you create a data frame transform, you must define its destination.

Propertiesedit
index
(string) The destination index for the data frame transform.
pipeline
(string) The unique identifier for a pipeline.

Source objectsedit

Data frame transform resources contain source objects. For example, when you create a data frame transform, you must define its source.

Propertiesedit
index
(string or array) The source indices for the data frame transform. It can be a single index, an index pattern (for example, "myindex*"), or an array of indices (for example, ["index1", "index2"]).
query
(object) A query clause that retrieves a subset of data from the source index. See Query DSL.

Pivot objectsedit

Data frame transform resources contain pivot objects, which define the pivot function group by fields and the aggregation to reduce the data.

Propertiesedit
aggregations or aggs

(object) Defines how to aggregate the grouped data. The following composite aggregations are supported:

Important

Data frame transforms support a subset of the functionality in composite aggregations. See Data frame limitations.

group_by

(object) Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are supported:

max_page_search_size
(integer) Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the maximum is 10,000. The default value is 500.