Skip to content
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

Jump to bottom

[docs] update by query API scroll_size param default value described differently in docs #63637

Closed
pmuellr opened this issue Oct 13, 2020 · 2 comments · Fixed by #63656
Closed

[docs] update by query API scroll_size param default value described differently in docs #63637

pmuellr opened this issue Oct 13, 2020 · 2 comments · Fixed by #63656
Labels
>bug :Distributed/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes Team:Distributed Meta label for distributed team

Comments

@pmuellr
Copy link
Member

pmuellr commented Oct 13, 2020

In the update by query docs for query parameters, it says the following for scroll_size:

scroll_size
(Optional, integer) Size of the scroll request that powers the operation. Defaults to 100.

Later, in the examples section, it says:

By default update by query uses scroll batches of 1000. You can change the batch size with the scroll_size parameter:

POST my-index-000001/_update_by_query?scroll_size=100

It seems like one of these is wrong - it's either 100 or 1000.
@pmuellr pmuellr added >bug needs:triage Requires assignment of a team area label labels Oct 13, 2020
@pmuellr pmuellr mentioned this issue Oct 13, 2020
Closed
@gaobinlong gaobinlong mentioned this issue Oct 14, 2020
Closed
@cbuescher cbuescher added the >docs General docs changes label Oct 14, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Oct 14, 2020
@cbuescher cbuescher added :Distributed/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. and removed Team:Docs Meta label for docs team needs:triage Requires assignment of a team area label labels Oct 14, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (:Distributed/CRUD)

@elasticmachine elasticmachine added the Team:Distributed Meta label for distributed team label Oct 14, 2020
@cbuescher cbuescher mentioned this issue Oct 14, 2020
Merged
cbuescher pushed a commit that referenced this issue Oct 14, 2020
[Docs] Correct default scroll_size for update by query (#63656)
b44a03d 
The current _update_by_query documentation mentions a scroll_size default of 100 and later another default of 1000.
We use the default of 1000 defined in AbstractBulkByScrollRequest and this PR changes the documentation accordingly.

Closes #63637
cbuescher pushed a commit that referenced this issue Oct 14, 2020
[Docs] Correct default scroll_size for update by query (#63656)
6c99ce7 
The current _update_by_query documentation mentions a scroll_size default of 100 and later another default of 1000.
We use the default of 1000 defined in AbstractBulkByScrollRequest and this PR changes the documentation accordingly.

Closes #63637
cbuescher pushed a commit that referenced this issue Oct 14, 2020
[Docs] Correct default scroll_size for update by query (#63656)
fe75bf5 
The current _update_by_query documentation mentions a scroll_size default of 100 and later another default of 1000.
We use the default of 1000 defined in AbstractBulkByScrollRequest and this PR changes the documentation accordingly.

Closes #63637
cbuescher pushed a commit that referenced this issue Oct 14, 2020
[Docs] Correct default scroll_size for update by query (#63656)
e6d04dc 
The current _update_by_query documentation mentions a scroll_size default of 100 and later another default of 1000.
We use the default of 1000 defined in AbstractBulkByScrollRequest and this PR changes the documentation accordingly.

Closes #63637
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
>bug :Distributed/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes Team:Distributed Meta label for distributed team
Projects
None yet
Milestone
No milestone
3 participants
@pmuellr @cbuescher @elasticmachine