mGet #
Gets multiple documents.
The number of documents that can be fetched by a single request is limited by the documentsFetchCount
server configuration (see the Configuring Kuzzle guide).
Query Syntax #
HTTP #
URL: http://kuzzle:7512/<index>/<collection>/_mGet
Method: POST
Body:
{
"ids": ["<documentId>", "<anotherDocumentId>"]
}
You can also access this route with the GET
verb:
URL: http://kuzzle:7512/<index>/<collection>/_mGet?ids=documentId,anotherDocumentId
Method: GET
Other protocols #
{
"index": "<index>",
"collection": "<collection>",
"controller": "document",
"action": "mGet",
"body": {
"ids": ["<documentId>", "<anotherDocumentId>"]
}
}
Kourou #
kourou document:mGet <index> <collection> <body>
Arguments #
collection
: collection nameindex
: index name
Optional: #
strict
: if set, an error will occur if any of the documents could not be retrievedAvailable since 2.11.0
Body properties #
ids
: an array of document identifiers to fetch
Response #
Returns an object containing 2 arrays: successes
and errors
The successes
array contain the list of retrieved documents.
Each document is an object with the following properties:
_id
: document unique identifier_source
: document content_version
: version number of the document
The errors
array contain the IDs of not found documents.
If strict
mode is enabled, will rather return an error if at least one document could not been retreived.
{
"status": 200,
"error": null,
"index": "<index>",
"collection": "<collection>",
"action": "mGet",
"controller": "document",
"requestId": "<unique request identifier>",
"result": {
"successes": [
{
"_id": "<documentId>",
"_source": {
// document content
},
"_version": 4
},
{
"_id": "<anotherDocumentId>",
"_source": {
// document content
},
"_version": 2
}
]
"errors": ["<anotherDocumentId>"]
}
}
Edit this page on Github (opens new window)