ALTER ROLE¶

Modifies the properties for an existing custom role. Currently, the only supported operations are renaming a role or adding/overwriting/removing a comment for a role.

See also:

CREATE ROLE , DROP ROLE , SHOW ROLES

Syntax¶

ALTER ROLE [ IF EXISTS ] <name> RENAME TO <new_name>

ALTER ROLE [ IF EXISTS ] <name> SET COMMENT = '<string_literal>'

ALTER ROLE [ IF EXISTS ] <name> UNSET COMMENT

ALTER ROLE [ IF EXISTS ] <name> SET TAG <tag_name> = '<tag_value>' [ , <tag_name> = '<tag_value>' ... ]

ALTER ROLE [ IF EXISTS ] <name> UNSET TAG <tag_name> [ , <tag_name> ... ]
Copy

Parameters¶

name

Specifies the identifier for the role to alter. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

RENAME TO new_name

Specifies the new identifier for the role; must be unique for your account.

For more details, see Identifier requirements.

SET ...

Specifies the properties to set for the role:

TAG tag_name = 'tag_value' [ , tag_name = 'tag_value' , ... ]

Specifies the tag name and the tag string value.

The tag value is always a string, and the maximum number of characters for the tag value is 256.

For information about specifying tags in a statement, see Tag quotas for objects and columns.

COMMENT = 'string_literal'

Adds a comment or overwrites an existing comment for the role.

UNSET ...

Specifies the properties to unset for the role, which resets them to the defaults.

  • TAG tag_name [ , tag_name ... ]

  • COMMENT

Usage notes¶

  • Only the role owner (i.e. the role with the OWNERSHIP privilege on the role), or a higher role, can execute this command.

  • To rename a role (using the RENAME TO new_name parameter) the role that executes this command must also have the global CREATE ROLE privilege.

  • Regarding metadata:

    Attention

    Customers should ensure that no personal data (other than for a User object), sensitive data, export-controlled data, or other regulated data is entered as metadata when using the Snowflake service. For more information, see Metadata fields in Snowflake.

Examples¶

Rename role role1 to role2:

ALTER ROLE role1 RENAME TO role2;
Copy

Add a comment for role myrole:

ALTER ROLE myrole SET COMMENT = 'New comment for role';
Copy
Language: English