PolarDB provides the DBMS_JOB package that is used to schedule and manage scheduled jobs. This topic describes how to create, manage, and delete a scheduled job.
Prerequisites
- You can perform the following steps to manually enable the DBMS_JOB package:
- Log on to the PolarDB console and click the name of the cluster for which you want to enable the DBMS_JOB package.
- In the left-side navigation pane, choose .
- Add
dbms_job
to the extension list of the shared_preload_libraries parameter.
- The kernel version of your PolarDB cluster is 1.1.7 or later. For more information about how to check the kernel version, see Release notes.
Usage
- Only privileged accounts can use the DBMS_JOB package. For more information about how to create a privileged account, see Create database accounts.
- Due to security reasons, you cannot manually create the dbms_job extension. To create the dbms_job extension, go to the Quota Center. Click Apply in the Actions column corresponding to polardb_pg_dbms_job.
- If you have an existing dbms_job extension, delete and reinstall it by following the instructions described in this topic. The following syntax can be used to delete the extension:Warning If you delete the extension, the scheduled jobs that are related to the extension are deleted. Back up your data before you delete the extension.
drop extension dbms_job;
- You can create the dbms_job extension in only the
postgres
database. If you want to configure scheduled jobs for other databases, configure cross-database scheduled jobs in thepostgres
database. For more information, see Run a scheduled job across databases.
Prepare test data
jobrun
for testing, as shown in the following example:CREATE TABLE jobrun (
id serial NOT NULL PRIMARY KEY,
runtime VARCHAR2(40)
);
job_proc
, as shown in the following example:CREATE PROCEDURE job_proc
IS
BEGIN
INSERT INTO jobrun(runtime) VALUES ('job_proc run at ' || TO_CHAR(SYSDATE, 'yyyy-mm-dd hh24:mi:ss'));
END;
Delete the DBMS_JOB package
DROP EXTENSION dbms_job CASCADE;
Create a scheduled job
SUBMIT(job OUT BINARY_INTEGER, what VARCHAR2
[, next_date DATE [, interval VARCHAR2 ]])
Parameter | Description |
---|---|
job | The jobid value that you pass. After you pass the jobid value, the ID of the submitted job is returned. The job ID is automatically generated and is unique for each job. |
what | The name of the stored procedure that you want to call. You must specify this parameter. The job_proc stored procedure is used in the examples in this topic. |
next_date | The start time of the scheduled job. If you do not specify this parameter, the current time is automatically used. |
interval | The interval at which the scheduled job is run. For more information, see Interval description. |
Execution interval | Example |
---|---|
Every minute |
|
Every day | The system runs the job at 01:00:00 every day:
|
Every week | The system runs the job at 01:00:00 on every Monday:
|
Every month | The system runs the job at 01:00:00 on the first day of every month:
|
Every quarter | The system runs the job at 01:00:00 on the first day of every quarter:
|
Every year | The system runs the job at 01:00:00 on January 1 every year:
|
Fixed point in time | The system runs the job at 08:10:00 every morning:
|
Fixed interval | The system runs the job at the fifteenth minute of every hour, such as 08:15:00, 09:15:00, and 10:15:00.
|
job_proc
stored procedure to create a scheduled job, as shown in the following example:DECLARE
jobid INTEGER;
BEGIN
DBMS_JOB.SUBMIT(jobid,'job_proc;', SYSDATE, 'SYSDATE + 1/(24 * 60)');
END;
DBMS_JOB.SUBMIT(jobid,'job_proc;', SYSDATE, 'TRUNC(sysdate,'mi') + 1/(24*60)');
You must enclose the corresponding parameter values in $$
symbols to prevent this error, as shown in the following example:
DBMS_JOB.SUBMIT(jobid,'job_proc;', SYSDATE, $$TRUNC(sysdate,'mi') + 1/(24*60)$$);
Modify the content, start time, and execution interval of a scheduled job
CHANGE(job BINARY_INTEGER what VARCHAR2, next_date DATE,interval VARCHAR2)
Parameter | Description |
---|---|
job | The job ID. For more information about how to check the job ID, see Query scheduled jobs. |
what | The name of the stored procedure that you want to call. Note If you want to use the current value, set this parameter to NULL . |
next_date | The start time of the scheduled job. Note If you want to use the current value, set this parameter to NULL . |
interval | The interval at which the scheduled job is run. For more information, see Interval description. Note If you want to use the current value, set this parameter to NULL . |
BEGIN
DBMS_JOB.CHANGE(1,NULL,TO_DATE('29-DEC-20','DD-MON-YY'),$$Trunc(sysdate,'hh') + (60+15)/(24*60)$$);
END;
Modify the execution interval of a scheduled job
INTERVAL(job BINARY_INTEGER, interval VARCHAR2)
Parameter | Description |
---|---|
job | The job ID. For more information about how to check the job ID, see Query scheduled jobs. |
interval | The interval at which the scheduled job is run. For more information, see Interval description. |
BEGIN
DBMS_JOB.INTERVAL(1,'TRUNC(sysdate) + 1 + 1/(24)');
END;
Modify the start time of a scheduled job
NEXT_DATE(job BINARY_INTEGER, next_date DATE)
Parameter | Description |
---|---|
job | The job ID. For more information about how to check the job ID, see Query scheduled jobs. |
next_date | The start time of the scheduled job. |
BEGIN
DBMS_JOB.NEXT_DATE(1, TO_DATE('30-DEC-20','DD-MON-YY'));
END;
Modify the content of a scheduled job
WHAT(job BINARY_INTEGER, what VARCHAR2)
Parameter | Description |
---|---|
job | The job ID. For more information about how to check the job ID, see Query scheduled jobs. |
what | The name of the stored procedure that you want to call. |
job_proc2
. The following sample statement provides an example:BEGIN
DBMS_JOB.WHAT(1,'job_proc2');
END;
Stop and start a scheduled job
BROKEN(job BINARY_INTEGER, broken BOOLEAN [, next_date DATE ])
Parameter | Description |
---|---|
job | The job ID. For more information about how to check the job ID, see Query scheduled jobs. |
broken | The state of the scheduled job. Valid values:
|
next_date | The start time of the scheduled job. If you do not specify this parameter, the current time is automatically used. |
BEGIN
DBMS_JOB.BROKEN(1,true);
END;
Specify the state of the scheduled job whose job ID is 1 as normal. The following sample statement provides an example:BEGIN
DBMS_JOB.BROKEN(1,false);
END;
Force a scheduled job to run
RUN(job BINARY_INTEGER)
Parameter | Description |
---|---|
job | The job ID. For more information about how to check the job ID, see Query scheduled jobs. |
BEGIN
DBMS_JOB.RUN(1);
END;
Delete a scheduled task
REMOVE(job BINARY_INTEGER)
Parameter | Description |
---|---|
job | The job ID. For more information about how to check the job ID, see Query scheduled jobs. |
BEGIN
DBMS_JOB.REMOVE(1);
END;
Query scheduled jobs
select * from sys.user_jobs;
Query the execution records of a scheduled job
select * from dbmsjob.pga_joblog;
Run a scheduled job across databases
The DBMS_JOB package applies only to the postgres
database. If you want to configure scheduled jobs for other databases, configure cross-database scheduled jobs in the postgres database.
An example is used to describe how to configure a cross-database scheduled job. In this example, the DBMS_JOB package is configured in the postgres
database. A scheduled job is configured to run in a database named test
. In this example, you want to insert one data record per minute into a table in the test
database. For more information about how to create a database, see Create a database.
- Create a table named
jobrun
and a stored procedure namedjob_proc
in thetest
database.- Execute the following statement to create a table named
jobrun
:CREATE TABLE public.jobrun ( id serial NOT NULL PRIMARY KEY, runtime VARCHAR2(40) );
- Execute the following statement to create a stored procedure named
job_proc
:CREATE PROCEDURE public.job_proc IS BEGIN INSERT INTO jobrun(runtime) VALUES ('job_proc run at ' || TO_CHAR(SYSDATE, 'yyyy-mm-dd hh24:mi:ss')); END;
- Execute the following statement to create a table named
- Create a scheduled job in the
postgres
database.You must add the database in which you want to run the scheduled job to the
DBMS_JOB.SUBMIT()
function. In this example, the database in which the scheduled job runs is namedtest
. For more information about other parameters, see Create a scheduled job.The following sample statement provides an example:DECLARE jobid INTEGER; BEGIN DBMS_JOB.SUBMIT(jobid,'job_proc;', SYSDATE, 'SYSDATE + 1/(24 * 60)','test'); END;
- Query the state and execution records of the scheduled job in the
postgres
database.- Query the scheduled job:
The following output is returned:select * from sys.user_jobs;
job | jobloguser | job_user | database | job_created | job_changed | last_date | last_sec | next_date | next_sec | total_time | broken | interval | failures | what | instance -----+------------+----------+----------+----------------------------------+----------------------------------+----------------------------------+----------+---------------------------+----------+-----------------+--------+------------------------------------------+----------+-----------------------------------------------------------------------------------------------------------------+---------- 1 | DBUSER | dbuser | postgres | 29-OCT-20 02:38:49.478494 +00:00 | 29-OCT-20 02:38:49.478494 +00:00 | 29-OCT-20 02:51:12.025001 +00:00 | 02:51:12 | 29-OCT-20 02:53:12 +00:00 | 02:53:12 | 00:00:00.243224 | N | BEGIN return SYSDATE + 1/(24 * 30); END; | 0 | BEGIN EXECUTE IMMEDIATE 'SELECT dbmsjob.dbms_job_internal_job_link(''BEGIN job_proc; END;'', ''test'');' ; END | 0
- Query the execution records:
The following output is returned:select * from dbmsjob.pga_joblog;
jlgid | jlgjobid | jlgstatus | jlgstart | jlgduration -------+----------+-----------+----------------------------------+----------------- 1 | 1 | s | 29-OCT-20 02:38:49.762995 +00:00 | 00:00:00.017495 2 | 1 | s | 29-OCT-20 02:39:50.061113 +00:00 | 00:00:00.016463 3 | 1 | s | 29-OCT-20 02:40:50.062331 +00:00 | 00:00:00.016244
- Query the scheduled job:
- Query the data in the jobrun table in the
test
database.Execute the following statement:
The following output is returned:select * from jobrun;
id | runtime ----+------------------------------------- 1 | job_proc run at 2020-10-29 02:38:50 2 | job_proc run at 2020-10-29 02:39:50 3 | job_proc run at 2020-10-29 02:40:50
BEGIN
DBMS_JOB.CHANGE(1,NULL,SYSDATE,'SYSDATE + 1/(24 * 30)','test');
END;