Skip to content

Commit 255c14d

Browse files
committed
[DOCS] Clarifies data transform source definition (#44504)
1 parent 4d043bc commit 255c14d

File tree

3 files changed

+28
-5
lines changed

3 files changed

+28
-5
lines changed

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

+12-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,18 @@ on all the current data in the source index.
4040
==== {api-request-body-title}
4141

4242
`source`::
43-
(Required, object) The source index or index pattern.
43+
(Required, object) The source configuration, which has the following
44+
properties:
45+
46+
`index`:::
47+
(Required, string or array) The _source indices_ for the
48+
{dataframe-transform}. It can be a single index, an index pattern (for
49+
example, `"myindex*"`), or an array of indices (for example,
50+
`["index1", "index2"]`).
51+
52+
`query`:::
53+
(Optional, object) A query clause that retrieves a subset of data from the
54+
source index. See <<query-dsl>>.
4455

4556
`pivot`::
4657
(Required, object) Defines the pivot function `group by` fields and the

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

+12-2
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,18 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
7171
reduce the data. See <<data-frame-transform-pivot>>.
7272

7373
`source`::
74-
(Required, object) The source configuration, which consists of `index` and
75-
optionally a `query`. See <<data-frame-transform-source>>.
74+
(Required, object) The source configuration, which has the following
75+
properties:
76+
77+
`index`:::
78+
(Required, string or array) The _source indices_ for the
79+
{dataframe-transform}. It can be a single index, an index pattern (for
80+
example, `"myindex*"`), or an array of indices (for example,
81+
`["index1", "index2"]`).
82+
83+
`query`:::
84+
(Optional, object) A query clause that retrieves a subset of data from the
85+
source index. See <<query-dsl>>.
7686

7787
`sync`::
7888
(Optional, object) Defines the properties required to run continuously.

docs/reference/data-frames/apis/transformresource.asciidoc

+4-2
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,10 @@ you create a {dataframe-transform}, you must define its source.
6161
[[data-frame-transform-source-properties]]
6262
===== {api-definitions-title}
6363

64-
`index`::
65-
(array) The _source index_ for the {dataframe-transform}.
64+
`index`::
65+
(string or array) The _source indices_ for the {dataframe-transform}. It can
66+
be a single index, an index pattern (for example, `"myindex*"`), or an array
67+
of indices (for example, `["index1", "index2"]`).
6668

6769
`query`::
6870
(object) A query clause that retrieves a subset of data from the source index.

0 commit comments

Comments
 (0)