| code | type | title | description |
|---|---|---|---|
true |
page |
mDelete |
Delete documents |
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).
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 |
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) |
silent |
boolean ( false) |
If true, then Kuzzle will not generate notifications |
timeout |
number ( -1) |
Time (in ms) during which a request will still be waited to be resolved. Set it -1 if you want to wait indefinitely |
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 |
<<< ./snippets/m-delete.js