Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Adds max_page_search_size to data frame transform pivot properties #44126

Merged
merged 2 commits into from
Jul 16, 2019
Merged

[DOCS] Adds max_page_search_size to data frame transform pivot properties #44126

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88550fc
[DOCS] Adds max_page_search_size to data frame transform pivot proper…
szabosteve Jul 9, 2019
927396e
[DOCS] Minor edits
lcawl Jul 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions docs/reference/data-frames/apis/transformresource.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,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 @@ -96,15 +96,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