PL/SQL API jcs.submit
Summary
- procedure submit(name in varchar2, queue_name in varchar2, starttime in varchar2, time_window_name in varchar2, submit_frame_name in varchar2, priority in number, queue_partition in varchar2, time_window_partition in varchar2, submit_frame_partition in varchar2, os_user in varchar2)
- function submit(name in varchar2, queue_name in varchar2, starttime in varchar2, time_window_name in varchar2, submit_frame_name in varchar2, priority in number, queue_partition in varchar2, time_window_partition in varchar2, submit_frame_partition in varchar2, os_user in varchar2) return number
- procedure submit(name in varchar2, queue_name in varchar2, starttime in date, time_window_name in varchar2, submit_frame_name in varchar2, priority in number, queue_partition in varchar2, time_window_partition in varchar2, submit_frame_partition in varchar2, os_user in varchar2)
- function submit(name in varchar2, queue_name in varchar2, starttime in date, time_window_name in varchar2, submit_frame_name in varchar2, priority in number, queue_partition in varchar2, time_window_partition in varchar2, submit_frame_partition in varchar2, os_user in varchar2) return number
- procedure submit(name in varchar2, queue_name in varchar2, starttime in timestamp with time zone, time_window_name in varchar2, submit_frame_name in varchar2, priority in number, queue_partition in varchar2, time_window_partition in varchar2, submit_frame_partition in varchar2, os_user in varchar2) (os_user parameter unsupported.)
- function submit(name in varchar2, queue_name in varchar2, starttime in timestamp with time zone, time_window_name in varchar2, submit_frame_name in varchar2, priority in number, queue_partition in varchar2, time_window_partition in varchar2, submit_frame_partition in varchar2, os_user in varchar2) return number (os_user parameter unsupported.)
- procedure submit(name in varchar2, job_id in out number) (Unsupported)
Schedule a job execution of a script.
Data that is stored in the submit buffer is validated and stored in the repository, but not committed.
The job will only be seen by the system when the transaction is committed. This atomic behaviour is so you can perform other database actions in the same transaction. If you want a job to be submitted outside your current transaction, use jcs.run.
The submit parameters queue_name, starttime, time_window_name, submit_window_name and priority are all optional and dependent on licensing restrictions. They can also be set using jcs.parameter.
note
Some parameters can be set with jcs.submit, however, all can be set with jcs.parameter. If in doubt, use jcs.parameter to set parameters. The only exception is "Force scheduler" (pin to scheduler), use jcs.job_pin_to_scheduler for that.
Privileges
You must have the SUBMIT privilege. You must have EXECUTE privilege on the script or EXECUTE ANY PROCEDURE system privilege. You must have INSERT privilege on the queue or USE_ANY_QUEUE system privilege. If a submit frame is used, you must have SELECT privilege on the submit frame or USE_ANY_SUBMIT_FRAME system privilege. If a time window is used, you must have SELECT privilege on the time window or USE_ANY_TIME_WINDOW system privilege.
Specification
procedure submit(name in varchar2,
queue_name in varchar2 default const.def_str,
starttime in varchar2,
time_window_name in varchar2 default const.def_str,
submit_frame_name in varchar2 default const.def_str,
priority in number default const.def_num,
queue_partition in varchar2 default null,
time_window_partition in varchar2 default null,
submit_frame_partition in varchar2 default null,
os_user in varchar2 default const.def_str)
Submit a job.
Parameters
- name - object name (script_name, owner.script_name, or destination_name), possibly with double quotes to specify lower case identifiers
- queue_name - the name of the queue that the job should run in
- starttime - requested first execution time
- time_window_name - the name of the time window that the job should start in
- submit_frame_name - the name of the submit frame that decides how to repeat the job
- priority - priority 1-100, higher has precedence; only has relevance if the resources or queue size is limited
- queue_partition - the partition of the queue that the job should run in If it is not filled in the default partition is assumed
- time_window_partition - the partition of the time window that the job should start in If it is not filled in the default partition is assumed
- submit_frame_partition - the partition of the submit frame that decides how to repeat the job If it is not filled in the default partition is assumed
- os_user - the name of the OS user under which the job should run
Transaction keyword
The transaction keyword defines how and/or when the changes are committed to the database. A definition of the various transaction keywords can be found on the jcs package summary page.
database_modified
Specification
function submit(name in varchar2,
queue_name in varchar2 default const.def_str,
starttime in varchar2,
time_window_name in varchar2 default const.def_str,
submit_frame_name in varchar2 default const.def_str,
priority in number default const.def_num,
queue_partition in varchar2 default null,
time_window_partition in varchar2 default null,
submit_frame_partition in varchar2 default null,
os_user in varchar2 default const.def_str)
return number
Submit a job and return the job_id of the job that was created.
Parameters
- name - object name (script_name, owner.script_name, or destination_name), possibly with double quotes to specify lower case identifiers
- queue_name - the name of the queue that the job should run in
- starttime - requested first execution time
- time_window_name - the name of the time window that the job should start in
- submit_frame_name - the name of the submit frame that decides how to repeat the job
- priority - priority 1-100, higher has precedence; only has relevance if the resources or queue size is limited
- queue_partition - the partition of the queue that the job should run in If it is not filled in the default partition is assumed
- time_window_partition - the partition of the time window that the job should start in If it is not filled in the default partition is assumed
- submit_frame_partition - the partition of the submit frame that decides how to repeat the job If it is not filled in the default partition is assumed
- os_user - the name of the OS user under which the job should run
- returns number - the job id of the created job.
Specification
procedure submit(name in varchar2,
queue_name in varchar2 default const.def_str,
starttime in date,
time_window_name in varchar2 default const.def_str,
submit_frame_name in varchar2 default const.def_str,
priority in number default const.def_num,
queue_partition in varchar2 default null,
time_window_partition in varchar2 default null,
submit_frame_partition in varchar2 default null,
os_user in varchar2 default const.def_str)
Submit a job and return the job_id of the job that was created.
Parameters
- name - object name (script_name, owner.script_name, or destination_name), possibly with double quotes to specify lower case identifiers
- queue_name - the name of the queue that the job should run in
- starttime - requested first execution time
- time_window_name - the name of the time window that the job should start in
- submit_frame_name - the name of the submit frame that decides how to repeat the job
- priority - priority 1-100, higher has precedence; only has relevance if the resources or queue size is limited
- queue_partition - the partition of the queue that the job should run in If it is not filled in the default partition is assumed
- time_window_partition - the partition of the time window that the job should start in If it is not filled in the default partition is assumed
- submit_frame_partition - the partition of the submit frame that decides how to repeat the job If it is not filled in the default partition is assumed
- os_user - the name of the OS user under which the job should run
Specification
function submit(name in varchar2,
queue_name in varchar2 default const.def_str,
starttime in date,
time_window_name in varchar2 default const.def_str,
submit_frame_name in varchar2 default const.def_str,
priority in number default const.def_num,
queue_partition in varchar2 default null,
time_window_partition in varchar2 default null,
submit_frame_partition in varchar2 default null,
os_user in varchar2 default const.def_str)
return number
Submit a job and return the job_id of the job that was created.
Parameters
- name - object name (script_name, owner.script_name, or destination_name), possibly with double quotes to specify lower case identifiers
- queue_name - the name of the queue that the job should run in
- starttime - requested first execution time
- time_window_name - the name of the time window that the job should start in
- submit_frame_name - the name of the submit frame that decides how to repeat the job
- priority - priority 1-100, higher has precedence; only has relevance if the resources or queue size is limited
- queue_partition - the partition of the queue that the job should run in If it is not filled in the default partition is assumed
- time_window_partition - the partition of the time window that the job should start in If it is not filled in the default partition is assumed
- submit_frame_partition - the partition of the submit frame that decides how to repeat the job If it is not filled in the default partition is assumed
- os_user - the name of the OS user under which the job should run
- returns number - the job id of the created job.
Specification
procedure submit(name in varchar2,
queue_name in varchar2 default const.def_str,
starttime in timestamp with time zone default const.def_tstamp,
time_window_name in varchar2 default const.def_str,
submit_frame_name in varchar2 default const.def_str,
priority in number default const.def_num,
queue_partition in varchar2 default null,
time_window_partition in varchar2 default null,
submit_frame_partition in varchar2 default null,
os_user in varchar2 default const.def_str)
Submit a job and return the job_id of the job that was created.
Parameters
- name - object name (script_name, owner.script_name, or destination_name), possibly with double quotes to specify lower case identifiers
- queue_name - the name of the queue that the job should run in
- starttime - requested first execution time
- time_window_name - the name of the time window that the job should start in
- submit_frame_name - the name of the submit frame that decides how to repeat the job
- priority - priority 1-100, higher has precedence; only has relevance if the resources or queue size is limited
- queue_partition - the partition of the queue that the job should run in If it is not filled in the default partition is assumed
- time_window_partition - the partition of the time window that the job should start in If it is not filled in the default partition is assumed
- submit_frame_partition - the partition of the submit frame that decides how to repeat the job If it is not filled in the default partition is assumed
- os_user - the name of the OS user under which the job should run
Specification
function submit(name in varchar2,
queue_name in varchar2 default const.def_str,
starttime in timestamp with time zone default const.def_tstamp,
time_window_name in varchar2 default const.def_str,
submit_frame_name in varchar2 default const.def_str,
priority in number default const.def_num,
queue_partition in varchar2 default null,
time_window_partition in varchar2 default null,
submit_frame_partition in varchar2 default null,
os_user in varchar2 default const.def_str)
return number
Submit a job and return the job_id of the job that was created.
Parameters
- name - object name (script_name, owner.script_name, or destination_name), possibly with double quotes to specify lower case identifiers
- queue_name - the name of the queue that the job should run in
- starttime - requested first execution time
- time_window_name - the name of the time window that the job should start in
- submit_frame_name - the name of the submit frame that decides how to repeat the job
- priority - priority 1-100, higher has precedence; only has relevance if the resources or queue size is limited
- queue_partition - the partition of the queue that the job should run in If it is not filled in the default partition is assumed
- time_window_partition - the partition of the time window that the job should start in If it is not filled in the default partition is assumed
- submit_frame_partition - the partition of the submit frame that decides how to repeat the job If it is not filled in the default partition is assumed
- os_user - the name of the OS user under which the job should run
- returns number - the job id of the created job.
See Also
plsqlTopic
onsiteTopic