Skip to main content

dependents

Creates, updates, deletes, gets or lists a dependents resource.

Overview

Namedependents
TypeResource
Idsnowflake.task.dependents

Fields

The following fields are returned by SELECT queries:

A Snowflake task, used to execute SQL code.

NameDatatypeDescription
idstringAn ID for the current task.
namestringA Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$, example: TEST_NAME)
database_namestringThe name of the parent database for the task.
schema_namestringThe name of the parent schema for the task.
allow_overlapping_executionbooleanSpecifies whether to allow multiple instances of the DAG to run concurrently.
commentstringSpecifies a comment for the task.
conditionstringSpecifies a Boolean SQL expression condition; multiple conditions joined with AND/OR are supported
configobjectTask Config
created_onstring (date-time)The time the task was created on.
definitionstringThe SQL definition for the task. Any one of single SQL statement, call to stored procedure, or procedural logic using Snowflake scripting.
error_integrationstringSpecifies the name of the notification integration used to communicate with Amazon SNS, MS Azure Event Grid, or Google Pub/Sub.
finalizestringSpecifies the name of the root task that the finalizer task is associated with.
last_committed_onstring (date-time)The time the task was last committed on.
last_suspended_onstring (date-time)The time the task was last suspended on.
ownerstringThe role that owns the task.
owner_role_typestringThe role type of the task owner.
predecessorsarraySpecifies one or more predecessor tasks for the current task
scheduleobjectSpecifies the schedule for periodically running the task.
serverless_task_max_statement_sizestringSpecifies the maximum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. This parameter only applies to serverless tasks.
serverless_task_min_statement_sizestringSpecifies the minimum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. This parameter only applies to serverless tasks.
session_parametersobjectSession Parameters for the task at runtime.
statestringThe state of the task. Must be one of started or suspended.
suspend_task_after_num_failuresintegerSpecifies the number of consecutive failed task runs after which the current task is suspended automatically.
target_completion_intervalobjectSpecifies the schedule for periodically running the task.
task_auto_retry_attemptsintegerRoot task settable only. Specifies the number of automatic task graph retry attempts. Valid range is 0 to 30. When not specified, no retry would happen.
task_relationsstringDisplays the relationship between the root task and its corresponding finalizer tasks.
user_task_managed_initial_warehouse_sizestringSpecifies the size of the compute resources to provision for the first run of the task. This parameter only applies to serverless tasks.
user_task_timeout_msintegerSpecifies the time limit on a single run of the task before it times out (in milliseconds).
warehousestringA Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$, example: TEST_NAME)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
fetch_task_dependentsselectdatabase_name, schema_name, name, endpointrecursiveThis operation returns a list of the dependent tasks of the task with identifier {name}.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
database_namestringIdentifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases.
endpointstringOrganization and Account Name (default: orgid-acctid)
namestringIdentifier (i.e. name) for the resource.
schema_namestringIdentifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database.
recursivebooleanSpecifies whether to limit the output to include only direct child tasks or to include all recursive child tasks.

SELECT examples

This operation returns a list of the dependent tasks of the task with identifier {name}.

SELECT
id,
name,
database_name,
schema_name,
allow_overlapping_execution,
comment,
condition,
config,
created_on,
definition,
error_integration,
finalize,
last_committed_on,
last_suspended_on,
owner,
owner_role_type,
predecessors,
schedule,
serverless_task_max_statement_size,
serverless_task_min_statement_size,
session_parameters,
state,
suspend_task_after_num_failures,
target_completion_interval,
task_auto_retry_attempts,
task_relations,
user_task_managed_initial_warehouse_size,
user_task_timeout_ms,
warehouse
FROM snowflake.task.dependents
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND recursive = '{{ recursive }}';