mDelete #

Deletes multiple documents.

---

Arguments #

Copied to clipboard!

Future<Map<String, dynamic>> mDelete(
    String index,
    String collection,
    List<String> ids,
    { bool waitForRefresh = false, })

Arguments	Type	Description
index	String	Index name
collection	String	Collection name
ids	List<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:

Property	Type	Description
_id	String	Document ID
reason	String	Human readable reason

Usage #

Copied to clipboard!

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