dynamic_tables

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

Overview

Name	dynamic_tables
Type	Resource
Id	snowflake.dynamic_table.dynamic_tables

Fields

The following fields are returned by SELECT queries:

list_dynamic_tables

A Snowflake dynamic table object.

Name	Datatype	Description
name	string	Specifies the name for the dynamic table, must be unique for the schema in which the dynamic table is created
database_name	string	Database in which the dynamic table is stored
schema_name	string	Schema in which the dynamic table is stored
automatic_clustering	boolean	If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the dynamic table.
budget	string	Name of the budget if the object is monitored by a budget
bytes	integer (int64)	Number of bytes that will be scanned if the entire table is scanned in a query. Note that this number may be different than the number of actual physical bytes stored on-disk for the table
cluster_by	array	Specifies one or more columns or column expressions in the dynamic table as the clustering key
columns	array
comment	string	Specifies a comment for the dynamic table.
created_on	string (date-time)	Date and time when the dynamic table was created.
data_retention_time_in_days	integer	Specifies the retention period for the dynamic table so that Time Travel actions (SELECT, CLONE) can be performed on historical data in the dynamic table
initialize	string	Specifies the behavior of the initial refresh of the dynamic table
kind	string	Specifies the dynamic table type, permanent (default) or transient. (default: PERMANENT)
max_data_extension_time_in_days	integer	Specifies the retention period for the dynamic table so that Time Travel actions (SELECT, CLONE) can be performed on historical data in the dynamic table
owner	string	Role that owns the table
owner_role_type	string	The type of role that owns the object.
query	string	Specifies the query whose results the dynamic table should contain (example: SELECT * FROM foo)
refresh_mode	string	Specifies the refresh type for the dynamic table
rows	integer (int64)	Number of rows in the dynamic table.
scheduling_state	string	Scheduling state (RUNNING or SUSPENDED)
target_lag	object	Specifies the schedule for periodically refreshing the dynamic table.
warehouse	string	Specifies the name of the warehouse that provides the compute resources for refreshing the dynamic table (example: test_wh)

fetch_dynamic_table

A Snowflake dynamic table object.

Name	Datatype	Description
name	string	Specifies the name for the dynamic table, must be unique for the schema in which the dynamic table is created
database_name	string	Database in which the dynamic table is stored
schema_name	string	Schema in which the dynamic table is stored
automatic_clustering	boolean	If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the dynamic table.
budget	string	Name of the budget if the object is monitored by a budget
bytes	integer (int64)	Number of bytes that will be scanned if the entire table is scanned in a query. Note that this number may be different than the number of actual physical bytes stored on-disk for the table
cluster_by	array	Specifies one or more columns or column expressions in the dynamic table as the clustering key
columns	array
comment	string	Specifies a comment for the dynamic table.
created_on	string (date-time)	Date and time when the dynamic table was created.
data_retention_time_in_days	integer	Specifies the retention period for the dynamic table so that Time Travel actions (SELECT, CLONE) can be performed on historical data in the dynamic table
initialize	string	Specifies the behavior of the initial refresh of the dynamic table
kind	string	Specifies the dynamic table type, permanent (default) or transient. (default: PERMANENT)
max_data_extension_time_in_days	integer	Specifies the retention period for the dynamic table so that Time Travel actions (SELECT, CLONE) can be performed on historical data in the dynamic table
owner	string	Role that owns the table
owner_role_type	string	The type of role that owns the object.
query	string	Specifies the query whose results the dynamic table should contain (example: SELECT * FROM foo)
refresh_mode	string	Specifies the refresh type for the dynamic table
rows	integer (int64)	Number of rows in the dynamic table.
scheduling_state	string	Scheduling state (RUNNING or SUSPENDED)
target_lag	object	Specifies the schedule for periodically refreshing the dynamic table.
warehouse	string	Specifies the name of the warehouse that provides the compute resources for refreshing the dynamic table (example: test_wh)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_dynamic_tables	select	database_name, schema_name, endpoint	like, startsWith, showLimit, fromName, deep	Lists the dynamic tables under the database and schema.
fetch_dynamic_table	select	database_name, schema_name, name, endpoint		Fetch a Dynamic Table.
create_dynamic_table	insert	database_name, schema_name, endpoint	createMode	Create a dynamic table, with standard create modifiers as query parameters. See the Dynamic Table component definition for what is required to be provided in the request body.
delete_dynamic_table	delete	database_name, schema_name, name, endpoint	ifExists	Delete a dynamic table with the given name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful.
clone_dynamic_table	exec	database_name, schema_name, name, endpoint	createMode, copyGrants, targetDatabase, targetSchema	Create a new dynamic table by cloning from the specified resource
undrop_dynamic_table	exec	database_name, schema_name, name, endpoint		Undrop specified dynamic table
suspend_dynamic_table	exec	database_name, schema_name, name, endpoint	ifExists	Suspend refreshes on the dynamic table
resume_dynamic_table	exec	database_name, schema_name, name, endpoint	ifExists	Resume refreshes on the dynamic table
refresh_dynamic_table	exec	database_name, schema_name, name, endpoint	ifExists	Specifies that the dynamic table should be manually refreshed
suspend_recluster_dynamic_table	exec	database_name, schema_name, name, endpoint	ifExists	Suspend recluster of a dynamic table
resume_recluster_dynamic_table	exec	database_name, schema_name, name, endpoint	ifExists	Resume recluster of a dynamic table
swap_with_dynamic_table	exec	database_name, schema_name, name, targetName, endpoint	ifExists, targetDatabase, targetSchema	Swap with another dynamic table

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
database_name	string	Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases.
endpoint	string	Organization and Account Name (default: orgid-acctid)
name	string	Identifier (i.e. name) for the resource.
schema_name	string	Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database.
targetName	string	The name of the target dynamic table to be swapped with.
copyGrants	boolean	Query parameter to enable copy grants when creating the object.
createMode	string	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.
deep	boolean	Optionally includes dependency information of the dynamic table.
fromName	string	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.
ifExists	boolean	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.
like	string	Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
showLimit	integer	Query parameter to limit the maximum number of rows returned by a command.
startsWith	string	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.
targetDatabase	string	Database of the target dynamic table. Defaults to the source table's database.
targetSchema	string	Schema of the target dynamic table. Defaults to the source table's schema.

SELECT examples

list_dynamic_tables

Lists the dynamic tables under the database and schema.

SELECT
name,
database_name,
schema_name,
automatic_clustering,
budget,
bytes,
cluster_by,
columns,
comment,
created_on,
data_retention_time_in_days,
initialize,
kind,
max_data_extension_time_in_days,
owner,
owner_role_type,
query,
refresh_mode,
rows,
scheduling_state,
target_lag,
warehouse
FROM snowflake.dynamic_table.dynamic_tables
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND like = '{{ like }}'
AND startsWith = '{{ startsWith }}'
AND showLimit = '{{ showLimit }}'
AND fromName = '{{ fromName }}'
AND deep = '{{ deep }}';

fetch_dynamic_table

Fetch a Dynamic Table.

SELECT
name,
database_name,
schema_name,
automatic_clustering,
budget,
bytes,
cluster_by,
columns,
comment,
created_on,
data_retention_time_in_days,
initialize,
kind,
max_data_extension_time_in_days,
owner,
owner_role_type,
query,
refresh_mode,
rows,
scheduling_state,
target_lag,
warehouse
FROM snowflake.dynamic_table.dynamic_tables
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required;

INSERT examples

create_dynamic_table

Create a dynamic table, with standard create modifiers as query parameters. See the Dynamic Table component definition for what is required to be provided in the request body.

INSERT INTO snowflake.dynamic_table.dynamic_tables (
data__name,
data__kind,
data__columns,
data__target_lag,
data__refresh_mode,
data__initialize,
data__warehouse,
data__cluster_by,
data__query,
data__data_retention_time_in_days,
data__max_data_extension_time_in_days,
data__comment,
database_name,
schema_name,
endpoint,
createMode
)
SELECT 
'{{ name }}' --required,
'{{ kind }}',
'{{ columns }}',
'{{ target_lag }}' --required,
'{{ refresh_mode }}',
'{{ initialize }}',
'{{ warehouse }}' --required,
'{{ cluster_by }}',
'{{ query }}' --required,
{{ data_retention_time_in_days }},
{{ max_data_extension_time_in_days }},
'{{ comment }}',
'{{ database_name }}',
'{{ schema_name }}',
'{{ endpoint }}',
'{{ createMode }}'
;

Manifest

# Description fields are for documentation purposes
- name: dynamic_tables
  props:
    - name: database_name
      value: string
      description: Required parameter for the dynamic_tables resource.
    - name: schema_name
      value: string
      description: Required parameter for the dynamic_tables resource.
    - name: endpoint
      value: string
      description: Required parameter for the dynamic_tables resource.
    - name: name
      value: string
      description: >
        Specifies the name for the dynamic table, must be unique for the schema in which the dynamic table is created
        
    - name: kind
      value: string
      description: >
        Specifies the dynamic table type, permanent (default) or transient.
        
      valid_values: ['PERMANENT', 'TRANSIENT']
      default: PERMANENT
    - name: columns
      value: array
    - name: target_lag
      value: object
      description: >
        Specifies the schedule for periodically refreshing the dynamic table.
        
    - name: refresh_mode
      value: string
      description: >
        Specifies the refresh type for the dynamic table
        
      valid_values: ['AUTO', 'FULL', 'INCREMENTAL']
    - name: initialize
      value: string
      description: >
        Specifies the behavior of the initial refresh of the dynamic table
        
      valid_values: ['ON_CREATE', 'ON_SCHEDULE']
    - name: warehouse
      value: string
      description: >
        Specifies the name of the warehouse that provides the compute resources for refreshing the dynamic table
        
    - name: cluster_by
      value: array
      description: >
        Specifies one or more columns or column expressions in the dynamic table as the clustering key
        
    - name: query
      value: string
      description: >
        Specifies the query whose results the dynamic table should contain
        
    - name: data_retention_time_in_days
      value: integer
      description: >
        Specifies the retention period for the dynamic table so that Time Travel actions (SELECT, CLONE) can be performed on historical data in the dynamic table
        
    - name: max_data_extension_time_in_days
      value: integer
      description: >
        Specifies the retention period for the dynamic table so that Time Travel actions (SELECT, CLONE) can be performed on historical data in the dynamic table
        
    - name: comment
      value: string
      description: >
        Specifies a comment for the dynamic table.
        
    - name: createMode
      value: string
      description: 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.

DELETE examples

delete_dynamic_table

Delete a dynamic table with the given name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful.

DELETE FROM snowflake.dynamic_table.dynamic_tables
WHERE database_name = '{{ database_name }}' --required
AND schema_name = '{{ schema_name }}' --required
AND name = '{{ name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND ifExists = '{{ ifExists }}';

Lifecycle Methods

clone_dynamic_table

Create a new dynamic table by cloning from the specified resource

EXEC snowflake.dynamic_table.dynamic_tables.clone_dynamic_table 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@createMode='{{ createMode }}', 
@copyGrants={{ copyGrants }}, 
@targetDatabase='{{ targetDatabase }}', 
@targetSchema='{{ targetSchema }}' 
@@json=
'{
"name": "{{ name }}", 
"target_lag": "{{ target_lag }}", 
"warehouse": "{{ warehouse }}", 
"point_of_time": "{{ point_of_time }}"
}';

undrop_dynamic_table

Undrop specified dynamic table

EXEC snowflake.dynamic_table.dynamic_tables.undrop_dynamic_table 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required;

suspend_dynamic_table

Suspend refreshes on the dynamic table

EXEC snowflake.dynamic_table.dynamic_tables.suspend_dynamic_table 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@ifExists={{ ifExists }};

resume_dynamic_table

Resume refreshes on the dynamic table

EXEC snowflake.dynamic_table.dynamic_tables.resume_dynamic_table 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@ifExists={{ ifExists }};

refresh_dynamic_table

Specifies that the dynamic table should be manually refreshed

EXEC snowflake.dynamic_table.dynamic_tables.refresh_dynamic_table 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@ifExists={{ ifExists }};

suspend_recluster_dynamic_table

Suspend recluster of a dynamic table

EXEC snowflake.dynamic_table.dynamic_tables.suspend_recluster_dynamic_table 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@ifExists={{ ifExists }};

resume_recluster_dynamic_table

Resume recluster of a dynamic table

EXEC snowflake.dynamic_table.dynamic_tables.resume_recluster_dynamic_table 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@ifExists={{ ifExists }};

swap_with_dynamic_table

Swap with another dynamic table

EXEC snowflake.dynamic_table.dynamic_tables.swap_with_dynamic_table 
@database_name='{{ database_name }}' --required, 
@schema_name='{{ schema_name }}' --required, 
@name='{{ name }}' --required, 
@targetName='{{ targetName }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@ifExists={{ ifExists }}, 
@targetDatabase='{{ targetDatabase }}', 
@targetSchema='{{ targetSchema }}';