From f8f57455c110891de7589881ec30c0e5095dc7f8 Mon Sep 17 00:00:00 2001 From: Pat Whelan Date: Fri, 19 Sep 2025 13:14:20 -0400 Subject: [PATCH 1/3] [Transform] Specify use_point_in_time in settings --- output/schema/schema.json | 23 +++++++++++++++++---- output/typescript/types.ts | 1 + specification/transform/_types/Transform.ts | 6 ++++++ 3 files changed, 26 insertions(+), 4 deletions(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index 0474539de3..8eb6413ade 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -262284,6 +262284,21 @@ } } }, + { + "description": "Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index.", + "docId": "point-in-time-api", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time", + "name": "use_point_in_time", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, { "availability": { "serverless": {}, @@ -262304,7 +262319,7 @@ } } ], - "specLocation": "transform/_types/Transform.ts#L98-L144" + "specLocation": "transform/_types/Transform.ts#L98-L150" }, { "kind": "interface", @@ -262356,7 +262371,7 @@ } } ], - "specLocation": "transform/_types/Transform.ts#L146-L165" + "specLocation": "transform/_types/Transform.ts#L152-L171" }, { "kind": "interface", @@ -262378,7 +262393,7 @@ } } ], - "specLocation": "transform/_types/Transform.ts#L169-L175", + "specLocation": "transform/_types/Transform.ts#L175-L181", "variants": { "kind": "container" } @@ -262416,7 +262431,7 @@ } } ], - "specLocation": "transform/_types/Transform.ts#L177-L189" + "specLocation": "transform/_types/Transform.ts#L183-L195" }, { "kind": "request", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index d978bfde72..b3b75a89f6 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -22396,6 +22396,7 @@ export interface TransformSettings { deduce_mappings?: boolean docs_per_second?: float max_page_search_size?: integer + use_point_in_time?: boolean unattended?: boolean } diff --git a/specification/transform/_types/Transform.ts b/specification/transform/_types/Transform.ts index ed11e0bcb1..1a8daf4db3 100644 --- a/specification/transform/_types/Transform.ts +++ b/specification/transform/_types/Transform.ts @@ -130,6 +130,12 @@ 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. + * @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 From de6d072ddffe4071c9d1766f98ce24d4b63bcc79 Mon Sep 17 00:00:00 2001 From: Pat Whelan Date: Fri, 19 Sep 2025 13:42:47 -0400 Subject: [PATCH 2/3] use @ext_doc_id --- output/schema/schema.json | 4 ++-- specification/transform/_types/Transform.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index 8eb6413ade..863421e6ec 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -262286,8 +262286,8 @@ }, { "description": "Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index.", - "docId": "point-in-time-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time", + "extDocId": "point-in-time-api", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time", "name": "use_point_in_time", "required": false, "serverDefault": true, diff --git a/specification/transform/_types/Transform.ts b/specification/transform/_types/Transform.ts index 1a8daf4db3..3ca20079a6 100644 --- a/specification/transform/_types/Transform.ts +++ b/specification/transform/_types/Transform.ts @@ -132,7 +132,7 @@ export class Settings { max_page_search_size?: integer /** * Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index. - * @doc_id point-in-time-api + * @ext_doc_id point-in-time-api * @server_default true */ use_point_in_time?: boolean From e6f662c78719f6b209c183b73647a71fde7e0cee Mon Sep 17 00:00:00 2001 From: Pat Whelan Date: Wed, 1 Oct 2025 15:44:26 -0400 Subject: [PATCH 3/3] address comments --- output/schema/schema.json | 10 +++++----- specification/_doc_ids/table.csv | 2 +- specification/transform/_types/Transform.ts | 4 ++++ 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index f5ae90aaf3..dc34116862 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -263177,7 +263177,7 @@ } }, { - "description": "Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index.", + "description": "Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index.\nIn general, Point In Time is an optimization that will reduce pressure on the source index by reducing the amount\nof refreshes and merges, but it can be expensive if a large number of Point In Times are opened and closed for a\ngiven index. The benefits and impact depend on the data being searched, the ingest rate into the source index, and\nthe amount of other consumers searching the same source index.", "extDocId": "point-in-time-api", "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time", "name": "use_point_in_time", @@ -263211,7 +263211,7 @@ } } ], - "specLocation": "transform/_types/Transform.ts#L98-L150" + "specLocation": "transform/_types/Transform.ts#L98-L154" }, { "kind": "interface", @@ -263263,7 +263263,7 @@ } } ], - "specLocation": "transform/_types/Transform.ts#L152-L171" + "specLocation": "transform/_types/Transform.ts#L156-L175" }, { "kind": "interface", @@ -263285,7 +263285,7 @@ } } ], - "specLocation": "transform/_types/Transform.ts#L175-L181", + "specLocation": "transform/_types/Transform.ts#L179-L185", "variants": { "kind": "container" } @@ -263323,7 +263323,7 @@ } } ], - "specLocation": "transform/_types/Transform.ts#L183-L195" + "specLocation": "transform/_types/Transform.ts#L187-L199" }, { "kind": "request", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 93060c910b..afaa604e4f 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -520,7 +520,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, diff --git a/specification/transform/_types/Transform.ts b/specification/transform/_types/Transform.ts index 3ca20079a6..f363aa5ac0 100644 --- a/specification/transform/_types/Transform.ts +++ b/specification/transform/_types/Transform.ts @@ -132,6 +132,10 @@ export class Settings { 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 */