[DOCS] Add search pagination docs #56785
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reworks the `from / size` content to `Paginate search results`. Moves those docs from the request body search API page (slated for deletion) to the `Run a search` tutorial docs. Also adds some notes to the `from` and `size` param docs.
jrodewig
added
>docs
|
Pinging @elastic/es-search (:Search/Search) |
|
Pinging @elastic/es-docs (>docs) |
28 tasks
debadair
suggested changes
May 14, 2020
Comment on lines
13
to
19
| [IMPORTANT] | ||
| ==== | ||
| The combined document count, including offset and and returned documents, for | ||
| the `from` and `size` parameters cannot exceed the | ||
| <<index-max-result-window,`index.max_result_window`>> index setting, which | ||
| defaults to 10,000 documents. | ||
| ==== |
There was a problem hiding this comment.
I think the point here is that by default, you can page through a maximum of 10,000 documents. I'd say that, and then xref the settings, but probably not as a note. Instead,
I'd pull some of the cautionary info about deep paging into an important note from the definitive guide.
| @@ -87,6 +87,14 @@ both parameters are specified, only the query parameter is used. | |||
| include::{docdir}/rest-api/common-parms.asciidoc[tag=from] | |||
| + | |||
| -- | |||
| [IMPORTANT] | |||
There was a problem hiding this comment.
Some combo of only being able to page through 10k docs by default and the warning about deep paging would need to go replace these admonitions, as well.
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
|
Thanks! |
This was referenced Jun 1, 2020
jrodewig
added a commit
that referenced
this pull request
Jun 1, 2020
Reworks the `from / size` content to `Paginate search results`. Moves those docs from the request body search API page (slated for deletion) to the `Run a search` tutorial docs. Also adds some notes to the `from` and `size` param docs. Co-authored-by: debadair <debadair@elastic.co>
jrodewig
added a commit
that referenced
this pull request
Jun 1, 2020
Reworks the `from / size` content to `Paginate search results`. Moves those docs from the request body search API page (slated for deletion) to the `Run a search` tutorial docs. Also adds some notes to the `from` and `size` param docs. Co-authored-by: debadair <debadair@elastic.co>
jrodewig
added a commit
that referenced
this pull request
Jun 1, 2020
Reworks the `from / size` content to `Paginate search results`. Moves those docs from the request body search API page (slated for deletion) to the `Run a search` tutorial docs. Also adds some notes to the `from` and `size` param docs. Co-authored-by: debadair <debadair@elastic.co>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reworks the
from / sizecontent toPaginate search results.Moves those docs from the
Request body searchAPI docs page(slated for deletion) to the
Run a searchtutorial docs.Also adds some notes to the
fromandsizeparam docs.Because this involves redirects, I only plan to merge intoI'll be backporting to all maintained branches.master.Relates to #48194