databases

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

Overview

Name	databases
Type	Resource
Id	snowflake.database.databases

Fields

Name	Datatype	Description
name	string	A Snowflake object identifier. 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.
budget	string	Budget that defines a monthly spending limit on the compute costs for a Snowflake account or a custom group of Snowflake objects.
comment	string	Optional comment in which to store information related to the database.
created_on	string	Date and time the database was created.
data_retention_time_in_days	integer	Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database.
default_ddl_collation	string	Default collation specification for all schemas and tables added to the database. You an override the default at the schema and individual table levels.
dropped_on	string	Date and time the database was dropped.
is_current	boolean	Current database for the session.
is_default	boolean	Whether the database is the default database for a user.
kind	string	Database type, permanent (default) or transient.
log_level	string	Severity level of messages that should be ingested and made available in the active event table. Currently, Snowflake supports only TRACE, DEBUG, INFO, WARN, ERROR, FATAL and OFF.
max_data_extension_time_in_days	integer	Maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale.
options	string
origin	string
owner	string	Name of the role that owns the database.
owner_role_type	string	Type of role that owns the object, either ROLE or DATABASE_ROLE
retention_time	integer	Number of days that historical data is retained for Time Travel.
serverless_task_max_statement_size	string	Specifies the maximum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE.
serverless_task_min_statement_size	string	Specifies the minimum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE.
suspend_task_after_num_failures	integer	Maximum number of consecutive failed task runs before the current task is suspended automatically.
trace_level	string	How trace events are ingested into the event table. Currently, Snowflake supports only ALWAYS, ON_EVENT, and OFF.
user_task_managed_initial_warehouse_size	string	Size of the compute resources to provision for the first run of the serverless task, before a task history is available for Snowflake to determine an ideal size.
user_task_timeout_ms	integer	Time limit, in milliseconds, for a single run of the task before it times out.

Methods

Name	Accessible by	Required Params	Description
fetch_database	SELECT	name, endpoint	Fetches a database.
list_databases	SELECT	endpoint	Lists the accessible databases.
create_database	INSERT	data__name, endpoint	Creates a database, with modifiers as query parameters. You must provide the full database definition when creating a database.
delete_database	DELETE	name, endpoint	Deletes the specified database. If you enable the ifExists parameter, the operation succeeds even if the database does not exist. Otherwise, a 404 failure is returned if the database does not exist. if the drop is unsuccessful.
create_or_alter_database	REPLACE	name, data__name, endpoint	Creates a new, or alters an existing, database. You must provide the full database definition even when altering an existing database.
clone_database	EXEC	name, endpoint	Clones an existing database, with modifiers as query parameters. You must provide the full database definition when cloning an existing database.
create_database_from_share	EXEC	endpoint	Creates a database from a given share.
create_database_from_share_deprecated	EXEC	name, endpoint	Creates a database from a given share.
disable_database_failover	EXEC	name, data__accounts, endpoint	Disables failover for this primary database, meaning no replica of this database (i.e. secondary database) can be promoted to serve as the primary database.
disable_database_replication	EXEC	name, data__accounts, endpoint	Disables replication for this primary database, meaning no replica of this database (i.e. secondary database) in another account can be refreshed. Any secondary databases remain linked to the primary database, but requests to refresh a secondary database are denied.
enable_database_failover	EXEC	name, data__accounts, endpoint	Specifies a comma-separated list of accounts in your organization where a replica of this primary database can be promoted to serve as the primary database.
enable_database_replication	EXEC	name, data__accounts, endpoint	Promotes a local database to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database.
primary_database_failover	EXEC	name, endpoint	Promotes the specified secondary (replica) database to serve as the primary database. When promoted, the database becomes writeable. At the same time, the previous primary database becomes a read-only secondary database.
refresh_database_replication	EXEC	name, endpoint	Refreshes a secondary database from a snapshot of its primary database. A snapshot includes changes to the objects and data. If you call this endpoint while another refresh for the same replica database is running, it fails and returns an error. Snowflake ensures only one refresh is executed at any given time.
undrop_database	EXEC	name, endpoint	Undrops database.

SELECT examples

Lists the accessible databases.

SELECT
name,
budget,
comment,
created_on,
data_retention_time_in_days,
default_ddl_collation,
dropped_on,
is_current,
is_default,
kind,
log_level,
max_data_extension_time_in_days,
options,
origin,
owner,
owner_role_type,
retention_time,
serverless_task_max_statement_size,
serverless_task_min_statement_size,
suspend_task_after_num_failures,
trace_level,
user_task_managed_initial_warehouse_size,
user_task_timeout_ms
FROM snowflake.database.databases
WHERE endpoint = '{{ endpoint }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO snowflake.database.databases (
data__name,
data__kind,
data__comment,
data__data_retention_time_in_days,
data__default_ddl_collation,
data__log_level,
data__max_data_extension_time_in_days,
data__suspend_task_after_num_failures,
data__trace_level,
data__user_task_managed_initial_warehouse_size,
data__serverless_task_min_statement_size,
data__serverless_task_max_statement_size,
data__user_task_timeout_ms,
endpoint
)
SELECT 
'{{ name }}',
'{{ kind }}',
'{{ comment }}',
'{{ data_retention_time_in_days }}',
'{{ default_ddl_collation }}',
'{{ log_level }}',
'{{ max_data_extension_time_in_days }}',
'{{ suspend_task_after_num_failures }}',
'{{ trace_level }}',
'{{ user_task_managed_initial_warehouse_size }}',
'{{ serverless_task_min_statement_size }}',
'{{ serverless_task_max_statement_size }}',
'{{ user_task_timeout_ms }}',
'{{ endpoint }}'
;

All Properties

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

Manifest

- name: databases
  props:
    - name: data__name
      value: string
    - name: endpoint
      value: string
    - name: name
      value: string
    - name: kind
      value: string
    - name: comment
      value: string
    - name: data_retention_time_in_days
      value: integer
    - name: default_ddl_collation
      value: string
    - name: log_level
      value: string
    - name: max_data_extension_time_in_days
      value: integer
    - name: suspend_task_after_num_failures
      value: integer
    - name: trace_level
      value: string
    - name: user_task_managed_initial_warehouse_size
      value: string
    - name: serverless_task_min_statement_size
      value: string
    - name: serverless_task_max_statement_size
      value: string
    - name: user_task_timeout_ms
      value: integer

REPLACE example

Replaces all fields in the specified databases resource.

/*+ update */
REPLACE snowflake.database.databases
SET 
name = '{{ name }}',
kind = '{{ kind }}',
comment = '{{ comment }}',
data_retention_time_in_days = '{{ data_retention_time_in_days }}',
default_ddl_collation = '{{ default_ddl_collation }}',
log_level = '{{ log_level }}',
max_data_extension_time_in_days = '{{ max_data_extension_time_in_days }}',
suspend_task_after_num_failures = '{{ suspend_task_after_num_failures }}',
trace_level = '{{ trace_level }}',
user_task_managed_initial_warehouse_size = '{{ user_task_managed_initial_warehouse_size }}',
serverless_task_min_statement_size = '{{ serverless_task_min_statement_size }}',
serverless_task_max_statement_size = '{{ serverless_task_max_statement_size }}',
user_task_timeout_ms = '{{ user_task_timeout_ms }}'
WHERE 
name = '{{ name }}'
AND data__name = '{{ data__name }}'
AND endpoint = '{{ endpoint }}';

DELETE example

Deletes the specified databases resource.

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