Skip to content

Commit 2c539f8

Browse files
committed
[DOCS] Adds descriptions for put and start data frame transforms (#44724)
1 parent 9427e14 commit 2c539f8

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docs/reference/data-frames/apis/put-transform.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and
3131
[[put-data-frame-transform-desc]]
3232
==== {api-description-title}
3333

34+
This API defines a {dataframe-transform}, which copies data from source indices,
35+
transforms it, and persists it into an entity-centric destination index. The
36+
entities are defined by the set of `group_by` fields in the `pivot` object. You
37+
can also think of the destination index as a two-dimensional tabular data
38+
structure (known as a {dataframe}). The ID for each document in the
39+
{dataframe} is generated from a hash of the entity, so there is a unique row
40+
per entity. For more information, see
41+
{stack-ov}/ml-dataframes.html[{dataframe-transforms-cap}].
42+
3443
IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
3544
Do not put a {dataframe-transform} directly into any
3645
`.data-frame-internal*` indices using the Elasticsearch index API.

docs/reference/data-frames/apis/start-transform.asciidoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,20 @@ have `view_index_metadata` privileges on the source index for the
2727
{stack-ov}/security-privileges.html[Security privileges] and
2828
{stack-ov}/built-in-roles.html[Built-in roles].
2929

30+
[[start-data-frame-transform-desc]]
31+
==== {api-description-title}
32+
33+
When you start a {dataframe-transform}, it creates the destination index if it
34+
does not already exist. The `number_of_shards` is set to `1` and the
35+
`auto_expand_replicas` is set to `0-1`.
36+
37+
The transform deduces the mapping definitions from the source indices. For
38+
scripted fields, it uses <<dynamic-mapping,dynamic mappings>>. If a field in the
39+
destination index is created by `scripted_metric` or `bucket_script`
40+
aggregations, the transform uses dynamic mappings unless a template exists or
41+
the destination index already exists. Mapping definitions in the destination
42+
index take precedence over dynamic mappings and templates.
43+
3044
[[start-data-frame-transform-path-parms]]
3145
==== {api-path-parms-title}
3246

0 commit comments

Comments
 (0)