add_job()

Timescale Cloud：性能、扩展、企业级

自托管产品

MST

注册任务以供自动化框架调度。有关调度的更多信息，包括示例任务，请参阅任务文档部分。

必填参数

名称	类型	描述
`proc`	REGPROC	要注册为任务的函数或过程的名称。
`schedule_interval`	INTERVAL	此任务的执行间隔。默认为 24 小时。

可选参数

名称	类型	描述
`config`	JSONB	任务特定的配置，在函数运行时传递给它。
`initial_start`	TIMESTAMPTZ	任务首次运行的时间。对于固定调度，这也作为任务执行对齐的起点。如果省略，在固定调度的情况下，当前时间将用作起点。
`scheduled`	BOOLEAN	设置为 `FALSE` 可将此任务从调度中排除。默认为 `TRUE`。
`check_config`	`REGPROC`	一个函数，它接受一个参数，即 `JSONB` `config` 结构。如果配置无效，该函数应引发错误；否则，返回空。可用于在添加任务时验证配置。只有函数（而非过程）允许作为 `check_config` 的值。
`fixed_schedule`	BOOLEAN	如果希望任务的下一次开始时间由其上次完成时间加上调度间隔确定，请设置为 `FALSE`。如果希望任务的下一次开始时间在上次开始时间后 `schedule_interval` 启动，请设置为 `TRUE`。默认为 `TRUE`。
`timezone`	TEXT	有效时区。如果 fixed_schedule 为 `TRUE`，则任务的后续执行将与其初始开始时间对齐。但是，夏令时 (DST) 更改可能会使此对齐发生偏移。如果您想缓解此问题，请设置为有效时区。默认为 `NULL`。

返回值

列	类型	描述
`job_id`	INTEGER	TimescaleDB 后台任务 ID

示例用法


CREATE OR REPLACE PROCEDURE user_defined_action(job_id int, config jsonb) LANGUAGE PLPGSQL AS
$$
BEGIN
  RAISE NOTICE 'Executing action % with config %', job_id, config;
END
$$;

SELECT add_job('user_defined_action','1h');
SELECT add_job('user_defined_action','1h', fixed_schedule => false);


-- December 4, 2022 is a Sunday
SELECT add_job('user_defined_action','1 week', initial_start => '2022-12-04 00:00:00+00'::timestamptz);
-- if subject to DST
SELECT add_job('user_defined_action','1 week', initial_start => '2022-12-04 00:00:00+00'::timestamptz, timezone => 'Europe/Berlin');

add_job()

必填参数

可选参数

返回值

示例用法

相关内容