Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. Task
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake

snowflake.Task

Explore with Pulumi AI

Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake

Import

$ pulumi import snowflake:index/task:Task example '"<database_name>"."<schema_name>"."<task_name>"'
Copy

Create Task Resource

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

Constructor syntax

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

@overload
def Task(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         database: Optional[str] = None,
         schema: Optional[str] = None,
         sql_statement: Optional[str] = None,
         started: Optional[bool] = None,
         abort_detached_query: Optional[bool] = None,
         afters: Optional[Sequence[str]] = None,
         allow_overlapping_execution: Optional[str] = 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,
         config: Optional[str] = None,
         date_input_format: Optional[str] = None,
         date_output_format: Optional[str] = None,
         enable_unload_physical_type_optimization: Optional[bool] = None,
         error_integration: Optional[str] = None,
         error_on_nondeterministic_merge: Optional[bool] = None,
         error_on_nondeterministic_update: Optional[bool] = None,
         finalize: Optional[str] = None,
         geography_output_format: Optional[str] = None,
         geometry_output_format: Optional[str] = None,
         jdbc_treat_timestamp_ntz_as_utc: Optional[bool] = None,
         jdbc_use_session_timezone: Optional[bool] = None,
         json_indent: Optional[int] = None,
         lock_timeout: Optional[int] = None,
         log_level: Optional[str] = None,
         multi_statement_count: Optional[int] = None,
         name: Optional[str] = None,
         noorder_sequence_as_default: Optional[bool] = None,
         odbc_treat_decimal_as_int: Optional[bool] = None,
         query_tag: Optional[str] = None,
         quoted_identifiers_ignore_case: Optional[bool] = None,
         rows_per_resultset: Optional[int] = None,
         s3_stage_vpce_dns_name: Optional[str] = None,
         schedule: Optional[TaskScheduleArgs] = None,
         search_path: Optional[str] = None,
         statement_queued_timeout_in_seconds: Optional[int] = None,
         statement_timeout_in_seconds: Optional[int] = None,
         strict_json_output: Optional[bool] = None,
         suspend_task_after_num_failures: Optional[int] = None,
         task_auto_retry_attempts: Optional[int] = None,
         time_input_format: Optional[str] = None,
         time_output_format: Optional[str] = None,
         timestamp_day_is_always24h: Optional[bool] = None,
         timestamp_input_format: Optional[str] = None,
         timestamp_ltz_output_format: Optional[str] = None,
         timestamp_ntz_output_format: Optional[str] = None,
         timestamp_output_format: Optional[str] = None,
         timestamp_type_mapping: Optional[str] = None,
         timestamp_tz_output_format: Optional[str] = None,
         timezone: Optional[str] = None,
         trace_level: Optional[str] = None,
         transaction_abort_on_error: Optional[bool] = None,
         transaction_default_isolation_level: Optional[str] = None,
         two_digit_century_start: Optional[int] = None,
         unsupported_ddl_action: Optional[str] = None,
         use_cached_result: Optional[bool] = None,
         user_task_managed_initial_warehouse_size: Optional[str] = None,
         user_task_minimum_trigger_interval_in_seconds: Optional[int] = None,
         user_task_timeout_ms: Optional[int] = None,
         warehouse: Optional[str] = None,
         week_of_year_policy: Optional[int] = None,
         week_start: Optional[int] = None,
         when: Optional[str] = None)
func NewTask(ctx *Context, name string, args TaskArgs, opts ...ResourceOption) (*Task, error)
public Task(string name, TaskArgs args, CustomResourceOptions? opts = null)
public Task(String name, TaskArgs args)
public Task(String name, TaskArgs args, CustomResourceOptions options)

type: snowflake:Task
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 This property is required. TaskArgs
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 This property is required. TaskArgs
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 This property is required. TaskArgs
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 This property is required. TaskArgs
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. TaskArgs
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 taskResource = new Snowflake.Task("taskResource", new()
{
    Database = "string",
    Schema = "string",
    SqlStatement = "string",
    Started = false,
    AbortDetachedQuery = false,
    Afters = new[]
    {
        "string",
    },
    AllowOverlappingExecution = "string",
    Autocommit = false,
    BinaryInputFormat = "string",
    BinaryOutputFormat = "string",
    ClientMemoryLimit = 0,
    ClientMetadataRequestUseConnectionCtx = false,
    ClientPrefetchThreads = 0,
    ClientResultChunkSize = 0,
    ClientResultColumnCaseInsensitive = false,
    ClientSessionKeepAlive = false,
    ClientSessionKeepAliveHeartbeatFrequency = 0,
    ClientTimestampTypeMapping = "string",
    Comment = "string",
    Config = "string",
    DateInputFormat = "string",
    DateOutputFormat = "string",
    EnableUnloadPhysicalTypeOptimization = false,
    ErrorIntegration = "string",
    ErrorOnNondeterministicMerge = false,
    ErrorOnNondeterministicUpdate = false,
    Finalize = "string",
    GeographyOutputFormat = "string",
    GeometryOutputFormat = "string",
    JdbcTreatTimestampNtzAsUtc = false,
    JdbcUseSessionTimezone = false,
    JsonIndent = 0,
    LockTimeout = 0,
    LogLevel = "string",
    MultiStatementCount = 0,
    Name = "string",
    NoorderSequenceAsDefault = false,
    OdbcTreatDecimalAsInt = false,
    QueryTag = "string",
    QuotedIdentifiersIgnoreCase = false,
    RowsPerResultset = 0,
    S3StageVpceDnsName = "string",
    Schedule = new Snowflake.Inputs.TaskScheduleArgs
    {
        Minutes = 0,
        UsingCron = "string",
    },
    SearchPath = "string",
    StatementQueuedTimeoutInSeconds = 0,
    StatementTimeoutInSeconds = 0,
    StrictJsonOutput = false,
    SuspendTaskAfterNumFailures = 0,
    TaskAutoRetryAttempts = 0,
    TimeInputFormat = "string",
    TimeOutputFormat = "string",
    TimestampDayIsAlways24h = false,
    TimestampInputFormat = "string",
    TimestampLtzOutputFormat = "string",
    TimestampNtzOutputFormat = "string",
    TimestampOutputFormat = "string",
    TimestampTypeMapping = "string",
    TimestampTzOutputFormat = "string",
    Timezone = "string",
    TraceLevel = "string",
    TransactionAbortOnError = false,
    TransactionDefaultIsolationLevel = "string",
    TwoDigitCenturyStart = 0,
    UnsupportedDdlAction = "string",
    UseCachedResult = false,
    UserTaskManagedInitialWarehouseSize = "string",
    UserTaskMinimumTriggerIntervalInSeconds = 0,
    UserTaskTimeoutMs = 0,
    Warehouse = "string",
    WeekOfYearPolicy = 0,
    WeekStart = 0,
    When = "string",
});
Copy
example, err := snowflake.NewTask(ctx, "taskResource", &snowflake.TaskArgs{
	Database:           pulumi.String("string"),
	Schema:             pulumi.String("string"),
	SqlStatement:       pulumi.String("string"),
	Started:            pulumi.Bool(false),
	AbortDetachedQuery: pulumi.Bool(false),
	Afters: pulumi.StringArray{
		pulumi.String("string"),
	},
	AllowOverlappingExecution:                pulumi.String("string"),
	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"),
	Config:                                   pulumi.String("string"),
	DateInputFormat:                          pulumi.String("string"),
	DateOutputFormat:                         pulumi.String("string"),
	EnableUnloadPhysicalTypeOptimization:     pulumi.Bool(false),
	ErrorIntegration:                         pulumi.String("string"),
	ErrorOnNondeterministicMerge:             pulumi.Bool(false),
	ErrorOnNondeterministicUpdate:            pulumi.Bool(false),
	Finalize:                                 pulumi.String("string"),
	GeographyOutputFormat:                    pulumi.String("string"),
	GeometryOutputFormat:                     pulumi.String("string"),
	JdbcTreatTimestampNtzAsUtc:               pulumi.Bool(false),
	JdbcUseSessionTimezone:                   pulumi.Bool(false),
	JsonIndent:                               pulumi.Int(0),
	LockTimeout:                              pulumi.Int(0),
	LogLevel:                                 pulumi.String("string"),
	MultiStatementCount:                      pulumi.Int(0),
	Name:                                     pulumi.String("string"),
	NoorderSequenceAsDefault:                 pulumi.Bool(false),
	OdbcTreatDecimalAsInt:                    pulumi.Bool(false),
	QueryTag:                                 pulumi.String("string"),
	QuotedIdentifiersIgnoreCase:              pulumi.Bool(false),
	RowsPerResultset:                         pulumi.Int(0),
	S3StageVpceDnsName:                       pulumi.String("string"),
	Schedule: &snowflake.TaskScheduleArgs{
		Minutes:   pulumi.Int(0),
		UsingCron: pulumi.String("string"),
	},
	SearchPath:                              pulumi.String("string"),
	StatementQueuedTimeoutInSeconds:         pulumi.Int(0),
	StatementTimeoutInSeconds:               pulumi.Int(0),
	StrictJsonOutput:                        pulumi.Bool(false),
	SuspendTaskAfterNumFailures:             pulumi.Int(0),
	TaskAutoRetryAttempts:                   pulumi.Int(0),
	TimeInputFormat:                         pulumi.String("string"),
	TimeOutputFormat:                        pulumi.String("string"),
	TimestampDayIsAlways24h:                 pulumi.Bool(false),
	TimestampInputFormat:                    pulumi.String("string"),
	TimestampLtzOutputFormat:                pulumi.String("string"),
	TimestampNtzOutputFormat:                pulumi.String("string"),
	TimestampOutputFormat:                   pulumi.String("string"),
	TimestampTypeMapping:                    pulumi.String("string"),
	TimestampTzOutputFormat:                 pulumi.String("string"),
	Timezone:                                pulumi.String("string"),
	TraceLevel:                              pulumi.String("string"),
	TransactionAbortOnError:                 pulumi.Bool(false),
	TransactionDefaultIsolationLevel:        pulumi.String("string"),
	TwoDigitCenturyStart:                    pulumi.Int(0),
	UnsupportedDdlAction:                    pulumi.String("string"),
	UseCachedResult:                         pulumi.Bool(false),
	UserTaskManagedInitialWarehouseSize:     pulumi.String("string"),
	UserTaskMinimumTriggerIntervalInSeconds: pulumi.Int(0),
	UserTaskTimeoutMs:                       pulumi.Int(0),
	Warehouse:                               pulumi.String("string"),
	WeekOfYearPolicy:                        pulumi.Int(0),
	WeekStart:                               pulumi.Int(0),
	When:                                    pulumi.String("string"),
})
Copy
var taskResource = new Task("taskResource", TaskArgs.builder()
    .database("string")
    .schema("string")
    .sqlStatement("string")
    .started(false)
    .abortDetachedQuery(false)
    .afters("string")
    .allowOverlappingExecution("string")
    .autocommit(false)
    .binaryInputFormat("string")
    .binaryOutputFormat("string")
    .clientMemoryLimit(0)
    .clientMetadataRequestUseConnectionCtx(false)
    .clientPrefetchThreads(0)
    .clientResultChunkSize(0)
    .clientResultColumnCaseInsensitive(false)
    .clientSessionKeepAlive(false)
    .clientSessionKeepAliveHeartbeatFrequency(0)
    .clientTimestampTypeMapping("string")
    .comment("string")
    .config("string")
    .dateInputFormat("string")
    .dateOutputFormat("string")
    .enableUnloadPhysicalTypeOptimization(false)
    .errorIntegration("string")
    .errorOnNondeterministicMerge(false)
    .errorOnNondeterministicUpdate(false)
    .finalize("string")
    .geographyOutputFormat("string")
    .geometryOutputFormat("string")
    .jdbcTreatTimestampNtzAsUtc(false)
    .jdbcUseSessionTimezone(false)
    .jsonIndent(0)
    .lockTimeout(0)
    .logLevel("string")
    .multiStatementCount(0)
    .name("string")
    .noorderSequenceAsDefault(false)
    .odbcTreatDecimalAsInt(false)
    .queryTag("string")
    .quotedIdentifiersIgnoreCase(false)
    .rowsPerResultset(0)
    .s3StageVpceDnsName("string")
    .schedule(TaskScheduleArgs.builder()
        .minutes(0)
        .usingCron("string")
        .build())
    .searchPath("string")
    .statementQueuedTimeoutInSeconds(0)
    .statementTimeoutInSeconds(0)
    .strictJsonOutput(false)
    .suspendTaskAfterNumFailures(0)
    .taskAutoRetryAttempts(0)
    .timeInputFormat("string")
    .timeOutputFormat("string")
    .timestampDayIsAlways24h(false)
    .timestampInputFormat("string")
    .timestampLtzOutputFormat("string")
    .timestampNtzOutputFormat("string")
    .timestampOutputFormat("string")
    .timestampTypeMapping("string")
    .timestampTzOutputFormat("string")
    .timezone("string")
    .traceLevel("string")
    .transactionAbortOnError(false)
    .transactionDefaultIsolationLevel("string")
    .twoDigitCenturyStart(0)
    .unsupportedDdlAction("string")
    .useCachedResult(false)
    .userTaskManagedInitialWarehouseSize("string")
    .userTaskMinimumTriggerIntervalInSeconds(0)
    .userTaskTimeoutMs(0)
    .warehouse("string")
    .weekOfYearPolicy(0)
    .weekStart(0)
    .when("string")
    .build());
Copy
task_resource = snowflake.Task("taskResource",
    database="string",
    schema="string",
    sql_statement="string",
    started=False,
    abort_detached_query=False,
    afters=["string"],
    allow_overlapping_execution="string",
    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",
    config="string",
    date_input_format="string",
    date_output_format="string",
    enable_unload_physical_type_optimization=False,
    error_integration="string",
    error_on_nondeterministic_merge=False,
    error_on_nondeterministic_update=False,
    finalize="string",
    geography_output_format="string",
    geometry_output_format="string",
    jdbc_treat_timestamp_ntz_as_utc=False,
    jdbc_use_session_timezone=False,
    json_indent=0,
    lock_timeout=0,
    log_level="string",
    multi_statement_count=0,
    name="string",
    noorder_sequence_as_default=False,
    odbc_treat_decimal_as_int=False,
    query_tag="string",
    quoted_identifiers_ignore_case=False,
    rows_per_resultset=0,
    s3_stage_vpce_dns_name="string",
    schedule={
        "minutes": 0,
        "using_cron": "string",
    },
    search_path="string",
    statement_queued_timeout_in_seconds=0,
    statement_timeout_in_seconds=0,
    strict_json_output=False,
    suspend_task_after_num_failures=0,
    task_auto_retry_attempts=0,
    time_input_format="string",
    time_output_format="string",
    timestamp_day_is_always24h=False,
    timestamp_input_format="string",
    timestamp_ltz_output_format="string",
    timestamp_ntz_output_format="string",
    timestamp_output_format="string",
    timestamp_type_mapping="string",
    timestamp_tz_output_format="string",
    timezone="string",
    trace_level="string",
    transaction_abort_on_error=False,
    transaction_default_isolation_level="string",
    two_digit_century_start=0,
    unsupported_ddl_action="string",
    use_cached_result=False,
    user_task_managed_initial_warehouse_size="string",
    user_task_minimum_trigger_interval_in_seconds=0,
    user_task_timeout_ms=0,
    warehouse="string",
    week_of_year_policy=0,
    week_start=0,
    when="string")
Copy
const taskResource = new snowflake.Task("taskResource", {
    database: "string",
    schema: "string",
    sqlStatement: "string",
    started: false,
    abortDetachedQuery: false,
    afters: ["string"],
    allowOverlappingExecution: "string",
    autocommit: false,
    binaryInputFormat: "string",
    binaryOutputFormat: "string",
    clientMemoryLimit: 0,
    clientMetadataRequestUseConnectionCtx: false,
    clientPrefetchThreads: 0,
    clientResultChunkSize: 0,
    clientResultColumnCaseInsensitive: false,
    clientSessionKeepAlive: false,
    clientSessionKeepAliveHeartbeatFrequency: 0,
    clientTimestampTypeMapping: "string",
    comment: "string",
    config: "string",
    dateInputFormat: "string",
    dateOutputFormat: "string",
    enableUnloadPhysicalTypeOptimization: false,
    errorIntegration: "string",
    errorOnNondeterministicMerge: false,
    errorOnNondeterministicUpdate: false,
    finalize: "string",
    geographyOutputFormat: "string",
    geometryOutputFormat: "string",
    jdbcTreatTimestampNtzAsUtc: false,
    jdbcUseSessionTimezone: false,
    jsonIndent: 0,
    lockTimeout: 0,
    logLevel: "string",
    multiStatementCount: 0,
    name: "string",
    noorderSequenceAsDefault: false,
    odbcTreatDecimalAsInt: false,
    queryTag: "string",
    quotedIdentifiersIgnoreCase: false,
    rowsPerResultset: 0,
    s3StageVpceDnsName: "string",
    schedule: {
        minutes: 0,
        usingCron: "string",
    },
    searchPath: "string",
    statementQueuedTimeoutInSeconds: 0,
    statementTimeoutInSeconds: 0,
    strictJsonOutput: false,
    suspendTaskAfterNumFailures: 0,
    taskAutoRetryAttempts: 0,
    timeInputFormat: "string",
    timeOutputFormat: "string",
    timestampDayIsAlways24h: false,
    timestampInputFormat: "string",
    timestampLtzOutputFormat: "string",
    timestampNtzOutputFormat: "string",
    timestampOutputFormat: "string",
    timestampTypeMapping: "string",
    timestampTzOutputFormat: "string",
    timezone: "string",
    traceLevel: "string",
    transactionAbortOnError: false,
    transactionDefaultIsolationLevel: "string",
    twoDigitCenturyStart: 0,
    unsupportedDdlAction: "string",
    useCachedResult: false,
    userTaskManagedInitialWarehouseSize: "string",
    userTaskMinimumTriggerIntervalInSeconds: 0,
    userTaskTimeoutMs: 0,
    warehouse: "string",
    weekOfYearPolicy: 0,
    weekStart: 0,
    when: "string",
});
Copy
type: snowflake:Task
properties:
    abortDetachedQuery: false
    afters:
        - string
    allowOverlappingExecution: string
    autocommit: false
    binaryInputFormat: string
    binaryOutputFormat: string
    clientMemoryLimit: 0
    clientMetadataRequestUseConnectionCtx: false
    clientPrefetchThreads: 0
    clientResultChunkSize: 0
    clientResultColumnCaseInsensitive: false
    clientSessionKeepAlive: false
    clientSessionKeepAliveHeartbeatFrequency: 0
    clientTimestampTypeMapping: string
    comment: string
    config: string
    database: string
    dateInputFormat: string
    dateOutputFormat: string
    enableUnloadPhysicalTypeOptimization: false
    errorIntegration: string
    errorOnNondeterministicMerge: false
    errorOnNondeterministicUpdate: false
    finalize: string
    geographyOutputFormat: string
    geometryOutputFormat: string
    jdbcTreatTimestampNtzAsUtc: false
    jdbcUseSessionTimezone: false
    jsonIndent: 0
    lockTimeout: 0
    logLevel: string
    multiStatementCount: 0
    name: string
    noorderSequenceAsDefault: false
    odbcTreatDecimalAsInt: false
    queryTag: string
    quotedIdentifiersIgnoreCase: false
    rowsPerResultset: 0
    s3StageVpceDnsName: string
    schedule:
        minutes: 0
        usingCron: string
    schema: string
    searchPath: string
    sqlStatement: string
    started: false
    statementQueuedTimeoutInSeconds: 0
    statementTimeoutInSeconds: 0
    strictJsonOutput: false
    suspendTaskAfterNumFailures: 0
    taskAutoRetryAttempts: 0
    timeInputFormat: string
    timeOutputFormat: string
    timestampDayIsAlways24h: false
    timestampInputFormat: string
    timestampLtzOutputFormat: string
    timestampNtzOutputFormat: string
    timestampOutputFormat: string
    timestampTypeMapping: string
    timestampTzOutputFormat: string
    timezone: string
    traceLevel: string
    transactionAbortOnError: false
    transactionDefaultIsolationLevel: string
    twoDigitCenturyStart: 0
    unsupportedDdlAction: string
    useCachedResult: false
    userTaskManagedInitialWarehouseSize: string
    userTaskMinimumTriggerIntervalInSeconds: 0
    userTaskTimeoutMs: 0
    warehouse: string
    weekOfYearPolicy: 0
    weekStart: 0
    when: string
Copy

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

Database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
SqlStatement This property is required. string
Any single SQL statement, or a call to a stored procedure, executed when the task runs.
Started This property is required. bool
Specifies if the task should be started or suspended.
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.
Afters List<string>
Specifies one or more predecessor tasks for the current task. Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
AllowOverlappingExecution string
By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap. 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.
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 task.
Config string
Specifies a string representation of key value pairs that can be accessed by all tasks in the task graph. Must be in JSON format.
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.
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.
ErrorIntegration string
Specifies the name of the notification integration used for error notifications. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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.
Finalize string
Specifies the name of a root task that the finalizer task is associated with. Finalizer tasks run after all other tasks in the task graph run to completion. You can define the SQL of a finalizer task to handle notifications and the release and cleanup of resources that a task graph uses. For more information, see Release and cleanup of task graphs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
MultiStatementCount int
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
Name Changes to this property will trigger replacement. string
Specifies the identifier for the task; must be unique for the database and schema in which the task is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
Schedule TaskSchedule
The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflicts with finalize and after; when set, one of the sub-fields minutes or using_cron should be set)
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.
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.
SuspendTaskAfterNumFailures int
Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
TaskAutoRetryAttempts int
Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
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.
UserTaskManagedInitialWarehouseSize string
Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive): %s. (Conflicts with warehouse). For more information about warehouses, see docs. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs.
UserTaskMinimumTriggerIntervalInSeconds int
Minimum amount of time between Triggered Task executions in seconds For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
UserTaskTimeoutMs int
Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
Warehouse string
The warehouse the task will use. Omit this parameter to use Snowflake-managed compute resources for runs of this task. Due to Snowflake limitations warehouse identifier can consist of only upper-cased letters. (Conflicts with usertaskmanagedinitialwarehouse_size) For more information about this resource, see 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.
When string
Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported. When a task is triggered (based on its SCHEDULE or AFTER setting), it validates the conditions of the expression to determine whether to execute. If the conditions of the expression are not met, then the task skips the current run. Any tasks that identify this task as a predecessor also don’t run.
Database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
SqlStatement This property is required. string
Any single SQL statement, or a call to a stored procedure, executed when the task runs.
Started This property is required. bool
Specifies if the task should be started or suspended.
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.
Afters []string
Specifies one or more predecessor tasks for the current task. Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
AllowOverlappingExecution string
By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap. 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.
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 task.
Config string
Specifies a string representation of key value pairs that can be accessed by all tasks in the task graph. Must be in JSON format.
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.
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.
ErrorIntegration string
Specifies the name of the notification integration used for error notifications. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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.
Finalize string
Specifies the name of a root task that the finalizer task is associated with. Finalizer tasks run after all other tasks in the task graph run to completion. You can define the SQL of a finalizer task to handle notifications and the release and cleanup of resources that a task graph uses. For more information, see Release and cleanup of task graphs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
MultiStatementCount int
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
Name Changes to this property will trigger replacement. string
Specifies the identifier for the task; must be unique for the database and schema in which the task is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
Schedule TaskScheduleArgs
The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflicts with finalize and after; when set, one of the sub-fields minutes or using_cron should be set)
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.
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.
SuspendTaskAfterNumFailures int
Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
TaskAutoRetryAttempts int
Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
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.
UserTaskManagedInitialWarehouseSize string
Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive): %s. (Conflicts with warehouse). For more information about warehouses, see docs. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs.
UserTaskMinimumTriggerIntervalInSeconds int
Minimum amount of time between Triggered Task executions in seconds For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
UserTaskTimeoutMs int
Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
Warehouse string
The warehouse the task will use. Omit this parameter to use Snowflake-managed compute resources for runs of this task. Due to Snowflake limitations warehouse identifier can consist of only upper-cased letters. (Conflicts with usertaskmanagedinitialwarehouse_size) For more information about this resource, see 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.
When string
Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported. When a task is triggered (based on its SCHEDULE or AFTER setting), it validates the conditions of the expression to determine whether to execute. If the conditions of the expression are not met, then the task skips the current run. Any tasks that identify this task as a predecessor also don’t run.
database
This property is required.
Changes to this property will trigger replacement.
String
The database in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema
This property is required.
Changes to this property will trigger replacement.
String
The schema in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
sqlStatement This property is required. String
Any single SQL statement, or a call to a stored procedure, executed when the task runs.
started This property is required. Boolean
Specifies if the task should be started or suspended.
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.
afters List<String>
Specifies one or more predecessor tasks for the current task. Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
allowOverlappingExecution String
By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap. 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.
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 task.
config String
Specifies a string representation of key value pairs that can be accessed by all tasks in the task graph. Must be in JSON format.
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.
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.
errorIntegration String
Specifies the name of the notification integration used for error notifications. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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.
finalize_ String
Specifies the name of a root task that the finalizer task is associated with. Finalizer tasks run after all other tasks in the task graph run to completion. You can define the SQL of a finalizer task to handle notifications and the release and cleanup of resources that a task graph uses. For more information, see Release and cleanup of task graphs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
multiStatementCount Integer
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
name Changes to this property will trigger replacement. String
Specifies the identifier for the task; must be unique for the database and schema in which the task is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
schedule TaskSchedule
The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflicts with finalize and after; when set, one of the sub-fields minutes or using_cron should be set)
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.
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.
suspendTaskAfterNumFailures Integer
Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
taskAutoRetryAttempts Integer
Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
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.
userTaskManagedInitialWarehouseSize String
Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive): %s. (Conflicts with warehouse). For more information about warehouses, see docs. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs.
userTaskMinimumTriggerIntervalInSeconds Integer
Minimum amount of time between Triggered Task executions in seconds For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
userTaskTimeoutMs Integer
Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
warehouse String
The warehouse the task will use. Omit this parameter to use Snowflake-managed compute resources for runs of this task. Due to Snowflake limitations warehouse identifier can consist of only upper-cased letters. (Conflicts with usertaskmanagedinitialwarehouse_size) For more information about this resource, see 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.
when String
Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported. When a task is triggered (based on its SCHEDULE or AFTER setting), it validates the conditions of the expression to determine whether to execute. If the conditions of the expression are not met, then the task skips the current run. Any tasks that identify this task as a predecessor also don’t run.
database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
sqlStatement This property is required. string
Any single SQL statement, or a call to a stored procedure, executed when the task runs.
started This property is required. boolean
Specifies if the task should be started or suspended.
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.
afters string[]
Specifies one or more predecessor tasks for the current task. Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
allowOverlappingExecution string
By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap. 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.
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 task.
config string
Specifies a string representation of key value pairs that can be accessed by all tasks in the task graph. Must be in JSON format.
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.
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.
errorIntegration string
Specifies the name of the notification integration used for error notifications. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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.
finalize string
Specifies the name of a root task that the finalizer task is associated with. Finalizer tasks run after all other tasks in the task graph run to completion. You can define the SQL of a finalizer task to handle notifications and the release and cleanup of resources that a task graph uses. For more information, see Release and cleanup of task graphs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
multiStatementCount number
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
name Changes to this property will trigger replacement. string
Specifies the identifier for the task; must be unique for the database and schema in which the task is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
schedule TaskSchedule
The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflicts with finalize and after; when set, one of the sub-fields minutes or using_cron should be set)
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.
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.
suspendTaskAfterNumFailures number
Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
taskAutoRetryAttempts number
Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
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.
userTaskManagedInitialWarehouseSize string
Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive): %s. (Conflicts with warehouse). For more information about warehouses, see docs. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs.
userTaskMinimumTriggerIntervalInSeconds number
Minimum amount of time between Triggered Task executions in seconds For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
userTaskTimeoutMs number
Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
warehouse string
The warehouse the task will use. Omit this parameter to use Snowflake-managed compute resources for runs of this task. Due to Snowflake limitations warehouse identifier can consist of only upper-cased letters. (Conflicts with usertaskmanagedinitialwarehouse_size) For more information about this resource, see 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.
when string
Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported. When a task is triggered (based on its SCHEDULE or AFTER setting), it validates the conditions of the expression to determine whether to execute. If the conditions of the expression are not met, then the task skips the current run. Any tasks that identify this task as a predecessor also don’t run.
database
This property is required.
Changes to this property will trigger replacement.
str
The database in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema
This property is required.
Changes to this property will trigger replacement.
str
The schema in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
sql_statement This property is required. str
Any single SQL statement, or a call to a stored procedure, executed when the task runs.
started This property is required. bool
Specifies if the task should be started or suspended.
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.
afters Sequence[str]
Specifies one or more predecessor tasks for the current task. Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
allow_overlapping_execution str
By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap. 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.
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 task.
config str
Specifies a string representation of key value pairs that can be accessed by all tasks in the task graph. Must be in JSON format.
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.
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.
error_integration str
Specifies the name of the notification integration used for error notifications. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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.
finalize str
Specifies the name of a root task that the finalizer task is associated with. Finalizer tasks run after all other tasks in the task graph run to completion. You can define the SQL of a finalizer task to handle notifications and the release and cleanup of resources that a task graph uses. For more information, see Release and cleanup of task graphs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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_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.
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.
multi_statement_count int
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
name Changes to this property will trigger replacement. str
Specifies the identifier for the task; must be unique for the database and schema in which the task is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
schedule TaskScheduleArgs
The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflicts with finalize and after; when set, one of the sub-fields minutes or using_cron should be set)
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.
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.
suspend_task_after_num_failures int
Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
task_auto_retry_attempts int
Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
time_input_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_task_managed_initial_warehouse_size str
Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive): %s. (Conflicts with warehouse). For more information about warehouses, see docs. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs.
user_task_minimum_trigger_interval_in_seconds int
Minimum amount of time between Triggered Task executions in seconds For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
user_task_timeout_ms int
Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
warehouse str
The warehouse the task will use. Omit this parameter to use Snowflake-managed compute resources for runs of this task. Due to Snowflake limitations warehouse identifier can consist of only upper-cased letters. (Conflicts with usertaskmanagedinitialwarehouse_size) For more information about this resource, see 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.
when str
Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported. When a task is triggered (based on its SCHEDULE or AFTER setting), it validates the conditions of the expression to determine whether to execute. If the conditions of the expression are not met, then the task skips the current run. Any tasks that identify this task as a predecessor also don’t run.
database
This property is required.
Changes to this property will trigger replacement.
String
The database in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema
This property is required.
Changes to this property will trigger replacement.
String
The schema in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
sqlStatement This property is required. String
Any single SQL statement, or a call to a stored procedure, executed when the task runs.
started This property is required. Boolean
Specifies if the task should be started or suspended.
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.
afters List<String>
Specifies one or more predecessor tasks for the current task. Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
allowOverlappingExecution String
By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap. 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.
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 task.
config String
Specifies a string representation of key value pairs that can be accessed by all tasks in the task graph. Must be in JSON format.
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.
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.
errorIntegration String
Specifies the name of the notification integration used for error notifications. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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.
finalize String
Specifies the name of a root task that the finalizer task is associated with. Finalizer tasks run after all other tasks in the task graph run to completion. You can define the SQL of a finalizer task to handle notifications and the release and cleanup of resources that a task graph uses. For more information, see Release and cleanup of task graphs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
multiStatementCount Number
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
name Changes to this property will trigger replacement. String
Specifies the identifier for the task; must be unique for the database and schema in which the task is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
schedule Property Map
The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflicts with finalize and after; when set, one of the sub-fields minutes or using_cron should be set)
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.
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.
suspendTaskAfterNumFailures Number
Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
taskAutoRetryAttempts Number
Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
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.
userTaskManagedInitialWarehouseSize String
Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive): %s. (Conflicts with warehouse). For more information about warehouses, see docs. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs.
userTaskMinimumTriggerIntervalInSeconds Number
Minimum amount of time between Triggered Task executions in seconds For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
userTaskTimeoutMs Number
Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
warehouse String
The warehouse the task will use. Omit this parameter to use Snowflake-managed compute resources for runs of this task. Due to Snowflake limitations warehouse identifier can consist of only upper-cased letters. (Conflicts with usertaskmanagedinitialwarehouse_size) For more information about this resource, see 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.
when String
Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported. When a task is triggered (based on its SCHEDULE or AFTER setting), it validates the conditions of the expression to determine whether to execute. If the conditions of the expression are not met, then the task skips the current run. Any tasks that identify this task as a predecessor also don’t run.

Outputs

All input properties are implicitly available as output properties. Additionally, the Task 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<TaskParameter>
Outputs the result of SHOW PARAMETERS IN TASK for the given task.
ShowOutputs List<TaskShowOutput>
Outputs the result of SHOW TASKS for the given task.
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 []TaskParameter
Outputs the result of SHOW PARAMETERS IN TASK for the given task.
ShowOutputs []TaskShowOutput
Outputs the result of SHOW TASKS for the given task.
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<TaskParameter>
Outputs the result of SHOW PARAMETERS IN TASK for the given task.
showOutputs List<TaskShowOutput>
Outputs the result of SHOW TASKS for the given task.
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 TaskParameter[]
Outputs the result of SHOW PARAMETERS IN TASK for the given task.
showOutputs TaskShowOutput[]
Outputs the result of SHOW TASKS for the given task.
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[TaskParameter]
Outputs the result of SHOW PARAMETERS IN TASK for the given task.
show_outputs Sequence[TaskShowOutput]
Outputs the result of SHOW TASKS for the given task.
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 TASK for the given task.
showOutputs List<Property Map>
Outputs the result of SHOW TASKS for the given task.

Look up Existing Task Resource

Get an existing Task 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?: TaskState, opts?: CustomResourceOptions): Task
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        abort_detached_query: Optional[bool] = None,
        afters: Optional[Sequence[str]] = None,
        allow_overlapping_execution: Optional[str] = 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,
        config: Optional[str] = None,
        database: Optional[str] = None,
        date_input_format: Optional[str] = None,
        date_output_format: Optional[str] = None,
        enable_unload_physical_type_optimization: Optional[bool] = None,
        error_integration: Optional[str] = None,
        error_on_nondeterministic_merge: Optional[bool] = None,
        error_on_nondeterministic_update: Optional[bool] = None,
        finalize: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        geography_output_format: Optional[str] = None,
        geometry_output_format: Optional[str] = None,
        jdbc_treat_timestamp_ntz_as_utc: Optional[bool] = None,
        jdbc_use_session_timezone: Optional[bool] = None,
        json_indent: Optional[int] = None,
        lock_timeout: Optional[int] = None,
        log_level: Optional[str] = None,
        multi_statement_count: Optional[int] = None,
        name: Optional[str] = None,
        noorder_sequence_as_default: Optional[bool] = None,
        odbc_treat_decimal_as_int: Optional[bool] = None,
        parameters: Optional[Sequence[TaskParameterArgs]] = None,
        query_tag: Optional[str] = None,
        quoted_identifiers_ignore_case: Optional[bool] = None,
        rows_per_resultset: Optional[int] = None,
        s3_stage_vpce_dns_name: Optional[str] = None,
        schedule: Optional[TaskScheduleArgs] = None,
        schema: Optional[str] = None,
        search_path: Optional[str] = None,
        show_outputs: Optional[Sequence[TaskShowOutputArgs]] = None,
        sql_statement: Optional[str] = None,
        started: Optional[bool] = None,
        statement_queued_timeout_in_seconds: Optional[int] = None,
        statement_timeout_in_seconds: Optional[int] = None,
        strict_json_output: Optional[bool] = None,
        suspend_task_after_num_failures: Optional[int] = None,
        task_auto_retry_attempts: Optional[int] = None,
        time_input_format: Optional[str] = None,
        time_output_format: Optional[str] = None,
        timestamp_day_is_always24h: Optional[bool] = None,
        timestamp_input_format: Optional[str] = None,
        timestamp_ltz_output_format: Optional[str] = None,
        timestamp_ntz_output_format: Optional[str] = None,
        timestamp_output_format: Optional[str] = None,
        timestamp_type_mapping: Optional[str] = None,
        timestamp_tz_output_format: Optional[str] = None,
        timezone: Optional[str] = None,
        trace_level: Optional[str] = None,
        transaction_abort_on_error: Optional[bool] = None,
        transaction_default_isolation_level: Optional[str] = None,
        two_digit_century_start: Optional[int] = None,
        unsupported_ddl_action: Optional[str] = None,
        use_cached_result: Optional[bool] = None,
        user_task_managed_initial_warehouse_size: Optional[str] = None,
        user_task_minimum_trigger_interval_in_seconds: Optional[int] = None,
        user_task_timeout_ms: Optional[int] = None,
        warehouse: Optional[str] = None,
        week_of_year_policy: Optional[int] = None,
        week_start: Optional[int] = None,
        when: Optional[str] = None) -> Task
func GetTask(ctx *Context, name string, id IDInput, state *TaskState, opts ...ResourceOption) (*Task, error)
public static Task Get(string name, Input<string> id, TaskState? state, CustomResourceOptions? opts = null)
public static Task get(String name, Output<String> id, TaskState state, CustomResourceOptions options)
resources:  _:    type: snowflake:Task    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.
Afters List<string>
Specifies one or more predecessor tasks for the current task. Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
AllowOverlappingExecution string
By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap. 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.
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 task.
Config string
Specifies a string representation of key value pairs that can be accessed by all tasks in the task graph. Must be in JSON format.
Database Changes to this property will trigger replacement. string
The database in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
ErrorIntegration string
Specifies the name of the notification integration used for error notifications. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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.
Finalize string
Specifies the name of a root task that the finalizer task is associated with. Finalizer tasks run after all other tasks in the task graph run to completion. You can define the SQL of a finalizer task to handle notifications and the release and cleanup of resources that a task graph uses. For more information, see Release and cleanup of task graphs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
MultiStatementCount int
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
Name Changes to this property will trigger replacement. string
Specifies the identifier for the task; must be unique for the database and schema in which the task is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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<TaskParameter>
Outputs the result of SHOW PARAMETERS IN TASK for the given task.
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.
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.
Schedule TaskSchedule
The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflicts with finalize and after; when set, one of the sub-fields minutes or using_cron should be set)
Schema Changes to this property will trigger replacement. string
The schema in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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<TaskShowOutput>
Outputs the result of SHOW TASKS for the given task.
SqlStatement string
Any single SQL statement, or a call to a stored procedure, executed when the task runs.
Started bool
Specifies if the task should be started or suspended.
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.
SuspendTaskAfterNumFailures int
Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
TaskAutoRetryAttempts int
Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
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.
UserTaskManagedInitialWarehouseSize string
Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive): %s. (Conflicts with warehouse). For more information about warehouses, see docs. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs.
UserTaskMinimumTriggerIntervalInSeconds int
Minimum amount of time between Triggered Task executions in seconds For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
UserTaskTimeoutMs int
Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
Warehouse string
The warehouse the task will use. Omit this parameter to use Snowflake-managed compute resources for runs of this task. Due to Snowflake limitations warehouse identifier can consist of only upper-cased letters. (Conflicts with usertaskmanagedinitialwarehouse_size) For more information about this resource, see 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.
When string
Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported. When a task is triggered (based on its SCHEDULE or AFTER setting), it validates the conditions of the expression to determine whether to execute. If the conditions of the expression are not met, then the task skips the current run. Any tasks that identify this task as a predecessor also don’t run.
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.
Afters []string
Specifies one or more predecessor tasks for the current task. Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
AllowOverlappingExecution string
By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap. 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.
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 task.
Config string
Specifies a string representation of key value pairs that can be accessed by all tasks in the task graph. Must be in JSON format.
Database Changes to this property will trigger replacement. string
The database in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
ErrorIntegration string
Specifies the name of the notification integration used for error notifications. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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.
Finalize string
Specifies the name of a root task that the finalizer task is associated with. Finalizer tasks run after all other tasks in the task graph run to completion. You can define the SQL of a finalizer task to handle notifications and the release and cleanup of resources that a task graph uses. For more information, see Release and cleanup of task graphs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
MultiStatementCount int
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
Name Changes to this property will trigger replacement. string
Specifies the identifier for the task; must be unique for the database and schema in which the task is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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 []TaskParameterArgs
Outputs the result of SHOW PARAMETERS IN TASK for the given task.
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.
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.
Schedule TaskScheduleArgs
The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflicts with finalize and after; when set, one of the sub-fields minutes or using_cron should be set)
Schema Changes to this property will trigger replacement. string
The schema in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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 []TaskShowOutputArgs
Outputs the result of SHOW TASKS for the given task.
SqlStatement string
Any single SQL statement, or a call to a stored procedure, executed when the task runs.
Started bool
Specifies if the task should be started or suspended.
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.
SuspendTaskAfterNumFailures int
Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
TaskAutoRetryAttempts int
Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
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.
UserTaskManagedInitialWarehouseSize string
Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive): %s. (Conflicts with warehouse). For more information about warehouses, see docs. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs.
UserTaskMinimumTriggerIntervalInSeconds int
Minimum amount of time between Triggered Task executions in seconds For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
UserTaskTimeoutMs int
Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
Warehouse string
The warehouse the task will use. Omit this parameter to use Snowflake-managed compute resources for runs of this task. Due to Snowflake limitations warehouse identifier can consist of only upper-cased letters. (Conflicts with usertaskmanagedinitialwarehouse_size) For more information about this resource, see 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.
When string
Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported. When a task is triggered (based on its SCHEDULE or AFTER setting), it validates the conditions of the expression to determine whether to execute. If the conditions of the expression are not met, then the task skips the current run. Any tasks that identify this task as a predecessor also don’t run.
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.
afters List<String>
Specifies one or more predecessor tasks for the current task. Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
allowOverlappingExecution String
By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap. 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.
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 task.
config String
Specifies a string representation of key value pairs that can be accessed by all tasks in the task graph. Must be in JSON format.
database Changes to this property will trigger replacement. String
The database in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
errorIntegration String
Specifies the name of the notification integration used for error notifications. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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.
finalize_ String
Specifies the name of a root task that the finalizer task is associated with. Finalizer tasks run after all other tasks in the task graph run to completion. You can define the SQL of a finalizer task to handle notifications and the release and cleanup of resources that a task graph uses. For more information, see Release and cleanup of task graphs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
multiStatementCount Integer
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
name Changes to this property will trigger replacement. String
Specifies the identifier for the task; must be unique for the database and schema in which the task is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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<TaskParameter>
Outputs the result of SHOW PARAMETERS IN TASK for the given task.
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.
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.
schedule TaskSchedule
The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflicts with finalize and after; when set, one of the sub-fields minutes or using_cron should be set)
schema Changes to this property will trigger replacement. String
The schema in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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<TaskShowOutput>
Outputs the result of SHOW TASKS for the given task.
sqlStatement String
Any single SQL statement, or a call to a stored procedure, executed when the task runs.
started Boolean
Specifies if the task should be started or suspended.
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.
suspendTaskAfterNumFailures Integer
Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
taskAutoRetryAttempts Integer
Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
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.
userTaskManagedInitialWarehouseSize String
Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive): %s. (Conflicts with warehouse). For more information about warehouses, see docs. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs.
userTaskMinimumTriggerIntervalInSeconds Integer
Minimum amount of time between Triggered Task executions in seconds For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
userTaskTimeoutMs Integer
Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
warehouse String
The warehouse the task will use. Omit this parameter to use Snowflake-managed compute resources for runs of this task. Due to Snowflake limitations warehouse identifier can consist of only upper-cased letters. (Conflicts with usertaskmanagedinitialwarehouse_size) For more information about this resource, see 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.
when String
Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported. When a task is triggered (based on its SCHEDULE or AFTER setting), it validates the conditions of the expression to determine whether to execute. If the conditions of the expression are not met, then the task skips the current run. Any tasks that identify this task as a predecessor also don’t run.
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.
afters string[]
Specifies one or more predecessor tasks for the current task. Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
allowOverlappingExecution string
By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap. 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.
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 task.
config string
Specifies a string representation of key value pairs that can be accessed by all tasks in the task graph. Must be in JSON format.
database Changes to this property will trigger replacement. string
The database in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
errorIntegration string
Specifies the name of the notification integration used for error notifications. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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.
finalize string
Specifies the name of a root task that the finalizer task is associated with. Finalizer tasks run after all other tasks in the task graph run to completion. You can define the SQL of a finalizer task to handle notifications and the release and cleanup of resources that a task graph uses. For more information, see Release and cleanup of task graphs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
multiStatementCount number
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
name Changes to this property will trigger replacement. string
Specifies the identifier for the task; must be unique for the database and schema in which the task is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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 TaskParameter[]
Outputs the result of SHOW PARAMETERS IN TASK for the given task.
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.
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.
schedule TaskSchedule
The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflicts with finalize and after; when set, one of the sub-fields minutes or using_cron should be set)
schema Changes to this property will trigger replacement. string
The schema in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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 TaskShowOutput[]
Outputs the result of SHOW TASKS for the given task.
sqlStatement string
Any single SQL statement, or a call to a stored procedure, executed when the task runs.
started boolean
Specifies if the task should be started or suspended.
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.
suspendTaskAfterNumFailures number
Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
taskAutoRetryAttempts number
Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
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.
userTaskManagedInitialWarehouseSize string
Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive): %s. (Conflicts with warehouse). For more information about warehouses, see docs. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs.
userTaskMinimumTriggerIntervalInSeconds number
Minimum amount of time between Triggered Task executions in seconds For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
userTaskTimeoutMs number
Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
warehouse string
The warehouse the task will use. Omit this parameter to use Snowflake-managed compute resources for runs of this task. Due to Snowflake limitations warehouse identifier can consist of only upper-cased letters. (Conflicts with usertaskmanagedinitialwarehouse_size) For more information about this resource, see 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.
when string
Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported. When a task is triggered (based on its SCHEDULE or AFTER setting), it validates the conditions of the expression to determine whether to execute. If the conditions of the expression are not met, then the task skips the current run. Any tasks that identify this task as a predecessor also don’t run.
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.
afters Sequence[str]
Specifies one or more predecessor tasks for the current task. Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
allow_overlapping_execution str
By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap. 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.
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 task.
config str
Specifies a string representation of key value pairs that can be accessed by all tasks in the task graph. Must be in JSON format.
database Changes to this property will trigger replacement. str
The database in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
error_integration str
Specifies the name of the notification integration used for error notifications. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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.
finalize str
Specifies the name of a root task that the finalizer task is associated with. Finalizer tasks run after all other tasks in the task graph run to completion. You can define the SQL of a finalizer task to handle notifications and the release and cleanup of resources that a task graph uses. For more information, see Release and cleanup of task graphs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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_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.
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.
multi_statement_count int
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
name Changes to this property will trigger replacement. str
Specifies the identifier for the task; must be unique for the database and schema in which the task is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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[TaskParameterArgs]
Outputs the result of SHOW PARAMETERS IN TASK for the given task.
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.
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.
schedule TaskScheduleArgs
The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflicts with finalize and after; when set, one of the sub-fields minutes or using_cron should be set)
schema Changes to this property will trigger replacement. str
The schema in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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[TaskShowOutputArgs]
Outputs the result of SHOW TASKS for the given task.
sql_statement str
Any single SQL statement, or a call to a stored procedure, executed when the task runs.
started bool
Specifies if the task should be started or suspended.
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.
suspend_task_after_num_failures int
Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
task_auto_retry_attempts int
Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
time_input_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_task_managed_initial_warehouse_size str
Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive): %s. (Conflicts with warehouse). For more information about warehouses, see docs. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs.
user_task_minimum_trigger_interval_in_seconds int
Minimum amount of time between Triggered Task executions in seconds For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
user_task_timeout_ms int
Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
warehouse str
The warehouse the task will use. Omit this parameter to use Snowflake-managed compute resources for runs of this task. Due to Snowflake limitations warehouse identifier can consist of only upper-cased letters. (Conflicts with usertaskmanagedinitialwarehouse_size) For more information about this resource, see 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.
when str
Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported. When a task is triggered (based on its SCHEDULE or AFTER setting), it validates the conditions of the expression to determine whether to execute. If the conditions of the expression are not met, then the task skips the current run. Any tasks that identify this task as a predecessor also don’t run.
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.
afters List<String>
Specifies one or more predecessor tasks for the current task. Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
allowOverlappingExecution String
By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap. 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.
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 task.
config String
Specifies a string representation of key value pairs that can be accessed by all tasks in the task graph. Must be in JSON format.
database Changes to this property will trigger replacement. String
The database in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
errorIntegration String
Specifies the name of the notification integration used for error notifications. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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.
finalize String
Specifies the name of a root task that the finalizer task is associated with. Finalizer tasks run after all other tasks in the task graph run to completion. You can define the SQL of a finalizer task to handle notifications and the release and cleanup of resources that a task graph uses. For more information, see Release and cleanup of task graphs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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.
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.
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.
multiStatementCount Number
Number of statements to execute when using the multi-statement capability. For more information, check MULTISTATEMENTCOUNT docs.
name Changes to this property will trigger replacement. String
Specifies the identifier for the task; must be unique for the database and schema in which the task is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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 TASK for the given task.
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.
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.
schedule Property Map
The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflicts with finalize and after; when set, one of the sub-fields minutes or using_cron should be set)
schema Changes to this property will trigger replacement. String
The schema in which to create the task. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
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 TASKS for the given task.
sqlStatement String
Any single SQL statement, or a call to a stored procedure, executed when the task runs.
started Boolean
Specifies if the task should be started or suspended.
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.
suspendTaskAfterNumFailures Number
Specifies the number of consecutive failed task runs after which the current task is suspended automatically. The default is 0 (no automatic suspension). For more information, check SUSPENDTASKAFTERNUMFAILURES docs.
taskAutoRetryAttempts Number
Specifies the number of automatic task graph retry attempts. If any task graphs complete in a FAILED state, Snowflake can automatically retry the task graphs from the last task in the graph that failed. For more information, check TASKAUTORETRY_ATTEMPTS docs.
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.
userTaskManagedInitialWarehouseSize String
Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size. Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. Valid values are (case-insensitive): %s. (Conflicts with warehouse). For more information about warehouses, see docs. For more information, check USERTASKMANAGEDINITIALWAREHOUSE_SIZE docs.
userTaskMinimumTriggerIntervalInSeconds Number
Minimum amount of time between Triggered Task executions in seconds For more information, check USERTASKMINIMUMTRIGGERINTERVALINSECONDS docs.
userTaskTimeoutMs Number
Specifies the time limit on a single run of the task before it times out (in milliseconds). For more information, check USERTASKTIMEOUT_MS docs.
warehouse String
The warehouse the task will use. Omit this parameter to use Snowflake-managed compute resources for runs of this task. Due to Snowflake limitations warehouse identifier can consist of only upper-cased letters. (Conflicts with usertaskmanagedinitialwarehouse_size) For more information about this resource, see 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.
when String
Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported. When a task is triggered (based on its SCHEDULE or AFTER setting), it validates the conditions of the expression to determine whether to execute. If the conditions of the expression are not met, then the task skips the current run. Any tasks that identify this task as a predecessor also don’t run.

Supporting Types

TaskParameter
, TaskParameterArgs

AbortDetachedQueries List<TaskParameterAbortDetachedQuery>
Autocommits List<TaskParameterAutocommit>
BinaryInputFormats List<TaskParameterBinaryInputFormat>
BinaryOutputFormats List<TaskParameterBinaryOutputFormat>
ClientMemoryLimits List<TaskParameterClientMemoryLimit>
ClientMetadataRequestUseConnectionCtxes List<TaskParameterClientMetadataRequestUseConnectionCtx>
ClientPrefetchThreads List<TaskParameterClientPrefetchThread>
ClientResultChunkSizes List<TaskParameterClientResultChunkSize>
ClientResultColumnCaseInsensitives List<TaskParameterClientResultColumnCaseInsensitive>
ClientSessionKeepAliveHeartbeatFrequencies List<TaskParameterClientSessionKeepAliveHeartbeatFrequency>
ClientSessionKeepAlives List<TaskParameterClientSessionKeepAlife>
ClientTimestampTypeMappings List<TaskParameterClientTimestampTypeMapping>
DateInputFormats List<TaskParameterDateInputFormat>
DateOutputFormats List<TaskParameterDateOutputFormat>
EnableUnloadPhysicalTypeOptimizations List<TaskParameterEnableUnloadPhysicalTypeOptimization>
ErrorOnNondeterministicMerges List<TaskParameterErrorOnNondeterministicMerge>
ErrorOnNondeterministicUpdates List<TaskParameterErrorOnNondeterministicUpdate>
GeographyOutputFormats List<TaskParameterGeographyOutputFormat>
GeometryOutputFormats List<TaskParameterGeometryOutputFormat>
JdbcTreatTimestampNtzAsUtcs List<TaskParameterJdbcTreatTimestampNtzAsUtc>
JdbcUseSessionTimezones List<TaskParameterJdbcUseSessionTimezone>
JsonIndents List<TaskParameterJsonIndent>
LockTimeouts List<TaskParameterLockTimeout>
LogLevels List<TaskParameterLogLevel>
MultiStatementCounts List<TaskParameterMultiStatementCount>
NoorderSequenceAsDefaults List<TaskParameterNoorderSequenceAsDefault>
OdbcTreatDecimalAsInts List<TaskParameterOdbcTreatDecimalAsInt>
QueryTags List<TaskParameterQueryTag>
QuotedIdentifiersIgnoreCases List<TaskParameterQuotedIdentifiersIgnoreCase>
RowsPerResultsets List<TaskParameterRowsPerResultset>
S3StageVpceDnsNames List<TaskParameterS3StageVpceDnsName>
SearchPaths List<TaskParameterSearchPath>
StatementQueuedTimeoutInSeconds List<TaskParameterStatementQueuedTimeoutInSecond>
StatementTimeoutInSeconds List<TaskParameterStatementTimeoutInSecond>
StrictJsonOutputs List<TaskParameterStrictJsonOutput>
SuspendTaskAfterNumFailures List<TaskParameterSuspendTaskAfterNumFailure>
TaskAutoRetryAttempts List<TaskParameterTaskAutoRetryAttempt>
TimeInputFormats List<TaskParameterTimeInputFormat>
TimeOutputFormats List<TaskParameterTimeOutputFormat>
TimestampDayIsAlways24hs List<TaskParameterTimestampDayIsAlways24h>
TimestampInputFormats List<TaskParameterTimestampInputFormat>
TimestampLtzOutputFormats List<TaskParameterTimestampLtzOutputFormat>
TimestampNtzOutputFormats List<TaskParameterTimestampNtzOutputFormat>
TimestampOutputFormats List<TaskParameterTimestampOutputFormat>
TimestampTypeMappings List<TaskParameterTimestampTypeMapping>
TimestampTzOutputFormats List<TaskParameterTimestampTzOutputFormat>
Timezones List<TaskParameterTimezone>
TraceLevels List<TaskParameterTraceLevel>
TransactionAbortOnErrors List<TaskParameterTransactionAbortOnError>
TransactionDefaultIsolationLevels List<TaskParameterTransactionDefaultIsolationLevel>
TwoDigitCenturyStarts List<TaskParameterTwoDigitCenturyStart>
UnsupportedDdlActions List<TaskParameterUnsupportedDdlAction>
UseCachedResults List<TaskParameterUseCachedResult>
UserTaskManagedInitialWarehouseSizes List<TaskParameterUserTaskManagedInitialWarehouseSize>
UserTaskMinimumTriggerIntervalInSeconds List<TaskParameterUserTaskMinimumTriggerIntervalInSecond>
UserTaskTimeoutMs List<TaskParameterUserTaskTimeoutM>
WeekOfYearPolicies List<TaskParameterWeekOfYearPolicy>
WeekStarts List<TaskParameterWeekStart>
AbortDetachedQueries []TaskParameterAbortDetachedQuery
Autocommits []TaskParameterAutocommit
BinaryInputFormats []TaskParameterBinaryInputFormat
BinaryOutputFormats []TaskParameterBinaryOutputFormat
ClientMemoryLimits []TaskParameterClientMemoryLimit
ClientMetadataRequestUseConnectionCtxes []TaskParameterClientMetadataRequestUseConnectionCtx
ClientPrefetchThreads []TaskParameterClientPrefetchThread
ClientResultChunkSizes []TaskParameterClientResultChunkSize
ClientResultColumnCaseInsensitives []TaskParameterClientResultColumnCaseInsensitive
ClientSessionKeepAliveHeartbeatFrequencies []TaskParameterClientSessionKeepAliveHeartbeatFrequency
ClientSessionKeepAlives []TaskParameterClientSessionKeepAlife
ClientTimestampTypeMappings []TaskParameterClientTimestampTypeMapping
DateInputFormats []TaskParameterDateInputFormat
DateOutputFormats []TaskParameterDateOutputFormat
EnableUnloadPhysicalTypeOptimizations []TaskParameterEnableUnloadPhysicalTypeOptimization
ErrorOnNondeterministicMerges []TaskParameterErrorOnNondeterministicMerge
ErrorOnNondeterministicUpdates []TaskParameterErrorOnNondeterministicUpdate
GeographyOutputFormats []TaskParameterGeographyOutputFormat
GeometryOutputFormats []TaskParameterGeometryOutputFormat
JdbcTreatTimestampNtzAsUtcs []TaskParameterJdbcTreatTimestampNtzAsUtc
JdbcUseSessionTimezones []TaskParameterJdbcUseSessionTimezone
JsonIndents []TaskParameterJsonIndent
LockTimeouts []TaskParameterLockTimeout
LogLevels []TaskParameterLogLevel
MultiStatementCounts []TaskParameterMultiStatementCount
NoorderSequenceAsDefaults []TaskParameterNoorderSequenceAsDefault
OdbcTreatDecimalAsInts []TaskParameterOdbcTreatDecimalAsInt
QueryTags []TaskParameterQueryTag
QuotedIdentifiersIgnoreCases []TaskParameterQuotedIdentifiersIgnoreCase
RowsPerResultsets []TaskParameterRowsPerResultset
S3StageVpceDnsNames []TaskParameterS3StageVpceDnsName
SearchPaths []TaskParameterSearchPath
StatementQueuedTimeoutInSeconds []TaskParameterStatementQueuedTimeoutInSecond
StatementTimeoutInSeconds []TaskParameterStatementTimeoutInSecond
StrictJsonOutputs []TaskParameterStrictJsonOutput
SuspendTaskAfterNumFailures []TaskParameterSuspendTaskAfterNumFailure
TaskAutoRetryAttempts []TaskParameterTaskAutoRetryAttempt
TimeInputFormats []TaskParameterTimeInputFormat
TimeOutputFormats []TaskParameterTimeOutputFormat
TimestampDayIsAlways24hs []TaskParameterTimestampDayIsAlways24h
TimestampInputFormats []TaskParameterTimestampInputFormat
TimestampLtzOutputFormats []TaskParameterTimestampLtzOutputFormat
TimestampNtzOutputFormats []TaskParameterTimestampNtzOutputFormat
TimestampOutputFormats []TaskParameterTimestampOutputFormat
TimestampTypeMappings []TaskParameterTimestampTypeMapping
TimestampTzOutputFormats []TaskParameterTimestampTzOutputFormat
Timezones []TaskParameterTimezone
TraceLevels []TaskParameterTraceLevel
TransactionAbortOnErrors []TaskParameterTransactionAbortOnError
TransactionDefaultIsolationLevels []TaskParameterTransactionDefaultIsolationLevel
TwoDigitCenturyStarts []TaskParameterTwoDigitCenturyStart
UnsupportedDdlActions []TaskParameterUnsupportedDdlAction
UseCachedResults []TaskParameterUseCachedResult
UserTaskManagedInitialWarehouseSizes []TaskParameterUserTaskManagedInitialWarehouseSize
UserTaskMinimumTriggerIntervalInSeconds []TaskParameterUserTaskMinimumTriggerIntervalInSecond
UserTaskTimeoutMs []TaskParameterUserTaskTimeoutM
WeekOfYearPolicies []TaskParameterWeekOfYearPolicy
WeekStarts []TaskParameterWeekStart
abortDetachedQueries List<TaskParameterAbortDetachedQuery>
autocommits List<TaskParameterAutocommit>
binaryInputFormats List<TaskParameterBinaryInputFormat>
binaryOutputFormats List<TaskParameterBinaryOutputFormat>
clientMemoryLimits List<TaskParameterClientMemoryLimit>
clientMetadataRequestUseConnectionCtxes List<TaskParameterClientMetadataRequestUseConnectionCtx>
clientPrefetchThreads List<TaskParameterClientPrefetchThread>
clientResultChunkSizes List<TaskParameterClientResultChunkSize>
clientResultColumnCaseInsensitives List<TaskParameterClientResultColumnCaseInsensitive>
clientSessionKeepAliveHeartbeatFrequencies List<TaskParameterClientSessionKeepAliveHeartbeatFrequency>
clientSessionKeepAlives List<TaskParameterClientSessionKeepAlife>
clientTimestampTypeMappings List<TaskParameterClientTimestampTypeMapping>
dateInputFormats List<TaskParameterDateInputFormat>
dateOutputFormats List<TaskParameterDateOutputFormat>
enableUnloadPhysicalTypeOptimizations List<TaskParameterEnableUnloadPhysicalTypeOptimization>
errorOnNondeterministicMerges List<TaskParameterErrorOnNondeterministicMerge>
errorOnNondeterministicUpdates List<TaskParameterErrorOnNondeterministicUpdate>
geographyOutputFormats List<TaskParameterGeographyOutputFormat>
geometryOutputFormats List<TaskParameterGeometryOutputFormat>
jdbcTreatTimestampNtzAsUtcs List<TaskParameterJdbcTreatTimestampNtzAsUtc>
jdbcUseSessionTimezones List<TaskParameterJdbcUseSessionTimezone>
jsonIndents List<TaskParameterJsonIndent>
lockTimeouts List<TaskParameterLockTimeout>
logLevels List<TaskParameterLogLevel>
multiStatementCounts List<TaskParameterMultiStatementCount>
noorderSequenceAsDefaults List<TaskParameterNoorderSequenceAsDefault>
odbcTreatDecimalAsInts List<TaskParameterOdbcTreatDecimalAsInt>
queryTags List<TaskParameterQueryTag>
quotedIdentifiersIgnoreCases List<TaskParameterQuotedIdentifiersIgnoreCase>
rowsPerResultsets List<TaskParameterRowsPerResultset>
s3StageVpceDnsNames List<TaskParameterS3StageVpceDnsName>
searchPaths List<TaskParameterSearchPath>
statementQueuedTimeoutInSeconds List<TaskParameterStatementQueuedTimeoutInSecond>
statementTimeoutInSeconds List<TaskParameterStatementTimeoutInSecond>
strictJsonOutputs List<TaskParameterStrictJsonOutput>
suspendTaskAfterNumFailures List<TaskParameterSuspendTaskAfterNumFailure>
taskAutoRetryAttempts List<TaskParameterTaskAutoRetryAttempt>
timeInputFormats List<TaskParameterTimeInputFormat>
timeOutputFormats List<TaskParameterTimeOutputFormat>
timestampDayIsAlways24hs List<TaskParameterTimestampDayIsAlways24h>
timestampInputFormats List<TaskParameterTimestampInputFormat>
timestampLtzOutputFormats List<TaskParameterTimestampLtzOutputFormat>
timestampNtzOutputFormats List<TaskParameterTimestampNtzOutputFormat>
timestampOutputFormats List<TaskParameterTimestampOutputFormat>
timestampTypeMappings List<TaskParameterTimestampTypeMapping>
timestampTzOutputFormats List<TaskParameterTimestampTzOutputFormat>
timezones List<TaskParameterTimezone>
traceLevels List<TaskParameterTraceLevel>
transactionAbortOnErrors List<TaskParameterTransactionAbortOnError>
transactionDefaultIsolationLevels List<TaskParameterTransactionDefaultIsolationLevel>
twoDigitCenturyStarts List<TaskParameterTwoDigitCenturyStart>
unsupportedDdlActions List<TaskParameterUnsupportedDdlAction>
useCachedResults List<TaskParameterUseCachedResult>
userTaskManagedInitialWarehouseSizes List<TaskParameterUserTaskManagedInitialWarehouseSize>
userTaskMinimumTriggerIntervalInSeconds List<TaskParameterUserTaskMinimumTriggerIntervalInSecond>
userTaskTimeoutMs List<TaskParameterUserTaskTimeoutM>
weekOfYearPolicies List<TaskParameterWeekOfYearPolicy>
weekStarts List<TaskParameterWeekStart>
abortDetachedQueries TaskParameterAbortDetachedQuery[]
autocommits TaskParameterAutocommit[]
binaryInputFormats TaskParameterBinaryInputFormat[]
binaryOutputFormats TaskParameterBinaryOutputFormat[]
clientMemoryLimits TaskParameterClientMemoryLimit[]
clientMetadataRequestUseConnectionCtxes TaskParameterClientMetadataRequestUseConnectionCtx[]
clientPrefetchThreads TaskParameterClientPrefetchThread[]
clientResultChunkSizes TaskParameterClientResultChunkSize[]
clientResultColumnCaseInsensitives TaskParameterClientResultColumnCaseInsensitive[]
clientSessionKeepAliveHeartbeatFrequencies TaskParameterClientSessionKeepAliveHeartbeatFrequency[]
clientSessionKeepAlives TaskParameterClientSessionKeepAlife[]
clientTimestampTypeMappings TaskParameterClientTimestampTypeMapping[]
dateInputFormats TaskParameterDateInputFormat[]
dateOutputFormats TaskParameterDateOutputFormat[]
enableUnloadPhysicalTypeOptimizations TaskParameterEnableUnloadPhysicalTypeOptimization[]
errorOnNondeterministicMerges TaskParameterErrorOnNondeterministicMerge[]
errorOnNondeterministicUpdates TaskParameterErrorOnNondeterministicUpdate[]
geographyOutputFormats TaskParameterGeographyOutputFormat[]
geometryOutputFormats TaskParameterGeometryOutputFormat[]
jdbcTreatTimestampNtzAsUtcs TaskParameterJdbcTreatTimestampNtzAsUtc[]
jdbcUseSessionTimezones TaskParameterJdbcUseSessionTimezone[]
jsonIndents TaskParameterJsonIndent[]
lockTimeouts TaskParameterLockTimeout[]
logLevels TaskParameterLogLevel[]
multiStatementCounts TaskParameterMultiStatementCount[]
noorderSequenceAsDefaults TaskParameterNoorderSequenceAsDefault[]
odbcTreatDecimalAsInts TaskParameterOdbcTreatDecimalAsInt[]
queryTags TaskParameterQueryTag[]
quotedIdentifiersIgnoreCases TaskParameterQuotedIdentifiersIgnoreCase[]
rowsPerResultsets TaskParameterRowsPerResultset[]
s3StageVpceDnsNames TaskParameterS3StageVpceDnsName[]
searchPaths TaskParameterSearchPath[]
statementQueuedTimeoutInSeconds TaskParameterStatementQueuedTimeoutInSecond[]
statementTimeoutInSeconds TaskParameterStatementTimeoutInSecond[]
strictJsonOutputs TaskParameterStrictJsonOutput[]
suspendTaskAfterNumFailures TaskParameterSuspendTaskAfterNumFailure[]
taskAutoRetryAttempts TaskParameterTaskAutoRetryAttempt[]
timeInputFormats TaskParameterTimeInputFormat[]
timeOutputFormats TaskParameterTimeOutputFormat[]
timestampDayIsAlways24hs TaskParameterTimestampDayIsAlways24h[]
timestampInputFormats TaskParameterTimestampInputFormat[]
timestampLtzOutputFormats TaskParameterTimestampLtzOutputFormat[]
timestampNtzOutputFormats TaskParameterTimestampNtzOutputFormat[]
timestampOutputFormats TaskParameterTimestampOutputFormat[]
timestampTypeMappings TaskParameterTimestampTypeMapping[]
timestampTzOutputFormats TaskParameterTimestampTzOutputFormat[]
timezones TaskParameterTimezone[]
traceLevels TaskParameterTraceLevel[]
transactionAbortOnErrors TaskParameterTransactionAbortOnError[]
transactionDefaultIsolationLevels TaskParameterTransactionDefaultIsolationLevel[]
twoDigitCenturyStarts TaskParameterTwoDigitCenturyStart[]
unsupportedDdlActions TaskParameterUnsupportedDdlAction[]
useCachedResults TaskParameterUseCachedResult[]
userTaskManagedInitialWarehouseSizes TaskParameterUserTaskManagedInitialWarehouseSize[]
userTaskMinimumTriggerIntervalInSeconds TaskParameterUserTaskMinimumTriggerIntervalInSecond[]
userTaskTimeoutMs TaskParameterUserTaskTimeoutM[]
weekOfYearPolicies TaskParameterWeekOfYearPolicy[]
weekStarts TaskParameterWeekStart[]
abort_detached_queries Sequence[TaskParameterAbortDetachedQuery]
autocommits Sequence[TaskParameterAutocommit]
binary_input_formats Sequence[TaskParameterBinaryInputFormat]
binary_output_formats Sequence[TaskParameterBinaryOutputFormat]
client_memory_limits Sequence[TaskParameterClientMemoryLimit]
client_metadata_request_use_connection_ctxes Sequence[TaskParameterClientMetadataRequestUseConnectionCtx]
client_prefetch_threads Sequence[TaskParameterClientPrefetchThread]
client_result_chunk_sizes Sequence[TaskParameterClientResultChunkSize]
client_result_column_case_insensitives Sequence[TaskParameterClientResultColumnCaseInsensitive]
client_session_keep_alive_heartbeat_frequencies Sequence[TaskParameterClientSessionKeepAliveHeartbeatFrequency]
client_session_keep_alives Sequence[TaskParameterClientSessionKeepAlife]
client_timestamp_type_mappings Sequence[TaskParameterClientTimestampTypeMapping]
date_input_formats Sequence[TaskParameterDateInputFormat]
date_output_formats Sequence[TaskParameterDateOutputFormat]
enable_unload_physical_type_optimizations Sequence[TaskParameterEnableUnloadPhysicalTypeOptimization]
error_on_nondeterministic_merges Sequence[TaskParameterErrorOnNondeterministicMerge]
error_on_nondeterministic_updates Sequence[TaskParameterErrorOnNondeterministicUpdate]
geography_output_formats Sequence[TaskParameterGeographyOutputFormat]
geometry_output_formats Sequence[TaskParameterGeometryOutputFormat]
jdbc_treat_timestamp_ntz_as_utcs Sequence[TaskParameterJdbcTreatTimestampNtzAsUtc]
jdbc_use_session_timezones Sequence[TaskParameterJdbcUseSessionTimezone]
json_indents Sequence[TaskParameterJsonIndent]
lock_timeouts Sequence[TaskParameterLockTimeout]
log_levels Sequence[TaskParameterLogLevel]
multi_statement_counts Sequence[TaskParameterMultiStatementCount]
noorder_sequence_as_defaults Sequence[TaskParameterNoorderSequenceAsDefault]
odbc_treat_decimal_as_ints Sequence[TaskParameterOdbcTreatDecimalAsInt]
query_tags Sequence[TaskParameterQueryTag]
quoted_identifiers_ignore_cases Sequence[TaskParameterQuotedIdentifiersIgnoreCase]
rows_per_resultsets Sequence[TaskParameterRowsPerResultset]
s3_stage_vpce_dns_names Sequence[TaskParameterS3StageVpceDnsName]
search_paths Sequence[TaskParameterSearchPath]
statement_queued_timeout_in_seconds Sequence[TaskParameterStatementQueuedTimeoutInSecond]
statement_timeout_in_seconds Sequence[TaskParameterStatementTimeoutInSecond]
strict_json_outputs Sequence[TaskParameterStrictJsonOutput]
suspend_task_after_num_failures Sequence[TaskParameterSuspendTaskAfterNumFailure]
task_auto_retry_attempts Sequence[TaskParameterTaskAutoRetryAttempt]
time_input_formats Sequence[TaskParameterTimeInputFormat]
time_output_formats Sequence[TaskParameterTimeOutputFormat]
timestamp_day_is_always24hs Sequence[TaskParameterTimestampDayIsAlways24h]
timestamp_input_formats Sequence[TaskParameterTimestampInputFormat]
timestamp_ltz_output_formats Sequence[TaskParameterTimestampLtzOutputFormat]
timestamp_ntz_output_formats Sequence[TaskParameterTimestampNtzOutputFormat]
timestamp_output_formats Sequence[TaskParameterTimestampOutputFormat]
timestamp_type_mappings Sequence[TaskParameterTimestampTypeMapping]
timestamp_tz_output_formats Sequence[TaskParameterTimestampTzOutputFormat]
timezones Sequence[TaskParameterTimezone]
trace_levels Sequence[TaskParameterTraceLevel]
transaction_abort_on_errors Sequence[TaskParameterTransactionAbortOnError]
transaction_default_isolation_levels Sequence[TaskParameterTransactionDefaultIsolationLevel]
two_digit_century_starts Sequence[TaskParameterTwoDigitCenturyStart]
unsupported_ddl_actions Sequence[TaskParameterUnsupportedDdlAction]
use_cached_results Sequence[TaskParameterUseCachedResult]
user_task_managed_initial_warehouse_sizes Sequence[TaskParameterUserTaskManagedInitialWarehouseSize]
user_task_minimum_trigger_interval_in_seconds Sequence[TaskParameterUserTaskMinimumTriggerIntervalInSecond]
user_task_timeout_ms Sequence[TaskParameterUserTaskTimeoutM]
week_of_year_policies Sequence[TaskParameterWeekOfYearPolicy]
week_starts Sequence[TaskParameterWeekStart]
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>
errorOnNondeterministicMerges List<Property Map>
errorOnNondeterministicUpdates List<Property Map>
geographyOutputFormats List<Property Map>
geometryOutputFormats 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>
noorderSequenceAsDefaults List<Property Map>
odbcTreatDecimalAsInts List<Property Map>
queryTags List<Property Map>
quotedIdentifiersIgnoreCases List<Property Map>
rowsPerResultsets List<Property Map>
s3StageVpceDnsNames List<Property Map>
searchPaths List<Property Map>
statementQueuedTimeoutInSeconds List<Property Map>
statementTimeoutInSeconds List<Property Map>
strictJsonOutputs List<Property Map>
suspendTaskAfterNumFailures List<Property Map>
taskAutoRetryAttempts 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>
userTaskManagedInitialWarehouseSizes List<Property Map>
userTaskMinimumTriggerIntervalInSeconds List<Property Map>
userTaskTimeoutMs List<Property Map>
weekOfYearPolicies List<Property Map>
weekStarts List<Property Map>

TaskParameterAbortDetachedQuery
, TaskParameterAbortDetachedQueryArgs

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

TaskParameterAutocommit
, TaskParameterAutocommitArgs

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

TaskParameterBinaryInputFormat
, TaskParameterBinaryInputFormatArgs

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

TaskParameterBinaryOutputFormat
, TaskParameterBinaryOutputFormatArgs

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

TaskParameterClientMemoryLimit
, TaskParameterClientMemoryLimitArgs

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

TaskParameterClientMetadataRequestUseConnectionCtx
, TaskParameterClientMetadataRequestUseConnectionCtxArgs

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

TaskParameterClientPrefetchThread
, TaskParameterClientPrefetchThreadArgs

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

TaskParameterClientResultChunkSize
, TaskParameterClientResultChunkSizeArgs

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

TaskParameterClientResultColumnCaseInsensitive
, TaskParameterClientResultColumnCaseInsensitiveArgs

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

TaskParameterClientSessionKeepAlife
, TaskParameterClientSessionKeepAlifeArgs

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

TaskParameterClientSessionKeepAliveHeartbeatFrequency
, TaskParameterClientSessionKeepAliveHeartbeatFrequencyArgs

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

TaskParameterClientTimestampTypeMapping
, TaskParameterClientTimestampTypeMappingArgs

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

TaskParameterDateInputFormat
, TaskParameterDateInputFormatArgs

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

TaskParameterDateOutputFormat
, TaskParameterDateOutputFormatArgs

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

TaskParameterEnableUnloadPhysicalTypeOptimization
, TaskParameterEnableUnloadPhysicalTypeOptimizationArgs

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

TaskParameterErrorOnNondeterministicMerge
, TaskParameterErrorOnNondeterministicMergeArgs

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

TaskParameterErrorOnNondeterministicUpdate
, TaskParameterErrorOnNondeterministicUpdateArgs

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

TaskParameterGeographyOutputFormat
, TaskParameterGeographyOutputFormatArgs

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

TaskParameterGeometryOutputFormat
, TaskParameterGeometryOutputFormatArgs

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

TaskParameterJdbcTreatTimestampNtzAsUtc
, TaskParameterJdbcTreatTimestampNtzAsUtcArgs

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

TaskParameterJdbcUseSessionTimezone
, TaskParameterJdbcUseSessionTimezoneArgs

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

TaskParameterJsonIndent
, TaskParameterJsonIndentArgs

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

TaskParameterLockTimeout
, TaskParameterLockTimeoutArgs

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

TaskParameterLogLevel
, TaskParameterLogLevelArgs

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

TaskParameterMultiStatementCount
, TaskParameterMultiStatementCountArgs

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

TaskParameterNoorderSequenceAsDefault
, TaskParameterNoorderSequenceAsDefaultArgs

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

TaskParameterOdbcTreatDecimalAsInt
, TaskParameterOdbcTreatDecimalAsIntArgs

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

TaskParameterQueryTag
, TaskParameterQueryTagArgs

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

TaskParameterQuotedIdentifiersIgnoreCase
, TaskParameterQuotedIdentifiersIgnoreCaseArgs

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

TaskParameterRowsPerResultset
, TaskParameterRowsPerResultsetArgs

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

TaskParameterS3StageVpceDnsName
, TaskParameterS3StageVpceDnsNameArgs

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

TaskParameterSearchPath
, TaskParameterSearchPathArgs

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

TaskParameterStatementQueuedTimeoutInSecond
, TaskParameterStatementQueuedTimeoutInSecondArgs

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

TaskParameterStatementTimeoutInSecond
, TaskParameterStatementTimeoutInSecondArgs

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

TaskParameterStrictJsonOutput
, TaskParameterStrictJsonOutputArgs

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

TaskParameterSuspendTaskAfterNumFailure
, TaskParameterSuspendTaskAfterNumFailureArgs

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

TaskParameterTaskAutoRetryAttempt
, TaskParameterTaskAutoRetryAttemptArgs

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

TaskParameterTimeInputFormat
, TaskParameterTimeInputFormatArgs

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

TaskParameterTimeOutputFormat
, TaskParameterTimeOutputFormatArgs

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

TaskParameterTimestampDayIsAlways24h
, TaskParameterTimestampDayIsAlways24hArgs

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

TaskParameterTimestampInputFormat
, TaskParameterTimestampInputFormatArgs

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

TaskParameterTimestampLtzOutputFormat
, TaskParameterTimestampLtzOutputFormatArgs

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

TaskParameterTimestampNtzOutputFormat
, TaskParameterTimestampNtzOutputFormatArgs

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

TaskParameterTimestampOutputFormat
, TaskParameterTimestampOutputFormatArgs

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

TaskParameterTimestampTypeMapping
, TaskParameterTimestampTypeMappingArgs

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

TaskParameterTimestampTzOutputFormat
, TaskParameterTimestampTzOutputFormatArgs

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

TaskParameterTimezone
, TaskParameterTimezoneArgs

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

TaskParameterTraceLevel
, TaskParameterTraceLevelArgs

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

TaskParameterTransactionAbortOnError
, TaskParameterTransactionAbortOnErrorArgs

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

TaskParameterTransactionDefaultIsolationLevel
, TaskParameterTransactionDefaultIsolationLevelArgs

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

TaskParameterTwoDigitCenturyStart
, TaskParameterTwoDigitCenturyStartArgs

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

TaskParameterUnsupportedDdlAction
, TaskParameterUnsupportedDdlActionArgs

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

TaskParameterUseCachedResult
, TaskParameterUseCachedResultArgs

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

TaskParameterUserTaskManagedInitialWarehouseSize
, TaskParameterUserTaskManagedInitialWarehouseSizeArgs

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

TaskParameterUserTaskMinimumTriggerIntervalInSecond
, TaskParameterUserTaskMinimumTriggerIntervalInSecondArgs

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

TaskParameterUserTaskTimeoutM
, TaskParameterUserTaskTimeoutMArgs

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

TaskParameterWeekOfYearPolicy
, TaskParameterWeekOfYearPolicyArgs

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

TaskParameterWeekStart
, TaskParameterWeekStartArgs

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

TaskSchedule
, TaskScheduleArgs

Minutes int
Specifies an interval (in minutes) of wait time inserted between runs of the task. Accepts positive integers only. (conflicts with using_cron)
UsingCron string
Specifies a cron expression and time zone for periodically running the task. Supports a subset of standard cron utility syntax. (conflicts with minutes)
Minutes int
Specifies an interval (in minutes) of wait time inserted between runs of the task. Accepts positive integers only. (conflicts with using_cron)
UsingCron string
Specifies a cron expression and time zone for periodically running the task. Supports a subset of standard cron utility syntax. (conflicts with minutes)
minutes Integer
Specifies an interval (in minutes) of wait time inserted between runs of the task. Accepts positive integers only. (conflicts with using_cron)
usingCron String
Specifies a cron expression and time zone for periodically running the task. Supports a subset of standard cron utility syntax. (conflicts with minutes)
minutes number
Specifies an interval (in minutes) of wait time inserted between runs of the task. Accepts positive integers only. (conflicts with using_cron)
usingCron string
Specifies a cron expression and time zone for periodically running the task. Supports a subset of standard cron utility syntax. (conflicts with minutes)
minutes int
Specifies an interval (in minutes) of wait time inserted between runs of the task. Accepts positive integers only. (conflicts with using_cron)
using_cron str
Specifies a cron expression and time zone for periodically running the task. Supports a subset of standard cron utility syntax. (conflicts with minutes)
minutes Number
Specifies an interval (in minutes) of wait time inserted between runs of the task. Accepts positive integers only. (conflicts with using_cron)
usingCron String
Specifies a cron expression and time zone for periodically running the task. Supports a subset of standard cron utility syntax. (conflicts with minutes)

TaskShowOutput
, TaskShowOutputArgs

TaskShowOutputTaskRelation
, TaskShowOutputTaskRelationArgs

FinalizedRootTask string
Finalizer string
Predecessors List<string>
finalizedRootTask String
finalizer String
predecessors List<String>
finalizedRootTask String
finalizer String
predecessors List<String>

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake