removeProvider

Removes an existing document or documents and updates the tracking index.

Args:

• collection - The collection from which to remove the document.
• data - An object or array of objects containing meta information of documents to be removed.
• options - An optional object, containing any combination of the following keys:
  • returnOld - Whether to return the old object. Default false.
  • silent - Whether to return anything in the result. Default false.
  • ignoreRevs - Whether to ignore a revision match before delete. Default true.

Return:

The contents of the result returned by the method is identical to the contents of the response body of the corresponding HTTP API, invoked with identical input, except when the method throws an error. In the latter case, the error message would be identical to the error response of the HTTP call.

Errors:

If data is a single object, then any error that occurs while executing the method is thrown back to the caller.

If, on the other hand, data is an array of objects, then the method always returns an array of results. For every element of the data array which incurs an error, the error object is present at the corresponding index in the result array. For every input element that the method handles successfully, the result array contains an element that is identical to the result that would have been returned had the method been invoked singly for this element, with identical options.

Examples:

1. Remove a single document silently:

   removeProvider('vertex_collection',
    { _key: 'abc' },
    { silent: true }
   )

2. Remove an array of documents and return the old documents (full content rather just the meta information):

   removeProvider('edge_collection', [
      // Perform a rev match before delete.
      { _key: 'abc', _rev: 'xyz' },
      // Non-meta content is ignored.
      { x: 2, y: 1, _id: 'edge_collection/def' },
      { _id: 'edge_collection/xyz' }
    ],
    { returnOld: true }
   )