pg_cron

Overview


1070	`pg_cron`	`pg_cron`	1.6.5	TIME	PostgreSQL	C

Attributes


Yes	No	Yes	Yes	Yes	No	No	`pg_catalog`

Packages


EL	PGDG	`pg_cron_$v*`	`1.6`	-	17 16 15 14 13
Debian	PGDG	`postgresql-$v-cron`	`1.6`	-	17 16 15 14 13

Dependent Extensions

The following extensions depend on this extension: timeseries, vectorize, pg_incremental, documentdb

Comments

require cron.database_name

Availability

	PG17	PG16	PG15	PG14	PG13
`el8.x86_64`	1.6.5	1.6.5	1.6.5	1.6.5	1.6.5
`el8.aarch64`	1.6.5	1.6.5	1.6.5	1.6.5	1.6.5
`el9.x86_64`	1.6.5	1.6.5	1.6.5	1.6.5	1.6.5
`el9.aarch64`	1.6.5	1.6.5	1.6.5	1.6.5	1.6.5
`d12.x86_64`	1.6.5	1.6.5	1.6.5	1.6.5	1.6.5
`d12.aarch64`	1.6.5	1.6.5	1.6.5	1.6.5	1.6.5
`u22.x86_64`	1.6.5	1.6.5	1.6.5	1.6.5	1.6.5
`u22.aarch64`	1.6.5	1.6.5	1.6.5	1.6.5	1.6.5
`u24.x86_64`	1.6.5	1.6.5	1.6.5	1.6.5	1.6.5
`u24.aarch64`	1.6.5	1.6.5	1.6.5	1.6.5	1.6.5

CONTRIB

PGDG

PIGSTY

Download

To add the required PGDG / PIGSTY upstream repository, use:

pig repo add pgdg -u    # add PGDG repo and update cache (leave existing repos)
pig repo add pigsty -u  # add PIGSTY repo and update cache (leave existing repos)
pig repo add pgsql -u   # add PGDG + Pigsty repo and update cache (leave existing repos)
pig repo set all -u     # set repo to all = NODE + PGSQL + INFRA  (remove existing repos)

./node.yml -t node_repo -e node_repo_modules=node,pgsql # -l <cluster>

Or download the latest packages directly:

Install

Install this extension with:

pig ext install pg_cron; # install by extension name, for the current active PG version

pig ext install pg_cron -v 17;   # install for PG 17
pig ext install pg_cron -v 16;   # install for PG 16
pig ext install pg_cron -v 15;   # install for PG 15
pig ext install pg_cron -v 14;   # install for PG 14
pig ext install pg_cron -v 13;   # install for PG 13

dnf install pg_cron_17*;
dnf install pg_cron_16*;
dnf install pg_cron_15*;
dnf install pg_cron_14*;
dnf install pg_cron_13*;

apt install postgresql-17-cron;
apt install postgresql-16-cron;
apt install postgresql-15-cron;
apt install postgresql-14-cron;
apt install postgresql-13-cron;

./pgsql.yml -t pg_ext -e '{"pg_extensions": ["pg_cron"]}' # -l <cls>

Preload this extension with:

shared_preload_libraries = 'pg_cron'; # add to pg cluster config

Create this extension with:

CREATE EXTENSION pg_cron;

Usage

beware that cron.database has to be set before adding to shared_preload_libraries

-- Delete old data on Saturday at 3:30am (GMT)
SELECT cron.schedule('30 3 * * 6', $$DELETE FROM events WHERE event_time < now() - interval '1 week'$$);
 schedule
----------
       42

-- Vacuum every day at 10:00am (GMT)
SELECT cron.schedule('nightly-vacuum', '0 10 * * *', 'VACUUM');
 schedule
----------
       43

-- Change to vacuum at 3:00am (GMT)
SELECT cron.schedule('nightly-vacuum', '0 3 * * *', 'VACUUM');
 schedule
----------
       43

-- Stop scheduling jobs
SELECT cron.unschedule('nightly-vacuum' );
 unschedule 
------------
 t

SELECT cron.unschedule(42);
 unschedule
------------
          t

-- Vacuum every Sunday at 4:00am (GMT) in a database other than the one pg_cron is installed in
SELECT cron.schedule_in_database('weekly-vacuum', '0 4 * * 0', 'VACUUM', 'some_other_database');
 schedule
----------
       44

-- Call a stored procedure every 5 seconds
SELECT cron.schedule('process-updates', '5 seconds', 'CALL process_updates()');

-- Process payroll at 12:00 of the last day of each month
SELECT cron.schedule('process-payroll', '0 12 $ * *', 'CALL process_payroll()');

Crontab format:

 ┌───────────── min (0 - 59)
 │ ┌────────────── hour (0 - 23)
 │ │ ┌─────────────── day of month (1 - 31) or last day of the month ($)
 │ │ │ ┌──────────────── month (1 - 12)
 │ │ │ │ ┌───────────────── day of week (0 - 6) (0 to 6 are Sunday to
 │ │ │ │ │                  Saturday, or use names; 7 is also Sunday)
 │ │ │ │ │
 │ │ │ │ │
 * * * * *