Skip to main content

#db.r(..)

Removes document(s) from the database.

Similar to a MongoDB db.collection.remove(), with some syntax restrictions

Syntax

#db.r(query)

Arguments

query

Selection filter for documents in the script owner's database.

danger

All documents matched will be deleted, without confirmation. An empty query ( {} ) will delete every document in the user's database!

Return Data

An object is returned upon deleting documents with this function, providing extra details about whether it succeeded:

KeyInformation
nNumber of documents deleted
okIf the operation succeeded, == 1
opTimeObject that contains a property 't' -- time of deletion operation in millieconds

Other values are returned, but provide no additional usable data due to undefined conversions

Example

function(context, args) {
/*
where the database already contains documents:
#db.i(
{type:"my_data", my_key:"foo"},
{type:"my_data", my_key:"bar"}
)
*/
#db.r({type:"my_data"})

return #db.f({type:"my_data"}).first() // null
}