| code | type | title |
|---|---|---|
true |
page |
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.
scan(cursor, [options]);| Arguments | Type | Description |
|---|---|---|
cursor |
integer |
Cursor offset |
options |
object |
Optional query arguments |
The options arguments can contain the following option properties:
| Property | Type (default) | Description |
|---|---|---|
count |
integer (10) |
Return an approximate number of items per result set |
match |
string (*) |
Return only keys matching the provided pattern |
queuable |
boolean (true) |
If true, queues the request during downtime, until connected to Kuzzle again |
Resolves to an object representing a result page, with the following properties:
| Property | Type | Description |
|---|---|---|
cursor |
integer |
Cursor offset for the next page, or 0 if at the end of the scan |
values |
string[] |
List of keys |
<<< ./snippets/scan.js