scan

Iterates incrementally over the set of keys in the database using a cursor.

An iteration starts when the cursor is set to 0.
To get the next page of results, simply re-send the request with the updated cursor position provided in the result set.

The scan ends when the cursor returned by the server is 0.

[Redis documentation]


Query Syntax

HTTP

Copied to clipboard!
URL: http://kuzzle:7512/ms/_scan?cursor=<cursor>[&match=<pattern>][&count=<count>]
Method: GET

Other protocols

Copied to clipboard!
{
  "controller": "ms",
  "action": "scan",
  "cursor": 0,
  // optional
  "match": "foo*bar",
  "count": 20
}

Arguments

  • cursor: cursor offset (set it to 0 to start a new scan)

Optional:

  • count: return an approximate number of items per result set (the default is 10)
  • match: search only keys matching the provided pattern

Response

Returns an array containing the following two elements:

  • a new cursor position, to be used to get the next page of results (or 0 when at the end of the cursor)
  • an array of found keys

Example

Copied to clipboard!
{
  "requestId": "<unique request identifier>",
  "status": 200,
  "error": null,
  "controller": "ms",
  "action": "hscan",
  "collection": null,
  "index": null,
  "result": [
    13,
    [
      "key1",
      "key2",
      "..."
    ]
  ]
}