CreateClass
CreateClass( param_object )
CreateClass( param_object )
CreateClass( param_object )
CreateClass( param_object )
create_class( param_object )
CreateClass( param_object )
Description
This function is deprecated as of Fauna 2.7.0. Use CreateCollection instead. A Class was renamed to a Collection in Fauna 2.7.0. This function continues to exist for compatibility with older drivers. |
The CreateClass
function is used to create a class (now, collection)
which groups instance objects (now, documents). Once the class has been
created, it is possible to create instances in the class. You cannot
create a class and insert instances into that class in the same
transaction.
Parameters
Argument | Type | Definition and Requirements |
---|---|---|
|
The param_object fields are described below. |
param_object
Field Name | Field Type | Definition and Requirements | ||
---|---|---|---|---|
|
The name of a class. Classes (now, collections) cannot be named any of
the following reserved words: |
|||
|
Optional - This is user-defined metadata for the class (now, collection). It is provided for the developer to store information at the class (now, collection) level. |
|||
|
Optional - The number of days that document history is retained for in this class (now, collection). The default is 30 days. Setting |
|||
|
Optional - The number of days documents are retained for this class.
Instances which have not been updated within the configured TTL
duration are removed. Setting
|
|||
|
Optional - Provides the ability to enable permissions at the class level. See class permissions for additional details. |
Returns
An object containing the fields returned by the CreateClass
function
is described below.
Field Name | Field Type | Definition and Requirements |
---|---|---|
|
Reference |
The reference is an automatically generated identifier within the database to uniquely identify the class that was created. |
|
The name of the class (now, collection) that was created. |
|
|
The timestamp, with microsecond resolution, associated with the creation of the class (now, collection). |
|
|
The number of days to retain history. |
Examples
The following query creates a class called "boons" with defaults:
client.Query(
CreateCollection(Obj("name", "boons"))
);
ObjectV(ref: RefV(id = "boons", collection = RefV(id = "collections")),ts: LongV(1603756168550000),history_days: LongV(30),name: StringV(boons))
result, err := client.Query(
f.CreateCollection(f.Obj{"name": "boons"}))
if err != nil {
fmt.Fprintln(os.Stderr, err)
} else {
fmt.Println(result)
}
map[history_days:30 name:boons ref:{boons 0xc0001780c0 0xc0001780c0 <nil>} ts:1603747131750000]
System.out.println(
client.query(
CreateCollection(Obj("name", Value("boons")))
).get());
{ref: ref(id = "boons", collection = ref(id = "collections")), ts: 1593220411910000, history_days: 30, name: "boons"}
client.query(
q.CreateCollection({ name: 'boons' })
)
.then((ret) => console.log(ret))
.catch((err) => console.error('Error: %s', err))
{
ref: Collection("boons"),
ts: 1592053895890000,
history_days: 30,
name: 'boons'
}
result = client.query(
q.create_collection({"name": "boons"})
)
print(result)
{'ref': Ref(id=boons, collection=Ref(id=collections)), 'ts': 1592845981190000, 'history_days': 30, 'name': 'boons'}
client.query(CreateCollection(Obj("name" -> "boons")))
{ref: ref(id = "boons", collection = ref(id = "collections")), ts: 1594484955870000, history_days: 30, name: "boons"}
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!