GET /data/{namespace}[?cursor={cursor}&count={count}&start={start}&timeout={timeout}]
A GET operation on the path to namespace will return all objects in that namespace as a JSON-formatted message body. The results are efficiently stored as system objects in the data grid for subsequent retrieval as a "snapshot in time" without re-running the query operation. The cached results can be retrieved by passing the returned cursor parameter as an input cursor to a subsequent query.
Note | |
---|---|
Retrieving all object keys in a namespace is resource-intensive: it entails running a query against the ScaleOut StateServer service, which involves every host in the distributed data grid. Favor key-based operations against individual objects whenever possible, as they will run faster by orders of magnitude. |
-
Timeout
-
(Optional) Specifies the lifetime of the results represented by the returned cursor in seconds. The default is 5 minutes (
300
). This parameter has no effect when returning a previously queried result set identified by a cursor. -
Cursor
- (Optional) Specifies the cursor returned from a previous query to retrieve the same result set.
-
Count
- (Optional) Specifies the number of results to return.
-
Start
- (Optional) Specifies the starting point in the result set to return.
If successful, the response will contain a JSON-formatted message body of a unique cursor identifier (used to retrieve the
same results in a future request), followed by an array of object keys represented as bytes and strings (if available). If
a string key is not available for an object, that key’s stringKey
property will be omitted and only a byteKey
will be returned.
Example Response.
{ "cursor":"{4C296374-D114-435D-B86E-98966D871ADD}", "keys":[ { "byteKey":"913da1f8df6f8fd47593840d533ba0458cc9873996bf310460abb495b34c232a", "stringKey":"2" }, { "byteKey":"e4f60d0aa6d7f3d3b6a6494b1c861b99f649c6f9ec51abaf201b20f297327c95", "stringKey":"0" }, { "byteKey":"aa4fb8a61cab7db73f42671f2bb987a7291a436929b3d5f17ffe05f96be13371", "stringKey":"6" }, { "byteKey":"e79e418e48623569d75e2a7b09ae88ed9b77b126a445b9ff9dc6989a08efa079", "stringKey":"1" }, { "byteKey":"3089c464221340fed4229d6ba913a04224c91b44158c22163e8849eb7dcc4878", "stringKey":"4" } ] }
-
Soss-Cursor
- A unique identifier for the current complete result set, used in future queries to retrieve the same results (e.g., for iteration/pagination).