SDK
SDK Dart Null Safety v3.x
2

mDelete #

Deletes multiple documents.


Arguments #

Future<Map<String, dynamic>> mDelete(
    String index,
    String collection,
    List<String> ids,
    { bool waitForRefresh = false, })
ArgumentsTypeDescription
index
String
Index name
collection
String
Collection name
idsList<String>Document IDs

Return #

A Map<String, dynamic> which has a successes and errors: The successes array contains the successfully deleted document IDs.

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

PropertyTypeDescription
_id
String
Document ID
reason
String
Human readable reason

Usage #

final result = await kuzzle
  .document
  .mDelete('nyc-open-data', 'yellow-taxi', [
    'some-id',
    'some-id2'
  ]);