Skip to content

Commit 659e35c

Browse files
committed
Add apply_checkpoints setting description
1 parent 87ca6fa commit 659e35c

File tree

4 files changed

+17
-0
lines changed

4 files changed

+17
-0
lines changed

docs/reference/rest-api/common-parms.asciidoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1005,6 +1005,14 @@ throttles the {transform} by adding a wait time between search requests. The
10051005
default value is `null`, which disables throttling.
10061006
end::transform-settings-docs-per-second[]
10071007

1008+
tag::transform-settings-interim-results[]
1009+
Specifies whether the transform checkpoint ranges should be optimized for performance.
1010+
Such optimization can align checkpoint ranges with date histogram interval when date histogram
1011+
is specified as a group source in the transform config. As an effect, less document updates in the
1012+
destination index will be performed thus improving overall performance.
1013+
The default value is `true`, which means the checkpoint ranges will be optimized if possible.
1014+
end::transform-settings-interim-results[]
1015+
10081016
tag::transform-settings-max-page-search-size[]
10091017
Defines the initial page size to use for the composite aggregation for each
10101018
checkpoint. If circuit breaker exceptions occur, the page size is dynamically

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings]
204204
`docs_per_second`:::
205205
(Optional, float)
206206
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
207+
`interim_results`:::
208+
(Optional, boolean)
209+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-interim-results]
207210
`max_page_search_size`:::
208211
(Optional, integer)
209212
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dat
186186
`docs_per_second`:::
187187
(Optional, float)
188188
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
189+
`interim_results`:::
190+
(Optional, boolean)
191+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-interim-results]
189192
`max_page_search_size`:::
190193
(Optional, integer)
191194
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]

docs/reference/transform/apis/update-transform.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,9 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-dat
138138
`docs_per_second`:::
139139
(Optional, float)
140140
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-docs-per-second]
141+
`interim_results`:::
142+
(Optional, boolean)
143+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-interim-results]
141144
`max_page_search_size`:::
142145
(Optional, integer)
143146
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-settings-max-page-search-size]

0 commit comments

Comments
 (0)