Snowflake · Schema

DynamicTable

A Snowflake dynamic table object.

Data LakesData SharingData WarehousingDatabaseSQL

Properties

Name	Type	Description
name	string	Specifies the name for the dynamic table, must be unique for the schema in which the dynamic table is created
kind	string	Specifies the dynamic table type, permanent (default) or transient.
columns	array
refresh_mode	string	Specifies the refresh type for the dynamic table
initialize	string	Specifies the behavior of the initial refresh of the dynamic table
warehouse	string	Specifies the name of the warehouse that provides the compute resources for refreshing the dynamic table
cluster_by	array	Specifies one or more columns or column expressions in the dynamic table as the clustering key
query	string	Specifies the query whose results the dynamic table should contain
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
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
comment	string	Specifies a comment for the dynamic table.
created_on	string	Date and time when the dynamic table was created.
database_name	string	Database in which the dynamic table is stored
schema_name	string	Schema in which the dynamic table is stored
rows	integer	Number of rows in the dynamic table.
bytes	integer	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
scheduling_state	string	Scheduling state (RUNNING or SUSPENDED)
automatic_clustering	boolean	If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the dynamic table.
owner	string	Role that owns the table
owner_role_type	string	The type of role that owns the object.
budget	string	Name of the budget if the object is monitored by a budget

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "DynamicTable",
  "type": "object",
  "description": "A Snowflake dynamic table object.",
  "properties": {
    "name": {
      "type": "string",
      "description": "Specifies the name for the dynamic table, must be unique for the schema in which the dynamic table is created"
    },
    "kind": {
      "type": "string",
      "description": "Specifies the dynamic table type, permanent (default) or transient."
    },
    "columns": {
      "type": "array"
    },
    "refresh_mode": {
      "type": "string",
      "description": "Specifies the refresh type for the dynamic table"
    },
    "initialize": {
      "type": "string",
      "description": "Specifies the behavior of the initial refresh of the dynamic table"
    },
    "warehouse": {
      "type": "string",
      "description": "Specifies the name of the warehouse that provides the compute resources for refreshing the dynamic table"
    },
    "cluster_by": {
      "type": "array",
      "description": "Specifies one or more columns or column expressions in the dynamic table as the clustering key"
    },
    "query": {
      "type": "string",
      "description": "Specifies the query whose results the dynamic table should contain"
    },
    "data_retention_time_in_days": {
      "type": "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"
    },
    "max_data_extension_time_in_days": {
      "type": "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"
    },
    "comment": {
      "type": "string",
      "description": "Specifies a comment for the dynamic table."
    },
    "created_on": {
      "type": "string",
      "description": "Date and time when the dynamic table was created."
    },
    "database_name": {
      "type": "string",
      "description": "Database in which the dynamic table is stored"
    },
    "schema_name": {
      "type": "string",
      "description": "Schema in which the dynamic table is stored"
    },
    "rows": {
      "type": "integer",
      "description": "Number of rows in the dynamic table."
    },
    "bytes": {
      "type": "integer",
      "description": "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"
    },
    "scheduling_state": {
      "type": "string",
      "description": "Scheduling state (RUNNING or SUSPENDED)"
    },
    "automatic_clustering": {
      "type": "boolean",
      "description": "If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the dynamic table."
    },
    "owner": {
      "type": "string",
      "description": "Role that owns the table"
    },
    "owner_role_type": {
      "type": "string",
      "description": "The type of role that owns the object."
    },
    "budget": {
      "type": "string",
      "description": "Name of the budget if the object is monitored by a budget"
    }
  }
}