collectionDef.update()
We recommend you use FSL to create and update user-defined functions (UDFs). See FSL function schema. |
Updates a collection definition.
Description
The update()
method updates a collection definition, represented as a
Collection
document.
Collection
documents have the CollectionDef type and are an FQL version
of the FSL collection schema.
Staged schema
If a database has staged schema, this method interacts with the database’s staged schema, not the active schema.
If the database has no staged schema, using this method is equivalent to making an unstaged schema change. Changes are applied immediately to the database’s active schema.
Unstaged schema changes that trigger an index build may result in downtime where the index is not queryable.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
data |
Object containing valid
|
Yes |
The replacement collection definition, represented as a
During the update, fields from the object are copied to the document, creating new fields or updating existing fields. The operation is similar to a merge. Only the fields included in the Object are updated, all other document fields aren’t updated. Fields with nested Objects in the Object are merged with the identically named nested Object in the document. |
Return value
Type | Description |
---|---|
Definition for the updated collection, represented as a
|
Examples
Collection.byName("Customer")!.update({
ttl_days: 15
})
{
name: "Customer",
coll: Collection,
ts: Time("2099-10-03T20:45:53.780Z"),
history_days: 0,
fields: {
name: {
signature: "String"
},
email: {
signature: "String"
},
address: {
signature: "{ street: String, city: String, state: String, postalCode: String, country: String }"
}
},
wildcard: "Any",
computed_fields: {
cart: {
body: "(customer) => Order.byCustomerAndStatus(customer, \"cart\").first()",
signature: "Order?"
},
orders: {
body: "(customer) => Order.byCustomer(customer)",
signature: "Set<Order>"
}
},
indexes: {
byEmail: {
terms: [
{
field: ".email",
mva: false
}
],
values: [
{
field: ".email",
order: "desc",
mva: false
},
{
field: ".name",
order: "asc",
mva: false
}
],
queryable: true,
status: "complete"
},
},
ttl_days: 15,
constraints: [
{
unique: [
{
field: ".email",
mva: false
}
],
status: "active"
}
],
document_ttls: true,
migrations: [
{
add_wildcard: {}
}
]
}
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!