role.update()
Learn: Roles |
---|
We recommend you use FSL to create and update user-defined roles. See FSL role schema. |
Update a Role
.
Description
This method updates a role with the object fields and returns the updated document. During the update, fields from 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 object are updated, all other document fields aren’t updated. Fields with nested objects in object are merged with the identically named nested object in the document.
Use the update()
method to rename a role or update its user-defined metadata.
To remove a field, set its value in object to null
.
Considerations
If a database has staged schema, this method interacts with the database’s staged schema, not the active schema.
You can’t rename a role while a database has staged 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.
Avoid concurrent schema changes
Concurrent unstaged schema changes can cause contended transactions, even if the changes affect different resources. This includes unstaged changes made using:
-
FQL methods, such as
Collection.create()
orrole.update()
, that write to a schema’s underlying document. -
The Fauna CLI
-
The Fauna Dashboard.
A schema change triggers a transaction that validates the entire database schema. To avoid errors, do one of the following instead:
-
Perform unstaged schema changes sequentially
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
object |
Yes |
Role document with the updated document fields. |
Examples
Role.byName("manager")?.update({
membership: [
{
resource: "Manager"
}
],
privileges: [
{
resource: "Order",
actions: {
create: false,
delete: false,
read: true,
write: false
}
}, {
resource: "Product",
actions: {
create: true
}
}
],
data: {
custom: "some data"
}
})
{
name: "manager",
coll: Role,
ts: Time("2099-07-27T22:40:32.735Z"),
privileges: [
{
resource: "Order",
actions: {
create: false,
delete: false,
read: true,
write: false
}
},
{
resource: "Product",
actions: {
create: true
}
}
],
membership: [
{
resource: "Manager"
}
],
data: {
custom: "some data"
}
}
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!