Skip to content

Commit 9fe24d1

Browse files
authored
[Transform] Specify use_point_in_time in settings (#5322)
use_point_in_time has been in the docs since before 8.18 Resolve elastic/elasticsearch#134841
1 parent 88ed866 commit 9fe24d1

File tree

4 files changed

+31
-5
lines changed

4 files changed

+31
-5
lines changed

output/schema/schema.json

Lines changed: 19 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/typescript/types.ts

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ painless-contexts,https://www.elastic.co/docs/reference/scripting-languages/pain
521521
painless-execute-api,https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples,,
522522
pipeline-processor,https://www.elastic.co/docs/reference/enrich-processor/pipeline-processor,,
523523
pki-realm,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/pki,,
524-
point-in-time-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/point-in-time-api.html,
524+
point-in-time-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/point-in-time-api.html,Open a point in time API
525525
prevalidate-node-removal,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster.html,
526526
preview-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-data-frame-analytics,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/preview-dfanalytics.html,
527527
preview-transform,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-preview-transform,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/preview-transform.html,

specification/transform/_types/Transform.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,16 @@ export class Settings {
130130
* @server_default 500
131131
*/
132132
max_page_search_size?: integer
133+
/**
134+
* Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index.
135+
* In general, Point In Time is an optimization that will reduce pressure on the source index by reducing the amount
136+
* of refreshes and merges, but it can be expensive if a large number of Point In Times are opened and closed for a
137+
* given index. The benefits and impact depend on the data being searched, the ingest rate into the source index, and
138+
* the amount of other consumers searching the same source index.
139+
* @ext_doc_id point-in-time-api
140+
* @server_default true
141+
*/
142+
use_point_in_time?: boolean
133143

134144
/**
135145
* If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case

0 commit comments

Comments
 (0)