Skip to content

Document scroll param on reindex.json #38615

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 2 commits into from
Mar 7, 2019
Merged

Document scroll param on reindex.json #38615

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
394fcda
Document scroll param on reindex.json
Mpdreamz Feb 8, 2019
e2dfc7f
Merge branch 'master' into rest-spec-reindex-scroll
Mpdreamz Mar 5, 2019
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
5 changes: 5 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/reindex.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@
"default": 0,
"description": "The throttle to set on this request in sub-requests per second. -1 means no throttle."
},
"scroll": {
"type" : "time",
"description" : "Control how long to keep the search context alive",
"default" : "5m"
Copy link
Member

@javanna javanna Feb 25, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where did you find the 5m default again?

Copy link
Member Author

@Mpdreamz Mpdreamz Mar 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both work exactly how they work in the Bulk API. As _reindex uses scroll search, you can also specify the scroll parameter to control how long it keeps the "search context" alive, (e.g. ?scroll=10m). The default value is 5 minutes.

https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html

},
"slices": {
"type": "number",
"default": 1,
Expand Down