honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/search/request/from-size.asciidoc

35 lines
1.2 KiB
Plaintext
Raw Normal View History

[DOCS] Move Elasticsearch APIs to REST APIs section. (#44238) (#44372) Moves the following API sections under the REST APIs navigations: - API Conventions - Document APIs - Search APIs - Index APIs (previously named Indices APIs) - cat APIs - Cluster APIs Other supporting changes: - Removes the previous index APIs page under REST APIs. Adds a redirect for the removed page. - Removes several [partintro] macros so the docs build correctly. - Changes anchors for pages that become sections of a parent page. - Adds several redirects for existing pages that become sections of a parent page. This commit re-applies changes from #44238. Changes from that PR were reverted due to broken links in several repos. This commit adds redirects for those broken links.
2019-07-17 08:49:22 -04:00
[[request-body-search-from-size]]
[DOCS] Remove heading offsets for REST APIs (#44568) 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.
2019-07-19 14:35:36 -04:00
==== From / Size
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
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]
--------------------------------------------------
Add CONSOLE to from/size docs Relates to #18160
2016-05-18 05:54:41 -04:00
GET /_search
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
{
"from" : 0, "size" : 10,
"query" : {
"term" : { "user" : "kimchy" }
}
}
--------------------------------------------------
Add CONSOLE to from/size docs Relates to #18160
2016-05-18 05:54:41 -04:00
// CONSOLE
[search] Limit the size of the result window Requesting a million hits, or page 100,000 is always a bad idea, but users may not be aware of this. This adds a per-index limit on the maximum size + from that can be requested which defaults to 10,000. This should not interfere with deep-scrolling. Closes #9311
2015-08-28 14:16:45 -04:00
Note that `from` + `size` can not be more than the `index.max_result_window`
Adding a warning to from-size.asciidoc Customers occasionally discover a known behavior in Elasticsearch's pagination that does not appear to be documented. This warning is intended to educate customers of this behavior while still highlighting alternative solutions.
2019-08-22 21:22:54 -04:00
index setting, which defaults to 10,000.
WARNING: {es} uses Lucene's internal doc IDs as tie-breakers. These internal
doc IDs can be completely different across replicas of the same
data. When paginating, you might occasionally see that documents with the same
sort values are not ordered consistently. For deep scrolling, it is more
efficient to use the <<request-body-search-scroll,Scroll>> or
<<request-body-search-search-after,Search After>> APIs.