key.delete()
Delete an key.
Description
The delete()
method deletes the key from storage, and
returns an Object representing the deleted key with the
id
and coll
identity fields.
Return value
Type | Description |
---|---|
NullKey |
Document doesn’t exist or is inaccessible. See NullDoc. |
Examples
Delete all keys
To avoid throttling, you can incrementally delete all keys for a database before deleting the database itself.
To stay within transaction size
limits, use set.paginate()
to
perform the deletions over several transactions instead of one.
// Gets all `Key` system collection documents.
// Uses `pageSize()` to limit the page size.
// Uses `paginate()` to project the after cursor.
let page = Key.all().pageSize(200).paginate()
// `paginate()` returns an object. The object's `data` property
// contains an array of `Key` documents.
let data = page.data
// Use `forEach()` to delete each `Key` document in the
// `data` array.
data.forEach(doc => doc.delete()
// Project the `after` cursor returned by `paginate()`.
// Use the cursor to iterate through the remaining pages.
page {
after
}
{
after: "hdWDxoq..."
}
Subsequent transactions use the cursor and
Set.paginate()
to iterate
through the remaining pages:
// Uses `Set.paginate()` to iterate through pages.
let page = Set.paginate("hdWDxoq...")
let data = page.data
data.forEach(doc => doc.delete()
page {
after
}
Is this article helpful?
Tell Fauna how the article can be improved:
Visit Fauna's forums
or email docs@fauna.com
Thank you for your feedback!