Skip to content

Commit 8bac13d

Browse files
committed
[DOCS] Adds descriptions for put and start data frame transforms (#44724)
1 parent a12be61 commit 8bac13d

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

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

+9
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
When the {dataframe-transform} is created, a series of validations occur to
3544
ensure its success. For example, there is a check for the existence of the
3645
source indices and a check that the destination index is not part of the source

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

+17-6
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,23 @@ have `view_index_metadata` privileges on the source index for the
3030
[[start-data-frame-transform-desc]]
3131
==== {api-description-title}
3232

33-
When a {dataframe-transform} starts, a series of validations occur to ensure its
34-
success. If you deferred validation when you created the {dataframe-transform},
35-
they occur when you start the transform--with the exception of privilege checks.
36-
If the user who created the transform does not have the required privileges on
37-
the source and destination indices, the transform starts but then fails when
38-
it attempts the unauthorized operation.
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+
44+
When the {dataframe-transform} starts, a series of validations occur to ensure
45+
its success. If you deferred validation when you created the
46+
{dataframe-transform}, they occur when you start the transform--with the
47+
exception of privilege checks. If the user who created the transform does not
48+
have the required privileges on the source and destination indices, the
49+
transform starts but then fails when it attempts the unauthorized operation.
3950

4051
[[start-data-frame-transform-path-parms]]
4152
==== {api-path-parms-title}

0 commit comments

Comments
 (0)