Skip to content

Commit 60eb7f7

Browse files
authored
[DOCS] Adds max_page_search_size to data frame transform pivot properties (#44126)
1 parent 2797b24 commit 60eb7f7

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

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

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ pivot function `group by` fields and the aggregation to reduce the data.
7979
===== {api-definitions-title}
8080

8181
`aggregations` or `aggs`::
82-
(object) Defines how to aggregate the grouped data. The following composite
83-
aggregations are supported:
82+
(object) Defines how to aggregate the grouped data. The following composite
83+
aggregations are supported:
8484
+
8585
--
8686
* {ref}/search-aggregations-metrics-avg-aggregation.html[Average]
@@ -101,15 +101,21 @@ composite aggregations. See
101101
--
102102

103103
`group_by`::
104-
(object) Defines how to group the data. More than one grouping can be defined
105-
per pivot. The following groupings are supported:
104+
(object) Defines how to group the data. More than one grouping can be defined
105+
per pivot. The following groupings are supported:
106106
+
107107
--
108108
* {ref}/search-aggregations-bucket-composite-aggregation.html#_terms[Terms]
109109
* {ref}/search-aggregations-bucket-composite-aggregation.html#_histogram[Histogram]
110110
* {ref}/search-aggregations-bucket-composite-aggregation.html#_date_histogram[Date Histogram]
111111
--
112112

113+
`max_page_search_size`::
114+
(integer) Defines the initial page size to use for the composite aggregation
115+
for each checkpoint. If circuit breaker exceptions occur, the page size is
116+
dynamically adjusted to a lower value. The minimum value is `10` and the
117+
maximum is `10,000`. The default value is `500`.
118+
113119
[[data-frame-transform-example]]
114120
==== {api-examples-title}
115121

0 commit comments

Comments
 (0)