Insert
Insert( ref, ts, action, param_object )
Description
The Insert
function adds an event to a document’s history at a
specified timestamp.
We do not recommend using the update action. Currently, it
operates like a create action. For example, if you create a
document, and then use Insert to create an update , the
document then looks identical to the update; any fields not
specified are removed.
|
Parameters
Argument | Type | Definition and Requirements | ||
---|---|---|---|---|
|
A reference must refer to a user-defined collection or a key to be modified. A reference to any other collection results in an "invalid argument" error. |
|||
|
The timestamp within the document’s history that should be modified. Can be expressed as either a number of UNIX microseconds or as a Timestamp.
|
|||
|
The type of action ( |
|||
|
The |
Returns
An object containing the metadata about the insert operation.
Field Name | Field Type | Definition and Requirements |
---|---|---|
|
The timestamp when the document’s history was modified. |
|
|
The action for the event. |
|
|
The reference to document where the event was inserted. |
|
|
A copy of the document data that was created, updated, or deleted. |
Examples
The following query modifies the history of the "spells" collection for
the document at id 181388642581742080
, adding a document create
operation at timestamp 1 with the associated user data:
client.query(
q.Insert(
q.Ref(q.Collection('spells'), '181388642581742080'),
1,
'create',
{
data: {
name: 'Mountain\'s Thunder',
cost: 10,
element: ['air', 'earth'],
},
},
)
)
.then((ret) => console.log(ret))
{ ts: 1,
action: 'create',
document:
Ref(id=181388642581742080, collection=Ref(id=spells, collection=Ref(id=collections))),
data:
{ name: 'Mountain\'s Thunder',
cost: 10,
element: [ 'air', 'earth' ] } }
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!