| code | type | title | description |
|---|---|---|---|
false |
page |
deleteDocument |
Collection:deleteDocument |
Delete a stored document, or all stored documents matching a search filter.
There is a small delay between the time a document is deleted and it being reflected in the search layer (usually a couple of seconds). That means that a document that was just deleted may still be returned by this function at first.
| Arguments | Type | Description |
|---|---|---|
documentId |
string | Unique document identifier |
options |
JSON object | Optional parameters |
callback |
function | Optional callback |
| Arguments | Type | Description |
|---|---|---|
filters |
JSON object | Filters in ElasticSearch Query DSL format |
options |
JSON object | Optional parameters |
callback |
function | Optional callback |
| Option | Type | Description | Default |
|---|---|---|---|
volatile |
JSON object | Additional information passed to notifications to other users | null |
queuable |
boolean | Make this request queuable or not | true |
refresh |
string | If set to wait_for, Kuzzle will wait for the persistence layer to finish indexing (available with Elasticsearch 5.x and above) |
undefined |
Returns the Collection object to allow chaining.
Returns an array containing the ids of the deleted documents.
<<< ./snippets/delete-document-1.js
Callback response:
["AVCoeBkimsySTKTfa8AX"]