ALTER ROLE

ALTER ROLE changes a role's description in the current service group. It does not change the privileges in the role.

Prerequisites

First connect to the Graph service. Run the command in a GQL client.

To alter a role, you must own the role or have ADMIN in the current service group.

Syntax

Syntax diagramBNF

alter_role_command

alter_role_command ::=
    'ALTER' 'ROLE' role_name 'SET' 'COMMENT' '=' '"' comment '"'

Parameters

role_name

The name of the role to be altered.

comment

The new description of the role. The description must be a string literal.

Examples

The example uses an existing role named role1.

ALTER ROLE role1 SET COMMENT = "This is new description for role1"

Use SHOW ALL ROLES to check that role1 has the new comment.