Skip to content

[DOC] document transform settings and docs_per_second #56178

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

Merged
merged 3 commits into from
May 11, 2020
Merged

[DOC] document transform settings and docs_per_second #56178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2918866
document transform settings and docs_per_second
May 5, 2020
5721c9c
add settings to update docs
May 11, 2020
afb4fad
adapt cat and preview
May 11, 2020
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
2 changes: 1 addition & 1 deletion docs/reference/cat/transforms.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=exponential-avg-documents-i

`max_page_search_size`, `mpsz`:::
(Default)
include::{docdir}/rest-api/common-parms.asciidoc[tag=pivot-max-page-search-size]
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]

`pages_processed`, `pp`:::
include::{docdir}/rest-api/common-parms.asciidoc[tag=pages-processed]
Expand Down
26 changes: 19 additions & 7 deletions docs/reference/rest-api/common-parms.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -667,13 +667,6 @@ Defines how to group the data. More than one grouping can be defined
--
end::pivot-group-by[]

tag::pivot-max-page-search-size[]
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`.
end::pivot-max-page-search-size[]

tag::positions[]
`positions`::
(Optional, boolean) If `true`, the response includes term positions.
Expand Down Expand Up @@ -919,6 +912,25 @@ The time delay between the current time and the latest input data time. The
default value is `60s`.
end::sync-time-delay[]

tag::transform-settings[]
Defines the settings of the {transform}.
end::transform-settings[]

tag::transform-settings-docs-per-second[]
Set `docs-per-second` to throttle the rate transform is issuing search and
index requests. Throttling slows down search requests by adding a wait time
between searches. For the number of docs, the number of input documents is taken.
Throttling can be disabled by setting it to `null`.
The default is no throttling, value `null`.
end::transform-settings-docs-per-second[]

tag::transform-settings-max-page-search-size[]
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`.
end::transform-settings-max-page-search-size[]

tag::target-index[]
`<target-index>`::
+
Expand Down
21 changes: 17 additions & 4 deletions docs/reference/transform/apis/preview-transform.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=pivot-aggs]
`group_by`:::
(Required, object)
include::{docdir}/rest-api/common-parms.asciidoc[tag=pivot-group-by]

`max_page_search_size`:::
(Optional, integer)
include::{docdir}/rest-api/common-parms.asciidoc[tag=pivot-max-page-search-size]
====
//End pivot

Expand Down Expand Up @@ -149,6 +145,23 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=sync-time-field]
====
//End sync

//Begin settings
`settings`::
(Optional, object)
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-settings]
+
.Properties of `settings`
[%collapsible%open]
====
`docs_per_second`:::
(Optional, float)
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
`max_page_search_size`:::
(Optional, integer)
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]
====
//End settings

[role="child_attributes"]
[[preview-transform-response]]
==== {api-response-body-title}
Expand Down
21 changes: 18 additions & 3 deletions docs/reference/transform/apis/put-transform.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=pivot-aggs]
(Required, object)
include::{docdir}/rest-api/common-parms.asciidoc[tag=pivot-group-by]

`max_page_search_size`:::
Copy link
Author

@hendrikmuhs hendrikmuhs May 5, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This setting has been deprecated and moved to the settings part. I therefore removed the old mention, this might not be best-practice.

(Optional, integer)
include::{docdir}/rest-api/common-parms.asciidoc[tag=pivot-max-page-search-size]
====
//End pivot

Expand Down Expand Up @@ -188,6 +185,24 @@ delays.
====
//End sync

//Begin settings
`settings`::
(Optional, object)
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-settings]
+
.Properties of `settings`
[%collapsible%open]
====
`docs_per_second`:::
(Optional, float)
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
`max_page_search_size`:::
(Optional, integer)
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]
====
//End settings


[[put-transform-example]]
==== {api-examples-title}

Expand Down
17 changes: 17 additions & 0 deletions docs/reference/transform/apis/update-transform.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,23 @@ delays.
====
//End sync

//Begin settings
`settings`::
(Optional, object)
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-settings]
+
.Properties of `settings`
[%collapsible%open]
====
`docs_per_second`:::
(Optional, float)
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
`max_page_search_size`:::
(Optional, integer)
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]
====
//End settings

[[update-transform-example]]
==== {api-examples-title}

Expand Down