Categories:

System Functions (System Control)

SYSTEM$USER_TASK_CANCEL_ONGOING_EXECUTIONS

Aborts the next run of the specified task if the system had already started to process it (i.e. its state is EXECUTING).

Syntax

SYSTEM$USER_TASK_CANCEL_ONGOING_EXECUTIONS( '<task_name>' )

Arguments

task_name

Name of the task.

Usage Notes

  • task_name is a string so it must be enclosed in single quotes:

    • Note that the entire name must be enclosed in single quotes, including the database and schema (if the name is fully-qualified), i.e. '<db>.<schema>.<task_name>'.

    • If the task name is case-sensitive or includes any special characters or spaces, double quotes are required to process the case/characters. The double quotes must be enclosed within the single quotes, i.e. '"<task_name>"'.

  • To prevent future runs of the task from starting, we recommend first suspending the task (using ALTER TASK … SUSPEND) and then executing this function.

    Note that if the task is not suspended when this function is executed, it currently takes several minutes for the Snowflake cloud services to begin scheduling executions of this task again.

Examples

Abort the current run of a task with a case-insensitive name:

SELECT SYSTEM$USER_TASK_CANCEL_ONGOING_EXECUTIONS('mydb.myschema.mytask');

Abort the current run of a task with a case-sensitive name:

SELECT SYSTEM$USER_TASK_CANCEL_ONGOING_EXECUTIONS('mydb.myschema."myTask"');