index.md

code	type	title
true	page	sscan | API | Core

sscan

Iterates incrementally over members contained in a set of unique values, 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

URL: http://kuzzle:7512/ms/_sscan/<_id>?cursor=<cursor>[&match=<pattern>][&count=<count>]
Method: GET

Other protocols

{
  "controller": "ms",
  "action": "sscan",
  "_id": "<key>",
  "cursor": 0,
  // optional
  "match": "<pattern>",
  "count": 20
}

---

Arguments

• _id: set key identifier
• cursor: cursor offset

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

{
  "requestId": "<unique request identifier>",
  "status": 200,
  "error": null,
  "controller": "ms",
  "action": "sscan",
  "collection": null,
  "index": null,
  "result": [
    13,
    [
      "member1",
      "member2",
      "..."
    ]
  ]
}