Skip to content

Commit

Permalink
[DOCS] Adds max_page_search_size to data frame transform pivot proper…
Browse files Browse the repository at this point in the history
…ties (#44126)
  • Loading branch information
szabosteve authored Jul 16, 2019
1 parent 2797b24 commit 60eb7f7
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/reference/data-frames/apis/transformresource.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ pivot function `group by` fields and the aggregation to reduce the data.
===== {api-definitions-title}

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

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

`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`.

[[data-frame-transform-example]]
==== {api-examples-title}

Expand Down

0 comments on commit 60eb7f7

Please sign in to comment.