文档

周期调度任务(Periodic Task)

更新时间:

MaxCompute周期调度任务(Periodic Task)功能,支持通过SQL语句自定义调度和计算逻辑,从而高效灵活地管理定时调度任务,实现更短的周期、高效的运行及低成本的调度管理。

功能介绍

MaxCompute周期调度任务(Periodic Task)可以灵活自定义任务调度策略,执行对应的SQL计算逻辑,来自动构建数据管道,简化ETL链路。此外,您还可以将任务与表数据变更和流读场景相结合,从而实现连续的ELT工作流程,以处理最近更改的数据。该功能具有以下特性:

  • 支持SQL语言,所有针对定时任务的管理操作均可通过简洁的SQL语言实现。

  • 支持全生命周期管理:包括创建、修改、删除、查看以及查看任务列表和任务执行实例列表。

  • 秒级别周期调度任务,支持最短10 s的定时调度。

  • MaxCompute内置调度服务,更高效成本更低。

  • 支持配置实例启动条件的When表达式,该表达式能够实现较为复杂的条件判断。

  • 支持与平台内对象的无缝结合。例如:支持Delta Table CDC、Object Table等需要定期刷新的对象,提供高效的内置调度服务。

  • 默认支持增量CDC数据后台自动生成。

创建周期调度任务(Periodic Task)

  • 语法

    CREATE TASK [IF NOT EXISTS] <task_name>
        SCHEDULE = "<num> [minute|minutes] | [second|seconds]"
        [TASKPROPERTIES("schedule_strategy"="3",--指定定时调度任务重试次数
                   "odps.namespace.schema"="true" ....];
        [COMMENT task_comment]
        WHEN <bool_expr>
        AS <taskBody>;
  • 参数说明

    • IF NOT EXISTS:可选,创建任务时:

      • 若选择该选项,则无论是否存在同名任务,即使原表结构与要创建的目标任务结构不一致,均会返回成功,且已存在的同名任务将不会受到影响。

      • 若未指定该选项,当存在同名任务,将返回报错。

    • task_name:必填,周期调度任务名称。

    • SCHEDULE = "<num> [minute|minutes] | [second|seconds]":必填,执行周期时长,支持的单位为:分钟、秒。取值范围:[10秒,59*60秒]。

      说明

      单位为秒的数值限制为10~59,大于60 s的需要设置单位为分钟。

    • TASKPROPERTIES("schedule_strategy"="3","odps.namespace.schema"="true" ....]:可选,定时任务调度执行SQL时需要指定的参数,均可通过此处配置。常见取值:schedule_strategy:指定定时调度任务重试次数。定时任务调度执行SQL示例:

      • taskproperties('odps.sql.reducer.instances'='100'):自动启动的任务Reduce Task的Instance数量为100个。

      • taskproperties('odps.sql.reducer.memory'='2048'):自动启动的任务Reduce Task的每个Instance的Memory大小为2048 M。

    • COMMENT task_comment:可选, 周期调度任务的注释内容。注释内容为长度不超过1024字节的有效字符串,否则报错。

    • WHEN:可选,支持配置一个BOOLEAN表达式。仅当该表达式返回True时,后续SQL的执行才会被触发。如果未进行配置,则默认值为True。目前对支持的条件语句进行了相应的约束,只有部分函数支持使用。

      说明
      • BOOLEAN表达式内常用的SCALAR函数,不能使用窗口函数和聚合函数,不能使用子查询嵌套。

      • SCALAR函数可以使用CURRENT_TIMESTAMP、GETDATE、WEEKDAY等获取日期、TO_DATE、CONCAT、LENGTH、REGEXP_REPLACE、UPPER、SPLIT等做转换、计算和替换,也可以使用MAX_PT、TABLE_EXISTS、PARTITION_EXISTS、STREAM_HAS_DATA、TABLE_NEED_CDC_BUILD获取表和分区的信息等,支持的函数列表详情,请参见函数白名单

    • AS <taskBody>:要执行的SQL任务。SQL语句不支持脚本模式执行的语句,目前支持常用的DML和DQL语法, 不支持DDL。

  • 示例

    创建调度任务periodic_task1,每5 分钟(minutes)调度一次,调度失败会重试3次。仅当判断条件stream_has_data('acid2_stream')返回结果为true时,执行SQL任务INSERT INTO acid2_table_dest SELECT pk, val FROM acid_stream。代码示例如下。

    -- 创建一个Delta Table增量表
    CREATE TABLE acid2_table_dest (
      pk bigint NOT NULL PRIMARY KEY, 
      val bigint
    ) tblproperties ("transactional"="true");
    
    -- 创建一个定时调度任务periodic_task1
    CREATE task if NOT EXISTS periodic_task1  
      schedule = '5 minutes' 
      taskproperties('schedule_strategy'='3')
      comment 'task_comment'
      WHEN stream_has_data('acid_stream') 
      AS INSERT INTO acid2_table_dest SELECT pk, val FROM acid_stream;
    说明

    其中stream_has_data('acid2_stream') 的条件判断,等同于在MaxCompute中执行select stream_has_data('acid2_stream');

修改定时调度任务Periodic Task

  • 语法

    ALTER TASK [IF EXISTS] <task_name>
        SET SCHEDULE = "<num> [minute|minutes] | [second|seconds]"
        [TASKPROPERTIES("schedule_strategy"="3",--指定定时调度任务重试次数
                   "odps.namespace.schema"="true" ....];
        [COMMENT task_comment];
    
    ALTER TASK [IF EXISTS] task_name resume | suspend;
    ALTER TASK [IF EXISTS] task_name MODIFY WHEN <boolean_expr>;
  • 参数说明

    • IF EXISTS:可选,创建任务时:

      • 不指定该选项,若指定的定时调度任务不存在,则返回出错。

      • 指定该选项,若指定的定时调度任务不存在,将会跳过执行并返回成功;存在指定的定时调度任务存在,将对指定的任务进行修改。

    • ALTER TASK [IF EXISTS] task_name resume | suspend;:重启(resume) 或暂停(suspend)定时调度任务。

      说明

      创建定时调度任务后会自动启动,若定时调度任务出现问题或手动执行了暂停(suspend),导致任务暂停,您可以通过重启(resume),重新定时调度任务。重启后通过desc查看定时调度任务的状态是ACTIVE。

    其他更多相关参数说明,请参见创建周期调度任务的参数介绍。

  • 示例

    ALTER task periodic_task_alter1 resume; --重启周期调度任务
    ALTER task periodic_task_alter1 suspend;  --暂停周期调度任务
    ALTER task if EXISTS periodic_task_alter1 SET schedule = '6 minute';--修改调度时间
    ALTER task if EXISTS periodic_task_alter1 SET comment 'comment2';--添加注释内容
    ALTER task if EXISTS periodic_task_alter1 SET taskproperties('session_parameter'='false');--

查看定时调度任务(Periodic Task)信息

  • 语法

    DESC task <task_name>;--查看定时调度任务信息
    DESC extended task <task_name>;--查看定时调度任务信息以及Extended信息。
  • 示例

    查看定时调度任务periodic_task1信息。

    DESC task periodic_task1;

    返回结果如下。

    +------------------------------------------------------------------------------------+
    | Owner:                    ALIYUN$odpstest1@aliyun.com                              |
    | Project:                  sql_odps2_daoxi                                          |
    | Schema:                                                                            |
    | Task:                     periodic_task1                                           |
    +------------------------------------------------------------------------------------+
    | CreateTime:               2024-08-23 11:05:46                                      |
    | LastModifiedTime:         2024-08-23 11:05:46                                      |
    +------------------------------------------------------------------------------------+
    | ScheduleText:             '5 minute'                                               |
    | TaskType:                 SQL                                                      |
    | Query:                    insert into acid2_table_dest select pk, val from acid_stream;                                                |
    | Condition:                stream_has_data('acid_stream')                           |
    | Status:                   ACTIVE                                                   |
    | Comment:                                                                           |
    +------------------------------------------------------------------------------------+
    

删除定时调度任务(Periodic Task)

  • 语法

    DROP TASK [IF EXISTS] <task_name>; 
  • 参数说明

    • IF EXISTS:可选,删除任务时:

      • 不指定该选项,若指定的定时调度任务不存在,则返回出错。

      • 指定该选项,若指定的定时调度任务不存在,将会跳过执行并返回成功;若指定的定时调度任务存在,将删除指定任务。

    • task_name:需要删除的定时调度任务(Periodic Task)名称。

查看所有定时调度任务(Periodic Task)列表

您可以通过以下SQL,查看当前MaxCompute项目下的所有定时调度(Periodic Task)任务。

SHOW TASKS; 

结果如下所示:

+--------------------------------------------------------------------------------------------------------------------------------+
| Project:                  openmronlot_daily_arm_src3_xr                                                                        |
| Schema:                                                                                                                        |
+--------------------------------------------------------------------------------------------------------------------------------+
| Tasks:                                                                                                                         |
+--------------------------------------------------------------------------------------------------------------------------------+
| Name                      | Owner                             | CreateTime             | LastModifiedTime       | Status       |
+--------------------------------------------------------------------------------------------------------------------------------+
| periodic_task1            | ALIYUN$odpstest1@aliyun.com       | 2024-07-26 16:19:06    | 2024-07-26 16:19:06    | ACTIVE       |
| periodic_task2            | ALIYUN$odpstest1@aliyun.com       | 2024-07-26 16:19:28    | 2024-07-26 16:19:28    | ACTIVE       |
| periodic_task3            | ALIYUN$odpstest1@aliyun.com       | 2024-07-26 16:20:45    | 2024-07-26 16:20:45    | ACTIVE       |
| periodic_task6            | ALIYUN$odpstest1@aliyun.com       | 2024-08-15 11:09:55    | 2024-08-15 11:09:55    | ACTIVE       |
| periodic_task_alter1      | ALIYUN$odpstest1@aliyun.com       | 2024-07-26 16:17:40    | 2024-07-26 16:17:40    | ACTIVE       |
| periodic_task_condition_task1 | ALIYUN$odpstest1@aliyun.com       | 2024-08-15 11:35:52    | 2024-08-15 11:35:52    | ACTIVE       |
| periodic_task_condition_task_f1 | ALIYUN$odpstest1@aliyun.com       | 2024-08-15 17:59:38    | 2024-08-15 17:59:38    | ACTIVE       |
| periodic_task_condition_task_f2 | ALIYUN$odpstest1@aliyun.com       | 2024-08-15 18:00:18    | 2024-08-15 18:00:18    | ACTIVE       |
| periodic_task_condition_task_f3 | ALIYUN$odpstest1@aliyun.com       | 2024-08-15 18:45:41    | 2024-08-15 18:45:41    | ACTIVE       |
| periodic_task_condition_task_f6 | ALIYUN$odpstest1@aliyun.com       | 2024-08-15 18:49:53    | 2024-08-15 18:49:53    | ACTIVE       |
| periodic_task_ifall_task1 | ALIYUN$odpstest1@aliyun.com       | 2024-08-21 09:17:58    | 2024-08-21 09:17:58    | ACTIVE       |
| periodic_task_ifall_task2 | ALIYUN$odpstest1@aliyun.com       | 2024-08-21 09:26:55    | 2024-08-21 09:26:55    | ACTIVE       |
| periodic_task_negative2   | ALIYUN$odpstest1@aliyun.com       | 2024-07-26 16:15:43    | 2024-07-26 16:15:43    | ACTIVE       |
| periodic_task_negative3   | ALIYUN$odpstest1@aliyun.com       | 2024-07-26 16:17:03    | 2024-07-26 16:17:03    | ACTIVE       |
| task1                     | ALIYUN$odpstest1@aliyun.com       | 2024-07-17 11:36:54    | 2024-07-17 11:36:54    | ACTIVE       |
+--------------------------------------------------------------------------------------------------------------------------------+

查看定时调度任务(Periodic Task)自动调度实例的历史列表

  • 语法

    SHOW HISTORY FOR TASK <task_name>; 
    说明

    上述命令可以看到定时调度任务(Periodic Task)自动调度实例的InstanceId、CreateTime、EndTime以及Status信息。若需要查看某个自动调度实例的详细日志,可以执行wait InstanceId命令。例如:wait 2024082309000177gq71ut9g42m可以获取到MaxCompute Logview地址。您可以在浏览器中复制MaxCompute Logview地址,查看自动调度实例的详细日志。

  • 示例

    --查看定时调度任务periodic_task1的自动调度历史列表信息。
    SHOW HISTORY FOR TASK periodic_task1;

    返回结果如下。

    +---------------------------------------------------------------------------------------------------+
    | Project:                  xr_project                                                                     |
    | Schema:                                                                                                                     |
    | Task:                     periodic_task1                                                                     |
    +---------------------------------------------------------------------------------------------------+
    | History:                                                                                          |
    +---------------------------------------------------------------------------------------------------+
    | InstanceId                       | CreateTime             | EndTime                | Status       |
    +---------------------------------------------------------------------------------------------------+
    | 20240823093000475gpp5sfmcw92     | 2024-08-23 17:30:00    | 2024-08-23 17:30:03    | Terminated   |
    | 2024082309000177gq71ut9g42m      | 2024-08-23 17:00:00    | 2024-08-23 17:00:02    | Terminated   |
    | 20240823083001129gm2k2uq242m     | 2024-08-23 16:30:00    | 2024-08-23 16:30:02    | Terminated   |
    | 2024082308000127g830w1nunj66     | 2024-08-23 16:00:00    | 2024-08-23 16:00:02    | Terminated   |
    | 20240823073000936gd6nllaizqm     | 2024-08-23 15:30:00    | 2024-08-23 15:30:02    | Terminated   |
    | 20240823070000813g1c1ksw7fgc6    | 2024-08-23 15:00:00    | 2024-08-23 15:00:02    | Terminated   |
    | 20240823063001181glltwkzrtdk     | 2024-08-23 14:30:00    | 2024-08-23 14:30:02    | Terminated   |
    | 20240823060000776goyxv1nunj66    | 2024-08-23 14:00:00    | 2024-08-23 14:00:02    | Terminated   |
    | 2024082305300180g5in7zbo22m      | 2024-08-23 13:30:00    | 2024-08-23 13:30:02    | Terminated   |
    | 20240823050000998g59i62v95y9     | 2024-08-23 13:00:00    | 2024-08-23 13:00:02    | Terminated   |
    | 20240823043000692gf6vtt9g42m     | 2024-08-23 12:30:00    | 2024-08-23 12:30:02    | Terminated   |
    | 20240823040000747gp4drnmcw92     | 2024-08-23 12:00:00    | 2024-08-23 12:00:02    | Terminated   |
    | 20240823033000643gmwn937izqm     | 2024-08-23 11:30:00    | 2024-08-23 11:30:02    | Terminated   |
    | 20240823030000777g4whu60oe72     | 2024-08-23 11:00:00    | 2024-08-23 11:00:02    | Terminated   |
    | 20240823023000838gt2rsw3s9un5    | 2024-08-23 10:30:00    | 2024-08-23 10:30:02    | Terminated   |
    | 20240823020000754gdgj937izqm     | 2024-08-23 10:00:00    | 2024-08-23 10:00:02    | Terminated   |
    | 20240823013000869gw0vv77vx7      | 2024-08-23 09:30:00    | 2024-08-23 09:30:02    | Terminated   |
    | 20240823010000895gcwv2e0stdk     | 2024-08-23 09:00:00    | 2024-08-23 09:00:02    | Terminated   |
    | 20240823003000911gujpaps5tz      | 2024-08-23 08:30:00    | 2024-08-23 08:30:02    | Terminated   |
    | 20240823000000466gc6vlbut7f2     | 2024-08-23 08:00:00    | 2024-08-23 08:00:02    | Terminated   |
    | 20240822233000688go492o8o22m     | 2024-08-23 07:30:00    | 2024-08-23 07:30:02    | Terminated   |
    | 20240822230000524gw39jtv95y9     | 2024-08-23 07:00:00    | 2024-08-23 07:00:02    | Terminated   |
    | 20240822223000394g0g82o8o22m     | 2024-08-23 06:30:00    | 2024-08-23 06:30:01    | Terminated   |
    | 20240822220000691geeksypunj66    | 2024-08-23 06:00:00    | 2024-08-23 06:00:02    | Terminated   |
    | 20240822213000736gil72o8o22m     | 2024-08-23 05:30:00    | 2024-08-23 05:30:02    | Terminated   |
    | 20240822210000712gcmlbuu242m     | 2024-08-23 05:00:00    | 2024-08-23 05:00:03    | Terminated   |
    | 20240822203000397glakbuu242m     | 2024-08-23 04:30:00    | 2024-08-23 04:30:01    | Terminated   |
    | 20240822200000531ghxwgupr9un5    | 2024-08-23 04:00:00    | 2024-08-23 04:00:02    | Terminated   |
    | 20240822193000506gydgvlca68o     | 2024-08-23 03:30:00    | 2024-08-23 03:30:01    | Terminated   |
    | 20240822190000545g1moq4s7fgc6    | 2024-08-23 03:00:00    | 2024-08-23 03:00:02    | Terminated   |
    | 20240822183000199g4gsqclunj66    | 2024-08-23 02:30:00    | 2024-08-23 02:30:01    | Terminated   |
    | 20240822180000405goxm8zsr9un5    | 2024-08-23 02:00:00    | 2024-08-23 02:00:01    | Terminated   |
    +---------------------------------------------------------------------------------------------------+
    

函数白名单

创建周期调度任务(Periodic Task)时,支持配置一个BOOLEAN表达式。目前,对支持的条件语句进行了相应的约束,仅以下函数支持被使用。以下函数详情,请参见内建函数(字母排序)

  • DATEADD

  • DATEDIFF

  • DATEPART

  • DATETRUNC

  • DATE_FORMAT

  • FROM_UNIXTIME

  • GETDATE

  • ISDATE

  • LASTDAY

  • LAST_DAY

  • UNIX_TIMESTAMP

  • WEEKDAY

  • WEEKDAY

  • WEEKOFYEAR

  • TO_DATE

  • TO_CHAR

  • YEAR

  • QUARTER

  • MONTH

  • DAY

  • DAYOFMONTH

  • HOUR

  • MINUTE

  • SECOND

  • CURRENT_TIMESTAMP

  • FROM_UTC_TIMESTAMP

  • ADD_MONTHS

  • NEXT_DAY

  • MONTHS_BETWEEN

  • TO_MILLIS

  • ABS

  • ROUND

  • CONCAT

  • CONCAT_WS

  • GET_JSON_OBJECT

  • INSTR

  • LENGTH

  • LENGTHB

  • REGEXP_EXTRACT

  • REGEXP_REPLACE

  • REGEXP_INSTR

  • REGEXP_SUBSTR

  • REGEXP_COUNT

  • REVERSE

  • SUBSTR

  • TOLOWER

  • TOUPPER

  • TRIM

  • LTRIM

  • RTRIM

  • REPLACE

  • SIZE

  • FIELD

  • COALESCE

  • IF

  • SPLIT

  • SPLIT_PART

  • FROM_JSON

  • MAX_PT

  • TABLE_EXISTS

  • PARTITION_EXISTS

  • GET_LATEST_VERSION

  • GET_LATEST_TIMESTAMP