Scroll

Introduced 1.0

You can use the scroll operation to retrieve a large number of results. For example, for machine learning jobs, you can request an unlimited number of results in batches.

To use the scroll operation, add a scroll parameter to the request header with a search context to tell OpenSearch how long you need to keep scrolling. This search context needs to be long enough to process a single batch of results.

Because search contexts consume a lot of memory, we suggest you don’t use the scroll operation for frequent user queries. Instead, use the sort parameter with the search_after parameter to scroll responses for user queries.

Path and HTTP methods

  1. GET _search/scroll
  2. POST _search/scroll
  3. GET _search/scroll/<scroll-id>
  4. POST _search/scroll/<scroll-id>

Path parameters

ParameterTypeDescription
scroll_idStringThe scroll ID for the search.

Query parameters

All scroll parameters are optional.

ParameterTypeDescription
scrollTimeSpecifies the amount of time the search context is maintained.
scroll_idStringThe scroll ID for the search.
rest_total_hits_as_intBooleanWhether the hits.total property is returned as an integer (true) or an object (false). Default is false.

Example requests

To set the number of results that you want returned for each batch, use the size parameter:

  1. GET shakespeare/_search?scroll=10m
  2. {
  3.   "size": 10000
  4. }

copy

OpenSearch caches the results and returns a scroll ID to access them in batches:

  1. "_scroll_id" : "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAUWdmpUZDhnRFBUcWFtV21nMmFwUGJEQQ=="

Pass this scroll ID to the scroll operation to get back the next batch of results:

  1. GET _search/scroll
  2. {
  3.   "scroll": "10m",
  4.   "scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAUWdmpUZDhnRFBUcWFtV21nMmFwUGJEQQ=="
  5. }

copy

Using this scroll ID, you get results in batches of 10,000 as long as the search context is still open. Typically, the scroll ID does not change between requests, but it can change, so make sure to always use the latest scroll ID. If you don’t send the next scroll request within the set search context, the scroll operation does not return any results.

If you expect billions of results, use a sliced scroll. Slicing allows you to perform multiple scroll operations for the same request, but in parallel. Set the ID and the maximum number of slices for the scroll:

  1. GET shakespeare/_search?scroll=10m
  2. {
  3.   "slice": {
  4.     "id": 0,
  5.     "max": 10
  6.   },
  7.   "query": {
  8.     "match_all": {}
  9.   }
  10. }

copy

With a single scroll ID, you get back 10 results. You can have up to 10 IDs.

Close the search context when you’re done scrolling, because the scroll operation continues to consume computing resources until the timeout:

  1. DELETE _search/scroll/DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAcWdmpUZDhnRFBUcWFtV21nMmFwUGJEQQ==

copy

To close all open scroll contexts:

  1. DELETE _search/scroll/_all

copy

The scroll operation corresponds to a specific timestamp. It doesn’t consider documents added after that timestamp as potential results.

Example response

  1. {
  2.   "succeeded": true,
  3.   "num_freed": 1
  4. }