Installation information for procedures and functions that are supplied with Db2

Db2 supplies a number of stored procedures and user defined functions that job DSNTIJRT defines and binds during installation or migration.

For supplied routines, job DSNTIJRW creates the core WLM environments that are listed in the following table. If you decide to set up your own WLM application environments, use the following table to help you group the supplied routines into the appropriate environments. If your system resources are constrained, you might need to choose a lower NUMTCB value than the recommended one.

For more information about each of the stored procedures that are provided with Db2, see Procedures that are supplied with Db2.

Supplied routine Schema name Recommended value of NUMTCB Core WLM environment Does the routine have to run in an APF-authorized environment? Does the routine have to be program- controlled?
ADMIN_COMMAND_DB2 SYSPROC 40–60 DSNWLM_GENERAL No No
ADMIN_COMMAND_DSN SYSPROC 1 DSNWLM_REXX No No
ADMIN_COMMAND_MVS SYSPROC 40–60 DSNWLM_GENERAL No No
ADMIN_COMMAND_UNIX SYSPROC 40–60 DSNWLM_PGM_CONTROL No Yes
ADMIN_DS_BROWSE SYSPROC 40–60 DSNWLM_GENERAL Yes No
ADMIN_DS_DELETE SYSPROC 40–60 DSNWLM_GENERAL Yes No
ADMIN_DS_LIST SYSPROC 40–60 DSNWLM_GENERAL Yes No
ADMIN_DS_RENAME SYSPROC 40–60 DSNWLM_GENERAL Yes No
ADMIN_DS_SEARCH SYSPROC 40–60 DSNWLM_GENERAL Yes No
ADMIN_DS_WRITE SYSPROC 40–60 DSNWLM_GENERAL Yes No
ADMIN_EXPLAIN_MAINT SYSPROC 40–60 DSNWLM_GENERAL No  
ADMIN_INFO_HOST SYSPROC 40–60 DSNWLM_GENERAL No No
ADMIN_INFO_IFCID SYSPROC 40–60 DSNWLM_GENERAL No No
ADMIN_INFO_SMS SYSPROC 40–60 DSNWLM_GENERAL Yes No
ADMIN_INFO_SQL SYSPROC 40–60 DSNWLM_GENERAL No No
ADMIN_INFO_SSID SYSPROC 40–60 DSNWLM_GENERAL No No
ADMIN_INFO_SYSLOG SYSPROC 1 DSNWLM_REXX No No
ADMIN_INFO_SYSPARM SYSPROC 1 DSNWLM_NUMTCB1 No No
ADMIN_JOB_CANCEL SYSPROC 40–60 DSNWLM_PGM_CONTROL Yes Yes
ADMIN_JOB_FETCH SYSPROC 40–60 DSNWLM_PGM_CONTROL Yes Yes
ADMIN_JOB_QUERY SYSPROC 40–60 DSNWLM_PGM_CONTROL Yes Yes
ADMIN_JOB_SUBMIT SYSPROC 40–60 DSNWLM_PGM_CONTROL No Yes
ADMIN_TASK_ADD SYSPROC 40–60 DSNWLM_GENERAL No No
ADMIN_TASK_CANCEL SYSPROC 40–60 DSNWLM_GENERAL No No
ADMIN_TASK_LIST DSNADM 40–60 DSNWLM_GENERAL No No
ADMIN_TASK_OUTPUT DSNADM 40–60 DSNWLM_GENERAL No No
ADMIN_TASK_REMOVE SYSPROC 40–60 DSNWLM_GENERAL No No
ADMIN_TASK_STATUS DSNADM 40–60 DSNWLM_GENERAL No No
ADMIN_TASK_UPDATE SYSPROC 40–60 DSNWLM_GENERAL No No
ADMIN_UPDATE_SYSPARM SYSPROC 1 DSNWLM_REXX No1 No
ADMIN_UTL_EXECUTE SYSPROC 40–60 DSNWLM_GENERAL Yes Yes
ADMIN_UTL_MODIFY SYSPROC 40–60 DSNWLM_GENERAL No No
ADMIN_UTL_MONITOR SYSPROC 40–60 DSNWLM_PGM_CONTROL Yes Yes
ADMIN_UTL_SCHEDULE SYSPROC 40–60 DSNWLM_GENERAL No No
ADMIN_UTL_SORT SYSPROC 40–60 DSNWLM_GENERAL No No
ALTER_JAVA_PATH SQLJ 40–60 DSNWLM_GENERAL No No
BSON2JSON SYSTOOLS 20 DSNWLM_GENERAL2 No No
CREATE_SESSION DB2DEBUG 5–20 DSNWLM_DEBUGGER No No
DB2_INSTALL_JAR SQLJ 40–60 DSNWLM_GENERAL No No
DB2_REMOVE_JAR SQLJ 40–60 DSNWLM_GENERAL No No
DB2_REPLACE_JAR SQLJ 40–60 DSNWLM_GENERAL No No
DB2_UPDATEJARINFO SQLJ 40–60 DSNWLM_GENERAL No No
DBG_ENDSESSIONMANAGER SYSPROC 5–20 DSNWLM_DEBUGGER No No
DBG_INITIALIZECLIENT SYSPROC 5–20 DSNWLM_DEBUGGER No No
DBG_LOOKUPSESSIONMANAGER SYSPROC 5–20 DSNWLM_DEBUGGER No No
DBG_PINGSESSIONMANAGER SYSPROC 5–20 DSNWLM_DEBUGGER No No
DBG_RECVCLIENTREPORTS SYSPROC 5–20 DSNWLM_DEBUGGER No No
DBG_RUNSESSIONMANAGER SYSPROC 40–60 DSNWLM_GENERAL No No
DBG_SENDCLIENTCOMMANDS SYSPROC 5–20 DSNWLM_DEBUGGER No No
DBG_SENDCLIENTREQUESTS SYSPROC 5–20 DSNWLM_DEBUGGER No No
DBG_TERMINATECLIENT SYSPROC 5–20 DSNWLM_DEBUGGER No No
DEBUGGERLEVEL DB2DEBUG 5–20 DSNWLM_DEBUGGER No No
DESTROY_SESSION DB2DEBUG 5–20 DSNWLM_DEBUGGER No No
DSN_WLM_APPLENV SYSPROC 40–60 DSNWLM_GENERAL No No
DSNACCOX SYSPROC 40–60 DSNWLM_GENERAL No No
DSNACICS SYSPROC 40 DSNWLM_CICS Yes No
DSNAHVPM SYSPROC 40–60 DSNWLM_GENERAL No No
DSNAIMS SYSPROC 40 DSNWLM_GENERAL Yes No
DSNAIMS2 SYSPROC 40 DSNWLM_GENERAL Yes No
DSNTBIND SYSPROC 1 DSNWLM_REXX No No
DSNLEUSR SYSPROC 1 DSNWLM_NUMTCB1 Yes No
DSNTPSMP SYSPROC 1 DSNWLM_REXX No1 No
DSNUTILS SYSPROC 1 DSNWLM_UTILS Yes No
DSNUTILU SYSPROC 1 DSNWLM_UTILS Yes No
DSNUTILV SYSPROC 1 DSNWLM_UTILS Yes No
DSNWSPM SYSPROC 1 DSNWLM_NUMTCB1 Yes No
DSNWZP SYSPROC 1 DSNWLM_NUMTCB1 Yes No
GET_CONFIG SYSPROC 40–60 DSNWLM_GENERAL No No
GET_MESSAGE SYSPROC 40–60 DSNWLM_GENERAL No No
GET_REPORT DB2DEBUG 5–20 DSNWLM_DEBUGGER No No
GET_SYSTEM_INFO SYSPROC 1 DSNWLM_NUMTCB1 Yes No
INSTALL_JAR SQLJ 40–60 DSNWLM_GENERAL No No
JSON2BSON SYSTOOLS 20 DSNWLM_GENERAL2 No No
JSON_LEN SYSTOOLS 40–60 DSNWLM_GENERAL No No
JSON_TABLE SYSTOOLS 40–60 DSNWLM_GENERAL No No
JSON_TYPE SYSTOOLS 40–60 DSNWLM_GENERAL No No
JSONVAL SYSIBM 40–60   No No
LIST_SESSION DB2DEBUG 5–20 DSNWLM_DEBUGGER No No
MQREAD DB2MQ ≥ 10 DSNWLM_MQSERIES No No
MQREADALL DB2MQ ≥ 10 DSNWLM_MQSERIES No No
MQREADALLCLOB DB2MQ ≥ 10 DSNWLM_MQSERIES No No
MQREADCLOB DB2MQ ≥ 10 DSNWLM_MQSERIES No No
MQRECEIVE DB2MQ ≥ 10 DSNWLM_MQSERIES No No
MQRECEIVEALL DB2MQ ≥ 10 DSNWLM_MQSERIES No No
MQRECEIVEALLCLOB DB2MQ ≥ 10 DSNWLM_MQSERIES No No
MQRECEIVECLOB DB2MQ ≥ 10 DSNWLM_MQSERIES No No
MQSEND DB2MQ ≥ 10 DSNWLM_MQSERIES No No
PUT_COMMAND DB2DEBUG 5–20 DSNWLM_DEBUGGER No No
QUERY_SESSION DB2DEBUG 5–20 DSNWLM_DEBUGGER No No
REMOVE_JAR SQLJ 40–60 DSNWLM_GENERAL No No
REPLACE_JAR SQLJ 40–60 DSNWLM_GENERAL No No
SET_PLAN_HINT SYSPROC 40–60 DSNWLM_GENERAL No No
SOAPHTTPC DB2XML ≥ 10 DSNWLM_WEBSERVICES No No
SOAPHTTPNC DB2XML ≥ 10 DSNWLM_WEBSERVICES No No
SOAPHTTPNV DB2XML ≥ 10 DSNWLM_WEBSERVICES No No
SOAPHTTPV DB2XML ≥ 10 DSNWLM_WEBSERVICES No No
SQLCAMESSAGE SYSIBM 40–60 DSNWLM_GENERAL No No
SQLCOLPRIVILEGES SYSIBM 40–60 DSNWLM_GENERAL No No
SQLCOLUMNS SYSIBM 40–60 DSNWLM_GENERAL No No
SQLFOREIGNKEYS SYSIBM 40–60 DSNWLM_GENERAL No No
SQLFUNCTIONCOLS SYSIBM 40–60 DSNWLM_GENERAL No No
SQLFUNCTIONS SYSIBM 40–60 DSNWLM_GENERAL No No
SQLGETTYPEINFO SYSIBM 40–60 DSNWLM_GENERAL No No
SQLPRIMARYKEYS SYSIBM 40–60 DSNWLM_GENERAL No No
SQLPROCEDURECOLS SYSIBM 40–60 DSNWLM_GENERAL No No
SQLPROCEDURES SYSIBM 40–60 DSNWLM_GENERAL No No
SQLPSEUDOCOLUMNS SYSIBM 40–60 DSNWLM_GENERAL No No
SQLSPECIALCOLUMNS SYSIBM 40–60 DSNWLM_GENERAL No No
SQLSTATISTICS SYSIBM 40–60 DSNWLM_GENERAL No No
SQLTABLEPRIVILEGES SYSIBM 40–60 DSNWLM_GENERAL No No
SQLTABLES SYSIBM 40–60 DSNWLM_GENERAL No No
SQLUDTS SYSIBM 40–60 DSNWLM_GENERAL No No
SYSTS_ALTER SYSPROC 10–40 DSNWLM_GENERAL No No
SYSTS_CREATE SYSPROC 10–40 DSNWLM_GENERAL No No
SYSTS_DROP SYSPROC 10–40 DSNWLM_GENERAL No No
SYSTS_ENCRYPT SYSFUN 2–83 DSNWLM_JAVA No No
SYSTS_RESTORE SYSPROC 10–40 DSNWLM_GENERAL No No
SYSTS_START SYSPROC 10–40 DSNWLM_GENERAL No No
SYSTS_STOP SYSPROC 10–40 DSNWLM_GENERAL No No
SYSTS_TAKEOVER SYSPROC 10–40 DSNWLM_GENERAL No No
SYSTS_UPDATE SYSPROC 10–40 DSNWLM_GENERAL No No
WLM_REFRESH SYSPROC 40–60 DSNWLM_GENERAL Yes No
WLM_SET_CLIENT_INFO SYSPROC > 1 DSNWLM_GENERAL No No
XSLTRANSFORM SYSFUN 2–83 DSNWLM_JAVA No No
XSR_ADDSCHEMADOC SYSPROC 40–60 DSNWLM_XML Yes No
XSR_COMPLETE SYSPROC 2–83 DSNWLM_JAVA No No
XSR_REGISTER SYSPROC 40–60 DSNWLM_XML Yes No
XSR_REMOVE SYSPROC 40–60 DSNWLM_XML Yes No

Notes:

  1. This routine cannot run in an APF-authorized environment.
  2. If you encounter storage-consumption issues for this routine, consider isolating it in a separate WLM environment. For more information, see Tuning routines with storage-consuming parameter lists.
  3. If you are running your Java™ stored procedures in 64-bit JVMs, the recommended NUMTCB is 25. You cannot run XSR_COMPLETE in a 64-bit Java virtual machine (JVM).

Routine setup information in DSNTIDxx

To install the Db2-supplied routines, job DSNTIJRT uses setup information that is stored in the CLIST defaults input member (DSNTIDxx). Each Db2-supplied routine is represented by a different name in DSNTIDxx. The following table shows the mapping between each DSNTIDxx name and Db2-supplied routine. The left column contains the DSNTIDxx name and the right column contains the routine name. The xxx in the DSNTIDxx names represent the letters that specify the WLM environment name, the grant execute list, and the package owner. For example, RTB01xxx represents RTB01WLM, RTB01ACL, and RTB01PKO.

Table 1. Mapping between DSNTIDxx variables and Db2-supplied routines
DSNTIDxx variable Stored procedure name
RTB01xxx DSNWSPM
RTB02xxx DSNWZP
RTC01xxx DSNUTILS
RTC02xxx DSNUTILU
RTC03xxx DSNUTILV
RTD01xxx DSNACCOR
RTD02xxx DSNACCOX
RTE01xxx DSNLEUSR
RTF01xxx DSNTBIND
RTF02xxx DSNTPSMP
RTF03xxx WLM_REFRESH
RTG01xxx ALTER_JAVA_PATH
RTG02xxx DB2_INSTALL_JAR
RTG03xxx DB2_REMOVE_JAR
RTG04xxx DB2_REPLACE_JAR
RTG05xxx DB2_UPDATEJARINFO
RTG06xxx INSTALL_JAR
RTG07xxx REMOVE_JAR
RTG08xxx REPLACE_JAR
RTH01xxx CREATE_SESSION
RTH02xxx DEBUGGERLEVEL
RTH03xxx DESTROY_SESSION
RTH04xxx GET_REPORT
RTH05xxx LIST_SESSION
RTH06xxx PUT_COMMAND
RTH07xxx QUERY_SESSION
RTH08xxx DBG_ENDSESSIONMANAGER
RTH09xxx DBG_INITIALIZECLIENT
RTH10xxx DBG_LOOKUPSESSIONMANAGER
RTH11xxx DBG_PINGSESSIONMANAGER
RTH12xxx DBG_RECVCLIENTREPORTS
RTH13xxx DBG_RUNSESSIONMANAGER
RTH14xxx DBG_SENDCLIENTCOMMANDS
RTH15xxx DBG_SENDCLIENTREQUESTS
RTH16xxx DBG_TERMINATECLIENT
RTI03xxx XSLTRANSFORM
RTI04xxx XSR_ADDSCHEMADOC
RTI05xxx XSR_COMPLETE
RTI06xxx XSR_REGISTER
RTI07xxx XSR_REMOVE
RTJ01xxx SYSTS_CREATE
RTJ02xxx SYSTS_DROP
RTJ03xxx SYSTS_ENCRYPT
RTJ04xxx SYSTS_RESTORE
RTJ05xxx SYSTS_START
RTJ06xxx SYSTS_STOP
RTJ07xxx SYSTS_TAKEOVER
RTJ08xxx SYSTS_UPDATE
RTJ09xxx SYSTS_ALTER
RTK01xxx SQLCAMESSAGE
RTK02xxx SQLCOLPRIVILEGES
RTK03xxx SQLCOLUMNS
RTK04xxx SQLFOREIGNKEYS
RTK05xxx SQLFUNCTIONCOLS
RTK06xxx SQLFUNCTIONS
RTK07xxx SQLGETTYPEINFO
RTK08xxx SQLPRIMARYKEYS
RTK09xxx SQLPROCEDURECOLS
RTK10xxx SQLPROCEDURES
RTK11xxx SQLSPECIALCOLUMNS
RTK12xxx SQLSTATISTICS
RTK13xxx SQLTABLEPRIVILEGES
RTK14xxx SQLTABLES
RTK15xxx SQLUDTS
RTL01xxx ADMIN_COMMAND_DB2
RTL02xxx ADMIN_COMMAND_DSN
RTL03xxx ADMIN_COMMAND_UNIX
RTL04xxx ADMIN_DS_BROWSE
RTL05xxx ADMIN_DS_DELETE
RTL06xxx ADMIN_DS_LIST
RTL07xxx ADMIN_DS_RENAME
RTL08xxx ADMIN_DS_SEARCH
RTL09xxx ADMIN_DS_WRITE
RTL10xxx ADMIN_INFO_HOST
RTL11xxx ADMIN_INFO_SSID
RTL12xxx ADMIN_JOB_CANCEL
RTL13xxx ADMIN_JOB_FETCH
RTL14xxx ADMIN_JOB_QUERY
RTL15xxx ADMIN_JOB_SUBMIT
RTL17xxx ADMIN_TASK_ADD
RTL18xxx ADMIN_TASK_LIST
RTL19xxx ADMIN_TASK_REMOVE
RTL20xxx ADMIN_TASK_STATUS
RTL21xxx ADMIN_UTL_SCHEDULE
RTL22xxx ADMIN_UTL_SORT
RTL23xxx ADMIN_TASK_CANCEL
RTL24xxx ADMIN_TASK_OUTPUT
RTL25xxx GET_CONFIG
RTL26xxx GET_MESSAGE
RTL27xxx GET_SYSTEM_INFO
RTL28xxx ADMIN_INFO_SYSPARM
RTL29xxx WLM_SET_CLIENT_INFO
RTL30xxx ADMIN_UTL_EXECUTE
RTL31xxx ADMIN_UTL_MODIFY
RTL32xxx ADMIN_UTL_MONITOR
RTL33xxx DSN_WLM_APPLENV
RTL34xxx ADMIN_TASK_UPDATE
RTL35xxx ADMIN_INFO_SMS
RTL36xxx ADMIN_INFO_SQL
RTL37xxx ADMIN_INFO_SYSLOG
RTL38xxx ADMIN_UPDATE_SYSPARM
RTL40xxx SET_PLAN_HINT
RTL41xxx ADMIN_COMMAND_MVS
RTL42xxx ADMIN_EXPLAIN_MAINT
RTM05xxx DSNAHVPM
RTN01xxx DSNACICS
RTN02xxx DSNAIMS
RTN03xxx DSNAIMS2
RTO02xxx MQREAD
RTO03xxx MQREADALL
RTO04xxx MQREADALLCLOB
RTO05xxx MQREADCLOB
RTO06xxx MQRECEIVE
RTO07xxx MQRECEIVEALL
RTO08xxx MQRECEIVEALLCLOB
RTO09xxx MQRECEIVECLOB
RTO10xxx MQSEND
RTP01xxx SOAPHTTPC
RTP02xxx SOAPHTTPNC
RTP03xxx SOAPHTTPNV
RTP04xxx SOAPHTTPV