roles

Creates, updates, deletes, gets or lists a roles resource.

Overview

Name	roles
Type	Resource
Id	snowflake.role.roles

Fields

Name	Datatype	Description
name	string	Name of the role.
assigned_to_users	integer	The number of users to whom this role has been assigned.
comment	string	Comment of the role.
created_on	string	Date and time when the role was created.
granted_roles	integer	The number of roles that have been granted to this role.
granted_to_roles	integer	The number of roles to which this role has been granted.
is_current	boolean	Specifies whether the role being fetched is the user's current role.
is_default	boolean	Specifies whether the role being fetched is the user's default role.
is_inherited	boolean	Specifies whether the role used to run the command inherits the specified role.
owner	string	Specifies the role that owns this role.

Methods

Name	Accessible by	Required Params	Optional Params	Description
list_roles	SELECT	endpoint	like, startsWith, showLimit, fromName	List roles
create_role	INSERT	data__name, endpoint	createMode	Create a role
delete_role	DELETE	name, endpoint	ifExists	Delete a role

Optional Parameter Details

Name	Description	Type	Default
createMode	Query parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.	string	errorIfExists
fromName	Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.	string	-
ifExists	Query parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn't exist.	boolean	false
like	Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.	string	-
showLimit	Query parameter to limit the maximum number of rows returned by a command.	integer	-
startsWith	Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.	string	-

SELECT examples

List roles

SELECT
name,
assigned_to_users,
comment,
created_on,
granted_roles,
granted_to_roles,
is_current,
is_default,
is_inherited,
owner
FROM snowflake.role.roles
WHERE endpoint = '{{ endpoint }}';

INSERT example

Use the following StackQL query and manifest file to create a new roles resource.

Required Properties

/*+ create */
INSERT INTO snowflake.role.roles (
data__name,
data__comment,
endpoint
)
SELECT 
'{{ name }}',
'{{ comment }}',
'{{ endpoint }}'
;

All Properties

/*+ create */
INSERT INTO snowflake.role.roles (
data__name,
endpoint
)
SELECT 
'{{ name }}',
'{{ endpoint }}'
;

Manifest

- name: roles
  props:
    - name: data__name
      value: string
    - name: endpoint
      value: string
    - name: name
      value: string
    - name: comment
      value: string

DELETE example

Deletes the specified roles resource.

/*+ delete */
DELETE FROM snowflake.role.roles
WHERE name = '{{ name }}'
AND endpoint = '{{ endpoint }}';