published on Friday, Nov 6, 2026 by Pulumi
published on Friday, Nov 6, 2026 by Pulumi
Note The provider does not detect external changes on database type. In this case, remove the database of wrong type manually with
terraform destroyand recreate the resource. It will be addressed in the future.
Note A database cannot be dropped successfully if it contains network rule-network policy associations. The error looks like
098507 (2BP01): Cannot drop database DATABASE as it includes network rule - policy associations.. Currently, the provider does not unassign such objects automatically. Before dropping the resource, first unassign the network rule from the relevant objects. See guide for more details.
Represents a standard database. If replication configuration is specified, the database is promoted to serve as a primary database for replication.
Create Database Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Database(name: string, args?: DatabaseArgs, opts?: CustomResourceOptions);@overload
def Database(resource_name: str,
args: Optional[DatabaseArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Database(resource_name: str,
opts: Optional[ResourceOptions] = None,
catalog: Optional[str] = None,
comment: Optional[str] = None,
data_retention_time_in_days: Optional[int] = None,
default_ddl_collation: Optional[str] = None,
default_notebook_compute_pool_cpu: Optional[str] = None,
default_notebook_compute_pool_gpu: Optional[str] = None,
drop_public_schema_on_creation: Optional[bool] = None,
enable_console_output: Optional[bool] = None,
external_volume: Optional[str] = None,
is_transient: Optional[bool] = None,
log_event_level: Optional[str] = None,
log_level: Optional[str] = None,
max_data_extension_time_in_days: Optional[int] = None,
name: Optional[str] = None,
quoted_identifiers_ignore_case: Optional[bool] = None,
replace_invalid_characters: Optional[bool] = None,
replication: Optional[DatabaseReplicationArgs] = None,
storage_serialization_policy: Optional[str] = None,
suspend_task_after_num_failures: Optional[int] = None,
task_auto_retry_attempts: Optional[int] = None,
trace_level: Optional[str] = None,
user_task_managed_initial_warehouse_size: Optional[str] = None,
user_task_minimum_trigger_interval_in_seconds: Optional[int] = None,
user_task_timeout_ms: Optional[int] = None)func NewDatabase(ctx *Context, name string, args *DatabaseArgs, opts ...ResourceOption) (*Database, error)public Database(string name, DatabaseArgs? args = null, CustomResourceOptions? opts = null)
public Database(String name, DatabaseArgs args)
public Database(String name, DatabaseArgs args, CustomResourceOptions options)
type: snowflake:Database
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "snowflake_database" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args DatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DatabaseArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DatabaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DatabaseArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var databaseResource = new Snowflake.Database("databaseResource", new()
{
Catalog = "string",
Comment = "string",
DataRetentionTimeInDays = 0,
DefaultDdlCollation = "string",
DefaultNotebookComputePoolCpu = "string",
DefaultNotebookComputePoolGpu = "string",
DropPublicSchemaOnCreation = false,
EnableConsoleOutput = false,
ExternalVolume = "string",
IsTransient = false,
LogEventLevel = "string",
LogLevel = "string",
MaxDataExtensionTimeInDays = 0,
Name = "string",
QuotedIdentifiersIgnoreCase = false,
ReplaceInvalidCharacters = false,
Replication = new Snowflake.Inputs.DatabaseReplicationArgs
{
EnableToAccounts = new[]
{
new Snowflake.Inputs.DatabaseReplicationEnableToAccountArgs
{
AccountIdentifier = "string",
WithFailover = false,
},
},
IgnoreEditionCheck = false,
},
StorageSerializationPolicy = "string",
SuspendTaskAfterNumFailures = 0,
TaskAutoRetryAttempts = 0,
TraceLevel = "string",
UserTaskManagedInitialWarehouseSize = "string",
UserTaskMinimumTriggerIntervalInSeconds = 0,
UserTaskTimeoutMs = 0,
});
example, err := snowflake.NewDatabase(ctx, "databaseResource", &snowflake.DatabaseArgs{
Catalog: pulumi.String("string"),
Comment: pulumi.String("string"),
DataRetentionTimeInDays: pulumi.Int(0),
DefaultDdlCollation: pulumi.String("string"),
DefaultNotebookComputePoolCpu: pulumi.String("string"),
DefaultNotebookComputePoolGpu: pulumi.String("string"),
DropPublicSchemaOnCreation: pulumi.Bool(false),
EnableConsoleOutput: pulumi.Bool(false),
ExternalVolume: pulumi.String("string"),
IsTransient: pulumi.Bool(false),
LogEventLevel: pulumi.String("string"),
LogLevel: pulumi.String("string"),
MaxDataExtensionTimeInDays: pulumi.Int(0),
Name: pulumi.String("string"),
QuotedIdentifiersIgnoreCase: pulumi.Bool(false),
ReplaceInvalidCharacters: pulumi.Bool(false),
Replication: &snowflake.DatabaseReplicationArgs{
EnableToAccounts: snowflake.DatabaseReplicationEnableToAccountArray{
&snowflake.DatabaseReplicationEnableToAccountArgs{
AccountIdentifier: pulumi.String("string"),
WithFailover: pulumi.Bool(false),
},
},
IgnoreEditionCheck: pulumi.Bool(false),
},
StorageSerializationPolicy: pulumi.String("string"),
SuspendTaskAfterNumFailures: pulumi.Int(0),
TaskAutoRetryAttempts: pulumi.Int(0),
TraceLevel: pulumi.String("string"),
UserTaskManagedInitialWarehouseSize: pulumi.String("string"),
UserTaskMinimumTriggerIntervalInSeconds: pulumi.Int(0),
UserTaskTimeoutMs: pulumi.Int(0),
})
resource "snowflake_database" "databaseResource" {
lifecycle {
create_before_destroy = true
}
catalog = "string"
comment = "string"
data_retention_time_in_days = 0
default_ddl_collation = "string"
default_notebook_compute_pool_cpu = "string"
default_notebook_compute_pool_gpu = "string"
drop_public_schema_on_creation = false
enable_console_output = false
external_volume = "string"
is_transient = false
log_event_level = "string"
log_level = "string"
max_data_extension_time_in_days = 0
name = "string"
quoted_identifiers_ignore_case = false
replace_invalid_characters = false
replication = {
enable_to_accounts = [{
account_identifier = "string"
with_failover = false
}]
ignore_edition_check = false
}
storage_serialization_policy = "string"
suspend_task_after_num_failures = 0
task_auto_retry_attempts = 0
trace_level = "string"
user_task_managed_initial_warehouse_size = "string"
user_task_minimum_trigger_interval_in_seconds = 0
user_task_timeout_ms = 0
}
var databaseResource = new Database("databaseResource", DatabaseArgs.builder()
.catalog("string")
.comment("string")
.dataRetentionTimeInDays(0)
.defaultDdlCollation("string")
.defaultNotebookComputePoolCpu("string")
.defaultNotebookComputePoolGpu("string")
.dropPublicSchemaOnCreation(false)
.enableConsoleOutput(false)
.externalVolume("string")
.isTransient(false)
.logEventLevel("string")
.logLevel("string")
.maxDataExtensionTimeInDays(0)
.name("string")
.quotedIdentifiersIgnoreCase(false)
.replaceInvalidCharacters(false)
.replication(DatabaseReplicationArgs.builder()
.enableToAccounts(DatabaseReplicationEnableToAccountArgs.builder()
.accountIdentifier("string")
.withFailover(false)
.build())
.ignoreEditionCheck(false)
.build())
.storageSerializationPolicy("string")
.suspendTaskAfterNumFailures(0)
.taskAutoRetryAttempts(0)
.traceLevel("string")
.userTaskManagedInitialWarehouseSize("string")
.userTaskMinimumTriggerIntervalInSeconds(0)
.userTaskTimeoutMs(0)
.build());
database_resource = snowflake.Database("databaseResource",
catalog="string",
comment="string",
data_retention_time_in_days=0,
default_ddl_collation="string",
default_notebook_compute_pool_cpu="string",
default_notebook_compute_pool_gpu="string",
drop_public_schema_on_creation=False,
enable_console_output=False,
external_volume="string",
is_transient=False,
log_event_level="string",
log_level="string",
max_data_extension_time_in_days=0,
name="string",
quoted_identifiers_ignore_case=False,
replace_invalid_characters=False,
replication={
"enable_to_accounts": [{
"account_identifier": "string",
"with_failover": False,
}],
"ignore_edition_check": False,
},
storage_serialization_policy="string",
suspend_task_after_num_failures=0,
task_auto_retry_attempts=0,
trace_level="string",
user_task_managed_initial_warehouse_size="string",
user_task_minimum_trigger_interval_in_seconds=0,
user_task_timeout_ms=0)
const databaseResource = new snowflake.Database("databaseResource", {
catalog: "string",
comment: "string",
dataRetentionTimeInDays: 0,
defaultDdlCollation: "string",
defaultNotebookComputePoolCpu: "string",
defaultNotebookComputePoolGpu: "string",
dropPublicSchemaOnCreation: false,
enableConsoleOutput: false,
externalVolume: "string",
isTransient: false,
logEventLevel: "string",
logLevel: "string",
maxDataExtensionTimeInDays: 0,
name: "string",
quotedIdentifiersIgnoreCase: false,
replaceInvalidCharacters: false,
replication: {
enableToAccounts: [{
accountIdentifier: "string",
withFailover: false,
}],
ignoreEditionCheck: false,
},
storageSerializationPolicy: "string",
suspendTaskAfterNumFailures: 0,
taskAutoRetryAttempts: 0,
traceLevel: "string",
userTaskManagedInitialWarehouseSize: "string",
userTaskMinimumTriggerIntervalInSeconds: 0,
userTaskTimeoutMs: 0,
});
type: snowflake:Database
properties:
catalog: string
comment: string
dataRetentionTimeInDays: 0
defaultDdlCollation: string
defaultNotebookComputePoolCpu: string
defaultNotebookComputePoolGpu: string
dropPublicSchemaOnCreation: false
enableConsoleOutput: false
externalVolume: string
isTransient: false
logEventLevel: string
logLevel: string
maxDataExtensionTimeInDays: 0
name: string
quotedIdentifiersIgnoreCase: false
replaceInvalidCharacters: false
replication:
enableToAccounts:
- accountIdentifier: string
withFailover: false
ignoreEditionCheck: false
storageSerializationPolicy: string
suspendTaskAfterNumFailures: 0
taskAutoRetryAttempts: 0
traceLevel: string
userTaskManagedInitialWarehouseSize: string
userTaskMinimumTriggerIntervalInSeconds: 0
userTaskTimeoutMs: 0
Database Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Database resource accepts the following input properties:
- Catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- Comment string
- Specifies a comment for the database.
- Data
Retention intTime In Days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- Default
Ddl stringCollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- Default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- Default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- Drop
Public boolSchema On Creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- Enable
Console boolOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- External
Volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- Is
Transient bool - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- Log
Event stringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - Log
Level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - Max
Data intExtension Time In Days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- Name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Quoted
Identifiers boolIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- Replace
Invalid boolCharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- Replication
Database
Replication - Configures replication for a given database. When specified, this database will be promoted 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.
- Storage
Serialization stringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - Suspend
Task intAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- Task
Auto intRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- Trace
Level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - User
Task stringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - User
Task intMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- User
Task intTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- Catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- Comment string
- Specifies a comment for the database.
- Data
Retention intTime In Days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- Default
Ddl stringCollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- Default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- Default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- Drop
Public boolSchema On Creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- Enable
Console boolOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- External
Volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- Is
Transient bool - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- Log
Event stringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - Log
Level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - Max
Data intExtension Time In Days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- Name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Quoted
Identifiers boolIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- Replace
Invalid boolCharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- Replication
Database
Replication Args - Configures replication for a given database. When specified, this database will be promoted 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.
- Storage
Serialization stringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - Suspend
Task intAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- Task
Auto intRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- Trace
Level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - User
Task stringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - User
Task intMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- User
Task intTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment string
- Specifies a comment for the database.
- data_
retention_ numbertime_ in_ days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- default_
ddl_ stringcollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- default_
notebook_ stringcompute_ pool_ cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default_
notebook_ stringcompute_ pool_ gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- drop_
public_ boolschema_ on_ creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- enable_
console_ booloutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external_
volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- is_
transient bool - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- log_
event_ stringlevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log_
level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max_
data_ numberextension_ time_ in_ days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted_
identifiers_ boolignore_ case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace_
invalid_ boolcharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- replication object
- Configures replication for a given database. When specified, this database will be promoted 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.
- storage_
serialization_ stringpolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend_
task_ numberafter_ num_ failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task_
auto_ numberretry_ attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace_
level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user_
task_ stringmanaged_ initial_ warehouse_ size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user_
task_ numberminimum_ trigger_ interval_ in_ seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user_
task_ numbertimeout_ ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- catalog String
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment String
- Specifies a comment for the database.
- data
Retention IntegerTime In Days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- default
Ddl StringCollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook StringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default
Notebook StringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- drop
Public BooleanSchema On Creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- enable
Console BooleanOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external
Volume String - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- is
Transient Boolean - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- log
Event StringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log
Level String - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max
Data IntegerExtension Time In Days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name String
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted
Identifiers BooleanIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace
Invalid BooleanCharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- replication
Database
Replication - Configures replication for a given database. When specified, this database will be promoted 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.
- storage
Serialization StringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend
Task IntegerAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto IntegerRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace
Level String - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user
Task StringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user
Task IntegerMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user
Task IntegerTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment string
- Specifies a comment for the database.
- data
Retention numberTime In Days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- default
Ddl stringCollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- drop
Public booleanSchema On Creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- enable
Console booleanOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external
Volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- is
Transient boolean - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- log
Event stringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log
Level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max
Data numberExtension Time In Days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted
Identifiers booleanIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace
Invalid booleanCharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- replication
Database
Replication - Configures replication for a given database. When specified, this database will be promoted 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.
- storage
Serialization stringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend
Task numberAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto numberRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace
Level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user
Task stringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user
Task numberMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user
Task numberTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- catalog str
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment str
- Specifies a comment for the database.
- data_
retention_ inttime_ in_ days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- default_
ddl_ strcollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- default_
notebook_ strcompute_ pool_ cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default_
notebook_ strcompute_ pool_ gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- drop_
public_ boolschema_ on_ creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- enable_
console_ booloutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external_
volume str - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- is_
transient bool - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- log_
event_ strlevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log_
level str - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max_
data_ intextension_ time_ in_ days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name str
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted_
identifiers_ boolignore_ case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace_
invalid_ boolcharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- replication
Database
Replication Args - Configures replication for a given database. When specified, this database will be promoted 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.
- storage_
serialization_ strpolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend_
task_ intafter_ num_ failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task_
auto_ intretry_ attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace_
level str - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user_
task_ strmanaged_ initial_ warehouse_ size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user_
task_ intminimum_ trigger_ interval_ in_ seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user_
task_ inttimeout_ ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- catalog String
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment String
- Specifies a comment for the database.
- data
Retention NumberTime In Days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- default
Ddl StringCollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook StringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default
Notebook StringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- drop
Public BooleanSchema On Creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- enable
Console BooleanOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external
Volume String - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- is
Transient Boolean - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- log
Event StringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log
Level String - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max
Data NumberExtension Time In Days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name String
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - quoted
Identifiers BooleanIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace
Invalid BooleanCharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- replication Property Map
- Configures replication for a given database. When specified, this database will be promoted 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.
- storage
Serialization StringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend
Task NumberAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto NumberRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace
Level String - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user
Task StringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user
Task NumberMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user
Task NumberTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
Outputs
All input properties are implicitly available as output properties. Additionally, the Database resource produces the following output properties:
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Parameters
List<Database
Parameter> - Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Parameters
[]Database
Parameter - Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object.
- fully_
qualified_ stringname - Fully qualified name of the resource. For more information, see object name resolution.
- id string
- The provider-assigned unique ID for this managed resource.
- parameters list(object)
- Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- parameters
List<Database
Parameter> - Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- id string
- The provider-assigned unique ID for this managed resource.
- parameters
Database
Parameter[] - Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object.
- fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- id str
- The provider-assigned unique ID for this managed resource.
- parameters
Sequence[Database
Parameter] - Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- parameters List<Property Map>
- Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object.
Look up Existing Database Resource
Get an existing Database resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DatabaseState, opts?: CustomResourceOptions): Database@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
catalog: Optional[str] = None,
comment: Optional[str] = None,
data_retention_time_in_days: Optional[int] = None,
default_ddl_collation: Optional[str] = None,
default_notebook_compute_pool_cpu: Optional[str] = None,
default_notebook_compute_pool_gpu: Optional[str] = None,
drop_public_schema_on_creation: Optional[bool] = None,
enable_console_output: Optional[bool] = None,
external_volume: Optional[str] = None,
fully_qualified_name: Optional[str] = None,
is_transient: Optional[bool] = None,
log_event_level: Optional[str] = None,
log_level: Optional[str] = None,
max_data_extension_time_in_days: Optional[int] = None,
name: Optional[str] = None,
parameters: Optional[Sequence[DatabaseParameterArgs]] = None,
quoted_identifiers_ignore_case: Optional[bool] = None,
replace_invalid_characters: Optional[bool] = None,
replication: Optional[DatabaseReplicationArgs] = None,
storage_serialization_policy: Optional[str] = None,
suspend_task_after_num_failures: Optional[int] = None,
task_auto_retry_attempts: Optional[int] = None,
trace_level: Optional[str] = None,
user_task_managed_initial_warehouse_size: Optional[str] = None,
user_task_minimum_trigger_interval_in_seconds: Optional[int] = None,
user_task_timeout_ms: Optional[int] = None) -> Databasefunc GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)public static Database get(String name, Output<String> id, DatabaseState state, CustomResourceOptions options)resources: _: type: snowflake:Database get: id: ${id}import {
to = snowflake_database.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- Comment string
- Specifies a comment for the database.
- Data
Retention intTime In Days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- Default
Ddl stringCollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- Default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- Default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- Drop
Public boolSchema On Creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- Enable
Console boolOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- External
Volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Is
Transient bool - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- Log
Event stringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - Log
Level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - Max
Data intExtension Time In Days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- Name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Parameters
List<Database
Parameter> - Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object. - Quoted
Identifiers boolIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- Replace
Invalid boolCharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- Replication
Database
Replication - Configures replication for a given database. When specified, this database will be promoted 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.
- Storage
Serialization stringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - Suspend
Task intAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- Task
Auto intRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- Trace
Level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - User
Task stringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - User
Task intMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- User
Task intTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- Catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- Comment string
- Specifies a comment for the database.
- Data
Retention intTime In Days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- Default
Ddl stringCollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- Default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- Default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- Drop
Public boolSchema On Creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- Enable
Console boolOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- External
Volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Is
Transient bool - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- Log
Event stringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - Log
Level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - Max
Data intExtension Time In Days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- Name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Parameters
[]Database
Parameter Args - Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object. - Quoted
Identifiers boolIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- Replace
Invalid boolCharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- Replication
Database
Replication Args - Configures replication for a given database. When specified, this database will be promoted 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.
- Storage
Serialization stringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - Suspend
Task intAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- Task
Auto intRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- Trace
Level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - User
Task stringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - User
Task intMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- User
Task intTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment string
- Specifies a comment for the database.
- data_
retention_ numbertime_ in_ days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- default_
ddl_ stringcollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- default_
notebook_ stringcompute_ pool_ cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default_
notebook_ stringcompute_ pool_ gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- drop_
public_ boolschema_ on_ creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- enable_
console_ booloutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external_
volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- fully_
qualified_ stringname - Fully qualified name of the resource. For more information, see object name resolution.
- is_
transient bool - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- log_
event_ stringlevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log_
level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max_
data_ numberextension_ time_ in_ days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - parameters list(object)
- Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object. - quoted_
identifiers_ boolignore_ case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace_
invalid_ boolcharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- replication object
- Configures replication for a given database. When specified, this database will be promoted 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.
- storage_
serialization_ stringpolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend_
task_ numberafter_ num_ failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task_
auto_ numberretry_ attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace_
level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user_
task_ stringmanaged_ initial_ warehouse_ size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user_
task_ numberminimum_ trigger_ interval_ in_ seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user_
task_ numbertimeout_ ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- catalog String
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment String
- Specifies a comment for the database.
- data
Retention IntegerTime In Days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- default
Ddl StringCollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook StringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default
Notebook StringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- drop
Public BooleanSchema On Creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- enable
Console BooleanOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external
Volume String - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- is
Transient Boolean - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- log
Event StringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log
Level String - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max
Data IntegerExtension Time In Days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name String
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - parameters
List<Database
Parameter> - Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object. - quoted
Identifiers BooleanIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace
Invalid BooleanCharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- replication
Database
Replication - Configures replication for a given database. When specified, this database will be promoted 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.
- storage
Serialization StringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend
Task IntegerAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto IntegerRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace
Level String - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user
Task StringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user
Task IntegerMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user
Task IntegerTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- catalog string
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment string
- Specifies a comment for the database.
- data
Retention numberTime In Days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- default
Ddl stringCollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- drop
Public booleanSchema On Creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- enable
Console booleanOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external
Volume string - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- is
Transient boolean - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- log
Event stringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log
Level string - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max
Data numberExtension Time In Days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name string
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - parameters
Database
Parameter[] - Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object. - quoted
Identifiers booleanIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace
Invalid booleanCharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- replication
Database
Replication - Configures replication for a given database. When specified, this database will be promoted 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.
- storage
Serialization stringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend
Task numberAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto numberRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace
Level string - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user
Task stringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user
Task numberMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user
Task numberTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- catalog str
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment str
- Specifies a comment for the database.
- data_
retention_ inttime_ in_ days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- default_
ddl_ strcollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- default_
notebook_ strcompute_ pool_ cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default_
notebook_ strcompute_ pool_ gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- drop_
public_ boolschema_ on_ creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- enable_
console_ booloutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external_
volume str - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- is_
transient bool - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- log_
event_ strlevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log_
level str - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max_
data_ intextension_ time_ in_ days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name str
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - parameters
Sequence[Database
Parameter Args] - Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object. - quoted_
identifiers_ boolignore_ case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace_
invalid_ boolcharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- replication
Database
Replication Args - Configures replication for a given database. When specified, this database will be promoted 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.
- storage_
serialization_ strpolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend_
task_ intafter_ num_ failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task_
auto_ intretry_ attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace_
level str - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user_
task_ strmanaged_ initial_ warehouse_ size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user_
task_ intminimum_ trigger_ interval_ in_ seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user_
task_ inttimeout_ ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
- catalog String
- The parameter that specifies the default catalog to use for Iceberg tables. For more information, check CATALOG docs.
- comment String
- Specifies a comment for the database.
- data
Retention NumberTime In Days - 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. For more details, see Understanding & Using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- default
Ddl StringCollation - Specifies a default collation specification for all schemas and tables added to the database. It can be overridden on schema or table level. For more information, see collation specification. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook StringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs.
- default
Notebook StringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs.
- drop
Public BooleanSchema On Creation - Specifies whether to drop public schema on creation or not. Modifying the parameter after database is already created won't have any effect.
- enable
Console BooleanOutput - If true, enables stdout/stderr fast path logging for anonymous stored procedures. For more information, check ENABLECONSOLEOUTPUT docs.
- external
Volume String - The parameter that specifies the default external volume to use for Iceberg tables. For more information, check EXTERNAL_VOLUME docs.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- is
Transient Boolean - Specifies the database as transient. Transient databases do not have a Fail-safe period so they do not incur additional storage costs once they leave Time Travel; however, this means they are also not protected by Fail-safe in the event of a data loss.
- log
Event StringLevel - Specifies the severity level of log events (rows with record type EVENT) that should be ingested and made available in the active event table. Log events at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOGEVENTLEVEL docs. - log
Level String - Specifies the severity level of messages that should be ingested and made available in the active event table. Messages at the specified level (and at more severe levels) are ingested. Valid values are (case-insensitive):
TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF. For more information, check LOG_LEVEL docs. - max
Data NumberExtension Time In Days - Object parameter that specifies the 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. For more information, check MAXDATAEXTENSIONTIMEIN_DAYS docs.
- name String
- Specifies the identifier for the database; must be unique for your account. As a best practice for Database Replication and Failover, it is recommended to give each secondary database the same name as its primary database. This practice supports referencing fully-qualified objects (i.e. '\n\n.\n\n.\n\n') by other objects in the same database, such as querying a fully-qualified table name in a view. If a secondary database has a different name from the primary database, then these object references would break in the secondary database. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - parameters List<Property Map>
- Outputs the result of
SHOW PARAMETERS IN DATABASEfor the given object. - quoted
Identifiers BooleanIgnore Case - If true, the case of quoted identifiers is ignored. For more information, check QUOTEDIDENTIFIERSIGNORE_CASE docs.
- replace
Invalid BooleanCharacters - Specifies whether to replace invalid UTF-8 characters with the Unicode replacement character in query results for an Iceberg table. You can only set this parameter for tables that use an external Iceberg catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- replication Property Map
- Configures replication for a given database. When specified, this database will be promoted 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.
- storage
Serialization StringPolicy - The storage serialization policy for Iceberg tables that use Snowflake as the catalog. COMPATIBLE: Snowflake performs encoding and compression of data files that ensures interoperability with third-party compute engines. OPTIMIZED: Snowflake performs encoding and compression of data files that ensures the best table performance within Snowflake. Valid values are (case-insensitive):
COMPATIBLE|OPTIMIZED. For more information, check STORAGESERIALIZATIONPOLICY docs. - suspend
Task NumberAfter Num Failures - How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending. For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto NumberRetry Attempts - Maximum automatic retries allowed for a user task. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- trace
Level String - Controls how trace events are ingested into the event table. Valid values are (case-insensitive):
ALWAYS|ON_EVENT|PROPAGATE|OFF. For more information, check TRACE_LEVEL docs. - user
Task StringManaged Initial Warehouse Size - The initial size of warehouse to use for managed warehouses in the absence of history. Valid values are (case-insensitive):
XSMALL|SMALL|MEDIUM|LARGE|XLARGE|XXLARGE|XXXLARGE|X4LARGE|X5LARGE|X6LARGE. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs. - user
Task NumberMinimum Trigger Interval In Seconds - Minimum amount of time between Triggered Task executions in seconds. For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
- user
Task NumberTimeout Ms - User task execution timeout in milliseconds. For more information, check USERTASKTIMEOUT_MS docs.
Supporting Types
DatabaseParameter, DatabaseParameterArgs
- Catalogs
List<Database
Parameter Catalog> - Data
Retention List<DatabaseTime In Days Parameter Data Retention Time In Day> - Default
Ddl List<DatabaseCollations Parameter Default Ddl Collation> - Default
Notebook List<DatabaseCompute Pool Cpus Parameter Default Notebook Compute Pool Cpus> - Default
Notebook List<DatabaseCompute Pool Gpus Parameter Default Notebook Compute Pool Gpus> - Enable
Console List<DatabaseOutputs Parameter Enable Console Output> - External
Volumes List<DatabaseParameter External Volume> - Log
Event List<DatabaseLevels Parameter Log Event Level> - Log
Levels List<DatabaseParameter Log Level> - Max
Data List<DatabaseExtension Time In Days Parameter Max Data Extension Time In Day> - Quoted
Identifiers List<DatabaseIgnore Cases Parameter Quoted Identifiers Ignore Case> - Replace
Invalid List<DatabaseCharacters Parameter Replace Invalid Character> - Storage
Serialization List<DatabasePolicies Parameter Storage Serialization Policy> - Suspend
Task List<DatabaseAfter Num Failures Parameter Suspend Task After Num Failure> - Task
Auto List<DatabaseRetry Attempts Parameter Task Auto Retry Attempt> - Trace
Levels List<DatabaseParameter Trace Level> - User
Task List<DatabaseManaged Initial Warehouse Sizes Parameter User Task Managed Initial Warehouse Size> - User
Task List<DatabaseMinimum Trigger Interval In Seconds Parameter User Task Minimum Trigger Interval In Second> - User
Task List<DatabaseTimeout Ms Parameter User Task Timeout M>
- Catalogs
[]Database
Parameter Catalog - Data
Retention []DatabaseTime In Days Parameter Data Retention Time In Day - Default
Ddl []DatabaseCollations Parameter Default Ddl Collation - Default
Notebook []DatabaseCompute Pool Cpus Parameter Default Notebook Compute Pool Cpus - Default
Notebook []DatabaseCompute Pool Gpus Parameter Default Notebook Compute Pool Gpus - Enable
Console []DatabaseOutputs Parameter Enable Console Output - External
Volumes []DatabaseParameter External Volume - Log
Event []DatabaseLevels Parameter Log Event Level - Log
Levels []DatabaseParameter Log Level - Max
Data []DatabaseExtension Time In Days Parameter Max Data Extension Time In Day - Quoted
Identifiers []DatabaseIgnore Cases Parameter Quoted Identifiers Ignore Case - Replace
Invalid []DatabaseCharacters Parameter Replace Invalid Character - Storage
Serialization []DatabasePolicies Parameter Storage Serialization Policy - Suspend
Task []DatabaseAfter Num Failures Parameter Suspend Task After Num Failure - Task
Auto []DatabaseRetry Attempts Parameter Task Auto Retry Attempt - Trace
Levels []DatabaseParameter Trace Level - User
Task []DatabaseManaged Initial Warehouse Sizes Parameter User Task Managed Initial Warehouse Size - User
Task []DatabaseMinimum Trigger Interval In Seconds Parameter User Task Minimum Trigger Interval In Second - User
Task []DatabaseTimeout Ms Parameter User Task Timeout M
- catalogs list(object)
- data_
retention_ list(object)time_ in_ days - default_
ddl_ list(object)collations - default_
notebook_ list(object)compute_ pool_ cpus - default_
notebook_ list(object)compute_ pool_ gpus - enable_
console_ list(object)outputs - external_
volumes list(object) - log_
event_ list(object)levels - log_
levels list(object) - max_
data_ list(object)extension_ time_ in_ days - quoted_
identifiers_ list(object)ignore_ cases - replace_
invalid_ list(object)characters - storage_
serialization_ list(object)policies - suspend_
task_ list(object)after_ num_ failures - task_
auto_ list(object)retry_ attempts - trace_
levels list(object) - user_
task_ list(object)managed_ initial_ warehouse_ sizes - user_
task_ list(object)minimum_ trigger_ interval_ in_ seconds - user_
task_ list(object)timeout_ ms
- catalogs
List<Database
Parameter Catalog> - data
Retention List<DatabaseTime In Days Parameter Data Retention Time In Day> - default
Ddl List<DatabaseCollations Parameter Default Ddl Collation> - default
Notebook List<DatabaseCompute Pool Cpus Parameter Default Notebook Compute Pool Cpus> - default
Notebook List<DatabaseCompute Pool Gpus Parameter Default Notebook Compute Pool Gpus> - enable
Console List<DatabaseOutputs Parameter Enable Console Output> - external
Volumes List<DatabaseParameter External Volume> - log
Event List<DatabaseLevels Parameter Log Event Level> - log
Levels List<DatabaseParameter Log Level> - max
Data List<DatabaseExtension Time In Days Parameter Max Data Extension Time In Day> - quoted
Identifiers List<DatabaseIgnore Cases Parameter Quoted Identifiers Ignore Case> - replace
Invalid List<DatabaseCharacters Parameter Replace Invalid Character> - storage
Serialization List<DatabasePolicies Parameter Storage Serialization Policy> - suspend
Task List<DatabaseAfter Num Failures Parameter Suspend Task After Num Failure> - task
Auto List<DatabaseRetry Attempts Parameter Task Auto Retry Attempt> - trace
Levels List<DatabaseParameter Trace Level> - user
Task List<DatabaseManaged Initial Warehouse Sizes Parameter User Task Managed Initial Warehouse Size> - user
Task List<DatabaseMinimum Trigger Interval In Seconds Parameter User Task Minimum Trigger Interval In Second> - user
Task List<DatabaseTimeout Ms Parameter User Task Timeout M>
- catalogs
Database
Parameter Catalog[] - data
Retention DatabaseTime In Days Parameter Data Retention Time In Day[] - default
Ddl DatabaseCollations Parameter Default Ddl Collation[] - default
Notebook DatabaseCompute Pool Cpus Parameter Default Notebook Compute Pool Cpus[] - default
Notebook DatabaseCompute Pool Gpus Parameter Default Notebook Compute Pool Gpus[] - enable
Console DatabaseOutputs Parameter Enable Console Output[] - external
Volumes DatabaseParameter External Volume[] - log
Event DatabaseLevels Parameter Log Event Level[] - log
Levels DatabaseParameter Log Level[] - max
Data DatabaseExtension Time In Days Parameter Max Data Extension Time In Day[] - quoted
Identifiers DatabaseIgnore Cases Parameter Quoted Identifiers Ignore Case[] - replace
Invalid DatabaseCharacters Parameter Replace Invalid Character[] - storage
Serialization DatabasePolicies Parameter Storage Serialization Policy[] - suspend
Task DatabaseAfter Num Failures Parameter Suspend Task After Num Failure[] - task
Auto DatabaseRetry Attempts Parameter Task Auto Retry Attempt[] - trace
Levels DatabaseParameter Trace Level[] - user
Task DatabaseManaged Initial Warehouse Sizes Parameter User Task Managed Initial Warehouse Size[] - user
Task DatabaseMinimum Trigger Interval In Seconds Parameter User Task Minimum Trigger Interval In Second[] - user
Task DatabaseTimeout Ms Parameter User Task Timeout M[]
- catalogs
Sequence[Database
Parameter Catalog] - data_
retention_ Sequence[Databasetime_ in_ days Parameter Data Retention Time In Day] - default_
ddl_ Sequence[Databasecollations Parameter Default Ddl Collation] - default_
notebook_ Sequence[Databasecompute_ pool_ cpus Parameter Default Notebook Compute Pool Cpus] - default_
notebook_ Sequence[Databasecompute_ pool_ gpus Parameter Default Notebook Compute Pool Gpus] - enable_
console_ Sequence[Databaseoutputs Parameter Enable Console Output] - external_
volumes Sequence[DatabaseParameter External Volume] - log_
event_ Sequence[Databaselevels Parameter Log Event Level] - log_
levels Sequence[DatabaseParameter Log Level] - max_
data_ Sequence[Databaseextension_ time_ in_ days Parameter Max Data Extension Time In Day] - quoted_
identifiers_ Sequence[Databaseignore_ cases Parameter Quoted Identifiers Ignore Case] - replace_
invalid_ Sequence[Databasecharacters Parameter Replace Invalid Character] - storage_
serialization_ Sequence[Databasepolicies Parameter Storage Serialization Policy] - suspend_
task_ Sequence[Databaseafter_ num_ failures Parameter Suspend Task After Num Failure] - task_
auto_ Sequence[Databaseretry_ attempts Parameter Task Auto Retry Attempt] - trace_
levels Sequence[DatabaseParameter Trace Level] - user_
task_ Sequence[Databasemanaged_ initial_ warehouse_ sizes Parameter User Task Managed Initial Warehouse Size] - user_
task_ Sequence[Databaseminimum_ trigger_ interval_ in_ seconds Parameter User Task Minimum Trigger Interval In Second] - user_
task_ Sequence[Databasetimeout_ ms Parameter User Task Timeout M]
- catalogs List<Property Map>
- data
Retention List<Property Map>Time In Days - default
Ddl List<Property Map>Collations - default
Notebook List<Property Map>Compute Pool Cpus - default
Notebook List<Property Map>Compute Pool Gpus - enable
Console List<Property Map>Outputs - external
Volumes List<Property Map> - log
Event List<Property Map>Levels - log
Levels List<Property Map> - max
Data List<Property Map>Extension Time In Days - quoted
Identifiers List<Property Map>Ignore Cases - replace
Invalid List<Property Map>Characters - storage
Serialization List<Property Map>Policies - suspend
Task List<Property Map>After Num Failures - task
Auto List<Property Map>Retry Attempts - trace
Levels List<Property Map> - user
Task List<Property Map>Managed Initial Warehouse Sizes - user
Task List<Property Map>Minimum Trigger Interval In Seconds - user
Task List<Property Map>Timeout Ms
DatabaseParameterCatalog, DatabaseParameterCatalogArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterDataRetentionTimeInDay, DatabaseParameterDataRetentionTimeInDayArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterDefaultDdlCollation, DatabaseParameterDefaultDdlCollationArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterDefaultNotebookComputePoolCpus, DatabaseParameterDefaultNotebookComputePoolCpusArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterDefaultNotebookComputePoolGpus, DatabaseParameterDefaultNotebookComputePoolGpusArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterEnableConsoleOutput, DatabaseParameterEnableConsoleOutputArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterExternalVolume, DatabaseParameterExternalVolumeArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterLogEventLevel, DatabaseParameterLogEventLevelArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterLogLevel, DatabaseParameterLogLevelArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterMaxDataExtensionTimeInDay, DatabaseParameterMaxDataExtensionTimeInDayArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterQuotedIdentifiersIgnoreCase, DatabaseParameterQuotedIdentifiersIgnoreCaseArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterReplaceInvalidCharacter, DatabaseParameterReplaceInvalidCharacterArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterStorageSerializationPolicy, DatabaseParameterStorageSerializationPolicyArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterSuspendTaskAfterNumFailure, DatabaseParameterSuspendTaskAfterNumFailureArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterTaskAutoRetryAttempt, DatabaseParameterTaskAutoRetryAttemptArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterTraceLevel, DatabaseParameterTraceLevelArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterUserTaskManagedInitialWarehouseSize, DatabaseParameterUserTaskManagedInitialWarehouseSizeArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterUserTaskMinimumTriggerIntervalInSecond, DatabaseParameterUserTaskMinimumTriggerIntervalInSecondArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseParameterUserTaskTimeoutM, DatabaseParameterUserTaskTimeoutMArgs
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default string
- description string
- key string
- level string
- value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
DatabaseReplication, DatabaseReplicationArgs
- Enable
To List<DatabaseAccounts Replication Enable To Account> - Entry to enable replication and optionally failover for a given account identifier.
- Ignore
Edition boolCheck - Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.
- Enable
To []DatabaseAccounts Replication Enable To Account - Entry to enable replication and optionally failover for a given account identifier.
- Ignore
Edition boolCheck - Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.
- enable_
to_ list(object)accounts - Entry to enable replication and optionally failover for a given account identifier.
- ignore_
edition_ boolcheck - Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.
- enable
To List<DatabaseAccounts Replication Enable To Account> - Entry to enable replication and optionally failover for a given account identifier.
- ignore
Edition BooleanCheck - Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.
- enable
To DatabaseAccounts Replication Enable To Account[] - Entry to enable replication and optionally failover for a given account identifier.
- ignore
Edition booleanCheck - Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.
- enable_
to_ Sequence[Databaseaccounts Replication Enable To Account] - Entry to enable replication and optionally failover for a given account identifier.
- ignore_
edition_ boolcheck - Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.
- enable
To List<Property Map>Accounts - Entry to enable replication and optionally failover for a given account identifier.
- ignore
Edition BooleanCheck - Allows replicating data to accounts on lower editions in either of the following scenarios: 1. The primary database is in a Business Critical (or higher) account but one or more of the accounts approved for replication are on lower editions. Business Critical Edition is intended for Snowflake accounts with extremely sensitive data. 2. The primary database is in a Business Critical (or higher) account and a signed business associate agreement is in place to store PHI data in the account per HIPAA and HITRUST regulations, but no such agreement is in place for one or more of the accounts approved for replication, regardless if they are Business Critical (or higher) accounts. Both scenarios are prohibited by default in an effort to help prevent account administrators for Business Critical (or higher) accounts from inadvertently replicating sensitive data to accounts on lower editions.
DatabaseReplicationEnableToAccount, DatabaseReplicationEnableToAccountArgs
- Account
Identifier string - Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of
"<organization_name>"."<account_name>". For more information about this resource, see docs. - With
Failover bool - Specifies if failover should be enabled for the specified account identifier
- Account
Identifier string - Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of
"<organization_name>"."<account_name>". For more information about this resource, see docs. - With
Failover bool - Specifies if failover should be enabled for the specified account identifier
- account_
identifier string - Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of
"<organization_name>"."<account_name>". For more information about this resource, see docs. - with_
failover bool - Specifies if failover should be enabled for the specified account identifier
- account
Identifier String - Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of
"<organization_name>"."<account_name>". For more information about this resource, see docs. - with
Failover Boolean - Specifies if failover should be enabled for the specified account identifier
- account
Identifier string - Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of
"<organization_name>"."<account_name>". For more information about this resource, see docs. - with
Failover boolean - Specifies if failover should be enabled for the specified account identifier
- account_
identifier str - Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of
"<organization_name>"."<account_name>". For more information about this resource, see docs. - with_
failover bool - Specifies if failover should be enabled for the specified account identifier
- account
Identifier String - Specifies account identifier for which replication should be enabled. The account identifiers should be in the form of
"<organization_name>"."<account_name>". For more information about this resource, see docs. - with
Failover Boolean - Specifies if failover should be enabled for the specified account identifier
Import
Make sure that isTransient and withManagedAccess are set in your config explicitly before import to avoid diff and recreation
(reasons are presented in this migration guide entry).
$ pulumi import snowflake:index/database:Database example '"<database_name>"'
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflakeTerraform Provider.
published on Friday, Nov 6, 2026 by Pulumi