Remove
Remove(Ref, TS, Action)
Description
The Remove
function deletes an event from a document’s history. The
reference must refer to a document within a user-defined collection.
Outstanding references result in an "invalid argument" error.
Parameters
Argument | Type | Definition and Requirements | ||
---|---|---|---|---|
|
A reference type containing the document that should be removed. |
|||
|
The timestamp when the document’s history should be removed. Can be expressed as either a number of UNIX microseconds since epoch, or as a Timestamp.
|
|||
|
Document Action |
The type of action (create, delete, update) to be removed. |
Examples
The following query changes the history for a document in the "spells" collection. The create event at timestamp 1 is removed.
client.query(
q.Remove(
q.Ref(q.Collection('spells'), '181388642581742080'),
1,
'create'
)
)
.then((ret) => console.log(ret))
null
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!