Procedures that are supplied with DB2

A procedure is an application program that can be started through the SQL CALL statement. The procedure is specified by a procedure name, which may be followed by arguments that are enclosed within parentheses. This information contains syntax diagrams, semantic descriptions, rules, and examples of the use of the system supplied procedures.

Important: Do not create additional versions of DB2®-supplied procedures by specifying the VERSION keyword. Only versions that are supplied with DB2 are supported. Additional versions of such routines cause the installation and configuration of DB2-supplied routines to fail.

ADMIN_COMMAND_DB2 stored procedure
The SYSPROC.ADMIN_COMMAND_DB2 stored procedure executes one or more DB2 commands on a connected DB2 subsystem, or on a DB2 data sharing group member. This stored procedure also returns the command output messages.
ADMIN_COMMAND_DSN stored procedure
The SYSPROC.ADMIN_COMMAND_DSN stored procedure executes a BIND, REBIND, or FREE DSN subcommand and returns the output from the DSN subcommand execution.
ADMIN_COMMAND_MVS stored procedure
The SYSPROC.ADMIN_COMMAND_MVS stored procedure issues the QUERY COPYPOOL, LIST COPYPOOL, DB2 START, DB2 STOP, DUMP, or DISPLAY WLM command.
ADMIN_COMMAND_UNIX stored procedure
The SYSPROC.ADMIN_COMMAND_UNIX stored procedure executes a z/OS® UNIX System Services command and returns the output.
ADMIN_DS_BROWSE stored procedure
The SYSPROC.ADMIN_DS_BROWSE stored procedure returns either text or binary records from certain data sets or their members. You can browse a physical sequential (PS) data set, a generation data set, a partitioned data set (PDS) member, or a partitioned data set extended (PDSE) member. This stored procedure supports only data sets with LRECL=80 and RECFM=FB.
ADMIN_DS_DELETE stored procedure
The SYSPROC.ADMIN_DS_DELETE stored procedure deletes certain data sets or their members. You can delete a physical sequential (PS) data set, a partitioned data set (PDS), a partitioned data set extended (PDSE), a generation data set (GDS), or a member of a PDS or PDSE.
ADMIN_DS_LIST stored procedure
The SYSPROC.ADMIN_DS_LIST stored procedure returns a list of data set names, a generation data group (GDG), a partitioned data set (PDS) member, a partitioned data set extended (PDSE) member, or generation data sets of a GDG.
ADMIN_DS_RENAME stored procedure
The SYSPROC.ADMIN_DS_RENAME stored procedure renames a physical sequential (PS) data set, a partitioned data set (PDS), a partitioned data set extended (PDSE), or a member of a PDS or PDSE.
ADMIN_DS_SEARCH stored procedure
The SYSPROC.ADMIN_DS_SEARCH stored procedure determines if certain data sets are cataloged, or if a library member of a cataloged data set exists. You can search for a physical sequential (PS) data set, a partitioned data set (PDS), a partitioned data set extended (PDSE), a generation data group (GDG), a generation data set (GDS), or the library member of a cataloged PDS or PDSE.
ADMIN_DS_WRITE stored procedure
The SYSPROC.ADMIN_DS_WRITE stored procedure writes either text or binary records that are passed in a global temporary table to data sets or their members. You can write to a physical sequential (PS) data set, a partitioned data set (PDS) member, a partitioned data set extended (PDSE) member, or a generation data set (GDS).
ADMIN_INFO_HOST stored procedure
The SYSPROC.ADMIN_INFO_HOST stored procedure returns the host name of a connected DB2 subsystem or the host name of every member of a data sharing group.
ADMIN_INFO_SMS stored procedure
The ADMIN_INFO_SMS stored procedure returns space information about copy pools and their storage groups and volumes.
ADMIN_INFO_SSID stored procedure
The SYSPROC.ADMIN_INFO_SSID stored procedure returns the name of the connected DB2 subsystem.
ADMIN_INFO_SQL stored procedure
The ADMIN_INFO_SQL stored procedure captures statistics about a DB2 subsystem, its objects, and applications and returns the results in a data set or as a result set. This information can help IBM® Software Support re-create and troubleshoot problems, such as a poorly performing SQL query.
ADMIN_INFO_SYSLOG stored procedure
The ADMIN_INFO_SYSLOG stored procedure returns system log entries. You can specify filters, such as search string, system name, begin date and time, end date and time, and maximum number of entries, to limit the number of system log entries that are returned.
ADMIN_INFO_SYSPARM stored procedure
The SYSPROC.ADMIN_INFO_SYSPARM stored procedure returns the system parameters, application defaults module, and IRLM parameters of a connected DB2 subsystem, or member of its data sharing group.
ADMIN_JOB_CANCEL stored procedure
The SYSPROC.ADMIN_JOB_CANCEL stored procedure purges or cancels a job.
ADMIN_JOB_FETCH stored procedure
The SYSPROC.ADMIN_JOB_FETCH stored procedure retrieves SYSOUT from JES spool and returns the SYSOUT.
ADMIN_JOB_QUERY stored procedure
The SYSPROC.ADMIN_JOB_QUERY stored procedure displays the status and completion information about a job.
ADMIN_JOB_SUBMIT stored procedure
The SYSPROC.ADMIN_JOB_SUBMIT stored procedure submits a job to a JES2 or JES3 system.
ADMIN_TASK_ADD stored procedure
The SYSPROC.ADMIN_TASK_ADD stored procedure adds a task to the task list of the administrative task scheduler.
ADMIN_TASK_CANCEL stored procedure
The ADMIN_TASK_CANCEL stored procedure attempts to stop the execution of a task that is currently running.
ADMIN_TASK_REMOVE stored procedure
The SYSPROC.ADMIN_TASK_REMOVE stored procedure removes a task from the task list of the administrative task scheduler.
ADMIN_TASK_UPDATE stored procedure
The ADMIN_TASK_UPDATE stored procedure updates the schedule of a task that is in the task list for the administrative task scheduler. If the task that you want to update is running, the changes go into effect after the current execution finishes.
ADMIN_UPDATE_SYSPARM stored procedure
The SYSPROC.ADMIN_UPDATE_SYSPARM stored procedure changes the value of one or more subsystem parameters which are located in one of these macros: DSN6SPRM, DSN6ARVP, DSN6LOGP, DSN6SYSP, DSN6FAC, and DSN6GRP.
ADMIN_UTL_EXECUTE stored procedure
ADMIN_UTL_EXECUTE is a stored procedure that solves alerts stored in the SYSIBM.SYSAUTOALERTS catalog table within the maintenance windows defined by the SYSIBM.SYSAUTOTIMEWINDOWS catalog table. It is required for the use of autonomic statistics.
ADMIN_UTL_MONITOR stored procedure
SYSPROC.ADMIN_UTL_MONITOR is an autonomic stored procedure that provides functions that enable analysis of database statistics. These functions include alerts for out-of-date, missing, or conflicting statistics, summary reports and detailed table-level reports that describe generated RUNSTATS statements. It is required for the use of autonomic statistics.
ADMIN_UTL_MODIFY stored procedure
ADMIN_UTL_MODIFY is an autonomic stored procedure that maintains the SYSIBM.SYSAUTORUNS_HIST and SYSIBM.SYSAUTOALERTS catalog tables.
ADMIN_UTL_SCHEDULE stored procedure
The SYSPROC.ADMIN_UTL_SCHEDULE stored procedure executes utilities in parallel.
ADMIN_UTL_SORT stored procedure
The SYSPROC.ADMIN_UTL_SORT stored procedure sorts objects for parallel utility execution using JCL or the ADMIN_UTL_SCHEDULE stored procedure.
DSNACCOR stored procedure (deprecated)
The DB2 real-time statistics stored procedure (DSNACCOR) is a sample stored procedure that makes recommendations to help you maintain your DB2 databases. The DSNACCOR stored procedure is deprecated. It is replaced by the DSNACCOX stored procedure.
DSNACCOX stored procedure
The DB2 real-time statistics stored procedure (DSNACCOX) is a sample stored procedure that makes recommendations to help you maintain your DB2 databases.
DSNACICS stored procedure
The CICS® transaction invocation stored procedure (DSNACICS) invokes CICS server programs.
DSNAEXP stored procedure
The DB2 EXPLAIN stored procedure, DSNAEXP, is a sample stored procedure that enables you to execute an EXPLAIN statement for certain simple SQL statements without having the authorization to execute that SQL statement.This stored procedure is deprecated. Starting in DB2 10, use of the EXPLAIN privilege or SQLADM authority is recommended instead.
DSNAIMS stored procedure
DSNAIMS is a stored procedure that allows DB2 applications to invoke IMS™ transactions and commands easily, without maintaining their own connections to IMS.
DSNAIMS2 stored procedure
DSNAIMS2 is a stored procedure that allows DB2 applications to invoke IMS transactions and commands easily, without maintaining their own connections to IMS. DSNAIMS2 includes multi-segment input support for IMS transactions.
DSNLEUSR stored procedure
The DSNLEUSR stored procedure is a sample stored procedure. Use this stored procedure to store encrypted values in the translated authorization ID (NEWAUTHID) and password fields of the SYSIBM.USERNAMES table.
DSNUTILS stored procedure (deprecated)
The DSNUTILS stored procedure enables you use the SQL CALL statement to execute DB2 utilities from a DB2 application program that specifies EBCDIC input.
DSNUTILU stored procedure
Use the DSNUTILU stored procedure to run DB2 utilities from a DB2 application program.
DSN_WLM_APPLENV stored procedure
This procedure provides a convenient way to define, install, and activate a new WLM application environment for DB2.
GET_CONFIG stored procedure
The GET_CONFIG stored procedure retrieves data server configuration information.
GET_MESSAGE stored procedure
The GET_MESSAGE stored procedure returns the short message text for an SQLCODE.
GET_SYSTEM_INFO stored procedure
The GET_SYSTEM_INFO stored procedure returns system information about the data server.
SET_MAINT_MODE_RECORD_NO_TEMPORALHISTORY stored procedure
The SYSPROC.SET_MAINT_MODE_RECORD_NO_TEMPORALHISTORY stored procedure indicates that DB2 is to disable recording of temporal history for a system-period temporal table and allow an application to specify values for row-begin, row-end, and transaction-start-ID columns on subsequent operations.
SET_PLAN_HINT stored procedure
The SET_PLAN_HINT stored procedure validates, deploys, modifies, or deletes catalog tables rows that influence access path selection for SQL statements.
SQLJ.ALTER_JAVA_PATH stored procedure
SQLJ.ALTER_JAVA_PATH modifies the class resolution path of an installed JAR.
SQLJ.DB2_INSTALL_JAR stored procedure
SQLJ.DB2_INSTALL_JAR creates a new definition of a JAR file in the local DB2 catalog or in a remote DB2 catalog.
SQLJ.DB2_REPLACE_JAR stored procedure
SQLJ.DB2_REPLACE_JAR replaces an existing JAR file in the local DB2 catalog or in a remote DB2 catalog.
SQLJ.INSTALL_JAR stored procedure
SQLJ.INSTALL_JAR creates a new definition of a JAR file in the local DB2 catalog.
SQLJ.REMOVE_JAR stored procedure
SQLJ.REMOVE_JAR deletes a JAR file from the local DB2 catalog or from a remote DB2 catalog.
SQLJ.REPLACE_JAR stored procedure
SQLJ.REPLACE_JAR replaces an existing JAR file in the local DB2 catalog.
WLM_REFRESH stored procedure
The WLM_REFRESH stored procedure refreshes a WLM environment. This stored procedure can recycle the environment in which it runs and in any other WLM environment.
WLM_SET_CLIENT_INFO stored procedure
This procedure allows the caller to set client information that is associated with the current connection at the DB2 for z/OS server.
XSR_ADDSCHEMADOC stored procedure
The XSR_ADDSCHEMADOC stored procedure adds every XML schema, other than the primary XML schema document, to the XSR.
XSR_COMPLETE stored procedure
The XSR_COMPLETE procedure is the final stored procedure to be called as part of the XML schema registration process, which registers XML schemas with the XSR.
XSR_REGISTER stored procedure
The XSR_REGISTER procedure is the first stored procedure to be called as part of the XML schema registration process, which registers XML schemas with the XSR.
XSR_REMOVE stored procedure
The XSR_REMOVE procedure is used to remove all components of an XML schema. After the XML schema is removed, you can reuse the name of the removed XML schema when you register a new XML schema.

Parent topic: SQL: The language of DB2

Related concepts:

Procedures

Migration step 25: Configure DB2 for running stored procedures and user-defined functions (optional)

Common SQL API stored procedures

Installing DB2-supplied routines during installation

Implementing DB2 stored procedures

Related reference:

CALL statement

Installation information for procedures and functions that are supplied with DB2