SDK
SDK Javascript v5.x
1

mDeleteDocument #

Delete multiple Documents according to the input IDs.


mDeleteDocument(documentIds, [options], callback) #

Arguments Type Description
documentIds String[] Array of IDs of documents to delete
options JSON Object Optional parameters
callback function Callback handling the response

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Callback Response #

Returns a JSON object containing the raw Kuzzle response. Can return a 206 partial error in cases where some documents could not be deleted.

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
kuzzle
  .collection('collection', 'index')
  .mDeleteDocument(['doc1', 'doc2'], function (error, result) {
    // callback called once the mDelete operation has completed
    // => the result is a JSON object containing the raw Kuzzle response
  });
// Using promises (NodeJS only)
kuzzle
  .collection('collection', 'index')
  .mDeleteDocument()
  .then(result => {
    // promise resolved once the mDelete operation has completed
    // => the result is a JSON object containing the raw Kuzzle response
  });

Callback response:

Copied to clipboard!
["doc1", "doc2"]