Skip to content

[Backport 9.1] [Transform] Specify use_point_in_time in settings #5460

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 1 commit into from
Oct 10, 2025
Merged

[Backport 9.1] [Transform] Specify use_point_in_time in settings #5460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 19 additions & 4 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions output/typescript/types.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion specification/_doc_ids/table.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,7 @@ painless-contexts,https://www.elastic.co/docs/reference/scripting-languages/pain
painless-execute-api,https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples,,
pipeline-processor,https://www.elastic.co/docs/reference/enrich-processor/pipeline-processor,,
pki-realm,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/pki,,
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,
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
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,
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,
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,
Expand Down
10 changes: 10 additions & 0 deletions specification/transform/_types/Transform.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,16 @@ export class Settings {
* @server_default 500
*/
max_page_search_size?: integer
/**
* Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index.
* In general, Point In Time is an optimization that will reduce pressure on the source index by reducing the amount
* of refreshes and merges, but it can be expensive if a large number of Point In Times are opened and closed for a
* given index. The benefits and impact depend on the data being searched, the ingest rate into the source index, and
* the amount of other consumers searching the same source index.
* @ext_doc_id point-in-time-api
* @server_default true
*/
use_point_in_time?: boolean

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