Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. User
Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-snowflake

snowflake.User

Explore with Pulumi AI

Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-snowflake

Import

$ pulumi import snowflake:index/user:User example '"<user_name>"'
Copy

Note: pulumi preview+apply may be needed after successful import to fill out all the missing fields (like password) in state.

Create User Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new User(name: string, args?: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
         args: Optional[UserArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         abort_detached_query: Optional[bool] = None,
         autocommit: Optional[bool] = None,
         binary_input_format: Optional[str] = None,
         binary_output_format: Optional[str] = None,
         client_memory_limit: Optional[int] = None,
         client_metadata_request_use_connection_ctx: 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,
         comment: Optional[str] = None,
         date_input_format: Optional[str] = None,
         date_output_format: Optional[str] = None,
         days_to_expiry: Optional[int] = None,
         default_namespace: Optional[str] = None,
         default_role: Optional[str] = None,
         default_secondary_roles_option: Optional[str] = None,
         default_warehouse: Optional[str] = None,
         disable_mfa: Optional[str] = None,
         disabled: Optional[str] = None,
         display_name: Optional[str] = None,
         email: Optional[str] = None,
         enable_unload_physical_type_optimization: Optional[bool] = None,
         enable_unredacted_query_syntax_error: Optional[bool] = None,
         error_on_nondeterministic_merge: Optional[bool] = None,
         error_on_nondeterministic_update: Optional[bool] = None,
         first_name: Optional[str] = None,
         geography_output_format: Optional[str] = None,
         geometry_output_format: 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,
         json_indent: Optional[int] = None,
         last_name: Optional[str] = None,
         lock_timeout: Optional[int] = None,
         log_level: Optional[str] = None,
         login_name: Optional[str] = None,
         middle_name: Optional[str] = None,
         mins_to_bypass_mfa: Optional[int] = None,
         mins_to_unlock: Optional[int] = None,
         multi_statement_count: Optional[int] = None,
         must_change_password: Optional[str] = None,
         name: Optional[str] = None,
         network_policy: Optional[str] = None,
         noorder_sequence_as_default: Optional[bool] = None,
         odbc_treat_decimal_as_int: Optional[bool] = None,
         password: Optional[str] = None,
         prevent_unload_to_internal_stages: Optional[bool] = None,
         query_tag: Optional[str] = None,
         quoted_identifiers_ignore_case: Optional[bool] = None,
         rows_per_resultset: Optional[int] = None,
         rsa_public_key: Optional[str] = None,
         rsa_public_key2: Optional[str] = None,
         s3_stage_vpce_dns_name: Optional[str] = None,
         search_path: Optional[str] = None,
         simulated_data_sharing_consumer: Optional[str] = None,
         statement_queued_timeout_in_seconds: Optional[int] = None,
         statement_timeout_in_seconds: Optional[int] = None,
         strict_json_output: Optional[bool] = 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,
         week_of_year_policy: Optional[int] = None,
         week_start: Optional[int] = None)
func NewUser(ctx *Context, name string, args *UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs? args = null, CustomResourceOptions? opts = null)
public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

type: snowflake:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UserArgs
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 userResource = new Snowflake.User("userResource", new()
{
    AbortDetachedQuery = false,
    Autocommit = false,
    BinaryInputFormat = "string",
    BinaryOutputFormat = "string",
    ClientMemoryLimit = 0,
    ClientMetadataRequestUseConnectionCtx = false,
    ClientPrefetchThreads = 0,
    ClientResultChunkSize = 0,
    ClientResultColumnCaseInsensitive = false,
    ClientSessionKeepAlive = false,
    ClientSessionKeepAliveHeartbeatFrequency = 0,
    ClientTimestampTypeMapping = "string",
    Comment = "string",
    DateInputFormat = "string",
    DateOutputFormat = "string",
    DaysToExpiry = 0,
    DefaultNamespace = "string",
    DefaultRole = "string",
    DefaultSecondaryRolesOption = "string",
    DefaultWarehouse = "string",
    DisableMfa = "string",
    Disabled = "string",
    DisplayName = "string",
    Email = "string",
    EnableUnloadPhysicalTypeOptimization = false,
    EnableUnredactedQuerySyntaxError = false,
    ErrorOnNondeterministicMerge = false,
    ErrorOnNondeterministicUpdate = false,
    FirstName = "string",
    GeographyOutputFormat = "string",
    GeometryOutputFormat = "string",
    JdbcTreatDecimalAsInt = false,
    JdbcTreatTimestampNtzAsUtc = false,
    JdbcUseSessionTimezone = false,
    JsonIndent = 0,
    LastName = "string",
    LockTimeout = 0,
    LogLevel = "string",
    LoginName = "string",
    MiddleName = "string",
    MinsToBypassMfa = 0,
    MinsToUnlock = 0,
    MultiStatementCount = 0,
    MustChangePassword = "string",
    Name = "string",
    NetworkPolicy = "string",
    NoorderSequenceAsDefault = false,
    OdbcTreatDecimalAsInt = false,
    Password = "string",
    PreventUnloadToInternalStages = false,
    QueryTag = "string",
    QuotedIdentifiersIgnoreCase = false,
    RowsPerResultset = 0,
    RsaPublicKey = "string",
    RsaPublicKey2 = "string",
    S3StageVpceDnsName = "string",
    SearchPath = "string",
    SimulatedDataSharingConsumer = "string",
    StatementQueuedTimeoutInSeconds = 0,
    StatementTimeoutInSeconds = 0,
    StrictJsonOutput = false,
    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,
    WeekOfYearPolicy = 0,
    WeekStart = 0,
});
Copy
example, err := snowflake.NewUser(ctx, "userResource", &snowflake.UserArgs{
	AbortDetachedQuery:                       pulumi.Bool(false),
	Autocommit:                               pulumi.Bool(false),
	BinaryInputFormat:                        pulumi.String("string"),
	BinaryOutputFormat:                       pulumi.String("string"),
	ClientMemoryLimit:                        pulumi.Int(0),
	ClientMetadataRequestUseConnectionCtx:    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"),
	Comment:                                  pulumi.String("string"),
	DateInputFormat:                          pulumi.String("string"),
	DateOutputFormat:                         pulumi.String("string"),
	DaysToExpiry:                             pulumi.Int(0),
	DefaultNamespace:                         pulumi.String("string"),
	DefaultRole:                              pulumi.String("string"),
	DefaultSecondaryRolesOption:              pulumi.String("string"),
	DefaultWarehouse:                         pulumi.String("string"),
	DisableMfa:                               pulumi.String("string"),
	Disabled:                                 pulumi.String("string"),
	DisplayName:                              pulumi.String("string"),
	Email:                                    pulumi.String("string"),
	EnableUnloadPhysicalTypeOptimization:     pulumi.Bool(false),
	EnableUnredactedQuerySyntaxError:         pulumi.Bool(false),
	ErrorOnNondeterministicMerge:             pulumi.Bool(false),
	ErrorOnNondeterministicUpdate:            pulumi.Bool(false),
	FirstName:                                pulumi.String("string"),
	GeographyOutputFormat:                    pulumi.String("string"),
	GeometryOutputFormat:                     pulumi.String("string"),
	JdbcTreatDecimalAsInt:                    pulumi.Bool(false),
	JdbcTreatTimestampNtzAsUtc:               pulumi.Bool(false),
	JdbcUseSessionTimezone:                   pulumi.Bool(false),
	JsonIndent:                               pulumi.Int(0),
	LastName:                                 pulumi.String("string"),
	LockTimeout:                              pulumi.Int(0),
	LogLevel:                                 pulumi.String("string"),
	LoginName:                                pulumi.String("string"),
	MiddleName:                               pulumi.String("string"),
	MinsToBypassMfa:                          pulumi.Int(0),
	MinsToUnlock:                             pulumi.Int(0),
	MultiStatementCount:                      pulumi.Int(0),
	MustChangePassword:                       pulumi.String("string"),
	Name:                                     pulumi.String("string"),
	NetworkPolicy:                            pulumi.String("string"),
	NoorderSequenceAsDefault:                 pulumi.Bool(false),
	OdbcTreatDecimalAsInt:                    pulumi.Bool(false),
	Password:                                 pulumi.String("string"),
	PreventUnloadToInternalStages:            pulumi.Bool(false),
	QueryTag:                                 pulumi.String("string"),
	QuotedIdentifiersIgnoreCase:              pulumi.Bool(false),
	RowsPerResultset:                         pulumi.Int(0),
	RsaPublicKey:                             pulumi.String("string"),
	RsaPublicKey2:                            pulumi.String("string"),
	S3StageVpceDnsName:                       pulumi.String("string"),
	SearchPath:                               pulumi.String("string"),
	SimulatedDataSharingConsumer:             pulumi.String("string"),
	StatementQueuedTimeoutInSeconds:          pulumi.Int(0),
	StatementTimeoutInSeconds:                pulumi.Int(0),
	StrictJsonOutput:                         pulumi.Bool(false),
	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),
	WeekOfYearPolicy:                         pulumi.Int(0),
	WeekStart:                                pulumi.Int(0),
})
Copy
var userResource = new User("userResource", UserArgs.builder()
    .abortDetachedQuery(false)
    .autocommit(false)
    .binaryInputFormat("string")
    .binaryOutputFormat("string")
    .clientMemoryLimit(0)
    .clientMetadataRequestUseConnectionCtx(false)
    .clientPrefetchThreads(0)
    .clientResultChunkSize(0)
    .clientResultColumnCaseInsensitive(false)
    .clientSessionKeepAlive(false)
    .clientSessionKeepAliveHeartbeatFrequency(0)
    .clientTimestampTypeMapping("string")
    .comment("string")
    .dateInputFormat("string")
    .dateOutputFormat("string")
    .daysToExpiry(0)
    .defaultNamespace("string")
    .defaultRole("string")
    .defaultSecondaryRolesOption("string")
    .defaultWarehouse("string")
    .disableMfa("string")
    .disabled("string")
    .displayName("string")
    .email("string")
    .enableUnloadPhysicalTypeOptimization(false)
    .enableUnredactedQuerySyntaxError(false)
    .errorOnNondeterministicMerge(false)
    .errorOnNondeterministicUpdate(false)
    .firstName("string")
    .geographyOutputFormat("string")
    .geometryOutputFormat("string")
    .jdbcTreatDecimalAsInt(false)
    .jdbcTreatTimestampNtzAsUtc(false)
    .jdbcUseSessionTimezone(false)
    .jsonIndent(0)
    .lastName("string")
    .lockTimeout(0)
    .logLevel("string")
    .loginName("string")
    .middleName("string")
    .minsToBypassMfa(0)
    .minsToUnlock(0)
    .multiStatementCount(0)
    .mustChangePassword("string")
    .name("string")
    .networkPolicy("string")
    .noorderSequenceAsDefault(false)
    .odbcTreatDecimalAsInt(false)
    .password("string")
    .preventUnloadToInternalStages(false)
    .queryTag("string")
    .quotedIdentifiersIgnoreCase(false)
    .rowsPerResultset(0)
    .rsaPublicKey("string")
    .rsaPublicKey2("string")
    .s3StageVpceDnsName("string")
    .searchPath("string")
    .simulatedDataSharingConsumer("string")
    .statementQueuedTimeoutInSeconds(0)
    .statementTimeoutInSeconds(0)
    .strictJsonOutput(false)
    .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)
    .weekOfYearPolicy(0)
    .weekStart(0)
    .build());
Copy
user_resource = snowflake.User("userResource",
    abort_detached_query=False,
    autocommit=False,
    binary_input_format="string",
    binary_output_format="string",
    client_memory_limit=0,
    client_metadata_request_use_connection_ctx=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",
    comment="string",
    date_input_format="string",
    date_output_format="string",
    days_to_expiry=0,
    default_namespace="string",
    default_role="string",
    default_secondary_roles_option="string",
    default_warehouse="string",
    disable_mfa="string",
    disabled="string",
    display_name="string",
    email="string",
    enable_unload_physical_type_optimization=False,
    enable_unredacted_query_syntax_error=False,
    error_on_nondeterministic_merge=False,
    error_on_nondeterministic_update=False,
    first_name="string",
    geography_output_format="string",
    geometry_output_format="string",
    jdbc_treat_decimal_as_int=False,
    jdbc_treat_timestamp_ntz_as_utc=False,
    jdbc_use_session_timezone=False,
    json_indent=0,
    last_name="string",
    lock_timeout=0,
    log_level="string",
    login_name="string",
    middle_name="string",
    mins_to_bypass_mfa=0,
    mins_to_unlock=0,
    multi_statement_count=0,
    must_change_password="string",
    name="string",
    network_policy="string",
    noorder_sequence_as_default=False,
    odbc_treat_decimal_as_int=False,
    password="string",
    prevent_unload_to_internal_stages=False,
    query_tag="string",
    quoted_identifiers_ignore_case=False,
    rows_per_resultset=0,
    rsa_public_key="string",
    rsa_public_key2="string",
    s3_stage_vpce_dns_name="string",
    search_path="string",
    simulated_data_sharing_consumer="string",
    statement_queued_timeout_in_seconds=0,
    statement_timeout_in_seconds=0,
    strict_json_output=False,
    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,
    week_of_year_policy=0,
    week_start=0)
Copy
const userResource = new snowflake.User("userResource", {
    abortDetachedQuery: false,
    autocommit: false,
    binaryInputFormat: "string",
    binaryOutputFormat: "string",
    clientMemoryLimit: 0,
    clientMetadataRequestUseConnectionCtx: false,
    clientPrefetchThreads: 0,
    clientResultChunkSize: 0,
    clientResultColumnCaseInsensitive: false,
    clientSessionKeepAlive: false,
    clientSessionKeepAliveHeartbeatFrequency: 0,
    clientTimestampTypeMapping: "string",
    comment: "string",
    dateInputFormat: "string",
    dateOutputFormat: "string",
    daysToExpiry: 0,
    defaultNamespace: "string",
    defaultRole: "string",
    defaultSecondaryRolesOption: "string",
    defaultWarehouse: "string",
    disableMfa: "string",
    disabled: "string",
    displayName: "string",
    email: "string",
    enableUnloadPhysicalTypeOptimization: false,
    enableUnredactedQuerySyntaxError: false,
    errorOnNondeterministicMerge: false,
    errorOnNondeterministicUpdate: false,
    firstName: "string",
    geographyOutputFormat: "string",
    geometryOutputFormat: "string",
    jdbcTreatDecimalAsInt: false,
    jdbcTreatTimestampNtzAsUtc: false,
    jdbcUseSessionTimezone: false,
    jsonIndent: 0,
    lastName: "string",
    lockTimeout: 0,
    logLevel: "string",
    loginName: "string",
    middleName: "string",
    minsToBypassMfa: 0,
    minsToUnlock: 0,
    multiStatementCount: 0,
    mustChangePassword: "string",
    name: "string",
    networkPolicy: "string",
    noorderSequenceAsDefault: false,
    odbcTreatDecimalAsInt: false,
    password: "string",
    preventUnloadToInternalStages: false,
    queryTag: "string",
    quotedIdentifiersIgnoreCase: false,
    rowsPerResultset: 0,
    rsaPublicKey: "string",
    rsaPublicKey2: "string",
    s3StageVpceDnsName: "string",
    searchPath: "string",
    simulatedDataSharingConsumer: "string",
    statementQueuedTimeoutInSeconds: 0,
    statementTimeoutInSeconds: 0,
    strictJsonOutput: false,
    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,
    weekOfYearPolicy: 0,
    weekStart: 0,
});
Copy
type: snowflake:User
properties:
    abortDetachedQuery: false
    autocommit: false
    binaryInputFormat: string
    binaryOutputFormat: string
    clientMemoryLimit: 0
    clientMetadataRequestUseConnectionCtx: false
    clientPrefetchThreads: 0
    clientResultChunkSize: 0
    clientResultColumnCaseInsensitive: false
    clientSessionKeepAlive: false
    clientSessionKeepAliveHeartbeatFrequency: 0
    clientTimestampTypeMapping: string
    comment: string
    dateInputFormat: string
    dateOutputFormat: string
    daysToExpiry: 0
    defaultNamespace: string
    defaultRole: string
    defaultSecondaryRolesOption: string
    defaultWarehouse: string
    disableMfa: string
    disabled: string
    displayName: string
    email: string
    enableUnloadPhysicalTypeOptimization: false
    enableUnredactedQuerySyntaxError: false
    errorOnNondeterministicMerge: false
    errorOnNondeterministicUpdate: false
    firstName: string
    geographyOutputFormat: string
    geometryOutputFormat: string
    jdbcTreatDecimalAsInt: false
    jdbcTreatTimestampNtzAsUtc: false
    jdbcUseSessionTimezone: false
    jsonIndent: 0
    lastName: string
    lockTimeout: 0
    logLevel: string
    loginName: string
    middleName: string
    minsToBypassMfa: 0
    minsToUnlock: 0
    multiStatementCount: 0
    mustChangePassword: string
    name: string
    networkPolicy: string
    noorderSequenceAsDefault: false
    odbcTreatDecimalAsInt: false
    password: string
    preventUnloadToInternalStages: false
    queryTag: string
    quotedIdentifiersIgnoreCase: false
    rowsPerResultset: 0
    rsaPublicKey: string
    rsaPublicKey2: string
    s3StageVpceDnsName: string
    searchPath: string
    simulatedDataSharingConsumer: string
    statementQueuedTimeoutInSeconds: 0
    statementTimeoutInSeconds: 0
    strictJsonOutput: false
    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
    weekOfYearPolicy: 0
    weekStart: 0
Copy

User 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 User resource accepts the following input properties:

AbortDetachedQuery bool
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.
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.
BinaryInputFormat string
The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. For more information, check BINARYINPUTFORMAT docs.
BinaryOutputFormat string
The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. For more information, check BINARYOUTPUTFORMAT docs.
ClientMemoryLimit int
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.
ClientMetadataRequestUseConnectionCtx bool
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.
ClientPrefetchThreads int
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.
ClientResultChunkSize int
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.
ClientResultColumnCaseInsensitive bool
Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
ClientSessionKeepAlive bool
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.
ClientSessionKeepAliveHeartbeatFrequency int
Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
ClientTimestampTypeMapping string
Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs.
Comment string
Specifies a comment for the user.
DateInputFormat string
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.
DateOutputFormat string
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.
DaysToExpiry int
DefaultNamespace string
Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
DefaultRole string
Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does not grant the role to the user. The role must be granted explicitly to the user using the GRANT ROLE command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
DefaultSecondaryRolesOption string
(Default: DEFAULT) Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): DEFAULT | NONE | ALL. More information can be found in doc.
DefaultWarehouse string
Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
DisableMfa string
Disabled string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
DisplayName string
Name displayed for the user in the Snowflake web interface.
Email string
Email address for the user.
EnableUnloadPhysicalTypeOptimization bool
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.
EnableUnredactedQuerySyntaxError bool
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.
ErrorOnNondeterministicMerge bool
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.
ErrorOnNondeterministicUpdate bool
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.
FirstName string
First name of the user.
GeographyOutputFormat string
Display format for GEOGRAPHY values. For more information, check GEOGRAPHYOUTPUTFORMAT docs.
GeometryOutputFormat string
Display format for GEOMETRY values. For more information, check GEOMETRYOUTPUTFORMAT docs.
JdbcTreatDecimalAsInt bool
Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
JdbcTreatTimestampNtzAsUtc bool
Specifies how JDBC processes TIMESTAMPNTZ values. For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
JdbcUseSessionTimezone bool
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.
JsonIndent 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.
LastName string
Last name of the user.
LockTimeout 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.
LogLevel 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 log level. For more information, check LOG_LEVEL docs.
LoginName string
The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
MiddleName string
Middle name of the user.
MinsToBypassMfa int
MinsToUnlock int
MultiStatementCount int
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
MustChangePassword string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
Name string
Name of the user. Note that if you do not supply loginname this will be used as loginname. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
NetworkPolicy 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. Any existing network policy (created using CREATE NETWORK POLICY). For more information, check NETWORK_POLICY docs.
NoorderSequenceAsDefault bool
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.
OdbcTreatDecimalAsInt bool
Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
Password string
PreventUnloadToInternalStages bool
Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO \n\n statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
QueryTag 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.
QuotedIdentifiersIgnoreCase bool
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.
RowsPerResultset int
Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
RsaPublicKey string
Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
RsaPublicKey2 string
Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
S3StageVpceDnsName string
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.
SearchPath 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.
SimulatedDataSharingConsumer string
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, see Introduction to Secure Data Sharing and Working with shares. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
StatementQueuedTimeoutInSeconds int
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.
StatementTimeoutInSeconds int
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.
StrictJsonOutput bool
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.
TimeInputFormat string
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.
TimeOutputFormat string
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.
TimestampDayIsAlways24h bool
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.
TimestampInputFormat string
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.
TimestampLtzOutputFormat string
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.
TimestampNtzOutputFormat string
Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
TimestampOutputFormat string
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.
TimestampTypeMapping string
Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check TIMESTAMP*TYPE_MAPPING docs.
TimestampTzOutputFormat string
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.
TraceLevel string
Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. For more information, check TRACE_LEVEL docs.
TransactionAbortOnError bool
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.
TransactionDefaultIsolationLevel string
Specifies the isolation level for transactions in the user session. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs.
TwoDigitCenturyStart int
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.
UnsupportedDdlAction string
Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
UseCachedResult bool
Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
WeekOfYearPolicy int
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.
WeekStart 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) to 7 (Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
AbortDetachedQuery bool
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.
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.
BinaryInputFormat string
The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. For more information, check BINARYINPUTFORMAT docs.
BinaryOutputFormat string
The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. For more information, check BINARYOUTPUTFORMAT docs.
ClientMemoryLimit int
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.
ClientMetadataRequestUseConnectionCtx bool
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.
ClientPrefetchThreads int
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.
ClientResultChunkSize int
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.
ClientResultColumnCaseInsensitive bool
Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
ClientSessionKeepAlive bool
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.
ClientSessionKeepAliveHeartbeatFrequency int
Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
ClientTimestampTypeMapping string
Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs.
Comment string
Specifies a comment for the user.
DateInputFormat string
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.
DateOutputFormat string
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.
DaysToExpiry int
DefaultNamespace string
Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
DefaultRole string
Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does not grant the role to the user. The role must be granted explicitly to the user using the GRANT ROLE command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
DefaultSecondaryRolesOption string
(Default: DEFAULT) Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): DEFAULT | NONE | ALL. More information can be found in doc.
DefaultWarehouse string
Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
DisableMfa string
Disabled string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
DisplayName string
Name displayed for the user in the Snowflake web interface.
Email string
Email address for the user.
EnableUnloadPhysicalTypeOptimization bool
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.
EnableUnredactedQuerySyntaxError bool
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.
ErrorOnNondeterministicMerge bool
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.
ErrorOnNondeterministicUpdate bool
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.
FirstName string
First name of the user.
GeographyOutputFormat string
Display format for GEOGRAPHY values. For more information, check GEOGRAPHYOUTPUTFORMAT docs.
GeometryOutputFormat string
Display format for GEOMETRY values. For more information, check GEOMETRYOUTPUTFORMAT docs.
JdbcTreatDecimalAsInt bool
Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
JdbcTreatTimestampNtzAsUtc bool
Specifies how JDBC processes TIMESTAMPNTZ values. For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
JdbcUseSessionTimezone bool
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.
JsonIndent 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.
LastName string
Last name of the user.
LockTimeout 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.
LogLevel 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 log level. For more information, check LOG_LEVEL docs.
LoginName string
The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
MiddleName string
Middle name of the user.
MinsToBypassMfa int
MinsToUnlock int
MultiStatementCount int
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
MustChangePassword string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
Name string
Name of the user. Note that if you do not supply loginname this will be used as loginname. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
NetworkPolicy 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. Any existing network policy (created using CREATE NETWORK POLICY). For more information, check NETWORK_POLICY docs.
NoorderSequenceAsDefault bool
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.
OdbcTreatDecimalAsInt bool
Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
Password string
PreventUnloadToInternalStages bool
Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO \n\n statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
QueryTag 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.
QuotedIdentifiersIgnoreCase bool
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.
RowsPerResultset int
Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
RsaPublicKey string
Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
RsaPublicKey2 string
Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
S3StageVpceDnsName string
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.
SearchPath 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.
SimulatedDataSharingConsumer string
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, see Introduction to Secure Data Sharing and Working with shares. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
StatementQueuedTimeoutInSeconds int
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.
StatementTimeoutInSeconds int
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.
StrictJsonOutput bool
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.
TimeInputFormat string
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.
TimeOutputFormat string
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.
TimestampDayIsAlways24h bool
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.
TimestampInputFormat string
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.
TimestampLtzOutputFormat string
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.
TimestampNtzOutputFormat string
Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
TimestampOutputFormat string
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.
TimestampTypeMapping string
Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check TIMESTAMP*TYPE_MAPPING docs.
TimestampTzOutputFormat string
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.
TraceLevel string
Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. For more information, check TRACE_LEVEL docs.
TransactionAbortOnError bool
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.
TransactionDefaultIsolationLevel string
Specifies the isolation level for transactions in the user session. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs.
TwoDigitCenturyStart int
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.
UnsupportedDdlAction string
Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
UseCachedResult bool
Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
WeekOfYearPolicy int
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.
WeekStart 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) to 7 (Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
abortDetachedQuery Boolean
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.
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.
binaryInputFormat String
The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. For more information, check BINARYINPUTFORMAT docs.
binaryOutputFormat String
The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. For more information, check BINARYOUTPUTFORMAT docs.
clientMemoryLimit Integer
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.
clientMetadataRequestUseConnectionCtx Boolean
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.
clientPrefetchThreads Integer
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.
clientResultChunkSize Integer
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.
clientResultColumnCaseInsensitive Boolean
Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
clientSessionKeepAlive Boolean
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.
clientSessionKeepAliveHeartbeatFrequency Integer
Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
clientTimestampTypeMapping String
Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs.
comment String
Specifies a comment for the user.
dateInputFormat String
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.
dateOutputFormat String
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.
daysToExpiry Integer
defaultNamespace String
Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
defaultRole String
Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does not grant the role to the user. The role must be granted explicitly to the user using the GRANT ROLE command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
defaultSecondaryRolesOption String
(Default: DEFAULT) Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): DEFAULT | NONE | ALL. More information can be found in doc.
defaultWarehouse String
Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
disableMfa String
disabled String
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
displayName String
Name displayed for the user in the Snowflake web interface.
email String
Email address for the user.
enableUnloadPhysicalTypeOptimization Boolean
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.
enableUnredactedQuerySyntaxError Boolean
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.
errorOnNondeterministicMerge Boolean
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.
errorOnNondeterministicUpdate Boolean
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.
firstName String
First name of the user.
geographyOutputFormat String
Display format for GEOGRAPHY values. For more information, check GEOGRAPHYOUTPUTFORMAT docs.
geometryOutputFormat String
Display format for GEOMETRY values. For more information, check GEOMETRYOUTPUTFORMAT docs.
jdbcTreatDecimalAsInt Boolean
Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
jdbcTreatTimestampNtzAsUtc Boolean
Specifies how JDBC processes TIMESTAMPNTZ values. For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
jdbcUseSessionTimezone Boolean
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.
jsonIndent 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.
lastName String
Last name of the user.
lockTimeout 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.
logLevel 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 log level. For more information, check LOG_LEVEL docs.
loginName String
The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
middleName String
Middle name of the user.
minsToBypassMfa Integer
minsToUnlock Integer
multiStatementCount Integer
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
mustChangePassword String
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
name String
Name of the user. Note that if you do not supply loginname this will be used as loginname. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
networkPolicy 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. Any existing network policy (created using CREATE NETWORK POLICY). For more information, check NETWORK_POLICY docs.
noorderSequenceAsDefault Boolean
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.
odbcTreatDecimalAsInt Boolean
Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
password String
preventUnloadToInternalStages Boolean
Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO \n\n statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
queryTag 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.
quotedIdentifiersIgnoreCase Boolean
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.
rowsPerResultset Integer
Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
rsaPublicKey String
Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
rsaPublicKey2 String
Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
s3StageVpceDnsName String
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.
searchPath 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.
simulatedDataSharingConsumer String
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, see Introduction to Secure Data Sharing and Working with shares. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
statementQueuedTimeoutInSeconds Integer
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.
statementTimeoutInSeconds Integer
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.
strictJsonOutput Boolean
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.
timeInputFormat String
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.
timeOutputFormat String
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.
timestampDayIsAlways24h Boolean
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.
timestampInputFormat String
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.
timestampLtzOutputFormat String
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.
timestampNtzOutputFormat String
Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
timestampOutputFormat String
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.
timestampTypeMapping String
Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check TIMESTAMP*TYPE_MAPPING docs.
timestampTzOutputFormat String
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.
traceLevel String
Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. For more information, check TRACE_LEVEL docs.
transactionAbortOnError Boolean
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.
transactionDefaultIsolationLevel String
Specifies the isolation level for transactions in the user session. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs.
twoDigitCenturyStart Integer
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.
unsupportedDdlAction String
Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
useCachedResult Boolean
Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
weekOfYearPolicy Integer
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.
weekStart 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) to 7 (Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
abortDetachedQuery boolean
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.
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.
binaryInputFormat string
The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. For more information, check BINARYINPUTFORMAT docs.
binaryOutputFormat string
The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. For more information, check BINARYOUTPUTFORMAT docs.
clientMemoryLimit number
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.
clientMetadataRequestUseConnectionCtx boolean
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.
clientPrefetchThreads number
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.
clientResultChunkSize number
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.
clientResultColumnCaseInsensitive boolean
Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
clientSessionKeepAlive boolean
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.
clientSessionKeepAliveHeartbeatFrequency number
Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
clientTimestampTypeMapping string
Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs.
comment string
Specifies a comment for the user.
dateInputFormat string
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.
dateOutputFormat string
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.
daysToExpiry number
defaultNamespace string
Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
defaultRole string
Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does not grant the role to the user. The role must be granted explicitly to the user using the GRANT ROLE command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
defaultSecondaryRolesOption string
(Default: DEFAULT) Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): DEFAULT | NONE | ALL. More information can be found in doc.
defaultWarehouse string
Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
disableMfa string
disabled string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
displayName string
Name displayed for the user in the Snowflake web interface.
email string
Email address for the user.
enableUnloadPhysicalTypeOptimization boolean
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.
enableUnredactedQuerySyntaxError boolean
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.
errorOnNondeterministicMerge boolean
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.
errorOnNondeterministicUpdate boolean
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.
firstName string
First name of the user.
geographyOutputFormat string
Display format for GEOGRAPHY values. For more information, check GEOGRAPHYOUTPUTFORMAT docs.
geometryOutputFormat string
Display format for GEOMETRY values. For more information, check GEOMETRYOUTPUTFORMAT docs.
jdbcTreatDecimalAsInt boolean
Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
jdbcTreatTimestampNtzAsUtc boolean
Specifies how JDBC processes TIMESTAMPNTZ values. For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
jdbcUseSessionTimezone boolean
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.
jsonIndent 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.
lastName string
Last name of the user.
lockTimeout 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.
logLevel 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 log level. For more information, check LOG_LEVEL docs.
loginName string
The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
middleName string
Middle name of the user.
minsToBypassMfa number
minsToUnlock number
multiStatementCount number
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
mustChangePassword string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
name string
Name of the user. Note that if you do not supply loginname this will be used as loginname. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
networkPolicy 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. Any existing network policy (created using CREATE NETWORK POLICY). For more information, check NETWORK_POLICY docs.
noorderSequenceAsDefault boolean
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.
odbcTreatDecimalAsInt boolean
Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
password string
preventUnloadToInternalStages boolean
Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO \n\n statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
queryTag 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.
quotedIdentifiersIgnoreCase boolean
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.
rowsPerResultset number
Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
rsaPublicKey string
Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
rsaPublicKey2 string
Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
s3StageVpceDnsName string
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.
searchPath 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.
simulatedDataSharingConsumer string
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, see Introduction to Secure Data Sharing and Working with shares. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
statementQueuedTimeoutInSeconds number
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.
statementTimeoutInSeconds number
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.
strictJsonOutput boolean
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.
timeInputFormat string
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.
timeOutputFormat string
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.
timestampDayIsAlways24h boolean
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.
timestampInputFormat string
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.
timestampLtzOutputFormat string
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.
timestampNtzOutputFormat string
Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
timestampOutputFormat string
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.
timestampTypeMapping string
Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check TIMESTAMP*TYPE_MAPPING docs.
timestampTzOutputFormat string
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.
traceLevel string
Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. For more information, check TRACE_LEVEL docs.
transactionAbortOnError boolean
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.
transactionDefaultIsolationLevel string
Specifies the isolation level for transactions in the user session. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs.
twoDigitCenturyStart number
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.
unsupportedDdlAction string
Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
useCachedResult boolean
Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
weekOfYearPolicy number
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.
weekStart 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) to 7 (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_query bool
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.
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.
binary_input_format str
The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. For more information, check BINARYINPUTFORMAT docs.
binary_output_format str
The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. For more information, check BINARYOUTPUTFORMAT docs.
client_memory_limit int
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_request_use_connection_ctx bool
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_prefetch_threads int
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_chunk_size int
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_column_case_insensitive bool
Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
client_session_keep_alive bool
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_keep_alive_heartbeat_frequency int
Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
client_timestamp_type_mapping str
Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs.
comment str
Specifies a comment for the user.
date_input_format str
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_format str
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.
days_to_expiry int
default_namespace str
Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
default_role str
Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does not grant the role to the user. The role must be granted explicitly to the user using the GRANT ROLE command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
default_secondary_roles_option str
(Default: DEFAULT) Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): DEFAULT | NONE | ALL. More information can be found in doc.
default_warehouse str
Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
disable_mfa str
disabled str
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
display_name str
Name displayed for the user in the Snowflake web interface.
email str
Email address for the user.
enable_unload_physical_type_optimization bool
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_query_syntax_error bool
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.
error_on_nondeterministic_merge bool
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_nondeterministic_update bool
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.
first_name str
First name of the user.
geography_output_format str
Display format for GEOGRAPHY values. For more information, check GEOGRAPHYOUTPUTFORMAT docs.
geometry_output_format str
Display format for GEOMETRY values. For more information, check GEOMETRYOUTPUTFORMAT docs.
jdbc_treat_decimal_as_int bool
Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
jdbc_treat_timestamp_ntz_as_utc bool
Specifies how JDBC processes TIMESTAMPNTZ values. For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
jdbc_use_session_timezone bool
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.
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.
last_name str
Last name of the user.
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 log level. For more information, check LOG_LEVEL docs.
login_name str
The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
middle_name str
Middle name of the user.
mins_to_bypass_mfa int
mins_to_unlock int
multi_statement_count int
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
must_change_password str
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
name str
Name of the user. Note that if you do not supply loginname this will be used as loginname. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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. Any existing network policy (created using CREATE NETWORK POLICY). For more information, check NETWORK_POLICY docs.
noorder_sequence_as_default bool
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.
odbc_treat_decimal_as_int bool
Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
password str
prevent_unload_to_internal_stages bool
Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO \n\n statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES 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_ignore_case bool
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.
rows_per_resultset int
Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
rsa_public_key str
Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
rsa_public_key2 str
Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
s3_stage_vpce_dns_name str
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.
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.
simulated_data_sharing_consumer str
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, see Introduction to Secure Data Sharing and Working with shares. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
statement_queued_timeout_in_seconds int
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_in_seconds int
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.
strict_json_output bool
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.
time_input_format str
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_format str
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_is_always24h bool
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_format str
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_output_format str
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_output_format str
Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
timestamp_output_format str
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_mapping str
Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check TIMESTAMP*TYPE_MAPPING docs.
timestamp_tz_output_format str
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. For more information, check TRACE_LEVEL docs.
transaction_abort_on_error bool
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_isolation_level str
Specifies the isolation level for transactions in the user session. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs.
two_digit_century_start int
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_action str
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_result bool
Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
week_of_year_policy int
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) to 7 (Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
abortDetachedQuery Boolean
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.
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.
binaryInputFormat String
The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. For more information, check BINARYINPUTFORMAT docs.
binaryOutputFormat String
The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. For more information, check BINARYOUTPUTFORMAT docs.
clientMemoryLimit Number
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.
clientMetadataRequestUseConnectionCtx Boolean
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.
clientPrefetchThreads Number
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.
clientResultChunkSize Number
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.
clientResultColumnCaseInsensitive Boolean
Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
clientSessionKeepAlive Boolean
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.
clientSessionKeepAliveHeartbeatFrequency Number
Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
clientTimestampTypeMapping String
Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs.
comment String
Specifies a comment for the user.
dateInputFormat String
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.
dateOutputFormat String
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.
daysToExpiry Number
defaultNamespace String
Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
defaultRole String
Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does not grant the role to the user. The role must be granted explicitly to the user using the GRANT ROLE command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
defaultSecondaryRolesOption String
(Default: DEFAULT) Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): DEFAULT | NONE | ALL. More information can be found in doc.
defaultWarehouse String
Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
disableMfa String
disabled String
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
displayName String
Name displayed for the user in the Snowflake web interface.
email String
Email address for the user.
enableUnloadPhysicalTypeOptimization Boolean
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.
enableUnredactedQuerySyntaxError Boolean
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.
errorOnNondeterministicMerge Boolean
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.
errorOnNondeterministicUpdate Boolean
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.
firstName String
First name of the user.
geographyOutputFormat String
Display format for GEOGRAPHY values. For more information, check GEOGRAPHYOUTPUTFORMAT docs.
geometryOutputFormat String
Display format for GEOMETRY values. For more information, check GEOMETRYOUTPUTFORMAT docs.
jdbcTreatDecimalAsInt Boolean
Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
jdbcTreatTimestampNtzAsUtc Boolean
Specifies how JDBC processes TIMESTAMPNTZ values. For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
jdbcUseSessionTimezone Boolean
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.
jsonIndent 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.
lastName String
Last name of the user.
lockTimeout 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.
logLevel 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 log level. For more information, check LOG_LEVEL docs.
loginName String
The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
middleName String
Middle name of the user.
minsToBypassMfa Number
minsToUnlock Number
multiStatementCount Number
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
mustChangePassword String
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
name String
Name of the user. Note that if you do not supply loginname this will be used as loginname. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
networkPolicy 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. Any existing network policy (created using CREATE NETWORK POLICY). For more information, check NETWORK_POLICY docs.
noorderSequenceAsDefault Boolean
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.
odbcTreatDecimalAsInt Boolean
Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
password String
preventUnloadToInternalStages Boolean
Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO \n\n statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
queryTag 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.
quotedIdentifiersIgnoreCase Boolean
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.
rowsPerResultset Number
Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
rsaPublicKey String
Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
rsaPublicKey2 String
Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
s3StageVpceDnsName String
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.
searchPath 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.
simulatedDataSharingConsumer String
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, see Introduction to Secure Data Sharing and Working with shares. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
statementQueuedTimeoutInSeconds Number
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.
statementTimeoutInSeconds Number
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.
strictJsonOutput Boolean
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.
timeInputFormat String
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.
timeOutputFormat String
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.
timestampDayIsAlways24h Boolean
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.
timestampInputFormat String
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.
timestampLtzOutputFormat String
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.
timestampNtzOutputFormat String
Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
timestampOutputFormat String
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.
timestampTypeMapping String
Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check TIMESTAMP*TYPE_MAPPING docs.
timestampTzOutputFormat String
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.
traceLevel String
Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. For more information, check TRACE_LEVEL docs.
transactionAbortOnError Boolean
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.
transactionDefaultIsolationLevel String
Specifies the isolation level for transactions in the user session. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs.
twoDigitCenturyStart Number
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.
unsupportedDdlAction String
Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
useCachedResult Boolean
Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
weekOfYearPolicy Number
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.
weekStart 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) to 7 (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 User resource produces the following output properties:

FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Id string
The provider-assigned unique ID for this managed resource.
Parameters List<UserParameter>
Outputs the result of SHOW PARAMETERS IN USER for the given user.
ShowOutputs List<UserShowOutput>
Outputs the result of SHOW USER for the given user.
UserType string
Specifies a type for the user.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Id string
The provider-assigned unique ID for this managed resource.
Parameters []UserParameter
Outputs the result of SHOW PARAMETERS IN USER for the given user.
ShowOutputs []UserShowOutput
Outputs the result of SHOW USER for the given user.
UserType string
Specifies a type for the user.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
id String
The provider-assigned unique ID for this managed resource.
parameters List<UserParameter>
Outputs the result of SHOW PARAMETERS IN USER for the given user.
showOutputs List<UserShowOutput>
Outputs the result of SHOW USER for the given user.
userType String
Specifies a type for the user.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
id string
The provider-assigned unique ID for this managed resource.
parameters UserParameter[]
Outputs the result of SHOW PARAMETERS IN USER for the given user.
showOutputs UserShowOutput[]
Outputs the result of SHOW USER for the given user.
userType string
Specifies a type for the user.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
id str
The provider-assigned unique ID for this managed resource.
parameters Sequence[UserParameter]
Outputs the result of SHOW PARAMETERS IN USER for the given user.
show_outputs Sequence[UserShowOutput]
Outputs the result of SHOW USER for the given user.
user_type str
Specifies a type for the user.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
id String
The provider-assigned unique ID for this managed resource.
parameters List<Property Map>
Outputs the result of SHOW PARAMETERS IN USER for the given user.
showOutputs List<Property Map>
Outputs the result of SHOW USER for the given user.
userType String
Specifies a type for the user.

Look up Existing User Resource

Get an existing User 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?: UserState, opts?: CustomResourceOptions): User
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        abort_detached_query: Optional[bool] = None,
        autocommit: Optional[bool] = None,
        binary_input_format: Optional[str] = None,
        binary_output_format: Optional[str] = None,
        client_memory_limit: Optional[int] = None,
        client_metadata_request_use_connection_ctx: 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,
        comment: Optional[str] = None,
        date_input_format: Optional[str] = None,
        date_output_format: Optional[str] = None,
        days_to_expiry: Optional[int] = None,
        default_namespace: Optional[str] = None,
        default_role: Optional[str] = None,
        default_secondary_roles_option: Optional[str] = None,
        default_warehouse: Optional[str] = None,
        disable_mfa: Optional[str] = None,
        disabled: Optional[str] = None,
        display_name: Optional[str] = None,
        email: Optional[str] = None,
        enable_unload_physical_type_optimization: Optional[bool] = None,
        enable_unredacted_query_syntax_error: Optional[bool] = None,
        error_on_nondeterministic_merge: Optional[bool] = None,
        error_on_nondeterministic_update: Optional[bool] = None,
        first_name: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        geography_output_format: Optional[str] = None,
        geometry_output_format: 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,
        json_indent: Optional[int] = None,
        last_name: Optional[str] = None,
        lock_timeout: Optional[int] = None,
        log_level: Optional[str] = None,
        login_name: Optional[str] = None,
        middle_name: Optional[str] = None,
        mins_to_bypass_mfa: Optional[int] = None,
        mins_to_unlock: Optional[int] = None,
        multi_statement_count: Optional[int] = None,
        must_change_password: Optional[str] = None,
        name: Optional[str] = None,
        network_policy: Optional[str] = None,
        noorder_sequence_as_default: Optional[bool] = None,
        odbc_treat_decimal_as_int: Optional[bool] = None,
        parameters: Optional[Sequence[UserParameterArgs]] = None,
        password: Optional[str] = None,
        prevent_unload_to_internal_stages: Optional[bool] = None,
        query_tag: Optional[str] = None,
        quoted_identifiers_ignore_case: Optional[bool] = None,
        rows_per_resultset: Optional[int] = None,
        rsa_public_key: Optional[str] = None,
        rsa_public_key2: Optional[str] = None,
        s3_stage_vpce_dns_name: Optional[str] = None,
        search_path: Optional[str] = None,
        show_outputs: Optional[Sequence[UserShowOutputArgs]] = None,
        simulated_data_sharing_consumer: Optional[str] = None,
        statement_queued_timeout_in_seconds: Optional[int] = None,
        statement_timeout_in_seconds: Optional[int] = None,
        strict_json_output: Optional[bool] = 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_type: Optional[str] = None,
        week_of_year_policy: Optional[int] = None,
        week_start: Optional[int] = None) -> User
func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
resources:  _:    type: snowflake:User    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
AbortDetachedQuery bool
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.
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.
BinaryInputFormat string
The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. For more information, check BINARYINPUTFORMAT docs.
BinaryOutputFormat string
The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. For more information, check BINARYOUTPUTFORMAT docs.
ClientMemoryLimit int
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.
ClientMetadataRequestUseConnectionCtx bool
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.
ClientPrefetchThreads int
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.
ClientResultChunkSize int
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.
ClientResultColumnCaseInsensitive bool
Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
ClientSessionKeepAlive bool
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.
ClientSessionKeepAliveHeartbeatFrequency int
Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
ClientTimestampTypeMapping string
Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs.
Comment string
Specifies a comment for the user.
DateInputFormat string
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.
DateOutputFormat string
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.
DaysToExpiry int
DefaultNamespace string
Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
DefaultRole string
Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does not grant the role to the user. The role must be granted explicitly to the user using the GRANT ROLE command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
DefaultSecondaryRolesOption string
(Default: DEFAULT) Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): DEFAULT | NONE | ALL. More information can be found in doc.
DefaultWarehouse string
Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
DisableMfa string
Disabled string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
DisplayName string
Name displayed for the user in the Snowflake web interface.
Email string
Email address for the user.
EnableUnloadPhysicalTypeOptimization bool
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.
EnableUnredactedQuerySyntaxError bool
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.
ErrorOnNondeterministicMerge bool
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.
ErrorOnNondeterministicUpdate bool
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.
FirstName string
First name of the user.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
GeographyOutputFormat string
Display format for GEOGRAPHY values. For more information, check GEOGRAPHYOUTPUTFORMAT docs.
GeometryOutputFormat string
Display format for GEOMETRY values. For more information, check GEOMETRYOUTPUTFORMAT docs.
JdbcTreatDecimalAsInt bool
Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
JdbcTreatTimestampNtzAsUtc bool
Specifies how JDBC processes TIMESTAMPNTZ values. For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
JdbcUseSessionTimezone bool
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.
JsonIndent 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.
LastName string
Last name of the user.
LockTimeout 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.
LogLevel 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 log level. For more information, check LOG_LEVEL docs.
LoginName string
The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
MiddleName string
Middle name of the user.
MinsToBypassMfa int
MinsToUnlock int
MultiStatementCount int
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
MustChangePassword string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
Name string
Name of the user. Note that if you do not supply loginname this will be used as loginname. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
NetworkPolicy 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. Any existing network policy (created using CREATE NETWORK POLICY). For more information, check NETWORK_POLICY docs.
NoorderSequenceAsDefault bool
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.
OdbcTreatDecimalAsInt bool
Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
Parameters List<UserParameter>
Outputs the result of SHOW PARAMETERS IN USER for the given user.
Password string
PreventUnloadToInternalStages bool
Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO \n\n statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
QueryTag 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.
QuotedIdentifiersIgnoreCase bool
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.
RowsPerResultset int
Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
RsaPublicKey string
Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
RsaPublicKey2 string
Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
S3StageVpceDnsName string
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.
SearchPath 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.
ShowOutputs List<UserShowOutput>
Outputs the result of SHOW USER for the given user.
SimulatedDataSharingConsumer string
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, see Introduction to Secure Data Sharing and Working with shares. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
StatementQueuedTimeoutInSeconds int
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.
StatementTimeoutInSeconds int
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.
StrictJsonOutput bool
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.
TimeInputFormat string
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.
TimeOutputFormat string
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.
TimestampDayIsAlways24h bool
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.
TimestampInputFormat string
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.
TimestampLtzOutputFormat string
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.
TimestampNtzOutputFormat string
Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
TimestampOutputFormat string
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.
TimestampTypeMapping string
Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check TIMESTAMP*TYPE_MAPPING docs.
TimestampTzOutputFormat string
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.
TraceLevel string
Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. For more information, check TRACE_LEVEL docs.
TransactionAbortOnError bool
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.
TransactionDefaultIsolationLevel string
Specifies the isolation level for transactions in the user session. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs.
TwoDigitCenturyStart int
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.
UnsupportedDdlAction string
Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
UseCachedResult bool
Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
UserType string
Specifies a type for the user.
WeekOfYearPolicy int
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.
WeekStart 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) to 7 (Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
AbortDetachedQuery bool
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.
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.
BinaryInputFormat string
The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. For more information, check BINARYINPUTFORMAT docs.
BinaryOutputFormat string
The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. For more information, check BINARYOUTPUTFORMAT docs.
ClientMemoryLimit int
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.
ClientMetadataRequestUseConnectionCtx bool
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.
ClientPrefetchThreads int
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.
ClientResultChunkSize int
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.
ClientResultColumnCaseInsensitive bool
Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
ClientSessionKeepAlive bool
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.
ClientSessionKeepAliveHeartbeatFrequency int
Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
ClientTimestampTypeMapping string
Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs.
Comment string
Specifies a comment for the user.
DateInputFormat string
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.
DateOutputFormat string
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.
DaysToExpiry int
DefaultNamespace string
Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
DefaultRole string
Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does not grant the role to the user. The role must be granted explicitly to the user using the GRANT ROLE command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
DefaultSecondaryRolesOption string
(Default: DEFAULT) Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): DEFAULT | NONE | ALL. More information can be found in doc.
DefaultWarehouse string
Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
DisableMfa string
Disabled string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
DisplayName string
Name displayed for the user in the Snowflake web interface.
Email string
Email address for the user.
EnableUnloadPhysicalTypeOptimization bool
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.
EnableUnredactedQuerySyntaxError bool
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.
ErrorOnNondeterministicMerge bool
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.
ErrorOnNondeterministicUpdate bool
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.
FirstName string
First name of the user.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
GeographyOutputFormat string
Display format for GEOGRAPHY values. For more information, check GEOGRAPHYOUTPUTFORMAT docs.
GeometryOutputFormat string
Display format for GEOMETRY values. For more information, check GEOMETRYOUTPUTFORMAT docs.
JdbcTreatDecimalAsInt bool
Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
JdbcTreatTimestampNtzAsUtc bool
Specifies how JDBC processes TIMESTAMPNTZ values. For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
JdbcUseSessionTimezone bool
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.
JsonIndent 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.
LastName string
Last name of the user.
LockTimeout 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.
LogLevel 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 log level. For more information, check LOG_LEVEL docs.
LoginName string
The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
MiddleName string
Middle name of the user.
MinsToBypassMfa int
MinsToUnlock int
MultiStatementCount int
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
MustChangePassword string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
Name string
Name of the user. Note that if you do not supply loginname this will be used as loginname. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
NetworkPolicy 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. Any existing network policy (created using CREATE NETWORK POLICY). For more information, check NETWORK_POLICY docs.
NoorderSequenceAsDefault bool
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.
OdbcTreatDecimalAsInt bool
Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
Parameters []UserParameterArgs
Outputs the result of SHOW PARAMETERS IN USER for the given user.
Password string
PreventUnloadToInternalStages bool
Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO \n\n statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
QueryTag 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.
QuotedIdentifiersIgnoreCase bool
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.
RowsPerResultset int
Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
RsaPublicKey string
Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
RsaPublicKey2 string
Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
S3StageVpceDnsName string
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.
SearchPath 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.
ShowOutputs []UserShowOutputArgs
Outputs the result of SHOW USER for the given user.
SimulatedDataSharingConsumer string
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, see Introduction to Secure Data Sharing and Working with shares. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
StatementQueuedTimeoutInSeconds int
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.
StatementTimeoutInSeconds int
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.
StrictJsonOutput bool
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.
TimeInputFormat string
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.
TimeOutputFormat string
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.
TimestampDayIsAlways24h bool
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.
TimestampInputFormat string
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.
TimestampLtzOutputFormat string
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.
TimestampNtzOutputFormat string
Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
TimestampOutputFormat string
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.
TimestampTypeMapping string
Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check TIMESTAMP*TYPE_MAPPING docs.
TimestampTzOutputFormat string
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.
TraceLevel string
Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. For more information, check TRACE_LEVEL docs.
TransactionAbortOnError bool
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.
TransactionDefaultIsolationLevel string
Specifies the isolation level for transactions in the user session. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs.
TwoDigitCenturyStart int
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.
UnsupportedDdlAction string
Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
UseCachedResult bool
Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
UserType string
Specifies a type for the user.
WeekOfYearPolicy int
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.
WeekStart 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) to 7 (Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
abortDetachedQuery Boolean
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.
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.
binaryInputFormat String
The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. For more information, check BINARYINPUTFORMAT docs.
binaryOutputFormat String
The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. For more information, check BINARYOUTPUTFORMAT docs.
clientMemoryLimit Integer
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.
clientMetadataRequestUseConnectionCtx Boolean
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.
clientPrefetchThreads Integer
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.
clientResultChunkSize Integer
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.
clientResultColumnCaseInsensitive Boolean
Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
clientSessionKeepAlive Boolean
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.
clientSessionKeepAliveHeartbeatFrequency Integer
Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
clientTimestampTypeMapping String
Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs.
comment String
Specifies a comment for the user.
dateInputFormat String
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.
dateOutputFormat String
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.
daysToExpiry Integer
defaultNamespace String
Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
defaultRole String
Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does not grant the role to the user. The role must be granted explicitly to the user using the GRANT ROLE command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
defaultSecondaryRolesOption String
(Default: DEFAULT) Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): DEFAULT | NONE | ALL. More information can be found in doc.
defaultWarehouse String
Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
disableMfa String
disabled String
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
displayName String
Name displayed for the user in the Snowflake web interface.
email String
Email address for the user.
enableUnloadPhysicalTypeOptimization Boolean
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.
enableUnredactedQuerySyntaxError Boolean
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.
errorOnNondeterministicMerge Boolean
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.
errorOnNondeterministicUpdate Boolean
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.
firstName String
First name of the user.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
geographyOutputFormat String
Display format for GEOGRAPHY values. For more information, check GEOGRAPHYOUTPUTFORMAT docs.
geometryOutputFormat String
Display format for GEOMETRY values. For more information, check GEOMETRYOUTPUTFORMAT docs.
jdbcTreatDecimalAsInt Boolean
Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
jdbcTreatTimestampNtzAsUtc Boolean
Specifies how JDBC processes TIMESTAMPNTZ values. For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
jdbcUseSessionTimezone Boolean
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.
jsonIndent 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.
lastName String
Last name of the user.
lockTimeout 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.
logLevel 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 log level. For more information, check LOG_LEVEL docs.
loginName String
The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
middleName String
Middle name of the user.
minsToBypassMfa Integer
minsToUnlock Integer
multiStatementCount Integer
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
mustChangePassword String
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
name String
Name of the user. Note that if you do not supply loginname this will be used as loginname. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
networkPolicy 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. Any existing network policy (created using CREATE NETWORK POLICY). For more information, check NETWORK_POLICY docs.
noorderSequenceAsDefault Boolean
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.
odbcTreatDecimalAsInt Boolean
Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
parameters List<UserParameter>
Outputs the result of SHOW PARAMETERS IN USER for the given user.
password String
preventUnloadToInternalStages Boolean
Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO \n\n statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
queryTag 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.
quotedIdentifiersIgnoreCase Boolean
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.
rowsPerResultset Integer
Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
rsaPublicKey String
Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
rsaPublicKey2 String
Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
s3StageVpceDnsName String
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.
searchPath 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.
showOutputs List<UserShowOutput>
Outputs the result of SHOW USER for the given user.
simulatedDataSharingConsumer String
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, see Introduction to Secure Data Sharing and Working with shares. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
statementQueuedTimeoutInSeconds Integer
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.
statementTimeoutInSeconds Integer
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.
strictJsonOutput Boolean
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.
timeInputFormat String
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.
timeOutputFormat String
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.
timestampDayIsAlways24h Boolean
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.
timestampInputFormat String
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.
timestampLtzOutputFormat String
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.
timestampNtzOutputFormat String
Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
timestampOutputFormat String
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.
timestampTypeMapping String
Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check TIMESTAMP*TYPE_MAPPING docs.
timestampTzOutputFormat String
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.
traceLevel String
Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. For more information, check TRACE_LEVEL docs.
transactionAbortOnError Boolean
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.
transactionDefaultIsolationLevel String
Specifies the isolation level for transactions in the user session. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs.
twoDigitCenturyStart Integer
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.
unsupportedDdlAction String
Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
useCachedResult Boolean
Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
userType String
Specifies a type for the user.
weekOfYearPolicy Integer
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.
weekStart 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) to 7 (Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
abortDetachedQuery boolean
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.
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.
binaryInputFormat string
The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. For more information, check BINARYINPUTFORMAT docs.
binaryOutputFormat string
The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. For more information, check BINARYOUTPUTFORMAT docs.
clientMemoryLimit number
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.
clientMetadataRequestUseConnectionCtx boolean
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.
clientPrefetchThreads number
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.
clientResultChunkSize number
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.
clientResultColumnCaseInsensitive boolean
Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
clientSessionKeepAlive boolean
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.
clientSessionKeepAliveHeartbeatFrequency number
Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
clientTimestampTypeMapping string
Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs.
comment string
Specifies a comment for the user.
dateInputFormat string
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.
dateOutputFormat string
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.
daysToExpiry number
defaultNamespace string
Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
defaultRole string
Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does not grant the role to the user. The role must be granted explicitly to the user using the GRANT ROLE command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
defaultSecondaryRolesOption string
(Default: DEFAULT) Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): DEFAULT | NONE | ALL. More information can be found in doc.
defaultWarehouse string
Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
disableMfa string
disabled string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
displayName string
Name displayed for the user in the Snowflake web interface.
email string
Email address for the user.
enableUnloadPhysicalTypeOptimization boolean
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.
enableUnredactedQuerySyntaxError boolean
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.
errorOnNondeterministicMerge boolean
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.
errorOnNondeterministicUpdate boolean
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.
firstName string
First name of the user.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
geographyOutputFormat string
Display format for GEOGRAPHY values. For more information, check GEOGRAPHYOUTPUTFORMAT docs.
geometryOutputFormat string
Display format for GEOMETRY values. For more information, check GEOMETRYOUTPUTFORMAT docs.
jdbcTreatDecimalAsInt boolean
Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
jdbcTreatTimestampNtzAsUtc boolean
Specifies how JDBC processes TIMESTAMPNTZ values. For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
jdbcUseSessionTimezone boolean
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.
jsonIndent 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.
lastName string
Last name of the user.
lockTimeout 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.
logLevel 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 log level. For more information, check LOG_LEVEL docs.
loginName string
The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
middleName string
Middle name of the user.
minsToBypassMfa number
minsToUnlock number
multiStatementCount number
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
mustChangePassword string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
name string
Name of the user. Note that if you do not supply loginname this will be used as loginname. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
networkPolicy 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. Any existing network policy (created using CREATE NETWORK POLICY). For more information, check NETWORK_POLICY docs.
noorderSequenceAsDefault boolean
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.
odbcTreatDecimalAsInt boolean
Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
parameters UserParameter[]
Outputs the result of SHOW PARAMETERS IN USER for the given user.
password string
preventUnloadToInternalStages boolean
Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO \n\n statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
queryTag 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.
quotedIdentifiersIgnoreCase boolean
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.
rowsPerResultset number
Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
rsaPublicKey string
Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
rsaPublicKey2 string
Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
s3StageVpceDnsName string
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.
searchPath 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.
showOutputs UserShowOutput[]
Outputs the result of SHOW USER for the given user.
simulatedDataSharingConsumer string
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, see Introduction to Secure Data Sharing and Working with shares. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
statementQueuedTimeoutInSeconds number
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.
statementTimeoutInSeconds number
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.
strictJsonOutput boolean
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.
timeInputFormat string
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.
timeOutputFormat string
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.
timestampDayIsAlways24h boolean
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.
timestampInputFormat string
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.
timestampLtzOutputFormat string
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.
timestampNtzOutputFormat string
Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
timestampOutputFormat string
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.
timestampTypeMapping string
Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check TIMESTAMP*TYPE_MAPPING docs.
timestampTzOutputFormat string
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.
traceLevel string
Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. For more information, check TRACE_LEVEL docs.
transactionAbortOnError boolean
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.
transactionDefaultIsolationLevel string
Specifies the isolation level for transactions in the user session. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs.
twoDigitCenturyStart number
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.
unsupportedDdlAction string
Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
useCachedResult boolean
Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
userType string
Specifies a type for the user.
weekOfYearPolicy number
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.
weekStart 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) to 7 (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_query bool
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.
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.
binary_input_format str
The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. For more information, check BINARYINPUTFORMAT docs.
binary_output_format str
The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. For more information, check BINARYOUTPUTFORMAT docs.
client_memory_limit int
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_request_use_connection_ctx bool
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_prefetch_threads int
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_chunk_size int
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_column_case_insensitive bool
Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
client_session_keep_alive bool
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_keep_alive_heartbeat_frequency int
Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
client_timestamp_type_mapping str
Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs.
comment str
Specifies a comment for the user.
date_input_format str
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_format str
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.
days_to_expiry int
default_namespace str
Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
default_role str
Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does not grant the role to the user. The role must be granted explicitly to the user using the GRANT ROLE command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
default_secondary_roles_option str
(Default: DEFAULT) Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): DEFAULT | NONE | ALL. More information can be found in doc.
default_warehouse str
Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
disable_mfa str
disabled str
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
display_name str
Name displayed for the user in the Snowflake web interface.
email str
Email address for the user.
enable_unload_physical_type_optimization bool
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_query_syntax_error bool
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.
error_on_nondeterministic_merge bool
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_nondeterministic_update bool
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.
first_name str
First name of the user.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
geography_output_format str
Display format for GEOGRAPHY values. For more information, check GEOGRAPHYOUTPUTFORMAT docs.
geometry_output_format str
Display format for GEOMETRY values. For more information, check GEOMETRYOUTPUTFORMAT docs.
jdbc_treat_decimal_as_int bool
Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
jdbc_treat_timestamp_ntz_as_utc bool
Specifies how JDBC processes TIMESTAMPNTZ values. For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
jdbc_use_session_timezone bool
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.
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.
last_name str
Last name of the user.
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 log level. For more information, check LOG_LEVEL docs.
login_name str
The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
middle_name str
Middle name of the user.
mins_to_bypass_mfa int
mins_to_unlock int
multi_statement_count int
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
must_change_password str
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
name str
Name of the user. Note that if you do not supply loginname this will be used as loginname. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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. Any existing network policy (created using CREATE NETWORK POLICY). For more information, check NETWORK_POLICY docs.
noorder_sequence_as_default bool
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.
odbc_treat_decimal_as_int bool
Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
parameters Sequence[UserParameterArgs]
Outputs the result of SHOW PARAMETERS IN USER for the given user.
password str
prevent_unload_to_internal_stages bool
Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO \n\n statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES 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_ignore_case bool
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.
rows_per_resultset int
Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
rsa_public_key str
Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
rsa_public_key2 str
Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
s3_stage_vpce_dns_name str
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.
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.
show_outputs Sequence[UserShowOutputArgs]
Outputs the result of SHOW USER for the given user.
simulated_data_sharing_consumer str
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, see Introduction to Secure Data Sharing and Working with shares. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
statement_queued_timeout_in_seconds int
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_in_seconds int
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.
strict_json_output bool
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.
time_input_format str
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_format str
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_is_always24h bool
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_format str
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_output_format str
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_output_format str
Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
timestamp_output_format str
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_mapping str
Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check TIMESTAMP*TYPE_MAPPING docs.
timestamp_tz_output_format str
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. For more information, check TRACE_LEVEL docs.
transaction_abort_on_error bool
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_isolation_level str
Specifies the isolation level for transactions in the user session. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs.
two_digit_century_start int
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_action str
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_result bool
Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
user_type str
Specifies a type for the user.
week_of_year_policy int
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) to 7 (Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.
abortDetachedQuery Boolean
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.
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.
binaryInputFormat String
The format of VARCHAR values passed as input to VARCHAR-to-BINARY conversion functions. For more information, see Binary input and output. For more information, check BINARYINPUTFORMAT docs.
binaryOutputFormat String
The format for VARCHAR values returned as output by BINARY-to-VARCHAR conversion functions. For more information, see Binary input and output. For more information, check BINARYOUTPUTFORMAT docs.
clientMemoryLimit Number
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.
clientMetadataRequestUseConnectionCtx Boolean
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.
clientPrefetchThreads Number
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.
clientResultChunkSize Number
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.
clientResultColumnCaseInsensitive Boolean
Parameter that indicates whether to match column name case-insensitively in ResultSet.get* methods in JDBC. For more information, check CLIENTRESULTCOLUMNCASEINSENSITIVE docs.
clientSessionKeepAlive Boolean
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.
clientSessionKeepAliveHeartbeatFrequency Number
Number of seconds in-between client attempts to update the token for the session. For more information, check CLIENTSESSIONKEEPALIVEHEARTBEAT_FREQUENCY docs.
clientTimestampTypeMapping String
Specifies the TIMESTAMP_* variation to use when binding timestamp variables for JDBC or ODBC applications that use the bind API to load data. For more information, check CLIENTTIMESTAMPTYPE_MAPPING docs.
comment String
Specifies a comment for the user.
dateInputFormat String
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.
dateOutputFormat String
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.
daysToExpiry Number
defaultNamespace String
Specifies the namespace (database only or database and schema) that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the namespace exists.
defaultRole String
Specifies the role that is active by default for the user’s session upon login. Note that specifying a default role for a user does not grant the role to the user. The role must be granted explicitly to the user using the GRANT ROLE command. In addition, the CREATE USER operation does not verify that the role exists. For more information about this resource, see docs.
defaultSecondaryRolesOption String
(Default: DEFAULT) Specifies the secondary roles that are active for the user’s session upon login. Valid values are (case-insensitive): DEFAULT | NONE | ALL. More information can be found in doc.
defaultWarehouse String
Specifies the virtual warehouse that is active by default for the user’s session upon login. Note that the CREATE USER operation does not verify that the warehouse exists. For more information about this resource, see docs.
disableMfa String
disabled String
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is disabled, which prevents logging in and aborts all the currently-running queries for the user. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
displayName String
Name displayed for the user in the Snowflake web interface.
email String
Email address for the user.
enableUnloadPhysicalTypeOptimization Boolean
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.
enableUnredactedQuerySyntaxError Boolean
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.
errorOnNondeterministicMerge Boolean
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.
errorOnNondeterministicUpdate Boolean
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.
firstName String
First name of the user.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
geographyOutputFormat String
Display format for GEOGRAPHY values. For more information, check GEOGRAPHYOUTPUTFORMAT docs.
geometryOutputFormat String
Display format for GEOMETRY values. For more information, check GEOMETRYOUTPUTFORMAT docs.
jdbcTreatDecimalAsInt Boolean
Specifies how JDBC processes columns that have a scale of zero (0). For more information, check JDBCTREATDECIMALASINT docs.
jdbcTreatTimestampNtzAsUtc Boolean
Specifies how JDBC processes TIMESTAMPNTZ values. For more information, check TREATTIMESTAMPNTZASUTC docsJDBC.
jdbcUseSessionTimezone Boolean
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.
jsonIndent 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.
lastName String
Last name of the user.
lockTimeout 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.
logLevel 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 log level. For more information, check LOG_LEVEL docs.
loginName String
The name users use to log in. If not supplied, snowflake will use name instead. Login names are always case-insensitive.
middleName String
Middle name of the user.
minsToBypassMfa Number
minsToUnlock Number
multiStatementCount Number
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
mustChangePassword String
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the user is forced to change their password on next login (including their first/initial login) into the system. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
name String
Name of the user. Note that if you do not supply loginname this will be used as loginname. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
networkPolicy 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. Any existing network policy (created using CREATE NETWORK POLICY). For more information, check NETWORK_POLICY docs.
noorderSequenceAsDefault Boolean
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.
odbcTreatDecimalAsInt Boolean
Specifies how ODBC processes columns that have a scale of zero (0). For more information, check ODBCTREATDECIMALASINT docs.
parameters List<Property Map>
Outputs the result of SHOW PARAMETERS IN USER for the given user.
password String
preventUnloadToInternalStages Boolean
Specifies whether to prevent data unload operations to internal (Snowflake) stages using COPY INTO \n\n statements. For more information, check PREVENTUNLOADTOINTERNALSTAGES docs.
queryTag 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.
quotedIdentifiersIgnoreCase Boolean
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.
rowsPerResultset Number
Specifies the maximum number of rows returned in a result set. A value of 0 specifies no maximum. For more information, check ROWSPERRESULTSET docs.
rsaPublicKey String
Specifies the user’s RSA public key; used for key-pair authentication. Must be on 1 line without header and trailer.
rsaPublicKey2 String
Specifies the user’s second RSA public key; used to rotate the public and private keys for key-pair authentication based on an expiration schedule set by your organization. Must be on 1 line without header and trailer.
s3StageVpceDnsName String
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.
searchPath 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.
showOutputs List<Property Map>
Outputs the result of SHOW USER for the given user.
simulatedDataSharingConsumer String
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, see Introduction to Secure Data Sharing and Working with shares. For more information, check SIMULATEDDATASHARING_CONSUMER docs.
statementQueuedTimeoutInSeconds Number
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.
statementTimeoutInSeconds Number
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.
strictJsonOutput Boolean
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.
timeInputFormat String
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.
timeOutputFormat String
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.
timestampDayIsAlways24h Boolean
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.
timestampInputFormat String
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.
timestampLtzOutputFormat String
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.
timestampNtzOutputFormat String
Specifies the display format for the TIMESTAMPNTZ data type. For more information, check NTZOUTPUTFORMAT docsTIMESTAMP.
timestampOutputFormat String
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.
timestampTypeMapping String
Specifies the TIMESTAMP** variation that the TIMESTAMP data type alias maps to. For more information, check TIMESTAMP*TYPE_MAPPING docs.
timestampTzOutputFormat String
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.
traceLevel String
Controls how trace events are ingested into the event table. For more information about trace levels, see Setting trace level. For more information, check TRACE_LEVEL docs.
transactionAbortOnError Boolean
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.
transactionDefaultIsolationLevel String
Specifies the isolation level for transactions in the user session. For more information, check TRANSACTIONDEFAULTISOLATION_LEVEL docs.
twoDigitCenturyStart Number
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.
unsupportedDdlAction String
Determines if an unsupported (i.e. non-default) value specified for a constraint property returns an error. For more information, check UNSUPPORTEDDDLACTION docs.
useCachedResult Boolean
Specifies whether to reuse persisted query results, if available, when a matching query is submitted. For more information, check USECACHEDRESULT docs.
userType String
Specifies a type for the user.
weekOfYearPolicy Number
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.
weekStart 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) to 7 (Sunday): All the week-related functions use weeks that start on the specified day of the week. For more information, check WEEK_START docs.

Supporting Types

UserParameter
, UserParameterArgs

AbortDetachedQueries List<UserParameterAbortDetachedQuery>
Autocommits List<UserParameterAutocommit>
BinaryInputFormats List<UserParameterBinaryInputFormat>
BinaryOutputFormats List<UserParameterBinaryOutputFormat>
ClientMemoryLimits List<UserParameterClientMemoryLimit>
ClientMetadataRequestUseConnectionCtxes List<UserParameterClientMetadataRequestUseConnectionCtx>
ClientPrefetchThreads List<UserParameterClientPrefetchThread>
ClientResultChunkSizes List<UserParameterClientResultChunkSize>
ClientResultColumnCaseInsensitives List<UserParameterClientResultColumnCaseInsensitive>
ClientSessionKeepAliveHeartbeatFrequencies List<UserParameterClientSessionKeepAliveHeartbeatFrequency>
ClientSessionKeepAlives List<UserParameterClientSessionKeepAlife>
ClientTimestampTypeMappings List<UserParameterClientTimestampTypeMapping>
DateInputFormats List<UserParameterDateInputFormat>
DateOutputFormats List<UserParameterDateOutputFormat>
EnableUnloadPhysicalTypeOptimizations List<UserParameterEnableUnloadPhysicalTypeOptimization>
EnableUnredactedQuerySyntaxErrors List<UserParameterEnableUnredactedQuerySyntaxError>
ErrorOnNondeterministicMerges List<UserParameterErrorOnNondeterministicMerge>
ErrorOnNondeterministicUpdates List<UserParameterErrorOnNondeterministicUpdate>
GeographyOutputFormats List<UserParameterGeographyOutputFormat>
GeometryOutputFormats List<UserParameterGeometryOutputFormat>
JdbcTreatDecimalAsInts List<UserParameterJdbcTreatDecimalAsInt>
JdbcTreatTimestampNtzAsUtcs List<UserParameterJdbcTreatTimestampNtzAsUtc>
JdbcUseSessionTimezones List<UserParameterJdbcUseSessionTimezone>
JsonIndents List<UserParameterJsonIndent>
LockTimeouts List<UserParameterLockTimeout>
LogLevels List<UserParameterLogLevel>
MultiStatementCounts List<UserParameterMultiStatementCount>
NetworkPolicies List<UserParameterNetworkPolicy>
NoorderSequenceAsDefaults List<UserParameterNoorderSequenceAsDefault>
OdbcTreatDecimalAsInts List<UserParameterOdbcTreatDecimalAsInt>
PreventUnloadToInternalStages List<UserParameterPreventUnloadToInternalStage>
QueryTags List<UserParameterQueryTag>
QuotedIdentifiersIgnoreCases List<UserParameterQuotedIdentifiersIgnoreCase>
RowsPerResultsets List<UserParameterRowsPerResultset>
S3StageVpceDnsNames List<UserParameterS3StageVpceDnsName>
SearchPaths List<UserParameterSearchPath>
SimulatedDataSharingConsumers List<UserParameterSimulatedDataSharingConsumer>
StatementQueuedTimeoutInSeconds List<UserParameterStatementQueuedTimeoutInSecond>
StatementTimeoutInSeconds List<UserParameterStatementTimeoutInSecond>
StrictJsonOutputs List<UserParameterStrictJsonOutput>
TimeInputFormats List<UserParameterTimeInputFormat>
TimeOutputFormats List<UserParameterTimeOutputFormat>
TimestampDayIsAlways24hs List<UserParameterTimestampDayIsAlways24h>
TimestampInputFormats List<UserParameterTimestampInputFormat>
TimestampLtzOutputFormats List<UserParameterTimestampLtzOutputFormat>
TimestampNtzOutputFormats List<UserParameterTimestampNtzOutputFormat>
TimestampOutputFormats List<UserParameterTimestampOutputFormat>
TimestampTypeMappings List<UserParameterTimestampTypeMapping>
TimestampTzOutputFormats List<UserParameterTimestampTzOutputFormat>
Timezones List<UserParameterTimezone>
TraceLevels List<UserParameterTraceLevel>
TransactionAbortOnErrors List<UserParameterTransactionAbortOnError>
TransactionDefaultIsolationLevels List<UserParameterTransactionDefaultIsolationLevel>
TwoDigitCenturyStarts List<UserParameterTwoDigitCenturyStart>
UnsupportedDdlActions List<UserParameterUnsupportedDdlAction>
UseCachedResults List<UserParameterUseCachedResult>
WeekOfYearPolicies List<UserParameterWeekOfYearPolicy>
WeekStarts List<UserParameterWeekStart>
AbortDetachedQueries []UserParameterAbortDetachedQuery
Autocommits []UserParameterAutocommit
BinaryInputFormats []UserParameterBinaryInputFormat
BinaryOutputFormats []UserParameterBinaryOutputFormat
ClientMemoryLimits []UserParameterClientMemoryLimit
ClientMetadataRequestUseConnectionCtxes []UserParameterClientMetadataRequestUseConnectionCtx
ClientPrefetchThreads []UserParameterClientPrefetchThread
ClientResultChunkSizes []UserParameterClientResultChunkSize
ClientResultColumnCaseInsensitives []UserParameterClientResultColumnCaseInsensitive
ClientSessionKeepAliveHeartbeatFrequencies []UserParameterClientSessionKeepAliveHeartbeatFrequency
ClientSessionKeepAlives []UserParameterClientSessionKeepAlife
ClientTimestampTypeMappings []UserParameterClientTimestampTypeMapping
DateInputFormats []UserParameterDateInputFormat
DateOutputFormats []UserParameterDateOutputFormat
EnableUnloadPhysicalTypeOptimizations []UserParameterEnableUnloadPhysicalTypeOptimization
EnableUnredactedQuerySyntaxErrors []UserParameterEnableUnredactedQuerySyntaxError
ErrorOnNondeterministicMerges []UserParameterErrorOnNondeterministicMerge
ErrorOnNondeterministicUpdates []UserParameterErrorOnNondeterministicUpdate
GeographyOutputFormats []UserParameterGeographyOutputFormat
GeometryOutputFormats []UserParameterGeometryOutputFormat
JdbcTreatDecimalAsInts []UserParameterJdbcTreatDecimalAsInt
JdbcTreatTimestampNtzAsUtcs []UserParameterJdbcTreatTimestampNtzAsUtc
JdbcUseSessionTimezones []UserParameterJdbcUseSessionTimezone
JsonIndents []UserParameterJsonIndent
LockTimeouts []UserParameterLockTimeout
LogLevels []UserParameterLogLevel
MultiStatementCounts []UserParameterMultiStatementCount
NetworkPolicies []UserParameterNetworkPolicy
NoorderSequenceAsDefaults []UserParameterNoorderSequenceAsDefault
OdbcTreatDecimalAsInts []UserParameterOdbcTreatDecimalAsInt
PreventUnloadToInternalStages []UserParameterPreventUnloadToInternalStage
QueryTags []UserParameterQueryTag
QuotedIdentifiersIgnoreCases []UserParameterQuotedIdentifiersIgnoreCase
RowsPerResultsets []UserParameterRowsPerResultset
S3StageVpceDnsNames []UserParameterS3StageVpceDnsName
SearchPaths []UserParameterSearchPath
SimulatedDataSharingConsumers []UserParameterSimulatedDataSharingConsumer
StatementQueuedTimeoutInSeconds []UserParameterStatementQueuedTimeoutInSecond
StatementTimeoutInSeconds []UserParameterStatementTimeoutInSecond
StrictJsonOutputs []UserParameterStrictJsonOutput
TimeInputFormats []UserParameterTimeInputFormat
TimeOutputFormats []UserParameterTimeOutputFormat
TimestampDayIsAlways24hs []UserParameterTimestampDayIsAlways24h
TimestampInputFormats []UserParameterTimestampInputFormat
TimestampLtzOutputFormats []UserParameterTimestampLtzOutputFormat
TimestampNtzOutputFormats []UserParameterTimestampNtzOutputFormat
TimestampOutputFormats []UserParameterTimestampOutputFormat
TimestampTypeMappings []UserParameterTimestampTypeMapping
TimestampTzOutputFormats []UserParameterTimestampTzOutputFormat
Timezones []UserParameterTimezone
TraceLevels []UserParameterTraceLevel
TransactionAbortOnErrors []UserParameterTransactionAbortOnError
TransactionDefaultIsolationLevels []UserParameterTransactionDefaultIsolationLevel
TwoDigitCenturyStarts []UserParameterTwoDigitCenturyStart
UnsupportedDdlActions []UserParameterUnsupportedDdlAction
UseCachedResults []UserParameterUseCachedResult
WeekOfYearPolicies []UserParameterWeekOfYearPolicy
WeekStarts []UserParameterWeekStart
abortDetachedQueries List<UserParameterAbortDetachedQuery>
autocommits List<UserParameterAutocommit>
binaryInputFormats List<UserParameterBinaryInputFormat>
binaryOutputFormats List<UserParameterBinaryOutputFormat>
clientMemoryLimits List<UserParameterClientMemoryLimit>
clientMetadataRequestUseConnectionCtxes List<UserParameterClientMetadataRequestUseConnectionCtx>
clientPrefetchThreads List<UserParameterClientPrefetchThread>
clientResultChunkSizes List<UserParameterClientResultChunkSize>
clientResultColumnCaseInsensitives List<UserParameterClientResultColumnCaseInsensitive>
clientSessionKeepAliveHeartbeatFrequencies List<UserParameterClientSessionKeepAliveHeartbeatFrequency>
clientSessionKeepAlives List<UserParameterClientSessionKeepAlife>
clientTimestampTypeMappings List<UserParameterClientTimestampTypeMapping>
dateInputFormats List<UserParameterDateInputFormat>
dateOutputFormats List<UserParameterDateOutputFormat>
enableUnloadPhysicalTypeOptimizations List<UserParameterEnableUnloadPhysicalTypeOptimization>
enableUnredactedQuerySyntaxErrors List<UserParameterEnableUnredactedQuerySyntaxError>
errorOnNondeterministicMerges List<UserParameterErrorOnNondeterministicMerge>
errorOnNondeterministicUpdates List<UserParameterErrorOnNondeterministicUpdate>
geographyOutputFormats List<UserParameterGeographyOutputFormat>
geometryOutputFormats List<UserParameterGeometryOutputFormat>
jdbcTreatDecimalAsInts List<UserParameterJdbcTreatDecimalAsInt>
jdbcTreatTimestampNtzAsUtcs List<UserParameterJdbcTreatTimestampNtzAsUtc>
jdbcUseSessionTimezones List<UserParameterJdbcUseSessionTimezone>
jsonIndents List<UserParameterJsonIndent>
lockTimeouts List<UserParameterLockTimeout>
logLevels List<UserParameterLogLevel>
multiStatementCounts List<UserParameterMultiStatementCount>
networkPolicies List<UserParameterNetworkPolicy>
noorderSequenceAsDefaults List<UserParameterNoorderSequenceAsDefault>
odbcTreatDecimalAsInts List<UserParameterOdbcTreatDecimalAsInt>
preventUnloadToInternalStages List<UserParameterPreventUnloadToInternalStage>
queryTags List<UserParameterQueryTag>
quotedIdentifiersIgnoreCases List<UserParameterQuotedIdentifiersIgnoreCase>
rowsPerResultsets List<UserParameterRowsPerResultset>
s3StageVpceDnsNames List<UserParameterS3StageVpceDnsName>
searchPaths List<UserParameterSearchPath>
simulatedDataSharingConsumers List<UserParameterSimulatedDataSharingConsumer>
statementQueuedTimeoutInSeconds List<UserParameterStatementQueuedTimeoutInSecond>
statementTimeoutInSeconds List<UserParameterStatementTimeoutInSecond>
strictJsonOutputs List<UserParameterStrictJsonOutput>
timeInputFormats List<UserParameterTimeInputFormat>
timeOutputFormats List<UserParameterTimeOutputFormat>
timestampDayIsAlways24hs List<UserParameterTimestampDayIsAlways24h>
timestampInputFormats List<UserParameterTimestampInputFormat>
timestampLtzOutputFormats List<UserParameterTimestampLtzOutputFormat>
timestampNtzOutputFormats List<UserParameterTimestampNtzOutputFormat>
timestampOutputFormats List<UserParameterTimestampOutputFormat>
timestampTypeMappings List<UserParameterTimestampTypeMapping>
timestampTzOutputFormats List<UserParameterTimestampTzOutputFormat>
timezones List<UserParameterTimezone>
traceLevels List<UserParameterTraceLevel>
transactionAbortOnErrors List<UserParameterTransactionAbortOnError>
transactionDefaultIsolationLevels List<UserParameterTransactionDefaultIsolationLevel>
twoDigitCenturyStarts List<UserParameterTwoDigitCenturyStart>
unsupportedDdlActions List<UserParameterUnsupportedDdlAction>
useCachedResults List<UserParameterUseCachedResult>
weekOfYearPolicies List<UserParameterWeekOfYearPolicy>
weekStarts List<UserParameterWeekStart>
abortDetachedQueries UserParameterAbortDetachedQuery[]
autocommits UserParameterAutocommit[]
binaryInputFormats UserParameterBinaryInputFormat[]
binaryOutputFormats UserParameterBinaryOutputFormat[]
clientMemoryLimits UserParameterClientMemoryLimit[]
clientMetadataRequestUseConnectionCtxes UserParameterClientMetadataRequestUseConnectionCtx[]
clientPrefetchThreads UserParameterClientPrefetchThread[]
clientResultChunkSizes UserParameterClientResultChunkSize[]
clientResultColumnCaseInsensitives UserParameterClientResultColumnCaseInsensitive[]
clientSessionKeepAliveHeartbeatFrequencies UserParameterClientSessionKeepAliveHeartbeatFrequency[]
clientSessionKeepAlives UserParameterClientSessionKeepAlife[]
clientTimestampTypeMappings UserParameterClientTimestampTypeMapping[]
dateInputFormats UserParameterDateInputFormat[]
dateOutputFormats UserParameterDateOutputFormat[]
enableUnloadPhysicalTypeOptimizations UserParameterEnableUnloadPhysicalTypeOptimization[]
enableUnredactedQuerySyntaxErrors UserParameterEnableUnredactedQuerySyntaxError[]
errorOnNondeterministicMerges UserParameterErrorOnNondeterministicMerge[]
errorOnNondeterministicUpdates UserParameterErrorOnNondeterministicUpdate[]
geographyOutputFormats UserParameterGeographyOutputFormat[]
geometryOutputFormats UserParameterGeometryOutputFormat[]
jdbcTreatDecimalAsInts UserParameterJdbcTreatDecimalAsInt[]
jdbcTreatTimestampNtzAsUtcs UserParameterJdbcTreatTimestampNtzAsUtc[]
jdbcUseSessionTimezones UserParameterJdbcUseSessionTimezone[]
jsonIndents UserParameterJsonIndent[]
lockTimeouts UserParameterLockTimeout[]
logLevels UserParameterLogLevel[]
multiStatementCounts UserParameterMultiStatementCount[]
networkPolicies UserParameterNetworkPolicy[]
noorderSequenceAsDefaults UserParameterNoorderSequenceAsDefault[]
odbcTreatDecimalAsInts UserParameterOdbcTreatDecimalAsInt[]
preventUnloadToInternalStages UserParameterPreventUnloadToInternalStage[]
queryTags UserParameterQueryTag[]
quotedIdentifiersIgnoreCases UserParameterQuotedIdentifiersIgnoreCase[]
rowsPerResultsets UserParameterRowsPerResultset[]
s3StageVpceDnsNames UserParameterS3StageVpceDnsName[]
searchPaths UserParameterSearchPath[]
simulatedDataSharingConsumers UserParameterSimulatedDataSharingConsumer[]
statementQueuedTimeoutInSeconds UserParameterStatementQueuedTimeoutInSecond[]
statementTimeoutInSeconds UserParameterStatementTimeoutInSecond[]
strictJsonOutputs UserParameterStrictJsonOutput[]
timeInputFormats UserParameterTimeInputFormat[]
timeOutputFormats UserParameterTimeOutputFormat[]
timestampDayIsAlways24hs UserParameterTimestampDayIsAlways24h[]
timestampInputFormats UserParameterTimestampInputFormat[]
timestampLtzOutputFormats UserParameterTimestampLtzOutputFormat[]
timestampNtzOutputFormats UserParameterTimestampNtzOutputFormat[]
timestampOutputFormats UserParameterTimestampOutputFormat[]
timestampTypeMappings UserParameterTimestampTypeMapping[]
timestampTzOutputFormats UserParameterTimestampTzOutputFormat[]
timezones UserParameterTimezone[]
traceLevels UserParameterTraceLevel[]
transactionAbortOnErrors UserParameterTransactionAbortOnError[]
transactionDefaultIsolationLevels UserParameterTransactionDefaultIsolationLevel[]
twoDigitCenturyStarts UserParameterTwoDigitCenturyStart[]
unsupportedDdlActions UserParameterUnsupportedDdlAction[]
useCachedResults UserParameterUseCachedResult[]
weekOfYearPolicies UserParameterWeekOfYearPolicy[]
weekStarts UserParameterWeekStart[]
abort_detached_queries Sequence[UserParameterAbortDetachedQuery]
autocommits Sequence[UserParameterAutocommit]
binary_input_formats Sequence[UserParameterBinaryInputFormat]
binary_output_formats Sequence[UserParameterBinaryOutputFormat]
client_memory_limits Sequence[UserParameterClientMemoryLimit]
client_metadata_request_use_connection_ctxes Sequence[UserParameterClientMetadataRequestUseConnectionCtx]
client_prefetch_threads Sequence[UserParameterClientPrefetchThread]
client_result_chunk_sizes Sequence[UserParameterClientResultChunkSize]
client_result_column_case_insensitives Sequence[UserParameterClientResultColumnCaseInsensitive]
client_session_keep_alive_heartbeat_frequencies Sequence[UserParameterClientSessionKeepAliveHeartbeatFrequency]
client_session_keep_alives Sequence[UserParameterClientSessionKeepAlife]
client_timestamp_type_mappings Sequence[UserParameterClientTimestampTypeMapping]
date_input_formats Sequence[UserParameterDateInputFormat]
date_output_formats Sequence[UserParameterDateOutputFormat]
enable_unload_physical_type_optimizations Sequence[UserParameterEnableUnloadPhysicalTypeOptimization]
enable_unredacted_query_syntax_errors Sequence[UserParameterEnableUnredactedQuerySyntaxError]
error_on_nondeterministic_merges Sequence[UserParameterErrorOnNondeterministicMerge]
error_on_nondeterministic_updates Sequence[UserParameterErrorOnNondeterministicUpdate]
geography_output_formats Sequence[UserParameterGeographyOutputFormat]
geometry_output_formats Sequence[UserParameterGeometryOutputFormat]
jdbc_treat_decimal_as_ints Sequence[UserParameterJdbcTreatDecimalAsInt]
jdbc_treat_timestamp_ntz_as_utcs Sequence[UserParameterJdbcTreatTimestampNtzAsUtc]
jdbc_use_session_timezones Sequence[UserParameterJdbcUseSessionTimezone]
json_indents Sequence[UserParameterJsonIndent]
lock_timeouts Sequence[UserParameterLockTimeout]
log_levels Sequence[UserParameterLogLevel]
multi_statement_counts Sequence[UserParameterMultiStatementCount]
network_policies Sequence[UserParameterNetworkPolicy]
noorder_sequence_as_defaults Sequence[UserParameterNoorderSequenceAsDefault]
odbc_treat_decimal_as_ints Sequence[UserParameterOdbcTreatDecimalAsInt]
prevent_unload_to_internal_stages Sequence[UserParameterPreventUnloadToInternalStage]
query_tags Sequence[UserParameterQueryTag]
quoted_identifiers_ignore_cases Sequence[UserParameterQuotedIdentifiersIgnoreCase]
rows_per_resultsets Sequence[UserParameterRowsPerResultset]
s3_stage_vpce_dns_names Sequence[UserParameterS3StageVpceDnsName]
search_paths Sequence[UserParameterSearchPath]
simulated_data_sharing_consumers Sequence[UserParameterSimulatedDataSharingConsumer]
statement_queued_timeout_in_seconds Sequence[UserParameterStatementQueuedTimeoutInSecond]
statement_timeout_in_seconds Sequence[UserParameterStatementTimeoutInSecond]
strict_json_outputs Sequence[UserParameterStrictJsonOutput]
time_input_formats Sequence[UserParameterTimeInputFormat]
time_output_formats Sequence[UserParameterTimeOutputFormat]
timestamp_day_is_always24hs Sequence[UserParameterTimestampDayIsAlways24h]
timestamp_input_formats Sequence[UserParameterTimestampInputFormat]
timestamp_ltz_output_formats Sequence[UserParameterTimestampLtzOutputFormat]
timestamp_ntz_output_formats Sequence[UserParameterTimestampNtzOutputFormat]
timestamp_output_formats Sequence[UserParameterTimestampOutputFormat]
timestamp_type_mappings Sequence[UserParameterTimestampTypeMapping]
timestamp_tz_output_formats Sequence[UserParameterTimestampTzOutputFormat]
timezones Sequence[UserParameterTimezone]
trace_levels Sequence[UserParameterTraceLevel]
transaction_abort_on_errors Sequence[UserParameterTransactionAbortOnError]
transaction_default_isolation_levels Sequence[UserParameterTransactionDefaultIsolationLevel]
two_digit_century_starts Sequence[UserParameterTwoDigitCenturyStart]
unsupported_ddl_actions Sequence[UserParameterUnsupportedDdlAction]
use_cached_results Sequence[UserParameterUseCachedResult]
week_of_year_policies Sequence[UserParameterWeekOfYearPolicy]
week_starts Sequence[UserParameterWeekStart]
abortDetachedQueries List<Property Map>
autocommits List<Property Map>
binaryInputFormats List<Property Map>
binaryOutputFormats List<Property Map>
clientMemoryLimits List<Property Map>
clientMetadataRequestUseConnectionCtxes List<Property Map>
clientPrefetchThreads List<Property Map>
clientResultChunkSizes List<Property Map>
clientResultColumnCaseInsensitives List<Property Map>
clientSessionKeepAliveHeartbeatFrequencies List<Property Map>
clientSessionKeepAlives List<Property Map>
clientTimestampTypeMappings List<Property Map>
dateInputFormats List<Property Map>
dateOutputFormats List<Property Map>
enableUnloadPhysicalTypeOptimizations List<Property Map>
enableUnredactedQuerySyntaxErrors List<Property Map>
errorOnNondeterministicMerges List<Property Map>
errorOnNondeterministicUpdates List<Property Map>
geographyOutputFormats List<Property Map>
geometryOutputFormats List<Property Map>
jdbcTreatDecimalAsInts List<Property Map>
jdbcTreatTimestampNtzAsUtcs List<Property Map>
jdbcUseSessionTimezones List<Property Map>
jsonIndents List<Property Map>
lockTimeouts List<Property Map>
logLevels List<Property Map>
multiStatementCounts List<Property Map>
networkPolicies List<Property Map>
noorderSequenceAsDefaults List<Property Map>
odbcTreatDecimalAsInts List<Property Map>
preventUnloadToInternalStages List<Property Map>
queryTags List<Property Map>
quotedIdentifiersIgnoreCases List<Property Map>
rowsPerResultsets List<Property Map>
s3StageVpceDnsNames List<Property Map>
searchPaths List<Property Map>
simulatedDataSharingConsumers List<Property Map>
statementQueuedTimeoutInSeconds List<Property Map>
statementTimeoutInSeconds List<Property Map>
strictJsonOutputs List<Property Map>
timeInputFormats List<Property Map>
timeOutputFormats List<Property Map>
timestampDayIsAlways24hs List<Property Map>
timestampInputFormats List<Property Map>
timestampLtzOutputFormats List<Property Map>
timestampNtzOutputFormats List<Property Map>
timestampOutputFormats List<Property Map>
timestampTypeMappings List<Property Map>
timestampTzOutputFormats List<Property Map>
timezones List<Property Map>
traceLevels List<Property Map>
transactionAbortOnErrors List<Property Map>
transactionDefaultIsolationLevels List<Property Map>
twoDigitCenturyStarts List<Property Map>
unsupportedDdlActions List<Property Map>
useCachedResults List<Property Map>
weekOfYearPolicies List<Property Map>
weekStarts List<Property Map>

UserParameterAbortDetachedQuery
, UserParameterAbortDetachedQueryArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterAutocommit
, UserParameterAutocommitArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterBinaryInputFormat
, UserParameterBinaryInputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterBinaryOutputFormat
, UserParameterBinaryOutputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterClientMemoryLimit
, UserParameterClientMemoryLimitArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterClientMetadataRequestUseConnectionCtx
, UserParameterClientMetadataRequestUseConnectionCtxArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterClientPrefetchThread
, UserParameterClientPrefetchThreadArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterClientResultChunkSize
, UserParameterClientResultChunkSizeArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterClientResultColumnCaseInsensitive
, UserParameterClientResultColumnCaseInsensitiveArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterClientSessionKeepAlife
, UserParameterClientSessionKeepAlifeArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterClientSessionKeepAliveHeartbeatFrequency
, UserParameterClientSessionKeepAliveHeartbeatFrequencyArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterClientTimestampTypeMapping
, UserParameterClientTimestampTypeMappingArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterDateInputFormat
, UserParameterDateInputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterDateOutputFormat
, UserParameterDateOutputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterEnableUnloadPhysicalTypeOptimization
, UserParameterEnableUnloadPhysicalTypeOptimizationArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterEnableUnredactedQuerySyntaxError
, UserParameterEnableUnredactedQuerySyntaxErrorArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterErrorOnNondeterministicMerge
, UserParameterErrorOnNondeterministicMergeArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterErrorOnNondeterministicUpdate
, UserParameterErrorOnNondeterministicUpdateArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterGeographyOutputFormat
, UserParameterGeographyOutputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterGeometryOutputFormat
, UserParameterGeometryOutputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterJdbcTreatDecimalAsInt
, UserParameterJdbcTreatDecimalAsIntArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterJdbcTreatTimestampNtzAsUtc
, UserParameterJdbcTreatTimestampNtzAsUtcArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterJdbcUseSessionTimezone
, UserParameterJdbcUseSessionTimezoneArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterJsonIndent
, UserParameterJsonIndentArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterLockTimeout
, UserParameterLockTimeoutArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterLogLevel
, UserParameterLogLevelArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterMultiStatementCount
, UserParameterMultiStatementCountArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterNetworkPolicy
, UserParameterNetworkPolicyArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterNoorderSequenceAsDefault
, UserParameterNoorderSequenceAsDefaultArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterOdbcTreatDecimalAsInt
, UserParameterOdbcTreatDecimalAsIntArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterPreventUnloadToInternalStage
, UserParameterPreventUnloadToInternalStageArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterQueryTag
, UserParameterQueryTagArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterQuotedIdentifiersIgnoreCase
, UserParameterQuotedIdentifiersIgnoreCaseArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterRowsPerResultset
, UserParameterRowsPerResultsetArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterS3StageVpceDnsName
, UserParameterS3StageVpceDnsNameArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterSearchPath
, UserParameterSearchPathArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterSimulatedDataSharingConsumer
, UserParameterSimulatedDataSharingConsumerArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterStatementQueuedTimeoutInSecond
, UserParameterStatementQueuedTimeoutInSecondArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterStatementTimeoutInSecond
, UserParameterStatementTimeoutInSecondArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterStrictJsonOutput
, UserParameterStrictJsonOutputArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTimeInputFormat
, UserParameterTimeInputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTimeOutputFormat
, UserParameterTimeOutputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTimestampDayIsAlways24h
, UserParameterTimestampDayIsAlways24hArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTimestampInputFormat
, UserParameterTimestampInputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTimestampLtzOutputFormat
, UserParameterTimestampLtzOutputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTimestampNtzOutputFormat
, UserParameterTimestampNtzOutputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTimestampOutputFormat
, UserParameterTimestampOutputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTimestampTypeMapping
, UserParameterTimestampTypeMappingArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTimestampTzOutputFormat
, UserParameterTimestampTzOutputFormatArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTimezone
, UserParameterTimezoneArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTraceLevel
, UserParameterTraceLevelArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTransactionAbortOnError
, UserParameterTransactionAbortOnErrorArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTransactionDefaultIsolationLevel
, UserParameterTransactionDefaultIsolationLevelArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterTwoDigitCenturyStart
, UserParameterTwoDigitCenturyStartArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterUnsupportedDdlAction
, UserParameterUnsupportedDdlActionArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterUseCachedResult
, UserParameterUseCachedResultArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterWeekOfYearPolicy
, UserParameterWeekOfYearPolicyArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserParameterWeekStart
, UserParameterWeekStartArgs

Default string
Description string
Key string
Level string
Value string
Default string
Description string
Key string
Level string
Value string
default_ String
description String
key String
level String
value String
default string
description string
key string
level string
value string
default String
description String
key String
level String
value String

UserShowOutput
, UserShowOutputArgs

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.
Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-snowflake