DBE_SCHEDULER

Deletes a scheduled task. The operation is performed only when the task is synchronized.

The prototype of the DBE_SCHEDULER.DROP_JOB function is as follows:

1
2
3
4
5
6

DBE_SCHEDULER.drop_job(
job_name text,
force boolean                           default false,
defer boolean                           default false,
commit_semantics text      default 'STOP_ON_FIRST_ERROR'
)

DBE_SCHEDULER.DROP_JOB can specify one or more tasks, or specify a task class to delete a scheduled task.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

gaussdb=# CALL DBE_SCHEDULER.create_program('program1', 'STORED_PROCEDURE', 'select pg_sleep(1);', 3, false, 'test');
 create_program 
----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.create_schedule('schedule1', NULL, 'sysdate', NULL, 'test');
 create_schedule 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.create_job(job_name=>'job1', program_name=>'program1', schedule_name=>'schedule1');
 create_job 
------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job('job1', true, false, 'STOP_ON_FIRST_ERROR');
 drop_job 
----------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_schedule('schedule1');
 drop_schedule 
---------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_program('program1', false);
 drop_program 
--------------

(1 row)

The TRANSACTIONAL option in commit_semantic takes effect only when force is set to false.

Deletes a scheduled task. The operation is performed only when the task is synchronized.

The prototype of the DBE_SCHEDULER.DROP_SINGLE_JOB function is as follows:

1
2
3
4
5

DBE_SCHEDULER.drop_single_job(
job_name text,
force boolean                           default false,
defer boolean                           default false
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_program('program1', 'STORED_PROCEDURE', 'select pg_sleep(1);', 0, false, 'test');
 create_program 
----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.create_job('job1', 'program1', '2021-07-20', 'interval ''3 minute''', '2121-07-20', 'DEFAULT_JOB_CLASS', false, false,'test', 'style', NULL, NULL);
 create_job 
------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_single_job('job1', false, false);
 drop_single_job 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_program('program1', false);
 drop_program 
--------------

(1 row)

Modifies the attributes of a scheduled task.

The prototypes of the DBE_SCHEDULER.SET_ATTRIBUTE function are as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

DBE_SCHEDULER.set_attribute(
name                    text,
attribute               text,
value                   boolean
)

DBE_SCHEDULER.set_attribute(
name                    text,
attribute               text,
value                   text
)

DBE_SCHEDULER.set_attribute(
name                    text,
attribute               text,
value                   timestamp
)

DBE_SCHEDULER.set_attribute(
name                    text,
attribute               text,
value                   timestamp with time zone
)

DBE_SCHEDULER.set_attribute(
name text,
attribute text,
value text,
value2 text                             default NULL
)

name specifies any object in DBE_SCHEDULER.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

gaussdb=# CALL DBE_SCHEDULER.create_program('program1', 'STORED_PROCEDURE', 'select pg_sleep(1);', 3, false, 'test');
 create_program 
----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.set_attribute('program1', 'number_of_arguments', 0);
 set_attribute 
---------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.set_attribute('program1', 'program_type', 'STORED_PROCEDURE');
 set_attribute 
---------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_program('program1', false);
 drop_program 
--------------

(1 row)

Do not use DBE_SCHEDULER.SET_ATTRIBUTE to leave the parameters empty.

The object name cannot be changed using DBE_SCHEDULER.SET_ATTRIBUTE.

Inline objects cannot be changed by DBE_SCHEDULER.SET_ATTRIBUTE.

Executes a scheduled task.

The prototype of the DBE_SCHEDULER.RUN_JOB function is as follows:

1
2
3
4

DBE_SCHEDULER.run_job(
job_name text,
use_current_session boolean             default true
)

DBE_SCHEDULER.RUN_JOB is used to run scheduled tasks immediately. It is independent of the scheduling of scheduled tasks and can even run at the same time.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

gaussdb=# SELECT dbe_scheduler.create_job('job1','PLSQL_BLOCK','begin insert into test1 values(12); end;',0,null,null,null,'DEFAULT_JOB_CLASS',false,false,null,null,null);
 create_job 
------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.run_job('job1', false);
 run_job 
---------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job('job1', true, false, 'STOP_ON_FIRST_ERROR');
 drop_job 
----------

(1 row)

Currently, use_current_session applies only to scheduled tasks whose job_type is set to EXTERNAL_SCRIPT.

Runs a scheduled task in the background.

The prototype of the DBE_SCHEDULER.RUN_BACKEND_JOB function is as follows:

1
2
3

DBE_SCHEDULER.run_backend_job(
job_name text
)

Example:

gaussdb=# SELECT dbe_scheduler.create_job('job1','PLSQL_BLOCK','begin insert into test1 values(12); end;',0,null,null,null,'DEFAULT_JOB_CLASS',false,false,null,null,null);
 create_job 
------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.run_backend_job('job1');
 run_backend_job 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job('job1', true, false, 'STOP_ON_FIRST_ERROR');
 drop_job 
----------

(1 row)

Executes a scheduled task in the current session.

Only external tasks can be executed.

Return value: text

The prototype of the DBE_SCHEDULER.RUN_FOREGROUND_JOB function is as follows:

1
2
3

DBE_SCHEDULER.run_foreground_job(
job_name text
)return text

Example:

gaussdb=# create user test1 identified by '*********';
NOTICE:  The encrypted password contains MD5 ciphertext, which is not secure.
CREATE ROLE
gaussdb=# select DBE_SCHEDULER.create_credential('cre_1', 'test1', '*********');
 create_credential 
-------------------

(1 row)

gaussdb=# select DBE_SCHEDULER.create_job(job_name=>'job1', job_type=>'EXTERNAL_SCRIPT', job_action=>'/usr/bin/pwd', enabled=>true, auto_drop=>false, credential_name => 'cre_1');
 create_job 
------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.run_foreground_job('job1');
  run_foreground_job
---------------------------------
 Host key verification failed.\r+

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job('job1', true, false, 'STOP_ON_FIRST_ERROR');
 drop_job 
----------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_credential('cre_1', false);
 drop_credential 
-----------------

(1 row)

gaussdb=# drop user test1;
DROP ROLE

Stops a scheduled task.

The prototype of the DBE_SCHEDULER.STOP_JOB function is as follows:

1
2
3
4
5

DBE_SCHEDULER.stop_job(
job_name text,
force boolean                           default false,
commit_semantics text                   default 'STOP_ON_FIRST_ERROR'
)

Example:

gaussdb=# SELECT dbe_scheduler.create_job('job1','PLSQL_BLOCK','begin insert into test1 values(12); end;',0,null,null,null,'DEFAULT_JOB_CLASS',false,false,null,null,null);
 create_job 
------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.stop_job('job1', true, 'STOP_ON_FIRST_ERROR');
 stop_job 
----------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job('job1', true, false, 'STOP_ON_FIRST_ERROR');
 drop_job 
----------

(1 row)

Stops a single scheduled task.

The prototype of the DBE_SCHEDULER.STOP_SINGLE_JOB function is as follows:

1
2
3
4

DBE_SCHEDULER.stop_single_job(
job_name text,
force boolean                           default false
)

Example:

gaussdb=# SELECT dbe_scheduler.create_job('job1','PLSQL_BLOCK','begin insert into test1 values(12); end;',0,null,null,null,'DEFAULT_JOB_CLASS',false,false,null,null,null);
 create_job 
------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.stop_single_job('job1', true);
 stop_single_job 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job('job1', true, false, 'STOP_ON_FIRST_ERROR');
 drop_job 
----------

(1 row)

Generates the name of a scheduled task.

The prototype of the DBE_SCHEDULER.GENERATE_JOB_NAME function is as follows:

1
2
3

DBE_SCHEDULER.generate_job_name(
prefix text                             default 'JOB$_'
)return text

Example:

gaussdb=# CALL DBE_SCHEDULER.generate_job_name();
 generate_job_name 
-------------------
 JOB$_1
(1 row)

gaussdb=# CALL DBE_SCHEDULER.generate_job_name();
 generate_job_name 
-------------------
 JOB$_2
(1 row)

gaussdb=# CALL DBE_SCHEDULER.generate_job_name('job');
 generate_job_name 
-------------------
 job3
(1 row)

gaussdb=# CALL DBE_SCHEDULER.generate_job_name('job');
 generate_job_name 
-------------------
 job4
(1 row)

When DBE_SCHEDULER.GENERATE_JOB_NAME is executed for the first time, a temporary sequence is created in public to store the sequence number of the current name. A common user does not have the create permission in public. Therefore, if a common user calls the function for the first time in the current database, the function fails to be called. In this case, you need to grant the create permission in public to the common user or call the API as a user with the create permission to create a temporary sequence.

Creates a program and synchronizes it to all CNs.

The prototype of the DBE_SCHEDULER.CREATE_PROGRAM function is as follows:

1
2
3
4
5
6
7
8

DBE_SCHEDULER.create_program(
program_name text,
program_type text,
program_action text,
number_of_arguments integer             default 0,
enabled boolean                         default false,
comments text                           default NULL
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_program('program1', 'STORED_PROCEDURE', 'select pg_sleep(1);', 3, false, 'test');
 create_program 
----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_program('program1', false);
 drop_program 
--------------

(1 row)

Defines program parameters. The operation is performed only when the program is synchronized.

An API with the default value default_value will not convert characters to lowercase letters by default. In this version, characters are case sensitive.

The prototype of the DBE_SCHEDULER.DEFINE_PROGRAM_ARGUMENT function is as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

DBE_SCHEDULER.define_program_argument(
program_name text,
argument_position integer,
argument_name text                      default NULL,
argument_type text,
out_argument boolean                    default false
)

-- With a default value --
DBE_SCHEDULER.define_program_argument(
program_name text,
argument_position integer,
argument_name text                      default NULL,
argument_type text,
default_value text,
out_argument boolean                    default false
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_program('program1', 'STORED_PROCEDURE', 'select pg_sleep(1);', 2, false, 'test');
create_program 
----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.define_program_argument('program1', 1, 'pa1', 'type1', false);
 define_program_argument 
-------------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.define_program_argument('program1', 1, 'pa1', 'type1', 'value1', false);
 define_program_argument 
-------------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_program('program1', false);
 drop_program 
--------------

(1 row)

Deletes a program. The operation is performed only when the program is synchronized.

The prototype of the DBE_SCHEDULER.DROP_PROGRAM function is as follows:

1
2
3
4

DBE_SCHEDULER.drop_program(
program_name text,
force boolean                           default false
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_program('program1', 'STORED_PROCEDURE', 'select pg_sleep(1);', 2, false, 'test');
create_program 
----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_program('program1', false);
 drop_program 
--------------

(1 row)

Deletes a single program. The operation is performed only when the program is synchronized.

The prototype of the DBE_SCHEDULER.DROP_SINGLE_PROGRAM function is as follows:

1
2
3
4

DBE_SCHEDULER.drop_single_program(
program_name text,
force boolean                           default false
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_program('program1', 'STORED_PROCEDURE', 'select pg_sleep(1);', 2, false, 'test');
create_program 
----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_single_program('program1', false);
 drop_single_program 
---------------------

(1 row)

Sets the parameters of a scheduled task. The argument_value can be left empty. The operation is performed only when the task is synchronized.

The prototype of the DBE_SCHEDULER.SET_JOB_ARGUMENT_VALUE function is as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

DBE_SCHEDULER.set_job_argument_value(
job_name text,
argument_position integer,
argument_value text
)

DBE_SCHEDULER.set_job_argument_value(
job_name text,
argument_name text,
argument_value text
)

Example:

gaussdb=# CALL dbe_scheduler.create_job('job1','EXTERNAL_SCRIPT','begin insert into test1 values(12); end;',2,null,null,null,'DEFAULT_JOB_CLASS',false,false,null,null,null);
 create_job 
------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.set_job_argument_value('job1', 1, 'value1');
 set_job_argument_value 
------------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job('job1', true, false, 'STOP_ON_FIRST_ERROR');
 drop_job 
----------

(1 row)

Creates a schedule and synchronizes it to all CNs.

The prototype of the DBE_SCHEDULER.CREATE_SCHEDULE function is as follows:

1
2
3
4
5
6
7

DBE_SCHEDULER.create_schedule(
schedule_name text,
start_date timestamp with time zone     default NULL,
repeat_interval text,
end_date timestamp with time zone       default NULL,
comments text                           default NULL
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_schedule('schedule1', sysdate, 'sysdate + 3 / (24 * 60 * 60)', null, 'test1');
 create_schedule 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.create_schedule('schedule2', sysdate, 'FREQ=DAILY; BYHOUR=6;', null, 'test1');
 create_schedule 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.create_schedule('schedule3', sysdate, 'FREQ=DAILY; BYHOUR=6;');
 create_schedule 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_schedule('schedule1');
 drop_single_schedule 
----------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_schedule('schedule2', false);
 drop_single_schedule 
----------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_schedule('schedule3', true);
 drop_single_schedule 
----------------------

(1 row)

Deletes a schedule. The operation is performed only when the schedule is synchronized.

The prototype of the DBE_SCHEDULER.DROP_SCHEDULE function is as follows:

1
2
3
4

DBE_SCHEDULER.drop_schedule(
schedule_name text,
force boolean                           default false
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_schedule('schedule1', sysdate, 'sysdate + 3 / (24 * 60 * 60)', null, 'test1');
 create_schedule 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.create_schedule('schedule2', sysdate, 'FREQ=DAILY; BYHOUR=6;', null, 'test1');
 create_schedule 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.create_schedule('schedule3', sysdate, 'FREQ=DAILY; BYHOUR=6;');
 create_schedule 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_schedule('schedule1');
 drop_single_schedule 
----------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_schedule('schedule2', false);
 drop_single_schedule 
----------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_schedule('schedule3', true);
 drop_single_schedule 
----------------------

(1 row)

Deletes a single schedule. The operation is performed only when the schedule is synchronized.

The prototype of the DBE_SCHEDULER.DROP_SINGLE_SCHEDULE function is as follows:

1
2
3
4

DBE_SCHEDULER.drop_single_schedule(
schedule_name text,
force boolean                           default false
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_schedule('schedule1', sysdate, 'sysdate + 3 / (24 * 60 * 60)', null, 'test1');
 create_schedule 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.create_schedule('schedule2', sysdate, 'FREQ=DAILY; BYHOUR=6;', null, 'test1');
 create_schedule 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.create_schedule('schedule3', sysdate, 'FREQ=DAILY; BYHOUR=6;');
 create_schedule 
-----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_single_schedule('schedule1');
 drop_single_schedule 
----------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_single_schedule('schedule2', false);
 drop_single_schedule 
----------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_single_schedule('schedule3', true);
 drop_single_schedule 
----------------------

(1 row)

Creates a scheduled task class and synchronizes it to all CNs.

The prototype of the DBE_SCHEDULER.CREATE_JOB_CLASS function is as follows:

1
2
3
4
5
6
7
8

DBE_SCHEDULER.create_job_class(
job_class_name text,
resource_consumer_group text            default NULL,
service text                            default NULL,
logging_level integer                   default 0,
log_history integer                     default NULL,
comments text                           default NULL
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_job_class(job_class_name => 'jc1', resource_consumer_group => '123');
 create_job_class 
------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job_class('jc1', false);
 drop_job_class 
----------------

(1 row)

Deletes the class of a scheduled task. The operation is performed only when the scheduled task class is synchronized.

The prototype of the DBE_SCHEDULER.DROP_JOB_CLASS function is as follows:

1
2
3
4

DBE_SCHEDULER.drop_job_class(
job_class_name text,
force boolean                           default false
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_job_class(job_class_name => 'jc1', resource_consumer_group => '123');
 create_job_class 
------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job_class('jc1', false);
 drop_job_class 
----------------

(1 row)

Deletes the class of a single scheduled task. The operation is performed only when the scheduled task class is synchronized.

The prototype of the DBE_SCHEDULER.DROP_SINGLE_JOB_CLASS function is as follows:

1
2
3
4

DBE_SCHEDULER.drop_single_job_class(
job_class_name text,
force boolean                           default false
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_job_class(job_class_name => 'jc1', resource_consumer_group => '123');
 create_job_class 
------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_single_job_class('jc1', false);
 drop_single_job_class 
-----------------------

(1 row)

Grants the scheduled task permissions to the database user. The user who calls this function must have the SYSADMIN permission. Then, it is synchronized to all CNs.

The prototype of the DBE_SCHEDULER.GRANT_USER_AUTHORIZATION function is as follows:

1
2
3
4

DBE_SCHEDULER.grant_user_authorization(
username                text,
privilege               text
)

Example:

gaussdb=# create user user1 password '1*s*****';
NOTICE:  The encrypted password contains MD5 ciphertext, which is not secure.
CREATE ROLE
gaussdb=# CALL DBE_SCHEDULER.grant_user_authorization('user1', 'create job');
 grant_user_authorization 
--------------------------

(1 row)
gaussdb=# drop user user1;
DROP ROLE

Revokes the scheduled task permissions from the database user. The user who calls this function must have the SYSADMIN permission. The operation is performed only when the permission granting is synchronized.

The prototype of the DBE_SCHEDULER.REVOKE_USER_AUTHORIZATION function is as follows:

1
2
3
4

DBE_SCHEDULER.revoke_user_authorization(
username                text,
privilege               text
)

Example:

gaussdb=# create user user1 password '1*s*****';
NOTICE:  The encrypted password contains MD5 ciphertext, which is not secure.
CREATE ROLE
gaussdb=# CALL DBE_SCHEDULER.grant_user_authorization('user1', 'create job');
 grant_user_authorization 
--------------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.revoke_user_authorization('user1', 'create job');
 revoke_user_authorization 
---------------------------

(1 row)
gaussdb=# drop user user1;
DROP ROLE

Creates an authorization certificate. The user who calls this function must have the SYSADMIN permission. Then, it is synchronized to all CNs.

The prototype of the DBE_SCHEDULER.CREATE_CREDENTIAL function is as follows:

1
2
3
4
5
6
7
8

DBE_SCHEDULER.create_credential(
credential_name         text,
username                text,
password                text            default NULL,
database_role           text            default NULL,
windows_domain          text            default NULL,
comments                text            default NULL
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_credential('cre_1', 'user1', '');
 create_credential 
-------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_credential('cre_1', false);
 drop_credential 
-----------------

(1 row)

The password parameter of DBE_SCHEDULER.CREATE_CREDENTIAL must be set to NULL or '******'. This parameter is used only for compatibility and does not indicate any actual meaning. Do not use the OS username corresponding to the installation user to create a certificate.

Destroys an authorization certificate. The user who calls this function must have the SYSADMIN permission. The operation is performed only when the certificate is synchronized.

The prototype of the DBE_SCHEDULER.DROP_CREDENTIAL function is as follows:

1
2
3
4

DBE_SCHEDULER.drop_credential(
credential_name         text,
force boolean default false
)

Example:

gaussdb=# CALL DBE_SCHEDULER.create_credential('cre_1', 'user1', '');
 create_credential 
-------------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_credential('cre_1', false);
 drop_credential 
-----------------

(1 row)

Enables objects and synchronizes them to all CNs.

The prototype of the DBE_SCHEDULER.ENABLE function is as follows:

1
2
3
4

DBE_SCHEDULER.enable(
name text,
commit_semantics text                   default 'STOP_ON_FIRST_ERROR'
)

Example:

gaussdb=# CALL dbe_scheduler.create_job('job1','PLSQL_BLOCK','begin insert into test1 values(12); end;',0,null,null,null,'DEFAULT_JOB_CLASS',false,false,null,null,null);
lse, 'test');
 create_job 
------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.create_program('program1', 'stored_procedure', 'insert into tb_job_test(key) values(null);', 0, false, '');
 create_program 
----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.enable('job1');
 enable 
--------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.enable('program1', 'STOP_ON_FIRST_ERROR');
 enable 
--------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job('job1', true, false, 'STOP_ON_FIRST_ERROR');
 drop_job 
----------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_program('program1', false);
 drop_program 
--------------

(1 row)

Enables a single object and synchronizes it to all CNs.

The prototype of the DBE_SCHEDULER.ENABLE_SINGLE function is as follows:

1
2
3

DBE_SCHEDULER.enable_single(
name text
)

Example:

gaussdb=# CALL dbe_scheduler.create_job('job1','PLSQL_BLOCK','begin insert into test1 values(12); end;',0,null,null,null,'DEFAULT_JOB_CLASS',false,false,null,null,null);
lse, 'test');
 create_job 
------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.enable_single('job1');
 enable_single 
---------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job('job1', true, false, 'STOP_ON_FIRST_ERROR');
 drop_job 
----------

(1 row)

Disables multiple objects. The value of name is a character string separated by commas (,). Each character string separated by commas (,) is an object. Operations are synchronized only when operation synchronization is enabled.

The prototype of the DBE_SCHEDULER.DISABLE function is as follows:

1
2
3
4
5

DBE_SCHEDULER.disable(
name text,
force boolean                           default false,
commit_semantics text                   default 'STOP_ON_FIRST_ERROR'
)

Example:

gaussdb=# CALL dbe_scheduler.create_job('job1','PLSQL_BLOCK','begin insert into test1 values(12); end;',0,null,null,null,'DEFAULT_JOB_CLASS',false,false,null,null,null);
 create_job 
------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.create_program('program1', 'stored_procedure', 'insert into tb_job_test(key) values(null);', 0, false, '');
 create_program 
----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.disable('job1');
 disable 
---------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.disable('program1', false, 'STOP_ON_FIRST_ERROR');
 disable 
---------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job('job1', true, false, 'STOP_ON_FIRST_ERROR');
 drop_job 
----------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_program('program1', false);
 drop_program 
--------------

(1 row)

Disables a single object. Operations are synchronized only when operation synchronization is enabled.

The prototype of the DBE_SCHEDULER.DISABLE_SINGLE function is as follows:

1
2
3
4

DBE_SCHEDULER.disable_single(
name text,
force boolean                           default false
)

Example:

gaussdb=# CALL dbe_scheduler.create_job('job1','PLSQL_BLOCK','begin insert into test1 values(12); end;',0,null,null,null,'DEFAULT_JOB_CLASS',false,false,null,null,null);
 create_job 
------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.disable_single('job1', false);
 disable_single 
----------------

(1 row)

gaussdb=# CALL DBE_SCHEDULER.drop_job('job1', true, false, 'STOP_ON_FIRST_ERROR');
 drop_job 
----------

(1 row)

Analyzes the scheduling task period.

Return type: timestamp with time zone

The prototype of the DBE_SCHEDULER.EVAL_CALENDAR_STRING function is as follows:

1
2
3
4
5

DBE_SCHEDULER.evaluate_calendar_string(
IN calendar_string text,
IN start_date timestamp with time zone,
IN return_date_after timestamp with time zone
)return timestamp with time zone

Example:

gaussdb=# CALL DBE_SCHEDULER.eval_calendar_string('FREQ=DAILY; BYHOUR=6;', sysdate, sysdate);
  eval_calendar_string  
------------------------
 2023-09-15 06:47:24+08
(1 row)

Analyzes the scheduling task period.

Return type: timestamp with time zone

The prototype of the DBE_SCHEDULER.EVALUATE_CALENDAR_STRING function is as follows:

1
2
3
4
5
6

DBE_SCHEDULER.evaluate_calendar_string(
IN calendar_string text,
IN start_date timestamp with time zone,
IN return_date_after timestamp with time zone,
OUT next_run_date timestamp with time zone
)return timestamp with time zone

Example:

gaussdb=# CREATE OR REPLACE PROCEDURE pr1(calendar_str text) as
DECLARE
    start_date        timestamp with time zone;
    return_date_after timestamp with time zone;
    next_run_date     timestamp with time zone;
BEGIN
    start_date := '2003-2-1 10:30:00.111111+8'::timestamp with time zone;
    return_date_after := start_date;
    DBE_SCHEDULER.evaluate_calendar_string(
        calendar_str,
        start_date, return_date_after, next_run_date);
    DBE_OUTPUT.PRINT_LINE('next_run_date: ' || next_run_date);
    return_date_after := next_run_date;
END;
/
CREATE PROCEDURE

gaussdb=# CALL pr1('FREQ=hourly;INTERVAL=2;BYHOUR=6,10;BYMINUTE=0;BYSECOND=0');
next_run_date: 2003-02-02 06:00:00+08
 pr1 
-----

(1 row)