【亲测免费】 pg_cron 技术文档

概述

pg_cron 是一款专为 PostgreSQL 数据库设计的轻量级作业调度器（兼容版本 10 及以上）。该扩展允许用户通过熟悉的cron语法在数据库内部安排执行SQL命令，实现了数据库层面的任务自动化。它支持秒级别调度，并且能够处理复杂的周期性任务，如数据清理、定期备份、或者触发特定的存储过程等。

安装指南

通过包管理器安装

对于 Red Hat, CentOS, Fedora, 和 Amazon Linux 用户，可以利用 PGDG 安装：

sudo yum install -y pg_cron_16

而对于 Debian 或 Ubuntu 系统，通过 apt.postgresql.org 进行安装：

sudo apt-get -y install postgresql-16-cron

从源码编译安装

首先，克隆 pg_cron 的仓库到本地，然后确保 pg_config 在路径中可访问，之后进行编译并安装：

git clone https://github.com/citusdata/pg_cron.git
cd pg_cron
export PATH=/usr/pgsql-16/bin:$PATH  # 替换为相应 PostgreSQL 版本的路径
make && sudo PATH=$PATH make install

设置pg_cron

1. 修改配置文件：为了使 pg_cron 启动时自动加载，需要将 pg_cron 添加至 postgresql.conf 文件中的 shared_preload_libraries 参数。

   shared_preload_libraries = 'pg_cron'
   

2. 设置环境：可以在 postgresql.conf 中指定 pg_cron 运行的默认数据库、时间区域等。

   cron.database_name = 'yourdb'  # 改为你希望的数据库名，默认是 postgres
   cron.timezone = 'Asia/Shanghai'  # 设置你所在时区
   

3. 重启 PostgreSQL 以应用更改。

4. 创建扩展：使用超级用户在数据库中创建 pg_cron 扩展。

   CREATE EXTENSION pg_cron;
   
   -- 如有需要，授予其他用户使用权限
   GRANT USAGE ON SCHEMA cron TO your_user;
   

使用说明

pg_cron 使用标准的cron表达式来定义任务的执行时间，例如：

SELECT cron.schedule('30 3 * * 6', $$DELETE FROM events WHERE event_time < now() - interval '1 week'$$);  -- 周六凌晨3:30删除一周前的数据

pg_cron 也能处理非标准特性，比如使用“$”代表月份的最后一天：

SELECT cron.schedule('0 12 $ * *', $$CALL process_payroll()$$);  -- 每个月最后一天中午12点处理薪资

API 使用文档

• 安排作业: 通过 cron.schedule 函数安排新作业。

  SELECT cron.schedule('cron-expression', 'command');
  

• 取消作业: 使用 cron.unschedule 删除已计划的作业。

  SELECT cron.unschedule('job-name-or-id');
  

• 跨数据库调度: 对不在安装 pg_cron 的数据库执行命令。

  SELECT cron.schedule_in_database('name', 'cron-expression', 'command', 'other_db');
  

• 查看作业: 查询当前所有作业状态。

  SELECT * FROM cron.job;
  

• 查询运行详情: 获取作业运行的历史记录。

  SELECT * FROM cron.job_run_details ORDER BY start_time DESC LIMIT 5;
  

示例和最佳实践

为了维护 pg_cron 的运行记录，建议定期清理 cron.job_run_details 表：

SELECT cron.schedule('0 12 * * *', $$DELETE FROM cron.job_run_details WHERE end_time < now() - interval '7 days'$$);

管理服务支持情况

云服务商	是否支持pg_cron
Aiven PostgreSQL	√
Alibaba Cloud RDS PostgreSQL	√
Amazon RDS for PostgreSQL	√

---

此文档提供了pg_cron的全面介绍，包括安装方法、基本操作以及一些实用的配置和管理技巧，帮助您高效地利用此工具进行数据库任务的自动化管理。记得在实际应用中根据具体需求调整配置和脚本。