Javascript 7.x

mDelete

Deletes multiple documents.

The optional parameter refresh can be used with the value wait_for in order to wait for the document indexation (indexed documents are available for search).


Copied to clipboard!
mDelete(index, collection, ids, [options]);
Argument Type Description
index
string
Index name
collection
string
Collection name
ids
string[]
IDs of the documents to delete
options
object
Query options

Options

Additional query options

Options Type
(default)
Description
queuable
boolean

(true)
If true, queues the request during downtime, until connected to Kuzzle again
refresh string
("")
If set to wait_for, waits for the change to be reflected for search (up to 1s)

Resolves

Returns an object containing 2 arrays: successes and errors

The successes array contain the successfuly deleted document IDs.

Each deletion error is an object of the errors array with the following properties:

Name Type Description
id
string
Document ID
reason
string
Human readable reason

Usage

Copied to clipboard!
try {
  await kuzzle.document.create('nyc-open-data', 'yellow-taxi', {}, 'some-id');
  await kuzzle.document.create('nyc-open-data', 'yellow-taxi', {}, 'some-other-id');
  const response = await kuzzle.document.mDelete(
    'nyc-open-data',
    'yellow-taxi',
    ['some-id', 'some-other-id']
  );
  console.log(`Successfully deleted ${response.successes.length} documents`);
} catch (error) {
  console.error(error.message);
}