You are currently browsing legacy 3.0 version of documentation. Click here to switch to the newest 5.1 version.
Commands: Documents: Stream
StreamDocs is used to stream documents which match chosen criteria from a database.
Syntax
curl \
http://{serverName}/databases/{databaseName}/streams/docs? \
etag={etag}& \
startsWith={startsWith}& \
matches={matches}& \
exclude={exclude}& \
skipAfter={skipAfter}& \
start={start}& \
pageSize={pageSize} \
-X GET
Request
Query parameter
Required
Description
etag
No
ETag of a document from which stream should start (mutually exclusive with 'startsWith')
startsWith
No
prefix for which documents should be streamed (mutually exclusive with 'etag')
matches
No
pipe ('|') separated values for which document keys (after 'keyPrefix') should be matched ('?' any single character, '*' any characters)
exclude
No
pipe ('|') separated values for which document keys (after 'keyPrefix') should not be matched ('?' any single character, '*' any characters)
skipAfter
No
skip document fetching until given key is found and return documents after that key
start
No
number of documents that should be skipped
pageSize
No
maximum number of documents that will be retrieved
Header
Required
Description
Single-Use-Auth-Token
No
Required if authentication is enabled.
Response
Status code
Description
200
OK
Return Value
Description
Results
list of json documents
Example
Streams products.
curl -X GET "http://localhost:8080/databases/NorthWind/streams/docs?startsWith=products%2F"
< HTTP/1.1 200 OK
{"Results": [ jsonDocument, jsonDocument, ... ] }
Please enable JavaScript to view the comments powered by Disqus.