snowflake.CurrentAccount
Explore with Pulumi AI
Import
This resource may contain a random identifier, but the following format is recommended.
$ pulumi import snowflake:index/currentAccount:CurrentAccount example 'current_account'
Create CurrentAccount Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CurrentAccount(name: string, args?: CurrentAccountArgs, opts?: CustomResourceOptions);
@overload
def CurrentAccount(resource_name: str,
args: Optional[CurrentAccountArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def CurrentAccount(resource_name: str,
opts: Optional[ResourceOptions] = None,
abort_detached_query: Optional[bool] = None,
active_python_profiler: Optional[str] = None,
allow_client_mfa_caching: Optional[bool] = None,
allow_id_token: Optional[bool] = None,
authentication_policy: Optional[str] = None,
autocommit: Optional[bool] = None,
base_location_prefix: Optional[str] = None,
binary_input_format: Optional[str] = None,
binary_output_format: Optional[str] = None,
catalog: Optional[str] = None,
catalog_sync: Optional[str] = None,
client_enable_log_info_statement_parameters: Optional[bool] = None,
client_encryption_key_size: Optional[int] = None,
client_memory_limit: Optional[int] = None,
client_metadata_request_use_connection_ctx: Optional[bool] = None,
client_metadata_use_session_database: Optional[bool] = None,
client_prefetch_threads: Optional[int] = None,
client_result_chunk_size: Optional[int] = None,
client_result_column_case_insensitive: Optional[bool] = None,
client_session_keep_alive: Optional[bool] = None,
client_session_keep_alive_heartbeat_frequency: Optional[int] = None,
client_timestamp_type_mapping: Optional[str] = None,
cortex_enabled_cross_region: Optional[str] = None,
cortex_models_allowlist: Optional[str] = None,
csv_timestamp_format: Optional[str] = None,
data_retention_time_in_days: Optional[int] = None,
date_input_format: Optional[str] = None,
date_output_format: Optional[str] = None,
default_ddl_collation: Optional[str] = None,
default_notebook_compute_pool_cpu: Optional[str] = None,
default_notebook_compute_pool_gpu: Optional[str] = None,
default_null_ordering: Optional[str] = None,
default_streamlit_notebook_warehouse: Optional[str] = None,
disable_ui_download_button: Optional[bool] = None,
disable_user_privilege_grants: Optional[bool] = None,
enable_automatic_sensitive_data_classification_log: Optional[bool] = None,
enable_egress_cost_optimizer: Optional[bool] = None,
enable_identifier_first_login: Optional[bool] = None,
enable_internal_stages_privatelink: Optional[bool] = None,
enable_tri_secret_and_rekey_opt_out_for_image_repository: Optional[bool] = None,
enable_tri_secret_and_rekey_opt_out_for_spcs_block_storage: Optional[bool] = None,
enable_unhandled_exceptions_reporting: Optional[bool] = None,
enable_unload_physical_type_optimization: Optional[bool] = None,
enable_unredacted_query_syntax_error: Optional[bool] = None,
enable_unredacted_secure_object_error: Optional[bool] = None,
enforce_network_rules_for_internal_stages: Optional[bool] = None,
error_on_nondeterministic_merge: Optional[bool] = None,
error_on_nondeterministic_update: Optional[bool] = None,
event_table: Optional[str] = None,
external_oauth_add_privileged_roles_to_blocked_list: Optional[bool] = None,
external_volume: Optional[str] = None,
feature_policy: Optional[str] = None,
geography_output_format: Optional[str] = None,
geometry_output_format: Optional[str] = None,
hybrid_table_lock_timeout: Optional[int] = None,
initial_replication_size_limit_in_tb: Optional[str] = None,
jdbc_treat_decimal_as_int: Optional[bool] = None,
jdbc_treat_timestamp_ntz_as_utc: Optional[bool] = None,
jdbc_use_session_timezone: Optional[bool] = None,
js_treat_integer_as_bigint: Optional[bool] = None,
json_indent: Optional[int] = None,
listing_auto_fulfillment_replication_refresh_schedule: Optional[str] = None,
lock_timeout: Optional[int] = None,
log_level: Optional[str] = None,
max_concurrency_level: Optional[int] = None,
max_data_extension_time_in_days: Optional[int] = None,
metric_level: Optional[str] = None,
min_data_retention_time_in_days: Optional[int] = None,
multi_statement_count: Optional[int] = None,
network_policy: Optional[str] = None,
noorder_sequence_as_default: Optional[bool] = None,
oauth_add_privileged_roles_to_blocked_list: Optional[bool] = None,
odbc_treat_decimal_as_int: Optional[bool] = None,
packages_policy: Optional[str] = None,
password_policy: Optional[str] = None,
periodic_data_rekeying: Optional[bool] = None,
pipe_execution_paused: Optional[bool] = None,
prevent_unload_to_inline_url: Optional[bool] = None,
prevent_unload_to_internal_stages: Optional[bool] = None,
python_profiler_modules: Optional[str] = None,
python_profiler_target_stage: Optional[str] = None,
query_tag: Optional[str] = None,
quoted_identifiers_ignore_case: Optional[bool] = None,
replace_invalid_characters: Optional[bool] = None,
require_storage_integration_for_stage_creation: Optional[bool] = None,
require_storage_integration_for_stage_operation: Optional[bool] = None,
resource_monitor: Optional[str] = None,
rows_per_resultset: Optional[int] = None,
s3_stage_vpce_dns_name: Optional[str] = None,
saml_identity_provider: Optional[str] = None,
search_path: Optional[str] = None,
serverless_task_max_statement_size: Optional[str] = None,
serverless_task_min_statement_size: Optional[str] = None,
session_policy: Optional[str] = None,
simulated_data_sharing_consumer: Optional[str] = None,
sso_login_page: Optional[bool] = None,
statement_queued_timeout_in_seconds: Optional[int] = None,
statement_timeout_in_seconds: Optional[int] = None,
storage_serialization_policy: Optional[str] = None,
strict_json_output: Optional[bool] = None,
suspend_task_after_num_failures: Optional[int] = None,
task_auto_retry_attempts: Optional[int] = None,
time_input_format: Optional[str] = None,
time_output_format: Optional[str] = None,
timestamp_day_is_always24h: Optional[bool] = None,
timestamp_input_format: Optional[str] = None,
timestamp_ltz_output_format: Optional[str] = None,
timestamp_ntz_output_format: Optional[str] = None,
timestamp_output_format: Optional[str] = None,
timestamp_type_mapping: Optional[str] = None,
timestamp_tz_output_format: Optional[str] = None,
timezone: Optional[str] = None,
trace_level: Optional[str] = None,
transaction_abort_on_error: Optional[bool] = None,
transaction_default_isolation_level: Optional[str] = None,
two_digit_century_start: Optional[int] = None,
unsupported_ddl_action: Optional[str] = None,
use_cached_result: Optional[bool] = 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,
week_of_year_policy: Optional[int] = None,
week_start: Optional[int] = None)
func NewCurrentAccount(ctx *Context, name string, args *CurrentAccountArgs, opts ...ResourceOption) (*CurrentAccount, error)
public CurrentAccount(string name, CurrentAccountArgs? args = null, CustomResourceOptions? opts = null)
public CurrentAccount(String name, CurrentAccountArgs args)
public CurrentAccount(String name, CurrentAccountArgs args, CustomResourceOptions options)
type: snowflake:CurrentAccount
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CurrentAccountArgs
- 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 CurrentAccountArgs
- 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 CurrentAccountArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CurrentAccountArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CurrentAccountArgs
- 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 currentAccountResource = new Snowflake.CurrentAccount("currentAccountResource", new()
{
AbortDetachedQuery = false,
ActivePythonProfiler = "string",
AllowClientMfaCaching = false,
AllowIdToken = false,
AuthenticationPolicy = "string",
Autocommit = false,
BaseLocationPrefix = "string",
BinaryInputFormat = "string",
BinaryOutputFormat = "string",
Catalog = "string",
CatalogSync = "string",
ClientEnableLogInfoStatementParameters = false,
ClientEncryptionKeySize = 0,
ClientMemoryLimit = 0,
ClientMetadataRequestUseConnectionCtx = false,
ClientMetadataUseSessionDatabase = false,
ClientPrefetchThreads = 0,
ClientResultChunkSize = 0,
ClientResultColumnCaseInsensitive = false,
ClientSessionKeepAlive = false,
ClientSessionKeepAliveHeartbeatFrequency = 0,
ClientTimestampTypeMapping = "string",
CortexEnabledCrossRegion = "string",
CortexModelsAllowlist = "string",
CsvTimestampFormat = "string",
DataRetentionTimeInDays = 0,
DateInputFormat = "string",
DateOutputFormat = "string",
DefaultDdlCollation = "string",
DefaultNotebookComputePoolCpu = "string",
DefaultNotebookComputePoolGpu = "string",
DefaultNullOrdering = "string",
DefaultStreamlitNotebookWarehouse = "string",
DisableUiDownloadButton = false,
DisableUserPrivilegeGrants = false,
EnableAutomaticSensitiveDataClassificationLog = false,
EnableEgressCostOptimizer = false,
EnableIdentifierFirstLogin = false,
EnableInternalStagesPrivatelink = false,
EnableTriSecretAndRekeyOptOutForImageRepository = false,
EnableTriSecretAndRekeyOptOutForSpcsBlockStorage = false,
EnableUnhandledExceptionsReporting = false,
EnableUnloadPhysicalTypeOptimization = false,
EnableUnredactedQuerySyntaxError = false,
EnableUnredactedSecureObjectError = false,
EnforceNetworkRulesForInternalStages = false,
ErrorOnNondeterministicMerge = false,
ErrorOnNondeterministicUpdate = false,
EventTable = "string",
ExternalOauthAddPrivilegedRolesToBlockedList = false,
ExternalVolume = "string",
FeaturePolicy = "string",
GeographyOutputFormat = "string",
GeometryOutputFormat = "string",
HybridTableLockTimeout = 0,
InitialReplicationSizeLimitInTb = "string",
JdbcTreatDecimalAsInt = false,
JdbcTreatTimestampNtzAsUtc = false,
JdbcUseSessionTimezone = false,
JsTreatIntegerAsBigint = false,
JsonIndent = 0,
ListingAutoFulfillmentReplicationRefreshSchedule = "string",
LockTimeout = 0,
LogLevel = "string",
MaxConcurrencyLevel = 0,
MaxDataExtensionTimeInDays = 0,
MetricLevel = "string",
MinDataRetentionTimeInDays = 0,
MultiStatementCount = 0,
NetworkPolicy = "string",
NoorderSequenceAsDefault = false,
OauthAddPrivilegedRolesToBlockedList = false,
OdbcTreatDecimalAsInt = false,
PackagesPolicy = "string",
PasswordPolicy = "string",
PeriodicDataRekeying = false,
PipeExecutionPaused = false,
PreventUnloadToInlineUrl = false,
PreventUnloadToInternalStages = false,
PythonProfilerModules = "string",
PythonProfilerTargetStage = "string",
QueryTag = "string",
QuotedIdentifiersIgnoreCase = false,
ReplaceInvalidCharacters = false,
RequireStorageIntegrationForStageCreation = false,
RequireStorageIntegrationForStageOperation = false,
ResourceMonitor = "string",
RowsPerResultset = 0,
S3StageVpceDnsName = "string",
SamlIdentityProvider = "string",
SearchPath = "string",
ServerlessTaskMaxStatementSize = "string",
ServerlessTaskMinStatementSize = "string",
SessionPolicy = "string",
SimulatedDataSharingConsumer = "string",
SsoLoginPage = false,
StatementQueuedTimeoutInSeconds = 0,
StatementTimeoutInSeconds = 0,
StorageSerializationPolicy = "string",
StrictJsonOutput = false,
SuspendTaskAfterNumFailures = 0,
TaskAutoRetryAttempts = 0,
TimeInputFormat = "string",
TimeOutputFormat = "string",
TimestampDayIsAlways24h = false,
TimestampInputFormat = "string",
TimestampLtzOutputFormat = "string",
TimestampNtzOutputFormat = "string",
TimestampOutputFormat = "string",
TimestampTypeMapping = "string",
TimestampTzOutputFormat = "string",
Timezone = "string",
TraceLevel = "string",
TransactionAbortOnError = false,
TransactionDefaultIsolationLevel = "string",
TwoDigitCenturyStart = 0,
UnsupportedDdlAction = "string",
UseCachedResult = false,
UserTaskManagedInitialWarehouseSize = "string",
UserTaskMinimumTriggerIntervalInSeconds = 0,
UserTaskTimeoutMs = 0,
WeekOfYearPolicy = 0,
WeekStart = 0,
});
example, err := snowflake.NewCurrentAccount(ctx, "currentAccountResource", &snowflake.CurrentAccountArgs{
AbortDetachedQuery: pulumi.Bool(false),
ActivePythonProfiler: pulumi.String("string"),
AllowClientMfaCaching: pulumi.Bool(false),
AllowIdToken: pulumi.Bool(false),
AuthenticationPolicy: pulumi.String("string"),
Autocommit: pulumi.Bool(false),
BaseLocationPrefix: pulumi.String("string"),
BinaryInputFormat: pulumi.String("string"),
BinaryOutputFormat: pulumi.String("string"),
Catalog: pulumi.String("string"),
CatalogSync: pulumi.String("string"),
ClientEnableLogInfoStatementParameters: pulumi.Bool(false),
ClientEncryptionKeySize: pulumi.Int(0),
ClientMemoryLimit: pulumi.Int(0),
ClientMetadataRequestUseConnectionCtx: pulumi.Bool(false),
ClientMetadataUseSessionDatabase: pulumi.Bool(false),
ClientPrefetchThreads: pulumi.Int(0),
ClientResultChunkSize: pulumi.Int(0),
ClientResultColumnCaseInsensitive: pulumi.Bool(false),
ClientSessionKeepAlive: pulumi.Bool(false),
ClientSessionKeepAliveHeartbeatFrequency: pulumi.Int(0),
ClientTimestampTypeMapping: pulumi.String("string"),
CortexEnabledCrossRegion: pulumi.String("string"),
CortexModelsAllowlist: pulumi.String("string"),
CsvTimestampFormat: pulumi.String("string"),
DataRetentionTimeInDays: pulumi.Int(0),
DateInputFormat: pulumi.String("string"),
DateOutputFormat: pulumi.String("string"),
DefaultDdlCollation: pulumi.String("string"),
DefaultNotebookComputePoolCpu: pulumi.String("string"),
DefaultNotebookComputePoolGpu: pulumi.String("string"),
DefaultNullOrdering: pulumi.String("string"),
DefaultStreamlitNotebookWarehouse: pulumi.String("string"),
DisableUiDownloadButton: pulumi.Bool(false),
DisableUserPrivilegeGrants: pulumi.Bool(false),
EnableAutomaticSensitiveDataClassificationLog: pulumi.Bool(false),
EnableEgressCostOptimizer: pulumi.Bool(false),
EnableIdentifierFirstLogin: pulumi.Bool(false),
EnableInternalStagesPrivatelink: pulumi.Bool(false),
EnableTriSecretAndRekeyOptOutForImageRepository: pulumi.Bool(false),
EnableTriSecretAndRekeyOptOutForSpcsBlockStorage: pulumi.Bool(false),
EnableUnhandledExceptionsReporting: pulumi.Bool(false),
EnableUnloadPhysicalTypeOptimization: pulumi.Bool(false),
EnableUnredactedQuerySyntaxError: pulumi.Bool(false),
EnableUnredactedSecureObjectError: pulumi.Bool(false),
EnforceNetworkRulesForInternalStages: pulumi.Bool(false),
ErrorOnNondeterministicMerge: pulumi.Bool(false),
ErrorOnNondeterministicUpdate: pulumi.Bool(false),
EventTable: pulumi.String("string"),
ExternalOauthAddPrivilegedRolesToBlockedList: pulumi.Bool(false),
ExternalVolume: pulumi.String("string"),
FeaturePolicy: pulumi.String("string"),
GeographyOutputFormat: pulumi.String("string"),
GeometryOutputFormat: pulumi.String("string"),
HybridTableLockTimeout: pulumi.Int(0),
InitialReplicationSizeLimitInTb: pulumi.String("string"),
JdbcTreatDecimalAsInt: pulumi.Bool(false),
JdbcTreatTimestampNtzAsUtc: pulumi.Bool(false),
JdbcUseSessionTimezone: pulumi.Bool(false),
JsTreatIntegerAsBigint: pulumi.Bool(false),
JsonIndent: pulumi.Int(0),
ListingAutoFulfillmentReplicationRefreshSchedule: pulumi.String("string"),
LockTimeout: pulumi.Int(0),
LogLevel: pulumi.String("string"),
MaxConcurrencyLevel: pulumi.Int(0),
MaxDataExtensionTimeInDays: pulumi.Int(0),
MetricLevel: pulumi.String("string"),
MinDataRetentionTimeInDays: pulumi.Int(0),
MultiStatementCount: pulumi.Int(0),
NetworkPolicy: pulumi.String("string"),
NoorderSequenceAsDefault: pulumi.Bool(false),
OauthAddPrivilegedRolesToBlockedList: pulumi.Bool(false),
OdbcTreatDecimalAsInt: pulumi.Bool(false),
PackagesPolicy: pulumi.String("string"),
PasswordPolicy: pulumi.String("string"),
PeriodicDataRekeying: pulumi.Bool(false),
PipeExecutionPaused: pulumi.Bool(false),
PreventUnloadToInlineUrl: pulumi.Bool(false),
PreventUnloadToInternalStages: pulumi.Bool(false),
PythonProfilerModules: pulumi.String("string"),
PythonProfilerTargetStage: pulumi.String("string"),
QueryTag: pulumi.String("string"),
QuotedIdentifiersIgnoreCase: pulumi.Bool(false),
ReplaceInvalidCharacters: pulumi.Bool(false),
RequireStorageIntegrationForStageCreation: pulumi.Bool(false),
RequireStorageIntegrationForStageOperation: pulumi.Bool(false),
ResourceMonitor: pulumi.String("string"),
RowsPerResultset: pulumi.Int(0),
S3StageVpceDnsName: pulumi.String("string"),
SamlIdentityProvider: pulumi.String("string"),
SearchPath: pulumi.String("string"),
ServerlessTaskMaxStatementSize: pulumi.String("string"),
ServerlessTaskMinStatementSize: pulumi.String("string"),
SessionPolicy: pulumi.String("string"),
SimulatedDataSharingConsumer: pulumi.String("string"),
SsoLoginPage: pulumi.Bool(false),
StatementQueuedTimeoutInSeconds: pulumi.Int(0),
StatementTimeoutInSeconds: pulumi.Int(0),
StorageSerializationPolicy: pulumi.String("string"),
StrictJsonOutput: pulumi.Bool(false),
SuspendTaskAfterNumFailures: pulumi.Int(0),
TaskAutoRetryAttempts: pulumi.Int(0),
TimeInputFormat: pulumi.String("string"),
TimeOutputFormat: pulumi.String("string"),
TimestampDayIsAlways24h: pulumi.Bool(false),
TimestampInputFormat: pulumi.String("string"),
TimestampLtzOutputFormat: pulumi.String("string"),
TimestampNtzOutputFormat: pulumi.String("string"),
TimestampOutputFormat: pulumi.String("string"),
TimestampTypeMapping: pulumi.String("string"),
TimestampTzOutputFormat: pulumi.String("string"),
Timezone: pulumi.String("string"),
TraceLevel: pulumi.String("string"),
TransactionAbortOnError: pulumi.Bool(false),
TransactionDefaultIsolationLevel: pulumi.String("string"),
TwoDigitCenturyStart: pulumi.Int(0),
UnsupportedDdlAction: pulumi.String("string"),
UseCachedResult: pulumi.Bool(false),
UserTaskManagedInitialWarehouseSize: pulumi.String("string"),
UserTaskMinimumTriggerIntervalInSeconds: pulumi.Int(0),
UserTaskTimeoutMs: pulumi.Int(0),
WeekOfYearPolicy: pulumi.Int(0),
WeekStart: pulumi.Int(0),
})
var currentAccountResource = new CurrentAccount("currentAccountResource", CurrentAccountArgs.builder()
.abortDetachedQuery(false)
.activePythonProfiler("string")
.allowClientMfaCaching(false)
.allowIdToken(false)
.authenticationPolicy("string")
.autocommit(false)
.baseLocationPrefix("string")
.binaryInputFormat("string")
.binaryOutputFormat("string")
.catalog("string")
.catalogSync("string")
.clientEnableLogInfoStatementParameters(false)
.clientEncryptionKeySize(0)
.clientMemoryLimit(0)
.clientMetadataRequestUseConnectionCtx(false)
.clientMetadataUseSessionDatabase(false)
.clientPrefetchThreads(0)
.clientResultChunkSize(0)
.clientResultColumnCaseInsensitive(false)
.clientSessionKeepAlive(false)
.clientSessionKeepAliveHeartbeatFrequency(0)
.clientTimestampTypeMapping("string")
.cortexEnabledCrossRegion("string")
.cortexModelsAllowlist("string")
.csvTimestampFormat("string")
.dataRetentionTimeInDays(0)
.dateInputFormat("string")
.dateOutputFormat("string")
.defaultDdlCollation("string")
.defaultNotebookComputePoolCpu("string")
.defaultNotebookComputePoolGpu("string")
.defaultNullOrdering("string")
.defaultStreamlitNotebookWarehouse("string")
.disableUiDownloadButton(false)
.disableUserPrivilegeGrants(false)
.enableAutomaticSensitiveDataClassificationLog(false)
.enableEgressCostOptimizer(false)
.enableIdentifierFirstLogin(false)
.enableInternalStagesPrivatelink(false)
.enableTriSecretAndRekeyOptOutForImageRepository(false)
.enableTriSecretAndRekeyOptOutForSpcsBlockStorage(false)
.enableUnhandledExceptionsReporting(false)
.enableUnloadPhysicalTypeOptimization(false)
.enableUnredactedQuerySyntaxError(false)
.enableUnredactedSecureObjectError(false)
.enforceNetworkRulesForInternalStages(false)
.errorOnNondeterministicMerge(false)
.errorOnNondeterministicUpdate(false)
.eventTable("string")
.externalOauthAddPrivilegedRolesToBlockedList(false)
.externalVolume("string")
.featurePolicy("string")
.geographyOutputFormat("string")
.geometryOutputFormat("string")
.hybridTableLockTimeout(0)
.initialReplicationSizeLimitInTb("string")
.jdbcTreatDecimalAsInt(false)
.jdbcTreatTimestampNtzAsUtc(false)
.jdbcUseSessionTimezone(false)
.jsTreatIntegerAsBigint(false)
.jsonIndent(0)
.listingAutoFulfillmentReplicationRefreshSchedule("string")
.lockTimeout(0)
.logLevel("string")
.maxConcurrencyLevel(0)
.maxDataExtensionTimeInDays(0)
.metricLevel("string")
.minDataRetentionTimeInDays(0)
.multiStatementCount(0)
.networkPolicy("string")
.noorderSequenceAsDefault(false)
.oauthAddPrivilegedRolesToBlockedList(false)
.odbcTreatDecimalAsInt(false)
.packagesPolicy("string")
.passwordPolicy("string")
.periodicDataRekeying(false)
.pipeExecutionPaused(false)
.preventUnloadToInlineUrl(false)
.preventUnloadToInternalStages(false)
.pythonProfilerModules("string")
.pythonProfilerTargetStage("string")
.queryTag("string")
.quotedIdentifiersIgnoreCase(false)
.replaceInvalidCharacters(false)
.requireStorageIntegrationForStageCreation(false)
.requireStorageIntegrationForStageOperation(false)
.resourceMonitor("string")
.rowsPerResultset(0)
.s3StageVpceDnsName("string")
.samlIdentityProvider("string")
.searchPath("string")
.serverlessTaskMaxStatementSize("string")
.serverlessTaskMinStatementSize("string")
.sessionPolicy("string")
.simulatedDataSharingConsumer("string")
.ssoLoginPage(false)
.statementQueuedTimeoutInSeconds(0)
.statementTimeoutInSeconds(0)
.storageSerializationPolicy("string")
.strictJsonOutput(false)
.suspendTaskAfterNumFailures(0)
.taskAutoRetryAttempts(0)
.timeInputFormat("string")
.timeOutputFormat("string")
.timestampDayIsAlways24h(false)
.timestampInputFormat("string")
.timestampLtzOutputFormat("string")
.timestampNtzOutputFormat("string")
.timestampOutputFormat("string")
.timestampTypeMapping("string")
.timestampTzOutputFormat("string")
.timezone("string")
.traceLevel("string")
.transactionAbortOnError(false)
.transactionDefaultIsolationLevel("string")
.twoDigitCenturyStart(0)
.unsupportedDdlAction("string")
.useCachedResult(false)
.userTaskManagedInitialWarehouseSize("string")
.userTaskMinimumTriggerIntervalInSeconds(0)
.userTaskTimeoutMs(0)
.weekOfYearPolicy(0)
.weekStart(0)
.build());
current_account_resource = snowflake.CurrentAccount("currentAccountResource",
abort_detached_query=False,
active_python_profiler="string",
allow_client_mfa_caching=False,
allow_id_token=False,
authentication_policy="string",
autocommit=False,
base_location_prefix="string",
binary_input_format="string",
binary_output_format="string",
catalog="string",
catalog_sync="string",
client_enable_log_info_statement_parameters=False,
client_encryption_key_size=0,
client_memory_limit=0,
client_metadata_request_use_connection_ctx=False,
client_metadata_use_session_database=False,
client_prefetch_threads=0,
client_result_chunk_size=0,
client_result_column_case_insensitive=False,
client_session_keep_alive=False,
client_session_keep_alive_heartbeat_frequency=0,
client_timestamp_type_mapping="string",
cortex_enabled_cross_region="string",
cortex_models_allowlist="string",
csv_timestamp_format="string",
data_retention_time_in_days=0,
date_input_format="string",
date_output_format="string",
default_ddl_collation="string",
default_notebook_compute_pool_cpu="string",
default_notebook_compute_pool_gpu="string",
default_null_ordering="string",
default_streamlit_notebook_warehouse="string",
disable_ui_download_button=False,
disable_user_privilege_grants=False,
enable_automatic_sensitive_data_classification_log=False,
enable_egress_cost_optimizer=False,
enable_identifier_first_login=False,
enable_internal_stages_privatelink=False,
enable_tri_secret_and_rekey_opt_out_for_image_repository=False,
enable_tri_secret_and_rekey_opt_out_for_spcs_block_storage=False,
enable_unhandled_exceptions_reporting=False,
enable_unload_physical_type_optimization=False,
enable_unredacted_query_syntax_error=False,
enable_unredacted_secure_object_error=False,
enforce_network_rules_for_internal_stages=False,
error_on_nondeterministic_merge=False,
error_on_nondeterministic_update=False,
event_table="string",
external_oauth_add_privileged_roles_to_blocked_list=False,
external_volume="string",
feature_policy="string",
geography_output_format="string",
geometry_output_format="string",
hybrid_table_lock_timeout=0,
initial_replication_size_limit_in_tb="string",
jdbc_treat_decimal_as_int=False,
jdbc_treat_timestamp_ntz_as_utc=False,
jdbc_use_session_timezone=False,
js_treat_integer_as_bigint=False,
json_indent=0,
listing_auto_fulfillment_replication_refresh_schedule="string",
lock_timeout=0,
log_level="string",
max_concurrency_level=0,
max_data_extension_time_in_days=0,
metric_level="string",
min_data_retention_time_in_days=0,
multi_statement_count=0,
network_policy="string",
noorder_sequence_as_default=False,
oauth_add_privileged_roles_to_blocked_list=False,
odbc_treat_decimal_as_int=False,
packages_policy="string",
password_policy="string",
periodic_data_rekeying=False,
pipe_execution_paused=False,
prevent_unload_to_inline_url=False,
prevent_unload_to_internal_stages=False,
python_profiler_modules="string",
python_profiler_target_stage="string",
query_tag="string",
quoted_identifiers_ignore_case=False,
replace_invalid_characters=False,
require_storage_integration_for_stage_creation=False,
require_storage_integration_for_stage_operation=False,
resource_monitor="string",
rows_per_resultset=0,
s3_stage_vpce_dns_name="string",
saml_identity_provider="string",
search_path="string",
serverless_task_max_statement_size="string",
serverless_task_min_statement_size="string",
session_policy="string",
simulated_data_sharing_consumer="string",
sso_login_page=False,
statement_queued_timeout_in_seconds=0,
statement_timeout_in_seconds=0,
storage_serialization_policy="string",
strict_json_output=False,
suspend_task_after_num_failures=0,
task_auto_retry_attempts=0,
time_input_format="string",
time_output_format="string",
timestamp_day_is_always24h=False,
timestamp_input_format="string",
timestamp_ltz_output_format="string",
timestamp_ntz_output_format="string",
timestamp_output_format="string",
timestamp_type_mapping="string",
timestamp_tz_output_format="string",
timezone="string",
trace_level="string",
transaction_abort_on_error=False,
transaction_default_isolation_level="string",
two_digit_century_start=0,
unsupported_ddl_action="string",
use_cached_result=False,
user_task_managed_initial_warehouse_size="string",
user_task_minimum_trigger_interval_in_seconds=0,
user_task_timeout_ms=0,
week_of_year_policy=0,
week_start=0)
const currentAccountResource = new snowflake.CurrentAccount("currentAccountResource", {
abortDetachedQuery: false,
activePythonProfiler: "string",
allowClientMfaCaching: false,
allowIdToken: false,
authenticationPolicy: "string",
autocommit: false,
baseLocationPrefix: "string",
binaryInputFormat: "string",
binaryOutputFormat: "string",
catalog: "string",
catalogSync: "string",
clientEnableLogInfoStatementParameters: false,
clientEncryptionKeySize: 0,
clientMemoryLimit: 0,
clientMetadataRequestUseConnectionCtx: false,
clientMetadataUseSessionDatabase: false,
clientPrefetchThreads: 0,
clientResultChunkSize: 0,
clientResultColumnCaseInsensitive: false,
clientSessionKeepAlive: false,
clientSessionKeepAliveHeartbeatFrequency: 0,
clientTimestampTypeMapping: "string",
cortexEnabledCrossRegion: "string",
cortexModelsAllowlist: "string",
csvTimestampFormat: "string",
dataRetentionTimeInDays: 0,
dateInputFormat: "string",
dateOutputFormat: "string",
defaultDdlCollation: "string",
defaultNotebookComputePoolCpu: "string",
defaultNotebookComputePoolGpu: "string",
defaultNullOrdering: "string",
defaultStreamlitNotebookWarehouse: "string",
disableUiDownloadButton: false,
disableUserPrivilegeGrants: false,
enableAutomaticSensitiveDataClassificationLog: false,
enableEgressCostOptimizer: false,
enableIdentifierFirstLogin: false,
enableInternalStagesPrivatelink: false,
enableTriSecretAndRekeyOptOutForImageRepository: false,
enableTriSecretAndRekeyOptOutForSpcsBlockStorage: false,
enableUnhandledExceptionsReporting: false,
enableUnloadPhysicalTypeOptimization: false,
enableUnredactedQuerySyntaxError: false,
enableUnredactedSecureObjectError: false,
enforceNetworkRulesForInternalStages: false,
errorOnNondeterministicMerge: false,
errorOnNondeterministicUpdate: false,
eventTable: "string",
externalOauthAddPrivilegedRolesToBlockedList: false,
externalVolume: "string",
featurePolicy: "string",
geographyOutputFormat: "string",
geometryOutputFormat: "string",
hybridTableLockTimeout: 0,
initialReplicationSizeLimitInTb: "string",
jdbcTreatDecimalAsInt: false,
jdbcTreatTimestampNtzAsUtc: false,
jdbcUseSessionTimezone: false,
jsTreatIntegerAsBigint: false,
jsonIndent: 0,
listingAutoFulfillmentReplicationRefreshSchedule: "string",
lockTimeout: 0,
logLevel: "string",
maxConcurrencyLevel: 0,
maxDataExtensionTimeInDays: 0,
metricLevel: "string",
minDataRetentionTimeInDays: 0,
multiStatementCount: 0,
networkPolicy: "string",
noorderSequenceAsDefault: false,
oauthAddPrivilegedRolesToBlockedList: false,
odbcTreatDecimalAsInt: false,
packagesPolicy: "string",
passwordPolicy: "string",
periodicDataRekeying: false,
pipeExecutionPaused: false,
preventUnloadToInlineUrl: false,
preventUnloadToInternalStages: false,
pythonProfilerModules: "string",
pythonProfilerTargetStage: "string",
queryTag: "string",
quotedIdentifiersIgnoreCase: false,
replaceInvalidCharacters: false,
requireStorageIntegrationForStageCreation: false,
requireStorageIntegrationForStageOperation: false,
resourceMonitor: "string",
rowsPerResultset: 0,
s3StageVpceDnsName: "string",
samlIdentityProvider: "string",
searchPath: "string",
serverlessTaskMaxStatementSize: "string",
serverlessTaskMinStatementSize: "string",
sessionPolicy: "string",
simulatedDataSharingConsumer: "string",
ssoLoginPage: false,
statementQueuedTimeoutInSeconds: 0,
statementTimeoutInSeconds: 0,
storageSerializationPolicy: "string",
strictJsonOutput: false,
suspendTaskAfterNumFailures: 0,
taskAutoRetryAttempts: 0,
timeInputFormat: "string",
timeOutputFormat: "string",
timestampDayIsAlways24h: false,
timestampInputFormat: "string",
timestampLtzOutputFormat: "string",
timestampNtzOutputFormat: "string",
timestampOutputFormat: "string",
timestampTypeMapping: "string",
timestampTzOutputFormat: "string",
timezone: "string",
traceLevel: "string",
transactionAbortOnError: false,
transactionDefaultIsolationLevel: "string",
twoDigitCenturyStart: 0,
unsupportedDdlAction: "string",
useCachedResult: false,
userTaskManagedInitialWarehouseSize: "string",
userTaskMinimumTriggerIntervalInSeconds: 0,
userTaskTimeoutMs: 0,
weekOfYearPolicy: 0,
weekStart: 0,
});
type: snowflake:CurrentAccount
properties:
abortDetachedQuery: false
activePythonProfiler: string
allowClientMfaCaching: false
allowIdToken: false
authenticationPolicy: string
autocommit: false
baseLocationPrefix: string
binaryInputFormat: string
binaryOutputFormat: string
catalog: string
catalogSync: string
clientEnableLogInfoStatementParameters: false
clientEncryptionKeySize: 0
clientMemoryLimit: 0
clientMetadataRequestUseConnectionCtx: false
clientMetadataUseSessionDatabase: false
clientPrefetchThreads: 0
clientResultChunkSize: 0
clientResultColumnCaseInsensitive: false
clientSessionKeepAlive: false
clientSessionKeepAliveHeartbeatFrequency: 0
clientTimestampTypeMapping: string
cortexEnabledCrossRegion: string
cortexModelsAllowlist: string
csvTimestampFormat: string
dataRetentionTimeInDays: 0
dateInputFormat: string
dateOutputFormat: string
defaultDdlCollation: string
defaultNotebookComputePoolCpu: string
defaultNotebookComputePoolGpu: string
defaultNullOrdering: string
defaultStreamlitNotebookWarehouse: string
disableUiDownloadButton: false
disableUserPrivilegeGrants: false
enableAutomaticSensitiveDataClassificationLog: false
enableEgressCostOptimizer: false
enableIdentifierFirstLogin: false
enableInternalStagesPrivatelink: false
enableTriSecretAndRekeyOptOutForImageRepository: false
enableTriSecretAndRekeyOptOutForSpcsBlockStorage: false
enableUnhandledExceptionsReporting: false
enableUnloadPhysicalTypeOptimization: false
enableUnredactedQuerySyntaxError: false
enableUnredactedSecureObjectError: false
enforceNetworkRulesForInternalStages: false
errorOnNondeterministicMerge: false
errorOnNondeterministicUpdate: false
eventTable: string
externalOauthAddPrivilegedRolesToBlockedList: false
externalVolume: string
featurePolicy: string
geographyOutputFormat: string
geometryOutputFormat: string
hybridTableLockTimeout: 0
initialReplicationSizeLimitInTb: string
jdbcTreatDecimalAsInt: false
jdbcTreatTimestampNtzAsUtc: false
jdbcUseSessionTimezone: false
jsTreatIntegerAsBigint: false
jsonIndent: 0
listingAutoFulfillmentReplicationRefreshSchedule: string
lockTimeout: 0
logLevel: string
maxConcurrencyLevel: 0
maxDataExtensionTimeInDays: 0
metricLevel: string
minDataRetentionTimeInDays: 0
multiStatementCount: 0
networkPolicy: string
noorderSequenceAsDefault: false
oauthAddPrivilegedRolesToBlockedList: false
odbcTreatDecimalAsInt: false
packagesPolicy: string
passwordPolicy: string
periodicDataRekeying: false
pipeExecutionPaused: false
preventUnloadToInlineUrl: false
preventUnloadToInternalStages: false
pythonProfilerModules: string
pythonProfilerTargetStage: string
queryTag: string
quotedIdentifiersIgnoreCase: false
replaceInvalidCharacters: false
requireStorageIntegrationForStageCreation: false
requireStorageIntegrationForStageOperation: false
resourceMonitor: string
rowsPerResultset: 0
s3StageVpceDnsName: string
samlIdentityProvider: string
searchPath: string
serverlessTaskMaxStatementSize: string
serverlessTaskMinStatementSize: string
sessionPolicy: string
simulatedDataSharingConsumer: string
ssoLoginPage: false
statementQueuedTimeoutInSeconds: 0
statementTimeoutInSeconds: 0
storageSerializationPolicy: string
strictJsonOutput: false
suspendTaskAfterNumFailures: 0
taskAutoRetryAttempts: 0
timeInputFormat: string
timeOutputFormat: string
timestampDayIsAlways24h: false
timestampInputFormat: string
timestampLtzOutputFormat: string
timestampNtzOutputFormat: string
timestampOutputFormat: string
timestampTypeMapping: string
timestampTzOutputFormat: string
timezone: string
traceLevel: string
transactionAbortOnError: false
transactionDefaultIsolationLevel: string
twoDigitCenturyStart: 0
unsupportedDdlAction: string
useCachedResult: false
userTaskManagedInitialWarehouseSize: string
userTaskMinimumTriggerIntervalInSeconds: 0
userTaskTimeoutMs: 0
weekOfYearPolicy: 0
weekStart: 0
CurrentAccount 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 CurrentAccount resource accepts the following input properties:
- Abort
Detached boolQuery - Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check ABORTDETACHEDQUERY docs.
- Active
Python stringProfiler - Sets the profiler to use for the session when profiling Python handler code. Valid values are (case-insensitive):
LINE
|MEMORY
. For more information, check ACTIVEPYTHONPROFILER docs. - Allow
Client boolMfa Caching - Specifies whether an MFA token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to respond to an MFA prompt at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using MFA token caching to minimize the number of prompts during authentication — optional. For more information, check ALLOWCLIENTMFA_CACHING docs.
- Allow
Id boolToken - Specifies whether a connection token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to enter login credentials at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using connection caching to minimize the number of prompts for authentication — optional. For more information, check ALLOWIDTOKEN docs.
- Authentication
Policy string - Specifies authentication policy for the current account.
- Autocommit bool
- Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see Transactions. For more information, check AUTOCOMMIT docs.
- Base
Location stringPrefix - Specifies a prefix for Snowflake to use in the write path for Snowflake-managed Apache Iceberg™ tables. For more information, see data and metadata directories for Iceberg tables. For more information, check BASELOCATIONPREFIX docs.
- Binary
Input stringFormat - The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
|UTF8
. For more information, check BINARYINPUTFORMAT docs. - Binary
Output stringFormat - The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
. For more information, check BINARYOUTPUTFORMAT docs. - Catalog string
- Specifies the catalog for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG docs. - Catalog
Sync string - Specifies the name of your catalog integration for Snowflake Open Catalog. Snowflake syncs tables that use the specified catalog integration with your Snowflake Open Catalog account. For more information, see Sync a Snowflake-managed table with Snowflake Open Catalog. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG_SYNC docs. - Client
Enable boolLog Info Statement Parameters - Enables users to log the data values bound to PreparedStatements (more details). For more information, check CLIENTENABLELOGINFOSTATEMENT_PARAMETERS docs.
- Client
Encryption intKey Size - Specifies the AES encryption key size, in bits, used by Snowflake to encrypt/decrypt files stored on internal stages (for loading/unloading data) when you use the SNOWFLAKEFULL encryption type. For more information, check ENCRYPTIONKEYSIZE docsCLIENT.
- Client
Memory intLimit - Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check CLIENTMEMORYLIMIT docs.
- Client
Metadata boolRequest Use Connection Ctx - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check CLIENTMETADATAREQUESTUSECONNECTION_CTX docs.
- Client
Metadata boolUse Session Database - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases to the current database. The narrower search typically returns fewer rows and executes more quickly (more details on the usage). For more information, check CLIENTMETADATAUSESESSIONDATABASE docs.
- Client
Prefetch intThreads - Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check CLIENTPREFETCHTHREADS docs.
- Client
Result intChunk Size - Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check CLIENTRESULTCHUNK_SIZE docs.
- Client
Result boolColumn Case Insensitive - Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
- Client
Session boolKeep Alive - Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check CLIENTSESSIONKEEP_ALIVE docs.
- Client
Session intKeep Alive Heartbeat Frequency - Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
- Client
Timestamp stringType Mapping - Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs. - Cortex
Enabled stringCross Region - Specifies the regions where an inference request may be processed in case the request cannot be processed in the region where request is originally placed. Specifying DISABLED disables cross-region inferencing. For examples and details, see Cross-region inference. For more information, check CORTEXENABLEDCROSS_REGION docs.
- Cortex
Models stringAllowlist - Specifies the models that users in the account can access. Use this parameter to allowlist models for all users in the account. If you need to provide specific users with access beyond what you’ve specified in the allowlist, use role-based access control instead. For more information, see Model allowlist. For more information, check CORTEXMODELSALLOWLIST docs.
- Csv
Timestamp stringFormat - Specifies the format for TIMESTAMP values in CSV files downloaded from Snowsight. If this parameter is not set, TIMESTAMPLTZOUTPUT_FORMAT will be used for TIMESTAMPLTZ values, TZ*OUTPUT_FORMATTIMESTAMP will be used for TIMESTAMPTZ and NTZOUTPUTFORMATTIMESTAMP for TIMESTAMPNTZ values. For more information, see Date and time input and output formats or Download your query results. For more information, check TIMESTAMP*FORMAT docsCSV.
- Data
Retention intTime In Days - Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database, schema, or table. For more information, see Understanding & using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- Date
Input stringFormat - Specifies the input format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEINPUTFORMAT docs.
- Date
Output stringFormat - Specifies the display format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEOUTPUTFORMAT docs.
- Default
Ddl stringCollation - Sets the default collation used for the following DDL operations: CREATE TABLE, ALTER TABLE … ADD COLUMN. Setting this parameter forces all subsequently-created columns in the affected objects (table, schema, database, or account) to have the specified collation as the default, unless the collation for the column is explicitly defined in the DDL. For more information, check DEFAULTDDLCOLLATION docs.
- Default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs. - Default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs. - Default
Null stringOrdering - Specifies the default ordering of NULL values in a result set (more details). Valid values are (case-insensitive):
FIRST
|LAST
. For more information, check DEFAULTNULLORDERING docs. - Default
Streamlit stringNotebook Warehouse - Specifies the name of the default warehouse to use when creating a notebook. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTSTREAMLITNOTEBOOK_WAREHOUSE docs. - bool
- Controls whether users in an account see a button to download data in Snowsight or the Classic Console, such as a table returned from running a query in a worksheet. If the button to download is hidden in Snowsight or the Classic Console, users can still download or export data using third-party software. For more information, check DISABLEUIDOWNLOAD_BUTTON docs.
- Disable
User boolPrivilege Grants - Controls whether users in an account can grant privileges directly to other users. Disabling user privilege grants (that is, setting DISABLEUSERPRIVILEGEGRANTS to TRUE) does not affect existing grants to users. Existing grants to users continue to confer privileges to those users. For more information, see GRANT \n\n … TO USER. For more information, check USERPRIVILEGEGRANTS docsDISABLE.
- Enable
Automatic boolSensitive Data Classification Log - Controls whether events from automatic sensitive data classification are logged in the user event table. For more information, check ENABLEAUTOMATICSENSITIVEDATACLASSIFICATION_LOG docs.
- Enable
Egress boolCost Optimizer - Enables or disables the Listing Cross-cloud auto-fulfillment Egress cost optimizer. For more information, check ENABLEEGRESSCOST_OPTIMIZER docs.
- Enable
Identifier boolFirst Login - Determines the login flow for users. When enabled, Snowflake prompts users for their username or email address before presenting authentication methods. For details, see Identifier-first login. For more information, check ENABLEIDENTIFIERFIRST_LOGIN docs.
- Enable
Internal boolStages Privatelink - Specifies whether the SYSTEM$GETPRIVATELINKCONFIG function returns the private-internal-stages key in the query result. The corresponding value in the query result is used during the configuration process for private connectivity to internal stages. For more information, check ENABLEINTERNALSTAGES_PRIVATELINK docs.
- Enable
Tri boolSecret And Rekey Opt Out For Image Repository - Specifies choice for the image repository to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORIMAGE_REPOSITORY docs.
- Enable
Tri boolSecret And Rekey Opt Out For Spcs Block Storage - Specifies the choice for the Snowpark Container Services block storage volume to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORSPCSBLOCKSTORAGE docs.
- Enable
Unhandled boolExceptions Reporting - Specifies whether Snowflake may capture – in an event table – log messages or trace event data for unhandled exceptions in procedure or UDF handler code. For more information, see Capturing messages from unhandled exceptions. For more information, check ENABLEUNHANDLEDEXCEPTIONS_REPORTING docs.
- Enable
Unload boolPhysical Type Optimization - Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check ENABLEUNLOADPHYSICALTYPEOPTIMIZATION docs.
- Enable
Unredacted boolQuery Syntax Error - Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If FALSE, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDQUERYSYNTAXERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check UNREDACTEDQUERYSYNTAXERROR docsENABLE.
- Enable
Unredacted boolSecure Object Error - Controls whether error messages related to secure objects are redacted in metadata. For more information, see Secure objects: Redaction of information in error messages. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDSECUREOBJECTERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the redacted error messages in metadata, not the user who caused the error. For more information, check UNREDACTEDSECUREOBJECTERROR docsENABLE.
- Enforce
Network boolRules For Internal Stages - Specifies whether a network policy that uses network rules can restrict access to AWS internal stages. This parameter has no effect on network policies that do not use network rules. This account-level parameter affects both account-level and user-level network policies. For details about using network policies and network rules to restrict access to AWS internal stages, including the use of this parameter, see Protecting internal stages on AWS. For more information, check ENFORCENETWORKRULESFORINTERNAL_STAGES docs.
- Error
On boolNondeterministic Merge - Specifies whether to return an error when the MERGE command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_MERGE docs.
- Error
On boolNondeterministic Update - Specifies whether to return an error when the UPDATE command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_UPDATE docs.
- Event
Table string - Specifies the name of the event table for logging messages from stored procedures and UDFs contained by the object with which the event table is associated. Associating an event table with a database is available in Enterprise Edition or higher. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EVENT_TABLE docs. - External
Oauth boolAdd Privileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from the External OAuth authorization server. For more information, check EXTERNALOAUTHADDPRIVILEGEDROLESTOBLOCKED_LIST docs.
- External
Volume string - Specifies the external volume for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EXTERNAL_VOLUME docs. - Feature
Policy string - Specifies feature policy for the current account.
- Geography
Output stringFormat - Display format for GEOGRAPHY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOGRAPHYOUTPUTFORMAT docs. - Geometry
Output stringFormat - Display format for GEOMETRY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOMETRYOUTPUTFORMAT docs. - Hybrid
Table intLock Timeout - Number of seconds to wait while trying to acquire row-level locks on a hybrid table, before timing out and aborting the statement. For more information, check HYBRIDTABLELOCK_TIMEOUT docs.
- Initial
Replication stringSize Limit In Tb - Sets the maximum estimated size limit for the initial replication of a primary database to a secondary database (in TB). Set this parameter on any account that stores a secondary database. This size limit helps prevent accounts from accidentally incurring large database replication charges. To remove the size limit, set the value to 0.0. It is required to pass numbers with scale of at least 1 (e.g. 20.5, 32.25, 33.333, etc.). For more information, check INITIALREPLICATIONSIZELIMITIN_TB docs.
- Jdbc
Treat boolDecimal As Int - Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
- Jdbc
Treat boolTimestamp Ntz As Utc - Specifies how JDBC processes TIMESTAMPNTZ values (more details). For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
- Jdbc
Use boolSession Timezone - Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the TIMEZONE parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check JDBCUSESESSION_TIMEZONE docs.
- Js
Treat boolInteger As Bigint - Specifies how the Snowflake Node.js Driver processes numeric columns that have a scale of zero (0), for example INTEGER or NUMBER(p, 0). For more information, check JSTREATINTEGERASBIGINT docs.
- Json
Indent int - Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check JSON_INDENT docs.
- Listing
Auto stringFulfillment Replication Refresh Schedule - Sets the time interval used to refresh the application package based data products to other regions. For more information, check LISTINGAUTOFULFILLMENTREPLICATIONREFRESH_SCHEDULE docs.
- Lock
Timeout int - Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check LOCK_TIMEOUT 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. For more information about log levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
TRACE
|DEBUG
|INFO
|WARN
|ERROR
|FATAL
|OFF
. For more information, check LOG_LEVEL docs. - Max
Concurrency intLevel - Specifies the concurrency level for SQL statements (that is, queries and DML) executed by a warehouse (more details). For more information, check MAXCONCURRENCYLEVEL docs.
- Max
Data intExtension Time In Days - Maximum number of days Snowflake can extend the data retention period for tables to prevent streams on the tables from becoming stale. By default, if the DATARETENTIONTIMEINDAYS setting for a source table is less than 14 days, and a stream has not been consumed, Snowflake temporarily extends this period to the stream’s offset, up to a maximum of 14 days, regardless of the Snowflake Edition for your account. The MAXDATAEXTENSIONTIMEINDAYS parameter enables you to limit this automatic extension period to control storage costs for data retention or for compliance reasons. For more information, check DATAEXTENSIONTIMEINDAYS docsMAX.
- Metric
Level string - Controls how metrics data is ingested into the event table. For more information about metric levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
ALL
|NONE
. For more information, check METRIC_LEVEL docs. - Min
Data intRetention Time In Days - Minimum number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on an object. If a minimum number of days for data retention is set on an account, the data retention period for an object is determined by MAX(DATARETENTIONTIMEINDAYS, MINDATARETENTIONTIMEINDAYS). For more information, check DATARETENTIONTIMEINDAYS docsMIN.
- Multi
Statement intCount - Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
- Network
Policy string - Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see Controlling network traffic with network policies. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check NETWORK_POLICY docs. - Noorder
Sequence boolAs Default - Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in increasing or decreasing order. For more information, check NOORDERSEQUENCEAS_DEFAULT docs.
- Oauth
Add boolPrivileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from Snowflake’s authorization server. For more information, check OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST docs.
- Odbc
Treat boolDecimal As Int - Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
- Packages
Policy string - Specifies packages policy for the current account.
- Password
Policy string - Specifies password policy for the current account.
- Periodic
Data boolRekeying - It enables/disables re-encryption of table data with new keys on a yearly basis to provide additional levels of data protection (more details). For more information, check PERIODICDATAREKEYING docs.
- Pipe
Execution boolPaused - Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role (more details). For more information, check PIPEEXECUTIONPAUSED docs.
- Prevent
Unload boolTo Inline Url - Specifies whether to prevent ad hoc data unload operations to external cloud storage locations (that is, COPY INTO location statements that specify the cloud storage URL and access settings directly in the statement). For an example, see Unloading data from a table directly to files in an external location. For more information, check PREVENTUNLOADTOINLINEURL docs.
- Prevent
Unload boolTo Internal Stages - Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO location statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
- Python
Profiler stringModules - Specifies the list of Python modules to include in a report when profiling Python handler code. For more information, check PYTHONPROFILERMODULES docs.
- Python
Profiler stringTarget Stage - Specifies the fully-qualified name of the stage in which to save a report when profiling Python handler code. For more information, check PYTHONPROFILERTARGET_STAGE docs.
- Query
Tag string - Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the QUERYHISTORY, QUERYHISTORY*BY** functions. For more information, check QUERY_TAG docs.
- Quoted
Identifiers boolIgnore Case - Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see Identifier resolution). You can use this parameter in situations in which third-party applications always use double quotes around identifiers. 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 Apache Iceberg™ tables that use an external catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- Require
Storage boolIntegration For Stage Creation - Specifies whether to require a storage integration object as cloud credentials when creating a named external stage (using CREATE STAGE) to access a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_CREATION docs.
- Require
Storage boolIntegration For Stage Operation - Specifies whether to require using a named external stage that references a storage integration object as cloud credentials when loading data from or unloading data to a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_OPERATION docs.
- Resource
Monitor string - Rows
Per intResultset - Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
- S3Stage
Vpce stringDns Name - Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via AWS PrivateLink for Amazon S3 use this endpoint to connect. For more information, see Accessing Internal stages with dedicated interface endpoints. For more information, check S3STAGEVPCEDNSNAME docs.
- Saml
Identity stringProvider - Enables federated authentication. This deprecated parameter enables federated authentication (more details). For more information, check SAMLIDENTITYPROVIDER docs.
- Search
Path string - Specifies the path to search to resolve unqualified object names in queries. For more information, see Name resolution in queries. Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check SEARCH_PATH docs.
- Serverless
Task stringMax Statement Size - Specifies the maximum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMAXSTATEMENTSIZE docs. - Serverless
Task stringMin Statement Size - Specifies the minimum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMINSTATEMENTSIZE docs. - Session
Policy string - Specifies session policy for the current account.
- Simulated
Data stringSharing Consumer - Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
- Sso
Login boolPage - This deprecated parameter disables preview mode for testing SSO (after enabling federated authentication) before rolling it out to users. For more information, check SSOLOGINPAGE docs.
- Statement
Queued intTimeout In Seconds - Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the MAXCONCURRENCYLEVEL parameter to ensure a warehouse is never backlogged. For more information, check STATEMENTQUEUEDTIMEOUTINSECONDS docs.
- Statement
Timeout intIn Seconds - Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check STATEMENTTIMEOUTIN_SECONDS docs.
- Storage
Serialization stringPolicy - Specifies the storage serialization policy for Snowflake-managed Apache Iceberg™ tables. Valid values are (case-insensitive):
COMPATIBLE
|OPTIMIZED
. For more information, check STORAGESERIALIZATIONPOLICY docs. - Strict
Json boolOutput - This parameter specifies whether JSON output in a session is compatible with the general standard (as described by http://json.org). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check STRICTJSONOUTPUT docs.
- Suspend
Task intAfter Num Failures - Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- Task
Auto intRetry Attempts - Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- Time
Input stringFormat - Specifies the input format for the TIME data type. For more information, see Date and time input and output formats. Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check TIMEINPUTFORMAT docs.
- Time
Output stringFormat - Specifies the display format for the TIME data type. For more information, see Date and time input and output formats. For more information, check TIMEOUTPUTFORMAT docs.
- Timestamp
Day boolIs Always24h - Specifies whether the DATEADD function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check TIMESTAMPDAYISALWAYS24H docs.
- Timestamp
Input stringFormat - Specifies the input format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check TIMESTAMPINPUTFORMAT docs.
- Timestamp
Ltz stringOutput Format - Specifies the display format for the TIMESTAMPLTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPLTZOUTPUT*FORMAT docs.
- Timestamp
Ntz stringOutput Format - Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
- Timestamp
Output stringFormat - Specifies the display format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. For more information, check TIMESTAMPOUTPUTFORMAT docs.
- Timestamp
Type stringMapping - Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
|TIMESTAMP_TZ
. For more information, check TIMESTAMP*TYPE_MAPPING docs. - Timestamp
Tz stringOutput Format - Specifies the display format for the TIMESTAMPTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPTZOUTPUT*FORMAT docs.
- Timezone string
- Specifies the time zone for the session. You can specify a time zone name or a link name from release 2021a of the IANA Time Zone Database (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check TIMEZONE docs.
- Trace
Level string - Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. Valid values are (case-insensitive):
ALWAYS
|ON_EVENT
|PROPAGATE
|OFF
. For more information, check TRACE_LEVEL docs. - Transaction
Abort boolOn Error - Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check TRANSACTIONABORTON_ERROR docs.
- Transaction
Default stringIsolation Level - Specifies the isolation level for transactions in the user session. Valid values are (case-insensitive):
READ COMMITTED
. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs. - Two
Digit intCentury Start - Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the
YY
date format component (i.e. years represented as 2 digits). For more information, check TWODIGITCENTURY_START docs. - Unsupported
Ddl stringAction - Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
- Use
Cached boolResult - Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
- User
Task stringManaged Initial Warehouse Size - Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. 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 - Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
- Week
Of intYear Policy - Specifies how the weeks in a given year are computed.
0
: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year.1
: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check WEEKOFYEAR_POLICY docs. - Week
Start int - Specifies the first day of the week (used by week-related date functions).
0
: Legacy Snowflake behavior is used (i.e. ISO-like semantics).1
(Monday) to7
(Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
- Abort
Detached boolQuery - Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check ABORTDETACHEDQUERY docs.
- Active
Python stringProfiler - Sets the profiler to use for the session when profiling Python handler code. Valid values are (case-insensitive):
LINE
|MEMORY
. For more information, check ACTIVEPYTHONPROFILER docs. - Allow
Client boolMfa Caching - Specifies whether an MFA token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to respond to an MFA prompt at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using MFA token caching to minimize the number of prompts during authentication — optional. For more information, check ALLOWCLIENTMFA_CACHING docs.
- Allow
Id boolToken - Specifies whether a connection token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to enter login credentials at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using connection caching to minimize the number of prompts for authentication — optional. For more information, check ALLOWIDTOKEN docs.
- Authentication
Policy string - Specifies authentication policy for the current account.
- Autocommit bool
- Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see Transactions. For more information, check AUTOCOMMIT docs.
- Base
Location stringPrefix - Specifies a prefix for Snowflake to use in the write path for Snowflake-managed Apache Iceberg™ tables. For more information, see data and metadata directories for Iceberg tables. For more information, check BASELOCATIONPREFIX docs.
- Binary
Input stringFormat - The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
|UTF8
. For more information, check BINARYINPUTFORMAT docs. - Binary
Output stringFormat - The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
. For more information, check BINARYOUTPUTFORMAT docs. - Catalog string
- Specifies the catalog for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG docs. - Catalog
Sync string - Specifies the name of your catalog integration for Snowflake Open Catalog. Snowflake syncs tables that use the specified catalog integration with your Snowflake Open Catalog account. For more information, see Sync a Snowflake-managed table with Snowflake Open Catalog. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG_SYNC docs. - Client
Enable boolLog Info Statement Parameters - Enables users to log the data values bound to PreparedStatements (more details). For more information, check CLIENTENABLELOGINFOSTATEMENT_PARAMETERS docs.
- Client
Encryption intKey Size - Specifies the AES encryption key size, in bits, used by Snowflake to encrypt/decrypt files stored on internal stages (for loading/unloading data) when you use the SNOWFLAKEFULL encryption type. For more information, check ENCRYPTIONKEYSIZE docsCLIENT.
- Client
Memory intLimit - Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check CLIENTMEMORYLIMIT docs.
- Client
Metadata boolRequest Use Connection Ctx - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check CLIENTMETADATAREQUESTUSECONNECTION_CTX docs.
- Client
Metadata boolUse Session Database - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases to the current database. The narrower search typically returns fewer rows and executes more quickly (more details on the usage). For more information, check CLIENTMETADATAUSESESSIONDATABASE docs.
- Client
Prefetch intThreads - Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check CLIENTPREFETCHTHREADS docs.
- Client
Result intChunk Size - Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check CLIENTRESULTCHUNK_SIZE docs.
- Client
Result boolColumn Case Insensitive - Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
- Client
Session boolKeep Alive - Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check CLIENTSESSIONKEEP_ALIVE docs.
- Client
Session intKeep Alive Heartbeat Frequency - Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
- Client
Timestamp stringType Mapping - Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs. - Cortex
Enabled stringCross Region - Specifies the regions where an inference request may be processed in case the request cannot be processed in the region where request is originally placed. Specifying DISABLED disables cross-region inferencing. For examples and details, see Cross-region inference. For more information, check CORTEXENABLEDCROSS_REGION docs.
- Cortex
Models stringAllowlist - Specifies the models that users in the account can access. Use this parameter to allowlist models for all users in the account. If you need to provide specific users with access beyond what you’ve specified in the allowlist, use role-based access control instead. For more information, see Model allowlist. For more information, check CORTEXMODELSALLOWLIST docs.
- Csv
Timestamp stringFormat - Specifies the format for TIMESTAMP values in CSV files downloaded from Snowsight. If this parameter is not set, TIMESTAMPLTZOUTPUT_FORMAT will be used for TIMESTAMPLTZ values, TZ*OUTPUT_FORMATTIMESTAMP will be used for TIMESTAMPTZ and NTZOUTPUTFORMATTIMESTAMP for TIMESTAMPNTZ values. For more information, see Date and time input and output formats or Download your query results. For more information, check TIMESTAMP*FORMAT docsCSV.
- Data
Retention intTime In Days - Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database, schema, or table. For more information, see Understanding & using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- Date
Input stringFormat - Specifies the input format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEINPUTFORMAT docs.
- Date
Output stringFormat - Specifies the display format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEOUTPUTFORMAT docs.
- Default
Ddl stringCollation - Sets the default collation used for the following DDL operations: CREATE TABLE, ALTER TABLE … ADD COLUMN. Setting this parameter forces all subsequently-created columns in the affected objects (table, schema, database, or account) to have the specified collation as the default, unless the collation for the column is explicitly defined in the DDL. For more information, check DEFAULTDDLCOLLATION docs.
- Default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs. - Default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs. - Default
Null stringOrdering - Specifies the default ordering of NULL values in a result set (more details). Valid values are (case-insensitive):
FIRST
|LAST
. For more information, check DEFAULTNULLORDERING docs. - Default
Streamlit stringNotebook Warehouse - Specifies the name of the default warehouse to use when creating a notebook. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTSTREAMLITNOTEBOOK_WAREHOUSE docs. - bool
- Controls whether users in an account see a button to download data in Snowsight or the Classic Console, such as a table returned from running a query in a worksheet. If the button to download is hidden in Snowsight or the Classic Console, users can still download or export data using third-party software. For more information, check DISABLEUIDOWNLOAD_BUTTON docs.
- Disable
User boolPrivilege Grants - Controls whether users in an account can grant privileges directly to other users. Disabling user privilege grants (that is, setting DISABLEUSERPRIVILEGEGRANTS to TRUE) does not affect existing grants to users. Existing grants to users continue to confer privileges to those users. For more information, see GRANT \n\n … TO USER. For more information, check USERPRIVILEGEGRANTS docsDISABLE.
- Enable
Automatic boolSensitive Data Classification Log - Controls whether events from automatic sensitive data classification are logged in the user event table. For more information, check ENABLEAUTOMATICSENSITIVEDATACLASSIFICATION_LOG docs.
- Enable
Egress boolCost Optimizer - Enables or disables the Listing Cross-cloud auto-fulfillment Egress cost optimizer. For more information, check ENABLEEGRESSCOST_OPTIMIZER docs.
- Enable
Identifier boolFirst Login - Determines the login flow for users. When enabled, Snowflake prompts users for their username or email address before presenting authentication methods. For details, see Identifier-first login. For more information, check ENABLEIDENTIFIERFIRST_LOGIN docs.
- Enable
Internal boolStages Privatelink - Specifies whether the SYSTEM$GETPRIVATELINKCONFIG function returns the private-internal-stages key in the query result. The corresponding value in the query result is used during the configuration process for private connectivity to internal stages. For more information, check ENABLEINTERNALSTAGES_PRIVATELINK docs.
- Enable
Tri boolSecret And Rekey Opt Out For Image Repository - Specifies choice for the image repository to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORIMAGE_REPOSITORY docs.
- Enable
Tri boolSecret And Rekey Opt Out For Spcs Block Storage - Specifies the choice for the Snowpark Container Services block storage volume to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORSPCSBLOCKSTORAGE docs.
- Enable
Unhandled boolExceptions Reporting - Specifies whether Snowflake may capture – in an event table – log messages or trace event data for unhandled exceptions in procedure or UDF handler code. For more information, see Capturing messages from unhandled exceptions. For more information, check ENABLEUNHANDLEDEXCEPTIONS_REPORTING docs.
- Enable
Unload boolPhysical Type Optimization - Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check ENABLEUNLOADPHYSICALTYPEOPTIMIZATION docs.
- Enable
Unredacted boolQuery Syntax Error - Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If FALSE, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDQUERYSYNTAXERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check UNREDACTEDQUERYSYNTAXERROR docsENABLE.
- Enable
Unredacted boolSecure Object Error - Controls whether error messages related to secure objects are redacted in metadata. For more information, see Secure objects: Redaction of information in error messages. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDSECUREOBJECTERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the redacted error messages in metadata, not the user who caused the error. For more information, check UNREDACTEDSECUREOBJECTERROR docsENABLE.
- Enforce
Network boolRules For Internal Stages - Specifies whether a network policy that uses network rules can restrict access to AWS internal stages. This parameter has no effect on network policies that do not use network rules. This account-level parameter affects both account-level and user-level network policies. For details about using network policies and network rules to restrict access to AWS internal stages, including the use of this parameter, see Protecting internal stages on AWS. For more information, check ENFORCENETWORKRULESFORINTERNAL_STAGES docs.
- Error
On boolNondeterministic Merge - Specifies whether to return an error when the MERGE command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_MERGE docs.
- Error
On boolNondeterministic Update - Specifies whether to return an error when the UPDATE command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_UPDATE docs.
- Event
Table string - Specifies the name of the event table for logging messages from stored procedures and UDFs contained by the object with which the event table is associated. Associating an event table with a database is available in Enterprise Edition or higher. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EVENT_TABLE docs. - External
Oauth boolAdd Privileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from the External OAuth authorization server. For more information, check EXTERNALOAUTHADDPRIVILEGEDROLESTOBLOCKED_LIST docs.
- External
Volume string - Specifies the external volume for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EXTERNAL_VOLUME docs. - Feature
Policy string - Specifies feature policy for the current account.
- Geography
Output stringFormat - Display format for GEOGRAPHY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOGRAPHYOUTPUTFORMAT docs. - Geometry
Output stringFormat - Display format for GEOMETRY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOMETRYOUTPUTFORMAT docs. - Hybrid
Table intLock Timeout - Number of seconds to wait while trying to acquire row-level locks on a hybrid table, before timing out and aborting the statement. For more information, check HYBRIDTABLELOCK_TIMEOUT docs.
- Initial
Replication stringSize Limit In Tb - Sets the maximum estimated size limit for the initial replication of a primary database to a secondary database (in TB). Set this parameter on any account that stores a secondary database. This size limit helps prevent accounts from accidentally incurring large database replication charges. To remove the size limit, set the value to 0.0. It is required to pass numbers with scale of at least 1 (e.g. 20.5, 32.25, 33.333, etc.). For more information, check INITIALREPLICATIONSIZELIMITIN_TB docs.
- Jdbc
Treat boolDecimal As Int - Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
- Jdbc
Treat boolTimestamp Ntz As Utc - Specifies how JDBC processes TIMESTAMPNTZ values (more details). For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
- Jdbc
Use boolSession Timezone - Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the TIMEZONE parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check JDBCUSESESSION_TIMEZONE docs.
- Js
Treat boolInteger As Bigint - Specifies how the Snowflake Node.js Driver processes numeric columns that have a scale of zero (0), for example INTEGER or NUMBER(p, 0). For more information, check JSTREATINTEGERASBIGINT docs.
- Json
Indent int - Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check JSON_INDENT docs.
- Listing
Auto stringFulfillment Replication Refresh Schedule - Sets the time interval used to refresh the application package based data products to other regions. For more information, check LISTINGAUTOFULFILLMENTREPLICATIONREFRESH_SCHEDULE docs.
- Lock
Timeout int - Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check LOCK_TIMEOUT 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. For more information about log levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
TRACE
|DEBUG
|INFO
|WARN
|ERROR
|FATAL
|OFF
. For more information, check LOG_LEVEL docs. - Max
Concurrency intLevel - Specifies the concurrency level for SQL statements (that is, queries and DML) executed by a warehouse (more details). For more information, check MAXCONCURRENCYLEVEL docs.
- Max
Data intExtension Time In Days - Maximum number of days Snowflake can extend the data retention period for tables to prevent streams on the tables from becoming stale. By default, if the DATARETENTIONTIMEINDAYS setting for a source table is less than 14 days, and a stream has not been consumed, Snowflake temporarily extends this period to the stream’s offset, up to a maximum of 14 days, regardless of the Snowflake Edition for your account. The MAXDATAEXTENSIONTIMEINDAYS parameter enables you to limit this automatic extension period to control storage costs for data retention or for compliance reasons. For more information, check DATAEXTENSIONTIMEINDAYS docsMAX.
- Metric
Level string - Controls how metrics data is ingested into the event table. For more information about metric levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
ALL
|NONE
. For more information, check METRIC_LEVEL docs. - Min
Data intRetention Time In Days - Minimum number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on an object. If a minimum number of days for data retention is set on an account, the data retention period for an object is determined by MAX(DATARETENTIONTIMEINDAYS, MINDATARETENTIONTIMEINDAYS). For more information, check DATARETENTIONTIMEINDAYS docsMIN.
- Multi
Statement intCount - Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
- Network
Policy string - Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see Controlling network traffic with network policies. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check NETWORK_POLICY docs. - Noorder
Sequence boolAs Default - Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in increasing or decreasing order. For more information, check NOORDERSEQUENCEAS_DEFAULT docs.
- Oauth
Add boolPrivileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from Snowflake’s authorization server. For more information, check OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST docs.
- Odbc
Treat boolDecimal As Int - Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
- Packages
Policy string - Specifies packages policy for the current account.
- Password
Policy string - Specifies password policy for the current account.
- Periodic
Data boolRekeying - It enables/disables re-encryption of table data with new keys on a yearly basis to provide additional levels of data protection (more details). For more information, check PERIODICDATAREKEYING docs.
- Pipe
Execution boolPaused - Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role (more details). For more information, check PIPEEXECUTIONPAUSED docs.
- Prevent
Unload boolTo Inline Url - Specifies whether to prevent ad hoc data unload operations to external cloud storage locations (that is, COPY INTO location statements that specify the cloud storage URL and access settings directly in the statement). For an example, see Unloading data from a table directly to files in an external location. For more information, check PREVENTUNLOADTOINLINEURL docs.
- Prevent
Unload boolTo Internal Stages - Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO location statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
- Python
Profiler stringModules - Specifies the list of Python modules to include in a report when profiling Python handler code. For more information, check PYTHONPROFILERMODULES docs.
- Python
Profiler stringTarget Stage - Specifies the fully-qualified name of the stage in which to save a report when profiling Python handler code. For more information, check PYTHONPROFILERTARGET_STAGE docs.
- Query
Tag string - Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the QUERYHISTORY, QUERYHISTORY*BY** functions. For more information, check QUERY_TAG docs.
- Quoted
Identifiers boolIgnore Case - Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see Identifier resolution). You can use this parameter in situations in which third-party applications always use double quotes around identifiers. 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 Apache Iceberg™ tables that use an external catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- Require
Storage boolIntegration For Stage Creation - Specifies whether to require a storage integration object as cloud credentials when creating a named external stage (using CREATE STAGE) to access a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_CREATION docs.
- Require
Storage boolIntegration For Stage Operation - Specifies whether to require using a named external stage that references a storage integration object as cloud credentials when loading data from or unloading data to a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_OPERATION docs.
- Resource
Monitor string - Rows
Per intResultset - Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
- S3Stage
Vpce stringDns Name - Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via AWS PrivateLink for Amazon S3 use this endpoint to connect. For more information, see Accessing Internal stages with dedicated interface endpoints. For more information, check S3STAGEVPCEDNSNAME docs.
- Saml
Identity stringProvider - Enables federated authentication. This deprecated parameter enables federated authentication (more details). For more information, check SAMLIDENTITYPROVIDER docs.
- Search
Path string - Specifies the path to search to resolve unqualified object names in queries. For more information, see Name resolution in queries. Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check SEARCH_PATH docs.
- Serverless
Task stringMax Statement Size - Specifies the maximum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMAXSTATEMENTSIZE docs. - Serverless
Task stringMin Statement Size - Specifies the minimum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMINSTATEMENTSIZE docs. - Session
Policy string - Specifies session policy for the current account.
- Simulated
Data stringSharing Consumer - Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
- Sso
Login boolPage - This deprecated parameter disables preview mode for testing SSO (after enabling federated authentication) before rolling it out to users. For more information, check SSOLOGINPAGE docs.
- Statement
Queued intTimeout In Seconds - Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the MAXCONCURRENCYLEVEL parameter to ensure a warehouse is never backlogged. For more information, check STATEMENTQUEUEDTIMEOUTINSECONDS docs.
- Statement
Timeout intIn Seconds - Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check STATEMENTTIMEOUTIN_SECONDS docs.
- Storage
Serialization stringPolicy - Specifies the storage serialization policy for Snowflake-managed Apache Iceberg™ tables. Valid values are (case-insensitive):
COMPATIBLE
|OPTIMIZED
. For more information, check STORAGESERIALIZATIONPOLICY docs. - Strict
Json boolOutput - This parameter specifies whether JSON output in a session is compatible with the general standard (as described by http://json.org). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check STRICTJSONOUTPUT docs.
- Suspend
Task intAfter Num Failures - Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- Task
Auto intRetry Attempts - Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- Time
Input stringFormat - Specifies the input format for the TIME data type. For more information, see Date and time input and output formats. Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check TIMEINPUTFORMAT docs.
- Time
Output stringFormat - Specifies the display format for the TIME data type. For more information, see Date and time input and output formats. For more information, check TIMEOUTPUTFORMAT docs.
- Timestamp
Day boolIs Always24h - Specifies whether the DATEADD function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check TIMESTAMPDAYISALWAYS24H docs.
- Timestamp
Input stringFormat - Specifies the input format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check TIMESTAMPINPUTFORMAT docs.
- Timestamp
Ltz stringOutput Format - Specifies the display format for the TIMESTAMPLTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPLTZOUTPUT*FORMAT docs.
- Timestamp
Ntz stringOutput Format - Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
- Timestamp
Output stringFormat - Specifies the display format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. For more information, check TIMESTAMPOUTPUTFORMAT docs.
- Timestamp
Type stringMapping - Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
|TIMESTAMP_TZ
. For more information, check TIMESTAMP*TYPE_MAPPING docs. - Timestamp
Tz stringOutput Format - Specifies the display format for the TIMESTAMPTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPTZOUTPUT*FORMAT docs.
- Timezone string
- Specifies the time zone for the session. You can specify a time zone name or a link name from release 2021a of the IANA Time Zone Database (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check TIMEZONE docs.
- Trace
Level string - Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. Valid values are (case-insensitive):
ALWAYS
|ON_EVENT
|PROPAGATE
|OFF
. For more information, check TRACE_LEVEL docs. - Transaction
Abort boolOn Error - Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check TRANSACTIONABORTON_ERROR docs.
- Transaction
Default stringIsolation Level - Specifies the isolation level for transactions in the user session. Valid values are (case-insensitive):
READ COMMITTED
. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs. - Two
Digit intCentury Start - Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the
YY
date format component (i.e. years represented as 2 digits). For more information, check TWODIGITCENTURY_START docs. - Unsupported
Ddl stringAction - Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
- Use
Cached boolResult - Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
- User
Task stringManaged Initial Warehouse Size - Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. 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 - Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
- Week
Of intYear Policy - Specifies how the weeks in a given year are computed.
0
: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year.1
: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check WEEKOFYEAR_POLICY docs. - Week
Start int - Specifies the first day of the week (used by week-related date functions).
0
: Legacy Snowflake behavior is used (i.e. ISO-like semantics).1
(Monday) to7
(Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
- abort
Detached BooleanQuery - Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check ABORTDETACHEDQUERY docs.
- active
Python StringProfiler - Sets the profiler to use for the session when profiling Python handler code. Valid values are (case-insensitive):
LINE
|MEMORY
. For more information, check ACTIVEPYTHONPROFILER docs. - allow
Client BooleanMfa Caching - Specifies whether an MFA token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to respond to an MFA prompt at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using MFA token caching to minimize the number of prompts during authentication — optional. For more information, check ALLOWCLIENTMFA_CACHING docs.
- allow
Id BooleanToken - Specifies whether a connection token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to enter login credentials at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using connection caching to minimize the number of prompts for authentication — optional. For more information, check ALLOWIDTOKEN docs.
- authentication
Policy String - Specifies authentication policy for the current account.
- autocommit Boolean
- Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see Transactions. For more information, check AUTOCOMMIT docs.
- base
Location StringPrefix - Specifies a prefix for Snowflake to use in the write path for Snowflake-managed Apache Iceberg™ tables. For more information, see data and metadata directories for Iceberg tables. For more information, check BASELOCATIONPREFIX docs.
- binary
Input StringFormat - The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
|UTF8
. For more information, check BINARYINPUTFORMAT docs. - binary
Output StringFormat - The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
. For more information, check BINARYOUTPUTFORMAT docs. - catalog String
- Specifies the catalog for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG docs. - catalog
Sync String - Specifies the name of your catalog integration for Snowflake Open Catalog. Snowflake syncs tables that use the specified catalog integration with your Snowflake Open Catalog account. For more information, see Sync a Snowflake-managed table with Snowflake Open Catalog. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG_SYNC docs. - client
Enable BooleanLog Info Statement Parameters - Enables users to log the data values bound to PreparedStatements (more details). For more information, check CLIENTENABLELOGINFOSTATEMENT_PARAMETERS docs.
- client
Encryption IntegerKey Size - Specifies the AES encryption key size, in bits, used by Snowflake to encrypt/decrypt files stored on internal stages (for loading/unloading data) when you use the SNOWFLAKEFULL encryption type. For more information, check ENCRYPTIONKEYSIZE docsCLIENT.
- client
Memory IntegerLimit - Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check CLIENTMEMORYLIMIT docs.
- client
Metadata BooleanRequest Use Connection Ctx - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check CLIENTMETADATAREQUESTUSECONNECTION_CTX docs.
- client
Metadata BooleanUse Session Database - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases to the current database. The narrower search typically returns fewer rows and executes more quickly (more details on the usage). For more information, check CLIENTMETADATAUSESESSIONDATABASE docs.
- client
Prefetch IntegerThreads - Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check CLIENTPREFETCHTHREADS docs.
- client
Result IntegerChunk Size - Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check CLIENTRESULTCHUNK_SIZE docs.
- client
Result BooleanColumn Case Insensitive - Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
- client
Session BooleanKeep Alive - Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check CLIENTSESSIONKEEP_ALIVE docs.
- client
Session IntegerKeep Alive Heartbeat Frequency - Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
- client
Timestamp StringType Mapping - Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs. - cortex
Enabled StringCross Region - Specifies the regions where an inference request may be processed in case the request cannot be processed in the region where request is originally placed. Specifying DISABLED disables cross-region inferencing. For examples and details, see Cross-region inference. For more information, check CORTEXENABLEDCROSS_REGION docs.
- cortex
Models StringAllowlist - Specifies the models that users in the account can access. Use this parameter to allowlist models for all users in the account. If you need to provide specific users with access beyond what you’ve specified in the allowlist, use role-based access control instead. For more information, see Model allowlist. For more information, check CORTEXMODELSALLOWLIST docs.
- csv
Timestamp StringFormat - Specifies the format for TIMESTAMP values in CSV files downloaded from Snowsight. If this parameter is not set, TIMESTAMPLTZOUTPUT_FORMAT will be used for TIMESTAMPLTZ values, TZ*OUTPUT_FORMATTIMESTAMP will be used for TIMESTAMPTZ and NTZOUTPUTFORMATTIMESTAMP for TIMESTAMPNTZ values. For more information, see Date and time input and output formats or Download your query results. For more information, check TIMESTAMP*FORMAT docsCSV.
- data
Retention IntegerTime In Days - Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database, schema, or table. For more information, see Understanding & using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- date
Input StringFormat - Specifies the input format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEINPUTFORMAT docs.
- date
Output StringFormat - Specifies the display format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEOUTPUTFORMAT docs.
- default
Ddl StringCollation - Sets the default collation used for the following DDL operations: CREATE TABLE, ALTER TABLE … ADD COLUMN. Setting this parameter forces all subsequently-created columns in the affected objects (table, schema, database, or account) to have the specified collation as the default, unless the collation for the column is explicitly defined in the DDL. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook StringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs. - default
Notebook StringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs. - default
Null StringOrdering - Specifies the default ordering of NULL values in a result set (more details). Valid values are (case-insensitive):
FIRST
|LAST
. For more information, check DEFAULTNULLORDERING docs. - default
Streamlit StringNotebook Warehouse - Specifies the name of the default warehouse to use when creating a notebook. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTSTREAMLITNOTEBOOK_WAREHOUSE docs. - Boolean
- Controls whether users in an account see a button to download data in Snowsight or the Classic Console, such as a table returned from running a query in a worksheet. If the button to download is hidden in Snowsight or the Classic Console, users can still download or export data using third-party software. For more information, check DISABLEUIDOWNLOAD_BUTTON docs.
- disable
User BooleanPrivilege Grants - Controls whether users in an account can grant privileges directly to other users. Disabling user privilege grants (that is, setting DISABLEUSERPRIVILEGEGRANTS to TRUE) does not affect existing grants to users. Existing grants to users continue to confer privileges to those users. For more information, see GRANT \n\n … TO USER. For more information, check USERPRIVILEGEGRANTS docsDISABLE.
- enable
Automatic BooleanSensitive Data Classification Log - Controls whether events from automatic sensitive data classification are logged in the user event table. For more information, check ENABLEAUTOMATICSENSITIVEDATACLASSIFICATION_LOG docs.
- enable
Egress BooleanCost Optimizer - Enables or disables the Listing Cross-cloud auto-fulfillment Egress cost optimizer. For more information, check ENABLEEGRESSCOST_OPTIMIZER docs.
- enable
Identifier BooleanFirst Login - Determines the login flow for users. When enabled, Snowflake prompts users for their username or email address before presenting authentication methods. For details, see Identifier-first login. For more information, check ENABLEIDENTIFIERFIRST_LOGIN docs.
- enable
Internal BooleanStages Privatelink - Specifies whether the SYSTEM$GETPRIVATELINKCONFIG function returns the private-internal-stages key in the query result. The corresponding value in the query result is used during the configuration process for private connectivity to internal stages. For more information, check ENABLEINTERNALSTAGES_PRIVATELINK docs.
- enable
Tri BooleanSecret And Rekey Opt Out For Image Repository - Specifies choice for the image repository to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORIMAGE_REPOSITORY docs.
- enable
Tri BooleanSecret And Rekey Opt Out For Spcs Block Storage - Specifies the choice for the Snowpark Container Services block storage volume to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORSPCSBLOCKSTORAGE docs.
- enable
Unhandled BooleanExceptions Reporting - Specifies whether Snowflake may capture – in an event table – log messages or trace event data for unhandled exceptions in procedure or UDF handler code. For more information, see Capturing messages from unhandled exceptions. For more information, check ENABLEUNHANDLEDEXCEPTIONS_REPORTING docs.
- enable
Unload BooleanPhysical Type Optimization - Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check ENABLEUNLOADPHYSICALTYPEOPTIMIZATION docs.
- enable
Unredacted BooleanQuery Syntax Error - Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If FALSE, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDQUERYSYNTAXERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check UNREDACTEDQUERYSYNTAXERROR docsENABLE.
- enable
Unredacted BooleanSecure Object Error - Controls whether error messages related to secure objects are redacted in metadata. For more information, see Secure objects: Redaction of information in error messages. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDSECUREOBJECTERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the redacted error messages in metadata, not the user who caused the error. For more information, check UNREDACTEDSECUREOBJECTERROR docsENABLE.
- enforce
Network BooleanRules For Internal Stages - Specifies whether a network policy that uses network rules can restrict access to AWS internal stages. This parameter has no effect on network policies that do not use network rules. This account-level parameter affects both account-level and user-level network policies. For details about using network policies and network rules to restrict access to AWS internal stages, including the use of this parameter, see Protecting internal stages on AWS. For more information, check ENFORCENETWORKRULESFORINTERNAL_STAGES docs.
- error
On BooleanNondeterministic Merge - Specifies whether to return an error when the MERGE command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_MERGE docs.
- error
On BooleanNondeterministic Update - Specifies whether to return an error when the UPDATE command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_UPDATE docs.
- event
Table String - Specifies the name of the event table for logging messages from stored procedures and UDFs contained by the object with which the event table is associated. Associating an event table with a database is available in Enterprise Edition or higher. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EVENT_TABLE docs. - external
Oauth BooleanAdd Privileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from the External OAuth authorization server. For more information, check EXTERNALOAUTHADDPRIVILEGEDROLESTOBLOCKED_LIST docs.
- external
Volume String - Specifies the external volume for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EXTERNAL_VOLUME docs. - feature
Policy String - Specifies feature policy for the current account.
- geography
Output StringFormat - Display format for GEOGRAPHY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOGRAPHYOUTPUTFORMAT docs. - geometry
Output StringFormat - Display format for GEOMETRY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOMETRYOUTPUTFORMAT docs. - hybrid
Table IntegerLock Timeout - Number of seconds to wait while trying to acquire row-level locks on a hybrid table, before timing out and aborting the statement. For more information, check HYBRIDTABLELOCK_TIMEOUT docs.
- initial
Replication StringSize Limit In Tb - Sets the maximum estimated size limit for the initial replication of a primary database to a secondary database (in TB). Set this parameter on any account that stores a secondary database. This size limit helps prevent accounts from accidentally incurring large database replication charges. To remove the size limit, set the value to 0.0. It is required to pass numbers with scale of at least 1 (e.g. 20.5, 32.25, 33.333, etc.). For more information, check INITIALREPLICATIONSIZELIMITIN_TB docs.
- jdbc
Treat BooleanDecimal As Int - Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
- jdbc
Treat BooleanTimestamp Ntz As Utc - Specifies how JDBC processes TIMESTAMPNTZ values (more details). For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
- jdbc
Use BooleanSession Timezone - Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the TIMEZONE parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check JDBCUSESESSION_TIMEZONE docs.
- js
Treat BooleanInteger As Bigint - Specifies how the Snowflake Node.js Driver processes numeric columns that have a scale of zero (0), for example INTEGER or NUMBER(p, 0). For more information, check JSTREATINTEGERASBIGINT docs.
- json
Indent Integer - Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check JSON_INDENT docs.
- listing
Auto StringFulfillment Replication Refresh Schedule - Sets the time interval used to refresh the application package based data products to other regions. For more information, check LISTINGAUTOFULFILLMENTREPLICATIONREFRESH_SCHEDULE docs.
- lock
Timeout Integer - Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check LOCK_TIMEOUT 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. For more information about log levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
TRACE
|DEBUG
|INFO
|WARN
|ERROR
|FATAL
|OFF
. For more information, check LOG_LEVEL docs. - max
Concurrency IntegerLevel - Specifies the concurrency level for SQL statements (that is, queries and DML) executed by a warehouse (more details). For more information, check MAXCONCURRENCYLEVEL docs.
- max
Data IntegerExtension Time In Days - Maximum number of days Snowflake can extend the data retention period for tables to prevent streams on the tables from becoming stale. By default, if the DATARETENTIONTIMEINDAYS setting for a source table is less than 14 days, and a stream has not been consumed, Snowflake temporarily extends this period to the stream’s offset, up to a maximum of 14 days, regardless of the Snowflake Edition for your account. The MAXDATAEXTENSIONTIMEINDAYS parameter enables you to limit this automatic extension period to control storage costs for data retention or for compliance reasons. For more information, check DATAEXTENSIONTIMEINDAYS docsMAX.
- metric
Level String - Controls how metrics data is ingested into the event table. For more information about metric levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
ALL
|NONE
. For more information, check METRIC_LEVEL docs. - min
Data IntegerRetention Time In Days - Minimum number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on an object. If a minimum number of days for data retention is set on an account, the data retention period for an object is determined by MAX(DATARETENTIONTIMEINDAYS, MINDATARETENTIONTIMEINDAYS). For more information, check DATARETENTIONTIMEINDAYS docsMIN.
- multi
Statement IntegerCount - Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
- network
Policy String - Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see Controlling network traffic with network policies. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check NETWORK_POLICY docs. - noorder
Sequence BooleanAs Default - Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in increasing or decreasing order. For more information, check NOORDERSEQUENCEAS_DEFAULT docs.
- oauth
Add BooleanPrivileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from Snowflake’s authorization server. For more information, check OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST docs.
- odbc
Treat BooleanDecimal As Int - Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
- packages
Policy String - Specifies packages policy for the current account.
- password
Policy String - Specifies password policy for the current account.
- periodic
Data BooleanRekeying - It enables/disables re-encryption of table data with new keys on a yearly basis to provide additional levels of data protection (more details). For more information, check PERIODICDATAREKEYING docs.
- pipe
Execution BooleanPaused - Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role (more details). For more information, check PIPEEXECUTIONPAUSED docs.
- prevent
Unload BooleanTo Inline Url - Specifies whether to prevent ad hoc data unload operations to external cloud storage locations (that is, COPY INTO location statements that specify the cloud storage URL and access settings directly in the statement). For an example, see Unloading data from a table directly to files in an external location. For more information, check PREVENTUNLOADTOINLINEURL docs.
- prevent
Unload BooleanTo Internal Stages - Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO location statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
- python
Profiler StringModules - Specifies the list of Python modules to include in a report when profiling Python handler code. For more information, check PYTHONPROFILERMODULES docs.
- python
Profiler StringTarget Stage - Specifies the fully-qualified name of the stage in which to save a report when profiling Python handler code. For more information, check PYTHONPROFILERTARGET_STAGE docs.
- query
Tag String - Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the QUERYHISTORY, QUERYHISTORY*BY** functions. For more information, check QUERY_TAG docs.
- quoted
Identifiers BooleanIgnore Case - Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see Identifier resolution). You can use this parameter in situations in which third-party applications always use double quotes around identifiers. 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 Apache Iceberg™ tables that use an external catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- require
Storage BooleanIntegration For Stage Creation - Specifies whether to require a storage integration object as cloud credentials when creating a named external stage (using CREATE STAGE) to access a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_CREATION docs.
- require
Storage BooleanIntegration For Stage Operation - Specifies whether to require using a named external stage that references a storage integration object as cloud credentials when loading data from or unloading data to a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_OPERATION docs.
- resource
Monitor String - rows
Per IntegerResultset - Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
- s3Stage
Vpce StringDns Name - Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via AWS PrivateLink for Amazon S3 use this endpoint to connect. For more information, see Accessing Internal stages with dedicated interface endpoints. For more information, check S3STAGEVPCEDNSNAME docs.
- saml
Identity StringProvider - Enables federated authentication. This deprecated parameter enables federated authentication (more details). For more information, check SAMLIDENTITYPROVIDER docs.
- search
Path String - Specifies the path to search to resolve unqualified object names in queries. For more information, see Name resolution in queries. Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check SEARCH_PATH docs.
- serverless
Task StringMax Statement Size - Specifies the maximum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMAXSTATEMENTSIZE docs. - serverless
Task StringMin Statement Size - Specifies the minimum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMINSTATEMENTSIZE docs. - session
Policy String - Specifies session policy for the current account.
- simulated
Data StringSharing Consumer - Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
- sso
Login BooleanPage - This deprecated parameter disables preview mode for testing SSO (after enabling federated authentication) before rolling it out to users. For more information, check SSOLOGINPAGE docs.
- statement
Queued IntegerTimeout In Seconds - Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the MAXCONCURRENCYLEVEL parameter to ensure a warehouse is never backlogged. For more information, check STATEMENTQUEUEDTIMEOUTINSECONDS docs.
- statement
Timeout IntegerIn Seconds - Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check STATEMENTTIMEOUTIN_SECONDS docs.
- storage
Serialization StringPolicy - Specifies the storage serialization policy for Snowflake-managed Apache Iceberg™ tables. Valid values are (case-insensitive):
COMPATIBLE
|OPTIMIZED
. For more information, check STORAGESERIALIZATIONPOLICY docs. - strict
Json BooleanOutput - This parameter specifies whether JSON output in a session is compatible with the general standard (as described by http://json.org). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check STRICTJSONOUTPUT docs.
- suspend
Task IntegerAfter Num Failures - Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto IntegerRetry Attempts - Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- time
Input StringFormat - Specifies the input format for the TIME data type. For more information, see Date and time input and output formats. Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check TIMEINPUTFORMAT docs.
- time
Output StringFormat - Specifies the display format for the TIME data type. For more information, see Date and time input and output formats. For more information, check TIMEOUTPUTFORMAT docs.
- timestamp
Day BooleanIs Always24h - Specifies whether the DATEADD function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check TIMESTAMPDAYISALWAYS24H docs.
- timestamp
Input StringFormat - Specifies the input format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check TIMESTAMPINPUTFORMAT docs.
- timestamp
Ltz StringOutput Format - Specifies the display format for the TIMESTAMPLTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPLTZOUTPUT*FORMAT docs.
- timestamp
Ntz StringOutput Format - Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
- timestamp
Output StringFormat - Specifies the display format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. For more information, check TIMESTAMPOUTPUTFORMAT docs.
- timestamp
Type StringMapping - Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
|TIMESTAMP_TZ
. For more information, check TIMESTAMP*TYPE_MAPPING docs. - timestamp
Tz StringOutput Format - Specifies the display format for the TIMESTAMPTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPTZOUTPUT*FORMAT docs.
- timezone String
- Specifies the time zone for the session. You can specify a time zone name or a link name from release 2021a of the IANA Time Zone Database (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check TIMEZONE docs.
- trace
Level String - Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. Valid values are (case-insensitive):
ALWAYS
|ON_EVENT
|PROPAGATE
|OFF
. For more information, check TRACE_LEVEL docs. - transaction
Abort BooleanOn Error - Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check TRANSACTIONABORTON_ERROR docs.
- transaction
Default StringIsolation Level - Specifies the isolation level for transactions in the user session. Valid values are (case-insensitive):
READ COMMITTED
. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs. - two
Digit IntegerCentury Start - Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the
YY
date format component (i.e. years represented as 2 digits). For more information, check TWODIGITCENTURY_START docs. - unsupported
Ddl StringAction - Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
- use
Cached BooleanResult - Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
- user
Task StringManaged Initial Warehouse Size - Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. 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 - Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
- week
Of IntegerYear Policy - Specifies how the weeks in a given year are computed.
0
: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year.1
: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check WEEKOFYEAR_POLICY docs. - week
Start Integer - Specifies the first day of the week (used by week-related date functions).
0
: Legacy Snowflake behavior is used (i.e. ISO-like semantics).1
(Monday) to7
(Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
- abort
Detached booleanQuery - Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check ABORTDETACHEDQUERY docs.
- active
Python stringProfiler - Sets the profiler to use for the session when profiling Python handler code. Valid values are (case-insensitive):
LINE
|MEMORY
. For more information, check ACTIVEPYTHONPROFILER docs. - allow
Client booleanMfa Caching - Specifies whether an MFA token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to respond to an MFA prompt at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using MFA token caching to minimize the number of prompts during authentication — optional. For more information, check ALLOWCLIENTMFA_CACHING docs.
- allow
Id booleanToken - Specifies whether a connection token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to enter login credentials at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using connection caching to minimize the number of prompts for authentication — optional. For more information, check ALLOWIDTOKEN docs.
- authentication
Policy string - Specifies authentication policy for the current account.
- autocommit boolean
- Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see Transactions. For more information, check AUTOCOMMIT docs.
- base
Location stringPrefix - Specifies a prefix for Snowflake to use in the write path for Snowflake-managed Apache Iceberg™ tables. For more information, see data and metadata directories for Iceberg tables. For more information, check BASELOCATIONPREFIX docs.
- binary
Input stringFormat - The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
|UTF8
. For more information, check BINARYINPUTFORMAT docs. - binary
Output stringFormat - The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
. For more information, check BINARYOUTPUTFORMAT docs. - catalog string
- Specifies the catalog for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG docs. - catalog
Sync string - Specifies the name of your catalog integration for Snowflake Open Catalog. Snowflake syncs tables that use the specified catalog integration with your Snowflake Open Catalog account. For more information, see Sync a Snowflake-managed table with Snowflake Open Catalog. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG_SYNC docs. - client
Enable booleanLog Info Statement Parameters - Enables users to log the data values bound to PreparedStatements (more details). For more information, check CLIENTENABLELOGINFOSTATEMENT_PARAMETERS docs.
- client
Encryption numberKey Size - Specifies the AES encryption key size, in bits, used by Snowflake to encrypt/decrypt files stored on internal stages (for loading/unloading data) when you use the SNOWFLAKEFULL encryption type. For more information, check ENCRYPTIONKEYSIZE docsCLIENT.
- client
Memory numberLimit - Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check CLIENTMEMORYLIMIT docs.
- client
Metadata booleanRequest Use Connection Ctx - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check CLIENTMETADATAREQUESTUSECONNECTION_CTX docs.
- client
Metadata booleanUse Session Database - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases to the current database. The narrower search typically returns fewer rows and executes more quickly (more details on the usage). For more information, check CLIENTMETADATAUSESESSIONDATABASE docs.
- client
Prefetch numberThreads - Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check CLIENTPREFETCHTHREADS docs.
- client
Result numberChunk Size - Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check CLIENTRESULTCHUNK_SIZE docs.
- client
Result booleanColumn Case Insensitive - Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
- client
Session booleanKeep Alive - Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check CLIENTSESSIONKEEP_ALIVE docs.
- client
Session numberKeep Alive Heartbeat Frequency - Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
- client
Timestamp stringType Mapping - Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs. - cortex
Enabled stringCross Region - Specifies the regions where an inference request may be processed in case the request cannot be processed in the region where request is originally placed. Specifying DISABLED disables cross-region inferencing. For examples and details, see Cross-region inference. For more information, check CORTEXENABLEDCROSS_REGION docs.
- cortex
Models stringAllowlist - Specifies the models that users in the account can access. Use this parameter to allowlist models for all users in the account. If you need to provide specific users with access beyond what you’ve specified in the allowlist, use role-based access control instead. For more information, see Model allowlist. For more information, check CORTEXMODELSALLOWLIST docs.
- csv
Timestamp stringFormat - Specifies the format for TIMESTAMP values in CSV files downloaded from Snowsight. If this parameter is not set, TIMESTAMPLTZOUTPUT_FORMAT will be used for TIMESTAMPLTZ values, TZ*OUTPUT_FORMATTIMESTAMP will be used for TIMESTAMPTZ and NTZOUTPUTFORMATTIMESTAMP for TIMESTAMPNTZ values. For more information, see Date and time input and output formats or Download your query results. For more information, check TIMESTAMP*FORMAT docsCSV.
- data
Retention numberTime In Days - Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database, schema, or table. For more information, see Understanding & using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- date
Input stringFormat - Specifies the input format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEINPUTFORMAT docs.
- date
Output stringFormat - Specifies the display format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEOUTPUTFORMAT docs.
- default
Ddl stringCollation - Sets the default collation used for the following DDL operations: CREATE TABLE, ALTER TABLE … ADD COLUMN. Setting this parameter forces all subsequently-created columns in the affected objects (table, schema, database, or account) to have the specified collation as the default, unless the collation for the column is explicitly defined in the DDL. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs. - default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs. - default
Null stringOrdering - Specifies the default ordering of NULL values in a result set (more details). Valid values are (case-insensitive):
FIRST
|LAST
. For more information, check DEFAULTNULLORDERING docs. - default
Streamlit stringNotebook Warehouse - Specifies the name of the default warehouse to use when creating a notebook. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTSTREAMLITNOTEBOOK_WAREHOUSE docs. - boolean
- Controls whether users in an account see a button to download data in Snowsight or the Classic Console, such as a table returned from running a query in a worksheet. If the button to download is hidden in Snowsight or the Classic Console, users can still download or export data using third-party software. For more information, check DISABLEUIDOWNLOAD_BUTTON docs.
- disable
User booleanPrivilege Grants - Controls whether users in an account can grant privileges directly to other users. Disabling user privilege grants (that is, setting DISABLEUSERPRIVILEGEGRANTS to TRUE) does not affect existing grants to users. Existing grants to users continue to confer privileges to those users. For more information, see GRANT \n\n … TO USER. For more information, check USERPRIVILEGEGRANTS docsDISABLE.
- enable
Automatic booleanSensitive Data Classification Log - Controls whether events from automatic sensitive data classification are logged in the user event table. For more information, check ENABLEAUTOMATICSENSITIVEDATACLASSIFICATION_LOG docs.
- enable
Egress booleanCost Optimizer - Enables or disables the Listing Cross-cloud auto-fulfillment Egress cost optimizer. For more information, check ENABLEEGRESSCOST_OPTIMIZER docs.
- enable
Identifier booleanFirst Login - Determines the login flow for users. When enabled, Snowflake prompts users for their username or email address before presenting authentication methods. For details, see Identifier-first login. For more information, check ENABLEIDENTIFIERFIRST_LOGIN docs.
- enable
Internal booleanStages Privatelink - Specifies whether the SYSTEM$GETPRIVATELINKCONFIG function returns the private-internal-stages key in the query result. The corresponding value in the query result is used during the configuration process for private connectivity to internal stages. For more information, check ENABLEINTERNALSTAGES_PRIVATELINK docs.
- enable
Tri booleanSecret And Rekey Opt Out For Image Repository - Specifies choice for the image repository to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORIMAGE_REPOSITORY docs.
- enable
Tri booleanSecret And Rekey Opt Out For Spcs Block Storage - Specifies the choice for the Snowpark Container Services block storage volume to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORSPCSBLOCKSTORAGE docs.
- enable
Unhandled booleanExceptions Reporting - Specifies whether Snowflake may capture – in an event table – log messages or trace event data for unhandled exceptions in procedure or UDF handler code. For more information, see Capturing messages from unhandled exceptions. For more information, check ENABLEUNHANDLEDEXCEPTIONS_REPORTING docs.
- enable
Unload booleanPhysical Type Optimization - Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check ENABLEUNLOADPHYSICALTYPEOPTIMIZATION docs.
- enable
Unredacted booleanQuery Syntax Error - Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If FALSE, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDQUERYSYNTAXERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check UNREDACTEDQUERYSYNTAXERROR docsENABLE.
- enable
Unredacted booleanSecure Object Error - Controls whether error messages related to secure objects are redacted in metadata. For more information, see Secure objects: Redaction of information in error messages. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDSECUREOBJECTERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the redacted error messages in metadata, not the user who caused the error. For more information, check UNREDACTEDSECUREOBJECTERROR docsENABLE.
- enforce
Network booleanRules For Internal Stages - Specifies whether a network policy that uses network rules can restrict access to AWS internal stages. This parameter has no effect on network policies that do not use network rules. This account-level parameter affects both account-level and user-level network policies. For details about using network policies and network rules to restrict access to AWS internal stages, including the use of this parameter, see Protecting internal stages on AWS. For more information, check ENFORCENETWORKRULESFORINTERNAL_STAGES docs.
- error
On booleanNondeterministic Merge - Specifies whether to return an error when the MERGE command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_MERGE docs.
- error
On booleanNondeterministic Update - Specifies whether to return an error when the UPDATE command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_UPDATE docs.
- event
Table string - Specifies the name of the event table for logging messages from stored procedures and UDFs contained by the object with which the event table is associated. Associating an event table with a database is available in Enterprise Edition or higher. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EVENT_TABLE docs. - external
Oauth booleanAdd Privileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from the External OAuth authorization server. For more information, check EXTERNALOAUTHADDPRIVILEGEDROLESTOBLOCKED_LIST docs.
- external
Volume string - Specifies the external volume for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EXTERNAL_VOLUME docs. - feature
Policy string - Specifies feature policy for the current account.
- geography
Output stringFormat - Display format for GEOGRAPHY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOGRAPHYOUTPUTFORMAT docs. - geometry
Output stringFormat - Display format for GEOMETRY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOMETRYOUTPUTFORMAT docs. - hybrid
Table numberLock Timeout - Number of seconds to wait while trying to acquire row-level locks on a hybrid table, before timing out and aborting the statement. For more information, check HYBRIDTABLELOCK_TIMEOUT docs.
- initial
Replication stringSize Limit In Tb - Sets the maximum estimated size limit for the initial replication of a primary database to a secondary database (in TB). Set this parameter on any account that stores a secondary database. This size limit helps prevent accounts from accidentally incurring large database replication charges. To remove the size limit, set the value to 0.0. It is required to pass numbers with scale of at least 1 (e.g. 20.5, 32.25, 33.333, etc.). For more information, check INITIALREPLICATIONSIZELIMITIN_TB docs.
- jdbc
Treat booleanDecimal As Int - Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
- jdbc
Treat booleanTimestamp Ntz As Utc - Specifies how JDBC processes TIMESTAMPNTZ values (more details). For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
- jdbc
Use booleanSession Timezone - Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the TIMEZONE parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check JDBCUSESESSION_TIMEZONE docs.
- js
Treat booleanInteger As Bigint - Specifies how the Snowflake Node.js Driver processes numeric columns that have a scale of zero (0), for example INTEGER or NUMBER(p, 0). For more information, check JSTREATINTEGERASBIGINT docs.
- json
Indent number - Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check JSON_INDENT docs.
- listing
Auto stringFulfillment Replication Refresh Schedule - Sets the time interval used to refresh the application package based data products to other regions. For more information, check LISTINGAUTOFULFILLMENTREPLICATIONREFRESH_SCHEDULE docs.
- lock
Timeout number - Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check LOCK_TIMEOUT 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. For more information about log levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
TRACE
|DEBUG
|INFO
|WARN
|ERROR
|FATAL
|OFF
. For more information, check LOG_LEVEL docs. - max
Concurrency numberLevel - Specifies the concurrency level for SQL statements (that is, queries and DML) executed by a warehouse (more details). For more information, check MAXCONCURRENCYLEVEL docs.
- max
Data numberExtension Time In Days - Maximum number of days Snowflake can extend the data retention period for tables to prevent streams on the tables from becoming stale. By default, if the DATARETENTIONTIMEINDAYS setting for a source table is less than 14 days, and a stream has not been consumed, Snowflake temporarily extends this period to the stream’s offset, up to a maximum of 14 days, regardless of the Snowflake Edition for your account. The MAXDATAEXTENSIONTIMEINDAYS parameter enables you to limit this automatic extension period to control storage costs for data retention or for compliance reasons. For more information, check DATAEXTENSIONTIMEINDAYS docsMAX.
- metric
Level string - Controls how metrics data is ingested into the event table. For more information about metric levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
ALL
|NONE
. For more information, check METRIC_LEVEL docs. - min
Data numberRetention Time In Days - Minimum number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on an object. If a minimum number of days for data retention is set on an account, the data retention period for an object is determined by MAX(DATARETENTIONTIMEINDAYS, MINDATARETENTIONTIMEINDAYS). For more information, check DATARETENTIONTIMEINDAYS docsMIN.
- multi
Statement numberCount - Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
- network
Policy string - Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see Controlling network traffic with network policies. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check NETWORK_POLICY docs. - noorder
Sequence booleanAs Default - Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in increasing or decreasing order. For more information, check NOORDERSEQUENCEAS_DEFAULT docs.
- oauth
Add booleanPrivileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from Snowflake’s authorization server. For more information, check OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST docs.
- odbc
Treat booleanDecimal As Int - Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
- packages
Policy string - Specifies packages policy for the current account.
- password
Policy string - Specifies password policy for the current account.
- periodic
Data booleanRekeying - It enables/disables re-encryption of table data with new keys on a yearly basis to provide additional levels of data protection (more details). For more information, check PERIODICDATAREKEYING docs.
- pipe
Execution booleanPaused - Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role (more details). For more information, check PIPEEXECUTIONPAUSED docs.
- prevent
Unload booleanTo Inline Url - Specifies whether to prevent ad hoc data unload operations to external cloud storage locations (that is, COPY INTO location statements that specify the cloud storage URL and access settings directly in the statement). For an example, see Unloading data from a table directly to files in an external location. For more information, check PREVENTUNLOADTOINLINEURL docs.
- prevent
Unload booleanTo Internal Stages - Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO location statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
- python
Profiler stringModules - Specifies the list of Python modules to include in a report when profiling Python handler code. For more information, check PYTHONPROFILERMODULES docs.
- python
Profiler stringTarget Stage - Specifies the fully-qualified name of the stage in which to save a report when profiling Python handler code. For more information, check PYTHONPROFILERTARGET_STAGE docs.
- query
Tag string - Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the QUERYHISTORY, QUERYHISTORY*BY** functions. For more information, check QUERY_TAG docs.
- quoted
Identifiers booleanIgnore Case - Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see Identifier resolution). You can use this parameter in situations in which third-party applications always use double quotes around identifiers. 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 Apache Iceberg™ tables that use an external catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- require
Storage booleanIntegration For Stage Creation - Specifies whether to require a storage integration object as cloud credentials when creating a named external stage (using CREATE STAGE) to access a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_CREATION docs.
- require
Storage booleanIntegration For Stage Operation - Specifies whether to require using a named external stage that references a storage integration object as cloud credentials when loading data from or unloading data to a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_OPERATION docs.
- resource
Monitor string - rows
Per numberResultset - Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
- s3Stage
Vpce stringDns Name - Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via AWS PrivateLink for Amazon S3 use this endpoint to connect. For more information, see Accessing Internal stages with dedicated interface endpoints. For more information, check S3STAGEVPCEDNSNAME docs.
- saml
Identity stringProvider - Enables federated authentication. This deprecated parameter enables federated authentication (more details). For more information, check SAMLIDENTITYPROVIDER docs.
- search
Path string - Specifies the path to search to resolve unqualified object names in queries. For more information, see Name resolution in queries. Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check SEARCH_PATH docs.
- serverless
Task stringMax Statement Size - Specifies the maximum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMAXSTATEMENTSIZE docs. - serverless
Task stringMin Statement Size - Specifies the minimum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMINSTATEMENTSIZE docs. - session
Policy string - Specifies session policy for the current account.
- simulated
Data stringSharing Consumer - Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
- sso
Login booleanPage - This deprecated parameter disables preview mode for testing SSO (after enabling federated authentication) before rolling it out to users. For more information, check SSOLOGINPAGE docs.
- statement
Queued numberTimeout In Seconds - Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the MAXCONCURRENCYLEVEL parameter to ensure a warehouse is never backlogged. For more information, check STATEMENTQUEUEDTIMEOUTINSECONDS docs.
- statement
Timeout numberIn Seconds - Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check STATEMENTTIMEOUTIN_SECONDS docs.
- storage
Serialization stringPolicy - Specifies the storage serialization policy for Snowflake-managed Apache Iceberg™ tables. Valid values are (case-insensitive):
COMPATIBLE
|OPTIMIZED
. For more information, check STORAGESERIALIZATIONPOLICY docs. - strict
Json booleanOutput - This parameter specifies whether JSON output in a session is compatible with the general standard (as described by http://json.org). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check STRICTJSONOUTPUT docs.
- suspend
Task numberAfter Num Failures - Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto numberRetry Attempts - Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- time
Input stringFormat - Specifies the input format for the TIME data type. For more information, see Date and time input and output formats. Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check TIMEINPUTFORMAT docs.
- time
Output stringFormat - Specifies the display format for the TIME data type. For more information, see Date and time input and output formats. For more information, check TIMEOUTPUTFORMAT docs.
- timestamp
Day booleanIs Always24h - Specifies whether the DATEADD function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check TIMESTAMPDAYISALWAYS24H docs.
- timestamp
Input stringFormat - Specifies the input format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check TIMESTAMPINPUTFORMAT docs.
- timestamp
Ltz stringOutput Format - Specifies the display format for the TIMESTAMPLTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPLTZOUTPUT*FORMAT docs.
- timestamp
Ntz stringOutput Format - Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
- timestamp
Output stringFormat - Specifies the display format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. For more information, check TIMESTAMPOUTPUTFORMAT docs.
- timestamp
Type stringMapping - Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
|TIMESTAMP_TZ
. For more information, check TIMESTAMP*TYPE_MAPPING docs. - timestamp
Tz stringOutput Format - Specifies the display format for the TIMESTAMPTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPTZOUTPUT*FORMAT docs.
- timezone string
- Specifies the time zone for the session. You can specify a time zone name or a link name from release 2021a of the IANA Time Zone Database (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check TIMEZONE docs.
- trace
Level string - Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. Valid values are (case-insensitive):
ALWAYS
|ON_EVENT
|PROPAGATE
|OFF
. For more information, check TRACE_LEVEL docs. - transaction
Abort booleanOn Error - Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check TRANSACTIONABORTON_ERROR docs.
- transaction
Default stringIsolation Level - Specifies the isolation level for transactions in the user session. Valid values are (case-insensitive):
READ COMMITTED
. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs. - two
Digit numberCentury Start - Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the
YY
date format component (i.e. years represented as 2 digits). For more information, check TWODIGITCENTURY_START docs. - unsupported
Ddl stringAction - Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
- use
Cached booleanResult - Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
- user
Task stringManaged Initial Warehouse Size - Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. 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 - Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
- week
Of numberYear Policy - Specifies how the weeks in a given year are computed.
0
: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year.1
: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check WEEKOFYEAR_POLICY docs. - week
Start number - Specifies the first day of the week (used by week-related date functions).
0
: Legacy Snowflake behavior is used (i.e. ISO-like semantics).1
(Monday) to7
(Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
- abort_
detached_ boolquery - Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check ABORTDETACHEDQUERY docs.
- active_
python_ strprofiler - Sets the profiler to use for the session when profiling Python handler code. Valid values are (case-insensitive):
LINE
|MEMORY
. For more information, check ACTIVEPYTHONPROFILER docs. - allow_
client_ boolmfa_ caching - Specifies whether an MFA token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to respond to an MFA prompt at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using MFA token caching to minimize the number of prompts during authentication — optional. For more information, check ALLOWCLIENTMFA_CACHING docs.
- allow_
id_ booltoken - Specifies whether a connection token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to enter login credentials at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using connection caching to minimize the number of prompts for authentication — optional. For more information, check ALLOWIDTOKEN docs.
- authentication_
policy str - Specifies authentication policy for the current account.
- autocommit bool
- Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see Transactions. For more information, check AUTOCOMMIT docs.
- base_
location_ strprefix - Specifies a prefix for Snowflake to use in the write path for Snowflake-managed Apache Iceberg™ tables. For more information, see data and metadata directories for Iceberg tables. For more information, check BASELOCATIONPREFIX docs.
- binary_
input_ strformat - The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
|UTF8
. For more information, check BINARYINPUTFORMAT docs. - binary_
output_ strformat - The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
. For more information, check BINARYOUTPUTFORMAT docs. - catalog str
- Specifies the catalog for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG docs. - catalog_
sync str - Specifies the name of your catalog integration for Snowflake Open Catalog. Snowflake syncs tables that use the specified catalog integration with your Snowflake Open Catalog account. For more information, see Sync a Snowflake-managed table with Snowflake Open Catalog. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG_SYNC docs. - client_
enable_ boollog_ info_ statement_ parameters - Enables users to log the data values bound to PreparedStatements (more details). For more information, check CLIENTENABLELOGINFOSTATEMENT_PARAMETERS docs.
- client_
encryption_ intkey_ size - Specifies the AES encryption key size, in bits, used by Snowflake to encrypt/decrypt files stored on internal stages (for loading/unloading data) when you use the SNOWFLAKEFULL encryption type. For more information, check ENCRYPTIONKEYSIZE docsCLIENT.
- client_
memory_ intlimit - Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check CLIENTMEMORYLIMIT docs.
- client_
metadata_ boolrequest_ use_ connection_ ctx - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check CLIENTMETADATAREQUESTUSECONNECTION_CTX docs.
- client_
metadata_ booluse_ session_ database - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases to the current database. The narrower search typically returns fewer rows and executes more quickly (more details on the usage). For more information, check CLIENTMETADATAUSESESSIONDATABASE docs.
- client_
prefetch_ intthreads - Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check CLIENTPREFETCHTHREADS docs.
- client_
result_ intchunk_ size - Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check CLIENTRESULTCHUNK_SIZE docs.
- client_
result_ boolcolumn_ case_ insensitive - Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
- client_
session_ boolkeep_ alive - Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check CLIENTSESSIONKEEP_ALIVE docs.
- client_
session_ intkeep_ alive_ heartbeat_ frequency - Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
- client_
timestamp_ strtype_ mapping - Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs. - cortex_
enabled_ strcross_ region - Specifies the regions where an inference request may be processed in case the request cannot be processed in the region where request is originally placed. Specifying DISABLED disables cross-region inferencing. For examples and details, see Cross-region inference. For more information, check CORTEXENABLEDCROSS_REGION docs.
- cortex_
models_ strallowlist - Specifies the models that users in the account can access. Use this parameter to allowlist models for all users in the account. If you need to provide specific users with access beyond what you’ve specified in the allowlist, use role-based access control instead. For more information, see Model allowlist. For more information, check CORTEXMODELSALLOWLIST docs.
- csv_
timestamp_ strformat - Specifies the format for TIMESTAMP values in CSV files downloaded from Snowsight. If this parameter is not set, TIMESTAMPLTZOUTPUT_FORMAT will be used for TIMESTAMPLTZ values, TZ*OUTPUT_FORMATTIMESTAMP will be used for TIMESTAMPTZ and NTZOUTPUTFORMATTIMESTAMP for TIMESTAMPNTZ values. For more information, see Date and time input and output formats or Download your query results. For more information, check TIMESTAMP*FORMAT docsCSV.
- data_
retention_ inttime_ in_ days - Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database, schema, or table. For more information, see Understanding & using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- date_
input_ strformat - Specifies the input format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEINPUTFORMAT docs.
- date_
output_ strformat - Specifies the display format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEOUTPUTFORMAT docs.
- default_
ddl_ strcollation - Sets the default collation used for the following DDL operations: CREATE TABLE, ALTER TABLE … ADD COLUMN. Setting this parameter forces all subsequently-created columns in the affected objects (table, schema, database, or account) to have the specified collation as the default, unless the collation for the column is explicitly defined in the DDL. For more information, check DEFAULTDDLCOLLATION docs.
- default_
notebook_ strcompute_ pool_ cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs. - default_
notebook_ strcompute_ pool_ gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs. - default_
null_ strordering - Specifies the default ordering of NULL values in a result set (more details). Valid values are (case-insensitive):
FIRST
|LAST
. For more information, check DEFAULTNULLORDERING docs. - default_
streamlit_ strnotebook_ warehouse - Specifies the name of the default warehouse to use when creating a notebook. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTSTREAMLITNOTEBOOK_WAREHOUSE docs. - bool
- Controls whether users in an account see a button to download data in Snowsight or the Classic Console, such as a table returned from running a query in a worksheet. If the button to download is hidden in Snowsight or the Classic Console, users can still download or export data using third-party software. For more information, check DISABLEUIDOWNLOAD_BUTTON docs.
- disable_
user_ boolprivilege_ grants - Controls whether users in an account can grant privileges directly to other users. Disabling user privilege grants (that is, setting DISABLEUSERPRIVILEGEGRANTS to TRUE) does not affect existing grants to users. Existing grants to users continue to confer privileges to those users. For more information, see GRANT \n\n … TO USER. For more information, check USERPRIVILEGEGRANTS docsDISABLE.
- enable_
automatic_ boolsensitive_ data_ classification_ log - Controls whether events from automatic sensitive data classification are logged in the user event table. For more information, check ENABLEAUTOMATICSENSITIVEDATACLASSIFICATION_LOG docs.
- enable_
egress_ boolcost_ optimizer - Enables or disables the Listing Cross-cloud auto-fulfillment Egress cost optimizer. For more information, check ENABLEEGRESSCOST_OPTIMIZER docs.
- enable_
identifier_ boolfirst_ login - Determines the login flow for users. When enabled, Snowflake prompts users for their username or email address before presenting authentication methods. For details, see Identifier-first login. For more information, check ENABLEIDENTIFIERFIRST_LOGIN docs.
- enable_
internal_ boolstages_ privatelink - Specifies whether the SYSTEM$GETPRIVATELINKCONFIG function returns the private-internal-stages key in the query result. The corresponding value in the query result is used during the configuration process for private connectivity to internal stages. For more information, check ENABLEINTERNALSTAGES_PRIVATELINK docs.
- enable_
tri_ boolsecret_ and_ rekey_ opt_ out_ for_ image_ repository - Specifies choice for the image repository to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORIMAGE_REPOSITORY docs.
- enable_
tri_ boolsecret_ and_ rekey_ opt_ out_ for_ spcs_ block_ storage - Specifies the choice for the Snowpark Container Services block storage volume to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORSPCSBLOCKSTORAGE docs.
- enable_
unhandled_ boolexceptions_ reporting - Specifies whether Snowflake may capture – in an event table – log messages or trace event data for unhandled exceptions in procedure or UDF handler code. For more information, see Capturing messages from unhandled exceptions. For more information, check ENABLEUNHANDLEDEXCEPTIONS_REPORTING docs.
- enable_
unload_ boolphysical_ type_ optimization - Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check ENABLEUNLOADPHYSICALTYPEOPTIMIZATION docs.
- enable_
unredacted_ boolquery_ syntax_ error - Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If FALSE, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDQUERYSYNTAXERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check UNREDACTEDQUERYSYNTAXERROR docsENABLE.
- enable_
unredacted_ boolsecure_ object_ error - Controls whether error messages related to secure objects are redacted in metadata. For more information, see Secure objects: Redaction of information in error messages. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDSECUREOBJECTERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the redacted error messages in metadata, not the user who caused the error. For more information, check UNREDACTEDSECUREOBJECTERROR docsENABLE.
- enforce_
network_ boolrules_ for_ internal_ stages - Specifies whether a network policy that uses network rules can restrict access to AWS internal stages. This parameter has no effect on network policies that do not use network rules. This account-level parameter affects both account-level and user-level network policies. For details about using network policies and network rules to restrict access to AWS internal stages, including the use of this parameter, see Protecting internal stages on AWS. For more information, check ENFORCENETWORKRULESFORINTERNAL_STAGES docs.
- error_
on_ boolnondeterministic_ merge - Specifies whether to return an error when the MERGE command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_MERGE docs.
- error_
on_ boolnondeterministic_ update - Specifies whether to return an error when the UPDATE command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_UPDATE docs.
- event_
table str - Specifies the name of the event table for logging messages from stored procedures and UDFs contained by the object with which the event table is associated. Associating an event table with a database is available in Enterprise Edition or higher. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EVENT_TABLE docs. - external_
oauth_ booladd_ privileged_ roles_ to_ blocked_ list - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from the External OAuth authorization server. For more information, check EXTERNALOAUTHADDPRIVILEGEDROLESTOBLOCKED_LIST docs.
- external_
volume str - Specifies the external volume for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EXTERNAL_VOLUME docs. - feature_
policy str - Specifies feature policy for the current account.
- geography_
output_ strformat - Display format for GEOGRAPHY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOGRAPHYOUTPUTFORMAT docs. - geometry_
output_ strformat - Display format for GEOMETRY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOMETRYOUTPUTFORMAT docs. - hybrid_
table_ intlock_ timeout - Number of seconds to wait while trying to acquire row-level locks on a hybrid table, before timing out and aborting the statement. For more information, check HYBRIDTABLELOCK_TIMEOUT docs.
- initial_
replication_ strsize_ limit_ in_ tb - Sets the maximum estimated size limit for the initial replication of a primary database to a secondary database (in TB). Set this parameter on any account that stores a secondary database. This size limit helps prevent accounts from accidentally incurring large database replication charges. To remove the size limit, set the value to 0.0. It is required to pass numbers with scale of at least 1 (e.g. 20.5, 32.25, 33.333, etc.). For more information, check INITIALREPLICATIONSIZELIMITIN_TB docs.
- jdbc_
treat_ booldecimal_ as_ int - Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
- jdbc_
treat_ booltimestamp_ ntz_ as_ utc - Specifies how JDBC processes TIMESTAMPNTZ values (more details). For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
- jdbc_
use_ boolsession_ timezone - Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the TIMEZONE parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check JDBCUSESESSION_TIMEZONE docs.
- js_
treat_ boolinteger_ as_ bigint - Specifies how the Snowflake Node.js Driver processes numeric columns that have a scale of zero (0), for example INTEGER or NUMBER(p, 0). For more information, check JSTREATINTEGERASBIGINT docs.
- json_
indent int - Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check JSON_INDENT docs.
- listing_
auto_ strfulfillment_ replication_ refresh_ schedule - Sets the time interval used to refresh the application package based data products to other regions. For more information, check LISTINGAUTOFULFILLMENTREPLICATIONREFRESH_SCHEDULE docs.
- lock_
timeout int - Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check LOCK_TIMEOUT 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. For more information about log levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
TRACE
|DEBUG
|INFO
|WARN
|ERROR
|FATAL
|OFF
. For more information, check LOG_LEVEL docs. - max_
concurrency_ intlevel - Specifies the concurrency level for SQL statements (that is, queries and DML) executed by a warehouse (more details). For more information, check MAXCONCURRENCYLEVEL docs.
- max_
data_ intextension_ time_ in_ days - Maximum number of days Snowflake can extend the data retention period for tables to prevent streams on the tables from becoming stale. By default, if the DATARETENTIONTIMEINDAYS setting for a source table is less than 14 days, and a stream has not been consumed, Snowflake temporarily extends this period to the stream’s offset, up to a maximum of 14 days, regardless of the Snowflake Edition for your account. The MAXDATAEXTENSIONTIMEINDAYS parameter enables you to limit this automatic extension period to control storage costs for data retention or for compliance reasons. For more information, check DATAEXTENSIONTIMEINDAYS docsMAX.
- metric_
level str - Controls how metrics data is ingested into the event table. For more information about metric levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
ALL
|NONE
. For more information, check METRIC_LEVEL docs. - min_
data_ intretention_ time_ in_ days - Minimum number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on an object. If a minimum number of days for data retention is set on an account, the data retention period for an object is determined by MAX(DATARETENTIONTIMEINDAYS, MINDATARETENTIONTIMEINDAYS). For more information, check DATARETENTIONTIMEINDAYS docsMIN.
- multi_
statement_ intcount - Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
- network_
policy str - Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see Controlling network traffic with network policies. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check NETWORK_POLICY docs. - noorder_
sequence_ boolas_ default - Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in increasing or decreasing order. For more information, check NOORDERSEQUENCEAS_DEFAULT docs.
- oauth_
add_ boolprivileged_ roles_ to_ blocked_ list - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from Snowflake’s authorization server. For more information, check OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST docs.
- odbc_
treat_ booldecimal_ as_ int - Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
- packages_
policy str - Specifies packages policy for the current account.
- password_
policy str - Specifies password policy for the current account.
- periodic_
data_ boolrekeying - It enables/disables re-encryption of table data with new keys on a yearly basis to provide additional levels of data protection (more details). For more information, check PERIODICDATAREKEYING docs.
- pipe_
execution_ boolpaused - Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role (more details). For more information, check PIPEEXECUTIONPAUSED docs.
- prevent_
unload_ boolto_ inline_ url - Specifies whether to prevent ad hoc data unload operations to external cloud storage locations (that is, COPY INTO location statements that specify the cloud storage URL and access settings directly in the statement). For an example, see Unloading data from a table directly to files in an external location. For more information, check PREVENTUNLOADTOINLINEURL docs.
- prevent_
unload_ boolto_ internal_ stages - Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO location statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
- python_
profiler_ strmodules - Specifies the list of Python modules to include in a report when profiling Python handler code. For more information, check PYTHONPROFILERMODULES docs.
- python_
profiler_ strtarget_ stage - Specifies the fully-qualified name of the stage in which to save a report when profiling Python handler code. For more information, check PYTHONPROFILERTARGET_STAGE docs.
- query_
tag str - Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the QUERYHISTORY, QUERYHISTORY*BY** functions. For more information, check QUERY_TAG docs.
- quoted_
identifiers_ boolignore_ case - Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see Identifier resolution). You can use this parameter in situations in which third-party applications always use double quotes around identifiers. 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 Apache Iceberg™ tables that use an external catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- require_
storage_ boolintegration_ for_ stage_ creation - Specifies whether to require a storage integration object as cloud credentials when creating a named external stage (using CREATE STAGE) to access a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_CREATION docs.
- require_
storage_ boolintegration_ for_ stage_ operation - Specifies whether to require using a named external stage that references a storage integration object as cloud credentials when loading data from or unloading data to a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_OPERATION docs.
- resource_
monitor str - rows_
per_ intresultset - Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
- s3_
stage_ strvpce_ dns_ name - Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via AWS PrivateLink for Amazon S3 use this endpoint to connect. For more information, see Accessing Internal stages with dedicated interface endpoints. For more information, check S3STAGEVPCEDNSNAME docs.
- saml_
identity_ strprovider - Enables federated authentication. This deprecated parameter enables federated authentication (more details). For more information, check SAMLIDENTITYPROVIDER docs.
- search_
path str - Specifies the path to search to resolve unqualified object names in queries. For more information, see Name resolution in queries. Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check SEARCH_PATH docs.
- serverless_
task_ strmax_ statement_ size - Specifies the maximum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMAXSTATEMENTSIZE docs. - serverless_
task_ strmin_ statement_ size - Specifies the minimum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMINSTATEMENTSIZE docs. - session_
policy str - Specifies session policy for the current account.
- simulated_
data_ strsharing_ consumer - Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
- sso_
login_ boolpage - This deprecated parameter disables preview mode for testing SSO (after enabling federated authentication) before rolling it out to users. For more information, check SSOLOGINPAGE docs.
- statement_
queued_ inttimeout_ in_ seconds - Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the MAXCONCURRENCYLEVEL parameter to ensure a warehouse is never backlogged. For more information, check STATEMENTQUEUEDTIMEOUTINSECONDS docs.
- statement_
timeout_ intin_ seconds - Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check STATEMENTTIMEOUTIN_SECONDS docs.
- storage_
serialization_ strpolicy - Specifies the storage serialization policy for Snowflake-managed Apache Iceberg™ tables. Valid values are (case-insensitive):
COMPATIBLE
|OPTIMIZED
. For more information, check STORAGESERIALIZATIONPOLICY docs. - strict_
json_ booloutput - This parameter specifies whether JSON output in a session is compatible with the general standard (as described by http://json.org). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check STRICTJSONOUTPUT docs.
- suspend_
task_ intafter_ num_ failures - Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task_
auto_ intretry_ attempts - Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- time_
input_ strformat - Specifies the input format for the TIME data type. For more information, see Date and time input and output formats. Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check TIMEINPUTFORMAT docs.
- time_
output_ strformat - Specifies the display format for the TIME data type. For more information, see Date and time input and output formats. For more information, check TIMEOUTPUTFORMAT docs.
- timestamp_
day_ boolis_ always24h - Specifies whether the DATEADD function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check TIMESTAMPDAYISALWAYS24H docs.
- timestamp_
input_ strformat - Specifies the input format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check TIMESTAMPINPUTFORMAT docs.
- timestamp_
ltz_ stroutput_ format - Specifies the display format for the TIMESTAMPLTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPLTZOUTPUT*FORMAT docs.
- timestamp_
ntz_ stroutput_ format - Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
- timestamp_
output_ strformat - Specifies the display format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. For more information, check TIMESTAMPOUTPUTFORMAT docs.
- timestamp_
type_ strmapping - Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
|TIMESTAMP_TZ
. For more information, check TIMESTAMP*TYPE_MAPPING docs. - timestamp_
tz_ stroutput_ format - Specifies the display format for the TIMESTAMPTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPTZOUTPUT*FORMAT docs.
- timezone str
- Specifies the time zone for the session. You can specify a time zone name or a link name from release 2021a of the IANA Time Zone Database (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check TIMEZONE docs.
- trace_
level str - Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. Valid values are (case-insensitive):
ALWAYS
|ON_EVENT
|PROPAGATE
|OFF
. For more information, check TRACE_LEVEL docs. - transaction_
abort_ boolon_ error - Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check TRANSACTIONABORTON_ERROR docs.
- transaction_
default_ strisolation_ level - Specifies the isolation level for transactions in the user session. Valid values are (case-insensitive):
READ COMMITTED
. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs. - two_
digit_ intcentury_ start - Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the
YY
date format component (i.e. years represented as 2 digits). For more information, check TWODIGITCENTURY_START docs. - unsupported_
ddl_ straction - Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
- use_
cached_ boolresult - Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
- user_
task_ strmanaged_ initial_ warehouse_ size - Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. 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 - Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
- week_
of_ intyear_ policy - Specifies how the weeks in a given year are computed.
0
: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year.1
: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check WEEKOFYEAR_POLICY docs. - week_
start int - Specifies the first day of the week (used by week-related date functions).
0
: Legacy Snowflake behavior is used (i.e. ISO-like semantics).1
(Monday) to7
(Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
- abort
Detached BooleanQuery - Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check ABORTDETACHEDQUERY docs.
- active
Python StringProfiler - Sets the profiler to use for the session when profiling Python handler code. Valid values are (case-insensitive):
LINE
|MEMORY
. For more information, check ACTIVEPYTHONPROFILER docs. - allow
Client BooleanMfa Caching - Specifies whether an MFA token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to respond to an MFA prompt at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using MFA token caching to minimize the number of prompts during authentication — optional. For more information, check ALLOWCLIENTMFA_CACHING docs.
- allow
Id BooleanToken - Specifies whether a connection token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to enter login credentials at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using connection caching to minimize the number of prompts for authentication — optional. For more information, check ALLOWIDTOKEN docs.
- authentication
Policy String - Specifies authentication policy for the current account.
- autocommit Boolean
- Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see Transactions. For more information, check AUTOCOMMIT docs.
- base
Location StringPrefix - Specifies a prefix for Snowflake to use in the write path for Snowflake-managed Apache Iceberg™ tables. For more information, see data and metadata directories for Iceberg tables. For more information, check BASELOCATIONPREFIX docs.
- binary
Input StringFormat - The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
|UTF8
. For more information, check BINARYINPUTFORMAT docs. - binary
Output StringFormat - The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
. For more information, check BINARYOUTPUTFORMAT docs. - catalog String
- Specifies the catalog for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG docs. - catalog
Sync String - Specifies the name of your catalog integration for Snowflake Open Catalog. Snowflake syncs tables that use the specified catalog integration with your Snowflake Open Catalog account. For more information, see Sync a Snowflake-managed table with Snowflake Open Catalog. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG_SYNC docs. - client
Enable BooleanLog Info Statement Parameters - Enables users to log the data values bound to PreparedStatements (more details). For more information, check CLIENTENABLELOGINFOSTATEMENT_PARAMETERS docs.
- client
Encryption NumberKey Size - Specifies the AES encryption key size, in bits, used by Snowflake to encrypt/decrypt files stored on internal stages (for loading/unloading data) when you use the SNOWFLAKEFULL encryption type. For more information, check ENCRYPTIONKEYSIZE docsCLIENT.
- client
Memory NumberLimit - Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check CLIENTMEMORYLIMIT docs.
- client
Metadata BooleanRequest Use Connection Ctx - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check CLIENTMETADATAREQUESTUSECONNECTION_CTX docs.
- client
Metadata BooleanUse Session Database - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases to the current database. The narrower search typically returns fewer rows and executes more quickly (more details on the usage). For more information, check CLIENTMETADATAUSESESSIONDATABASE docs.
- client
Prefetch NumberThreads - Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check CLIENTPREFETCHTHREADS docs.
- client
Result NumberChunk Size - Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check CLIENTRESULTCHUNK_SIZE docs.
- client
Result BooleanColumn Case Insensitive - Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
- client
Session BooleanKeep Alive - Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check CLIENTSESSIONKEEP_ALIVE docs.
- client
Session NumberKeep Alive Heartbeat Frequency - Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
- client
Timestamp StringType Mapping - Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs. - cortex
Enabled StringCross Region - Specifies the regions where an inference request may be processed in case the request cannot be processed in the region where request is originally placed. Specifying DISABLED disables cross-region inferencing. For examples and details, see Cross-region inference. For more information, check CORTEXENABLEDCROSS_REGION docs.
- cortex
Models StringAllowlist - Specifies the models that users in the account can access. Use this parameter to allowlist models for all users in the account. If you need to provide specific users with access beyond what you’ve specified in the allowlist, use role-based access control instead. For more information, see Model allowlist. For more information, check CORTEXMODELSALLOWLIST docs.
- csv
Timestamp StringFormat - Specifies the format for TIMESTAMP values in CSV files downloaded from Snowsight. If this parameter is not set, TIMESTAMPLTZOUTPUT_FORMAT will be used for TIMESTAMPLTZ values, TZ*OUTPUT_FORMATTIMESTAMP will be used for TIMESTAMPTZ and NTZOUTPUTFORMATTIMESTAMP for TIMESTAMPNTZ values. For more information, see Date and time input and output formats or Download your query results. For more information, check TIMESTAMP*FORMAT docsCSV.
- data
Retention NumberTime In Days - Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database, schema, or table. For more information, see Understanding & using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- date
Input StringFormat - Specifies the input format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEINPUTFORMAT docs.
- date
Output StringFormat - Specifies the display format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEOUTPUTFORMAT docs.
- default
Ddl StringCollation - Sets the default collation used for the following DDL operations: CREATE TABLE, ALTER TABLE … ADD COLUMN. Setting this parameter forces all subsequently-created columns in the affected objects (table, schema, database, or account) to have the specified collation as the default, unless the collation for the column is explicitly defined in the DDL. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook StringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs. - default
Notebook StringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs. - default
Null StringOrdering - Specifies the default ordering of NULL values in a result set (more details). Valid values are (case-insensitive):
FIRST
|LAST
. For more information, check DEFAULTNULLORDERING docs. - default
Streamlit StringNotebook Warehouse - Specifies the name of the default warehouse to use when creating a notebook. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTSTREAMLITNOTEBOOK_WAREHOUSE docs. - Boolean
- Controls whether users in an account see a button to download data in Snowsight or the Classic Console, such as a table returned from running a query in a worksheet. If the button to download is hidden in Snowsight or the Classic Console, users can still download or export data using third-party software. For more information, check DISABLEUIDOWNLOAD_BUTTON docs.
- disable
User BooleanPrivilege Grants - Controls whether users in an account can grant privileges directly to other users. Disabling user privilege grants (that is, setting DISABLEUSERPRIVILEGEGRANTS to TRUE) does not affect existing grants to users. Existing grants to users continue to confer privileges to those users. For more information, see GRANT \n\n … TO USER. For more information, check USERPRIVILEGEGRANTS docsDISABLE.
- enable
Automatic BooleanSensitive Data Classification Log - Controls whether events from automatic sensitive data classification are logged in the user event table. For more information, check ENABLEAUTOMATICSENSITIVEDATACLASSIFICATION_LOG docs.
- enable
Egress BooleanCost Optimizer - Enables or disables the Listing Cross-cloud auto-fulfillment Egress cost optimizer. For more information, check ENABLEEGRESSCOST_OPTIMIZER docs.
- enable
Identifier BooleanFirst Login - Determines the login flow for users. When enabled, Snowflake prompts users for their username or email address before presenting authentication methods. For details, see Identifier-first login. For more information, check ENABLEIDENTIFIERFIRST_LOGIN docs.
- enable
Internal BooleanStages Privatelink - Specifies whether the SYSTEM$GETPRIVATELINKCONFIG function returns the private-internal-stages key in the query result. The corresponding value in the query result is used during the configuration process for private connectivity to internal stages. For more information, check ENABLEINTERNALSTAGES_PRIVATELINK docs.
- enable
Tri BooleanSecret And Rekey Opt Out For Image Repository - Specifies choice for the image repository to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORIMAGE_REPOSITORY docs.
- enable
Tri BooleanSecret And Rekey Opt Out For Spcs Block Storage - Specifies the choice for the Snowpark Container Services block storage volume to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORSPCSBLOCKSTORAGE docs.
- enable
Unhandled BooleanExceptions Reporting - Specifies whether Snowflake may capture – in an event table – log messages or trace event data for unhandled exceptions in procedure or UDF handler code. For more information, see Capturing messages from unhandled exceptions. For more information, check ENABLEUNHANDLEDEXCEPTIONS_REPORTING docs.
- enable
Unload BooleanPhysical Type Optimization - Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check ENABLEUNLOADPHYSICALTYPEOPTIMIZATION docs.
- enable
Unredacted BooleanQuery Syntax Error - Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If FALSE, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDQUERYSYNTAXERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check UNREDACTEDQUERYSYNTAXERROR docsENABLE.
- enable
Unredacted BooleanSecure Object Error - Controls whether error messages related to secure objects are redacted in metadata. For more information, see Secure objects: Redaction of information in error messages. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDSECUREOBJECTERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the redacted error messages in metadata, not the user who caused the error. For more information, check UNREDACTEDSECUREOBJECTERROR docsENABLE.
- enforce
Network BooleanRules For Internal Stages - Specifies whether a network policy that uses network rules can restrict access to AWS internal stages. This parameter has no effect on network policies that do not use network rules. This account-level parameter affects both account-level and user-level network policies. For details about using network policies and network rules to restrict access to AWS internal stages, including the use of this parameter, see Protecting internal stages on AWS. For more information, check ENFORCENETWORKRULESFORINTERNAL_STAGES docs.
- error
On BooleanNondeterministic Merge - Specifies whether to return an error when the MERGE command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_MERGE docs.
- error
On BooleanNondeterministic Update - Specifies whether to return an error when the UPDATE command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_UPDATE docs.
- event
Table String - Specifies the name of the event table for logging messages from stored procedures and UDFs contained by the object with which the event table is associated. Associating an event table with a database is available in Enterprise Edition or higher. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EVENT_TABLE docs. - external
Oauth BooleanAdd Privileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from the External OAuth authorization server. For more information, check EXTERNALOAUTHADDPRIVILEGEDROLESTOBLOCKED_LIST docs.
- external
Volume String - Specifies the external volume for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EXTERNAL_VOLUME docs. - feature
Policy String - Specifies feature policy for the current account.
- geography
Output StringFormat - Display format for GEOGRAPHY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOGRAPHYOUTPUTFORMAT docs. - geometry
Output StringFormat - Display format for GEOMETRY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOMETRYOUTPUTFORMAT docs. - hybrid
Table NumberLock Timeout - Number of seconds to wait while trying to acquire row-level locks on a hybrid table, before timing out and aborting the statement. For more information, check HYBRIDTABLELOCK_TIMEOUT docs.
- initial
Replication StringSize Limit In Tb - Sets the maximum estimated size limit for the initial replication of a primary database to a secondary database (in TB). Set this parameter on any account that stores a secondary database. This size limit helps prevent accounts from accidentally incurring large database replication charges. To remove the size limit, set the value to 0.0. It is required to pass numbers with scale of at least 1 (e.g. 20.5, 32.25, 33.333, etc.). For more information, check INITIALREPLICATIONSIZELIMITIN_TB docs.
- jdbc
Treat BooleanDecimal As Int - Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
- jdbc
Treat BooleanTimestamp Ntz As Utc - Specifies how JDBC processes TIMESTAMPNTZ values (more details). For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
- jdbc
Use BooleanSession Timezone - Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the TIMEZONE parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check JDBCUSESESSION_TIMEZONE docs.
- js
Treat BooleanInteger As Bigint - Specifies how the Snowflake Node.js Driver processes numeric columns that have a scale of zero (0), for example INTEGER or NUMBER(p, 0). For more information, check JSTREATINTEGERASBIGINT docs.
- json
Indent Number - Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check JSON_INDENT docs.
- listing
Auto StringFulfillment Replication Refresh Schedule - Sets the time interval used to refresh the application package based data products to other regions. For more information, check LISTINGAUTOFULFILLMENTREPLICATIONREFRESH_SCHEDULE docs.
- lock
Timeout Number - Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check LOCK_TIMEOUT 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. For more information about log levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
TRACE
|DEBUG
|INFO
|WARN
|ERROR
|FATAL
|OFF
. For more information, check LOG_LEVEL docs. - max
Concurrency NumberLevel - Specifies the concurrency level for SQL statements (that is, queries and DML) executed by a warehouse (more details). For more information, check MAXCONCURRENCYLEVEL docs.
- max
Data NumberExtension Time In Days - Maximum number of days Snowflake can extend the data retention period for tables to prevent streams on the tables from becoming stale. By default, if the DATARETENTIONTIMEINDAYS setting for a source table is less than 14 days, and a stream has not been consumed, Snowflake temporarily extends this period to the stream’s offset, up to a maximum of 14 days, regardless of the Snowflake Edition for your account. The MAXDATAEXTENSIONTIMEINDAYS parameter enables you to limit this automatic extension period to control storage costs for data retention or for compliance reasons. For more information, check DATAEXTENSIONTIMEINDAYS docsMAX.
- metric
Level String - Controls how metrics data is ingested into the event table. For more information about metric levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
ALL
|NONE
. For more information, check METRIC_LEVEL docs. - min
Data NumberRetention Time In Days - Minimum number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on an object. If a minimum number of days for data retention is set on an account, the data retention period for an object is determined by MAX(DATARETENTIONTIMEINDAYS, MINDATARETENTIONTIMEINDAYS). For more information, check DATARETENTIONTIMEINDAYS docsMIN.
- multi
Statement NumberCount - Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
- network
Policy String - Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see Controlling network traffic with network policies. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check NETWORK_POLICY docs. - noorder
Sequence BooleanAs Default - Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in increasing or decreasing order. For more information, check NOORDERSEQUENCEAS_DEFAULT docs.
- oauth
Add BooleanPrivileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from Snowflake’s authorization server. For more information, check OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST docs.
- odbc
Treat BooleanDecimal As Int - Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
- packages
Policy String - Specifies packages policy for the current account.
- password
Policy String - Specifies password policy for the current account.
- periodic
Data BooleanRekeying - It enables/disables re-encryption of table data with new keys on a yearly basis to provide additional levels of data protection (more details). For more information, check PERIODICDATAREKEYING docs.
- pipe
Execution BooleanPaused - Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role (more details). For more information, check PIPEEXECUTIONPAUSED docs.
- prevent
Unload BooleanTo Inline Url - Specifies whether to prevent ad hoc data unload operations to external cloud storage locations (that is, COPY INTO location statements that specify the cloud storage URL and access settings directly in the statement). For an example, see Unloading data from a table directly to files in an external location. For more information, check PREVENTUNLOADTOINLINEURL docs.
- prevent
Unload BooleanTo Internal Stages - Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO location statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
- python
Profiler StringModules - Specifies the list of Python modules to include in a report when profiling Python handler code. For more information, check PYTHONPROFILERMODULES docs.
- python
Profiler StringTarget Stage - Specifies the fully-qualified name of the stage in which to save a report when profiling Python handler code. For more information, check PYTHONPROFILERTARGET_STAGE docs.
- query
Tag String - Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the QUERYHISTORY, QUERYHISTORY*BY** functions. For more information, check QUERY_TAG docs.
- quoted
Identifiers BooleanIgnore Case - Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see Identifier resolution). You can use this parameter in situations in which third-party applications always use double quotes around identifiers. 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 Apache Iceberg™ tables that use an external catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- require
Storage BooleanIntegration For Stage Creation - Specifies whether to require a storage integration object as cloud credentials when creating a named external stage (using CREATE STAGE) to access a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_CREATION docs.
- require
Storage BooleanIntegration For Stage Operation - Specifies whether to require using a named external stage that references a storage integration object as cloud credentials when loading data from or unloading data to a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_OPERATION docs.
- resource
Monitor String - rows
Per NumberResultset - Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
- s3Stage
Vpce StringDns Name - Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via AWS PrivateLink for Amazon S3 use this endpoint to connect. For more information, see Accessing Internal stages with dedicated interface endpoints. For more information, check S3STAGEVPCEDNSNAME docs.
- saml
Identity StringProvider - Enables federated authentication. This deprecated parameter enables federated authentication (more details). For more information, check SAMLIDENTITYPROVIDER docs.
- search
Path String - Specifies the path to search to resolve unqualified object names in queries. For more information, see Name resolution in queries. Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check SEARCH_PATH docs.
- serverless
Task StringMax Statement Size - Specifies the maximum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMAXSTATEMENTSIZE docs. - serverless
Task StringMin Statement Size - Specifies the minimum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMINSTATEMENTSIZE docs. - session
Policy String - Specifies session policy for the current account.
- simulated
Data StringSharing Consumer - Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
- sso
Login BooleanPage - This deprecated parameter disables preview mode for testing SSO (after enabling federated authentication) before rolling it out to users. For more information, check SSOLOGINPAGE docs.
- statement
Queued NumberTimeout In Seconds - Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the MAXCONCURRENCYLEVEL parameter to ensure a warehouse is never backlogged. For more information, check STATEMENTQUEUEDTIMEOUTINSECONDS docs.
- statement
Timeout NumberIn Seconds - Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check STATEMENTTIMEOUTIN_SECONDS docs.
- storage
Serialization StringPolicy - Specifies the storage serialization policy for Snowflake-managed Apache Iceberg™ tables. Valid values are (case-insensitive):
COMPATIBLE
|OPTIMIZED
. For more information, check STORAGESERIALIZATIONPOLICY docs. - strict
Json BooleanOutput - This parameter specifies whether JSON output in a session is compatible with the general standard (as described by http://json.org). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check STRICTJSONOUTPUT docs.
- suspend
Task NumberAfter Num Failures - Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto NumberRetry Attempts - Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- time
Input StringFormat - Specifies the input format for the TIME data type. For more information, see Date and time input and output formats. Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check TIMEINPUTFORMAT docs.
- time
Output StringFormat - Specifies the display format for the TIME data type. For more information, see Date and time input and output formats. For more information, check TIMEOUTPUTFORMAT docs.
- timestamp
Day BooleanIs Always24h - Specifies whether the DATEADD function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check TIMESTAMPDAYISALWAYS24H docs.
- timestamp
Input StringFormat - Specifies the input format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check TIMESTAMPINPUTFORMAT docs.
- timestamp
Ltz StringOutput Format - Specifies the display format for the TIMESTAMPLTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPLTZOUTPUT*FORMAT docs.
- timestamp
Ntz StringOutput Format - Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
- timestamp
Output StringFormat - Specifies the display format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. For more information, check TIMESTAMPOUTPUTFORMAT docs.
- timestamp
Type StringMapping - Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
|TIMESTAMP_TZ
. For more information, check TIMESTAMP*TYPE_MAPPING docs. - timestamp
Tz StringOutput Format - Specifies the display format for the TIMESTAMPTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPTZOUTPUT*FORMAT docs.
- timezone String
- Specifies the time zone for the session. You can specify a time zone name or a link name from release 2021a of the IANA Time Zone Database (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check TIMEZONE docs.
- trace
Level String - Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. Valid values are (case-insensitive):
ALWAYS
|ON_EVENT
|PROPAGATE
|OFF
. For more information, check TRACE_LEVEL docs. - transaction
Abort BooleanOn Error - Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check TRANSACTIONABORTON_ERROR docs.
- transaction
Default StringIsolation Level - Specifies the isolation level for transactions in the user session. Valid values are (case-insensitive):
READ COMMITTED
. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs. - two
Digit NumberCentury Start - Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the
YY
date format component (i.e. years represented as 2 digits). For more information, check TWODIGITCENTURY_START docs. - unsupported
Ddl StringAction - Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
- use
Cached BooleanResult - Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
- user
Task StringManaged Initial Warehouse Size - Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. 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 - Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
- week
Of NumberYear Policy - Specifies how the weeks in a given year are computed.
0
: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year.1
: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check WEEKOFYEAR_POLICY docs. - week
Start Number - Specifies the first day of the week (used by week-related date functions).
0
: Legacy Snowflake behavior is used (i.e. ISO-like semantics).1
(Monday) to7
(Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
Outputs
All input properties are implicitly available as output properties. Additionally, the CurrentAccount resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing CurrentAccount Resource
Get an existing CurrentAccount 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?: CurrentAccountState, opts?: CustomResourceOptions): CurrentAccount
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
abort_detached_query: Optional[bool] = None,
active_python_profiler: Optional[str] = None,
allow_client_mfa_caching: Optional[bool] = None,
allow_id_token: Optional[bool] = None,
authentication_policy: Optional[str] = None,
autocommit: Optional[bool] = None,
base_location_prefix: Optional[str] = None,
binary_input_format: Optional[str] = None,
binary_output_format: Optional[str] = None,
catalog: Optional[str] = None,
catalog_sync: Optional[str] = None,
client_enable_log_info_statement_parameters: Optional[bool] = None,
client_encryption_key_size: Optional[int] = None,
client_memory_limit: Optional[int] = None,
client_metadata_request_use_connection_ctx: Optional[bool] = None,
client_metadata_use_session_database: Optional[bool] = None,
client_prefetch_threads: Optional[int] = None,
client_result_chunk_size: Optional[int] = None,
client_result_column_case_insensitive: Optional[bool] = None,
client_session_keep_alive: Optional[bool] = None,
client_session_keep_alive_heartbeat_frequency: Optional[int] = None,
client_timestamp_type_mapping: Optional[str] = None,
cortex_enabled_cross_region: Optional[str] = None,
cortex_models_allowlist: Optional[str] = None,
csv_timestamp_format: Optional[str] = None,
data_retention_time_in_days: Optional[int] = None,
date_input_format: Optional[str] = None,
date_output_format: Optional[str] = None,
default_ddl_collation: Optional[str] = None,
default_notebook_compute_pool_cpu: Optional[str] = None,
default_notebook_compute_pool_gpu: Optional[str] = None,
default_null_ordering: Optional[str] = None,
default_streamlit_notebook_warehouse: Optional[str] = None,
disable_ui_download_button: Optional[bool] = None,
disable_user_privilege_grants: Optional[bool] = None,
enable_automatic_sensitive_data_classification_log: Optional[bool] = None,
enable_egress_cost_optimizer: Optional[bool] = None,
enable_identifier_first_login: Optional[bool] = None,
enable_internal_stages_privatelink: Optional[bool] = None,
enable_tri_secret_and_rekey_opt_out_for_image_repository: Optional[bool] = None,
enable_tri_secret_and_rekey_opt_out_for_spcs_block_storage: Optional[bool] = None,
enable_unhandled_exceptions_reporting: Optional[bool] = None,
enable_unload_physical_type_optimization: Optional[bool] = None,
enable_unredacted_query_syntax_error: Optional[bool] = None,
enable_unredacted_secure_object_error: Optional[bool] = None,
enforce_network_rules_for_internal_stages: Optional[bool] = None,
error_on_nondeterministic_merge: Optional[bool] = None,
error_on_nondeterministic_update: Optional[bool] = None,
event_table: Optional[str] = None,
external_oauth_add_privileged_roles_to_blocked_list: Optional[bool] = None,
external_volume: Optional[str] = None,
feature_policy: Optional[str] = None,
geography_output_format: Optional[str] = None,
geometry_output_format: Optional[str] = None,
hybrid_table_lock_timeout: Optional[int] = None,
initial_replication_size_limit_in_tb: Optional[str] = None,
jdbc_treat_decimal_as_int: Optional[bool] = None,
jdbc_treat_timestamp_ntz_as_utc: Optional[bool] = None,
jdbc_use_session_timezone: Optional[bool] = None,
js_treat_integer_as_bigint: Optional[bool] = None,
json_indent: Optional[int] = None,
listing_auto_fulfillment_replication_refresh_schedule: Optional[str] = None,
lock_timeout: Optional[int] = None,
log_level: Optional[str] = None,
max_concurrency_level: Optional[int] = None,
max_data_extension_time_in_days: Optional[int] = None,
metric_level: Optional[str] = None,
min_data_retention_time_in_days: Optional[int] = None,
multi_statement_count: Optional[int] = None,
network_policy: Optional[str] = None,
noorder_sequence_as_default: Optional[bool] = None,
oauth_add_privileged_roles_to_blocked_list: Optional[bool] = None,
odbc_treat_decimal_as_int: Optional[bool] = None,
packages_policy: Optional[str] = None,
password_policy: Optional[str] = None,
periodic_data_rekeying: Optional[bool] = None,
pipe_execution_paused: Optional[bool] = None,
prevent_unload_to_inline_url: Optional[bool] = None,
prevent_unload_to_internal_stages: Optional[bool] = None,
python_profiler_modules: Optional[str] = None,
python_profiler_target_stage: Optional[str] = None,
query_tag: Optional[str] = None,
quoted_identifiers_ignore_case: Optional[bool] = None,
replace_invalid_characters: Optional[bool] = None,
require_storage_integration_for_stage_creation: Optional[bool] = None,
require_storage_integration_for_stage_operation: Optional[bool] = None,
resource_monitor: Optional[str] = None,
rows_per_resultset: Optional[int] = None,
s3_stage_vpce_dns_name: Optional[str] = None,
saml_identity_provider: Optional[str] = None,
search_path: Optional[str] = None,
serverless_task_max_statement_size: Optional[str] = None,
serverless_task_min_statement_size: Optional[str] = None,
session_policy: Optional[str] = None,
simulated_data_sharing_consumer: Optional[str] = None,
sso_login_page: Optional[bool] = None,
statement_queued_timeout_in_seconds: Optional[int] = None,
statement_timeout_in_seconds: Optional[int] = None,
storage_serialization_policy: Optional[str] = None,
strict_json_output: Optional[bool] = None,
suspend_task_after_num_failures: Optional[int] = None,
task_auto_retry_attempts: Optional[int] = None,
time_input_format: Optional[str] = None,
time_output_format: Optional[str] = None,
timestamp_day_is_always24h: Optional[bool] = None,
timestamp_input_format: Optional[str] = None,
timestamp_ltz_output_format: Optional[str] = None,
timestamp_ntz_output_format: Optional[str] = None,
timestamp_output_format: Optional[str] = None,
timestamp_type_mapping: Optional[str] = None,
timestamp_tz_output_format: Optional[str] = None,
timezone: Optional[str] = None,
trace_level: Optional[str] = None,
transaction_abort_on_error: Optional[bool] = None,
transaction_default_isolation_level: Optional[str] = None,
two_digit_century_start: Optional[int] = None,
unsupported_ddl_action: Optional[str] = None,
use_cached_result: Optional[bool] = 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,
week_of_year_policy: Optional[int] = None,
week_start: Optional[int] = None) -> CurrentAccount
func GetCurrentAccount(ctx *Context, name string, id IDInput, state *CurrentAccountState, opts ...ResourceOption) (*CurrentAccount, error)
public static CurrentAccount Get(string name, Input<string> id, CurrentAccountState? state, CustomResourceOptions? opts = null)
public static CurrentAccount get(String name, Output<String> id, CurrentAccountState state, CustomResourceOptions options)
resources: _: type: snowflake:CurrentAccount get: 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.
- Abort
Detached boolQuery - Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check ABORTDETACHEDQUERY docs.
- Active
Python stringProfiler - Sets the profiler to use for the session when profiling Python handler code. Valid values are (case-insensitive):
LINE
|MEMORY
. For more information, check ACTIVEPYTHONPROFILER docs. - Allow
Client boolMfa Caching - Specifies whether an MFA token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to respond to an MFA prompt at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using MFA token caching to minimize the number of prompts during authentication — optional. For more information, check ALLOWCLIENTMFA_CACHING docs.
- Allow
Id boolToken - Specifies whether a connection token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to enter login credentials at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using connection caching to minimize the number of prompts for authentication — optional. For more information, check ALLOWIDTOKEN docs.
- Authentication
Policy string - Specifies authentication policy for the current account.
- Autocommit bool
- Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see Transactions. For more information, check AUTOCOMMIT docs.
- Base
Location stringPrefix - Specifies a prefix for Snowflake to use in the write path for Snowflake-managed Apache Iceberg™ tables. For more information, see data and metadata directories for Iceberg tables. For more information, check BASELOCATIONPREFIX docs.
- Binary
Input stringFormat - The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
|UTF8
. For more information, check BINARYINPUTFORMAT docs. - Binary
Output stringFormat - The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
. For more information, check BINARYOUTPUTFORMAT docs. - Catalog string
- Specifies the catalog for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG docs. - Catalog
Sync string - Specifies the name of your catalog integration for Snowflake Open Catalog. Snowflake syncs tables that use the specified catalog integration with your Snowflake Open Catalog account. For more information, see Sync a Snowflake-managed table with Snowflake Open Catalog. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG_SYNC docs. - Client
Enable boolLog Info Statement Parameters - Enables users to log the data values bound to PreparedStatements (more details). For more information, check CLIENTENABLELOGINFOSTATEMENT_PARAMETERS docs.
- Client
Encryption intKey Size - Specifies the AES encryption key size, in bits, used by Snowflake to encrypt/decrypt files stored on internal stages (for loading/unloading data) when you use the SNOWFLAKEFULL encryption type. For more information, check ENCRYPTIONKEYSIZE docsCLIENT.
- Client
Memory intLimit - Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check CLIENTMEMORYLIMIT docs.
- Client
Metadata boolRequest Use Connection Ctx - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check CLIENTMETADATAREQUESTUSECONNECTION_CTX docs.
- Client
Metadata boolUse Session Database - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases to the current database. The narrower search typically returns fewer rows and executes more quickly (more details on the usage). For more information, check CLIENTMETADATAUSESESSIONDATABASE docs.
- Client
Prefetch intThreads - Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check CLIENTPREFETCHTHREADS docs.
- Client
Result intChunk Size - Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check CLIENTRESULTCHUNK_SIZE docs.
- Client
Result boolColumn Case Insensitive - Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
- Client
Session boolKeep Alive - Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check CLIENTSESSIONKEEP_ALIVE docs.
- Client
Session intKeep Alive Heartbeat Frequency - Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
- Client
Timestamp stringType Mapping - Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs. - Cortex
Enabled stringCross Region - Specifies the regions where an inference request may be processed in case the request cannot be processed in the region where request is originally placed. Specifying DISABLED disables cross-region inferencing. For examples and details, see Cross-region inference. For more information, check CORTEXENABLEDCROSS_REGION docs.
- Cortex
Models stringAllowlist - Specifies the models that users in the account can access. Use this parameter to allowlist models for all users in the account. If you need to provide specific users with access beyond what you’ve specified in the allowlist, use role-based access control instead. For more information, see Model allowlist. For more information, check CORTEXMODELSALLOWLIST docs.
- Csv
Timestamp stringFormat - Specifies the format for TIMESTAMP values in CSV files downloaded from Snowsight. If this parameter is not set, TIMESTAMPLTZOUTPUT_FORMAT will be used for TIMESTAMPLTZ values, TZ*OUTPUT_FORMATTIMESTAMP will be used for TIMESTAMPTZ and NTZOUTPUTFORMATTIMESTAMP for TIMESTAMPNTZ values. For more information, see Date and time input and output formats or Download your query results. For more information, check TIMESTAMP*FORMAT docsCSV.
- Data
Retention intTime In Days - Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database, schema, or table. For more information, see Understanding & using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- Date
Input stringFormat - Specifies the input format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEINPUTFORMAT docs.
- Date
Output stringFormat - Specifies the display format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEOUTPUTFORMAT docs.
- Default
Ddl stringCollation - Sets the default collation used for the following DDL operations: CREATE TABLE, ALTER TABLE … ADD COLUMN. Setting this parameter forces all subsequently-created columns in the affected objects (table, schema, database, or account) to have the specified collation as the default, unless the collation for the column is explicitly defined in the DDL. For more information, check DEFAULTDDLCOLLATION docs.
- Default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs. - Default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs. - Default
Null stringOrdering - Specifies the default ordering of NULL values in a result set (more details). Valid values are (case-insensitive):
FIRST
|LAST
. For more information, check DEFAULTNULLORDERING docs. - Default
Streamlit stringNotebook Warehouse - Specifies the name of the default warehouse to use when creating a notebook. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTSTREAMLITNOTEBOOK_WAREHOUSE docs. - bool
- Controls whether users in an account see a button to download data in Snowsight or the Classic Console, such as a table returned from running a query in a worksheet. If the button to download is hidden in Snowsight or the Classic Console, users can still download or export data using third-party software. For more information, check DISABLEUIDOWNLOAD_BUTTON docs.
- Disable
User boolPrivilege Grants - Controls whether users in an account can grant privileges directly to other users. Disabling user privilege grants (that is, setting DISABLEUSERPRIVILEGEGRANTS to TRUE) does not affect existing grants to users. Existing grants to users continue to confer privileges to those users. For more information, see GRANT \n\n … TO USER. For more information, check USERPRIVILEGEGRANTS docsDISABLE.
- Enable
Automatic boolSensitive Data Classification Log - Controls whether events from automatic sensitive data classification are logged in the user event table. For more information, check ENABLEAUTOMATICSENSITIVEDATACLASSIFICATION_LOG docs.
- Enable
Egress boolCost Optimizer - Enables or disables the Listing Cross-cloud auto-fulfillment Egress cost optimizer. For more information, check ENABLEEGRESSCOST_OPTIMIZER docs.
- Enable
Identifier boolFirst Login - Determines the login flow for users. When enabled, Snowflake prompts users for their username or email address before presenting authentication methods. For details, see Identifier-first login. For more information, check ENABLEIDENTIFIERFIRST_LOGIN docs.
- Enable
Internal boolStages Privatelink - Specifies whether the SYSTEM$GETPRIVATELINKCONFIG function returns the private-internal-stages key in the query result. The corresponding value in the query result is used during the configuration process for private connectivity to internal stages. For more information, check ENABLEINTERNALSTAGES_PRIVATELINK docs.
- Enable
Tri boolSecret And Rekey Opt Out For Image Repository - Specifies choice for the image repository to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORIMAGE_REPOSITORY docs.
- Enable
Tri boolSecret And Rekey Opt Out For Spcs Block Storage - Specifies the choice for the Snowpark Container Services block storage volume to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORSPCSBLOCKSTORAGE docs.
- Enable
Unhandled boolExceptions Reporting - Specifies whether Snowflake may capture – in an event table – log messages or trace event data for unhandled exceptions in procedure or UDF handler code. For more information, see Capturing messages from unhandled exceptions. For more information, check ENABLEUNHANDLEDEXCEPTIONS_REPORTING docs.
- Enable
Unload boolPhysical Type Optimization - Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check ENABLEUNLOADPHYSICALTYPEOPTIMIZATION docs.
- Enable
Unredacted boolQuery Syntax Error - Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If FALSE, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDQUERYSYNTAXERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check UNREDACTEDQUERYSYNTAXERROR docsENABLE.
- Enable
Unredacted boolSecure Object Error - Controls whether error messages related to secure objects are redacted in metadata. For more information, see Secure objects: Redaction of information in error messages. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDSECUREOBJECTERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the redacted error messages in metadata, not the user who caused the error. For more information, check UNREDACTEDSECUREOBJECTERROR docsENABLE.
- Enforce
Network boolRules For Internal Stages - Specifies whether a network policy that uses network rules can restrict access to AWS internal stages. This parameter has no effect on network policies that do not use network rules. This account-level parameter affects both account-level and user-level network policies. For details about using network policies and network rules to restrict access to AWS internal stages, including the use of this parameter, see Protecting internal stages on AWS. For more information, check ENFORCENETWORKRULESFORINTERNAL_STAGES docs.
- Error
On boolNondeterministic Merge - Specifies whether to return an error when the MERGE command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_MERGE docs.
- Error
On boolNondeterministic Update - Specifies whether to return an error when the UPDATE command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_UPDATE docs.
- Event
Table string - Specifies the name of the event table for logging messages from stored procedures and UDFs contained by the object with which the event table is associated. Associating an event table with a database is available in Enterprise Edition or higher. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EVENT_TABLE docs. - External
Oauth boolAdd Privileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from the External OAuth authorization server. For more information, check EXTERNALOAUTHADDPRIVILEGEDROLESTOBLOCKED_LIST docs.
- External
Volume string - Specifies the external volume for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EXTERNAL_VOLUME docs. - Feature
Policy string - Specifies feature policy for the current account.
- Geography
Output stringFormat - Display format for GEOGRAPHY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOGRAPHYOUTPUTFORMAT docs. - Geometry
Output stringFormat - Display format for GEOMETRY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOMETRYOUTPUTFORMAT docs. - Hybrid
Table intLock Timeout - Number of seconds to wait while trying to acquire row-level locks on a hybrid table, before timing out and aborting the statement. For more information, check HYBRIDTABLELOCK_TIMEOUT docs.
- Initial
Replication stringSize Limit In Tb - Sets the maximum estimated size limit for the initial replication of a primary database to a secondary database (in TB). Set this parameter on any account that stores a secondary database. This size limit helps prevent accounts from accidentally incurring large database replication charges. To remove the size limit, set the value to 0.0. It is required to pass numbers with scale of at least 1 (e.g. 20.5, 32.25, 33.333, etc.). For more information, check INITIALREPLICATIONSIZELIMITIN_TB docs.
- Jdbc
Treat boolDecimal As Int - Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
- Jdbc
Treat boolTimestamp Ntz As Utc - Specifies how JDBC processes TIMESTAMPNTZ values (more details). For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
- Jdbc
Use boolSession Timezone - Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the TIMEZONE parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check JDBCUSESESSION_TIMEZONE docs.
- Js
Treat boolInteger As Bigint - Specifies how the Snowflake Node.js Driver processes numeric columns that have a scale of zero (0), for example INTEGER or NUMBER(p, 0). For more information, check JSTREATINTEGERASBIGINT docs.
- Json
Indent int - Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check JSON_INDENT docs.
- Listing
Auto stringFulfillment Replication Refresh Schedule - Sets the time interval used to refresh the application package based data products to other regions. For more information, check LISTINGAUTOFULFILLMENTREPLICATIONREFRESH_SCHEDULE docs.
- Lock
Timeout int - Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check LOCK_TIMEOUT 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. For more information about log levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
TRACE
|DEBUG
|INFO
|WARN
|ERROR
|FATAL
|OFF
. For more information, check LOG_LEVEL docs. - Max
Concurrency intLevel - Specifies the concurrency level for SQL statements (that is, queries and DML) executed by a warehouse (more details). For more information, check MAXCONCURRENCYLEVEL docs.
- Max
Data intExtension Time In Days - Maximum number of days Snowflake can extend the data retention period for tables to prevent streams on the tables from becoming stale. By default, if the DATARETENTIONTIMEINDAYS setting for a source table is less than 14 days, and a stream has not been consumed, Snowflake temporarily extends this period to the stream’s offset, up to a maximum of 14 days, regardless of the Snowflake Edition for your account. The MAXDATAEXTENSIONTIMEINDAYS parameter enables you to limit this automatic extension period to control storage costs for data retention or for compliance reasons. For more information, check DATAEXTENSIONTIMEINDAYS docsMAX.
- Metric
Level string - Controls how metrics data is ingested into the event table. For more information about metric levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
ALL
|NONE
. For more information, check METRIC_LEVEL docs. - Min
Data intRetention Time In Days - Minimum number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on an object. If a minimum number of days for data retention is set on an account, the data retention period for an object is determined by MAX(DATARETENTIONTIMEINDAYS, MINDATARETENTIONTIMEINDAYS). For more information, check DATARETENTIONTIMEINDAYS docsMIN.
- Multi
Statement intCount - Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
- Network
Policy string - Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see Controlling network traffic with network policies. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check NETWORK_POLICY docs. - Noorder
Sequence boolAs Default - Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in increasing or decreasing order. For more information, check NOORDERSEQUENCEAS_DEFAULT docs.
- Oauth
Add boolPrivileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from Snowflake’s authorization server. For more information, check OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST docs.
- Odbc
Treat boolDecimal As Int - Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
- Packages
Policy string - Specifies packages policy for the current account.
- Password
Policy string - Specifies password policy for the current account.
- Periodic
Data boolRekeying - It enables/disables re-encryption of table data with new keys on a yearly basis to provide additional levels of data protection (more details). For more information, check PERIODICDATAREKEYING docs.
- Pipe
Execution boolPaused - Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role (more details). For more information, check PIPEEXECUTIONPAUSED docs.
- Prevent
Unload boolTo Inline Url - Specifies whether to prevent ad hoc data unload operations to external cloud storage locations (that is, COPY INTO location statements that specify the cloud storage URL and access settings directly in the statement). For an example, see Unloading data from a table directly to files in an external location. For more information, check PREVENTUNLOADTOINLINEURL docs.
- Prevent
Unload boolTo Internal Stages - Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO location statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
- Python
Profiler stringModules - Specifies the list of Python modules to include in a report when profiling Python handler code. For more information, check PYTHONPROFILERMODULES docs.
- Python
Profiler stringTarget Stage - Specifies the fully-qualified name of the stage in which to save a report when profiling Python handler code. For more information, check PYTHONPROFILERTARGET_STAGE docs.
- Query
Tag string - Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the QUERYHISTORY, QUERYHISTORY*BY** functions. For more information, check QUERY_TAG docs.
- Quoted
Identifiers boolIgnore Case - Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see Identifier resolution). You can use this parameter in situations in which third-party applications always use double quotes around identifiers. 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 Apache Iceberg™ tables that use an external catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- Require
Storage boolIntegration For Stage Creation - Specifies whether to require a storage integration object as cloud credentials when creating a named external stage (using CREATE STAGE) to access a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_CREATION docs.
- Require
Storage boolIntegration For Stage Operation - Specifies whether to require using a named external stage that references a storage integration object as cloud credentials when loading data from or unloading data to a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_OPERATION docs.
- Resource
Monitor string - Rows
Per intResultset - Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
- S3Stage
Vpce stringDns Name - Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via AWS PrivateLink for Amazon S3 use this endpoint to connect. For more information, see Accessing Internal stages with dedicated interface endpoints. For more information, check S3STAGEVPCEDNSNAME docs.
- Saml
Identity stringProvider - Enables federated authentication. This deprecated parameter enables federated authentication (more details). For more information, check SAMLIDENTITYPROVIDER docs.
- Search
Path string - Specifies the path to search to resolve unqualified object names in queries. For more information, see Name resolution in queries. Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check SEARCH_PATH docs.
- Serverless
Task stringMax Statement Size - Specifies the maximum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMAXSTATEMENTSIZE docs. - Serverless
Task stringMin Statement Size - Specifies the minimum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMINSTATEMENTSIZE docs. - Session
Policy string - Specifies session policy for the current account.
- Simulated
Data stringSharing Consumer - Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
- Sso
Login boolPage - This deprecated parameter disables preview mode for testing SSO (after enabling federated authentication) before rolling it out to users. For more information, check SSOLOGINPAGE docs.
- Statement
Queued intTimeout In Seconds - Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the MAXCONCURRENCYLEVEL parameter to ensure a warehouse is never backlogged. For more information, check STATEMENTQUEUEDTIMEOUTINSECONDS docs.
- Statement
Timeout intIn Seconds - Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check STATEMENTTIMEOUTIN_SECONDS docs.
- Storage
Serialization stringPolicy - Specifies the storage serialization policy for Snowflake-managed Apache Iceberg™ tables. Valid values are (case-insensitive):
COMPATIBLE
|OPTIMIZED
. For more information, check STORAGESERIALIZATIONPOLICY docs. - Strict
Json boolOutput - This parameter specifies whether JSON output in a session is compatible with the general standard (as described by http://json.org). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check STRICTJSONOUTPUT docs.
- Suspend
Task intAfter Num Failures - Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- Task
Auto intRetry Attempts - Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- Time
Input stringFormat - Specifies the input format for the TIME data type. For more information, see Date and time input and output formats. Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check TIMEINPUTFORMAT docs.
- Time
Output stringFormat - Specifies the display format for the TIME data type. For more information, see Date and time input and output formats. For more information, check TIMEOUTPUTFORMAT docs.
- Timestamp
Day boolIs Always24h - Specifies whether the DATEADD function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check TIMESTAMPDAYISALWAYS24H docs.
- Timestamp
Input stringFormat - Specifies the input format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check TIMESTAMPINPUTFORMAT docs.
- Timestamp
Ltz stringOutput Format - Specifies the display format for the TIMESTAMPLTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPLTZOUTPUT*FORMAT docs.
- Timestamp
Ntz stringOutput Format - Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
- Timestamp
Output stringFormat - Specifies the display format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. For more information, check TIMESTAMPOUTPUTFORMAT docs.
- Timestamp
Type stringMapping - Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
|TIMESTAMP_TZ
. For more information, check TIMESTAMP*TYPE_MAPPING docs. - Timestamp
Tz stringOutput Format - Specifies the display format for the TIMESTAMPTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPTZOUTPUT*FORMAT docs.
- Timezone string
- Specifies the time zone for the session. You can specify a time zone name or a link name from release 2021a of the IANA Time Zone Database (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check TIMEZONE docs.
- Trace
Level string - Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. Valid values are (case-insensitive):
ALWAYS
|ON_EVENT
|PROPAGATE
|OFF
. For more information, check TRACE_LEVEL docs. - Transaction
Abort boolOn Error - Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check TRANSACTIONABORTON_ERROR docs.
- Transaction
Default stringIsolation Level - Specifies the isolation level for transactions in the user session. Valid values are (case-insensitive):
READ COMMITTED
. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs. - Two
Digit intCentury Start - Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the
YY
date format component (i.e. years represented as 2 digits). For more information, check TWODIGITCENTURY_START docs. - Unsupported
Ddl stringAction - Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
- Use
Cached boolResult - Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
- User
Task stringManaged Initial Warehouse Size - Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. 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 - Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
- Week
Of intYear Policy - Specifies how the weeks in a given year are computed.
0
: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year.1
: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check WEEKOFYEAR_POLICY docs. - Week
Start int - Specifies the first day of the week (used by week-related date functions).
0
: Legacy Snowflake behavior is used (i.e. ISO-like semantics).1
(Monday) to7
(Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
- Abort
Detached boolQuery - Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check ABORTDETACHEDQUERY docs.
- Active
Python stringProfiler - Sets the profiler to use for the session when profiling Python handler code. Valid values are (case-insensitive):
LINE
|MEMORY
. For more information, check ACTIVEPYTHONPROFILER docs. - Allow
Client boolMfa Caching - Specifies whether an MFA token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to respond to an MFA prompt at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using MFA token caching to minimize the number of prompts during authentication — optional. For more information, check ALLOWCLIENTMFA_CACHING docs.
- Allow
Id boolToken - Specifies whether a connection token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to enter login credentials at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using connection caching to minimize the number of prompts for authentication — optional. For more information, check ALLOWIDTOKEN docs.
- Authentication
Policy string - Specifies authentication policy for the current account.
- Autocommit bool
- Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see Transactions. For more information, check AUTOCOMMIT docs.
- Base
Location stringPrefix - Specifies a prefix for Snowflake to use in the write path for Snowflake-managed Apache Iceberg™ tables. For more information, see data and metadata directories for Iceberg tables. For more information, check BASELOCATIONPREFIX docs.
- Binary
Input stringFormat - The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
|UTF8
. For more information, check BINARYINPUTFORMAT docs. - Binary
Output stringFormat - The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
. For more information, check BINARYOUTPUTFORMAT docs. - Catalog string
- Specifies the catalog for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG docs. - Catalog
Sync string - Specifies the name of your catalog integration for Snowflake Open Catalog. Snowflake syncs tables that use the specified catalog integration with your Snowflake Open Catalog account. For more information, see Sync a Snowflake-managed table with Snowflake Open Catalog. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG_SYNC docs. - Client
Enable boolLog Info Statement Parameters - Enables users to log the data values bound to PreparedStatements (more details). For more information, check CLIENTENABLELOGINFOSTATEMENT_PARAMETERS docs.
- Client
Encryption intKey Size - Specifies the AES encryption key size, in bits, used by Snowflake to encrypt/decrypt files stored on internal stages (for loading/unloading data) when you use the SNOWFLAKEFULL encryption type. For more information, check ENCRYPTIONKEYSIZE docsCLIENT.
- Client
Memory intLimit - Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check CLIENTMEMORYLIMIT docs.
- Client
Metadata boolRequest Use Connection Ctx - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check CLIENTMETADATAREQUESTUSECONNECTION_CTX docs.
- Client
Metadata boolUse Session Database - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases to the current database. The narrower search typically returns fewer rows and executes more quickly (more details on the usage). For more information, check CLIENTMETADATAUSESESSIONDATABASE docs.
- Client
Prefetch intThreads - Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check CLIENTPREFETCHTHREADS docs.
- Client
Result intChunk Size - Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check CLIENTRESULTCHUNK_SIZE docs.
- Client
Result boolColumn Case Insensitive - Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
- Client
Session boolKeep Alive - Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check CLIENTSESSIONKEEP_ALIVE docs.
- Client
Session intKeep Alive Heartbeat Frequency - Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
- Client
Timestamp stringType Mapping - Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs. - Cortex
Enabled stringCross Region - Specifies the regions where an inference request may be processed in case the request cannot be processed in the region where request is originally placed. Specifying DISABLED disables cross-region inferencing. For examples and details, see Cross-region inference. For more information, check CORTEXENABLEDCROSS_REGION docs.
- Cortex
Models stringAllowlist - Specifies the models that users in the account can access. Use this parameter to allowlist models for all users in the account. If you need to provide specific users with access beyond what you’ve specified in the allowlist, use role-based access control instead. For more information, see Model allowlist. For more information, check CORTEXMODELSALLOWLIST docs.
- Csv
Timestamp stringFormat - Specifies the format for TIMESTAMP values in CSV files downloaded from Snowsight. If this parameter is not set, TIMESTAMPLTZOUTPUT_FORMAT will be used for TIMESTAMPLTZ values, TZ*OUTPUT_FORMATTIMESTAMP will be used for TIMESTAMPTZ and NTZOUTPUTFORMATTIMESTAMP for TIMESTAMPNTZ values. For more information, see Date and time input and output formats or Download your query results. For more information, check TIMESTAMP*FORMAT docsCSV.
- Data
Retention intTime In Days - Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database, schema, or table. For more information, see Understanding & using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- Date
Input stringFormat - Specifies the input format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEINPUTFORMAT docs.
- Date
Output stringFormat - Specifies the display format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEOUTPUTFORMAT docs.
- Default
Ddl stringCollation - Sets the default collation used for the following DDL operations: CREATE TABLE, ALTER TABLE … ADD COLUMN. Setting this parameter forces all subsequently-created columns in the affected objects (table, schema, database, or account) to have the specified collation as the default, unless the collation for the column is explicitly defined in the DDL. For more information, check DEFAULTDDLCOLLATION docs.
- Default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs. - Default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs. - Default
Null stringOrdering - Specifies the default ordering of NULL values in a result set (more details). Valid values are (case-insensitive):
FIRST
|LAST
. For more information, check DEFAULTNULLORDERING docs. - Default
Streamlit stringNotebook Warehouse - Specifies the name of the default warehouse to use when creating a notebook. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTSTREAMLITNOTEBOOK_WAREHOUSE docs. - bool
- Controls whether users in an account see a button to download data in Snowsight or the Classic Console, such as a table returned from running a query in a worksheet. If the button to download is hidden in Snowsight or the Classic Console, users can still download or export data using third-party software. For more information, check DISABLEUIDOWNLOAD_BUTTON docs.
- Disable
User boolPrivilege Grants - Controls whether users in an account can grant privileges directly to other users. Disabling user privilege grants (that is, setting DISABLEUSERPRIVILEGEGRANTS to TRUE) does not affect existing grants to users. Existing grants to users continue to confer privileges to those users. For more information, see GRANT \n\n … TO USER. For more information, check USERPRIVILEGEGRANTS docsDISABLE.
- Enable
Automatic boolSensitive Data Classification Log - Controls whether events from automatic sensitive data classification are logged in the user event table. For more information, check ENABLEAUTOMATICSENSITIVEDATACLASSIFICATION_LOG docs.
- Enable
Egress boolCost Optimizer - Enables or disables the Listing Cross-cloud auto-fulfillment Egress cost optimizer. For more information, check ENABLEEGRESSCOST_OPTIMIZER docs.
- Enable
Identifier boolFirst Login - Determines the login flow for users. When enabled, Snowflake prompts users for their username or email address before presenting authentication methods. For details, see Identifier-first login. For more information, check ENABLEIDENTIFIERFIRST_LOGIN docs.
- Enable
Internal boolStages Privatelink - Specifies whether the SYSTEM$GETPRIVATELINKCONFIG function returns the private-internal-stages key in the query result. The corresponding value in the query result is used during the configuration process for private connectivity to internal stages. For more information, check ENABLEINTERNALSTAGES_PRIVATELINK docs.
- Enable
Tri boolSecret And Rekey Opt Out For Image Repository - Specifies choice for the image repository to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORIMAGE_REPOSITORY docs.
- Enable
Tri boolSecret And Rekey Opt Out For Spcs Block Storage - Specifies the choice for the Snowpark Container Services block storage volume to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORSPCSBLOCKSTORAGE docs.
- Enable
Unhandled boolExceptions Reporting - Specifies whether Snowflake may capture – in an event table – log messages or trace event data for unhandled exceptions in procedure or UDF handler code. For more information, see Capturing messages from unhandled exceptions. For more information, check ENABLEUNHANDLEDEXCEPTIONS_REPORTING docs.
- Enable
Unload boolPhysical Type Optimization - Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check ENABLEUNLOADPHYSICALTYPEOPTIMIZATION docs.
- Enable
Unredacted boolQuery Syntax Error - Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If FALSE, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDQUERYSYNTAXERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check UNREDACTEDQUERYSYNTAXERROR docsENABLE.
- Enable
Unredacted boolSecure Object Error - Controls whether error messages related to secure objects are redacted in metadata. For more information, see Secure objects: Redaction of information in error messages. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDSECUREOBJECTERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the redacted error messages in metadata, not the user who caused the error. For more information, check UNREDACTEDSECUREOBJECTERROR docsENABLE.
- Enforce
Network boolRules For Internal Stages - Specifies whether a network policy that uses network rules can restrict access to AWS internal stages. This parameter has no effect on network policies that do not use network rules. This account-level parameter affects both account-level and user-level network policies. For details about using network policies and network rules to restrict access to AWS internal stages, including the use of this parameter, see Protecting internal stages on AWS. For more information, check ENFORCENETWORKRULESFORINTERNAL_STAGES docs.
- Error
On boolNondeterministic Merge - Specifies whether to return an error when the MERGE command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_MERGE docs.
- Error
On boolNondeterministic Update - Specifies whether to return an error when the UPDATE command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_UPDATE docs.
- Event
Table string - Specifies the name of the event table for logging messages from stored procedures and UDFs contained by the object with which the event table is associated. Associating an event table with a database is available in Enterprise Edition or higher. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EVENT_TABLE docs. - External
Oauth boolAdd Privileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from the External OAuth authorization server. For more information, check EXTERNALOAUTHADDPRIVILEGEDROLESTOBLOCKED_LIST docs.
- External
Volume string - Specifies the external volume for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EXTERNAL_VOLUME docs. - Feature
Policy string - Specifies feature policy for the current account.
- Geography
Output stringFormat - Display format for GEOGRAPHY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOGRAPHYOUTPUTFORMAT docs. - Geometry
Output stringFormat - Display format for GEOMETRY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOMETRYOUTPUTFORMAT docs. - Hybrid
Table intLock Timeout - Number of seconds to wait while trying to acquire row-level locks on a hybrid table, before timing out and aborting the statement. For more information, check HYBRIDTABLELOCK_TIMEOUT docs.
- Initial
Replication stringSize Limit In Tb - Sets the maximum estimated size limit for the initial replication of a primary database to a secondary database (in TB). Set this parameter on any account that stores a secondary database. This size limit helps prevent accounts from accidentally incurring large database replication charges. To remove the size limit, set the value to 0.0. It is required to pass numbers with scale of at least 1 (e.g. 20.5, 32.25, 33.333, etc.). For more information, check INITIALREPLICATIONSIZELIMITIN_TB docs.
- Jdbc
Treat boolDecimal As Int - Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
- Jdbc
Treat boolTimestamp Ntz As Utc - Specifies how JDBC processes TIMESTAMPNTZ values (more details). For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
- Jdbc
Use boolSession Timezone - Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the TIMEZONE parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check JDBCUSESESSION_TIMEZONE docs.
- Js
Treat boolInteger As Bigint - Specifies how the Snowflake Node.js Driver processes numeric columns that have a scale of zero (0), for example INTEGER or NUMBER(p, 0). For more information, check JSTREATINTEGERASBIGINT docs.
- Json
Indent int - Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check JSON_INDENT docs.
- Listing
Auto stringFulfillment Replication Refresh Schedule - Sets the time interval used to refresh the application package based data products to other regions. For more information, check LISTINGAUTOFULFILLMENTREPLICATIONREFRESH_SCHEDULE docs.
- Lock
Timeout int - Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check LOCK_TIMEOUT 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. For more information about log levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
TRACE
|DEBUG
|INFO
|WARN
|ERROR
|FATAL
|OFF
. For more information, check LOG_LEVEL docs. - Max
Concurrency intLevel - Specifies the concurrency level for SQL statements (that is, queries and DML) executed by a warehouse (more details). For more information, check MAXCONCURRENCYLEVEL docs.
- Max
Data intExtension Time In Days - Maximum number of days Snowflake can extend the data retention period for tables to prevent streams on the tables from becoming stale. By default, if the DATARETENTIONTIMEINDAYS setting for a source table is less than 14 days, and a stream has not been consumed, Snowflake temporarily extends this period to the stream’s offset, up to a maximum of 14 days, regardless of the Snowflake Edition for your account. The MAXDATAEXTENSIONTIMEINDAYS parameter enables you to limit this automatic extension period to control storage costs for data retention or for compliance reasons. For more information, check DATAEXTENSIONTIMEINDAYS docsMAX.
- Metric
Level string - Controls how metrics data is ingested into the event table. For more information about metric levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
ALL
|NONE
. For more information, check METRIC_LEVEL docs. - Min
Data intRetention Time In Days - Minimum number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on an object. If a minimum number of days for data retention is set on an account, the data retention period for an object is determined by MAX(DATARETENTIONTIMEINDAYS, MINDATARETENTIONTIMEINDAYS). For more information, check DATARETENTIONTIMEINDAYS docsMIN.
- Multi
Statement intCount - Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
- Network
Policy string - Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see Controlling network traffic with network policies. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check NETWORK_POLICY docs. - Noorder
Sequence boolAs Default - Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in increasing or decreasing order. For more information, check NOORDERSEQUENCEAS_DEFAULT docs.
- Oauth
Add boolPrivileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from Snowflake’s authorization server. For more information, check OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST docs.
- Odbc
Treat boolDecimal As Int - Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
- Packages
Policy string - Specifies packages policy for the current account.
- Password
Policy string - Specifies password policy for the current account.
- Periodic
Data boolRekeying - It enables/disables re-encryption of table data with new keys on a yearly basis to provide additional levels of data protection (more details). For more information, check PERIODICDATAREKEYING docs.
- Pipe
Execution boolPaused - Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role (more details). For more information, check PIPEEXECUTIONPAUSED docs.
- Prevent
Unload boolTo Inline Url - Specifies whether to prevent ad hoc data unload operations to external cloud storage locations (that is, COPY INTO location statements that specify the cloud storage URL and access settings directly in the statement). For an example, see Unloading data from a table directly to files in an external location. For more information, check PREVENTUNLOADTOINLINEURL docs.
- Prevent
Unload boolTo Internal Stages - Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO location statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
- Python
Profiler stringModules - Specifies the list of Python modules to include in a report when profiling Python handler code. For more information, check PYTHONPROFILERMODULES docs.
- Python
Profiler stringTarget Stage - Specifies the fully-qualified name of the stage in which to save a report when profiling Python handler code. For more information, check PYTHONPROFILERTARGET_STAGE docs.
- Query
Tag string - Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the QUERYHISTORY, QUERYHISTORY*BY** functions. For more information, check QUERY_TAG docs.
- Quoted
Identifiers boolIgnore Case - Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see Identifier resolution). You can use this parameter in situations in which third-party applications always use double quotes around identifiers. 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 Apache Iceberg™ tables that use an external catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- Require
Storage boolIntegration For Stage Creation - Specifies whether to require a storage integration object as cloud credentials when creating a named external stage (using CREATE STAGE) to access a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_CREATION docs.
- Require
Storage boolIntegration For Stage Operation - Specifies whether to require using a named external stage that references a storage integration object as cloud credentials when loading data from or unloading data to a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_OPERATION docs.
- Resource
Monitor string - Rows
Per intResultset - Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
- S3Stage
Vpce stringDns Name - Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via AWS PrivateLink for Amazon S3 use this endpoint to connect. For more information, see Accessing Internal stages with dedicated interface endpoints. For more information, check S3STAGEVPCEDNSNAME docs.
- Saml
Identity stringProvider - Enables federated authentication. This deprecated parameter enables federated authentication (more details). For more information, check SAMLIDENTITYPROVIDER docs.
- Search
Path string - Specifies the path to search to resolve unqualified object names in queries. For more information, see Name resolution in queries. Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check SEARCH_PATH docs.
- Serverless
Task stringMax Statement Size - Specifies the maximum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMAXSTATEMENTSIZE docs. - Serverless
Task stringMin Statement Size - Specifies the minimum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMINSTATEMENTSIZE docs. - Session
Policy string - Specifies session policy for the current account.
- Simulated
Data stringSharing Consumer - Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
- Sso
Login boolPage - This deprecated parameter disables preview mode for testing SSO (after enabling federated authentication) before rolling it out to users. For more information, check SSOLOGINPAGE docs.
- Statement
Queued intTimeout In Seconds - Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the MAXCONCURRENCYLEVEL parameter to ensure a warehouse is never backlogged. For more information, check STATEMENTQUEUEDTIMEOUTINSECONDS docs.
- Statement
Timeout intIn Seconds - Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check STATEMENTTIMEOUTIN_SECONDS docs.
- Storage
Serialization stringPolicy - Specifies the storage serialization policy for Snowflake-managed Apache Iceberg™ tables. Valid values are (case-insensitive):
COMPATIBLE
|OPTIMIZED
. For more information, check STORAGESERIALIZATIONPOLICY docs. - Strict
Json boolOutput - This parameter specifies whether JSON output in a session is compatible with the general standard (as described by http://json.org). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check STRICTJSONOUTPUT docs.
- Suspend
Task intAfter Num Failures - Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- Task
Auto intRetry Attempts - Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- Time
Input stringFormat - Specifies the input format for the TIME data type. For more information, see Date and time input and output formats. Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check TIMEINPUTFORMAT docs.
- Time
Output stringFormat - Specifies the display format for the TIME data type. For more information, see Date and time input and output formats. For more information, check TIMEOUTPUTFORMAT docs.
- Timestamp
Day boolIs Always24h - Specifies whether the DATEADD function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check TIMESTAMPDAYISALWAYS24H docs.
- Timestamp
Input stringFormat - Specifies the input format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check TIMESTAMPINPUTFORMAT docs.
- Timestamp
Ltz stringOutput Format - Specifies the display format for the TIMESTAMPLTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPLTZOUTPUT*FORMAT docs.
- Timestamp
Ntz stringOutput Format - Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
- Timestamp
Output stringFormat - Specifies the display format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. For more information, check TIMESTAMPOUTPUTFORMAT docs.
- Timestamp
Type stringMapping - Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
|TIMESTAMP_TZ
. For more information, check TIMESTAMP*TYPE_MAPPING docs. - Timestamp
Tz stringOutput Format - Specifies the display format for the TIMESTAMPTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPTZOUTPUT*FORMAT docs.
- Timezone string
- Specifies the time zone for the session. You can specify a time zone name or a link name from release 2021a of the IANA Time Zone Database (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check TIMEZONE docs.
- Trace
Level string - Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. Valid values are (case-insensitive):
ALWAYS
|ON_EVENT
|PROPAGATE
|OFF
. For more information, check TRACE_LEVEL docs. - Transaction
Abort boolOn Error - Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check TRANSACTIONABORTON_ERROR docs.
- Transaction
Default stringIsolation Level - Specifies the isolation level for transactions in the user session. Valid values are (case-insensitive):
READ COMMITTED
. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs. - Two
Digit intCentury Start - Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the
YY
date format component (i.e. years represented as 2 digits). For more information, check TWODIGITCENTURY_START docs. - Unsupported
Ddl stringAction - Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
- Use
Cached boolResult - Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
- User
Task stringManaged Initial Warehouse Size - Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. 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 - Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
- Week
Of intYear Policy - Specifies how the weeks in a given year are computed.
0
: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year.1
: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check WEEKOFYEAR_POLICY docs. - Week
Start int - Specifies the first day of the week (used by week-related date functions).
0
: Legacy Snowflake behavior is used (i.e. ISO-like semantics).1
(Monday) to7
(Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
- abort
Detached BooleanQuery - Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check ABORTDETACHEDQUERY docs.
- active
Python StringProfiler - Sets the profiler to use for the session when profiling Python handler code. Valid values are (case-insensitive):
LINE
|MEMORY
. For more information, check ACTIVEPYTHONPROFILER docs. - allow
Client BooleanMfa Caching - Specifies whether an MFA token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to respond to an MFA prompt at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using MFA token caching to minimize the number of prompts during authentication — optional. For more information, check ALLOWCLIENTMFA_CACHING docs.
- allow
Id BooleanToken - Specifies whether a connection token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to enter login credentials at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using connection caching to minimize the number of prompts for authentication — optional. For more information, check ALLOWIDTOKEN docs.
- authentication
Policy String - Specifies authentication policy for the current account.
- autocommit Boolean
- Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see Transactions. For more information, check AUTOCOMMIT docs.
- base
Location StringPrefix - Specifies a prefix for Snowflake to use in the write path for Snowflake-managed Apache Iceberg™ tables. For more information, see data and metadata directories for Iceberg tables. For more information, check BASELOCATIONPREFIX docs.
- binary
Input StringFormat - The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
|UTF8
. For more information, check BINARYINPUTFORMAT docs. - binary
Output StringFormat - The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
. For more information, check BINARYOUTPUTFORMAT docs. - catalog String
- Specifies the catalog for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG docs. - catalog
Sync String - Specifies the name of your catalog integration for Snowflake Open Catalog. Snowflake syncs tables that use the specified catalog integration with your Snowflake Open Catalog account. For more information, see Sync a Snowflake-managed table with Snowflake Open Catalog. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG_SYNC docs. - client
Enable BooleanLog Info Statement Parameters - Enables users to log the data values bound to PreparedStatements (more details). For more information, check CLIENTENABLELOGINFOSTATEMENT_PARAMETERS docs.
- client
Encryption IntegerKey Size - Specifies the AES encryption key size, in bits, used by Snowflake to encrypt/decrypt files stored on internal stages (for loading/unloading data) when you use the SNOWFLAKEFULL encryption type. For more information, check ENCRYPTIONKEYSIZE docsCLIENT.
- client
Memory IntegerLimit - Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check CLIENTMEMORYLIMIT docs.
- client
Metadata BooleanRequest Use Connection Ctx - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check CLIENTMETADATAREQUESTUSECONNECTION_CTX docs.
- client
Metadata BooleanUse Session Database - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases to the current database. The narrower search typically returns fewer rows and executes more quickly (more details on the usage). For more information, check CLIENTMETADATAUSESESSIONDATABASE docs.
- client
Prefetch IntegerThreads - Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check CLIENTPREFETCHTHREADS docs.
- client
Result IntegerChunk Size - Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check CLIENTRESULTCHUNK_SIZE docs.
- client
Result BooleanColumn Case Insensitive - Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
- client
Session BooleanKeep Alive - Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check CLIENTSESSIONKEEP_ALIVE docs.
- client
Session IntegerKeep Alive Heartbeat Frequency - Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
- client
Timestamp StringType Mapping - Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs. - cortex
Enabled StringCross Region - Specifies the regions where an inference request may be processed in case the request cannot be processed in the region where request is originally placed. Specifying DISABLED disables cross-region inferencing. For examples and details, see Cross-region inference. For more information, check CORTEXENABLEDCROSS_REGION docs.
- cortex
Models StringAllowlist - Specifies the models that users in the account can access. Use this parameter to allowlist models for all users in the account. If you need to provide specific users with access beyond what you’ve specified in the allowlist, use role-based access control instead. For more information, see Model allowlist. For more information, check CORTEXMODELSALLOWLIST docs.
- csv
Timestamp StringFormat - Specifies the format for TIMESTAMP values in CSV files downloaded from Snowsight. If this parameter is not set, TIMESTAMPLTZOUTPUT_FORMAT will be used for TIMESTAMPLTZ values, TZ*OUTPUT_FORMATTIMESTAMP will be used for TIMESTAMPTZ and NTZOUTPUTFORMATTIMESTAMP for TIMESTAMPNTZ values. For more information, see Date and time input and output formats or Download your query results. For more information, check TIMESTAMP*FORMAT docsCSV.
- data
Retention IntegerTime In Days - Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database, schema, or table. For more information, see Understanding & using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- date
Input StringFormat - Specifies the input format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEINPUTFORMAT docs.
- date
Output StringFormat - Specifies the display format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEOUTPUTFORMAT docs.
- default
Ddl StringCollation - Sets the default collation used for the following DDL operations: CREATE TABLE, ALTER TABLE … ADD COLUMN. Setting this parameter forces all subsequently-created columns in the affected objects (table, schema, database, or account) to have the specified collation as the default, unless the collation for the column is explicitly defined in the DDL. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook StringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs. - default
Notebook StringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs. - default
Null StringOrdering - Specifies the default ordering of NULL values in a result set (more details). Valid values are (case-insensitive):
FIRST
|LAST
. For more information, check DEFAULTNULLORDERING docs. - default
Streamlit StringNotebook Warehouse - Specifies the name of the default warehouse to use when creating a notebook. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTSTREAMLITNOTEBOOK_WAREHOUSE docs. - Boolean
- Controls whether users in an account see a button to download data in Snowsight or the Classic Console, such as a table returned from running a query in a worksheet. If the button to download is hidden in Snowsight or the Classic Console, users can still download or export data using third-party software. For more information, check DISABLEUIDOWNLOAD_BUTTON docs.
- disable
User BooleanPrivilege Grants - Controls whether users in an account can grant privileges directly to other users. Disabling user privilege grants (that is, setting DISABLEUSERPRIVILEGEGRANTS to TRUE) does not affect existing grants to users. Existing grants to users continue to confer privileges to those users. For more information, see GRANT \n\n … TO USER. For more information, check USERPRIVILEGEGRANTS docsDISABLE.
- enable
Automatic BooleanSensitive Data Classification Log - Controls whether events from automatic sensitive data classification are logged in the user event table. For more information, check ENABLEAUTOMATICSENSITIVEDATACLASSIFICATION_LOG docs.
- enable
Egress BooleanCost Optimizer - Enables or disables the Listing Cross-cloud auto-fulfillment Egress cost optimizer. For more information, check ENABLEEGRESSCOST_OPTIMIZER docs.
- enable
Identifier BooleanFirst Login - Determines the login flow for users. When enabled, Snowflake prompts users for their username or email address before presenting authentication methods. For details, see Identifier-first login. For more information, check ENABLEIDENTIFIERFIRST_LOGIN docs.
- enable
Internal BooleanStages Privatelink - Specifies whether the SYSTEM$GETPRIVATELINKCONFIG function returns the private-internal-stages key in the query result. The corresponding value in the query result is used during the configuration process for private connectivity to internal stages. For more information, check ENABLEINTERNALSTAGES_PRIVATELINK docs.
- enable
Tri BooleanSecret And Rekey Opt Out For Image Repository - Specifies choice for the image repository to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORIMAGE_REPOSITORY docs.
- enable
Tri BooleanSecret And Rekey Opt Out For Spcs Block Storage - Specifies the choice for the Snowpark Container Services block storage volume to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORSPCSBLOCKSTORAGE docs.
- enable
Unhandled BooleanExceptions Reporting - Specifies whether Snowflake may capture – in an event table – log messages or trace event data for unhandled exceptions in procedure or UDF handler code. For more information, see Capturing messages from unhandled exceptions. For more information, check ENABLEUNHANDLEDEXCEPTIONS_REPORTING docs.
- enable
Unload BooleanPhysical Type Optimization - Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check ENABLEUNLOADPHYSICALTYPEOPTIMIZATION docs.
- enable
Unredacted BooleanQuery Syntax Error - Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If FALSE, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDQUERYSYNTAXERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check UNREDACTEDQUERYSYNTAXERROR docsENABLE.
- enable
Unredacted BooleanSecure Object Error - Controls whether error messages related to secure objects are redacted in metadata. For more information, see Secure objects: Redaction of information in error messages. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDSECUREOBJECTERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the redacted error messages in metadata, not the user who caused the error. For more information, check UNREDACTEDSECUREOBJECTERROR docsENABLE.
- enforce
Network BooleanRules For Internal Stages - Specifies whether a network policy that uses network rules can restrict access to AWS internal stages. This parameter has no effect on network policies that do not use network rules. This account-level parameter affects both account-level and user-level network policies. For details about using network policies and network rules to restrict access to AWS internal stages, including the use of this parameter, see Protecting internal stages on AWS. For more information, check ENFORCENETWORKRULESFORINTERNAL_STAGES docs.
- error
On BooleanNondeterministic Merge - Specifies whether to return an error when the MERGE command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_MERGE docs.
- error
On BooleanNondeterministic Update - Specifies whether to return an error when the UPDATE command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_UPDATE docs.
- event
Table String - Specifies the name of the event table for logging messages from stored procedures and UDFs contained by the object with which the event table is associated. Associating an event table with a database is available in Enterprise Edition or higher. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EVENT_TABLE docs. - external
Oauth BooleanAdd Privileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from the External OAuth authorization server. For more information, check EXTERNALOAUTHADDPRIVILEGEDROLESTOBLOCKED_LIST docs.
- external
Volume String - Specifies the external volume for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EXTERNAL_VOLUME docs. - feature
Policy String - Specifies feature policy for the current account.
- geography
Output StringFormat - Display format for GEOGRAPHY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOGRAPHYOUTPUTFORMAT docs. - geometry
Output StringFormat - Display format for GEOMETRY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOMETRYOUTPUTFORMAT docs. - hybrid
Table IntegerLock Timeout - Number of seconds to wait while trying to acquire row-level locks on a hybrid table, before timing out and aborting the statement. For more information, check HYBRIDTABLELOCK_TIMEOUT docs.
- initial
Replication StringSize Limit In Tb - Sets the maximum estimated size limit for the initial replication of a primary database to a secondary database (in TB). Set this parameter on any account that stores a secondary database. This size limit helps prevent accounts from accidentally incurring large database replication charges. To remove the size limit, set the value to 0.0. It is required to pass numbers with scale of at least 1 (e.g. 20.5, 32.25, 33.333, etc.). For more information, check INITIALREPLICATIONSIZELIMITIN_TB docs.
- jdbc
Treat BooleanDecimal As Int - Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
- jdbc
Treat BooleanTimestamp Ntz As Utc - Specifies how JDBC processes TIMESTAMPNTZ values (more details). For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
- jdbc
Use BooleanSession Timezone - Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the TIMEZONE parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check JDBCUSESESSION_TIMEZONE docs.
- js
Treat BooleanInteger As Bigint - Specifies how the Snowflake Node.js Driver processes numeric columns that have a scale of zero (0), for example INTEGER or NUMBER(p, 0). For more information, check JSTREATINTEGERASBIGINT docs.
- json
Indent Integer - Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check JSON_INDENT docs.
- listing
Auto StringFulfillment Replication Refresh Schedule - Sets the time interval used to refresh the application package based data products to other regions. For more information, check LISTINGAUTOFULFILLMENTREPLICATIONREFRESH_SCHEDULE docs.
- lock
Timeout Integer - Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check LOCK_TIMEOUT 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. For more information about log levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
TRACE
|DEBUG
|INFO
|WARN
|ERROR
|FATAL
|OFF
. For more information, check LOG_LEVEL docs. - max
Concurrency IntegerLevel - Specifies the concurrency level for SQL statements (that is, queries and DML) executed by a warehouse (more details). For more information, check MAXCONCURRENCYLEVEL docs.
- max
Data IntegerExtension Time In Days - Maximum number of days Snowflake can extend the data retention period for tables to prevent streams on the tables from becoming stale. By default, if the DATARETENTIONTIMEINDAYS setting for a source table is less than 14 days, and a stream has not been consumed, Snowflake temporarily extends this period to the stream’s offset, up to a maximum of 14 days, regardless of the Snowflake Edition for your account. The MAXDATAEXTENSIONTIMEINDAYS parameter enables you to limit this automatic extension period to control storage costs for data retention or for compliance reasons. For more information, check DATAEXTENSIONTIMEINDAYS docsMAX.
- metric
Level String - Controls how metrics data is ingested into the event table. For more information about metric levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
ALL
|NONE
. For more information, check METRIC_LEVEL docs. - min
Data IntegerRetention Time In Days - Minimum number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on an object. If a minimum number of days for data retention is set on an account, the data retention period for an object is determined by MAX(DATARETENTIONTIMEINDAYS, MINDATARETENTIONTIMEINDAYS). For more information, check DATARETENTIONTIMEINDAYS docsMIN.
- multi
Statement IntegerCount - Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
- network
Policy String - Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see Controlling network traffic with network policies. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check NETWORK_POLICY docs. - noorder
Sequence BooleanAs Default - Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in increasing or decreasing order. For more information, check NOORDERSEQUENCEAS_DEFAULT docs.
- oauth
Add BooleanPrivileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from Snowflake’s authorization server. For more information, check OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST docs.
- odbc
Treat BooleanDecimal As Int - Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
- packages
Policy String - Specifies packages policy for the current account.
- password
Policy String - Specifies password policy for the current account.
- periodic
Data BooleanRekeying - It enables/disables re-encryption of table data with new keys on a yearly basis to provide additional levels of data protection (more details). For more information, check PERIODICDATAREKEYING docs.
- pipe
Execution BooleanPaused - Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role (more details). For more information, check PIPEEXECUTIONPAUSED docs.
- prevent
Unload BooleanTo Inline Url - Specifies whether to prevent ad hoc data unload operations to external cloud storage locations (that is, COPY INTO location statements that specify the cloud storage URL and access settings directly in the statement). For an example, see Unloading data from a table directly to files in an external location. For more information, check PREVENTUNLOADTOINLINEURL docs.
- prevent
Unload BooleanTo Internal Stages - Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO location statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
- python
Profiler StringModules - Specifies the list of Python modules to include in a report when profiling Python handler code. For more information, check PYTHONPROFILERMODULES docs.
- python
Profiler StringTarget Stage - Specifies the fully-qualified name of the stage in which to save a report when profiling Python handler code. For more information, check PYTHONPROFILERTARGET_STAGE docs.
- query
Tag String - Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the QUERYHISTORY, QUERYHISTORY*BY** functions. For more information, check QUERY_TAG docs.
- quoted
Identifiers BooleanIgnore Case - Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see Identifier resolution). You can use this parameter in situations in which third-party applications always use double quotes around identifiers. 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 Apache Iceberg™ tables that use an external catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- require
Storage BooleanIntegration For Stage Creation - Specifies whether to require a storage integration object as cloud credentials when creating a named external stage (using CREATE STAGE) to access a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_CREATION docs.
- require
Storage BooleanIntegration For Stage Operation - Specifies whether to require using a named external stage that references a storage integration object as cloud credentials when loading data from or unloading data to a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_OPERATION docs.
- resource
Monitor String - rows
Per IntegerResultset - Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
- s3Stage
Vpce StringDns Name - Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via AWS PrivateLink for Amazon S3 use this endpoint to connect. For more information, see Accessing Internal stages with dedicated interface endpoints. For more information, check S3STAGEVPCEDNSNAME docs.
- saml
Identity StringProvider - Enables federated authentication. This deprecated parameter enables federated authentication (more details). For more information, check SAMLIDENTITYPROVIDER docs.
- search
Path String - Specifies the path to search to resolve unqualified object names in queries. For more information, see Name resolution in queries. Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check SEARCH_PATH docs.
- serverless
Task StringMax Statement Size - Specifies the maximum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMAXSTATEMENTSIZE docs. - serverless
Task StringMin Statement Size - Specifies the minimum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMINSTATEMENTSIZE docs. - session
Policy String - Specifies session policy for the current account.
- simulated
Data StringSharing Consumer - Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
- sso
Login BooleanPage - This deprecated parameter disables preview mode for testing SSO (after enabling federated authentication) before rolling it out to users. For more information, check SSOLOGINPAGE docs.
- statement
Queued IntegerTimeout In Seconds - Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the MAXCONCURRENCYLEVEL parameter to ensure a warehouse is never backlogged. For more information, check STATEMENTQUEUEDTIMEOUTINSECONDS docs.
- statement
Timeout IntegerIn Seconds - Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check STATEMENTTIMEOUTIN_SECONDS docs.
- storage
Serialization StringPolicy - Specifies the storage serialization policy for Snowflake-managed Apache Iceberg™ tables. Valid values are (case-insensitive):
COMPATIBLE
|OPTIMIZED
. For more information, check STORAGESERIALIZATIONPOLICY docs. - strict
Json BooleanOutput - This parameter specifies whether JSON output in a session is compatible with the general standard (as described by http://json.org). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check STRICTJSONOUTPUT docs.
- suspend
Task IntegerAfter Num Failures - Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto IntegerRetry Attempts - Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- time
Input StringFormat - Specifies the input format for the TIME data type. For more information, see Date and time input and output formats. Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check TIMEINPUTFORMAT docs.
- time
Output StringFormat - Specifies the display format for the TIME data type. For more information, see Date and time input and output formats. For more information, check TIMEOUTPUTFORMAT docs.
- timestamp
Day BooleanIs Always24h - Specifies whether the DATEADD function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check TIMESTAMPDAYISALWAYS24H docs.
- timestamp
Input StringFormat - Specifies the input format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check TIMESTAMPINPUTFORMAT docs.
- timestamp
Ltz StringOutput Format - Specifies the display format for the TIMESTAMPLTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPLTZOUTPUT*FORMAT docs.
- timestamp
Ntz StringOutput Format - Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
- timestamp
Output StringFormat - Specifies the display format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. For more information, check TIMESTAMPOUTPUTFORMAT docs.
- timestamp
Type StringMapping - Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
|TIMESTAMP_TZ
. For more information, check TIMESTAMP*TYPE_MAPPING docs. - timestamp
Tz StringOutput Format - Specifies the display format for the TIMESTAMPTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPTZOUTPUT*FORMAT docs.
- timezone String
- Specifies the time zone for the session. You can specify a time zone name or a link name from release 2021a of the IANA Time Zone Database (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check TIMEZONE docs.
- trace
Level String - Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. Valid values are (case-insensitive):
ALWAYS
|ON_EVENT
|PROPAGATE
|OFF
. For more information, check TRACE_LEVEL docs. - transaction
Abort BooleanOn Error - Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check TRANSACTIONABORTON_ERROR docs.
- transaction
Default StringIsolation Level - Specifies the isolation level for transactions in the user session. Valid values are (case-insensitive):
READ COMMITTED
. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs. - two
Digit IntegerCentury Start - Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the
YY
date format component (i.e. years represented as 2 digits). For more information, check TWODIGITCENTURY_START docs. - unsupported
Ddl StringAction - Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
- use
Cached BooleanResult - Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
- user
Task StringManaged Initial Warehouse Size - Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. 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 - Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
- week
Of IntegerYear Policy - Specifies how the weeks in a given year are computed.
0
: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year.1
: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check WEEKOFYEAR_POLICY docs. - week
Start Integer - Specifies the first day of the week (used by week-related date functions).
0
: Legacy Snowflake behavior is used (i.e. ISO-like semantics).1
(Monday) to7
(Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
- abort
Detached booleanQuery - Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check ABORTDETACHEDQUERY docs.
- active
Python stringProfiler - Sets the profiler to use for the session when profiling Python handler code. Valid values are (case-insensitive):
LINE
|MEMORY
. For more information, check ACTIVEPYTHONPROFILER docs. - allow
Client booleanMfa Caching - Specifies whether an MFA token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to respond to an MFA prompt at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using MFA token caching to minimize the number of prompts during authentication — optional. For more information, check ALLOWCLIENTMFA_CACHING docs.
- allow
Id booleanToken - Specifies whether a connection token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to enter login credentials at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using connection caching to minimize the number of prompts for authentication — optional. For more information, check ALLOWIDTOKEN docs.
- authentication
Policy string - Specifies authentication policy for the current account.
- autocommit boolean
- Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see Transactions. For more information, check AUTOCOMMIT docs.
- base
Location stringPrefix - Specifies a prefix for Snowflake to use in the write path for Snowflake-managed Apache Iceberg™ tables. For more information, see data and metadata directories for Iceberg tables. For more information, check BASELOCATIONPREFIX docs.
- binary
Input stringFormat - The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
|UTF8
. For more information, check BINARYINPUTFORMAT docs. - binary
Output stringFormat - The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
. For more information, check BINARYOUTPUTFORMAT docs. - catalog string
- Specifies the catalog for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG docs. - catalog
Sync string - Specifies the name of your catalog integration for Snowflake Open Catalog. Snowflake syncs tables that use the specified catalog integration with your Snowflake Open Catalog account. For more information, see Sync a Snowflake-managed table with Snowflake Open Catalog. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG_SYNC docs. - client
Enable booleanLog Info Statement Parameters - Enables users to log the data values bound to PreparedStatements (more details). For more information, check CLIENTENABLELOGINFOSTATEMENT_PARAMETERS docs.
- client
Encryption numberKey Size - Specifies the AES encryption key size, in bits, used by Snowflake to encrypt/decrypt files stored on internal stages (for loading/unloading data) when you use the SNOWFLAKEFULL encryption type. For more information, check ENCRYPTIONKEYSIZE docsCLIENT.
- client
Memory numberLimit - Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check CLIENTMEMORYLIMIT docs.
- client
Metadata booleanRequest Use Connection Ctx - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check CLIENTMETADATAREQUESTUSECONNECTION_CTX docs.
- client
Metadata booleanUse Session Database - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases to the current database. The narrower search typically returns fewer rows and executes more quickly (more details on the usage). For more information, check CLIENTMETADATAUSESESSIONDATABASE docs.
- client
Prefetch numberThreads - Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check CLIENTPREFETCHTHREADS docs.
- client
Result numberChunk Size - Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check CLIENTRESULTCHUNK_SIZE docs.
- client
Result booleanColumn Case Insensitive - Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
- client
Session booleanKeep Alive - Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check CLIENTSESSIONKEEP_ALIVE docs.
- client
Session numberKeep Alive Heartbeat Frequency - Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
- client
Timestamp stringType Mapping - Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs. - cortex
Enabled stringCross Region - Specifies the regions where an inference request may be processed in case the request cannot be processed in the region where request is originally placed. Specifying DISABLED disables cross-region inferencing. For examples and details, see Cross-region inference. For more information, check CORTEXENABLEDCROSS_REGION docs.
- cortex
Models stringAllowlist - Specifies the models that users in the account can access. Use this parameter to allowlist models for all users in the account. If you need to provide specific users with access beyond what you’ve specified in the allowlist, use role-based access control instead. For more information, see Model allowlist. For more information, check CORTEXMODELSALLOWLIST docs.
- csv
Timestamp stringFormat - Specifies the format for TIMESTAMP values in CSV files downloaded from Snowsight. If this parameter is not set, TIMESTAMPLTZOUTPUT_FORMAT will be used for TIMESTAMPLTZ values, TZ*OUTPUT_FORMATTIMESTAMP will be used for TIMESTAMPTZ and NTZOUTPUTFORMATTIMESTAMP for TIMESTAMPNTZ values. For more information, see Date and time input and output formats or Download your query results. For more information, check TIMESTAMP*FORMAT docsCSV.
- data
Retention numberTime In Days - Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database, schema, or table. For more information, see Understanding & using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- date
Input stringFormat - Specifies the input format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEINPUTFORMAT docs.
- date
Output stringFormat - Specifies the display format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEOUTPUTFORMAT docs.
- default
Ddl stringCollation - Sets the default collation used for the following DDL operations: CREATE TABLE, ALTER TABLE … ADD COLUMN. Setting this parameter forces all subsequently-created columns in the affected objects (table, schema, database, or account) to have the specified collation as the default, unless the collation for the column is explicitly defined in the DDL. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook stringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs. - default
Notebook stringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs. - default
Null stringOrdering - Specifies the default ordering of NULL values in a result set (more details). Valid values are (case-insensitive):
FIRST
|LAST
. For more information, check DEFAULTNULLORDERING docs. - default
Streamlit stringNotebook Warehouse - Specifies the name of the default warehouse to use when creating a notebook. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTSTREAMLITNOTEBOOK_WAREHOUSE docs. - boolean
- Controls whether users in an account see a button to download data in Snowsight or the Classic Console, such as a table returned from running a query in a worksheet. If the button to download is hidden in Snowsight or the Classic Console, users can still download or export data using third-party software. For more information, check DISABLEUIDOWNLOAD_BUTTON docs.
- disable
User booleanPrivilege Grants - Controls whether users in an account can grant privileges directly to other users. Disabling user privilege grants (that is, setting DISABLEUSERPRIVILEGEGRANTS to TRUE) does not affect existing grants to users. Existing grants to users continue to confer privileges to those users. For more information, see GRANT \n\n … TO USER. For more information, check USERPRIVILEGEGRANTS docsDISABLE.
- enable
Automatic booleanSensitive Data Classification Log - Controls whether events from automatic sensitive data classification are logged in the user event table. For more information, check ENABLEAUTOMATICSENSITIVEDATACLASSIFICATION_LOG docs.
- enable
Egress booleanCost Optimizer - Enables or disables the Listing Cross-cloud auto-fulfillment Egress cost optimizer. For more information, check ENABLEEGRESSCOST_OPTIMIZER docs.
- enable
Identifier booleanFirst Login - Determines the login flow for users. When enabled, Snowflake prompts users for their username or email address before presenting authentication methods. For details, see Identifier-first login. For more information, check ENABLEIDENTIFIERFIRST_LOGIN docs.
- enable
Internal booleanStages Privatelink - Specifies whether the SYSTEM$GETPRIVATELINKCONFIG function returns the private-internal-stages key in the query result. The corresponding value in the query result is used during the configuration process for private connectivity to internal stages. For more information, check ENABLEINTERNALSTAGES_PRIVATELINK docs.
- enable
Tri booleanSecret And Rekey Opt Out For Image Repository - Specifies choice for the image repository to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORIMAGE_REPOSITORY docs.
- enable
Tri booleanSecret And Rekey Opt Out For Spcs Block Storage - Specifies the choice for the Snowpark Container Services block storage volume to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORSPCSBLOCKSTORAGE docs.
- enable
Unhandled booleanExceptions Reporting - Specifies whether Snowflake may capture – in an event table – log messages or trace event data for unhandled exceptions in procedure or UDF handler code. For more information, see Capturing messages from unhandled exceptions. For more information, check ENABLEUNHANDLEDEXCEPTIONS_REPORTING docs.
- enable
Unload booleanPhysical Type Optimization - Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check ENABLEUNLOADPHYSICALTYPEOPTIMIZATION docs.
- enable
Unredacted booleanQuery Syntax Error - Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If FALSE, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDQUERYSYNTAXERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check UNREDACTEDQUERYSYNTAXERROR docsENABLE.
- enable
Unredacted booleanSecure Object Error - Controls whether error messages related to secure objects are redacted in metadata. For more information, see Secure objects: Redaction of information in error messages. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDSECUREOBJECTERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the redacted error messages in metadata, not the user who caused the error. For more information, check UNREDACTEDSECUREOBJECTERROR docsENABLE.
- enforce
Network booleanRules For Internal Stages - Specifies whether a network policy that uses network rules can restrict access to AWS internal stages. This parameter has no effect on network policies that do not use network rules. This account-level parameter affects both account-level and user-level network policies. For details about using network policies and network rules to restrict access to AWS internal stages, including the use of this parameter, see Protecting internal stages on AWS. For more information, check ENFORCENETWORKRULESFORINTERNAL_STAGES docs.
- error
On booleanNondeterministic Merge - Specifies whether to return an error when the MERGE command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_MERGE docs.
- error
On booleanNondeterministic Update - Specifies whether to return an error when the UPDATE command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_UPDATE docs.
- event
Table string - Specifies the name of the event table for logging messages from stored procedures and UDFs contained by the object with which the event table is associated. Associating an event table with a database is available in Enterprise Edition or higher. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EVENT_TABLE docs. - external
Oauth booleanAdd Privileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from the External OAuth authorization server. For more information, check EXTERNALOAUTHADDPRIVILEGEDROLESTOBLOCKED_LIST docs.
- external
Volume string - Specifies the external volume for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EXTERNAL_VOLUME docs. - feature
Policy string - Specifies feature policy for the current account.
- geography
Output stringFormat - Display format for GEOGRAPHY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOGRAPHYOUTPUTFORMAT docs. - geometry
Output stringFormat - Display format for GEOMETRY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOMETRYOUTPUTFORMAT docs. - hybrid
Table numberLock Timeout - Number of seconds to wait while trying to acquire row-level locks on a hybrid table, before timing out and aborting the statement. For more information, check HYBRIDTABLELOCK_TIMEOUT docs.
- initial
Replication stringSize Limit In Tb - Sets the maximum estimated size limit for the initial replication of a primary database to a secondary database (in TB). Set this parameter on any account that stores a secondary database. This size limit helps prevent accounts from accidentally incurring large database replication charges. To remove the size limit, set the value to 0.0. It is required to pass numbers with scale of at least 1 (e.g. 20.5, 32.25, 33.333, etc.). For more information, check INITIALREPLICATIONSIZELIMITIN_TB docs.
- jdbc
Treat booleanDecimal As Int - Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
- jdbc
Treat booleanTimestamp Ntz As Utc - Specifies how JDBC processes TIMESTAMPNTZ values (more details). For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
- jdbc
Use booleanSession Timezone - Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the TIMEZONE parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check JDBCUSESESSION_TIMEZONE docs.
- js
Treat booleanInteger As Bigint - Specifies how the Snowflake Node.js Driver processes numeric columns that have a scale of zero (0), for example INTEGER or NUMBER(p, 0). For more information, check JSTREATINTEGERASBIGINT docs.
- json
Indent number - Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check JSON_INDENT docs.
- listing
Auto stringFulfillment Replication Refresh Schedule - Sets the time interval used to refresh the application package based data products to other regions. For more information, check LISTINGAUTOFULFILLMENTREPLICATIONREFRESH_SCHEDULE docs.
- lock
Timeout number - Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check LOCK_TIMEOUT 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. For more information about log levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
TRACE
|DEBUG
|INFO
|WARN
|ERROR
|FATAL
|OFF
. For more information, check LOG_LEVEL docs. - max
Concurrency numberLevel - Specifies the concurrency level for SQL statements (that is, queries and DML) executed by a warehouse (more details). For more information, check MAXCONCURRENCYLEVEL docs.
- max
Data numberExtension Time In Days - Maximum number of days Snowflake can extend the data retention period for tables to prevent streams on the tables from becoming stale. By default, if the DATARETENTIONTIMEINDAYS setting for a source table is less than 14 days, and a stream has not been consumed, Snowflake temporarily extends this period to the stream’s offset, up to a maximum of 14 days, regardless of the Snowflake Edition for your account. The MAXDATAEXTENSIONTIMEINDAYS parameter enables you to limit this automatic extension period to control storage costs for data retention or for compliance reasons. For more information, check DATAEXTENSIONTIMEINDAYS docsMAX.
- metric
Level string - Controls how metrics data is ingested into the event table. For more information about metric levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
ALL
|NONE
. For more information, check METRIC_LEVEL docs. - min
Data numberRetention Time In Days - Minimum number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on an object. If a minimum number of days for data retention is set on an account, the data retention period for an object is determined by MAX(DATARETENTIONTIMEINDAYS, MINDATARETENTIONTIMEINDAYS). For more information, check DATARETENTIONTIMEINDAYS docsMIN.
- multi
Statement numberCount - Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
- network
Policy string - Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see Controlling network traffic with network policies. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check NETWORK_POLICY docs. - noorder
Sequence booleanAs Default - Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in increasing or decreasing order. For more information, check NOORDERSEQUENCEAS_DEFAULT docs.
- oauth
Add booleanPrivileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from Snowflake’s authorization server. For more information, check OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST docs.
- odbc
Treat booleanDecimal As Int - Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
- packages
Policy string - Specifies packages policy for the current account.
- password
Policy string - Specifies password policy for the current account.
- periodic
Data booleanRekeying - It enables/disables re-encryption of table data with new keys on a yearly basis to provide additional levels of data protection (more details). For more information, check PERIODICDATAREKEYING docs.
- pipe
Execution booleanPaused - Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role (more details). For more information, check PIPEEXECUTIONPAUSED docs.
- prevent
Unload booleanTo Inline Url - Specifies whether to prevent ad hoc data unload operations to external cloud storage locations (that is, COPY INTO location statements that specify the cloud storage URL and access settings directly in the statement). For an example, see Unloading data from a table directly to files in an external location. For more information, check PREVENTUNLOADTOINLINEURL docs.
- prevent
Unload booleanTo Internal Stages - Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO location statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
- python
Profiler stringModules - Specifies the list of Python modules to include in a report when profiling Python handler code. For more information, check PYTHONPROFILERMODULES docs.
- python
Profiler stringTarget Stage - Specifies the fully-qualified name of the stage in which to save a report when profiling Python handler code. For more information, check PYTHONPROFILERTARGET_STAGE docs.
- query
Tag string - Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the QUERYHISTORY, QUERYHISTORY*BY** functions. For more information, check QUERY_TAG docs.
- quoted
Identifiers booleanIgnore Case - Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see Identifier resolution). You can use this parameter in situations in which third-party applications always use double quotes around identifiers. 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 Apache Iceberg™ tables that use an external catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- require
Storage booleanIntegration For Stage Creation - Specifies whether to require a storage integration object as cloud credentials when creating a named external stage (using CREATE STAGE) to access a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_CREATION docs.
- require
Storage booleanIntegration For Stage Operation - Specifies whether to require using a named external stage that references a storage integration object as cloud credentials when loading data from or unloading data to a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_OPERATION docs.
- resource
Monitor string - rows
Per numberResultset - Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
- s3Stage
Vpce stringDns Name - Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via AWS PrivateLink for Amazon S3 use this endpoint to connect. For more information, see Accessing Internal stages with dedicated interface endpoints. For more information, check S3STAGEVPCEDNSNAME docs.
- saml
Identity stringProvider - Enables federated authentication. This deprecated parameter enables federated authentication (more details). For more information, check SAMLIDENTITYPROVIDER docs.
- search
Path string - Specifies the path to search to resolve unqualified object names in queries. For more information, see Name resolution in queries. Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check SEARCH_PATH docs.
- serverless
Task stringMax Statement Size - Specifies the maximum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMAXSTATEMENTSIZE docs. - serverless
Task stringMin Statement Size - Specifies the minimum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMINSTATEMENTSIZE docs. - session
Policy string - Specifies session policy for the current account.
- simulated
Data stringSharing Consumer - Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
- sso
Login booleanPage - This deprecated parameter disables preview mode for testing SSO (after enabling federated authentication) before rolling it out to users. For more information, check SSOLOGINPAGE docs.
- statement
Queued numberTimeout In Seconds - Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the MAXCONCURRENCYLEVEL parameter to ensure a warehouse is never backlogged. For more information, check STATEMENTQUEUEDTIMEOUTINSECONDS docs.
- statement
Timeout numberIn Seconds - Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check STATEMENTTIMEOUTIN_SECONDS docs.
- storage
Serialization stringPolicy - Specifies the storage serialization policy for Snowflake-managed Apache Iceberg™ tables. Valid values are (case-insensitive):
COMPATIBLE
|OPTIMIZED
. For more information, check STORAGESERIALIZATIONPOLICY docs. - strict
Json booleanOutput - This parameter specifies whether JSON output in a session is compatible with the general standard (as described by http://json.org). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check STRICTJSONOUTPUT docs.
- suspend
Task numberAfter Num Failures - Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto numberRetry Attempts - Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- time
Input stringFormat - Specifies the input format for the TIME data type. For more information, see Date and time input and output formats. Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check TIMEINPUTFORMAT docs.
- time
Output stringFormat - Specifies the display format for the TIME data type. For more information, see Date and time input and output formats. For more information, check TIMEOUTPUTFORMAT docs.
- timestamp
Day booleanIs Always24h - Specifies whether the DATEADD function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check TIMESTAMPDAYISALWAYS24H docs.
- timestamp
Input stringFormat - Specifies the input format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check TIMESTAMPINPUTFORMAT docs.
- timestamp
Ltz stringOutput Format - Specifies the display format for the TIMESTAMPLTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPLTZOUTPUT*FORMAT docs.
- timestamp
Ntz stringOutput Format - Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
- timestamp
Output stringFormat - Specifies the display format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. For more information, check TIMESTAMPOUTPUTFORMAT docs.
- timestamp
Type stringMapping - Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
|TIMESTAMP_TZ
. For more information, check TIMESTAMP*TYPE_MAPPING docs. - timestamp
Tz stringOutput Format - Specifies the display format for the TIMESTAMPTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPTZOUTPUT*FORMAT docs.
- timezone string
- Specifies the time zone for the session. You can specify a time zone name or a link name from release 2021a of the IANA Time Zone Database (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check TIMEZONE docs.
- trace
Level string - Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. Valid values are (case-insensitive):
ALWAYS
|ON_EVENT
|PROPAGATE
|OFF
. For more information, check TRACE_LEVEL docs. - transaction
Abort booleanOn Error - Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check TRANSACTIONABORTON_ERROR docs.
- transaction
Default stringIsolation Level - Specifies the isolation level for transactions in the user session. Valid values are (case-insensitive):
READ COMMITTED
. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs. - two
Digit numberCentury Start - Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the
YY
date format component (i.e. years represented as 2 digits). For more information, check TWODIGITCENTURY_START docs. - unsupported
Ddl stringAction - Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
- use
Cached booleanResult - Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
- user
Task stringManaged Initial Warehouse Size - Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. 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 - Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
- week
Of numberYear Policy - Specifies how the weeks in a given year are computed.
0
: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year.1
: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check WEEKOFYEAR_POLICY docs. - week
Start number - Specifies the first day of the week (used by week-related date functions).
0
: Legacy Snowflake behavior is used (i.e. ISO-like semantics).1
(Monday) to7
(Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
- abort_
detached_ boolquery - Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check ABORTDETACHEDQUERY docs.
- active_
python_ strprofiler - Sets the profiler to use for the session when profiling Python handler code. Valid values are (case-insensitive):
LINE
|MEMORY
. For more information, check ACTIVEPYTHONPROFILER docs. - allow_
client_ boolmfa_ caching - Specifies whether an MFA token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to respond to an MFA prompt at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using MFA token caching to minimize the number of prompts during authentication — optional. For more information, check ALLOWCLIENTMFA_CACHING docs.
- allow_
id_ booltoken - Specifies whether a connection token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to enter login credentials at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using connection caching to minimize the number of prompts for authentication — optional. For more information, check ALLOWIDTOKEN docs.
- authentication_
policy str - Specifies authentication policy for the current account.
- autocommit bool
- Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see Transactions. For more information, check AUTOCOMMIT docs.
- base_
location_ strprefix - Specifies a prefix for Snowflake to use in the write path for Snowflake-managed Apache Iceberg™ tables. For more information, see data and metadata directories for Iceberg tables. For more information, check BASELOCATIONPREFIX docs.
- binary_
input_ strformat - The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
|UTF8
. For more information, check BINARYINPUTFORMAT docs. - binary_
output_ strformat - The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
. For more information, check BINARYOUTPUTFORMAT docs. - catalog str
- Specifies the catalog for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG docs. - catalog_
sync str - Specifies the name of your catalog integration for Snowflake Open Catalog. Snowflake syncs tables that use the specified catalog integration with your Snowflake Open Catalog account. For more information, see Sync a Snowflake-managed table with Snowflake Open Catalog. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG_SYNC docs. - client_
enable_ boollog_ info_ statement_ parameters - Enables users to log the data values bound to PreparedStatements (more details). For more information, check CLIENTENABLELOGINFOSTATEMENT_PARAMETERS docs.
- client_
encryption_ intkey_ size - Specifies the AES encryption key size, in bits, used by Snowflake to encrypt/decrypt files stored on internal stages (for loading/unloading data) when you use the SNOWFLAKEFULL encryption type. For more information, check ENCRYPTIONKEYSIZE docsCLIENT.
- client_
memory_ intlimit - Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check CLIENTMEMORYLIMIT docs.
- client_
metadata_ boolrequest_ use_ connection_ ctx - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check CLIENTMETADATAREQUESTUSECONNECTION_CTX docs.
- client_
metadata_ booluse_ session_ database - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases to the current database. The narrower search typically returns fewer rows and executes more quickly (more details on the usage). For more information, check CLIENTMETADATAUSESESSIONDATABASE docs.
- client_
prefetch_ intthreads - Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check CLIENTPREFETCHTHREADS docs.
- client_
result_ intchunk_ size - Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check CLIENTRESULTCHUNK_SIZE docs.
- client_
result_ boolcolumn_ case_ insensitive - Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
- client_
session_ boolkeep_ alive - Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check CLIENTSESSIONKEEP_ALIVE docs.
- client_
session_ intkeep_ alive_ heartbeat_ frequency - Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
- client_
timestamp_ strtype_ mapping - Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs. - cortex_
enabled_ strcross_ region - Specifies the regions where an inference request may be processed in case the request cannot be processed in the region where request is originally placed. Specifying DISABLED disables cross-region inferencing. For examples and details, see Cross-region inference. For more information, check CORTEXENABLEDCROSS_REGION docs.
- cortex_
models_ strallowlist - Specifies the models that users in the account can access. Use this parameter to allowlist models for all users in the account. If you need to provide specific users with access beyond what you’ve specified in the allowlist, use role-based access control instead. For more information, see Model allowlist. For more information, check CORTEXMODELSALLOWLIST docs.
- csv_
timestamp_ strformat - Specifies the format for TIMESTAMP values in CSV files downloaded from Snowsight. If this parameter is not set, TIMESTAMPLTZOUTPUT_FORMAT will be used for TIMESTAMPLTZ values, TZ*OUTPUT_FORMATTIMESTAMP will be used for TIMESTAMPTZ and NTZOUTPUTFORMATTIMESTAMP for TIMESTAMPNTZ values. For more information, see Date and time input and output formats or Download your query results. For more information, check TIMESTAMP*FORMAT docsCSV.
- data_
retention_ inttime_ in_ days - Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database, schema, or table. For more information, see Understanding & using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- date_
input_ strformat - Specifies the input format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEINPUTFORMAT docs.
- date_
output_ strformat - Specifies the display format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEOUTPUTFORMAT docs.
- default_
ddl_ strcollation - Sets the default collation used for the following DDL operations: CREATE TABLE, ALTER TABLE … ADD COLUMN. Setting this parameter forces all subsequently-created columns in the affected objects (table, schema, database, or account) to have the specified collation as the default, unless the collation for the column is explicitly defined in the DDL. For more information, check DEFAULTDDLCOLLATION docs.
- default_
notebook_ strcompute_ pool_ cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs. - default_
notebook_ strcompute_ pool_ gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs. - default_
null_ strordering - Specifies the default ordering of NULL values in a result set (more details). Valid values are (case-insensitive):
FIRST
|LAST
. For more information, check DEFAULTNULLORDERING docs. - default_
streamlit_ strnotebook_ warehouse - Specifies the name of the default warehouse to use when creating a notebook. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTSTREAMLITNOTEBOOK_WAREHOUSE docs. - bool
- Controls whether users in an account see a button to download data in Snowsight or the Classic Console, such as a table returned from running a query in a worksheet. If the button to download is hidden in Snowsight or the Classic Console, users can still download or export data using third-party software. For more information, check DISABLEUIDOWNLOAD_BUTTON docs.
- disable_
user_ boolprivilege_ grants - Controls whether users in an account can grant privileges directly to other users. Disabling user privilege grants (that is, setting DISABLEUSERPRIVILEGEGRANTS to TRUE) does not affect existing grants to users. Existing grants to users continue to confer privileges to those users. For more information, see GRANT \n\n … TO USER. For more information, check USERPRIVILEGEGRANTS docsDISABLE.
- enable_
automatic_ boolsensitive_ data_ classification_ log - Controls whether events from automatic sensitive data classification are logged in the user event table. For more information, check ENABLEAUTOMATICSENSITIVEDATACLASSIFICATION_LOG docs.
- enable_
egress_ boolcost_ optimizer - Enables or disables the Listing Cross-cloud auto-fulfillment Egress cost optimizer. For more information, check ENABLEEGRESSCOST_OPTIMIZER docs.
- enable_
identifier_ boolfirst_ login - Determines the login flow for users. When enabled, Snowflake prompts users for their username or email address before presenting authentication methods. For details, see Identifier-first login. For more information, check ENABLEIDENTIFIERFIRST_LOGIN docs.
- enable_
internal_ boolstages_ privatelink - Specifies whether the SYSTEM$GETPRIVATELINKCONFIG function returns the private-internal-stages key in the query result. The corresponding value in the query result is used during the configuration process for private connectivity to internal stages. For more information, check ENABLEINTERNALSTAGES_PRIVATELINK docs.
- enable_
tri_ boolsecret_ and_ rekey_ opt_ out_ for_ image_ repository - Specifies choice for the image repository to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORIMAGE_REPOSITORY docs.
- enable_
tri_ boolsecret_ and_ rekey_ opt_ out_ for_ spcs_ block_ storage - Specifies the choice for the Snowpark Container Services block storage volume to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORSPCSBLOCKSTORAGE docs.
- enable_
unhandled_ boolexceptions_ reporting - Specifies whether Snowflake may capture – in an event table – log messages or trace event data for unhandled exceptions in procedure or UDF handler code. For more information, see Capturing messages from unhandled exceptions. For more information, check ENABLEUNHANDLEDEXCEPTIONS_REPORTING docs.
- enable_
unload_ boolphysical_ type_ optimization - Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check ENABLEUNLOADPHYSICALTYPEOPTIMIZATION docs.
- enable_
unredacted_ boolquery_ syntax_ error - Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If FALSE, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDQUERYSYNTAXERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check UNREDACTEDQUERYSYNTAXERROR docsENABLE.
- enable_
unredacted_ boolsecure_ object_ error - Controls whether error messages related to secure objects are redacted in metadata. For more information, see Secure objects: Redaction of information in error messages. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDSECUREOBJECTERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the redacted error messages in metadata, not the user who caused the error. For more information, check UNREDACTEDSECUREOBJECTERROR docsENABLE.
- enforce_
network_ boolrules_ for_ internal_ stages - Specifies whether a network policy that uses network rules can restrict access to AWS internal stages. This parameter has no effect on network policies that do not use network rules. This account-level parameter affects both account-level and user-level network policies. For details about using network policies and network rules to restrict access to AWS internal stages, including the use of this parameter, see Protecting internal stages on AWS. For more information, check ENFORCENETWORKRULESFORINTERNAL_STAGES docs.
- error_
on_ boolnondeterministic_ merge - Specifies whether to return an error when the MERGE command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_MERGE docs.
- error_
on_ boolnondeterministic_ update - Specifies whether to return an error when the UPDATE command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_UPDATE docs.
- event_
table str - Specifies the name of the event table for logging messages from stored procedures and UDFs contained by the object with which the event table is associated. Associating an event table with a database is available in Enterprise Edition or higher. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EVENT_TABLE docs. - external_
oauth_ booladd_ privileged_ roles_ to_ blocked_ list - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from the External OAuth authorization server. For more information, check EXTERNALOAUTHADDPRIVILEGEDROLESTOBLOCKED_LIST docs.
- external_
volume str - Specifies the external volume for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EXTERNAL_VOLUME docs. - feature_
policy str - Specifies feature policy for the current account.
- geography_
output_ strformat - Display format for GEOGRAPHY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOGRAPHYOUTPUTFORMAT docs. - geometry_
output_ strformat - Display format for GEOMETRY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOMETRYOUTPUTFORMAT docs. - hybrid_
table_ intlock_ timeout - Number of seconds to wait while trying to acquire row-level locks on a hybrid table, before timing out and aborting the statement. For more information, check HYBRIDTABLELOCK_TIMEOUT docs.
- initial_
replication_ strsize_ limit_ in_ tb - Sets the maximum estimated size limit for the initial replication of a primary database to a secondary database (in TB). Set this parameter on any account that stores a secondary database. This size limit helps prevent accounts from accidentally incurring large database replication charges. To remove the size limit, set the value to 0.0. It is required to pass numbers with scale of at least 1 (e.g. 20.5, 32.25, 33.333, etc.). For more information, check INITIALREPLICATIONSIZELIMITIN_TB docs.
- jdbc_
treat_ booldecimal_ as_ int - Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
- jdbc_
treat_ booltimestamp_ ntz_ as_ utc - Specifies how JDBC processes TIMESTAMPNTZ values (more details). For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
- jdbc_
use_ boolsession_ timezone - Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the TIMEZONE parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check JDBCUSESESSION_TIMEZONE docs.
- js_
treat_ boolinteger_ as_ bigint - Specifies how the Snowflake Node.js Driver processes numeric columns that have a scale of zero (0), for example INTEGER or NUMBER(p, 0). For more information, check JSTREATINTEGERASBIGINT docs.
- json_
indent int - Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check JSON_INDENT docs.
- listing_
auto_ strfulfillment_ replication_ refresh_ schedule - Sets the time interval used to refresh the application package based data products to other regions. For more information, check LISTINGAUTOFULFILLMENTREPLICATIONREFRESH_SCHEDULE docs.
- lock_
timeout int - Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check LOCK_TIMEOUT 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. For more information about log levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
TRACE
|DEBUG
|INFO
|WARN
|ERROR
|FATAL
|OFF
. For more information, check LOG_LEVEL docs. - max_
concurrency_ intlevel - Specifies the concurrency level for SQL statements (that is, queries and DML) executed by a warehouse (more details). For more information, check MAXCONCURRENCYLEVEL docs.
- max_
data_ intextension_ time_ in_ days - Maximum number of days Snowflake can extend the data retention period for tables to prevent streams on the tables from becoming stale. By default, if the DATARETENTIONTIMEINDAYS setting for a source table is less than 14 days, and a stream has not been consumed, Snowflake temporarily extends this period to the stream’s offset, up to a maximum of 14 days, regardless of the Snowflake Edition for your account. The MAXDATAEXTENSIONTIMEINDAYS parameter enables you to limit this automatic extension period to control storage costs for data retention or for compliance reasons. For more information, check DATAEXTENSIONTIMEINDAYS docsMAX.
- metric_
level str - Controls how metrics data is ingested into the event table. For more information about metric levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
ALL
|NONE
. For more information, check METRIC_LEVEL docs. - min_
data_ intretention_ time_ in_ days - Minimum number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on an object. If a minimum number of days for data retention is set on an account, the data retention period for an object is determined by MAX(DATARETENTIONTIMEINDAYS, MINDATARETENTIONTIMEINDAYS). For more information, check DATARETENTIONTIMEINDAYS docsMIN.
- multi_
statement_ intcount - Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
- network_
policy str - Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see Controlling network traffic with network policies. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check NETWORK_POLICY docs. - noorder_
sequence_ boolas_ default - Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in increasing or decreasing order. For more information, check NOORDERSEQUENCEAS_DEFAULT docs.
- oauth_
add_ boolprivileged_ roles_ to_ blocked_ list - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from Snowflake’s authorization server. For more information, check OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST docs.
- odbc_
treat_ booldecimal_ as_ int - Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
- packages_
policy str - Specifies packages policy for the current account.
- password_
policy str - Specifies password policy for the current account.
- periodic_
data_ boolrekeying - It enables/disables re-encryption of table data with new keys on a yearly basis to provide additional levels of data protection (more details). For more information, check PERIODICDATAREKEYING docs.
- pipe_
execution_ boolpaused - Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role (more details). For more information, check PIPEEXECUTIONPAUSED docs.
- prevent_
unload_ boolto_ inline_ url - Specifies whether to prevent ad hoc data unload operations to external cloud storage locations (that is, COPY INTO location statements that specify the cloud storage URL and access settings directly in the statement). For an example, see Unloading data from a table directly to files in an external location. For more information, check PREVENTUNLOADTOINLINEURL docs.
- prevent_
unload_ boolto_ internal_ stages - Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO location statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
- python_
profiler_ strmodules - Specifies the list of Python modules to include in a report when profiling Python handler code. For more information, check PYTHONPROFILERMODULES docs.
- python_
profiler_ strtarget_ stage - Specifies the fully-qualified name of the stage in which to save a report when profiling Python handler code. For more information, check PYTHONPROFILERTARGET_STAGE docs.
- query_
tag str - Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the QUERYHISTORY, QUERYHISTORY*BY** functions. For more information, check QUERY_TAG docs.
- quoted_
identifiers_ boolignore_ case - Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see Identifier resolution). You can use this parameter in situations in which third-party applications always use double quotes around identifiers. 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 Apache Iceberg™ tables that use an external catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- require_
storage_ boolintegration_ for_ stage_ creation - Specifies whether to require a storage integration object as cloud credentials when creating a named external stage (using CREATE STAGE) to access a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_CREATION docs.
- require_
storage_ boolintegration_ for_ stage_ operation - Specifies whether to require using a named external stage that references a storage integration object as cloud credentials when loading data from or unloading data to a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_OPERATION docs.
- resource_
monitor str - rows_
per_ intresultset - Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
- s3_
stage_ strvpce_ dns_ name - Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via AWS PrivateLink for Amazon S3 use this endpoint to connect. For more information, see Accessing Internal stages with dedicated interface endpoints. For more information, check S3STAGEVPCEDNSNAME docs.
- saml_
identity_ strprovider - Enables federated authentication. This deprecated parameter enables federated authentication (more details). For more information, check SAMLIDENTITYPROVIDER docs.
- search_
path str - Specifies the path to search to resolve unqualified object names in queries. For more information, see Name resolution in queries. Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check SEARCH_PATH docs.
- serverless_
task_ strmax_ statement_ size - Specifies the maximum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMAXSTATEMENTSIZE docs. - serverless_
task_ strmin_ statement_ size - Specifies the minimum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMINSTATEMENTSIZE docs. - session_
policy str - Specifies session policy for the current account.
- simulated_
data_ strsharing_ consumer - Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
- sso_
login_ boolpage - This deprecated parameter disables preview mode for testing SSO (after enabling federated authentication) before rolling it out to users. For more information, check SSOLOGINPAGE docs.
- statement_
queued_ inttimeout_ in_ seconds - Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the MAXCONCURRENCYLEVEL parameter to ensure a warehouse is never backlogged. For more information, check STATEMENTQUEUEDTIMEOUTINSECONDS docs.
- statement_
timeout_ intin_ seconds - Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check STATEMENTTIMEOUTIN_SECONDS docs.
- storage_
serialization_ strpolicy - Specifies the storage serialization policy for Snowflake-managed Apache Iceberg™ tables. Valid values are (case-insensitive):
COMPATIBLE
|OPTIMIZED
. For more information, check STORAGESERIALIZATIONPOLICY docs. - strict_
json_ booloutput - This parameter specifies whether JSON output in a session is compatible with the general standard (as described by http://json.org). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check STRICTJSONOUTPUT docs.
- suspend_
task_ intafter_ num_ failures - Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task_
auto_ intretry_ attempts - Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- time_
input_ strformat - Specifies the input format for the TIME data type. For more information, see Date and time input and output formats. Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check TIMEINPUTFORMAT docs.
- time_
output_ strformat - Specifies the display format for the TIME data type. For more information, see Date and time input and output formats. For more information, check TIMEOUTPUTFORMAT docs.
- timestamp_
day_ boolis_ always24h - Specifies whether the DATEADD function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check TIMESTAMPDAYISALWAYS24H docs.
- timestamp_
input_ strformat - Specifies the input format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check TIMESTAMPINPUTFORMAT docs.
- timestamp_
ltz_ stroutput_ format - Specifies the display format for the TIMESTAMPLTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPLTZOUTPUT*FORMAT docs.
- timestamp_
ntz_ stroutput_ format - Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
- timestamp_
output_ strformat - Specifies the display format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. For more information, check TIMESTAMPOUTPUTFORMAT docs.
- timestamp_
type_ strmapping - Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
|TIMESTAMP_TZ
. For more information, check TIMESTAMP*TYPE_MAPPING docs. - timestamp_
tz_ stroutput_ format - Specifies the display format for the TIMESTAMPTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPTZOUTPUT*FORMAT docs.
- timezone str
- Specifies the time zone for the session. You can specify a time zone name or a link name from release 2021a of the IANA Time Zone Database (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check TIMEZONE docs.
- trace_
level str - Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. Valid values are (case-insensitive):
ALWAYS
|ON_EVENT
|PROPAGATE
|OFF
. For more information, check TRACE_LEVEL docs. - transaction_
abort_ boolon_ error - Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check TRANSACTIONABORTON_ERROR docs.
- transaction_
default_ strisolation_ level - Specifies the isolation level for transactions in the user session. Valid values are (case-insensitive):
READ COMMITTED
. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs. - two_
digit_ intcentury_ start - Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the
YY
date format component (i.e. years represented as 2 digits). For more information, check TWODIGITCENTURY_START docs. - unsupported_
ddl_ straction - Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
- use_
cached_ boolresult - Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
- user_
task_ strmanaged_ initial_ warehouse_ size - Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. 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 - Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
- week_
of_ intyear_ policy - Specifies how the weeks in a given year are computed.
0
: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year.1
: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check WEEKOFYEAR_POLICY docs. - week_
start int - Specifies the first day of the week (used by week-related date functions).
0
: Legacy Snowflake behavior is used (i.e. ISO-like semantics).1
(Monday) to7
(Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
- abort
Detached BooleanQuery - Specifies the action that Snowflake performs for in-progress queries if connectivity is lost due to abrupt termination of a session (e.g. network outage, browser termination, service interruption). For more information, check ABORTDETACHEDQUERY docs.
- active
Python StringProfiler - Sets the profiler to use for the session when profiling Python handler code. Valid values are (case-insensitive):
LINE
|MEMORY
. For more information, check ACTIVEPYTHONPROFILER docs. - allow
Client BooleanMfa Caching - Specifies whether an MFA token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to respond to an MFA prompt at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using MFA token caching to minimize the number of prompts during authentication — optional. For more information, check ALLOWCLIENTMFA_CACHING docs.
- allow
Id BooleanToken - Specifies whether a connection token can be saved in the client-side operating system keystore to promote continuous, secure connectivity without users needing to enter login credentials at the start of each connection attempt to Snowflake. For details and the list of supported Snowflake-provided clients, see Using connection caching to minimize the number of prompts for authentication — optional. For more information, check ALLOWIDTOKEN docs.
- authentication
Policy String - Specifies authentication policy for the current account.
- autocommit Boolean
- Specifies whether autocommit is enabled for the session. Autocommit determines whether a DML statement, when executed without an active transaction, is automatically committed after the statement successfully completes. For more information, see Transactions. For more information, check AUTOCOMMIT docs.
- base
Location StringPrefix - Specifies a prefix for Snowflake to use in the write path for Snowflake-managed Apache Iceberg™ tables. For more information, see data and metadata directories for Iceberg tables. For more information, check BASELOCATIONPREFIX docs.
- binary
Input StringFormat - The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
|UTF8
. For more information, check BINARYINPUTFORMAT docs. - binary
Output StringFormat - The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. Valid values are (case-insensitive):
HEX
|BASE64
. For more information, check BINARYOUTPUTFORMAT docs. - catalog String
- Specifies the catalog for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG docs. - catalog
Sync String - Specifies the name of your catalog integration for Snowflake Open Catalog. Snowflake syncs tables that use the specified catalog integration with your Snowflake Open Catalog account. For more information, see Sync a Snowflake-managed table with Snowflake Open Catalog. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check CATALOG_SYNC docs. - client
Enable BooleanLog Info Statement Parameters - Enables users to log the data values bound to PreparedStatements (more details). For more information, check CLIENTENABLELOGINFOSTATEMENT_PARAMETERS docs.
- client
Encryption NumberKey Size - Specifies the AES encryption key size, in bits, used by Snowflake to encrypt/decrypt files stored on internal stages (for loading/unloading data) when you use the SNOWFLAKEFULL encryption type. For more information, check ENCRYPTIONKEYSIZE docsCLIENT.
- client
Memory NumberLimit - Parameter that specifies the maximum amount of memory the JDBC driver or ODBC driver should use for the result set from queries (in MB). For more information, check CLIENTMEMORYLIMIT docs.
- client
Metadata BooleanRequest Use Connection Ctx - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases/schemas to the current database/schema. The narrower search typically returns fewer rows and executes more quickly. For more information, check CLIENTMETADATAREQUESTUSECONNECTION_CTX docs.
- client
Metadata BooleanUse Session Database - For specific ODBC functions and JDBC methods, this parameter can change the default search scope from all databases to the current database. The narrower search typically returns fewer rows and executes more quickly (more details on the usage). For more information, check CLIENTMETADATAUSESESSIONDATABASE docs.
- client
Prefetch NumberThreads - Parameter that specifies the number of threads used by the client to pre-fetch large result sets. The driver will attempt to honor the parameter value, but defines the minimum and maximum values (depending on your system’s resources) to improve performance. For more information, check CLIENTPREFETCHTHREADS docs.
- client
Result NumberChunk Size - Parameter that specifies the maximum size of each set (or chunk) of query results to download (in MB). The JDBC driver downloads query results in chunks. For more information, check CLIENTRESULTCHUNK_SIZE docs.
- client
Result BooleanColumn Case Insensitive - Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
- client
Session BooleanKeep Alive - Parameter that indicates whether to force a user to log in again after a period of inactivity in the session. For more information, check CLIENTSESSIONKEEP_ALIVE docs.
- client
Session NumberKeep Alive Heartbeat Frequency - Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
- client
Timestamp StringType Mapping - Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs. - cortex
Enabled StringCross Region - Specifies the regions where an inference request may be processed in case the request cannot be processed in the region where request is originally placed. Specifying DISABLED disables cross-region inferencing. For examples and details, see Cross-region inference. For more information, check CORTEXENABLEDCROSS_REGION docs.
- cortex
Models StringAllowlist - Specifies the models that users in the account can access. Use this parameter to allowlist models for all users in the account. If you need to provide specific users with access beyond what you’ve specified in the allowlist, use role-based access control instead. For more information, see Model allowlist. For more information, check CORTEXMODELSALLOWLIST docs.
- csv
Timestamp StringFormat - Specifies the format for TIMESTAMP values in CSV files downloaded from Snowsight. If this parameter is not set, TIMESTAMPLTZOUTPUT_FORMAT will be used for TIMESTAMPLTZ values, TZ*OUTPUT_FORMATTIMESTAMP will be used for TIMESTAMPTZ and NTZOUTPUTFORMATTIMESTAMP for TIMESTAMPNTZ values. For more information, see Date and time input and output formats or Download your query results. For more information, check TIMESTAMP*FORMAT docsCSV.
- data
Retention NumberTime In Days - Number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on the object. A value of 0 effectively disables Time Travel for the specified database, schema, or table. For more information, see Understanding & using Time Travel. For more information, check DATARETENTIONTIMEINDAYS docs.
- date
Input StringFormat - Specifies the input format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEINPUTFORMAT docs.
- date
Output StringFormat - Specifies the display format for the DATE data type. For more information, see Date and time input and output formats. For more information, check DATEOUTPUTFORMAT docs.
- default
Ddl StringCollation - Sets the default collation used for the following DDL operations: CREATE TABLE, ALTER TABLE … ADD COLUMN. Setting this parameter forces all subsequently-created columns in the affected objects (table, schema, database, or account) to have the specified collation as the default, unless the collation for the column is explicitly defined in the DDL. For more information, check DEFAULTDDLCOLLATION docs.
- default
Notebook StringCompute Pool Cpu - Sets the preferred CPU compute pool used for Notebooks on CPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLCPU docs. - default
Notebook StringCompute Pool Gpu - Sets the preferred GPU compute pool used for Notebooks on GPU Container Runtime. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTNOTEBOOKCOMPUTEPOOLGPU docs. - default
Null StringOrdering - Specifies the default ordering of NULL values in a result set (more details). Valid values are (case-insensitive):
FIRST
|LAST
. For more information, check DEFAULTNULLORDERING docs. - default
Streamlit StringNotebook Warehouse - Specifies the name of the default warehouse to use when creating a notebook. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check DEFAULTSTREAMLITNOTEBOOK_WAREHOUSE docs. - Boolean
- Controls whether users in an account see a button to download data in Snowsight or the Classic Console, such as a table returned from running a query in a worksheet. If the button to download is hidden in Snowsight or the Classic Console, users can still download or export data using third-party software. For more information, check DISABLEUIDOWNLOAD_BUTTON docs.
- disable
User BooleanPrivilege Grants - Controls whether users in an account can grant privileges directly to other users. Disabling user privilege grants (that is, setting DISABLEUSERPRIVILEGEGRANTS to TRUE) does not affect existing grants to users. Existing grants to users continue to confer privileges to those users. For more information, see GRANT \n\n … TO USER. For more information, check USERPRIVILEGEGRANTS docsDISABLE.
- enable
Automatic BooleanSensitive Data Classification Log - Controls whether events from automatic sensitive data classification are logged in the user event table. For more information, check ENABLEAUTOMATICSENSITIVEDATACLASSIFICATION_LOG docs.
- enable
Egress BooleanCost Optimizer - Enables or disables the Listing Cross-cloud auto-fulfillment Egress cost optimizer. For more information, check ENABLEEGRESSCOST_OPTIMIZER docs.
- enable
Identifier BooleanFirst Login - Determines the login flow for users. When enabled, Snowflake prompts users for their username or email address before presenting authentication methods. For details, see Identifier-first login. For more information, check ENABLEIDENTIFIERFIRST_LOGIN docs.
- enable
Internal BooleanStages Privatelink - Specifies whether the SYSTEM$GETPRIVATELINKCONFIG function returns the private-internal-stages key in the query result. The corresponding value in the query result is used during the configuration process for private connectivity to internal stages. For more information, check ENABLEINTERNALSTAGES_PRIVATELINK docs.
- enable
Tri BooleanSecret And Rekey Opt Out For Image Repository - Specifies choice for the image repository to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORIMAGE_REPOSITORY docs.
- enable
Tri BooleanSecret And Rekey Opt Out For Spcs Block Storage - Specifies the choice for the Snowpark Container Services block storage volume to opt out of Tri-Secret Secure and Periodic rekeying. For more information, check ENABLETRISECRETANDREKEYOPTOUTFORSPCSBLOCKSTORAGE docs.
- enable
Unhandled BooleanExceptions Reporting - Specifies whether Snowflake may capture – in an event table – log messages or trace event data for unhandled exceptions in procedure or UDF handler code. For more information, see Capturing messages from unhandled exceptions. For more information, check ENABLEUNHANDLEDEXCEPTIONS_REPORTING docs.
- enable
Unload BooleanPhysical Type Optimization - Specifies whether to set the schema for unloaded Parquet files based on the logical column data types (i.e. the types in the unload SQL query or source table) or on the unloaded column values (i.e. the smallest data types and precision that support the values in the output columns of the unload SQL statement or source table). For more information, check ENABLEUNLOADPHYSICALTYPEOPTIMIZATION docs.
- enable
Unredacted BooleanQuery Syntax Error - Controls whether query text is redacted if a SQL query fails due to a syntax or parsing error. If FALSE, the content of a failed query is redacted in the views, pages, and functions that provide a query history. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDQUERYSYNTAXERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the query text, not the user who executed the query (if those are different users). For more information, check UNREDACTEDQUERYSYNTAXERROR docsENABLE.
- enable
Unredacted BooleanSecure Object Error - Controls whether error messages related to secure objects are redacted in metadata. For more information, see Secure objects: Redaction of information in error messages. Only users with a role that is granted or inherits the AUDIT privilege can set the ENABLEUNREDACTEDSECUREOBJECTERROR parameter. When using the ALTER USER command to set the parameter to TRUE for a particular user, modify the user that you want to see the redacted error messages in metadata, not the user who caused the error. For more information, check UNREDACTEDSECUREOBJECTERROR docsENABLE.
- enforce
Network BooleanRules For Internal Stages - Specifies whether a network policy that uses network rules can restrict access to AWS internal stages. This parameter has no effect on network policies that do not use network rules. This account-level parameter affects both account-level and user-level network policies. For details about using network policies and network rules to restrict access to AWS internal stages, including the use of this parameter, see Protecting internal stages on AWS. For more information, check ENFORCENETWORKRULESFORINTERNAL_STAGES docs.
- error
On BooleanNondeterministic Merge - Specifies whether to return an error when the MERGE command is used to update or delete a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_MERGE docs.
- error
On BooleanNondeterministic Update - Specifies whether to return an error when the UPDATE command is used to update a target row that joins multiple source rows and the system cannot determine the action to perform on the target row. For more information, check ERRORONNONDETERMINISTIC_UPDATE docs.
- event
Table String - Specifies the name of the event table for logging messages from stored procedures and UDFs contained by the object with which the event table is associated. Associating an event table with a database is available in Enterprise Edition or higher. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EVENT_TABLE docs. - external
Oauth BooleanAdd Privileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from the External OAuth authorization server. For more information, check EXTERNALOAUTHADDPRIVILEGEDROLESTOBLOCKED_LIST docs.
- external
Volume String - Specifies the external volume for Apache Iceberg™ tables. For more information, see the Iceberg table documentation. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check EXTERNAL_VOLUME docs. - feature
Policy String - Specifies feature policy for the current account.
- geography
Output StringFormat - Display format for GEOGRAPHY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOGRAPHYOUTPUTFORMAT docs. - geometry
Output StringFormat - Display format for GEOMETRY values. Valid values are (case-insensitive):
GeoJSON
|WKT
|WKB
|EWKT
|EWKB
. For more information, check GEOMETRYOUTPUTFORMAT docs. - hybrid
Table NumberLock Timeout - Number of seconds to wait while trying to acquire row-level locks on a hybrid table, before timing out and aborting the statement. For more information, check HYBRIDTABLELOCK_TIMEOUT docs.
- initial
Replication StringSize Limit In Tb - Sets the maximum estimated size limit for the initial replication of a primary database to a secondary database (in TB). Set this parameter on any account that stores a secondary database. This size limit helps prevent accounts from accidentally incurring large database replication charges. To remove the size limit, set the value to 0.0. It is required to pass numbers with scale of at least 1 (e.g. 20.5, 32.25, 33.333, etc.). For more information, check INITIALREPLICATIONSIZELIMITIN_TB docs.
- jdbc
Treat BooleanDecimal As Int - Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
- jdbc
Treat BooleanTimestamp Ntz As Utc - Specifies how JDBC processes TIMESTAMPNTZ values (more details). For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
- jdbc
Use BooleanSession Timezone - Specifies whether the JDBC Driver uses the time zone of the JVM or the time zone of the session (specified by the TIMEZONE parameter) for the getDate(), getTime(), and getTimestamp() methods of the ResultSet class. For more information, check JDBCUSESESSION_TIMEZONE docs.
- js
Treat BooleanInteger As Bigint - Specifies how the Snowflake Node.js Driver processes numeric columns that have a scale of zero (0), for example INTEGER or NUMBER(p, 0). For more information, check JSTREATINTEGERASBIGINT docs.
- json
Indent Number - Specifies the number of blank spaces to indent each new element in JSON output in the session. Also specifies whether to insert newline characters after each element. For more information, check JSON_INDENT docs.
- listing
Auto StringFulfillment Replication Refresh Schedule - Sets the time interval used to refresh the application package based data products to other regions. For more information, check LISTINGAUTOFULFILLMENTREPLICATIONREFRESH_SCHEDULE docs.
- lock
Timeout Number - Number of seconds to wait while trying to lock a resource, before timing out and aborting the statement. For more information, check LOCK_TIMEOUT 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. For more information about log levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
TRACE
|DEBUG
|INFO
|WARN
|ERROR
|FATAL
|OFF
. For more information, check LOG_LEVEL docs. - max
Concurrency NumberLevel - Specifies the concurrency level for SQL statements (that is, queries and DML) executed by a warehouse (more details). For more information, check MAXCONCURRENCYLEVEL docs.
- max
Data NumberExtension Time In Days - Maximum number of days Snowflake can extend the data retention period for tables to prevent streams on the tables from becoming stale. By default, if the DATARETENTIONTIMEINDAYS setting for a source table is less than 14 days, and a stream has not been consumed, Snowflake temporarily extends this period to the stream’s offset, up to a maximum of 14 days, regardless of the Snowflake Edition for your account. The MAXDATAEXTENSIONTIMEINDAYS parameter enables you to limit this automatic extension period to control storage costs for data retention or for compliance reasons. For more information, check DATAEXTENSIONTIMEINDAYS docsMAX.
- metric
Level String - Controls how metrics data is ingested into the event table. For more information about metric levels, see Setting levels for logging, metrics, and tracing. Valid values are (case-insensitive):
ALL
|NONE
. For more information, check METRIC_LEVEL docs. - min
Data NumberRetention Time In Days - Minimum number of days for which Snowflake retains historical data for performing Time Travel actions (SELECT, CLONE, UNDROP) on an object. If a minimum number of days for data retention is set on an account, the data retention period for an object is determined by MAX(DATARETENTIONTIMEINDAYS, MINDATARETENTIONTIMEINDAYS). For more information, check DATARETENTIONTIMEINDAYS docsMIN.
- multi
Statement NumberCount - Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
- network
Policy String - Specifies the network policy to enforce for your account. Network policies enable restricting access to your account based on users’ IP address. For more details, see Controlling network traffic with network policies. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,"
. For more information, check NETWORK_POLICY docs. - noorder
Sequence BooleanAs Default - Specifies whether the ORDER or NOORDER property is set by default when you create a new sequence or add a new table column. The ORDER and NOORDER properties determine whether or not the values are generated for the sequence or auto-incremented column in increasing or decreasing order. For more information, check NOORDERSEQUENCEAS_DEFAULT docs.
- oauth
Add BooleanPrivileged Roles To Blocked List - Determines whether the ACCOUNTADMIN, ORGADMIN, GLOBALORGADMIN, and SECURITYADMIN roles can be used as the primary role when creating a Snowflake session based on the access token from Snowflake’s authorization server. For more information, check OAUTHADDPRIVILEGEDROLESTOBLOCKEDLIST docs.
- odbc
Treat BooleanDecimal As Int - Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
- packages
Policy String - Specifies packages policy for the current account.
- password
Policy String - Specifies password policy for the current account.
- periodic
Data BooleanRekeying - It enables/disables re-encryption of table data with new keys on a yearly basis to provide additional levels of data protection (more details). For more information, check PERIODICDATAREKEYING docs.
- pipe
Execution BooleanPaused - Specifies whether to pause a running pipe, primarily in preparation for transferring ownership of the pipe to a different role (more details). For more information, check PIPEEXECUTIONPAUSED docs.
- prevent
Unload BooleanTo Inline Url - Specifies whether to prevent ad hoc data unload operations to external cloud storage locations (that is, COPY INTO location statements that specify the cloud storage URL and access settings directly in the statement). For an example, see Unloading data from a table directly to files in an external location. For more information, check PREVENTUNLOADTOINLINEURL docs.
- prevent
Unload BooleanTo Internal Stages - Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO location statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
- python
Profiler StringModules - Specifies the list of Python modules to include in a report when profiling Python handler code. For more information, check PYTHONPROFILERMODULES docs.
- python
Profiler StringTarget Stage - Specifies the fully-qualified name of the stage in which to save a report when profiling Python handler code. For more information, check PYTHONPROFILERTARGET_STAGE docs.
- query
Tag String - Optional string that can be used to tag queries and other SQL statements executed within a session. The tags are displayed in the output of the QUERYHISTORY, QUERYHISTORY*BY** functions. For more information, check QUERY_TAG docs.
- quoted
Identifiers BooleanIgnore Case - Specifies whether letters in double-quoted object identifiers are stored and resolved as uppercase letters. By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers (see Identifier resolution). You can use this parameter in situations in which third-party applications always use double quotes around identifiers. 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 Apache Iceberg™ tables that use an external catalog. For more information, check REPLACEINVALIDCHARACTERS docs.
- require
Storage BooleanIntegration For Stage Creation - Specifies whether to require a storage integration object as cloud credentials when creating a named external stage (using CREATE STAGE) to access a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_CREATION docs.
- require
Storage BooleanIntegration For Stage Operation - Specifies whether to require using a named external stage that references a storage integration object as cloud credentials when loading data from or unloading data to a private cloud storage location. For more information, check REQUIRESTORAGEINTEGRATIONFORSTAGE_OPERATION docs.
- resource
Monitor String - rows
Per NumberResultset - Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
- s3Stage
Vpce StringDns Name - Specifies the DNS name of an Amazon S3 interface endpoint. Requests sent to the internal stage of an account via AWS PrivateLink for Amazon S3 use this endpoint to connect. For more information, see Accessing Internal stages with dedicated interface endpoints. For more information, check S3STAGEVPCEDNSNAME docs.
- saml
Identity StringProvider - Enables federated authentication. This deprecated parameter enables federated authentication (more details). For more information, check SAMLIDENTITYPROVIDER docs.
- search
Path String - Specifies the path to search to resolve unqualified object names in queries. For more information, see Name resolution in queries. Comma-separated list of identifiers. An identifier can be a fully or partially qualified schema name. For more information, check SEARCH_PATH docs.
- serverless
Task StringMax Statement Size - Specifies the maximum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMAXSTATEMENTSIZE docs. - serverless
Task StringMin Statement Size - Specifies the minimum allowed warehouse size for Serverless tasks. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. For more information, check SERVERLESSTASKMINSTATEMENTSIZE docs. - session
Policy String - Specifies session policy for the current account.
- simulated
Data StringSharing Consumer - Specifies the name of a consumer account to simulate for testing/validating shared data, particularly shared secure views. When this parameter is set in a session, shared views return rows as if executed in the specified consumer account rather than the provider account. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
- sso
Login BooleanPage - This deprecated parameter disables preview mode for testing SSO (after enabling federated authentication) before rolling it out to users. For more information, check SSOLOGINPAGE docs.
- statement
Queued NumberTimeout In Seconds - Amount of time, in seconds, a SQL statement (query, DDL, DML, etc.) remains queued for a warehouse before it is canceled by the system. This parameter can be used in conjunction with the MAXCONCURRENCYLEVEL parameter to ensure a warehouse is never backlogged. For more information, check STATEMENTQUEUEDTIMEOUTINSECONDS docs.
- statement
Timeout NumberIn Seconds - Amount of time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system. For more information, check STATEMENTTIMEOUTIN_SECONDS docs.
- storage
Serialization StringPolicy - Specifies the storage serialization policy for Snowflake-managed Apache Iceberg™ tables. Valid values are (case-insensitive):
COMPATIBLE
|OPTIMIZED
. For more information, check STORAGESERIALIZATIONPOLICY docs. - strict
Json BooleanOutput - This parameter specifies whether JSON output in a session is compatible with the general standard (as described by http://json.org). By design, Snowflake allows JSON input that contains non-standard values; however, these non-standard values might result in Snowflake outputting JSON that is incompatible with other platforms and languages. This parameter, when enabled, ensures that Snowflake outputs valid/compatible JSON. For more information, check STRICTJSONOUTPUT docs.
- suspend
Task NumberAfter Num Failures - Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
- task
Auto NumberRetry Attempts - Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
- time
Input StringFormat - Specifies the input format for the TIME data type. For more information, see Date and time input and output formats. Any valid, supported time format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of times stored in the system during the session). For more information, check TIMEINPUTFORMAT docs.
- time
Output StringFormat - Specifies the display format for the TIME data type. For more information, see Date and time input and output formats. For more information, check TIMEOUTPUTFORMAT docs.
- timestamp
Day BooleanIs Always24h - Specifies whether the DATEADD function (and its aliases) always consider a day to be exactly 24 hours for expressions that span multiple days. For more information, check TIMESTAMPDAYISALWAYS24H docs.
- timestamp
Input StringFormat - Specifies the input format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. Any valid, supported timestamp format or AUTO (AUTO specifies that Snowflake attempts to automatically detect the format of timestamps stored in the system during the session). For more information, check TIMESTAMPINPUTFORMAT docs.
- timestamp
Ltz StringOutput Format - Specifies the display format for the TIMESTAMPLTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPLTZOUTPUT*FORMAT docs.
- timestamp
Ntz StringOutput Format - Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
- timestamp
Output StringFormat - Specifies the display format for the TIMESTAMP data type alias. For more information, see Date and time input and output formats. For more information, check TIMESTAMPOUTPUTFORMAT docs.
- timestamp
Type StringMapping - Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. Valid values are (case-insensitive):
TIMESTAMP_LTZ
|TIMESTAMP_NTZ
|TIMESTAMP_TZ
. For more information, check TIMESTAMP*TYPE_MAPPING docs. - timestamp
Tz StringOutput Format - Specifies the display format for the TIMESTAMPTZ data type. If no format is specified, defaults to OUTPUT*FORMATTIMESTAMP. For more information, see Date and time input and output formats. For more information, check TIMESTAMPTZOUTPUT*FORMAT docs.
- timezone String
- Specifies the time zone for the session. You can specify a time zone name or a link name from release 2021a of the IANA Time Zone Database (e.g. America/Los_Angeles, Europe/London, UTC, Etc/GMT, etc.). For more information, check TIMEZONE docs.
- trace
Level String - Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. Valid values are (case-insensitive):
ALWAYS
|ON_EVENT
|PROPAGATE
|OFF
. For more information, check TRACE_LEVEL docs. - transaction
Abort BooleanOn Error - Specifies the action to perform when a statement issued within a non-autocommit transaction returns with an error. For more information, check TRANSACTIONABORTON_ERROR docs.
- transaction
Default StringIsolation Level - Specifies the isolation level for transactions in the user session. Valid values are (case-insensitive):
READ COMMITTED
. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs. - two
Digit NumberCentury Start - Specifies the “century start” year for 2-digit years (i.e. the earliest year such dates can represent). This parameter prevents ambiguous dates when importing or converting data with the
YY
date format component (i.e. years represented as 2 digits). For more information, check TWODIGITCENTURY_START docs. - unsupported
Ddl StringAction - Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
- use
Cached BooleanResult - Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
- user
Task StringManaged Initial Warehouse Size - Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive):
XSMALL
|X-SMALL
|SMALL
|MEDIUM
|LARGE
|XLARGE
|X-LARGE
|XXLARGE
|X2LARGE
|2X-LARGE
|XXXLARGE
|X3LARGE
|3X-LARGE
|X4LARGE
|4X-LARGE
|X5LARGE
|5X-LARGE
|X6LARGE
|6X-LARGE
. 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 - Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
- week
Of NumberYear Policy - Specifies how the weeks in a given year are computed.
0
: The semantics used are equivalent to the ISO semantics, in which a week belongs to a given year if at least 4 days of that week are in that year.1
: January 1 is included in the first week of the year and December 31 is included in the last week of the year. For more information, check WEEKOFYEAR_POLICY docs. - week
Start Number - Specifies the first day of the week (used by week-related date functions).
0
: Legacy Snowflake behavior is used (i.e. ISO-like semantics).1
(Monday) to7
(Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflake
Terraform Provider.