[Transform] Specify use_point_in_time in settings #5322
Conversation
|
Following you can find the validation changes against the target branch for the APIs. No changes detected. You can validate these APIs yourself by using the |
| max_page_search_size?: integer | ||
| /** | ||
| * Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index. | ||
| * @ext_doc_id point-in-time-api |
There was a problem hiding this comment.
@elastic/developer-docs Is this a correct usage of ext_doc_id?
This Transform API can be configured to use the PIT API, and here point-in-time-api links to the point-in-time API docs.
There was a problem hiding this comment.
Hey @pquentin, the @ext_doc_id looks fine here. I see it’s already in the table.csv file as well, so it should be good. What we usually do to make sure the links appear correctly is test them locally by running these (you should have the bump CLI installed):
make generate
make transform-to-openapi
bump preview output/openapi/elasticsearch-openapi.json
There was a problem hiding this comment.
Seems to have worked as intended:
And it correctly links to https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time
There was a problem hiding this comment.
FYI we could add a description field to the link definition in
and this would be render nicer link text than just External documentation 💅
There was a problem hiding this comment.
Do you have an example of that?
There was a problem hiding this comment.
this could be as simple as Point in Time API
There was a problem hiding this comment.
| */ | ||
| max_page_search_size?: integer | ||
| /** | ||
| * Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index. |
There was a problem hiding this comment.
What happens if you set it to false? It uses the scroll API?
There was a problem hiding this comment.
Nah it just uses a search request without PIT: https://github.com/elastic/elasticsearch/blob/main/x-pack/plugin/transform/src/main/java/org/elasticsearch/xpack/transform/transforms/TransformIndexer.java#L1154
There was a problem hiding this comment.
ideally we'd explain the pros/cons differences of each approach, or at least outline why you'd want to use the PIT, rather than just the how :)
There was a problem hiding this comment.
should that go on the PIT page? in either case, we'd need someone familiar with PIT to go into that detail, I'm just trying to show what users can configure rather than keeping the setting hidden
use_point_in_timehas been in the docs since before 8.18Resolve elastic/elasticsearch#134841