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.

deleteDocument(documentId, [options], [callback]) #

Arguments	Type	Description
`documentId`	string	Unique document identifier
`options`	JSON object	Optional parameters
`callback`	function	Optional callback

deleteDocument(filters, [options], [callback]) #

Arguments	Type	Description
`filters`	JSON object	Filters in ElasticSearch Query DSL format
`options`	JSON object	Optional parameters
`callback`	function	Optional callback

Options #

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`

Return Value #

Returns the Collection object to allow chaining.

Callback Response #

Returns an array containing the ids of the deleted documents.

Usage #

// Deleting one document using callbacks (NodeJS or Web Browser)
kuzzle
  .collection('collection', 'index')
  .deleteDocument('document unique ID', function (err, res) {
    // callback called once the delete action has been completed
  });
// Deleting one document using promises (NodeJS)
kuzzle
  .collection('collection', 'index')
  .deleteDocumentPromise('document unique ID')
  .then(res => {
    // promises resolved once the delete action has been completed
  });
// Deleting multiple documents using callbacks (NodeJS or Web Browser)
kuzzle
  .collection('collection', 'index')
  .deleteDocument({filter: {equals: {title: 'foo'}}}, function (err, res) {
    // callback called once the delete with query has been completed
  });
// Deleting multiple documents using promises (NodeJS)
  kuzzle
  .collection('collection', 'index')
  .deleteDocumentPromise({filter: {equals: {title: 'foo'}}})
  .then(res => {
    // promise resolved once the delete by query has been completed
  });

Callback response:

["AVCoeBkimsySTKTfa8AX"]

Edit this page on Github