pg_timetable: Advanced scheduling for PostgreSQL
pg_timetable is an advanced job scheduler for PostgreSQL, offering many advantages over traditional schedulers such as cron and others. It is completely database driven and provides a couple of advanced concepts.
Table of Contents
- 1. Main features
- 2. Installation
- 3. Features and advanced functionality
- 4. Database logging and transactions
- 5. Runtime information
- 6. Schema diagram
- 7. Contributing
- 8. Support
- 9. Authors
1. Main features
- Tasks can be arranged in chains
- A chain can consist of SQL and executables
- Parameters can be passed to chains
- Missed tasks (possibly due to downtime) can be retried automatically
- Support for configurable repetitions
- Builtin tasks such as sending emails, etc.
- Fully database driven configuration
- Full support for database driven logging
- Cron-style scheduling
- Optional concurrency protection
There are currently two options on how you can install and run pg_timetable.
If you feel the need for a .deb or .rpm package, please let us know by submitting an issue, or - which we would really appreciate! - creating a pull request that does said things.
2.1 Container installation
When using Docker, simply replace all
- Get the Dockerfile:
wget -O pg_timetable.Dockerfile https://raw.githubusercontent.com/cybertec-postgresql/pg_timetable/master/Dockerfile
- Build the Docker image:
podman build -f pg_timetable.Dockerfile -t pg_timetable:latest
- Run the image:
podman run --rm pg_timetable:latest
- To pass additional arguments to pg_timetable, such as where your database is located, simply attach the flags to the
podman run, like so:
podman run --rm pg_timetable:latest -h 10.0.0.3 -p 54321
2.2 Local Installation
- Downlod and install Go on your system.
- Clone pg_timetable using
$ env GIT_TERMINAL_PROMPT=1 go get github.com/cybertec-postgresql/pg_timetable/ Username for 'https://github.com': <Github Username> Password for 'https://email@example.com': <Github Password>
$ cd ~/go/src/github.com/cybertec-postgresql/pg_timetable/ $ go run main.go --dbname=dbname --name=worker001 --user=scheduler --password=strongpwd
Alternatively, build a binary and run it:
$ go build $ ./pg_timetable --dbname=dbname --name=worker001 --user=scheduler --password=strongpwd
- (Optional) Run tests in all sub-folders of the project:
$ cd ~/go/src/github.com/cybertec-postgresql/pg_timetable/ $ go get github.com/stretchr/testify/ $ go test ./...
Alternatively, run tests using postgres docker image:
$ RUN_DOCKER=true go test ./...
3. Features and advanced functionality
The scheduling in pg_timetable encompasses three different stages to facilitate the reuse with other parameters or additional schedules.
The first stage, base_task, defines what to do.
The second stage, task_chain, contains a list of base tasks to run sequentially.
The third stage consists of the chain_execution_config and defines if, when, and how often a chain should be executed.
Additionally, to provide the base tasks with parameters and influence their behavior, each entry in a task chain can be accompanied by an execution parameter.
3.1. Base task
In pg_timetable, the most basic building block is a base task. Currently, there are three different kinds of task:
|Base task kind||Task kind type||Example|
||Starting a cleanup, refreshing a materialized view or processing data.|
||Anything that can be called from the command line.|
||A prebuilt functionality included in pg_timetable. These include:
A new base task can be created by inserting a new entry into
||The name of the base task.|
||The type of the base task. Can be
||Contains either a SQL script or a command string which will be executed.|
3.2. Task chain
The next building block is a chain, which simply represents a list of tasks. An example would be:
- Start a transaction
- Download files from a server
- Import files
- Run aggregations
- Commit the transaction
- Remove the files from disk
Through chains, pg_timetable creates the ability to span transactions over more than just one task.
||The ID of the previous base task in the chain. Set this to
||The ID of the base task.|
||The role as which the chain should be executed as.|
||The ID of the
||Specify if the chain should resume after encountering an error (default:
3.2.1. Chain execution configuration
Once a chain has been created, it has to be scheduled. For this, pg_timetable builds upon the standard cron-string, all the while adding multiple configuration options.
||The id of the task chain.|
||The name of the chain.|
||To achieve the cron equivalent of *, set the value to NULL.|
||The amount of instances that this chain may have running at the same time.|
||Control if the chain may be executed once it reaches its schedule.|
||Self destruct the chain.|
||Specifies whether the chain should be executed exclusively while all other chains are paused.|
||Specifies which client should execute the chain. Set this to `NULL` to allow any client.|
3.2.2. Chain execution parameters
As mentioned above, base tasks are simple skeletons (e.g. send email, vacuum, etc.). In most cases, they have to be brought to live by passing parameters to the execution.
||bigint||The ID of the chain execution configuration.|
||bigint||The ID of the chain.|
||integer||The order of the parameter.|
3.3. Example usages
A variety of examples can be found in the
3.4 Examle functions
Create a Job with the
timetable.job_add function. With this function you can
add a new Job with a specific time (
by_day_of_week) as comma separated text list to run or with a in a cron-syntax.
||text||The name of the Task|
||text||The function wich will be executed.|
||text||Type of the function
||text||Time Schedule in Cron Syntax|
||text||This specifies the minutes on which the job is to run||ALL|
||text||This specifies the hours on which the job is to run||ALL|
||text||This specifies the days on which the job is to run.||ALL|
||text||This specifies the month on which the job is to run||ALL|
||text||This specifies the day of week (0,7 is sunday) on which the job is to run||ALL|
||integer||The amount of instances that this chain may have running at the same time.||NULL|
||boolean||Control if the chain may be executed once it reaches its schedule.||FALSE|
||boolean||Self destruct the chain.||FALSE|
If the parameter
by_cron is used all other
by_day_of_week) will be ignored.
18.104.22.168 With Cron-Style
Run "MyJob" at 00:05 in August.
SELECT timetable.job_add('MyJob','Select public.my_func()',null,'SQL','5 0 * 8 *');
Run "MyJob" at minute 23 past every 2nd hour from 0 through 20.
SELECT timetable.job_add('MyJob','Select public.my_func()',null,'SQL','23 0-20/2 * * *');
22.214.171.124 With specific time
Run "SQL" at 01:00 on first day of Month
SELECT timetable.job_add ('At minute 0 and 1st hour on first day of Month', 'SELECT timetable.insert_dummy_log()', null, 'SQL', null, '0', '1', '1', null, null, '1', TRUE, FALSE);
Run "SQL" at 01:00 and 02:00 on every Monday´s
SELECT timetable.job_add ('at 01:00 and 02:00 on every Monday´s', 'SELECT timetable.insert_dummy_log()', null, 'SQL', null, '0', null, '1,2', null, '1', '1', TRUE, FALSE);
4. Database logging and transactions
The entire activity of pg_timetable is logged in database tables (
timetable.execution_log). Since there is no need to parse files when accessing log data, the representation through an UI can be easily achieved.
Furthermore, this behavior allows a remote host to access the log in a straightforward manner, simplifying large and/or distributed applications.
Note: Logs are written in a separate transaction, in case the chain fails.
5. Runtime information
In order to examine the activity of pg_timetable, the table
timetable.run_status can be queried. It contains information about active jobs and their current parameters.
6. Schema diagram
If you want to contribute to pg_timetable and help make it better, feel free to open an issue or even consider submitting a pull request.
For professional support, please contact Cybertec.