CREATE EVENT

功能描述

创建一个新的定时任务。该定时任务是一种在数据库中定义的特殊对象，它与表或者其他数据库对象关联，当满足指定事件条件时，会自动触发执行预定义的操作或语句。

注意事项

• 定时任务相关操作只有sql_compatibility = 'B'时支持。
• 用户操作（创建/修改/删除）定时任务时，非sysadmin用户需要被sysadmin用户赋予操作定时任务的权限。定时任务操作权限与高级包DBE_SCHEDULER中创建定时任务赋权操作一致。
• 定时任务时间间隔interval表达式目前兼容了浮点数语法，例如interval 0.5 minute，但是计算时会将浮点数取整，所以不建议interval时间间隔使用浮点数形式。
• 同一database下不支持同名定时任务。
• 定时任务中待执行语句范围是除安全相关操作以外任意SQL语句，但对于某些有约束的语句会执行失败。例如：不支持通过复合语句创建database。
• 定时任务待执行语句不支持的安全相关操作范围主要包括：
  • 使用加密函数。
  • 创建、设置用户、group。
  • 连接数据库。
  • 函数加密等。
• 定时任务指定definer选项在以下场景下会指定失败：
  • 操作定时任务的用户不具有sysadmin权限。
  • 当前用户与被指定definer不一致时：
    • 指定definer为初始用户。
    • 指定definer为运维管理员、监控管理员。
    • 开启三权分立，enableSeparationOfDuty=on。

语法格式

CREATE
    [DEFINER = user]
EVENT
    [IF NOT EXISTS]
    event_name
    ON SCHEDULE schedule
    [ON COMPLETION [NOT] PRESERVE]
    [ENABLE | DISABLE | DISABLE ON SLAVE]
    [COMMENT 'string']
    DO event_body;

• schedule：

  1 2 3 4 5 6

  { AT timestamp [+ INTERVAL interval] ... | EVERY interval [STARTS timestamp [+ INTERVAL interval] ...] [ENDS timestamp [+ INTERVAL interval] ...] }

• interval：

  quantity 
           {YEAR | MONTH | DAY | HOUR | MINUTE | SECOND |
            YEAR TO MONTH | DAY TO HOUR | DAY TO MINUTE |
            DAY TO SECOND | HOUR TO MINUTE | HOUR TO SECOND | 
            MINUTE TO SECOND}

参数说明

• DEFINER

  定时任务待执行语句在执行时使用的权限。默认情况下使用当前创建定时任务者的权限，当definer被指定时，使用被指定用户user的用户权限。

  definer参数只有具有sysadmin权限的用户有权指定。

• ON SCHEDULE
  定时任务执行时刻。定时任务可以通过schedule设置为执行一次，也可以设置为执行多次：

  • AT timestamp [+ INTERVAL interval] 表示设置定时任务只在timestamp [+ INTERVAL interval] 时间点执行一次。
  • EVERY interval 表示设置定时任务在每隔interval时间后重复执行。
    • STARTS timestamp [+ INTERVAL interval] 用户可以给可重复执行的定时任务指定起始时间，即定时任务从timestamp [+ INTERVAL interval]时刻开始执行。当此参数为空时默认从当前时刻开始执行。
    • ENDS timestamp [+ INTERVAL interval] 用户可以给可重复执行的定时任务指定结束时间，即定时任务从timestamp [+ INTERVAL interval]时刻停止执行。当此参数为空时默认为3999-12-31 16:00:00。
• INTERVAL

  时间间隔，interval由quantity数字和时间单位组成，例如1 YEAR。

• ON COMPLETION [NOT] PRESERVE

  默认情况下，一旦事务处于完成状态，系统表中就会立刻删除该定时任务。用户可以通过设置ON COMPLETION PRESERVE来覆盖默认行为。

• ENABLE | DISABLE | DISABLE ON SLAVE

  创建定时任务后，定时任务默认处于ENABLE状态，即到规定时间立即执行待执行语句。用户可以使用DISABLE关键字，改变定时任务的活动状态。DISABLE ON SLAVE表现与DISABLE一致。

• COMMENT

  用户可以给定时任务添加注释，注释内容在GS_JOB_ATTRIBUTE表中查看。

• DO

  定时任务待执行语句。

• interval

  时间间隔。interval的取值可以使用下划线代替TO。例如，YEAR_MONTH、DAY_HOUR等。

  

  该参数在B兼容模式下，GUC参数b_format_version = '5.7'、b_format_dev_version = 's1'时才可使用。

示例

--创建并切换至测试数据库。
gaussdb=# CREATE DATABASE test_event WITH DBCOMPATIBILITY = 'b';
gaussdb=# \c test_event

--创建表。
test_event=# CREATE TABLE t_ev(num int);

--创建一个执行一次的定时任务，五秒后执行一次，执行完后定时任务自动删除。
test_event=# CREATE EVENT IF NOT EXISTS event_e1 ON SCHEDULE AT sysdate + interval 5 second DO INSERT INTO t_ev VALUES(0);

--五秒后查询表。
test_event=# SELECT * FROM t_ev;
 num 
-----
   0
(1 row)

--创建一个每隔一分钟执行一次的定时任务。
test_event=# CREATE EVENT IF NOT EXISTS event_e2 ON SCHEDULE EVERY 1 minute DO INSERT INTO t_ev VALUES(1);

--每隔一分钟查询表，会看到新增一条数据。
test_event=# SELECT * FROM t_ev;
 num 
-----
   0
   1
   1
(3 rows)

--删除定时任务。
test_event=# DROP EVENT event_e2;

--删除表。
test_event=# DROP TABLE t_ev;

--切换回初始数据库，并删除测试数据库。请用真实的数据库名替换postgres。
test_event=#\c postgres
gaussdb=# DROP DATABASE test_event;

相关链接

ALTER EVENT，DROP EVENT，SHOW EVENTS