mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-09 22:45:04 +00:00
a63f60b776
Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
29 lines
957 B
Plaintext
29 lines
957 B
Plaintext
[[request-body-search-from-size]]
|
|
==== From / Size
|
|
|
|
Pagination of results can be done by using the `from` and `size`
|
|
parameters. The `from` parameter defines the offset from the first
|
|
result you want to fetch. The `size` parameter allows you to configure
|
|
the maximum amount of hits to be returned.
|
|
|
|
Though `from` and `size` can be set as request parameters, they can also
|
|
be set within the search body. `from` defaults to `0`, and `size`
|
|
defaults to `10`.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_search
|
|
{
|
|
"from" : 0, "size" : 10,
|
|
"query" : {
|
|
"term" : { "user" : "kimchy" }
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
|
|
|
|
Note that `from` + `size` can not be more than the `index.max_result_window`
|
|
index setting which defaults to 10,000. See the <<request-body-search-scroll,Scroll>> or <<request-body-search-search-after,Search After>>
|
|
API for more efficient ways to do deep scrolling.
|