Categories:: Data Pipeline DDL

SHOW TASKS¶

Lists the tasks for which you have access privileges. The command can be used to list tasks for the current/specified database or schema, or across your entire account.

The output returns task metadata and properties, ordered lexicographically by database, schema, and task name (see Output in this topic for descriptions of the output columns). This is important to note if you wish to filter the results using the provided filters.

See also:: CREATE TASK , ALTER TASK , DROP TASK , DESCRIBE TASK

Syntax¶

SHOW [ TERSE ] TASKS [ LIKE '<pattern>' ]
                     [ IN { ACCOUNT | DATABASE [ <db_name> ] | [ SCHEMA ] [ <schema_name> ] } ]
                     [ STARTS WITH '<name_string>' ]
                     [ LIMIT <rows> [ FROM '<name_string>' ] ]

Parameters¶

TERSE

Returns only a subset of the output columns:

created_on
name
kind (shows NULL for all task records)
database_name
schema_name
schedule

LIKE 'pattern'

Filters the command output by object name. The filter uses case-insensitive pattern matching, with support for SQL wildcard characters (% and _).

For example, the following patterns return the same results:

... LIKE '%testing%' ...

... LIKE '%TESTING%' ...

IN ACCOUNT | [ DATABASE ] db_name | [ SCHEMA ] schema_name

Specifies the scope of the command, which determines whether the command lists records only for the current/specified database or schema, or across your entire account:

The DATABASE or SCHEMA keyword is not required; you can set the scope by specifying only the database or schema name. Likewise, the database or schema name is not required if the session currently has a database in use.

If DATABASE or SCHEMA is specified without a name and the session does not currently have a database in use, the parameter has no effect on the output.
If SCHEMA is specified with a name and the session does not currently have a database in use, the schema name must be fully qualified with the database name (e.g. testdb.testschema).

Default: Depends on whether the session currently has a database in use:

Database: DATABASE is the default (i.e. the command returns the objects you have privileges to view in the database).
No database: ACCOUNT is the default (i.e. the command returns the objects you have privileges to view in your account).

STARTS WITH 'name_string'

Filters the command output based on the string of characters that appear at the beginning of the object name. The string must be enclosed in single quotes and is case-sensitive. For example, the following return different results:

... STARTS WITH 'B' ...

... STARTS WITH 'b' ...

LIMIT rows [ FROM 'name_string' ]

Enables “pagination” of the results by limiting the maximum number of rows returned. Note that the actual number of rows returned may be less than the specified limit (e.g. the number of objects is less than the specified limit).

This clause can also include a FROM subclause, effectively serving as a “cursor” for the results. This enables fetching the specified number of rows following the first row whose object name matches the specified string:

The string must be enclosed in single quotes and is case-sensitive.
The string does not have to include the full object name; partial names are supported.

Note

FROM can be combined with STARTS WITH in the same statement; however, both conditions must be met or they cancel out each other and no results are returned. In addition, objects are returned in lexicographic order by name, so FROM only returns rows with a higher lexicographic value than the rows returned by STARTS WITH.

For example:

... STARTS WITH 'A' LIMIT ... FROM 'B' would return no results.
... STARTS WITH 'B' LIMIT ... FROM 'A' would return no results.
... STARTS WITH 'A' LIMIT ... FROM 'AB' would return results (if any rows match the input strings).

Usage Notes¶

Only returns rows for a task owner (i.e. the role with the OWNERSHIP privilege on a task) or a role with either the MONITOR or OPERATE privilege on a task.
The command does not require a running warehouse to execute.
The value for LIMIT rows cannot exceed 10000. If LIMIT rows is omitted, the command results in an error if the result set is larger than 10K rows.

To post-process the output of this command, you can use the RESULT_SCAN function, which treats the output as a table that can be queried.

Output¶

The command output provides table properties and metadata in the following columns:

| created_on | name | id | database_name | schema_name | owner | comment | warehouse | schedule | predecessors | state | definition | condition | allow_overlapping_execution |

Column	Description
`created_on`	Date and time when the task was created.
`name`	Name of the task.
`id`	Unique identifier for each task. Note that recreating a task (using CREATE OR REPLACE TASK) essentially creates a new task, which has a new ID.
`database_name`	Database in which the task is stored.
`schema_name`	Schema in which the task is stored.
`owner`	Role that owns the task (i.e. has the OWNERSHIP privilege on the task)
`comment`	Comment for the task.
`warehouse`	Warehouse that provides the required resources to run the task.
`schedule`	Schedule for running the task. Displays NULL if no schedule is specified.
`predecessors`	Task that triggers this task when run successfully. Displays NULL if no predecessor task is specified.
`state`	‘Started’ or ‘Suspended’ based on the current state of the task.
`definition`	SQL statements executed when the task runs.
`condition`	Condition specified in the WHEN clause for the task.
`allow_overlapping_execution`	For root tasks in a tree, displays TRUE if overlapping execution of the tree is explicitly allowed. For child tasks in a tree, displays NULL.

For more information about the properties that can be specified for a task, see CREATE TASK.

Examples¶

Show all the tasks whose name starts with line that you have privileges to view in the tpch.public schema:

SHOW TASKS LIKE 'line%' IN tpch.public;

Show all the tasks that you have privileges to view in the tpch.public schema:

SHOW TASKS IN tpch.public;