database_roles

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

Overview

Name	database_roles
Type	Resource
Id	snowflake.database_role.database_roles

Fields

Name	Datatype	Description
name	string	Name of the database role
comment	string	User comment associated to an object in the dictionary
created_on	string	Date and time when the database role was created
granted_database_roles	integer	How many database roles this database role has been granted
granted_to_database_roles	integer	How many database roles this database role has been granted to
granted_to_roles	integer	How many roles this database role has been granted to
owner	string	Role that owns the database role
owner_role_type	string	The type of role that owns the database role

Methods

Name	Accessible by	Required Params	Optional Params	Description
list_database_roles	SELECT	database_name, endpoint	showLimit, fromName	List database roles
create_database_role	INSERT	database_name, data__name, endpoint	createMode	Create a database role
delete_database_role	DELETE	database_name, name, endpoint	ifExists	Delete a database role
clone_database_role	EXEC	database_name, name, data__name, endpoint	createMode, targetDatabase	Create a new database role by cloning from the specified resource

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
showLimit	Query parameter to limit the maximum number of rows returned by a command.	integer	-
targetDatabase	Database of the target resource. Defaults to the source's database	string	-

SELECT examples

List database roles

SELECT
name,
comment,
created_on,
granted_database_roles,
granted_to_database_roles,
granted_to_roles,
owner,
owner_role_type
FROM snowflake.database_role.database_roles
WHERE database_name = '{{ database_name }}'
AND endpoint = '{{ endpoint }}';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO snowflake.database_role.database_roles (
data__name,
database_name,
endpoint
)
SELECT 
'{{ name }}',
'{{ database_name }}',
'{{ endpoint }}'
;

Manifest

- name: database_roles
  props:
    - name: database_name
      value: string
    - name: data__name
      value: string
    - name: endpoint
      value: string
    - name: name
      value: string
    - name: comment
      value: string

DELETE example

Deletes the specified database_roles resource.

/*+ delete */
DELETE FROM snowflake.database_role.database_roles
WHERE database_name = '{{ database_name }}'
AND name = '{{ name }}'
AND endpoint = '{{ endpoint }}';