Create
Create( collection, param_object )
Create( collection, param_object )
Create( collection, param_object )
Create( collection, param_object )
create( collection, param_object )
Create( collection, param_object )
Description
The Create
function adds a new document to a collection. The
collection_ref
parameter indicates in what collection the document
should be created, while param_object
contains the document data and
optional metadata.
Parameters
Parameter | Type | Definition and Requirements |
---|---|---|
|
The name, or Reference, of the collection that should contain the new
document. A collection Reference can be acquired using the
|
|
|
The |
param_object
Field Name | Field Type | Definition and Requirements | ||
---|---|---|---|---|
|
The user’s single, changeable document. |
|||
|
Optional - The permissions for this document. |
|||
|
||||
|
Optional - A timestamp indicating the document’s time-to-live, which is when the document should be removed. When a document is removed, the document’s existence ceases (as if it never existed); temporal queries cannot recover the document.
|
Returns
A document containing both the data and metadata about the results of the operations.
Field Name | Field Type | Definition and Requirements |
---|---|---|
|
A reference to the document that was created. |
|
|
The data that was inserted with the document. |
|
|
The timestamp, with microsecond resolution, associated with the creation of the document. |
Examples
The following query creates a document by providing a reference to the
collection "spells" and a param_object
with a data
field. The data
field contains the user data to be inserted for this document.
ObjectV(ref: RefV(id = "280491264236847616", collection = RefV(id = "spells", collection = RefV(id = "collections"))),ts: LongV(1603756164680000),data: ObjectV(name: StringV(Mountainous Thunder),element: StringV(air),cost: LongV(15)))
map[data:map[cost:15 element:air name:Mountainous Thunder] ref:{280481791726322176 0xc00009a1b0 0xc00009a1b0 <nil>} ts:1603747130990000]
{ref: ref(id = "269699776491028992", collection = ref(id = "spells", collection = ref(id = "collections"))), ts: 1593464599990000, data: {name: "Mountainous Thunder", element: "air", cost: 15}}
{
ref: Ref(Collection("spells"), "268159557092508160"),
ts: 1591995732300000,
data: { name: 'Mountainous Thunder', element: 'air', cost: 15 }
}
{'ref': Ref(id=269062149575279104, collection=Ref(id=spells, collection=Ref(id=collections))), 'ts': 1592856511570000, 'data': {'name': 'Mountainous Thunder', 'element': 'air', 'cost': 15}}
{
ref: Ref(Collection("spells"), "302043888864985600"),
ts: 1624310349250000,
data: { name: 'Mountainous Thunder', element: 'air', cost: 15 }
}
The following query creates a document in the posts
collection with a
specified document ID (via the Ref
function):
ObjectV(ref: RefV(id = "1", collection = RefV(id = "Posts", collection = RefV(id = "collections"))),ts: LongV(1622574261840000),data: ObjectV(title: StringV(The first post)))
map[data:map[title:The first post] ref:{1 0xc00009dbc0 0xc00009dbc0 <nil>} ts:1622574332010000]
{ref: ref(id = "1", collection = ref(id = "Posts", collection = ref(id = "collections"))), ts: 1622574416990000, data: {title: "The first post"}}
{
ref: Ref(Collection("Posts"), "1"),
ts: 1622574501060000,
data: { title: 'The first post' }
}
{'ref': Ref(id=1, collection=Ref(id=Posts, collection=Ref(id=collections))), 'ts': 1622574508850000, 'data': {'title': 'The first post'}}
{
ref: Ref(Collection("Posts"), "1"),
ts: 1624310598180000,
data: { title: 'The first post' }
}
Was this article helpful?
We're sorry to hear that.
Tell us how we can improve!
Visit Fauna's forums
or email docs@fauna.com
Thank you for your feedback!