Db2 Admin Routines Views

IBM DB2 10.
5
for Linux, UNIX, and Windows
Administrative Routines and Views
SC27-5507-00
IBM DB2 10.5

for Linux, UNIX, and Windows
SC27-5507-00
Note
Before using this information and the product it supports, read the general information under Appendix B, Notices, on
page 1565.
Edition Notice
This document contains proprietary information of IBM. It is provided under a license agreement and is protected
by copyright law. The information contained in this publication does not include any product warranties, and any
statements provided in this manual should not be interpreted as such.
You can order IBM publications online or through your local IBM representative.
v To order publications online, go to the IBM Publications Center at http://www.ibm.com/shop/publications/
order
v To find your local IBM representative, go to the IBM Directory of Worldwide Contacts at http://www.ibm.com/
planetwide/
To order DB2 publications from DB2 Marketing and Sales in the United States or Canada, call 1-800-IBM-4YOU
(426-4968).
When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any
way it believes appropriate without incurring any obligation to you.
Copyright IBM Corporation 2006, 2013.
US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Built-in routines and views . . . . . . 1
Best practices for calling built-in routines and views
in applications . . . . . . . . . . . . . . 1
Authorizations for using built-in routines and views 2
Built-in views versus table functions . . . . . . 3
Supported built-in SQL routines and views . . . . 3
Administrative routines and ADMIN_CMD
procedure . . . . . . . . . . . . . . 21
Administrative Task Scheduler routines and
views . . . . . . . . . . . . . . . 294
Audit routines and procedures . . . . . . 306
Automatic maintenance routines . . . . . . 310
Common SQL API procedures. . . . . . . 315
Configuration routines and views . . . . . 366
DB2 pureScale instance information routines
and views . . . . . . . . . . . . . 373
Environment routines and views . . . . . . 383
Explain routines . . . . . . . . . . . 403
Monitor routines and views . . . . . . . 421
MQSeries routines . . . . . . . . . . . 858
Security routines and views . . . . . . . 879
Snapshot routines and views . . . . . . . 892
SQL procedure routines . . . . . . . . . 959
Stepwise redistribute routines . . . . . . . 969
Storage management tool routines . . . . . 978
Text Search routines . . . . . . . . . . 982
Workload Management routines . . . . . . 1022
Miscellaneous routines and views . . . . . 1043
Deprecated SQL administrative routines and
views . . . . . . . . . . . . . . . 1088
ADMIN_GET_DBP_MEM_USAGE table
function - Get total memory consumption for
instance . . . . . . . . . . . . . . 1094
ADMINTABCOMPRESSINFO administrative
view and
ADMIN_GET_TAB_COMPRESS_INFO table
function (deprecated) - returns compressed
information . . . . . . . . . . . . 1096
ADMIN_GET_TAB_COMPRESS_INFO
_V97 . . . . . . . . . . . . . . . 1101
ADMIN_GET_TAB_INFO_V95 table function Retrieve size and state information for tables . 1107
ADMIN_GET_TAB_INFO_V97 table function Retrieve size and state information for tables . 1113
AM_BASE_RPT_RECOMS - Recommendations
for activity reports . . . . . . . . . . 1120
AM_BASE_RPTS - Activity event monitor
reports . . . . . . . . . . . . . . 1121
AM_DROP_TASK - Delete a monitoring task
1122
AM_GET_LOCK_CHN_TB - Retrieve
application lock chain data in a tabular format . 1123
AM_GET_LOCK_CHNS - Retrieve lock chain
information for a specific application . . . . 1124
AM_GET_LOCK_RPT - Retrieve application
lock details . . . . . . . . . . . . . 1125
AM_GET_RPT - Retrieve activity monitor data 1133
Copyright IBM Corp. 2006, 2013
AM_SAVE_TASK - Create or modify a

monitoring task . . . . . . . . . . .
APPL_PERFORMANCE administrative view Retrieve percentage of rows selected for an
application . . . . . . . . . . . . .
APPLICATIONS administrative view - Retrieve
connected database application information . .
APPLICATION_ID . . . . . . . . . .
BP_HITRATIO administrative view - Retrieve
bufferpool hit ratio information . . . . . .
BP_READ_IO administrative view - Retrieve
bufferpool read performance information . . .
BP_WRITE_IO administrative view - Retrieve
bufferpool write performance information . .
CONTAINER_UTILIZATION administrative
view - Retrieve table space container and
utilization information . . . . . . . . .
DB_PARTITIONS . . . . . . . . . . .
ENV_SYS_RESOURCES administrative view Return system information . . . . . . .
ENV_GET_SYS_RESOURCES table function return system information . . . . . . . .
GET_DB_CONFIG . . . . . . . . . .
GET_DBM_CONFIG. . . . . . . . . .
Health snapshot routines . . . . . . . .
LOCKS_HELD administrative view - Retrieve
information about locks held . . . . . . .
LOCKWAITS administrative view - Retrieve
current lockwaits information . . . . . .
LOG_UTILIZATION administrative view Retrieve log utilization information. . . . .
LONG_RUNNING_SQL administrative view
REG_VARIABLES administrative view Retrieve DB2 registry settings in use . . . .
REG_LIST_VARIABLES table function - return
registry settings . . . . . . . . . . .
SNAPAGENT administrative view and
SNAP_GET_AGENT table function - Retrieve
agent logical data group application snapshot
information . . . . . . . . . . . .
SNAPAGENT_MEMORY_POOL administrative
view and
SNAP_GET_AGENT_MEMORY_POOL table
function - Retrieve memory_pool logical data
group snapshot information . . . . . . .
SNAPAPPL_INFO administrative view and
SNAP_GET_APPL_INFO table function Retrieve appl_info logical data group snapshot
information . . . . . . . . . . . .
SNAP_GET_APPL_INFO_V95 table function Retrieve appl_info logical data group snapshot
information . . . . . . . . . . . .
SNAPAPPL administrative view and
SNAP_GET_APPL table function - Retrieve
appl logical data group snapshot information .
1134
1135
1137
1141
1142
1144
1146
1148
1150
1152
1155
1158
1160
1161
1206
1209
1212
1214
1216
1218
1220
1223
1228
1236
1242
iii
SNAP_GET_APPL_V95 table function Retrieve appl logical data group snapshot

information . . . . . . . . . . . .
SNAPBP administrative view and
SNAP_GET_BP table function - Retrieve
bufferpool logical group snapshot information .
SNAPBP_PART administrative view and
SNAP_GET_BP_PART table function - Retrieve
bufferpool_nodeinfo logical data group
snapshot information . . . . . . . . .
SNAP_GET_BP_V95 table function - Retrieve
SNAPCONTAINER administrative view and
SNAP_GET_CONTAINER table function Retrieve tablespace_container logical data
SNAP_GET_CONTAINER_V91 table function Retrieve tablespace_container logical data
SNAPDB administrative view and
SNAP_GET_DB table function - Retrieve
snapshot information from the dbase logical
group . . . . . . . . . . . . . .
SNAPDB_MEMORY_POOL administrative
view and SNAP_GET_DB_MEMORY_POOL
table function - Retrieve database level
memory usage information . . . . . . .
SNAP_GET_DB_V97 table function - Retrieve
group . . . . . . . . . . . . . .
SNAPDBM administrative view and
SNAP_GET_DBM table function - Retrieve the
dbm logical grouping snapshot information . .
SNAPDBM_MEMORY_POOL administrative
view and SNAP_GET_DBM_MEMORY_POOL
table function - Retrieve database manager
level memory usage information . . . . .
SNAP_GET_DBM_V95 table function - Retrieve
the dbm logical grouping snapshot information
SNAPDETAILLOG administrative view and
SNAP_GET_DETAILLOG table function Retrieve snapshot information from the
detail_log logical data group . . . . . . .
SNAP_GET_DETAILLOG_V91 table function Retrieve snapshot information from the
SNAP_GET_DYN_SQL_V95 table function Retrieve dynsql logical group snapshot
information . . . . . . . . . . . .
SNAPFCM administrative view and
SNAP_GET_FCM table function - Retrieve the
fcm logical data group snapshot information .
SNAPFCM_PART administrative view and
SNAP_GET_FCM_PART table function Retrieve the fcm_node logical data group
SNAPHADR administrative view and
SNAP_GET_HADR table function - Retrieve
hadr logical data group snapshot information .
iv
1250
1257
1263
1267
1270
1275
1278
1290
1294
1304
1309
1312
1315
1319
1321
1325
1328
1331
SNAPLOCK administrative view and

SNAP_GET_LOCK table function - Retrieve
lock logical data group snapshot information .
SNAPLOCKWAIT administrative view and
SNAP_GET_LOCKWAIT table function Retrieve lockwait logical data group snapshot
information . . . . . . . . . . . .
SNAPSTMT administrative view and
SNAP_GET_STMT table function - Retrieve
statement snapshot information . . . . . .
SNAP_GET_STO_PATHS . . . . . . . .
SNAPSTORAGE_PATHS administrative view
and SNAP_GET_STORAGE_PATHS_V97 table
function - Retrieve automatic storage path
information . . . . . . . . . . . .
SNAPTAB administrative view and
SNAP_GET_TAB table function - Retrieve table
logical data group snapshot information . . .
SNAP_GET_TAB_V91 . . . . . . . . .
SNAPTBSP administrative view and
SNAP_GET_TBSP table function - Retrieve
table space logical data group snapshot
information . . . . . . . . . . . .
SNAPTBSP_PART administrative view and
SNAP_GET_TBSP_PART table function Retrieve tablespace_nodeinfo logical data
SNAP_GET_TBSP_PART_V97 table function Retrieve tablespace_nodeinfo logical data
SNAP_GET_TBSP_V91 . . . . . . . . .
SNAPUTIL administrative view and
SNAP_GET_UTIL table function - Retrieve
utility_info logical data group snapshot
information . . . . . . . . . . . .
SNAP_WRITE_FILE procedure . . . . . .
information . . . . . . . . . . . .
SNAPAGENT_MEMORY_POOL administrative
view and
information . . . . . . . . . . . .
appl logical data group snapshot information .
1335
1341
1347
1353
1355
1358
1362
1364
1370
1376
1380
1384
1389
1390
1394
1398
1406
1414
1420

group . . . . . . . . . . . . . .
memory usage information . . . . . . .
dbm logical grouping snapshot information . .
level memory usage information . . . . .
fcm logical data group snapshot information .
hadr logical data group snapshot information .
lock logical data group snapshot information .
information . . . . . . . . . . . .
group . . . . . . . . . . . . . .
information . . . . . . . . . . . .
statement snapshot information . . . . . .
information . . . . . . . . . . . .
1424
1428
1440
1444
1449
1452
1456
1459
1462
1467
1472
1478

logical data group snapshot information . . .
information . . . . . . . . . . . .
information . . . . . . . . . . . .
SYSINSTALLROUTINES . . . . . . . .
TBSP_UTILIZATION administrative view Retrieve table space configuration and
utilization information . . . . . . . . .
WLM_GET_ACTIVITY_DETAILS - Return
detailed information about a specific activity .
WLM_GET_SERVICE_CLASS_AGENTS
_V97 - List agents running in a service class. .
WLM_GET_SERVICE_CLASS
_WORKLOAD_OCCURRENCES_V97 - List of
workload occurrences . . . . . . . . .
WLM_GET_SERVICE_SUBCLASS
_STATS_V97 - return statistics of service
subclasses . . . . . . . . . . . . .
WLM_GET_WORKLOAD
_OCCURRENCE_ACTIVITIES
_V97 - Return a list of activities . . . . . .
WLM_GET_WORKLOAD_STATS_V97 - return
workload statistics . . . . . . . . . .
1505
1508
1514
1520
1524
1525
1527
1533
1541
1544
1550
1554
Appendix A. Overview of the DB2

technical information . . . . . . . 1559
DB2 technical library in hardcopy or PDF format
Displaying SQL state help from the command line
processor . . . . . . . . . . . . . .
Accessing different versions of the DB2
Information Center . . . . . . . . . . .
Terms and conditions . . . . . . . . . .
1559
1562
1562
1562
Appendix B. Notices . . . . . . . . 1565

1490
Index . . . . . . . . . . . . . . 1569
1495
1501
Contents
vi
Built-in routines and views

Built-in administrative routines and views provide an simplified programmatic
interface to administer and use DB2 databases and database objects through
structured query language (SQL). Built-in routines encompass procedures, scalar
functions, and table functions.
You can use built-in routines and views to perform a variety of DB2 tasks. For
example, you can use built-in routines to reorganize a table, capture and retrieve
monitor data, or retrieve the application ID of the current connection.
You can invoke these built-in routines and views from an SQL-based application, a
DB2 command line, or a command script.
Character and graphic strings used as parameters of routines or returned from the
routines or views are always in OCTETS even when the environment is set to
CODEUNITS32.
Best practices for calling built-in routines and views in applications

To help ensure your successful use of the built-in routines and views, certain
coding practices are recommended. These practices are especially important
because routines might change from release to release and also within releases,
such as through fix packs, as enhancements are made.
When you issue a query to retrieve information by using a built-in routine or view,
select specific columns instead of selecting all columns with a wildcard. For
example, do not issue the following query:
SELECT * FROM TABLE(MON_GET_UNIT_OF_WORK(NULL,-1)) AS t
ORDER BY total_cpu_time DESC
Instead, name the result columns in the SELECT statement. This technique gives
the application control over the number of result columns and the sequence in
which they are returned. In the following rewrite of the previous query, the
columns are named:
SELECT application_handle,
uow_id,
total_cpu_time,
app_rqsts_completed_total,
rqsts_completed_total
FROM TABLE(MON_GET_UNIT_OF_WORK(NULL,-1)) AS t
Naming columns prevents problems if the sequence and number of columns in the
routines change. The number of result columns that a routine returns might
increase. If, for example, you provide only five host variables when the routine
returns six result columns, your application will break.
In addition, the type and size of output parameters or result columns of routines
might change. For example, a column might change from VARCHAR(8) to
VARCHAR(128), or an INTEGER column might become a BIGINT column. If a
variable that you use is too small, the data that you receive from the routine might
be truncated.
To protect your C application from such changes, you can describe a prepared
statement to determine which result columns are returned and what their types
and sizes are. The following example shows how to describe a prepared statement:
strcpy(strStmt, "SELECT application_handle, uow_id,total_cpu_time
FROM TABLE(MON_GET_UNIT_OF_WORK(NULL,-1))
AS t ORDER BY total_cpu_time DESC");
EXEC SQL PREPARE stmt FROM :strStmt;
EXEC SQL DESCRIBE stmt into :*pSqlda;
For an example of how to use the information that is returned in the SQL
description area (SQLDA), see the RowDatamemoryAlloc function in the
samples/c/tbread.sqc file.
For Java and .NET applications, you need to know the data type and size for a
program, you can use metadata to determine which result columns are returned
and what their types and sizes are, as shown in the following example:
ResultSet rs = pstmt.executeQuery();
ResultSetMetaData rsms = rs.getMetaData();
For an example of how to use the metadata of the result set, see the
execPreparedQueryWithUnknownOutputColumn( ) method in the
samples/java/jdbc/TbRead.java file.
Authorizations for using built-in routines and views

All built-in routines and views require specific privileges to run.
Built-in routines
For all built-in routines in the SYSPROC schema, you need EXECUTE privilege on the
routine. You can use the following query to check whether your authorization ID,
or a group or a role to which you belong, has EXECUTE privilege:
SELECT A.SPECIFICNAME, GRANTEE, GRANTEETYPE
FROM SYSCAT.ROUTINEAUTH A, SYSCAT.ROUTINES R
WHERE A.SCHEMA = R.ROUTINESCHEMA
AND A.SPECIFICNAME = R.SPECIFICNAME
AND A.SCHEMA = SYSPROC
AND R.ROUTINENAME = routine_name
AND A.EXECUTEAUTH <> N
where routine_name is the name of the built-in routine.

If your authorization ID, or a group or a role to which you belong, is listed in the
GRANTEE column, then you have access to the specified built-in routine.
Built-in views
For all built-in views in the SYSIBMADM schema, you need SELECT privilege on the
view. You can use the following query to check whether your authorization ID, or
a group or a role to which you belong, has SELECT privilege:
SELECT GRANTEE, GRANTEETYPE
FROM SYSCAT.TABAUTH
WHERE TABSCHEMA = SYSIBMADM
AND TABNAME = view_name
AND SELECTAUTH <> N
where view_name is the name of the built-in view.
If your authorization ID, or a group or a role to which you belong, is listed in the
GRANTEE column, then you have access to the specified built-in view.
Built-in views versus table functions

Built-in views provide a simplified application programming interface to DB2
functions through SQL.
The built-in views fall into three categories:
v Views that are based on catalog views
v Views that are based on table functions with no input parameters
v Views that are based on table functions with one or more input parameters
A table function can return similar information as the built-in view, however you
can use a table function to retrieve the information for a specific database on a
specific database partition, a subset of all database partitions, or all database
partitions.
The following examples illustrate the difference between using an built-in view,
based on a table function with one or more input parameters, and using the
corresponding table function:
v The PDLOGMSGS_LAST24HOURS view, which retrieves notification log messages,
provides quick access to data from the previous 24 hours. By contrast, you can
use the PD_GET_LOG_MSGS table function to retrieve data from a specified period
of time.
v The snapshot monitor views, which are identified by names beginning with
SNAP) provide access to data from each database partition. However, the
snapshot monitor table functions, which are identified by names beginning with
SNAP_GET_) provide the option to choose between data from a single database
partition or a data subset from across all database partitions.
v The ADMINTABINFO view retrieves information for all tables in a database, which
can significantly affect the performance of applications that use large databases.
Instead, you can reduce the performance impact by using the
ADMIN_GET_TAB_INFO table function and specifying the schema name, table name,
or both, as input.
For built-in views based on table functions with one or more input parameters,
both the built-in view and the table function can be used, each achieving a
different goal:
The built-in views are always based on the most current version of the table
functions. However, the column positions in the returned information may change
from release to release to enable new information to be returned. Therefore, you
should select specific columns from the built-in views or table functions, or
describe your result set if your application uses a SELECT * statement.
Table functions with a version suffix (_Vxx) have been deprecated or discontinued.
The deprecated functions might be discontinued in a future release. Therefore, you
should change applications and scripts that use these table functions to invoke the
corresponding table functions that have no version suffix.
Supported built-in SQL routines and views

This topic provides information about the following built-in SQL routines:
v
v
v
v
v
Administrative SQL routines and the ADMIN_CMD stored procedure: Table 1

Administrative task scheduler routines and views: Table 2 on page 6
Audit routines and procedures: Table 3 on page 6
Automatic maintenance built-in SQL routines and views:Table 4 on page 6
Common SQL API stored procedures: Table 5 on page 6
v
v
v
v
v
Configuration built-in SQL routines and views: Table 6 on page 7

DB2 pureScale instance administrative views: Table 7 on page 7
Environment built-in SQL routines and views: Table 8 on page 8
Explain routines: Table 9 on page 8
Monitor built-in SQL routines: Table 10 on page 9
MQSeries built-in SQL routines: Table 11 on page 15
Security built-in SQL routines and views: Table 12 on page 16
Snapshot built-in SQL routines and views: Table 13 on page 16
SQL procedures built-in SQL routines: Table 14 on page 17
v
v
v
v
v Stepwise redistribute built-in SQL routines: Table 15 on page 18

v Storage management tool built-in SQL routines: Table 16 on page 18
v Text search built-in SQL routines: Table 17 on page 18
v Workload Management routines: Table 18 on page 19
v Miscellaneous built-in SQL routines and views: Table 19 on page 20
Table 1. Administrative SQL routines
Routine name
Schema
Description
SYSPROC
This procedure allows the administrator to

execute administrative commands
(including DB2 command line processor
(CLP) commands) by running
ADMIN_CMD through a CALL statement.
SYSPROC
This procedure is used to copy a specific

schema and all objects contained in it.
SYSPROC
This procedure is used to drop a specific

schema and all objects contained in it.
SYSIBM
This function returns an estimate of the

inline length that is required to inline the
data stored in an XML column, BLOB
column, CLOB column, or DBCLOB
column.
SYSPROC
This table function returns the potential

index compression savings for
uncompressed indexes or reports the index
compression statistics from the catalogs.
SYSPROC
This table function returns index

information not available in the catalog
views.
SYSPROC
This scalar function returns the current state

of intrapartition parallelism for the
application.
SYSPROC
This table function returns the memory

usage statistics for a given member.
ADMIN_CMD procedure
ADMIN_COPY_SCHEMA procedure
ADMIN_DROP_SCHEMA procedure
ADMIN_EST_INLINE_LENGTH function
ADMIN_GET_INDEX_COMPRESS_INFO table
function
ADMIN_GET_INDEX_INFO table function
ADMIN_GET_INTRA_PARALLEL scalar
function
ADMIN_GET_MEM_USAGE table function
Table 1. Administrative SQL routines (continued)

Routine name
Schema
Description
SYSPROC
This table function is used to retrieve

messages generated by data movement
utilities that are executed through the
ADMIN_CMD procedure.
SYSPROC (table
function)
This administrative view and table function

return a list of automatic storage paths for
the database including file system
information for each storage path,
specifically, from the db_storage_group
logical data group
SYSPROC
This table function returns compression

estimates for tables, materialized query
tables (MQT) and hierarchy tables.
SYSPROC
This table function returns dictionary

information for tables, materialized query
tables (MQT) and hierarchy tables.
SYSIBM
This function retrieves state information

about inline data for an XML column,
BLOB column, CLOB column, or DBCLOB
column.
SYSPROC
This procedure moves data in an active

table into a new table object with the same
name, while the data remains online and
available for access.
SYSPROC
This procedure alters the user definable

values used by the ADMIN_MOVE_TABLE
procedure.
SYSPROC
This procedure is used to clean up

messages generated by data movement
utilities that are executed through the
SYSPROC
This procedure revalidates invalid database

objects.
SYSPROC
This procedure enables or disables

intrapartition parallelism for a database
application.
ADMINTABINFO and
ADMIN_GET_TAB_INFO view and table
function
SYSIBMADM
(administrative view),
SYSPROC (table
function)
This view and table function return size

and state information for tables,
materialized query tables (MQT) and
hierarchy tables.
ADMINTEMPCOLUMNS view and

ADMIN_GET_TEMP_COLUMNS table
function
SYSIBMADM
SYSPROC (table
function)
This view and table function retrieve

column attribute information for created
temporary tables and declared temporary
tables
ADMINTEMPTABLES view and

ADMIN_GET_TEMP_TABLES table function
SYSIBMADM
SYSPROC (table
function)
This view and table function retrieve table

attribute and instantiation time information
for instances of created temporary tables
and declared temporary tables.
ADMIN_GET_MSGS table function
ADMIN_GET_STORAGE_PATHS table
function
function
ADMIN_GET_TAB_DICTIONARY_INFO table
function
ADMIN_IS_INLINED function
ADMIN_MOVE_TABLE procedure
ADMIN_MOVE_TABLE_UTIL procedure
ADMIN_REMOVE_MSGS procedure
ADMIN_REVALIDATE_DB_OBJECTS
procedure
ADMIN_SET_INTRA_PARALLEL procedure
Table 2. Administrative task scheduler routines and views

Routine or view name
Schema
Description
SYSPROC
This procedure schedules an administrative

task.
SYSTOOLS
This administrative view retrieves

information about each task defined in the
scheduler.
SYSPROC
This procedure removes scheduled tasks or

task status records.
SYSTOOLS
This administrative view retrieves

information about the status of each task.
SYSPROC
This procedure updates an existing task
Schema
Description
AUDIT_ARCHIVE procedure and table

function
SYSPROC
This procedure and table function archives

the current audit log.
AUDIT_DELIM_EXTRACT procedure
SYSPROC
This procedure extracts data from the

binary archived logs and loads it into
delimited files.
AUDIT_LIST_LOGS table function
SYSPROC
This table function returns a list of the

archived audit logs at the specified path,
for the current database.
ADMIN_TASK_ADD procedure
ADMIN_TASK_LIST administrative view
ADMIN_TASK_REMOVE procedure
ADMIN_TASK_STATUS administrative view
ADMIN_TASK_UPDATE procedure
Table 3. Audit routines and procedures
Table 4. Automatic Maintenance built-in SQL routines and views

Schema
Description
AUTOMAINT_GET_POLICY procedure
SYSPROC
This procedure gets the current automatic

maintenance settings for the database.
AUTOMAINT_GET_POLICYFILE procedure
SYSPROC
This procedure gets the current automatic

maintenance settings for the database.
AUTOMAINT_SET_POLICY procedure
SYSPROC
This procedure sets the automatic

maintenance policy settings for the
currently connected database.
AUTOMAINT_SET_POLICYFILE procedure
SYSPROC
This procedure sets the automatic

maintenance settings for the currently
connected database.
Schema
Description
SYSPROC
This procedure cancels a specified activity.

If no unique activity ID is specified, cancels
all activity for a connected application, and
forces the application off of the system.
SYSPROC
This procedure retrieves design advisor

recommendations from a IBM DB2 10.5
server.
Table 5. Common SQL API stored procedures

CANCEL_WORK procedure
DESIGN_ADVISOR procedure
Table 5. Common SQL API stored procedures (continued)

Schema
Description
SYSPROC
This procedure retrieves data server

configuration data, including nodes.cfg file
data, database manager configuration data,
database configuration data, and registry
settings from all database partitions.
SYSPROC
This procedure retrieves the short message

text, long message text, and SQLSTATE for
an SQLCODE.
SYSPROC
This procedure retrieves information about

the data server, including information about
the system, the current instance, installed
DB2 database products, environment
variables, available CPUs, and other system
information.
SYSPROC
This procedure updates the configuration

parameters retrieved by the GET_CONFIG
procedure.
GET_CONFIG procedure
GET_MESSAGE procedure
GET_SYSTEM_INFO procedure
SET_CONFIG procedure
Table 6. Configuration built-in SQL routines and views

DBCFG administrative view
DBMCFG administrative view
Schema
Description
SYSIBMADM
This administrative view returns database

configuration information.
SYSIBMADM
This administrative view returns database

manager configuration information.
Table 7. DB2 pureScale instance administrative views

View name
DB_MEMBERS table function
Schema
Description
SYSIBMADM
This table function returns basic member

information about a DB2 pureScale instance.
SYSIBMADM
The DB2_CLUSTER_HOST_STATE
administrative view and the associated
DB2_GET_CLUSTER_HOST_STATE table
function retrieve information about the
hosts that are part of a DB2 pureScale
instance.
SYSIBMADM
This view provides information about alerts

in the DB2 pureScale instance.
SYSIBMADM
The DB2_MEMBER and DB2_CF

administrative views and the associated
DB2_GET_INSTANCE_INFO table function
return information about the members and
cluster caching facilities of a DB2 pureScale
instance, including state information where
applicable.
DB2_CLUSTER_HOST_STATE administrative
view
DB2_INSTANCE_ALERTS administrative view
DB2_MEMBER and DB2_CF administrative

views
Table 8. Environment built-in SQL routines and views

View name
Schema
Description
SYSIBMADM
This administrative view returns a list of

system resources used by the cluster
caching facilities (also known as CFs) on
the system.
SYSPROC
This administrative view returns

information about all available features for
which a license is required.
SYSPROC
This table function returns system resource

information metrics at the instance level for
all DB2 engine dispatchable units (EDUs).
SYSPROC
This table function returns CPU usage and

DB2 process information for specified
members in the current instance.
SYSPROC
This table function returns information for

all active network adaptors on the host
machines running DB2.
SYSPROC
This table function returns the DB2 registry

settings from one or all database members.
SYSPROC
This table function returns the code level

for the instance, members, and cluster
facilitators.
SYSPROC
This table function returns operating

system, CPU, memory and other
information related to members on the
system.
SYSIBMADM

information about the current instance.
SYSIBMADM

information about installed DB2 database
products.
SYSIBMADM

information about the system.
ENV_CF_SYS_RESOURCES administrative
view
ENV_FEATURE_INFO administrative view
ENV_GET_DB2_EDU_SYSTEM_RESOURCES
table function
ENV_GET_DB2_SYSTEM_RESOURCES table
function
ENV_GET_NETWORK_RESOURCES table
function
ENV_GET_REG_VARIABLES table function
ENV_GET_INSTANCE_CODE_LEVELS table
function
ENV_GET_SYSTEM_RESOURCES table
function
ENV_INST_INFO administrative view
ENV_PROD_INFO administrative view
ENV_SYS_INFO administrative view
Table 9. Explain Routines

Routine Name
Schema
Description
EXPLAIN_GET_MSGS table function
The schema is the same as the

Explain table schema.
This table function queries the

EXPLAIN_DIAGNOSTIC and
EXPLAIN_DIAGNOSTIC_DATA
Explain tables, and returns formatted
messages.
EXPLAIN_FORMAT_STATS scalar
function
SYSPROC
This new scalar function is used to

display formatted statistics
information which is parsed and
extracted from explain snapshot
captured for a given query.
EXPLAIN_FROM_ACTIVITY
procedure
SYSPROC
This procedure explains a specific

execution of a statement using the
contents of the section obtained from
an activity event monitor.
Table 9. Explain Routines (continued)

Routine Name
Schema
Description
EXPLAIN_FROM_CATALOG
procedure
SYSPROC
This procedure explains a statement

using the contents of the section
obtained from the catalogs.
EXPLAIN_FROM_DATA procedure
SYSPROC

using the contents of the input
section.
EXPLAIN_FROM_SECTION
procedure
SYSPROC

using the contents of the section
obtained from the package cache or
from the package cache event
monitor.
Table 10. Monitor SQL routines

Routine name
Schema
Description
SYSPROC
This procedure retrieves data stored in

an unformatted event table and moves
the XML document into a set of
relational tables.
SYSPROC
This table function extracts binary

events from an unformatted event table
and formats them into an XML
document.
SYSPROC
This procedure alters event monitor

target SQL or unformatted event tables
to accommodate new or changed
monitoring elements that have been
added since the event monitor was
created.
SYSIBMADM
This administrative view returns key

monitoring metrics, including hit ratios
and average read and write times, for
all buffer pools and all database
partitions in the currently connected
database.
SYSPROC
This procedure gathers information

about a specified activity and writes
the information to the active activities
event monitor.
SYSPROC
This procedure gathers or resets

statistics for service classes, workloads,
work classes, threshold queues, and
operating system resources. If there is
an active statistics event monitor,
writes them to the statistics event
monitor.
SYSIBMADM

metrics for all connections in the
EVMON_FORMAT_UE_TO_TABLES procedure
EVMON_FORMAT_UE_TO_XML table function
EVMON_UPGRADE_TABLES procedure
MON_BP_UTILIZATION administrative view
MON_CAPTURE_ACTIVITY_IN_PROGRESS procedure
MON_COLLECT_STATS procedure
MON_CONNECTION_SUMMARY administrative view
Table 10. Monitor SQL routines (continued)

Routine name
Schema
Description
SYSIBMADM

metrics for all activities that were
submitted on all members of the
database and have not yet been
completed.
SYSIBMADM

metrics for all units of work that were
submitted on all members of the
database.
SYSIBMADM

metrics aggregated over all service
classes in the currently connected
database.
SYSPROC
This table function formats the internal

lock name and returns details
regarding the lock in a row-based
format.
SYSPROC
This table function returns formatted

row-based output for the component
times contained in an XML metrics
document.
SYSPROC

row-based output for all metrics
contained in an XML metrics
document.
SYSPROC

row based output for the combined
hierarchy of wait and processing times
that are contained in an XML metrics
document.
SYSPROC

row-based output for the wait times
contained in an XML metrics
document.
SYSPROC
This table function returns the list of

all activities that were submitted by the
specified application on the specified
member and have not yet been
completed.
SYSPROC
This table function returns details

about an activity, including general
activity information and a set of
metrics for the activity.
SYSPROC
This table function returns the list of

agents, fenced mode processes (db2fmp
processes), and system entities on a
specified member that are running in a
specified service class or on behalf of a
specified application. The system
entities are non-agent threads and
processes, such as page cleaners and
prefetchers.
MON_CURRENT_SQL administrative view
MON_CURRENT_UOW administrative view
MON_DB_SUMMARY administrative view
MON_FORMAT_LOCK_NAME table function
MON_FORMAT_XML_COMPONENT_TIMES_BY_ROW
table function
MON_FORMAT_XML_METRICS_BY_ROW table
function
MON_FORMAT_XML_TIMES_BY_ROW table function
MON_FORMAT_XML_WAIT_TIMES_BY_ROW table
function
MON_GET_ACTIVITY table function
MON_GET_ACTIVITY_DETAILS
MON_GET_AGENT table function
10

Routine name
Schema
Description
SYSPROC
This table function returns information

about all locks that each application's
agents (that are connected to the
current database) are waiting to
acquire.
SYSPROC
This scalar function returns the

application handle of the invoking
application.
SYSPROC

application ID of the invoking
application.
SYSPROC

about all automatic maintenance jobs
(with the exception of real-time
statistics which does not submit jobs
on the automatic maintenance queue)
that are currently queued for execution
by the autonomic computing daemon
(db2acd).
SYSPROC

about all objects which are currently
queued for evaluation by automatic
statistics collection in the currently
connected database.
SYSPROC
This table function returns monitor

metrics for one or more buffer pools.
SYSPROC
This table function returns status

information about one or more cluster
caching facilities in a DB2 pureScale
environment.
SYSPROC

about the processing time for cluster
caching facility (CF) commands.
SYSPROC
This table function reports the total

amount of time, in microseconds, that
are spent waiting for the cluster
caching facilities (CFs) to process a
request. This time includes the time
that is taken for related
communications to the cluster caching
facilities.
SYSPROC
This table function returns metrics for

one or more connections.
SYSPROC
This table function returns detailed

metrics for one or more connections.
SYSPROC

metrics for one or more table space
containers.
SYSPROC
This table function returns database

level information within the monitor
infrastructure.
MON_GET_APPL_LOCKWAIT table function
MON_GET_APPLICATION_HANDLE scalar function
MON_GET_APPLICATION_ID scalar function
MON_GET_AUTO_MAINT_QUEUE table function
MON_GET_AUTO_RUNSTATS_QUEUE table function
MON_GET_BUFFERPOOL table function
MON_GET_CF table function
MON_GET_CF_CMD table function
MON_GET_CF_WAIT_TIME table function
MON_GET_CONNECTION table function

MON_GET_CONNECTION_DETAILS table function
MON_GET_CONTAINER table function
MON_GET_DATABASE table function
11

Routine name
Schema
Description
SYSPROC
This table function retrieves database

information metrics in an XML
document.
SYSPROC
This function returns information for

latches which have been involved in
extended latch waits.
SYSPROC
This table function returns the status of

the extent movement operation.
SYSPROC

the fast communication manager
(FCM).
SYSPROC

metrics for all the fast communication
manager (FCM) connections on the
specified member or members.
SYSPROC
This table function returns statistics

about the group bufferpool, including
the number of times the GBP_FULL
error is encountered.
SYSPROC
This function returns high availability

disaster recovery (HADR) monitoring
information.
SYSPROC

one or more indexes.
SYSPROC

from a usage list defined for an index.
SYSPROC
This table function returns DB2

instance level information within the
monitor infrastructure.
SYSPROC
This table function returns a list of all

locks in the currently connected
database.
SYSPROC
This table function retrieves metrics

from the memory pools contained
within a memory set.
SYSPROC
This table function retrieves metrics

from the memory pools contained
within a memory set.
SYSPROC

about bufferpool pages that are being
waited on for a specified table.
SYSPROC
This table function returns a

point-in-time view of both static and
dynamic SQL statements in the
database package cache.
SYSPROC

metrics for one or more package cache
entries.
MON_GET_DATABASE_DETAILS table function
MON_GET_EXTENDED_LATCH_WAIT table function

MON_GET_EXTENT_MOVEMENT_STATUS table
function
MON_GET_FCM table function
MON_GET_FCM_CONNECTION_LIST table function
MON_GET_GROUP_BUFFERPOOL table function
MON_GET_HADR table function
MON_GET_INDEX table function

MON_GET_INDEX_USAGE_LIST table function
MON_GET_INSTANCE table function
MON_GET_LOCKS table function
MON_GET_MEMORY_POOL table function
MON_GET_MEMORY_SET table function
MON_GET_PAGE_ACCESS_INFO table function
MON_GET_PKG_CACHE_STMT table function
MON_GET_PKG_CACHE_STMT_DETAILS table
function
12

Routine name
Schema
Description
SYSPROC
This table function returns basic

statistics for one or more threshold
queues on all active members. This
function returns one row of statistics
for each threshold queue.
SYSPROC
This table function returns the status of

a rebalance operation on a table space.
SYSPROC
This table function returns aggregated

execution metrics for procedures,
external procedures, compiled
functions, external functions, compiled
triggers, and anonymous blocks
invoked since the database was
activated.
SYSPROC
This table function returns aggregated

execution metrics for procedures,
external functions, compiled functions,
compiled triggers, and anonymous
blocks invoked since the database was
activated. The metrics are returned in
an XML document.
SYSPROC

statements (sections) executed by each
procedure, external function, compiled
function, compiled trigger, and
anonymous block invoked since the
database was activated.
SYSPROC

about all real-time statistics requests
that are pending in the system, and the
set of requests that are currently being
processed by the real time statistics
daemon (such as on the real-time
statistics processing queue).
SYSPROC

procedures, external functions,
compiled functions, and compiled
triggers that might be invoked during
the execution of the input section.
SYSPROC
This table function returns metrics on

the server list for the currently
connected database as cached on one
or more members.
SYSPROC

one or more service subclasses.
SYSPROC

metrics for one or more service
subclasses.
SYSPROC

statistics for one or more service
subclasses.
MON_GET_QUEUE_STATS table function
MON_GET_REBALANCE_STATUS table function
MON_GET_ROUTINE table function
MON_GET_ROUTINE_DETAILS table function
MON_GET_ROUTINE_EXEC_LIST table function
MON_GET_RTS_RQST table function
MON_GET_SECTION_ROUTINE table function
MON_GET_SERVERLIST table function
MON_GET_SERVICE_SUBCLASS table function

MON_GET_SERVICE_SUBCLASS_DETAILS table
function
MON_GET_SERVICE_SUBCLASS_STATS table function
13

Routine name
MON_GET_SERVICE_SUPERCLASS_STATS table
function
MON_GET_TABLE table function
MON_GET_TABLESPACE table function
MON_GET_TABLE_USAGE_LIST table function
Schema
Description
SYSPROC

statistics of one or more service
superclasses.
SYSPROC

metrics for one or more tables.
SYSPROC

metrics for one or more table spaces.
SYSPROC

from a usage list defined for a table.
SYSPROC

about the transaction logging
subsystem for the currently connected
database.
SYSPROC

one or more units of work.
SYSPROC

metrics for one or more units of work.
SYSPROC
This table function returns current

status on a usage list.
SYSPROC

about utilities currently running on the
database.
SYSPROC

one or more workloads.
SYSPROC

metrics for one or more workloads.
SYSPROC
This table function returns one row of

workload statistics for every
combination of workload name and
database member number.
SYSPROC
This table function returns the statistics

for a work action set.
SYSPROC
This procedure increments the

monitoring interval by 1 and returns
the new value in the output argument.
SYSPROC

information about agents working on
behalf of applications that are waiting
to obtain locks in the currently
connected database.
SYSIBMADM

metrics for both static and dynamic
SQL statements in the cache, providing
a high-level summary of the database
package cache.
MON_GET_TRANSACTION_LOG table function
MON_GET_UNIT_OF_WORK table function

MON_GET_UNIT_OF_WORK_DETAILS table function
MON_GET_USAGE_LIST_STATUS table function
MON_GET_UTILITY table function
MON_GET_WORKLOAD table function

MON_GET_WORKLOAD_DETAILS table function
MON_GET_WORKLOAD_STATS table function
MON_GET_WORK_ACTION_SET_STATS table function

- Return work action set statistics
MON_INCREMENT_INTERVAL_ID procedure
MON_LOCKWAITS administrative view
MON_PKG_CACHE_SUMMARY administrative view
14

Routine name
Schema
Description
SYSPROC
The table function reads system

metrics for one or more service classes
across one or more databases at two
points in time: at the time the function
is called and after a given amount of
time has passed.
SYSPROC
The table function reads system

metrics for one or more workloads
across one or more databases at two
points in time: at the time the function
is called and after a given amount of
time has passed.
SYSIBMADM

metrics for all service subclasses in the
SYSIBMADM

monitoring metrics, including hit ratios
and utilization percentage, for all table
spaces and all database partitions in
the currently connected database.
SYSIBMADM

information about transaction log
utilization for the currently connected
database. A single row is returned for
each member.
SYSIBMADM

metrics for all workloads in the
MON_SAMPLE_SERVICE_CLASS_METRICS table
function
MON_SAMPLE_WORKLOAD_METRICS table function
MON_SERVICE_SUBCLASS_SUMMARY administrative
view
MON_TBSP_UTILIZATION administrative view
MON_TRANSACTION_LOG_UTILIZATION
administrative view
MON_WORKLOAD_SUMMARY administrative view
Table 11. MQSeries built-in SQL routines

Routine name
MQPUBLISH scalar function
MQREAD scalar function
Schema
Description
DB2MQ, DB2MQ1C
This scalar function publishes data to an

MQSeries location.
DB2MQ, DB2MQ1C
This scalar function returns a message from

an MQSeries location.
DB2MQ, DB2MQ1C
This table function returns a table with

messages and message metadata from an
MQSeries location.
DB2MQ
This table function returns a table

containing messages and message metadata
from a specified MQSeries location.
DB2MQ

a specified MQSeries location.
DB2MQ, DB2MQ1C

an MQSeries location and removes the
message from the associated queue.
DB2MQ, DB2MQ1C

containing the messages and message
metadata from an MQSeries location and
removes the messages from the associated
queue.
MQREADALL table function
MQREADALLCLOB table function
MQREADCLOB scalar function
MQRECEIVE scalar function
MQRECEIVEALL table function
15
Table 11. MQSeries built-in SQL routines (continued)

Routine name
Schema
Description
DB2MQ

containing messages and message metadata
from a specified MQSeries location.
DB2MQ

a specified MQSeries location.
DB2MQ, DB2MQ1C
This scalar function sends data to an

MQSeries location.
DB2MQ, DB2MQ1C
This scalar function subscribes to MQSeries

messages published on a specific topic.
DB2MQ, DB2MQ1C
This scalar function unsubscribes from

MQSeries messages published on a specific
topic.
MQRECEIVEALLCLOB table function
MQRECEIVECLOB scalar function

MQSEND scalar function
MQSUBSCRIBE scalar function
MQUNSUBSCRIBE scalar function
Table 12. Security built-in SQL routines and views:

Schema
Description
AUTH_GET_INSTANCE_AUTHID scalar
function
SYSPROC

authorization ID of the instance owner.
SYSPROC
This table function returns all authorities

held by the authorization ID, either found
in the database configuration file or granted
to an authorization ID directly or indirectly
through a group or a role.
SYSPROC
This table function returns the list of groups

of which the given authorization ID is a
member.
SYSPROC
This function returns the list of roles in

which the given authorization ID is a
member.
SYSIBMADM
This administrative view contains a list of

authorization IDs that have been granted
privileges or authorities, along with their
types, for the currently connected database.
SYSIBMADM
This administrative view contains all object

ownership information for the currently
connected database.
SYSIBMADM
This administrative view contains all

explicit privileges for the currently
connected database.
AUTH_LIST_AUTHORITIES_FOR_AUTHID
table function
AUTH_LIST_GROUPS_FOR_AUTHID table
function
AUTH_LIST_ROLES_FOR_AUTHID function
AUTHORIZATIONIDS administrative view
OBJECTOWNERS administrative view
PRIVILEGES administrative view
Table 13. Snapshot built-in SQL routines and views

LOCKS_HELD administrative view
Schema
Description
SYSIBMADM

information about the current locks held.
SYSIBMADM

information about the locks that are waiting
to be granted.
SYSIBMADM
This administrative view returns a list of

statements with information about the time
required to prepare the statement.
LOCKWAITS administrative view
QUERY_PREP_COST administrative view
16
Table 13. Snapshot built-in SQL routines and views (continued)

Schema
Description
SNAPDYN_SQL administrative view and

SNAP_GET_DYN_SQL table function
SYSIBMADM
(administrative view), return snapshot information from the
SYSPROC (table
dynsql logical data group.
function)
SNAPSUBSECTION administrative view and

SNAP_GET_SUBSECTION table function
SYSIBMADM
SYSPROC (table
function)
SNAPSWITCHES administrative view and

SNAP_GET_SWITCHES table function

SYSIBMADM
(administrative view), return information about the database
snapshot switch state.
SYSPROC (table
function)
SNAPTAB_REORG administrative view and

SNAP_GET_TAB_REORG table function
SYSIBMADM
(administrative view), return table reorganization information.
SYSPROC (table
function)
SNAPTBSP_QUIESCER administrative view

and SNAP_GET_TBSP_QUIESCER table
function

SYSIBMADM
(administrative view), return information about quiescers from a
table space snapshot.
SYSPROC (table
function)
SNAPTBSP_RANGE administrative view and

SNAP_GET_TBSP_RANGE table function
SYSIBMADM
(administrative view), return information from a range snapshot.
SYSPROC (table
function)
SNAPUTIL_PROGRESS administrative view

and SNAP_GET_UTIL_PROGRESS table
function

SYSIBMADM
(administrative view), return information about utility progress, in
particular, the progress logical data group.
SYSPROC (table
function)

return information about application
subsections, namely the subsection logical
monitor grouping.
SYSIBMADM
This administrative view returns the top

dynamic SQL statements sortable by
number of executions, average execution
time, number of sorts, or sorts per
statement.
Schema
Description
SYSPROC
This procedure alters values for the package

associated with a compiled SQL routine or
a compiled trigger, without the need for
rebinding.
SYSPROC
This scalar function returns a character

string value of the options that are to be
used for the creation of SQL procedures in
the current session.
SYSFUN
This procedure returns the information

necessary to install an identical routine on
another database server running at least at
the same level and operating system.
SYSFUN
This procedure passes the information

necessary to create and define an SQL
routine at the database server.
TOP_DYNAMIC_SQL administrative view
Table 14. SQL procedures built-in SQL routines

Routine name
ALTER_ROUTINE_PACKAGE procedure
GET_ROUTINE_OPTS scalar function
GET_ROUTINE_SAR procedure
PUT_ROUTINE_SAR procedure
17
Table 14. SQL procedures built-in SQL routines (continued)

Routine name
REBIND_ROUTINE_PACKAGE procedure
Schema
Description
SYSPROC
This procedure rebinds the package

associated with an SQL procedure.
SYSPROC
This procedure sets the options that are to

be used for the creation of SQL procedures
in the current session.
SET_ROUTINE_OPTS procedure
Table 15. Stepwise redistribute built-in SQL routines

Routine name
ANALYZE_LOG_SPACE procedure
GENERATE_DISTFILE procedure
GET_SWRD_SETTINGS procedure
SET_SWRD_SETTINGS procedure
STEPWISE_REDISTRIBUTE_DBPG procedure
Schema
Description
SYSPROC
This procedure returns log space analysis

information.
SYSPROC
This procedure generates a data

distribution file.
SYSPROC
This procedure returns redistribute

information.
SYSPROC
This procedure creates or changes the

redistribute registry.
SYSPROC
This procedure redistributes part of

database partition group.
Table 16. Storage management tool built-in SQL routines

Routine name
CAPTURE_STORAGEMGMT_INFO procedure
CREATE_STORAGEMGMT_TABLES procedure
DROP_STORAGEMGMT_TABLES procedure
Schema
Description
SYSPROC
This procedure returns storage-related

information for a given root object.
SYSPROC
This procedure creates storage management

tables.
SYSPROC
This procedure drops all storage

management tables.
Schema
Description
SYSPROC
This procedure runs text search

administrative commands using the SQL
CALL statement.
SYSPROC
This procedure changes the update

characteristics of an index.
SYSPROC
This procedure enables removal of obsolete

DB2 Text Search index collections within a
database.
SYSPROC
This procedure removes all command locks

for a specific text search index or for all
text search indexes in the database.
SYSPROC
This procedure deletes indexing events

from an index's event table used for
administration.
SYSPROC
This procedure applies text search server

connection information to the text search
catalog
Table 17. Text search built-in SQL routines

Routine name
SYSTS_ADMIN_CMD stored procedure
SYSTS_ALTER procedure
SYSTS_CLEANUP procedure
SYSTS_CLEAR_COMMANDLOCKS procedure
SYSTS_CLEAR_EVENTS procedure
SYSTS_CONFIGURE procedure
18
Table 17. Text search built-in SQL routines (continued)

Routine name
Schema
Description
SYSPROC
This procedure creates a text search index

for a text column which allows the column
data to be searched using text search
functions.
SYSPROC
This procedure disables DB2 Text Search for

the current database.
SYSPROC
This procedure drops an existing text

search index associated with any table
column.
SYSPROC
This procedure must be issued successfully

before text search indexes on columns in
tables within the database can be created.
SYSPROC
This procedure updates the text search

index to reflect the current contents of the
text columns with which the index is
associated.
SYSPROC
This procedure upgrades the DB2 Text

Search catalog, including the administrative
tables and administrative views, to the
latest product version.
SYSPROC
This procedure updates DB2 Text Search

index information in the text search catalog
tables.
SYSTS_CREATE procedure
SYSTS_DISABLE procedure
SYSTS_DROP procedure
SYSTS_ENABLE procedure
SYSTS_UPDATE procedure
SYSTS_UPGRADE_CATALOG procedure
SYSTS_UPGRADE_INDEX procedure
Table 18. Workload management built-in SQL routines

Routine name
Schema
Description
WLM_CANCEL_ACTIVITY procedure
SYSPROC
This procedure cancels the given activity.
WLM_CAPTURE_ACTIVITY_IN_PROGRESS
procedure
SYSPROC
This procedure sends information about the

given activity to the activities event
monitor.
WLM_COLLECT_STATS procedure
SYSPROC
This procedure gathers or resets statistics

for service classes, workloads, work classes,
threshold queues, and operating system
resources. If there is an active statistics
event monitor, writes them to the statistics
event monitor.
SYSPROC
This procedure alters an existing member

subset database object.
SYSPROC
This procedure creates a member subset

database object.
SYSPROC
This procedure drops an existing member

subset database object.
WLM_GET_CONN_ENV table function
SYSPROC
This table function returns for a particular

connection the values of settings that
control collection of activity data and
section actuals.
WLM_GET_QUEUE_STATS table function
SYSPROC
This table function returns basic statistic

information for one or more threshold
queues.
WLM_ALTER_MEMBER_SUBSET procedure
WLM_CREATE_MEMBER_SUBSET procedure
WLM_DROP_MEMBER_SUBSET procedure
19
Table 18. Workload management built-in SQL routines (continued)

Routine name
Schema
Description
WLM_GET_SERVICE_CLASS_AGENTS table
function
SYSPROC
This table function returns the list of agents

on the given partition that are executing in
the service class given by the
SERVICE_SUPERCLASS_NAME and
SERVICE_SUBCLASS_NAME or on behalf
of the application given by the
APPLICATION_HANDLE.
WLM_GET_SERVICE_CLASS_WORKLOAD
_OCCURRENCES table function
SYSPROC
This table function returns the list of all

workload occurrences executing in a given
service class on a particular partition.
WLM_GET_SERVICE_SUBCLASS_STATS table
function
SYSPROC
This table function returns basic statistics of

WLM_GET_SERVICE_SUPERCLASS_STATS
table function
SYSPROC
This table function returns basic statistics of

one or more service superclasses.
WLM_GET_WORK_ACTION_SET_STATS table SYSPROC

function
This table function returns basic statistics

for work classes in a work action set.
WLM_GET_WORKLOAD_OCCURRENCE
_ACTIVITIES table function
This table function returns the list of all

activities that were submitted through the
given application on the specified partition
and have not yet completed.
SYSPROC
WLM_GET_WORKLOAD_STATS table function SYSPROC
This table function returns basic statistics

for one or more workloads.
WLM_SET_CLIENT_INFO procedure
SYSPROC
This procedure sets client information

associated with the current connection at
the DB2 database server.
WLM_SET_CONN_ENV procedure
SYSPROC
This procedure enables for a particular

connection the collection of activity data
and measurement of section actuals.
Table 19. Miscellaneous built-in SQL routines and views

Schema
Description
SYSPROC
This procedure alters an existing table

using the input CREATE TABLE statement
as the target table definition.
SYSPROC
This table function returns the elements of

a compilation environment.
SYSIBMADM
This administrative view returns the list of

contact groups.
SYSIBMADM

contacts defined on the database server.
SYSIBMADM

information from the history file that is
associated with the currently connected
database partition.
SYSIBMADM
This administrative view returns the values

for database paths required for tasks such
as split mirror backups.
SYSPROC
This procedure calculates the database size

and maximum capacity.
ALTOBJ procedure
COMPILATION_ENV table function

CONTACTGROUPS administrative view
CONTACTS administrative view
DB_HISTORY administrative view
DBPATHS administrative view
GET_DBSIZE_INFO procedure
20
Table 19. Miscellaneous built-in SQL routines and views (continued)

Schema
Description
SYSIBMADM

contacts and contact groups that are
notified about the health of an instance.
SYSPROC
The table function returns log records,

event records and notification records from
a given facility.
SYSIBMADM
SYSPROC (table
function)

return problem determination log messages
that were logged in the DB2 notification
log. The information is intended for use by
database and system administrators.
SYSPROC
This procedure checks index statistics to

determine whether or not there is a need
for reorganization.
SYSPROC
This procedure checks table statistics to

determine whether or not there is a need
for reorganization.
SYSPROC
This scalar function has two versions. The

first allows for full flexibility of message
retrieval including using message tokens
and language selection. The second is a
simple interface which takes only an
SQLCODE as an input parameter and
returns the short message in English.
SYSPROC
This procedure creates or drops the

database objects that are required for a
specific tool.
NOTIFICATIONLIST administrative view
PD_GET_DIAG_HIST table function
PDLOGMSGS_LAST24HOURS administrative
view and PD_GET_LOG_MSGS table function
REORGCHK_IX_STATS procedure
REORGCHK_TB_STATS procedure
SQLERRM scalar function
SYSINSTALLOBJECTS procedure
Administrative routines and ADMIN_CMD procedure

ADMIN_CMD - Run administrative commands
The ADMIN_CMD procedure is used by applications to run administrative
commands using the SQL CALL statement.
Syntax
ADMIN_CMD (
command-string
The schema is SYSPROC.
Procedure parameter
command-string
An input argument of type CLOB (2M) that specifies a single command that is
to be executed.
Authorization
One of the following authorities is required to execute the routine:
v EXECUTE privilege on the routine
v DATAACCESS authority
21
v DBADM authority
v SQLADM authority
Default PUBLIC privilege

In a non-restrictive database, EXECUTE privilege is granted to PUBLIC when the
procedure is automatically created.
The procedure currently supports the following DB2 command line processor
(CLP) commands:
v ADD CONTACT
v ADD CONTACTGROUP
v AUTOCONFIGURE
v BACKUP - online only
v
v
v
v
v
v
v
DESCRIBE
DROP CONTACT
DROP CONTACTGROUP
EXPORT
FORCE APPLICATION
IMPORT
INITIALIZE TAPE
v LOAD
v PRUNE HISTORY/LOGFILE
v QUIESCE DATABASE
v QUIESCE TABLESPACES FOR TABLE
v REDISTRIBUTE
v REORG INDEXES/TABLE
v RESET ALERT CONFIGURATION
v RESET DATABASE CONFIGURATION
v RESET DATABASE MANAGER CONFIGURATION
v REWIND TAPE
v RUNSTATS
v
v
v
v
v
SET TAPE POSITION

UNQUIESCE DATABASE
UPDATE ALERT CONFIGURATION
UPDATE CONTACT
UPDATE CONTACTGROUP
v UPDATE DATABASE CONFIGURATION

v UPDATE DATABASE MANAGER CONFIGURATION
v UPDATE HEALTH NOTIFICATION CONTACT LIST
v UPDATE HISTORY
Note: Some commands might have slightly different supported syntax when
executed through the ADMIN_CMD procedure.
The procedure also supports the following commands which are not supported by
the CLP:
v GET STMM TUNING
22
v UPDATE STMM TUNING
Usage notes
Retrieving command execution information:
v As the ADMIN_CMD procedure runs on the server, the utility messages are also
created on the server. The MESSAGES ON SERVER option (refer to the specific
command for further details) indicates that the message file is to be created on
the server.
v Command execution status is returned in the SQLCA resulting from the CALL
statement.
v If the execution of the administrative command is successful, and the command
returns more than the execution status, the additional information is returned in
the form of a result set (up to two result sets). For example, if the EXPORT
command executes successfully, the returned result set contains information
about the number of exported rows; however, if the RUNSTATS command executes
successfully, no result set is returned. The result set information is documented
with the corresponding command.
v If the execution of the administrative command is not successful, an SQL20397W
warning message is returned by the ADMIN_CMD procedure along with a
result set containing more details about the reason for the failure of the
administrative command. Any application that uses the ADMIN_CMD
procedure should check the SQLCODE returned by the procedure. If the
SQLCODE is >= 0, the result set for the administrative command should be
retrieved. The following table indicates what information might be returned
depending on whether the MESSAGES ON SERVER option is used or not.
Table 20. SQLCODE and information returned by the ADMIN_CMD procedure
Administrative command
execution status
MESSAGES ON SERVER
option specified
MESSAGES ON SERVER
option not specified
Successful
The SQLCODE returned is

>= 0: Additional information
(result sets) returned, if any.
The SQLCODE returned is

>= 0: Additional information
(result sets) returned, if any,
but the MSG_RETRIEVAL
and MSG_REMOVAL
columns are NULL.
Failed
The SQLCODE returned

20397: Additional
information (result sets)
returned, but only the
MSG_RETRIEVAL and
MSG_REMOVAL columns
are populated.
The SQLCODE returned is <

0: No additional information
(result sets) is returned.
v The result sets can be retrieved from the CLP or from applications such as JDBC
and CLI applications, but not from embedded C applications.
v Case-sensitive names and double-byte character set (DBCS) names must be
enclosed inside a backward slash and double quotation delimiter, for example,
\" MyTabLe \".
For all commands executed through the ADMIN_CMD, the user ID that
established the connection to the database is used for authentication.
23
Any additional authority required, for example, for commands that need file
system access on the database server, is documented in the reference information
describing the command.
This procedure cannot be called from a user-defined function (SQLSTATE 38001) or
a trigger.
ADD CONTACT command using the ADMIN_CMD procedure:
Adds a contact to the contact list which can be either defined locally on the system
or in a global list. Contacts are users to whom processes such as the Scheduler and
Health Monitor send messages.
The setting of the Database Administration Server (DAS) contact_host
configuration parameter determines whether the list is local or global.
Authorization
None
Required connection
Database. The DAS must be running.
Command syntax
ADD CONTACT name TYPE
EMAIL
PAGE

MAXIMUM PAGE LENGTH
MAX LEN
pg-length
ADDRESS recipients address

DESCRIPTION
contact description
Command parameters
ADD CONTACT name
The name of the contact that will be added. By default the contact will be
added in the local system, unless the DB2 administration server
configuration parameter contact_host points to another system.
TYPE
Method of contact, which must be one of the following two:

EMAIL
This contact wants to be notified by email at (ADDRESS).
PAGE
This contact wants to be notified by a page sent to ADDRESS.

MAXIMUM PAGE LENGTH pg-length
If the paging service has a message-length restriction, it is
specified here in characters.
The notification system uses the SMTP protocol to send the
notification to the mail server specified by the DB2 Administration
Server configuration parameter smtp_server. It is the responsibility
of the SMTP server to send the email or call the pager.
ADDRESS recipients-address
The SMTP mailbox address of the recipient. For example,
24
joe@somewhere.org. The smtp_server DAS configuration parameter must

be set to the name of the SMTP server.
DESCRIPTION contact description
A textual description of the contact. This has a maximum length of 128
characters.
Example
Add a contact for user 'testuser' with email address 'testuser@test.com'.
CALL SYSPROC.ADMIN_CMD
(ADD CONTACT testuser TYPE EMAIL ADDRESS testuser@test.com)
Usage notes
The DAS must have been created and be running.
Command execution status is returned in the SQLCA resulting from the CALL
statement.
ADD CONTACTGROUP command using the ADMIN_CMD procedure:
Adds a new contact group to the list of groups defined on the local system. A
contact group is a list of users and groups to whom monitoring processes such as
the Scheduler and Health Monitor can send messages.
Authorization
None
Required connection
Command Syntax
,
ADD CONTACTGROUP name
CONTACT
GROUP
name

DESCRIPTION group description
Command Parameters
ADD CONTACTGROUP name
Name of the new contact group, which must be unique among the set of
groups on the system.
25
CONTACT name
Name of the contact which is a member of the group. A contact can be
defined with the ADD CONTACT command after it has been added to a group.
GROUP name
Name of the contact group of which this group is a member.
DESCRIPTION group description
Optional. A textual description of the contact group.
Example
Create a contact group named 'gname1' that contains two contacts: 'cname1' and
'cname2'.
CALL SYSPROC.ADMIN_CMD( add contactgroup gname1 contact cname1, contact cname2 )
Usage notes
statement.
AUTOCONFIGURE command using the ADMIN_CMD procedure:
Calculates and displays initial values for the buffer pool size, database
configuration and database manager configuration parameters, with the option of
applying these reported values.
Authorization
SYSADM
Required connection
Database
Command syntax
AUTOCONFIGURE
USING input-keyword param-value

APPLY
26
DB ONLY
DB AND DBM
NONE

ON CURRENT MEMBER
Command parameters
USING input-keyword param-value
Table 21. Valid input keywords and parameter values
Keyword
Default
Valid values value
mem_percent
1-100
25
Percentage of instance memory that is

assigned to the database. However, if the
CREATE DATABASE command invokes the
configuration advisor and you do not
specify a value for mem_percent, the
percentage is calculated based on memory
usage in the instance and the system up to
a maximum of 25% of the instance
memory.
workload_type
simple,
mixed,
complex
mixed
Simple workloads tend to be I/O intensive

and mostly transactions, whereas complex
workloads tend to be CPU intensive and
mostly queries.
num_stmts
1-1 000 000
10
Number of statements per unit of work
tpm
1-200 000
60
Transactions per minute
admin_priority
performance, both
recovery,
both
Optimize for better performance (more

transactions per minute) or better recovery
time
is_populated
yes, no
yes
Is the database populated with data?
num_local_apps
0-5 000
Number of connected local applications
num_remote_
apps
0-5 000
10
Number of connected remote applications
isolation
RR, RS, CS, UR RR
Maximum isolation level of applications

connecting to this database (Repeatable
Read, Read Stability, Cursor Stability,
Uncommitted Read). It is only used to
determine values of other configuration
parameters. Nothing is set to restrict the
applications to a particular isolation level
and it is safe to use the default value.
bp_resizeable
yes, no
Are buffer pools resizeable?
yes
Explanation
APPLY
DB ONLY
Displays the recommended values for the database configuration
and the buffer pool settings based on the current database manager
configuration. Applies the recommended changes to the database
configuration and the buffer pool settings.
DB AND DBM
Displays and applies the recommended changes to the database
manager configuration, the database configuration, and the buffer
pool settings.
NONE
Displays the recommended changes, but does not apply them.
ON CURRENT MEMBER
In a partitioned database environment or DB2 pureScale environment, the
Configuration Advisor updates the database configuration on all members
27
by default. Specifying the ON CURRENT MEMBER option causes the

Configuration Advisor to set the member-level configuration parameters on
the current member determined by your connection, while the global-level
configuration parameters, that can be configured to be functional at only
the global level, are set and affect all members.
The buffer pool changes are always applied to the system catalogs. Thus,
all members are affected. The ON CURRENT MEMBER option is ignored for
buffer pool recommendations.
Example
Invoke autoconfigure on a database through the ADMIN_CMD stored procedure.
CALL SYSPROC.ADMIN_CMD( AUTOCONFIGURE APPLY NONE )
The following is an example of the result set returned by the command.

LEVEL
-----...DBM
DBM
...
DB
DB
...
BP
NAME
----------------...ASLHEAPSZ
FCM_NUM_BUFFERS
VALUE
-------...15
512
RECOMMENDED_VALUE
-----------------15
512
DATATYPE
--------...BIGINT
BIGINT
APP_CTL_HEAP_SZ
APPGROUP_MEM_SZ
128
20000
144
14559
INTEGER
BIGINT
IBMDEFAULTBP
1000
164182
BIGINT
Usage notes
v This command makes configuration recommendations for the currently
connected database and assumes that the database is the only active database on
the instance. If you have not enabled the self tuning memory manager and you
have more than one active database on the instance, specify a mem_percent value
that reflects the database memory distribution. For example, if you have two
active databases on the instance that should use 80% of the instance memory
and should share the resources equally, specify 40% (80% divided by 2
databases) as the mem_percent value.
v If you have multiple instances on the same computer and the self tuning
memory manager is not enabled, you should set a fixed value for
instance_memory on each instance or specify a mem_percent value that reflects the
database memory distribution. For example, if all active databases should use
80% of the computer memory and there are 4 instances each with one database,
specify 20% (80% divided by 4 databases) as the mem_percent value.
v When explicitly invoking the Configuration Advisor with the AUTOCONFIGURE
command, the setting of the DB2_ENABLE_AUTOCONFIG_DEFAULT registry variable
will be ignored.
v Running the AUTOCONFIGURE command on a database will recommend
enablement of the Self Tuning Memory Manager. However, if you run the
AUTOCONFIGURE command on a database in an instance where sheapthres is not
zero, sort memory tuning (sortheap) will not be enabled automatically. To enable
sort memory tuning (sortheap), you must set sheapthres equal to zero using the
UPDATE DATABASE MANAGER CONFIGURATION command. Note that changing the
value of sheapthres may affect the sort memory usage in your previously
existing databases.
statement.
28
v The AUTOCONFIGURE command issues a COMMIT statement at the end if its

execution. In the case of Type-2 connections this will cause the ADMIN_CMD
procedure to return SQL30090N with reason code 2.
Compatibilities
For compatibility with previous versions:
v NODE and DBPARTITIONNUM can be specified in place of MEMBER, except when the
DB2_ENFORCE_MEMBER_SYNTAX registry variable is set to ON.
Result set information
statement. If execution is successful, the command returns additional information
the following result set:
Table 22. Result set returned by the AUTOCONFIGURE command
Column name
Data type
Description
LEVEL
VARCHAR(3)
Level of parameter and is one of:

v BP for buffer pool level
v DBM for database manager level
v DB for database level
NAME
VARCHAR(128)
v If LEVEL is DB or DBM, this

contains the configuration
parameter keyword.
v If LEVEL is BP, this value
contains the buffer pool name.
VALUE
VARCHAR(256)
v If LEVEL is DB or DBM, and the

recommended values were
applied, this column contains
the value of the configuration
parameter identified in the
NAME column before applying
the recommended value (that is,
it contains the old value). If the
change was not applied, this
column contains the current
on-disk (deferred value) of the
identified configuration
parameter.
v If LEVEL is BP, and the
recommended values were
applied, this column contains
the size (in pages) of the buffer
pool identified in the NAME
column before applying the
recommended value (that is, it
contains the old size). If the
change was not applied, this
column contains the current size
(in pages) of the identified
buffer pool.
29
Table 22. Result set returned by the AUTOCONFIGURE command (continued)

Column name
Data type
Description
RECOMMENDED_VALUE
VARCHAR(256)
v If LEVEL is DB or DBM, this

column contains the
recommended (or applied) value
of the configuration parameter
identified in the parameter
column.
v If type is BP, this column
contains the recommended (or
applied) size (in pages) of the
buffer pool identified in the
parameter column.
DATATYPE
VARCHAR(128)
Parameter data type.
BACKUP DATABASE command using the ADMIN_CMD procedure:

Creates a backup copy of a database or a table space.
For information about the backup operations supported by DB2 database systems
between different operating systems and hardware platforms, see Backup and
restore operations between different operating systems and hardware platforms.
Scope
In a partitioned database environment, if no database partitions are specified, this
command affects only the database partition on which it is executed.
If the option to perform a partitioned backup is specified, the command can be
called only on the catalog database partition. If the option specifies that all
database partition servers are to be backed up, it affects all database partition
servers that are listed in the db2nodes.cfg file. Otherwise, it affects the database
partition servers that are specified on the command.
Authorization
One of the following authorities:
v SYSADM
v SYSCTRL
v SYSMAINT
Required connection
Database. The existing database connection remains after the completion of the
backup operation.
Command syntax
30
BACKUP
DATABASE
DB
database-alias

ON
DBPARTITIONNUM
DBPARTITIONNUMS
ALL DBPARTITIONNUMS
Partition number(s)
EXCEPT
DBPARTITIONNUM
DBPARTITIONNUMS
Partition number(s)
ONLINE

,
INCREMENTAL
DELTA
TABLESPACE
( tablespace-name
)

USE
TSM
XBSA
SNAPSHOT
Open sessions
Options
DEDUP_DEVICE
LIBRARY library-name
SCRIPT script-name
library-name
Open sessions
Options
,
LOAD
TO
dir
dev

WITH
num-buffers
BUFFERS
BUFFER
buffer-size
PARALLELISM

COMPRESS
COMPRLIB
name
COMPROPTS
string
EXCLUDE
WITHOUT PROMPTING

UTIL_IMPACT_PRIORITY
EXCLUDE LOGS
INCLUDE LOGS
priority
Partition number(s):
,
(
db-partition-number1
)
TO
Open sessions:
OPEN num-sessions SESSIONS
Options:
OPTIONS
"options-string"
@ file-name
Command parameters
DATABASE | DB database-alias
Specifies the alias of the database to back up. The alias must be a local
database defined on the server and must be the database name that the
user is currently connected to. If the database-alias is not the one the user
is connected to, an SQL20322N error is returned.
31
ON
Backup the database on a set of database partitions. This clause shall be

specified only on the catalog partition.
DBPARTITIONNUM db-partition-number1
Specifies a database partition number in the database partition list.
DBPARTITIONNUMS db-partition-number1 TO db-partition-number2
Specifies a range of database partition numbers, so that all
partitions from db-partition-number1 up to and including
db-partition-number2 are included in the database partition list.
ALL DBPARTITIONNUMS
Specifies that the database is to be backed up on all partitions
specified in the db2nodes.cfg file.
EXCEPT Specifies that the database is to be backed up on all
partitions specified in the db2nodes.cfg file, except those
specified in the database partition list.
DBPARTITIONNUM db-partition-number1
Specifies a database partition number in the
database partition list.
DBPARTITIONNUMS db-partition-number1 TO
Specifies a range of database partition numbers, so
that all partitions from db-partition-number1 up to
and including db-partition-number2 are included in
the database partition list.
TABLESPACE tablespace-name
A list of names used to specify the table spaces to be backed up.
ONLINE
Specifies online backup. This is the only supported mode and is the
default. The ONLINE clause does not need to be specified.
INCREMENTAL
Specifies a cumulative (incremental) backup image. An incremental backup
image is a copy of all database data that has changed since the most recent
successful, full backup operation.
DELTA
Specifies a noncumulative (delta) backup image. A delta backup

image is a copy of all database data that has changed since the
most recent successful backup operation of any type.
TSM
Specifies that the backup is to use Tivoli Storage Manager (TSM)

as the target device.
XBSA
Specifies that the XBSA interface is to be used. Backup Services

APIs (XBSA) are an open application programming interface for
applications or facilities needing data storage management for
backup or archiving purposes.
USE
SNAPSHOT
Specifies that a snapshot backup is to be taken.
You cannot use the SNAPSHOT parameter with any of the following
parameters:
v TABLESPACE
32
v
v
v
v
v
INCREMENTAL
WITH num-buffers BUFFERS
BUFFER
PARALLELISM
COMPRESS
v UTIL_IMPACT_PRIORITY
v SESSIONS
The default behavior for a snapshot backup is a full database
offline backup of all paths that make up the database including all
containers, local volume directory, database path (DBPATH), and
primary log and mirror log paths (INCLUDE LOGS is the default for
all snapshot backups unless EXCLUDE LOGS is explicitly stated).
LIBRARY library-name
Integrated into IBM DB2 Server is a DB2 ACS API driver
for the following storage hardware:
v IBM TotalStorage SAN Volume Controller
v IBM Enterprise Storage Server Model 800
v IBM Storwize V7000
v IBM System Storage DS6000
v IBM System Storage DS8000
v IBM System Storage N Series
v IBM XIV
If you have other storage hardware, and a DB2 ACS API
driver for that storage hardware, you can use the LIBRARY
parameter to specify the DB2 ACS API driver.
The value of the LIBRARY parameter is a fully-qualified
library file name.
SCRIPT script-name
The name of the executable script capable of performing a
snapshot backup operation. The script name must be a
fully qualified file name.
OPTIONS
"options-string"
Specifies options to be used for the backup operation. The string
will be passed exactly as it was entered, without the double
quotation marks.
@ file-name
Specifies that the options to be used for the backup operation are
contained in a file located on the DB2 server. The string will be
passed to the vendor support library. The file must be a fully
qualified file name.
You cannot use the vendoropt database configuration parameter to specify
vendor-specific options for snapshot backup operations. You must use the
OPTIONS parameter of the backup utilities instead.
OPEN num-sessions SESSIONS
The number of I/O sessions to create between the DB2 product and the
TSM product or another backup vendor product. This parameter has no
effect when you back up to tape, disk, or other local device. If you specify
33
the INCLUDE LOGS parameter for an online backup, an extra session is

created for the OPEN num-sessions SESSIONS parameter after the initial
sessions are closed. If you are creating a Single System View (SSV) online
backup, for each node backed up, an extra session is created for the OPEN
num-sessions SESSIONS parameter after the initial sessions are closed. If you
use this parameter with the TSM option, the number of entries that are
created in the history file is equal to the number of sessions created.
TO dir | dev
A list of directory or tape device names. The full path on which the
directory resides must be specified. This target directory or device must be
locally addressable on the database server.
In a partitioned database, the target directory or device must exist on all
database partitions, and can optionally be a shared path. The directory or
device name may be specified using a database partition expression. For
more information about database partition expressions, see Automatic
storage databases.
This parameter can be repeated to specify the target directories and devices
that the backup image will span. If more than one target is specified
(target1, target2, and target3, for example), target1 will be opened first. The
media header and special files (including the configuration file, table space
table, and history file) are placed in target1. All remaining targets are
opened, and are then used in parallel during the backup operation.
Because there is no general tape support on Windows operating systems,
each type of tape device requires a unique device driver.
Use of tape devices or floppy disks might require prompts and user
interaction, which will result in an error being returned.
If the tape system does not support the ability to uniquely reference a
backup image, it is recommended that multiple backup copies of the same
database not be kept on the same tape.
LOAD library-name
The name of the shared library (DLL on Windows operating systems)
containing the vendor backup and restore I/O functions to be used. It can
contain the full path. If the full path is not given, it will default to the path
on which the user exit program resides.
DEDUP_DEVICE
Optimizes the format of the backup images for target storage devices that
support data deduplication.
WITH num-buffers BUFFERS
The number of buffers to be used. If the number of buffers that you specify
is not enough to create a successful backup, then the minimum value
necessary to complete the backup is automatically chosen for this
parameter. If you are backing up to multiple locations, you can specify a
larger number of buffers to improve performance. If you specify the
COMPRESS parameter, to help improve performance, you can add an extra
buffer for each table space that you specify for the PARALLELISM parameter.
BUFFER buffer-size
The size, in 4 KB pages, of the buffer used when building the backup
image. DB2 will automatically choose an optimal value for this parameter
unless you explicitly enter a value. The minimum value for this parameter
is 8 pages.
34
If using tape with variable block size, reduce the buffer size to within the
range that the tape device supports. Otherwise, the backup operation
might succeed, but the resulting image might not be recoverable.
With most versions of Linux, using the default buffer size included with
DB2 for backup operations to a SCSI tape device results in error
SQL2025N, reason code 75. To prevent the overflow of Linux internal SCSI
buffers, use this formula:
bufferpages <= ST_MAX_BUFFERS * ST_BUFFER_BLOCKS / 4
where bufferpages is the value you want to use with the BUFFER parameter,
and ST_MAX_BUFFERS and ST_BUFFER_BLOCKS are defined in the Linux kernel
under the drivers/scsi directory.
PARALLELISM n
Determines the number of table spaces which can be read in parallel by the
backup utility. DB2 will automatically choose an optimal value for this
parameter unless you explicitly enter a value.
UTIL_IMPACT_PRIORITY priority
Specifies that the backup will run in throttled mode, with the priority
specified. Throttling allows you to regulate the performance impact of the
backup operation. Priority can be any number between 1 and 100, with 1
representing the lowest priority, and 100 representing the highest priority.
If the UTIL_IMPACT_PRIORITY keyword is specified with no priority, the
backup will run with the default priority of 50. If UTIL_IMPACT_PRIORITY is
not specified, the backup will run in unthrottled mode. An impact policy
must be defined by setting the util_impact_lim configuration parameter
for a backup to run in throttled mode.
COMPRESS
Indicates that the backup is to be compressed.
COMPRLIB name
Indicates the name of the library to be used to perform the
compression (for example, db2compr.dll for Windows;
libdb2compr.so for Linux and UNIX operating systems). The name
must be a fully qualified path referring to a file on the server. If
this parameter is not specified, the default DB2 compression library
will be used. If the specified library cannot be loaded, the backup
will fail.
EXCLUDE
Indicates that the compression library will not be stored in the
backup image.
COMPROPTS string
Describes a block of binary data that will be passed to the
initialization routine in the compression library. DB2 will pass this
string directly from the client to the server, so any issues of byte
reversal or code page conversion will have to be handled by the
compression library. If the first character of the data block is '@',
the remainder of the data will be interpreted by DB2 as the name
of a file residing on the server. DB2 will then replace the contents
of string with the contents of this file and will pass this new value
to the initialization routine instead. The maximum length for string
is 1024 bytes.
EXCLUDE LOGS
Specifies that the backup image should not include any log files. When
35
performing an offline backup operation, logs are excluded whether or not

this option is specified, with the exception of snapshot backups.Logs are
excluded by default in the following backup scenarios:
v Offline backup of a single-partitioned database.
v Online or offline backup of a multi-partitioned database, when not using
a single system view backup.
If you specify the EXCLUDE LOGS with a snapshot backup, writes to log files
are allowed during the backup. These log files will be included by default
in the snapshot backup, but are not usable for recovery. If this backup is
restored, the log files must not be extracted from the backup. If the log
path was set to the default when the backup was taken, then it is not
possible to exclude the log files from being restored and they must be
deleted manually after the backup is restored. If the log path was not the
default, then the log files can be excluded at restore time by using the
LOGTARGET EXCLUDE options with the RESTORE DATABASE command.
INCLUDE LOGS
Specifies that the backup image should include the range of log files
required to restore and roll forward this image to some consistent point in
time. This option is not valid for an offline backup, with the exception of
snapshot backups. INCLUDE LOGS is always the default option for any online
backup operation, except a multi-partitioned online backup where each
database partition is backed up independently (that is, a non-single system
view backup).
If any of the log files that are required for the backup have previously been
backed up and are no longer in the log path, then the DB2 database
manager retrieves them for backup from the overflow log path, if the path
has been set. Otherwise, the database manager retrieves them for backup
from the current log path or mirror log path. These log files are removed
from the log path after the backup has completed.
WITHOUT PROMPTING
Specifies that the backup will run unattended, and that any actions which
normally require user intervention will return an error message. This is the
default.
Examples
The following is a sample weekly incremental backup strategy for a recoverable
database. It includes a weekly full database backup operation, a daily
non-cumulative (delta) backup operation, and a midweek cumulative (incremental)
backup operation:
(Sun) CALL SYSPROC.ADMIN_CMD(backup db sample online
(Mon) CALL SYSPROC.ADMIN_CMD
(backup db sample online incremental delta use
(Tue) CALL SYSPROC.ADMIN_CMD
(Wed) CALL SYSPROC.ADMIN_CMD
(backup db sample online incremental use tsm)
(Thu) CALL SYSPROC.ADMIN_CMD
(Fri) CALL SYSPROC.ADMIN_CMD
(Sat) CALL SYSPROC.ADMIN_CMD
(backup db sample online incremental use tsm)
36
use tsm)
tsm)
tsm)
tsm)
tsm)
Usage notes
v The data in a backup cannot be protected by the database server. Make sure that
backups are properly safeguarded, particularly if the backup contains
LBAC-protected data.
v When backing up to tape, use of a variable block size is currently not supported.
If you must use this option, ensure that you have well tested procedures in place
that enable you to recover successfully, using backup images that were created
with a variable block size.
v The backup utility cannot be used with a Type 2 connection.
v When using a variable block size, you must specify a backup buffer size that is
less than or equal to the maximum limit for the tape devices that you are using.
For optimal performance, the buffer size must be equal to the maximum block
size limit of the device being used.
v Snapshot backups should be complemented with regular disk backups in case of
failure in the filer/storage system.
v As you regularly backup your database, you might accumulate very large
database backup images, many database logs and load copy images, all of which
might be taking up a large amount of disk space. Refer to Managing recovery
objects for information about how to manage these recovery objects.
v You can use the OPTIONS parameter to enable backup operations in TSM
environments supporting proxy nodes. For more information, see the
Configuring a Tivoli Storage Manager client topic.
v You can use the DB2_BCKP_PAGE_VALIDATION registry variable to enable DMS and
AS page validation during the backup.
v You can use the DB2_BCKP_INCLUDE_LOGS_WARNING registry variable to specify that
some online backups can now succeed even if they have not successfully
included all of the required logs.
statement. If execution is successful, the command returns additional information.
The backup operation will return one result set, comprising one row per database
partition that participated in the backup.
Table 23. Result set for a backup operation
Column name
Data type
Description
BACKUP_TIME
VARCHAR(14)
Corresponds to the
timestamp string used to
name the backup image.
DBPARTITIONNUM
SMALLINT
The database partition

number on which the agent
executed the backup
operation.
SQLCODE
INTEGER
Final SQLCODE resulting

from the backup processing
on the specified database
partition.
SQLERRMC
VARCHAR(70)
Final SQLERRMC resulting

partition.
37
Table 23. Result set for a backup operation (continued)

Column name
Data type
Description
SQLERRML
SMALLINT
Final SQLERRML resulting

partition.
If a nonpartitioned database is backed up, or if a partitioned database is backed up

using the traditional single-partition syntax, the result set will comprise a single
row. DBPARTITIONNUM will contain the identifier number of the database partition
being backed up.
SQLCODE, SQLERRMC, and SQLERRML refer to the equivalently-named
members of the SQLCA that is returned by the backup on the specified database
partition.
DESCRIBE command using the ADMIN_CMD procedure:
The DESCRIBE command displays metadata about the columns, indexes, and data
partitions of tables or views. This command can also display metadata about the
output of SELECT, CALL, or XQuery statements.
Use the DESCRIBE command to display information about any of the following
items:
v Output of a SELECT, CALL, or XQuery statement
v Columns of a table or a view
v Indexes of a table or a view
v Data partitions of a table or view
Authorization
The authorization required depends on the type of information you want to
display using the DESCRIBE command.
v If the SYSTOOLSTMPSPACE table space exists, one of the authorities shown in
the following table is required.
Object to display information about
Privileges or authorities required
Output of a SELECT statement or XQuery

statement
Any of the following privileges or

authorities for each table or view referenced
in the SELECT statement:
v SELECT privilege
v DBADM authority
v SQLADM authority
v EXPLAIN authority
Output of a CALL statement

authorities:
v EXECUTE privilege on the stored
procedure
38
Columns of a table or a view

authorities for the SYSCAT.COLUMNS
system catalog table:
v SELECT privilege
v ACCESSCTRL authority
v DBADM authority
v SECADM authority
v SQLADM authority
If you want to use the SHOW DETAIL
parameter, you also require any of these
privileges or authorities on the
SYSCAT.DATAPARTITIONEXPRESSION
system catalog table.
Because PUBLIC has all the privileges over
declared temporary tables, you can use the
command to display information about any
declared temporary table that exists within
your connection.
Indexes of a table or a view

authorities on the SYSCAT.INDEXES system
catalog table:
v SELECT privilege
v DBADM authority
v SECADM authority
v SQLADM authority
If you want to use the SHOW DETAIL
parameter, you also require EXECUTE
privilege on the GET_INDEX_COLNAMES()
UDF.
your connection.
39
Data partitions of a table or view

authorities on the
SYSCAT.DATAPARTITIONS system catalog
table:
v SELECT privilege
v DBADM authority
v SECADM authority
v SQLADM authority
your connection.
v If the SYSTOOLSTMPSPACE table space does not exist, SYSADM or SYSCTRL

authority is also required in addition to the one of the previously listed
authorities.
Required connection
Database
Command syntax
DESCRIBE
OUTPUT
select-statement
call-statement
XQUERY XQuery-statement
TABLE
table-name
INDEXES FOR TABLE
SHOW DETAIL
RELATIONAL DATA
XML DATA
TEXT SEARCH
DATA PARTITIONS FOR TABLE
Command parameters
OUTPUT Indicates that the output of the statement should be described. This
keyword is optional.
select-statement | call-statement | XQUERY XQuery-statement
Identifies the statement about which information is wanted. The
statement is automatically prepared by CLP. To identify an XQuery
statement, precede the statement with the keyword XQUERY. A
DESCRIBE OUTPUT statement only returns information about an
implicitly hidden column if the column is explicitly specified as
part of the SELECT list of the final result table of the query
described.
TABLE table-name
Specifies the table or view to be described. The fully qualified name in the
40
form schema.table-name must be used. An alias for the table cannot be used
in place of the actual table. Information about implicitly hidden columns is
returned, but SHOW DETAIL must be used to indicate which columns are
implicitly hidden.
The DESCRIBE TABLE command lists the following information about each
column:
v Column name
v
v
v
v
v
Type schema
Type name
Length
Scale
Nulls (yes/no)
INDEXES FOR TABLE table-name

Specifies the table or view for which indexes need to be described. You can
use the fully qualified name in the form schema.table-name or you can just
specify the table-name and default schema will be used automatically. An
alias for the table cannot be used in place of the actual table.
The DESCRIBE INDEXES FOR TABLE command lists the following information
about each index of the table or view:
v Index schema
v Index name
v Unique rule
v Number of columns
v Index type
If the DESCRIBE INDEXES FOR TABLE command is specified with the SHOW
DETAIL option, the index name is truncated when the index name is greater
than 18 bytes. If no index type option is specified, information for all index
types is listed: relational data index, index over XML data, and Text Search
index. The output includes the following additional information:
v Index ID for a relational data index, an XML path index, an XML regions
index, or an index over XML data
v Data Type for an index over XML data
v Hashed for an index over XML data
v
v
v
v
v
v
Max VARCHAR Length for an index over XML data

XML Pattern specified for an index over XML data
Codepage for a text search index
Language for a text search index
Format specified for a text search index
Update minimum for a text search index
v Update frequency for a text search index

v Collection directory for a text search index
v Column names of the indexes that are preceded by + for an ascending
order, - for a descending order, and * for a random order.
v Expressions in square brackets following the generated column name for
any part of an index key that is based on an expression.
v Whether the BUSINESS_TIME WITHOUT OVERLAPS clause is specified
41
Specify an index type to list information for only a specific index type.
Specifying multiple index types is not supported.
Column name is truncated when it is greater than 8256 bytes.
RELATIONAL DATA
If the RELATIONAL DATA index type option is specified without the
SHOW DETAIL option, only the following information is listed:
v Index schema
v Index name
v Unique rule
v Number of columns
v Null keys
If SHOW DETAIL is specified, the column names information is also
listed.
XML DATA
If the XML DATA index type option is specified without the SHOW
DETAIL option, only the following information is listed:
v Index schema
v Index name
v Unique rule
v Number of columns
v Index type
If SHOW DETAIL is specified, the following information for an index
over XML data is also listed:
v Index ID
v Data type
v
v
v
v
Hashed
Max Varchar length
XML Pattern
Column names
TEXT SEARCH
If the TEXT SEARCH index type option is specified without the SHOW
DETAIL option, only the following information is listed:
v Index schema
v Index name
If SHOW DETAIL is specified, the following text search index
information is also listed:
v
v
v
v
v
v
v
Column name
Codepage
Language
Format
Update minimum
Update frequency
Collection directory
If the TEXT SEARCH option is specified and a text search option is

not installed or not properly configured, an error (SQLSTATE
42724) is returned.
42
See DB2 Text Search for information listed in the columns.

DATA PARTITIONS FOR TABLE table-name
Specifies the table or view for which data partitions need to be described.
The information displayed for each data partition in the table includes; the
partition identifier and the partitioning intervals. Results are ordered
according to the partition identifier sequence. The fully qualified name in
the form schema.table-name must be used. An alias for the table cannot be
used in place of the actual table. The schema is the user name under which
the table or view was created.
For the DESCRIBE DATA PARTITIONS FOR TABLE command, specifies that
output include a second table with the following additional information:
v Data partition sequence identifier
v Data partition expression in SQL
SHOW DETAIL
For the DESCRIBE TABLE command, specifies that output include the
following additional information as well as a second result set which
contains the table data partition expressions (which might return 0 rows if
the table is not data partitioned):
v Whether a CHARACTER, VARCHAR or LONG VARCHAR column was
defined as FOR BIT DATA
v Column number
v Distribution key sequence
v Code page
v Hidden attribute
v Default
v Table partitioning type (for tables partitioned by range this output
appears after the original output)
v Partitioning key columns (for tables partitioned by range this output
v Identifier of table space used for the index
v Periods that are defined on the table (for temporal tables this output
v Whether versioning is enabled on the table (for temporal tables this
output appears after the original output)
Examples
Describing the output of a SELECT statement
The following example shows how to describe a SELECT statement:
CALL SYSPROC.ADMIN_CMD(describe select * from emp_photo)
The following is an example of output for this SELECT statement.

Result set 1
-------------SQLTYPE_ID
---------452
448
405
SQLTYPE
SQLLENGTH SQLSCALE SQLNAME_DATA
---------..- --------- -------- ------------..CHARACTER
6
0 EMPNO
VARCHAR
10
0 PHOTO_FORMAT
BLOB
102400
0 PICTURE
...
...
...
...
...
43
3 record(s) selected.
Return Status = 0
Output for this SELECT statement (continued).

... SQLNAME_LENGTH SQLDATATYPENAME_DATA
SQLDATATYPENAME_LENGTH
... -------------- ---------------------..- ----------------------...
5 SYSIBM .CHARACTER
18
...
12 SYSIBM .VARCHAR
16
...
7 SYSIBM .BLOB
13
Describing a table
Describing a non-partitioned table.
CALL SYSPROC.ADMIN_CMD(describe table org show detail)
The following is an example of output for this CALL statement.

Result set 1
-------------COLNAME
TYPESCHEMA
-------...- ----------...DEPTNUMB
SYSIBM
DEPTNAME
SYSIBM
MANAGER
SYSIBM
DIVISION
SYSIBM
LOCATION
SYSIBM
TYPENAME
--------...SMALLINT
VARCHAR
SMALLINT
VARCHAR
VARCHAR
FOR_BINARY_DATA
---------------...N
N
N
N
N
...
...
...
...
...
...
...
Output for this CALL statement (continued).

... LENGTH SCALE NULLABLE COLNO PARTKEYSEQ CODEPAGE DEFAULT
... ------ ----- -------- ----- ---------- -------- ------...
2
0 N
0
1
0 ...
14
0 Y
1
0
1208 ...
2
0 Y
2
0
0 ...
10
0 Y
3
0
1208 ...
13
0 Y
4
0
1208 -

Result set 2
-------------DATA_PARTITION_KEY_SEQ DATA_PARTITION_EXPRESSION
---------------------- -------------------------0 record(s) selected.
Return Status = 0
Describing a partitioned table.

CALL SYSPROC.ADMIN_CMD(describe table part_table1 show detail)

Result set 1
-------------COLNAME
TYPESCHEMA
TYPENAME FOR_BINARY_DATA ...
-------...- ----------...- -------- --------------- ...
COL1
SYSIBM
INTEGER N
...

... LENGTH SCALE NULLABLE COLNO PARTKEYSEQ CODEPAGE DEFAULT
... ------ ----- -------- ----- ---------- -------- ------...
4
0 N
0
1
0
-
44

Result set 2
-------------DATA_PARTITION_KEY_SEQ DATA_PARTITION_EXPRESSION
---------------------- -------------------------1 COL1
1 record(s) selected
Describing a table index

The following example shows how to describe a table index. This call
describes table USER1.DEPARTMENT and lists two relational data indexes,
six xml data indexes, two text search indexes, and the system indexes:
CALL SYSPROC.ADMIN_CMD(describe indexes for table user1.department)

Result set 1
-------------INDSCHEMA
----------...
SYSIBM
SYSIBM
USER1
USER1
SYSIBM
USER1
SYSIBM
USER1
SYSIBM
USER1
SYSIBM
USER1
SYSIBM
USER1
SYSIBM
USER1
SYSIBM
USER1
USER1
INDNAME
------------------...
SQL070531145253450
SQL070531145253620
RELIDX1
RELIDX2
SQL070531145253650
XMLIDX1
SQL070531154625650
XMLIDX2
SQL070531154626000
XMLIDX3
SQL070531154626090
XMLIDX4
SQL070531154626190
XMLIDX5
SQL070531154626290
XMLIDX6
SQL070531154626400
TXTIDX1
TXTIDX2
UNIQUE_RULE
------------------DUPLICATES_ALLOWED
UNIQUE_ENTRIES_ONLY
DUPLICATES_ALLOWED
DUPLICATES_ALLOWED
PRIMARY_INDEX
DUPLICATES_ALLOWED
DUPLICATES_ALLOWED
DUPLICATES_ALLOWED
DUPLICATES_ALLOWED
DUPLICATES_ALLOWED
DUPLICATES_ALLOWED
DUPLICATES_ALLOWED
DUPLICATES_ALLOWED
DUPLICATES_ALLOWED
DUPLICATES_ALLOWED
DUPLICATES_ALLOWED
DUPLICATES_ALLOWED
-
Return Status = 0

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
COLCOUNT
--------1
1
2
1
1
1
1
1
1
1
1
1
1
1
INDEXTYPE
-------------------------XML_DATA_REGIONS
XML_DATA_PATH
RELATIONAL_DATA
RELATIONAL_DATA
RELATIONAL_DATA
XML_DATA_VALUES_LOGICAL
XML_DATA_VALUES_PHYSICAL
45
...
...
...
...
1
1
1
1
TEXT_SEARCH
TEXT_SEARCH
Describing index with an expression-based key.

Given an expression-based index created with the statement:
CREATE INDEX emp_comp ON staff(UPPER(name), salary+bonus, id)
The following example shows how to describe a expression-based index.

CALL SYSPROC.ADMIN_CMD(describe indexes for table staff show detail)
Note: The 'Column names' column of the DESCRIBE output would include
the following information based on the previous statement.
+K00 [UPPER(name)] + K01 [salary + bonus] + id
Describing a data partition
The following example shows how to describe data partitions.
CALL SYSPROC.ADMIN_CMD(describe data partitions for table part_table2)

Result set 1
-------------DATA_PARTITION_ID
----------------0
1
2
LOW_KEY_INCLUSIVE
----------------Y
Y
Y
LOW_KEY_VALUE
------------1
10
20
...
...
...
...
...

...
...
...
...
...
HIGH_KEY_INCLUSIVE
-----------------N
N
N
HIGH_KEY_VALUE
-------------10
20
40
The following example shows how to describe data partitions with 'SHOW
DETAIL' clause.
CALL SYSPROC.ADMIN_CMD(describe data partitions
for table part_table2 show detail)

Result set 1
----------------0
1
2
LOW_KEY_INCLUSIVE
----------------Y
Y
Y
LOW_KEY_VALUE
------------1
10
20
Return Status = 0
46
...
...
...
...
...
...
...
...
...
...
HIGH_KEY_INCLUSIVE
-----------------N
N
N
HIGH_KEY_VALUE
-------------10
20
40

Result set 2
----------------0
1
2
DATA_PARTITION_NAME TBSPID ...

------------------- ------ ...
PART0
3 ...
PART1
3 ...
PART2
3 ...
Return Status = 0

... PARTITION_OBJECT_ID LONG_TBSPID ACCESSMODE STATUS
... ------------------- ----------- ----------- -----...
15
3 FULL_ACCESS
...
16
3 FULL_ACCESS
...
17
3 FULL_ACCESS
Usage note
If the DESCRIBE command tries to create a temporary table and fails, creation of
SYSTOOLSTMPSPACE is attempted, and then creation of the temporary table is
attempted again, this time in SYSTOOLSTMPSPACE. SYSCTRL or SYSADM
authority is required to create the SYSTOOLSTMPSPACE table space.
statement. If execution is successful, the commands return additional information
in result sets as follows:
v Table 24: DESCRIBE select-statement, DESCRIBE call-statement and DESCRIBE XQUERY
XQuery-statement commands
v Table 25 on page 48: Result set 1 for the DESCRIBE TABLE command
v Table 26 on
v Table 27 on
v Table 28 on
command
v Table 29 on
command
page 49: Result set 2 for the DESCRIBE TABLE command

page 49: DESCRIBE INDEXES FOR TABLE command
page 51: Result set 1 for the DESCRIBE DATA PARTITIONS FOR TABLE
page 51: Result set 2 for the DESCRIBE DATA PARTITIONS FOR TABLE
Table 24. Result set returned by the DESCRIBE select-statement, DESCRIBE call-statement and DESCRIBE
XQUERY XQuery-statement commands
Column name
Data type
LOB only1
Description
SQLTYPE_ID
SMALLINT
No
Data type of the column, as it

appears in the SQLTYPE field of the
SQL descriptor area (SQLDA).
SQLTYPE
VARCHAR (257)
No
Data type corresponding to the

SQLTYPE_ID value.
47
Table 24. Result set returned by the DESCRIBE select-statement, DESCRIBE call-statement and DESCRIBE
XQUERY XQuery-statement commands (continued)
Column name
Data type
LOB only1
Description
SQLLEN
INTEGER
No
Length attribute of the column, as it

appears in the SQLLEN field of the
SQLDA.
SQLSCALE
SMALLINT
No
Number of digits in the fractional

part of a decimal value; 0 in the case
of other data types.
SQLNAME_DATA
VARCHAR (128)
No
Name of the column.
SQLNAME_LENGTH
SMALLINT
No
Length of the column name.
SQLDATA_TYPESCHEMA
VARCHAR (128)
Yes
Data type schema name.
SQLDATA_TYPENAME
VARCHAR (128)
Yes
Data type name.
Note: 1: Yes indicates that non-null values are returned only when there is LOB
data being described.
Table 25. Result set 1 returned by the DESCRIBE TABLE command
Column name
Data type
Detail2
Description
COLNAME
VARCHAR (128)
No
Column name.
TYPESCHEMA
VARCHAR (128)
No
If the column name is distinct, the

schema name is returned, otherwise,
'SYSIBM' is returned.
TYPENAME
VARCHAR (128)
No
Name of the column type.
FOR_BINARY_DATA
CHAR (1)
Yes
Returns 'Y' if the column is of type

CHAR, VARCHAR or LONG
VARCHAR, and is defined as FOR
BIT DATA, 'N' otherwise.
LENGTH
INTEGER
No
Maximum length of the data. For

DECIMAL data, this indicates the
precision. For discinct types, 0 is
returned.
SCALE
SMALLINT
No
For DECIMAL data, this indicates

the scale. For all other types, 0 is
returned.
NULLABLE
CHAR (1)
No
One of:
v 'Y' if column is nullable
v 'N' if column is not nullable
COLNO
SMALLINT
Yes
Ordinal of the column.
PARTKEYSEQ
SMALLINT
Yes
Ordinal of the column within the

table's partitioning key. NULL or 0 is
returned if the column is not part of
the partitioning key, and is NULL for
subtables and hierarchy tables.
48
Table 25. Result set 1 returned by the DESCRIBE TABLE command (continued)
Column name
Data type
Detail2
Description
CODEPAGE
SMALLINT
Yes
Code page of the column and is one

of:
v Value of the database code page
for columns that are not defined
with FOR BIT DATA.
v Value of the DBCS code page for
graphic columns.
v 0 otherwise.
DEFAULT
VARCHAR (254)
Yes
Default value for the column of a

table expressed as a constant, special
register, or cast-function appropriate
for the data type of the column.
Might also be NULL.
Note: 2: Yes indicates that non-null values are returned only when the SHOW DETAIL
clause is used.
Table 26. Result set 2 returned by the DESCRIBE TABLE command when the SHOW DETAIL clause is used.
Column name
Data type
Description
DATA_PARTITION_KEY_SEQ
INTEGER
Data partition key number, for example, 1

for the first data partition expression and 2
for the second data partition expression.
DATA_PARTITION_EXPRESSION
CLOB (32K)
Expression for this data partition key in SQL

syntax
Table 27. Result set returned by the DESCRIBE INDEXES FOR TABLE command
Column name
Data type
Detail3
Index type option4, 5
Description
INDSCHEMA
VARCHAR
(128)
No
RELATIONAL DATA
XML DATA
TEXT SEARCH
Index schema name.
INDNAME
VARCHAR
(128)
No
RELATIONAL DATA
XML DATA
TEXT SEARCH
Index name.
UNIQUE_RULE
VARCHAR (30) No
RELATIONAL DATA
XML DATA
One of following values:

v DUPLICATES_ALLOWED
v PRIMARY_INDEX
v
INDEX
_PARTITIONING
CHAR(1)
No
N/A
UNIQUE_ENTRIES_ONLY
Identifies the partitioning

characteristic of the index. Possible
values are:
v N= Nonpartitioned index
v P= Partitioned index
v Blank = Index is not on a
partitioned table
COLCOUNT
SMALLINT
No
RELATIONAL DATA
XML DATA
Number of columns in the key, plus

the number of include columns, if
any.
49
Table 27. Result set returned by the DESCRIBE INDEXES FOR TABLE command (continued)
Detail3
Column name
Data type
INDEX_TYPE
VARCHAR (30) No
Index type option4, 5
Description
RELATIONAL DATA
XML DATA
TEXT SEARCH
Type of index:
v RELATIONAL_DATA
v TEXT_SEARCH
v XML_DATA_REGIONS
v XML_DATA_PATH
v XML_DATA_VALUES_LOGICAL
v
INDEX_ID
SMALLINT
Yes
RELATIONAL DATA
XML DATA
Index ID for a relational data index,

an XML path index, an XML regions
index, or an index over XML data
DATA_TYPE
VARCHAR
(128)
Yes
XML DATA
SQL data type specified for an index

over XML data. One of the following
values:
v VARCHAR
v DOUBLE
v DATE
v TIMESTAMP
HASHED
CHAR (1)
Yes
XML DATA
Indicates whether or not the value for

an index over XML data is hashed.
v 'Y' if the value is hashed.
v 'N' if the value is not hashed.
LENGTH
SMALLINT
Yes
XML DATA
For an index over XML data, the

VARCHAR (integer) length; 0
otherwise.
PATTERN
CLOB (2M)
Yes
XML DATA
XML pattern expression specified for

an index over XML data
CODEPAGE
INTEGER
Yes
TEXT SEARCH
Document code page specified for the

text search index
LANGUAGE
VARCHAR (5)
Yes
TEXT SEARCH
Document language specified for the

text search index
FORMAT
VARCHAR (30) Yes
TEXT SEARCH
Document format specified for a text

search index
UPDATEMINIMUM
INTEGER
Yes
TEXT SEARCH
Minimum number of entries in the

text search log table before an
incremental update is performed
UPDATEFREQUENCY
VARCHAR
(300)
Yes
TEXT SEARCH
Trigger criterion specified for

applying updates to the text index
COLLECTION
DIRECTORY
VARCHAR
(512)
Yes
TEXT SEARCH
Directory specified for the text search

index files
COLNAMES
VARCHAR
(2048)
Yes
RELATIONAL DATA
XML DATA
TEXT SEARCH
List of the column names, each

preceded with a + to indicate
ascending order or a - to indicate
descending order.
Note: 3: Yes indicates that values are returned only when the SHOW DETAIL clause is
used without specifying an index type option. Values might be NULL.
50
Note: 4: Indicates the values returned when using DESCRIBE index-type INDEXES FOR
TABLE. For example, INDEX_ID values are not returned if TEXT SEARCH is specified
as index-type. INDEX_ID values are returned if either RELATIONAL DATA or XML DATA
are specified.
Note: 5: When using DESCRIBE index-type INDEXES FOR TABLE SHOW DETAIL, the
values are returned only when the index type is listed. For example, DATA_TYPE
values are returned if XML DATA is specified as index-type. DATA_TYPE values are
not returned if either TEXT SEARCH or RELATIONAL DATA is specified as index-type.
Table 28. Result set 1 returned by the DESCRIBE DATA PARTITIONS FOR TABLE command
Column name
Data type
Detail2
Description
DATA_PARTITION_ID
INTEGER
No
Data partition identifier.
LOW_KEY_INCLUSIVE
CHAR (1)
No
'Y' if the low key value is inclusive,

otherwise, 'N'.
LOW_KEY_VALUE
VARCHAR (512)
No
Low key value for this data

partition.
HIGH_KEY_INCLUSIVE
CHAR (1)
No
'Y' if the high key value is inclusive,

otherwise, 'N'.
HIGH_KEY_VALUE
VARCHAR (512)
No
High key value for this data

partition.
Note: 2: Yes indicates that non-null values are returned only when the SHOW DETAIL
clause is used.
Table 29. Result set 2 returned by the DESCRIBE DATA PARTITIONS FOR TABLE command when the SHOW
DETAIL clause is used.
Column name
Data type
Description
DATA_PARTITION_ID
INTEGER
Data partition identifier.
DATA_PARTITION_NAME
VARCHAR (128)
Data partition name.
TBSPID
INTEGER
Identifier of the table space where this data

partition is stored.
PARTITION_OBJECT_ID
INTEGER
Identifier of the DMS object where this data

partition is stored.
LONG_TBSPID
INTEGER
Identifier of the table space where long data

is stored.
INDEX_TBSPID
INTEGER
Identifier of the table space where index data

is stored.
ACCESSMODE
VARCHAR (20)
Defines accessibility of the data partition and

is one of:
v FULL_ACCESS
v NO_ACCESS
v NO_DATA_MOVEMENT
v READ_ONLY
51
Table 29. Result set 2 returned by the DESCRIBE DATA PARTITIONS FOR TABLE command when the SHOW
DETAIL clause is used. (continued)
Column name
Data type
Description
STATUS
VARCHAR(64)
Data partition status and can be one of:

v NEWLY_ATTACHED
v NEWLY_DETACHED: MQT maintenance
is required.
v INDEX_CLEANUP_PENDING: detached
data partition whose tuple in
SYSDATAPARTITIONS is maintained only
for index cleanup. This tuple is removed
when all index records referring to the
detached data partition have been deleted.
The column is blank otherwise.
DROP CONTACT command using the ADMIN_CMD procedure:

Removes a contact from the list of contacts defined on the local system. A contact
is a user to whom the Scheduler and Health Monitor send messages. The setting of
the Database Administration Server (DAS) contact_host configuration parameter
determines whether the list is local or global.
Authorization
None
Required connection
Command syntax
DROP CONTACT name
Command parameters
CONTACT name
The name of the contact that will be dropped from the local system.
Example
Drop the contact named 'testuser' from the list of contacts on the server system.
CALL SYSPROC.ADMIN_CMD( drop contact testuser )
Usage notes
statement.
52
DROP CONTACTGROUP command using the ADMIN_CMD procedure:

Removes a contact group from the list of contacts defined on the local system. A
contact group contains a list of users to whom the Scheduler and Health Monitor
send messages. The setting of the Database Administration Server (DAS)
contact_host configuration parameter determines whether the list is local or
global.
Authorization
None
Required Connection
Command Syntax
DROP CONTACTGROUP name
Command Parameters
CONTACTGROUP name
The name of the contact group that will be dropped from the local system.
Example
Drop the contact group named 'gname1'.
CALL SYSPROC.ADMIN_CMD( drop contactgroup gname1 )
Usage notes
statement.
EXPORT command using the ADMIN_CMD procedure:
Exports data from a database to one of several external file formats. The user
specifies the data to be exported by supplying an SQL SELECT statement, or by
providing hierarchical information for typed tables. The data is exported to the
server only.
Quick link to File type modifiers for the export utility on page 59.
Authorization
v CONTROL or SELECT privilege on each participating table or view
53
Required connection
Database. Utility access to Linux, UNIX, or Windows database servers from Linux,
UNIX, or Windows clients must be a direct connection through the engine and not
through a DB2 Connect gateway or loop back environment.
Command syntax
EXPORT TO filename OF
filetype

,
LOBS TO
lob-path

,
LOBFILE filename
xml-path
XML TO

,
XMLFILE filename
MODIFIED BY filetype-mod

XMLSAVESCHEMA
,
METHOD N (
column-name
)

MESSAGES ON SERVER
select-statement
XQUERY xquery-statement
HIERARCHY
STARTING sub-table-name
traversal-order-list
WHERE
traversal-order-list:
,
(
sub-table-name
Command parameters
TO filename
Specifies the name of the file to which data is to be exported to on the
server. This must be a fully qualified path and must exist on the server
coordinator partition.
If the name of a file that already exists is specified, the export utility
overwrites the contents of the file; it does not append the information.
OF filetype
Specifies the format of the data in the output file:
v DEL (delimited ASCII format), which is used by a variety of database
manager and file manager programs.
54
v IXF (Integration Exchange Format, PC version) is a proprietary binary

format.
LOBS TO lob-path
Specifies one or more paths to directories in which the LOB files are to be
stored. The path(s) must exist on the coordinator partition of the server
and must be fully qualified. There will be at least one file per LOB path,
and each file will contain at least one LOB. The maximum number of paths
that can be specified is 999. This will implicitly activate the LOBSINFILE
behavior.
LOBFILE filename
Specifies one or more base file names for the LOB files. When name space
is exhausted for the first name, the second name is used, and so on. This
will implicitly activate the LOBSINFILE behavior.
When creating LOB files during an export operation, file names are
constructed by appending the current base name from this list to the
current path (from lob-path), and then appending a 3-digit sequence
number to start and the three character identifier lob. For example, if the
current LOB path is the directory /u/foo/lob/path/, and the current LOB
file name is bar, the LOB files created will be /u/foo/lob/path/
bar.001.lob, /u/foo/lob/path/bar.002.lob, and so on. The 3-digit
sequence number in the LOB file name will grow to 4-digits once 999 is
used, 4-digits will grow to 5-digits once 9999 is used, and so on.
XML TO xml-path
Specifies one or more paths to directories in which the XML files are to be
stored. There will be at least one file per XML path, and each file will
contain at least one XQuery Data Model (XDM) instance. If more than one
path is specified, then XDM instances are distributed evenly among the
paths.
XMLFILE filename
Specifies one or more base file names for the XML files. When name space
is exhausted for the first name, the second name is used, and so on.
When creating XML files during an export operation, file names are
constructed by appending the current base name from this list to the
current path (from xml-path), appending a 3-digit sequence number, and
appending the three character identifier xml. For example, if the current
XML path is the directory /u/foo/xml/path/, and the current XML file
name is bar, the XML files created will be /u/foo/xml/path/bar.001.xml,
/u/foo/xml/path/bar.002.xml, and so on.
Specifies file type modifier options. See File type modifiers for the export
utility on page 59.
XMLSAVESCHEMA
Specifies that XML schema information should be saved for all XML
columns. For each exported XML document that was validated against an
XML schema when it was inserted, the fully qualified SQL identifier of that
schema will be stored as an (SCH) attribute inside the corresponding XML
Data Specifier (XDS). If the exported document was not validated against
an XML schema or the schema object no longer exists in the database, an
SCH attribute will not be included in the corresponding XDS.
55
The schema and name portions of the SQL identifier are stored as the
"OBJECTSCHEMA" and "OBJECTNAME" values in the row of the
SYSCAT.XSROBJECTS catalog table corresponding to the XML schema.
The XMLSAVESCHEMA option is not compatible with XQuery sequences that
do not produce well-formed XML documents.
METHOD N column-name
Specifies one or more column names to be used in the output file. If this
parameter is not specified, the column names in the table are used. This
parameter is valid only for IXF files, but is not valid when exporting
hierarchical data.
select-statement
Specifies the SELECT or XQUERY statement that will return the data to be
exported. If the statement causes an error, a message is written to the
message file (or to standard output). If the error code is one of SQL0012W,
SQL0347W, SQL0360W, SQL0437W, or SQL1824W, the export operation
continues; otherwise, it stops.
If the SELECT statement is in the form of SELECT * FROM tablename and
the table contains implicitly hidden columns, you must explicitly specify
whether data for the hidden columns is included in the export operation.
Use one of the following methods to indicate if data for hidden columns is
included:
v Use one of the hidden column file type modifiers: specify
implicitlyhiddeninclude when the export contains data for the hidden
columns, or implicitlyhiddenmissing when the export does not.
db2 export to t.del of del modified by implicitlyhiddeninclude
select * from t
v Use the DB2_DMU_DEFAULT registry variable on the client-side to set

the default behavior when data movement utilities encounter tables with
implicitly hidden columns.
db2set DB2_DMU_DEFAULT=IMPLICITLYHIDDENINCLUDE
db2 export to t.del of del select * from t
HIERARCHY STARTING sub-table-name

Using the default traverse order (OUTER order for ASC or DEL files, or the
order stored in PC/IXF data files), export a sub-hierarchy starting from
sub-table-name.
HIERARCHY traversal-order-list
Export a sub-hierarchy using the specified traverse order. All sub-tables
must be listed in PRE-ORDER fashion. The first sub-table name is used as
the target table name for the SELECT statement.
MESSAGES ON SERVER
Specifies that the message file created on the server by the EXPORT
command is to be saved. The result set returned will include the following
two columns: MSG_RETRIEVAL, which is the SQL statement required to
retrieve all the warnings and error messages that occur during this
operation, and MSG_REMOVAL, which is the SQL statement required to
clean up the messages.
If this clause is not specified, the message file will be deleted when the
ADMIN_CMD procedure returns to the caller. The MSG_RETRIEVAL and
MSG_REMOVAL column in the result set will contain null values.
56
Note that with or without the clause, the fenced user ID must have the
authority to create files under the directory indicated by the
DB2_UTIL_MSGPATH registry variable, as well as the directory where the data
is to be exported to.
Example
The following example shows how to export information from the STAFF table in
the SAMPLE database to the file myfile.ixf. The output will be in IXF format. You
must be connected to the SAMPLE database before issuing the command.
CALL SYSPROC.ADMIN_CMD (EXPORT to /home/user1/data/myfile.ixf
OF ixf MESSAGES ON SERVER select * from staff)
Usage notes
v Any path used in the EXPORT command must be a valid fully-qualified path on
the server.
v If a table contains LOB columns, at least one fully-qualified LOB path and LOB
name must be specified, using the LOBS TO and LOBFILE clauses.
v The export utility issues a COMMIT statement at the beginning of the operation
which, in the case of Type 2 connections, causes the procedure to return
SQL30090N with reason code 2.
v When exporting from a UCS-2 database to a delimited ASCII (DEL) file, all
character data is converted to the code page that is in effect where the procedure
is executing. Both character string and graphic string data are converted to the
same SBCS or MBCS code page of the server.
v Be sure to complete all table operations and release all locks before starting an
export operation. This can be done by issuing a COMMIT after closing all
cursors opened WITH HOLD, or by issuing a ROLLBACK.
v Table aliases can be used in the SELECT statement.
v The messages placed in the message file include the information returned from
the message retrieval service. Each message begins on a new line.
v PC/IXF import should be used to move data between databases. If character
data containing row separators is exported to a delimited ASCII (DEL) file and
processed by a text transfer program, fields containing the row separators will
shrink or expand.
v The file copying step is not necessary if the source and the target databases are
both accessible from the same client.
v DB2 Connect can be used to export tables from DRDA servers such as DB2 for
OS/390, DB2 for VM and VSE, and DB2 for OS/400. Only PC/IXF export is
supported.
v When exporting to the IXF format, if identifiers exceed the maximum size
supported by the IXF format, the export will succeed but the resulting datafile
cannot be used by a subsequent import operation using the CREATE mode.
SQL27984W will be returned.
v When exporting to the IXF format, the export utility does not maintain
column-organized table metadata that would be needed to recreate the
column-organized table during a subsequent import operation using the
CREATE mode. SQL27984W will be returned.
v When exporting to a diskette on Windows, and the table that has more data
than the capacity of a single diskette, the system will prompt for another
diskette, and multiple-part PC/IXF files (also known as multi-volume PC/IXF
files, or logically split PC/IXF files), are generated and stored in separate
diskettes. In each file, with the exception of the last, there is a DB2
57
CONTINUATION RECORD (or "AC" Record in short) written to indicate the

files are logically split and where to look for the next file. The files can then be
transferred to an AIX system, to be read by the import and load utilities. The
export utility will not create multiple-part PC/IXF files when invoked from an
AIX system. For detailed usage, see the IMPORT command or LOAD command.
v The export utility will store the NOT NULL WITH DEFAULT attribute of the
table in an IXF file if the SELECT statement provided is in the form SELECT *
FROM tablename.
v When exporting typed tables, subselect statements can only be expressed by
specifying the target table name and the WHERE clause. Fullselect and
select-statement cannot be specified when exporting a hierarchy.
v For file formats other than IXF, it is recommended that the traversal order list be
specified, because it tells DB2 how to traverse the hierarchy, and what sub-tables
to export. If this list is not specified, all tables in the hierarchy are exported, and
the default order is the OUTER order. The alternative is to use the default order,
which is the order given by the OUTER function.
v Use the same traverse order during an import operation. The load utility does
not support loading hierarchies or sub-hierarchies.
v When exporting data from a table that has protected rows, the LBAC credentials
held by the session authorization id might limit the rows that are exported.
Rows that the session authorization ID does not have read access to will not be
exported. No error or warning is given.
v If the LBAC credentials held by the session authorization id do not allow
reading from one or more protected columns included in the export then the
export fails and an error (SQLSTATE 42512) is returned.
v When running Data Movement utilities such as export and db2move, the query
compiler might determine that the underlying query will run more efficiently
against an MQT than the base table or tables. In this case, the query will execute
against a refresh deferred MQT, and the result of the utilities might not
accurately represent the data in the underlying table.
v Export packages are bound using DATETIME ISO format, thus, all
date/time/timestamp values are converted into ISO format when cast to a string
representation. Since the CLP packages are bound using DATETIME LOC format
(locale specific format), you may see inconsistent behavior between CLP and
export if the CLP DATETIME format is different from ISO. For instance, the
following SELECT statement may return expected results:
db2 select col2 from tab1 where char(col2)=05/10/2005;
COL2
---------05/10/2005
05/10/2005
05/10/2005
But an export command using the same select clause will not:
db2 export to test.del of del select col2 from test
where char(col2)=05/10/2005;
Number of rows exported: 0
Now, replacing the LOCALE date format with ISO format gives the expected
results:
db2 export to test.del of del select col2 from test
where char(col2)=2005-05-10;
Number of rows exported: 3
58

Table 30. Result set returned by the EXPORT command
Column name
Data type
Description
ROWS_EXPORTED
BIGINT
Total number of exported rows.
MSG_RETRIEVAL
VARCHAR(512)
SQL statement that is used to retrieve messages created

by this utility. For example:
SELECT SQLCODE, MSG
FROM TABLE (SYSPROC.ADMIN_GET_MSGS
(3203498_txu)) AS MSG
MSG_REMOVAL
VARCHAR(512)
SQL statement that is used to clean up messages created

CALL SYSPROC.ADMIN_REMOVE_MSGS
(3203498_txu)
File type modifiers for the export utility

Table 31. Valid file type modifiers for the export utility: All file formats
Modifier
Description
lobsinfile
lob-path specifies the path to the files containing LOB data.

Each path contains at least one file that contains at least one LOB pointed to by a
Lob Location Specifier (LLS) in the data file. The LLS is a string representation of
the location of a LOB in a file stored in the LOB file path. The format of an LLS is
filename.ext.nnn.mmm/, where filename.ext is the name of the file that contains the
LOB, nnn is the offset in bytes of the LOB within the file, and mmm is the length
of the LOB in bytes. For example, if the string db2exp.001.123.456/ is stored in
the data file, the LOB is located at offset 123 in the file db2exp.001, and is 456
bytes long.
If you specify the lobsinfile modifier when using EXPORT, the LOB data is placed
in the locations specified by the LOBS TO clause. Otherwise the LOB data is sent to
the data file directory. The LOBS TO clause specifies one or more paths to
directories in which the LOB files are to be stored. There will be at least one file
per LOB path, and each file will contain at least one LOB. The LOBS TO or LOBFILE
options will implicitly activate the LOBSINFILE behavior.
To indicate a null LOB , enter the size as -1. If the size is specified as 0, it is
treated as a 0 length LOB. For null LOBS with length of -1, the offset and the file
name are ignored. For example, the LLS of a null LOB might be db2exp.001.7.-1/.
implicitlyhiddeninclude
This modifier is used with SELECT * queries and specifies that the data in
implicitly hidden columns is exported even though that data is not included in
the result of the SELECT * query. This modifier cannot be used with the
implicitlyhiddenmissing modifier.
If this modifier is used and the query is not a SELECT *, then an error is returned
(SQLCODE SQL3526N).
implicitlyhiddenmissing
This modifier is used with SELECT * queries and specifies that the data in
implicitly hidden columns is not exported. This modifier cannot be used with the
implicitlyhiddeninclude modifier.
If this modifier is used and the query is not a SELECT *, then an error is returned
(SQLCODE SQL3526N).
59
Table 31. Valid file type modifiers for the export utility: All file formats (continued)
Modifier
Description
xmlinsepfiles
Each XQuery Data Model (XDM) instance is written to a separate file. By default,
multiple values are concatenated together in the same file.
lobsinsepfiles
Each LOB value is written to a separate file. By default, multiple values are
concatenated together in the same file.
xmlnodeclaration
XDM instances are written without an XML declaration tag. By default, XDM
instances are exported with an XML declaration tag at the beginning that includes
an encoding attribute.
xmlchar
XDM instances are written in the character code page. Note that the character
codepage is the value specified by the codepage file type modifier, or the
application code page if it is not specified. By default, XDM instances are written
out in Unicode.
xmlgraphic
If the xmlgraphic modifier is specified with the EXPORT command, the exported
XML document will be encoded in the UTF-16 code page regardless of the
application code page or the codepage file type modifier.
Table 32. Valid file type modifiers for the export utility: DEL (delimited ASCII) file format
Modifier
Description
chardelx
x is a single character string delimiter. The default value is a double quotation

mark ("). The specified character is used in place of double quotation marks to
enclose a character string.2 If you want to explicitly specify the double quotation
mark as the character string delimiter, it should be specified as follows:
modified by chardel""
The single quotation mark (') can also be specified as a character string delimiter
as follows:
modified by chardel
codepage=x
x is an ASCII character string. The value is interpreted as the code page of the
data in the output data set. Converts character data to this code page from the
application code page during the export operation.
For pure DBCS (graphic), mixed DBCS, and EUC, delimiters are restricted to the
range of x00 to x3F, inclusive. The codepage modifier cannot be used with the
lobsinfile modifier.
coldelx
x is a single character column delimiter. The default value is a comma (,). The
specified character is used in place of a comma to signal the end of a column.2
In the following example, coldel; causes the export utility to use the semicolon
character (;) as a column delimiter for the exported data:
db2 "export to temp of del modified by coldel;
select * from staff where dept = 20"
decplusblank
Plus sign character. Causes positive decimal values to be prefixed with a blank
space instead of a plus sign (+). The default action is to prefix positive decimal
values with a plus sign.
decptx
x is a single character substitute for the period as a decimal point character. The
default value is a period (.). The specified character is used in place of a period as
a decimal point character.2
60
Table 32. Valid file type modifiers for the export utility: DEL (delimited ASCII) file format (continued)
Modifier
Description
nochardel
Column data will not be surrounded by character delimiters. This option should
not be specified if the data is intended to be imported or loaded using DB2. It is
provided to support vendor data files that do not have character delimiters.
Improper usage might result in data loss or corruption.
This option cannot be specified with chardelx or nodoubledel. These are mutually
exclusive options.
nodoubledel
Suppresses recognition of double character delimiters.2
striplzeros
Removes the leading zeros from all exported decimal columns.

Consider the following example:
db2 create table decimalTable ( c1 decimal( 31, 2 ) )
db2 insert into decimalTable values ( 1.1 )
db2 export to data of del select * from decimalTable
db2 export to data of del modified by STRIPLZEROS
select * from decimalTable
In the first export operation, the content of the exported file data will be
+00000000000000000000000000001.10. In the second operation, which is identical
to the first except for the striplzeros modifier, the content of the exported file
data will be +1.10.
61
Table 32. Valid file type modifiers for the export utility: DEL (delimited ASCII) file format (continued)
Modifier
Description
timestampformat="x"
x is the format of the time stamp in the source file.4 Valid time stamp elements
are:
YYYY
Year (four digits ranging from 0000 - 9999)
Month (one or two digits ranging from 1 - 12)
MM
Month (two digits ranging from 01 - 12; mutually exclusive with M and
MMM)
MMM
Month (three-letter case-insensitive abbreviation for the month name;

mutually exclusive with M and MM)
Day (one or two digits ranging from 1 - 31)
DD
Day (two digits ranging from 01 - 31; mutually exclusive with D)
DDD
Day of the year (three digits ranging from 001 - 366; mutually exclusive
with other day or month elements)
Hour (one or two digits ranging from 0 - 12 for a 12 hour system, and 0
- 24 for a 24 hour system)
HH
Hour (two digits ranging from 00 - 12 for a 12 hour system, and 00 - 24

for a 24 hour system; mutually exclusive with H)
Minute (one or two digits ranging from 0 - 59)
MM
Minute (two digits ranging from 00 - 59; mutually exclusive with M,

minute)
Second (one or two digits ranging from 0 - 59)
SS
Second (two digits ranging from 00 - 59; mutually exclusive with S)
SSSSS Second of the day after midnight (5 digits ranging from 00000 - 86400;
mutually exclusive with other time elements)
U (1 to 12 times)
Fractional seconds (number of occurrences of U represent the number of
digits with each digit ranging from 0 to 9
TT
Meridian indicator (AM or PM)
Following is an example of a time stamp format:

"YYYY/MM/DD HH:MM:SS.UUUUUU"
The MMM element will produce the following values: 'Jan', 'Feb', 'Mar', 'Apr',
'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', and 'Dec'. 'Jan' is equal to month 1, and
'Dec' is equal to month 12.
The following example illustrates how to export data containing user-defined
time stamp formats from a table called 'schedule':
db2 export to delfile2 of del
modified by timestampformat="yyyy.mm.dd hh:mm tt"
select * from schedule
62
Table 33. Valid file type modifiers for the export utility: IXF file format
Modifier
Description
codepage=x
data in the output data set. Converts character data from this code page to the
application code page during the export operation.
For pure DBCS (graphic), mixed DBCS, and EUC, delimiters are restricted to the
range of x00 to x3F, inclusive.
Note:
1. The export utility does not issue a warning if an attempt is made to use
unsupported file types with the MODIFIED BY option. If this is attempted, the
export operation fails, and an error code is returned.
2. Delimiter considerations for moving data lists restrictions that apply to the
characters that can be used as delimiter overrides.
3. The export utility normally writes
v date data in YYYYMMDD format
v char(date) data in "YYYY-MM-DD" format
v time data in "HH.MM.SS" format
v time stamp data in "YYYY-MM-DD-HH.MM.SS.uuuuuu" format
Data contained in any datetime columns specified in the SELECT statement
for the export operation will also be in these formats.
4. For time stamp formats, care must be taken to avoid ambiguity between the
month and the minute descriptors, since they both use the letter M. A month
field must be adjacent to other date fields. A minute field must be adjacent to
other time fields. Following are some ambiguous time stamp formats:
"M" (could be a month, or a minute)
"M:M" (Which is which?)
"M:YYYY:M" (Both are interpreted as month.)
"S:M:YYYY" (adjacent to both a time value and a date value)
In ambiguous cases, the utility will report an error message, and the operation
will fail.
Following are some unambiguous time stamp formats:
"M:YYYY" (Month)
"S:M" (Minute)
"M:YYYY:S:M" (Month....Minute)
"M:H:YYYY:M:D" (Minute....Month)
5. All XDM instances are written to XML files that are separate from the main
data file, even if neither the XMLFILE nor the XML TO clause is specified. By
default, XML files are written to the path of the exported data file. The default
base name for XML files is the name of the exported data file with the
extension ".xml" appended to it.
6. All XDM instances are written with an XML declaration at the beginning that
includes an encoding attribute, unless the XMLNODECLARATION file type
modifier is specified.
7. By default, all XDM instances are written in Unicode unless the XMLCHAR or
XMLGRAPHIC file type modifier is specified.
8. The default path for XML data and LOB data is the path of the main data file.
The default XML file base name is the main data file. The default LOB file
base name is the main data file. For example, if the main data file is:
/mypath/myfile.del
63
the default path for XML data and LOB data is:
/mypath"
the default XML file base name is:

myfile.del
and the default LOB file base name is:

myfile.del
The LOBSINFILE file type modifier must be specified in order to have LOB
files generated.
9. The export utility appends a numeric identifier to each LOB file or XML file.
The identifier starts as a 3 digit, 0 padded sequence value, starting at:
.001
After the 999th LOB file or XML file, the identifier will no longer be padded
with zeros (for example, the 1000th LOG file or XML file will have an
extension of:
.1000
Following the numeric identifier is a three character type identifier

representing the data type, either:
.lob
or
.xml
For example, a generated LOB file would have a name in the format:
myfile.del.001.lob
and a generated XML file would be have a name in the format:

myfile.del.001.xml
10. It is possible to have the export utility export XDM instances that are not
well-formed documents by specifying an XQuery. However, you will not be
able to import or load these exported documents directly into an XML
column, since XML columns can only contain complete documents.
FORCE APPLICATION command using the ADMIN_CMD procedure:
Forces local or remote users or applications off the system to allow for
maintenance on a server.
Attention: If an operation that cannot be interrupted (RESTORE DATABASE, for
example) is forced, the operation must be successfully re-executed before the
database becomes available.
Scope
This command affects all database partitions that are listed in the
$HOME/sqllib/db2nodes.cfg file.
In a partitioned database environment, this command does not have to be issued
from the coordinator database partition of the application being forced. It can be
issued from any database partition server in the partitioned database environment.
64
Authorization
v SYSADM
v SYSCTRL
v SYSMAINT
Required connection
Database
Command syntax
FORCE APPLICATION
ALL

,
application-handle
MODE ASYNC
)
Command parameters
FORCE APPLICATION
ALL
All applications will be disconnected from the database. This might

close the connection the ADMIN_CMD procedure is running on,
which causes an SQL1224N error to be returned for the
ADMIN_CMD procedure once the force operation is completed
successfully.
application-handle
Specifies the agent to be terminated. List the values using the LIST
APPLICATIONS command.
MODE ASYNC
The command does not wait for all specified users to be terminated before
returning; it returns as soon as the function has been successfully issued or
an error (such as invalid syntax) is discovered.
This is the only mode that is currently supported.
Examples
The following example forces two users, with application-handle values of 41408 and
55458, to disconnect from the database:
CALL SYSPROC.ADMIN_CMD( force application ( 41408, 55458 ) )
Usage notes
The database manager remains active so that subsequent database manager
operations can be handled without the need for db2start.
To preserve database integrity, only users who are idling or executing interruptible
database operations can be terminated.
The following types of users and applications cannot be forced:
v users creating a database
v system applications
65
In order to successfully force these types of users and applications, the database
must be deactivated and/or the instance restarted.
After a FORCE APPLICATION has been issued, the database will still accept requests
to connect. Additional forces might be required to completely force all users off.
statement.
GET STMM TUNING command using the ADMIN_CMD procedure:
Used to read the catalog tables to report the user preferred self tuning memory
manager (STMM) tuning member number and current STMM tuning member
number.
Authorization
The privileges held by the authorization ID of the statement must include at least
one of the following authorities or privilege:
v DBADM
v SECADM
v SQLADM
v ACCESSCTRL
v DATAACCESS
v SELECT on SYSIBM.SYSTUNINGINFO
Required connection
Database
Command syntax
GET STMM TUNING MEMBER
Example
CALL SYSPROC.ADMIN_CMD( get stmm tuning member )
The following is an example of output from this query.

Result set 1
-------------USER_PREFERRED_NUMBER CURRENT_NUMBER
--------------------- -------------2
2
Return Status = 0
Usage notes
v The user preferred self tuning memory manager (STMM) tuning member
number (USER_PREFERRED_NUMBER) is set by the user and specifies the member on
which the user wants to run the memory tuner. While the database is running,
the tuning member is applied a few times an hour. As a result, it is possible that
66
the CURRENT_NUMBER and USER_PREFERRED_NUMBER returned are not in sync after an

update of the user preferred STMM member. To resolve this, either wait for the
CURRENT_NUMBER to be updated asynchronously, or stop and start the database to
force the update of CURRENT_NUMBER.
Compatibilities
v DBPARTITIONNUM can be substituted for MEMBER, except when the
in the following result set:
Table 34. Result set returned by the GET STMM TUNING command
Column name
Data type
Description
USER_PREFERRED_NUMBER
INTEGER
User preferred self tuning memory

manager (STMM) tuning member
number. In a partitioned database
environment, a value of -1
indicates that the default member
is used.
CURRENT_NUMBER
INTEGER
Current STMM tuning member

number. A value of -1 indicates
that the default member is used.
IMPORT command using the ADMIN_CMD procedure:

Inserts data from an external file with a supported file format into a table,
hierarchy, view or nickname. LOAD is a faster alternative, but the load utility does
not support loading data at the hierarchy level.
Quick link to File type modifiers for the import utility on page 82.
Authorization
v IMPORT using the INSERT option requires one of the following authorities:
DATAACCESS authority
CONTROL privilege on each participating table, view, or nickname
INSERT and SELECT privilege on each participating table or view
v IMPORT to an existing table using the INSERT_UPDATE option, requires one of the
following authorities:
CONTROL privilege on each participating table, view, or nickname
INSERT, SELECT, UPDATE and DELETE privilege on each participating table
or view
v IMPORT to an existing table using the REPLACE or REPLACE_CREATE option, requires
one of the following authorities:
CONTROL privilege on the table or view
67
INSERT, SELECT, and DELETE privilege on the table or view

v IMPORT to a new table using the CREATE or REPLACE_CREATE option, requires one
of the following authorities:
DBADM authority
CREATETAB authority on the database and USE privilege on the table space,
as well as one of:
- IMPLICIT_SCHEMA authority on the database, if the implicit or explicit
schema name of the table does not exist
- CREATEIN privilege on the schema, if the schema name of the table refers
to an existing schema
v
IMPORT to a hierarchy that does not exist using the CREATE, or the
REPLACE_CREATE option, requires one of the following authorities:
DBADM authority
CREATETAB authority on the database and USE privilege on the table space
and one of:
- IMPLICIT_SCHEMA authority on the database, if the schema name of the
table does not exist
- CREATEIN privilege on the schema, if the schema of the table exists
- CONTROL privilege on every sub-table in the hierarchy, if the
REPLACE_CREATE option on the entire hierarchy is used
v IMPORT to an existing hierarchy using the REPLACE option requires one of the
CONTROL privilege on every sub-table in the hierarchy
v To import data into a table that has protected columns, the session authorization
ID must have LBAC credentials that allow write access to all protected columns
in the table. Otherwise the import fails and an error (SQLSTATE 42512) is
returned.
v To import data into a table that has protected rows, the session authorization ID
must hold LBAC credentials that meet these criteria:
It is part of the security policy protecting the table
It was granted to the session authorization ID for write access
The label on the row to insert, the user's LBAC credentials, the security policy
definition, and the LBAC rules determine the label on the row.
v If the REPLACE or REPLACE_CREATE option is specified, the session authorization ID
must have the authority to drop the table.
v To import data into a nickname, the session authorization ID must have the
privilege to access and use a specified data source in pass-through mode.
v If the table has row access control activated, then IMPORT REPLACE on that table
would require the ability to drop the table. Specifically, you must have either
CONTROL or DBADM on the table.
Required connection
Database. Utility access to Linux, UNIX, or Windows database servers from Linux,
UNIX, or Windows clients must be a direct connection through the engine and not
through a DB2 Connect gateway or loop back environment.
68
Command syntax
IMPORT FROM filename
OF
filetype

,
LOBS FROM
lob-path
XML FROM
xml-path


,
METHOD
( column-start column-end
)
,
NULL INDICATORS ( null-indicator-list
,
N
( column-name
,
( column-position

XMLPARSE
STRIP
PRESERVE
WHITESPACE
ALLOW NO ACCESS

XMLVALIDATE USING
XDS
Ignore and Map parameters
ALLOW WRITE ACCESS
DEFAULT schema-sqlid
SCHEMA schema-sqlid
SCHEMALOCATION HINTS

COMMITCOUNT
n
AUTOMATIC
RESTARTCOUNT
SKIPCOUNT
ROWCOUNT
WARNINGCOUNT
NOTIMEOUT

MESSAGES ON SERVER
INSERT
INSERT_UPDATE
REPLACE
REPLACE_CREATE
CREATE
INTO
INTO
table-name

,
( insert-column
hierarchy description
table-name
tblspace-specs
,
( insert-column
)
hierarchy description
AS ROOT TABLE
UNDER sub-table-name
Ignore and Map parameters:

,
schema-sqlid
IGNORE (

,
MAP
( ( schema-sqlid ,
schema-sqlid
69
hierarchy description:
ALL TABLES
sub-table-list
HIERARCHY
IN
sub-table-list:
,
(
sub-table-name
)
,
( insert-column
traversal-order-list:
,
(
sub-table-name
tblspace-specs:
IN tablespace-name
INDEX IN tablespace-name
LONG IN tablespace-name
Command parameters
FROM filename
Specifies the name of the file that contains the data to be imported. This
must be a fully qualified path and the file must exist on the database
server.
OF filetype
Specifies the format of the data in the input file:
v ASC (non-delimited ASCII format)
v DEL (delimited ASCII format), which is used by a variety of database
manager and file manager programs
v IXF (Integration Exchange Format, PC version) is a binary format that is
used exclusively by DB2.
LOBS FROM lob-path
Specifies one or more fully qualified paths that store LOB files. The paths
must exist on the database server coordinator partition. The names of the
LOB data files are stored in the main data file (ASC, DEL, or IXF), in the
column that will be loaded into the LOB column. The maximum number of
paths that can be specified is 999. This will implicitly activate the
LOBSINFILE behavior.
This parameter is not valid when you import to a nickname.
XML FROM xml-path
Specifies one or more paths that contain the XML files.
70
Specifies file type modifier options. See File type modifiers for the import
utility on page 82.
METHOD
L
Specifies the start and end column numbers from which to import
data. A column number is a byte offset from the beginning of a
row of data. It is numbered starting from 1.
Note: This method can only be used with ASC files, and is the
only valid option for that file type.
Specifies the names of the columns in the data file to be imported.

The case of these column names must match the case of the
corresponding names in the system catalogs. Each table column
that is not nullable should have a corresponding entry in the
METHOD N list. For example, given data fields F1, F2, F3, F4, F5, and
F6, and table columns C1 INT, C2 INT NOT NULL, C3 INT NOT
NULL, and C4 INT, method N (F2, F1, F4, F3) is a valid request,
while method N (F2, F1) is not valid.
Note: This method can only be used with IXF files.
Specifies the field numbers (numbered from 1) of the input data

fields to be imported. Each table column that is not nullable should
have a corresponding entry in the METHOD P list. For example, given
data fields F1, F2, F3, F4, F5, and F6, and table columns C1 INT, C2
INT NOT NULL, C3 INT NOT NULL, and C4 INT, method P (2,
1, 4, 3) is a valid request, while method P (2, 1) is not valid.
This method can only be used with file types IXF or DEL, and is
the only valid method for the DEL file type.
For each of the fields specified by method P, you need to define a
corresponding column in the action statement, unless all columns
are accounted for or the first x columns are going to be loaded, as
shown in the following example:
db2 load from datafile1.del of del method P(1, 3, 4)
replace into table1 (c1, c3, c4)
NULL INDICATORS null-indicator-list

This option can only be used when the METHOD L parameter is specified.
That is, the input file is an ASC file. The null indicator list is a
comma-separated list of positive integers specifying the column number of
each null indicator field. The column number is the byte offset of the null
indicator field from the beginning of a row of data. There must be one
entry in the null indicator list for each data field defined in the METHOD L
parameter. A column number of zero indicates that the corresponding data
field always contains data.
A value of Y in the NULL indicator column specifies that the column data
is NULL. Any character other than Y in the NULL indicator column
specifies that the column data is not NULL, and that column data specified
by the METHOD L option will be imported.
The NULL indicator character can be changed using the MODIFIED BY
option, with the nullindchar file type modifier.
XMLPARSE
Specifies how XML documents are parsed. If this option is not specified,
71
the parsing behavior for XML documents will be determined by the value
of the CURRENT XMLPARSE OPTION special register.
STRIP WHITESPACE
Specifies to remove whitespace when the XML document is parsed.
PRESERVE WHITESPACE
Specifies not to remove whitespace when the XML document is
parsed.
XMLVALIDATE
Specifies that XML documents are validated against a schema, when
applicable.
USING XDS
XML documents are validated against the XML schema identified
by the XML Data Specifier (XDS) in the main data file. By default,
if the XMLVALIDATE option is invoked with the USING XDS clause, the
schema used to perform validation will be determined by the SCH
attribute of the XDS. If an SCH attribute is not present in the XDS,
no schema validation will occur unless a default schema is
specified by the DEFAULT clause.
The DEFAULT, IGNORE, and MAP clauses can be used to modify the
schema determination behavior. These three optional clauses apply
directly to the specifications of the XDS, and not to each other. For
example, if a schema is selected because it is specified by the
DEFAULT clause, it will not be ignored if also specified by the IGNORE
clause. Similarly, if a schema is selected because it is specified as
the first part of a pair in the MAP clause, it will not be re-mapped
if also specified in the second part of another MAP clause pair.
USING SCHEMA schema-sqlid
XML documents are validated against the XML schema with the
specified SQL identifier. In this case, the SCH attribute of the XML
Data Specifier (XDS) will be ignored for all XML columns.
USING SCHEMALOCATION HINTS
XML documents are validated against the schemas identified by
XML schema location hints in the source XML documents. If a
schemaLocation attribute is not found in the XML document, no
validation will occur. When the USING SCHEMALOCATION HINTS clause
is specified, the SCH attribute of the XML Data Specifier (XDS) will
be ignored for all XML columns.
See examples of the XMLVALIDATE option in the following section.
This option can only be used when the USING XDS parameter is specified.
The schema specified through the DEFAULT clause identifies a schema to use
for validation when the XML Data Specifier (XDS) of an imported XML
document does not contain an SCH attribute identifying an XML Schema.
The DEFAULT clause takes precedence over the IGNORE and MAP clauses. If an
XDS satisfies the DEFAULT clause, the IGNORE and MAP specifications will be
ignored.
IGNORE schema-sqlid
The IGNORE clause specifies a list of one or more schemas to ignore if they
are identified by an SCH attribute. If an SCH attribute exists in the XML
72
Data Specifier for an imported XML document, and the schema identified
by the SCH attribute is included in the list of schemas to ignore, then no
schema validation will occur for the imported XML document.
If a schema is specified in the IGNORE clause, it cannot also be present in
the left side of a schema pair in the MAP clause.
The IGNORE clause applies only to the XDS. A schema that is mapped by
the MAP clause will not be subsequently ignored if specified by the IGNORE
clause.
MAP schema-sqlid
Use the MAP clause to specify alternate schemas to use in place of those
specified by the SCH attribute of an XML Data Specifier (XDS) for each
imported XML document. The MAP clause specifies a list of one or more
schema pairs, where each pair represents a mapping of one schema to
another. The first schema in the pair represents a schema that is referred to
by an SCH attribute in an XDS. The second schema in the pair represents
the schema that should be used to perform schema validation.
If a schema is present in the left side of a schema pair in the MAP clause, it
cannot also be specified in the IGNORE clause.
Once a schema pair mapping is applied, the result is final. The mapping
operation is non-transitive, and therefore the schema chosen will not be
subsequently applied to another schema pair mapping.
A schema cannot be mapped more than once, meaning that it cannot
appear on the left side of more than one pair.
ALLOW NO ACCESS
Runs import in the offline mode. An exclusive (X) lock on the target table
is acquired before any rows are inserted. This prevents concurrent
applications from accessing table data. This is the default import behavior.
ALLOW WRITE ACCESS
Runs import in the online mode. An intent exclusive (IX) lock on the target
table is acquired when the first row is inserted. This allows concurrent
readers and writers to access table data. Online mode is not compatible
with the REPLACE, CREATE, or REPLACE_CREATE import options. Online mode
is not supported in conjunction with buffered inserts. The import operation
will periodically commit inserted data to prevent lock escalation to a table
lock and to avoid running out of active log space. These commits will be
performed even if the COMMITCOUNT option was not used. During each
commit, import will lose its IX table lock, and will attempt to reacquire it
after the commit. This parameter is required when you import to a
nickname and COMMITCOUNT must be specified with a valid number
(AUTOMATIC is not considered a valid option).
COMMITCOUNT n | AUTOMATIC
Performs a COMMIT after every n records are imported. When a number n
is specified, import performs a COMMIT after every n records are
imported. When compound inserts are used, a user-specified commit
frequency of n is rounded up to the first integer multiple of the compound
count value. When AUTOMATIC is specified, import internally determines
when a commit needs to be performed. The utility will commit for either
one of two reasons:
v to avoid running out of active log space
v to avoid lock escalation from row level to table level
73
If the ALLOW WRITE ACCESS option is specified, and the COMMITCOUNT option
is not specified, the import utility will perform commits as if COMMITCOUNT
AUTOMATIC had been specified.
The ability of the import operation to avoid running out of active log space
is affected by the DB2 registry variable DB2_FORCE_APP_ON_MAX_LOG:
v If DB2_FORCE_APP_ON_MAX_LOG is set to FALSE and the COMMITCOUNT
AUTOMATIC command option is specified, the import utility will be able to
automatically avoid running out of active log space.
v If DB2_FORCE_APP_ON_MAX_LOG is set to FALSE and the COMMITCOUNT n
command option is specified, the import utility will attempt to resolve
the log full condition if it encounters an SQL0964C (Transaction Log
Full) while inserting or updating a record. It will perform an
unconditional commit and then will reattempt to insert or update the
record. If this does not help resolve the issue (which would be the case
when the log full is attributed to other activity on the database), then the
IMPORT command will fail as expected, however the number of rows
committed may not be a multiple of the COMMITCOUNT n value. To avoid
processing the rows that were already committed when you retry the
import operation, use the RESTARTCOUNT or SKIPCOUNT command
parameters.
v If DB2_FORCE_APP_ON_MAX_LOG is set to TRUE (which is the default), the
import operation will fail if it encounters an SQL0964C while inserting
or updating a record. This can occur irrespective of whether you specify
COMMITCOUNT AUTOMATIC or COMMITCOUNT n.
The application is forced off the database and the current unit of work is
rolled back. To avoid processing the rows that were already committed
when you retry the import operation, use the RESTARTCOUNT or SKIPCOUNT
command parameters.
RESTARTCOUNT n
Specifies that an import operation is to be started at record n+1. The first n
records are skipped. This option is functionally equivalent to SKIPCOUNT.
RESTARTCOUNT and SKIPCOUNT are mutually exclusive.
SKIPCOUNT n
Specifies that an import operation is to be started at record n+1. The first n
records are skipped. This option is functionally equivalent to RESTARTCOUNT.
SKIPCOUNT and RESTARTCOUNT are mutually exclusive.
ROWCOUNT n
Specifies the number n of physical records in the file to be imported
(inserted or updated). Allows a user to import only n rows from a file,
starting from the record determined by the SKIPCOUNT or RESTARTCOUNT
options. If the SKIPCOUNT or RESTARTCOUNT options are not specified, the
first n rows are imported. If SKIPCOUNT m or RESTARTCOUNT m is specified,
rows m+1 to m+n are imported. When compound inserts are used, user
specified ROWCOUNT n is rounded up to the first integer multiple of the
compound count value.
WARNINGCOUNT n
Stops the import operation after n warnings. Set this parameter if no
warnings are expected, but verification that the correct file and table are
being used is required. If the import file or the target table is specified
incorrectly, the import utility will generate a warning for each row that it
74
attempts to import, which will cause the import to fail. If n is zero, or this
option is not specified, the import operation will continue regardless of the
number of warnings issued.
NOTIMEOUT
Specifies that the import utility will not time out while waiting for locks.
This option supersedes the locktimeout database configuration parameter.
Other applications are not affected.
MESSAGES ON SERVER
Specifies that the message file created on the server by the IMPORT
command is to be saved. The result set returned will include the following
two columns: MSG_RETRIEVAL, which is the SQL statement required to
DB2_UTIL_MSGPATH registry variable, as well as the directory where the data
is to be exported to.
INSERT Adds the imported data to the table without changing the existing table
data.
INSERT_UPDATE
Adds rows of imported data to the target table, or updates existing rows
(of the target table) with matching primary keys.
REPLACE
Deletes all existing data from the table by truncating the data object, and
inserts the imported data. The table definition and the index definitions are
not changed. This option can only be used if the table exists. If this option
is used when moving data between hierarchies, only the data for an entire
hierarchy, not individual subtables, can be replaced.
This option does not honor the CREATE TABLE statement's NOT
LOGGED INITIALLY (NLI) clause or the ALTER TABLE statement's
ACTIVE NOT LOGGED INITIALLY clause.
This option cannot be used to import data into system-period temporal
tables.
If an import with the REPLACE option is performed within the same
transaction as a CREATE TABLE or ALTER TABLE statement where the
NLI clause is invoked, the import will not honor the NLI clause. All inserts
will be logged.
Workaround 1
Delete the contents of the table using the DELETE statement, then
invoke the import with INSERT statement
Workaround 2
Drop the table and re-create it, then invoke the import with
INSERT statement.
75
This limitation applies to DB2 Universal Database Version 7 and DB2

UDB Version 8
REPLACE_CREATE
Note: The REPLACE_CREATE parameter is deprecated and may be removed
in a future release. For additional details, see IMPORT command options
CREATE and REPLACE_CREATE are deprecated.
If the table exists, deletes all existing data from the table by truncating the
data object, and inserts the imported data without changing the table
definition or the index definitions.
If the table does not exist, creates the table and index definitions, as well as
the row contents, in the code page of the database. See Imported table
re-creation for a list of restrictions.
This option can only be used with IXF files. If this option is used when
moving data between hierarchies, only the data for an entire hierarchy, not
individual subtables, can be replaced.
INTO table-name
Specifies the database table into which the data is to be imported. This
table cannot be a system table, a created temporary table, a declared
temporary table, or a summary table.
One can use an alias for INSERT, INSERT_UPDATE, or REPLACE, except in the
case of an earlier server, when the fully qualified or the unqualified table
name should be used. A qualified table name is in the form:
schema.tablename. The schema is the user name under which the table was
created.
If the database table contains implicitly hidden columns, you must specify
whether data for the hidden columns is included in the import operation.
included:
v Use insert-column to explicitly specify the columns into which data is to
be inserted.
db2 import from delfile1 of del
insert into table1 (c1, c2, c3,...)

implicitlyhiddeninclude when the input file contains data for the
hidden columns, or implicitlyhiddenmissing when the input file does
not.
db2 import from delfile1 of del modified by implicitlyhiddeninclude
insert into table1
v Use the DB2_DMU_DEFAULT registry variable on the client-side to set

implicitly hidden columns.
db2 import from delfile1 of del insert into table1
insert-column
Specifies the name of a column in the table or the view into which data is
to be inserted.
76
ALL TABLES
An implicit keyword for hierarchy only. When importing a hierarchy, the
default is to import all tables specified in the traversal order.
sub-table-list
For typed tables with the INSERT or the INSERT_UPDATE option, a list of
sub-table names is used to indicate the sub-tables into which data is to be
imported.
HIERARCHY
Specifies that hierarchical data is to be imported.
A keyword for hierarchy only, requesting the default order, starting from
sub-table-name. For PC/IXF files, the default order is the order stored in the
input file. The default order is the only valid order for the PC/IXF file
format.
For typed tables with the INSERT, INSERT_UPDATE, or the REPLACE option, a
list of sub-table names is used to indicate the traversal order of the
importing sub-tables in the hierarchy.
CREATE
Note: The CREATE parameter is deprecated and may be removed in a future
release. For additional details, see IMPORT command options CREATE and
REPLACE_CREATE are deprecated.
Creates the table definition and row contents in the code page of the
database. If the data was exported from a DB2 table, sub-table, or
hierarchy, indexes are created. If this option operates on a hierarchy, and
data was exported from DB2, a type hierarchy will also be created. This
option can only be used with IXF files.
Note: If the data was exported from an MVS host database, and it
contains LONGVAR fields whose lengths, calculated on the page size, are
more than 254, CREATE might fail because the rows are too long. See
Imported table re-creation for a list of restrictions. In this case, the table
should be created manually, and IMPORT with INSERT should be invoked, or,
alternatively, the LOAD command should be used.
AS ROOT TABLE
Creates one or more sub-tables as a stand-alone table hierarchy.
UNDER sub-table-name
Specifies a parent table for creating one or more sub-tables.
IN tablespace-name
Identifies the table space in which the table will be created. The table space
must exist, and must be a REGULAR table space. If no other table space is
specified, all table parts are stored in this table space. If this clause is not
specified, the table is created in a table space created by the authorization
ID. If none is found, the table is placed into the default table space
USERSPACE1. If USERSPACE1 has been dropped, table creation fails.
INDEX IN tablespace-name
Identifies the table space in which any indexes on the table will be created.
This option is allowed only when the primary table space specified in the
77
IN clause is a DMS table space. The specified table space must exist, and
must be a REGULAR or LARGE DMS table space.
Note: Specifying which table space will contain an index can only be done
when the table is created.
LONG IN tablespace-name
Identifies the table space in which the values of any long columns (LONG
VARCHAR, LONG VARGRAPHIC, LOB data types, or distinct types with
any of these as source types) will be stored. This option is allowed only if
the primary table space specified in the IN clause is a DMS table space. The
table space must exist, and must be a LARGE DMS table space.
Example
The following example shows how to import information from the file myfile.ixf
to the STAFF table in the SAMPLE database.
CALL SYSPROC.ADMIN_CMD
(IMPORT FROM /home/userid/data/myfile.ixf
OF IXF MESSAGES ON SERVER INSERT INTO STAFF)
Usage notes
Any path used in the IMPORT command must be a valid fully-qualified path on the
coordinator database partition for the server.
If the ALLOW WRITE ACCESS or COMMITCOUNT options are specified, a commit will be
performed by the import utility. This causes the ADMIN_CMD procedure to return
an SQL30090N error with reason code 1 in the case of Type 2 connections.
If the value to be assigned for a column of a result set from the ADMIN_CMD
procedure is greater than the maximum value for the data type of the column, then
the maximum value for the data type is assigned and a warning message,
SQL1155W, is returned.
Be sure to complete all table operations and release all locks before starting an
import operation. This can be done by issuing a COMMIT after closing all cursors
opened WITH HOLD, or by issuing a ROLLBACK.
The import utility adds rows to the target table using the SQL INSERT statement.
The utility issues one INSERT statement for each row of data in the input file. If an
INSERT statement fails, one of two actions result:
v If it is likely that subsequent INSERT statements can be successful, a warning
message is written to the message file, and processing continues.
v If it is likely that subsequent INSERT statements will fail, and there is potential
for database damage, an error message is written to the message file, and
processing halts.
The utility performs an automatic COMMIT after the old rows are deleted during a
REPLACE or a REPLACE_CREATE operation. Therefore, if the system fails, or the
application interrupts the database manager after the table object is truncated, all
of the old data is lost. Ensure that the old data is no longer needed before using
these options.
If the log becomes full during a CREATE, REPLACE, or REPLACE_CREATE operation, the
utility performs an automatic COMMIT on inserted records. If the system fails, or
78
the application interrupts the database manager after an automatic COMMIT, a

table with partial data remains in the database. Use the REPLACE or the
REPLACE_CREATE option to rerun the whole import operation, or use INSERT with the
RESTARTCOUNT parameter set to the number of rows successfully imported.
Updates from the IMPORT command will always be committed at the end of an
IMPORT task. The IMPORT command can also perform automatic commits during
its execution to reduce the size of the lock list and the active log space. The
IMPORT command will roll back if the active log becomes full during IMPORT
processing.
v By default, automatic commits are not performed for the INSERT or the
INSERT_UPDATE option. They are, however, performed if the COMMITCOUNT
parameter is not zero.
v Offline import does not perform automatic COMMITs if any of the following
conditions are true:
The target is a view, not a table
Compound inserts are used
Buffered inserts are used
v By default, online import performs automatic commit to free both the active log
space and the lock list. Automatic commits are not performed only if a
COMMITCOUNT value of zero is specified.
Whenever the import utility performs a COMMIT, two messages are written to the
message file: one indicates the number of records to be committed, and the other is
written after a successful COMMIT. When restarting the import operation after a
failure, specify the number of records to skip, as determined from the last
successful COMMIT.
The import utility accepts input data with minor incompatibility problems (for
example, character data can be imported using padding or truncation, and numeric
data can be imported with a different numeric data type), but data with major
incompatibility problems is not accepted.
You cannot REPLACE or REPLACE_CREATE an object table if it has any dependents
other than itself, or an object view if its base table has any dependents (including
itself). To replace such a table or a view, do the following:
1. Drop all foreign keys in which the table is a parent.
2. Run the import utility.
3. Alter the table to re-create the foreign keys.
If an error occurs while recreating the foreign keys, modify the data to maintain
referential integrity.
Referential constraints and foreign key definitions are not preserved when
recreating tables from PC/IXF files. (Primary key definitions are preserved if the
data was previously exported using SELECT *.)
Importing to a remote database requires enough disk space on the server for a
copy of the input data file, the output message file, and potential growth in the
size of the database.
If an import operation is run against a remote database, and the output message
file is very long (more than 60 KB), the message file returned to the user on the
79
client might be missing messages from the middle of the import operation. The
first 30 KB of message information and the last 30 KB of message information are
always retained.
Importing PC/IXF files to a remote database is much faster if the PC/IXF file is on
a hard drive rather than on diskettes.
You cannot IMPORT CREATE PC/IXF files on a table that has an index defined with
an expression-based key.
The database table or hierarchy must exist before data in the ASC or DEL file
formats can be imported; however, if the table does not already exist, IMPORT
CREATE or IMPORT REPLACE_CREATE creates the table when it imports data from a
PC/IXF file. For typed tables, IMPORT CREATE can create the type hierarchy and the
table hierarchy as well.
PC/IXF import should be used to move data (including hierarchical data) between
databases. If character data containing row separators is exported to a delimited
ASCII (DEL) file and processed by a text transfer program, fields containing the
row separators will shrink or expand. The file copying step is not necessary if the
source and the target databases are both accessible from the same client.
The data in ASC and DEL files is assumed to be in the code page of the client
application performing the import. PC/IXF files, which allow for different code
pages, are recommended when importing data in different code pages. If the
PC/IXF file and the import utility are in the same code page, processing occurs as
for a regular application. If the two differ, and the FORCEIN option is specified, the
import utility assumes that data in the PC/IXF file has the same code page as the
application performing the import. This occurs even if there is a conversion table
for the two code pages. If the two differ, the FORCEIN option is not specified, and
there is a conversion table, all data in the PC/IXF file will be converted from the
file code page to the application code page. If the two differ, the FORCEIN option is
not specified, and there is no conversion table, the import operation will fail. This
applies only to PC/IXF files on DB2 clients on the AIX operating system.
For table objects on an 8 KB page that are close to the limit of 1012 columns,
import of PC/IXF data files might cause DB2 to return an error, because the
maximum size of an SQL statement was exceeded. This situation can occur only if
the columns are of type CHAR, VARCHAR, or CLOB. The restriction does not
apply to import of DEL or ASC files. If PC/IXF files are being used to create a
new table, an alternative is use db2look to dump the DDL statement that created
the table, and then to issue that statement through the CLP.
DB2 Connect can be used to import data to DRDA servers such as DB2 for
OS/390, DB2 for VM and VSE, and DB2 for OS/400. Only PC/IXF import (INSERT
option) is supported. The RESTARTCOUNT parameter, but not the COMMITCOUNT
parameter, is also supported.
When using the CREATE option with typed tables, create every sub-table defined in
the PC/IXF file; sub-table definitions cannot be altered. When using options other
than CREATE with typed tables, the traversal order list enables one to specify the
traverse order; therefore, the traversal order list must match the one used during
the export operation. For the PC/IXF file format, one need only specify the target
sub-table name, and use the traverse order stored in the file.
80
The import utility can be used to recover a table previously exported to a PC/IXF
file. The table returns to the state it was in when exported.
Data cannot be imported to a system table, a created temporary table, a declared
temporary table, or a summary table.
Views cannot be created through the import utility.
Importing a multiple-part PC/IXF file whose individual parts are copied from a
Windows system to an AIX system is supported. Only the name of the first file
must be specified in the IMPORT command. For example, IMPORT FROM data.ixf OF
IXF INSERT INTO TABLE1. The file data.002, etc should be available in the same
directory as data.ixf.
On the Windows operating system:
v Importing logically split PC/IXF files is not supported.
v Importing bad format PC/IXF files is not supported.
Security labels in their internal format might contain newline characters. If you
import the file using the DEL file format, those newline characters can be mistaken
for delimiters. If you have this problem use the older default priority for delimiters
by specifying the delprioritychar file type modifier in the IMPORT command.
If the database table contains implicitly hidden columns, you must specify whether
data for the hidden columns is included in the import operation.
The IMPORT utility does not match the number of columns in a table and the
number of fields in a data file. The utility checks for a sufficient amount of data in
the data file and if a row in the data file does not contain sufficient columns of
data, the row may either be rejected with a warning message if the corresponding
table columns without data are defined as NOT NULL, or be inserted successfully
without a warning message if the corresponding table columns are defined as
NULL. On the other hand, if a row contains a higher number of columns than
required, the sufficient number of columns are processed while the remaining
columns of data are omitted and no warning message is given.
Federated considerations
When using the IMPORT command and the INSERT, UPDATE, or INSERT_UPDATE
command parameters, you must ensure that you have CONTROL privilege on the
participating nickname. You must ensure that the nickname you want to use when
doing an import operation already exists. There are also several restrictions you
should be aware of as shown in the IMPORT command parameters section.
Some data sources, such as ODBC, do not support importing into nicknames.
Column-organized table considerations
v All INSERT, UPDATE, or DELETE restrictions that pertain to column-organized
tables are inherited by the IMPORT command.
v The CREATE INTO option of the IMPORT command cannot create a
column-organized table.
v Import operations against column-organized tables use the CS isolation level
(needed for INSERT), not the default RS isolation level that is set when import
packages are bound to the database.
81
v An IXF file that was created by exporting data from a column-organized table
cannot be used with the CREATE option or the REPLACE_CREATE option of the
IMPORT command; otherwise, SQL3311N is returned.
Table 35. Result set returned by the IMPORT command
Column name
Data type
Description
ROWS_READ
BIGINT
Number of records read from the file during import.
ROWS_SKIPPED
BIGINT
Number of records skipped before inserting or updating

begins.
ROWS_INSERTED
BIGINT
Number of rows inserted into the target table.
ROWS_UPDATED
BIGINT
Number of rows in the target table updated with

information from the imported records (records whose
primary key value already exists in the table).
ROWS_REJECTED
BIGINT
Number of records that could not be imported.
ROWS_COMMITTED
BIGINT
Number of records imported successfully and

committed to the database.
MSG_RETRIEVAL
VARCHAR(512)
SQL statement that is used to retrieve messages created

SELECT SQLCODE, MSG
FROM TABLE (SYSPROC.ADMIN_GET_MSGS
(1203498_txu)) AS MSG
MSG_REMOVAL
VARCHAR(512)
SQL statement that is used to clean up messages created

(1203498_txu)
File type modifiers for the import utility

Table 36. Valid file type modifiers for the import utility: All file formats
Modifier
Description
compound=x
x is a number between 1 and 100 inclusive. Uses nonatomic compound SQL to

insert the data, and x statements will be attempted each time.
If this modifier is specified, and the transaction log is not sufficiently large, the
import operation will fail. The transaction log must be large enough to
accommodate either the number of rows specified by COMMITCOUNT, or the number
of rows in the data file if COMMITCOUNT is not specified. It is therefore
recommended that the COMMITCOUNT option be specified to avoid transaction log
overflow.
This modifier is incompatible with INSERT_UPDATE mode, hierarchical tables, and
the following modifiers: usedefaults, identitymissing, identityignore,
generatedmissing, and generatedignore.
generatedignore
82
This modifier informs the import utility that data for all generated columns is
present in the data file but should be ignored. This results in all values for the
generated columns being generated by the utility. This modifier cannot be used
with the generatedmissing modifier.
Table 36. Valid file type modifiers for the import utility: All file formats (continued)
Modifier
Description
generatedmissing
If this modifier is specified, the utility assumes that the input data file contains no
data for the generated columns (not even NULLs), and will therefore generate a
value for each row. This modifier cannot be used with the generatedignore
modifier.
identityignore
This modifier informs the import utility that data for the identity column is
present in the data file but should be ignored. This results in all identity values
being generated by the utility. The behavior will be the same for both
GENERATED ALWAYS and GENERATED BY DEFAULT identity columns. This
means that for GENERATED ALWAYS columns, no rows will be rejected. This
modifier cannot be used with the identitymissing modifier.
identitymissing
data for the identity column (not even NULLs), and will therefore generate a
value for each row. The behavior will be the same for both GENERATED
ALWAYS and GENERATED BY DEFAULT identity columns. This modifier cannot
be used with the identityignore modifier.
If this modifier is specified, the utility assumes that the input data file contains
data for the implicitly hidden columns and this data will also be imported. This
modifier cannot be used with the implicitlyhiddenmissing modifier. See the
Note: section for information about the precedence when multiple modifiers are
specified.
If this modifier is specified, the utility assumes that the input data file does not
contain data for the implicitly hidden columns and the utility will generate values
for those hidden columns. This modifier cannot be used with the
implicitlyhiddeninclude modifier. See the Note: section for information about
the precedence when multiple modifiers are specified.
lobsinfile
lob-path specifies the path to the files containing LOB data.

filename.ext.nnn.mmm/, where filename.ext is the name of the file that contains
the LOB, nnn is the offset in bytes of the LOB within the file, and mmm is the
length of the LOB in bytes. For example, if the string db2exp.001.123.456/ is
stored in the data file, the LOB is located at offset 123 in the file db2exp.001, and
is 456 bytes long.
The LOBS FROM clause specifies where the LOB files are located when the
lobsinfile modifier is used. The LOBS FROM clause will implicitly activate the
LOBSINFILE behavior. The LOBS FROM clause conveys to the IMPORT utility the list
of paths to search for the LOB files while importing the data.
To indicate a null LOB, enter the size as -1. If the size is specified as 0, it is
name are ignored. For example, the LLS of a null LOB might be db2exp.001.7.-1/.
no_type_id
Valid only when importing into a single sub-table. Typical usage is to export data
from a regular table, and then to invoke an import operation (using this modifier)
to convert the data into a single sub-table.
83
Modifier
Description
nodefaults
If a source column for a target table column is not explicitly specified, and the
table column is not nullable, default values are not loaded. Without this option, if
a source column for one of the target table columns is not explicitly specified, one
of the following occurs:
v If a default value can be specified for a column, the default value is loaded
v If the column is nullable, and a default value cannot be specified for that
column, a NULL is loaded
v If the column is not nullable, and a default value cannot be specified, an error
is returned, and the utility stops processing.
norowwarnings
Suppresses all warnings about rejected rows.
periodignore
This modifier informs the import utility that data for the period columns is
present in the data file but should be ignored. When this modifier is specified, all
period column values are generated by the utility. This modifier cannot be used
with the periodmissing modifier.
periodmissing
data for the period columns. When this modifier is specified, all period column
values are generated by the utility. This modifier cannot be used with the
periodignore modifier.
rowchangetimestampignore
This modifier informs the import utility that data for the row change timestamp
column is present in the data file but should be ignored. This results in all ROW
CHANGE TIMESTAMP being generated by the utility. The behavior will be the
same for both GENERATED ALWAYS and GENERATED BY DEFAULT columns.
This means that for GENERATED ALWAYS columns, no rows will be rejected.
This modifier cannot be used with the rowchangetimestampmissing modifier.
rowchangetimestampmissing
data for the row change timestamp column (not even NULLs), and will therefore
generate a value for each row. The behavior will be the same for both
GENERATED ALWAYS and GENERATED BY DEFAULT columns. This modifier
cannot be used with the rowchangetimestampignore modifier.
seclabelchar
Indicates that security labels in the input source file are in the string format for
security label values rather than in the default encoded numeric format. IMPORT
converts each security label into the internal format as it is loaded. If a string is
not in the proper format the row is not loaded and a warning (SQLSTATE 01H53)
is returned. If the string does not represent a valid security label that is part of
the security policy protecting the table then the row is not loaded and a warning
(SQLSTATE 01H53, SQLCODE SQL3243W)) is returned.
This modifier cannot be specified if the seclabelname modifier is specified,
otherwise the import fails and an error (SQLCODE SQL3525N) is returned.
seclabelname
Indicates that security labels in the input source file are indicated by their name
rather than the default encoded numeric format. IMPORT will convert the name to
the appropriate security label if it exists. If no security label exists with the
indicated name for the security policy protecting the table the row is not loaded
and a warning (SQLSTATE 01H53, SQLCODE SQL3244W) is returned.
This modifier cannot be specified if the seclabelchar modifier is specified,
otherwise the import fails and an error (SQLCODE SQL3525N) is returned.
Note: If the file type is ASC, any spaces following the name of the security label
will be interpreted as being part of the name. To avoid this use the striptblanks
file type modifier to make sure the spaces are removed.
84
Modifier
Description
transactionidignore
This modifier informs the import utility that data for the TRANSACTION START
ID column is present in the data file but should be ignored. When this modifier is
specified, the value for the TRANSACTION START ID column is generated by
the utility. This modifier cannot be used with the transactionidmissing modifier.
transactionidmissing
data for the TRANSACTION START ID columns. When this modifier is specified,
the value for the TRANSACTION START ID column is generated by the utility.
This modifier cannot be used with the transactionidignore modifier.
usedefaults
If a source column for a target table column has been specified, but it contains no
data for one or more row instances, default values are loaded. Examples of
missing data are:
v For DEL files: two adjacent column delimiters (",,") or two adjacent column
delimiters separated by an arbitrary number of spaces (", ,") are specified for a
column value.
v For DEL/ASC files: A row that does not have enough columns, or is not long
enough for the original specification.
Note: For ASC files, NULL column values are not considered explicitly
missing, and a default will not be substituted for NULL column values. NULL
column values are represented by all space characters for numeric, date, time,
and /timestamp columns, or by using the NULL INDICATOR for a column of
any type to indicate the column is NULL.
Without this option, if a source column contains no data for a row instance, one
v For DEL/ASC files: If the column is nullable, a NULL is loaded. If the column
is not nullable, the utility rejects the row.
Table 37. Valid file type modifiers for the import utility: ASCII file formats (ASC/DEL)
Modifier
Description
codepage=x
data in the input data set. Converts character data from this code page to the
application code page during the import operation.
The following rules apply:
v For pure DBCS (graphic) mixed DBCS, and EUC, delimiters are restricted to the
range of x00 to x3F, inclusive.
v nullindchar must specify symbols included in the standard ASCII set between
code points x20 and x7F, inclusive. This refers to ASCII symbols and code
points.
Note:
1. The codepage modifier cannot be used with the lobsinfile modifier.
2. If data expansion occurs when the code page is converted from the
application code page to the database code page, the data might be truncated
and loss of data can occur.
85
Table 37. Valid file type modifiers for the import utility: ASCII file formats (ASC/DEL) (continued)
Modifier
Description
dateformat="x"
x is the format of the date in the source file.2 Valid date elements are:
YYYY
MM
Month (two digits ranging from 01 - 12; mutually exclusive with M)
DD
DDD
A default value of 1 is assigned for each element that is not specified. Some
examples of date formats are:
"D-M-YYYY"
"MM.DD.YYYY"
"YYYYDDD"
implieddecimal
The location of an implied decimal point is determined by the column definition;

it is no longer assumed to be at the end of the value. For example, the value
12345 is loaded into a DECIMAL(8,2) column as 123.45, not 12345.00.
timeformat="x"
x is the format of the time in the source file.2 Valid time elements are:
H
HH

MM
Minute (two digits ranging from 00 - 59; mutually exclusive with M)
SS
TT
examples of time formats are:
"HH:MM:SS"
"HH.MM TT"
"SSSSS"
86
Modifier
Description
timestampformat="x"
are:
YYYY
MM
Month (two digits ranging from 01 - 12; mutually exclusive with M and
MMM)
MMM
Month (three-letter case-insensitive abbreviation for the month name;

mutually exclusive with M and MM)
DD
DDD
HH

MM
Minute (two digits ranging from 00 - 59; mutually exclusive with M,

minute)
SS
U (1 to 12 times)
Fractional seconds(number of occurrences of U represent the number of
digits with each digit ranging from 0 to 9
TT
A default value of 1 is assigned for unspecified YYYY, M, MM, D, DD, or DDD

elements. A default value of 'Jan' is assigned to an unspecified MMM element. A
default value of 0 is assigned for all other unspecified elements. Following is an
example of a time stamp format:
The valid values for the MMM element include: 'jan', 'feb', 'mar', 'apr', 'may',
'jun', 'jul', 'aug', 'sep', 'oct', 'nov' and 'dec'. These values are case
insensitive.
The following example illustrates how to import data containing user defined
date and time formats into a table called schedule:
db2 import from delfile2 of del
insert into schedule
87
Modifier
Description
usegraphiccodepage
If usegraphiccodepage is given, the assumption is made that data being imported

into graphic or double-byte character large object (DBCLOB) data fields is in the
graphic code page. The rest of the data is assumed to be in the character code
page. The graphic code page is associated with the character code page. IMPORT
determines the character code page through either the codepage modifier, if it is
specified, or through the code page of the application if the codepage modifier is
not specified.
This modifier should be used in conjunction with the delimited data file
generated by drop table recovery only if the table being recovered has graphic
data.
Restrictions
The usegraphiccodepage modifier MUST NOT be specified with DEL files created
by the EXPORT utility, as these files contain data encoded in only one code page.
The usegraphiccodepage modifier is also ignored by the double-byte character
large objects (DBCLOBs) in files.
xmlchar
Specifies that XML documents are encoded in the character code page.
This option is useful for processing XML documents that are encoded in the
specified character code page but do not contain an encoding declaration.
For each document, if a declaration tag exists and contains an encoding attribute,
the encoding must match the character code page, otherwise the row containing
the document will be rejected. Note that the character code page is the value
specified by the codepage file type modifier, or the application code page if it is
not specified. By default, either the documents are encoded in Unicode, or they
contain a declaration tag with an encoding attribute.
xmlgraphic
Specifies that XML documents are encoded in the specified graphic code page.
This option is useful for processing XML documents that are encoded in a specific
graphic code page but do not contain an encoding declaration.
the encoding must match the graphic code page, otherwise the row containing
the document will be rejected. Note that the graphic code page is the graphic
component of the value specified by the codepage file type modifier, or the
graphic component of the application code page if it is not specified. By default,
documents are either encoded in Unicode, or they contain a declaration tag with
Note: If the xmlgraphic modifier is specified with the IMPORT command, the XML
document to be imported must be encoded in the UTF-16 code page. Otherwise,
the XML document may be rejected with a parsing error, or it may be imported
into the table with data corruption.
Table 38. Valid file type modifiers for the import utility: ASC (non-delimited ASCII) file format
Modifier
Description
nochecklengths
If nochecklengths is specified, an attempt is made to import each row, even if the

source data has a column definition that exceeds the size of the target table
column. Such rows can be successfully imported if code page conversion causes
the source data to shrink; for example, 4-byte EUC data in the source could
shrink to 2-byte DBCS data in the target, and require half the space. This option
is particularly useful if it is known that the source data will fit in all cases despite
mismatched column definitions.
88
Table 38. Valid file type modifiers for the import utility: ASC (non-delimited ASCII) file format (continued)
Modifier
Description
nullindchar=x
x is a single character. Changes the character denoting a null value to x. The

default value of x is Y.3
This modifier is case sensitive for EBCDIC data files, except when the character is
an English letter. For example, if the null indicator character is specified to be the
letter N, then n is also recognized as a null indicator.
reclen=x
x is an integer with a maximum value of 32 767. x characters are read for each
row, and a new-line character is not used to indicate the end of the row.
striptblanks
Truncates any trailing blank spaces when loading data into a variable-length field.
If this option is not specified, blank spaces are kept.
In the following example, striptblanks causes the import utility to truncate
trailing blank spaces:
db2 import from myfile.asc of asc
modified by striptblanks
method l (1 10, 12 15) messages msgs.txt
insert into staff
This option cannot be specified together with striptnulls. These are mutually
exclusive options. This option replaces the obsolete t option, which is supported
for earlier compatibility only.
striptnulls
Truncates any trailing NULLs (0x00 characters) when loading data into a
variable-length field. If this option is not specified, NULLs are kept.
This option cannot be specified together with striptblanks. These are mutually
exclusive options. This option replaces the obsolete padwithzero option, which is
supported for earlier compatibility only.
Table 39. Valid file type modifiers for the import utility: DEL (delimited ASCII) file format
Modifier
Description
chardelx

mark as the character string delimiter, it should be specified as follows:
The single quotation mark (') can also be specified as a character string delimiter.
In the following example, chardel causes the import utility to interpret any
single quotation mark (') it encounters as a character string delimiter:
db2 "import from myfile.del of del
modified by chardel
method p (1, 4) insert into staff (id, years)"
coldelx
In the following example, coldel; causes the import utility to interpret any
semicolon (;) it encounters as a column delimiter:
db2 import from myfile.del of del
modified by coldel;
messages msgs.txt insert into staff
decplusblank
89
Table 39. Valid file type modifiers for the import utility: DEL (delimited ASCII) file format (continued)
Modifier
Description
decptx
In the following example, decpt; causes the import utility to interpret any
semicolon (;) it encounters as a decimal point:
db2 "import from myfile.del of del
modified by chardel
decpt; messages msgs.txt insert into staff"
delprioritychar
The current default priority for delimiters is: record delimiter, character delimiter,
column delimiter. This modifier protects existing applications that depend on the
older priority by reverting the delimiter priorities to: character delimiter, record
delimiter, column delimiter. Syntax:
db2 import ... modified by delprioritychar ...
For example, given the following DEL data file:
"Smith, Joshua",4000,34.98<row delimiter>
"Vincent,<row delimiter>, is a manager", ...
... 4005,44.37<row delimiter>
With the delprioritychar modifier specified, there will be only two rows in this
data file. The second <row delimiter> will be interpreted as part of the first data
column of the second row, while the first and the third <row delimiter> are
interpreted as actual record delimiters. If this modifier is not specified, there will
be three rows in this data file, each delimited by a <row delimiter>.
keepblanks
Preserves the leading and trailing blanks in each field of type CHAR, VARCHAR,
LONG VARCHAR, or CLOB. Without this option, all leading and trailing blanks
that are not inside character delimiters are removed, and a NULL is inserted into
the table for all blank fields.
nochardel
The import utility will assume all bytes found between the column delimiters to
be part of the column's data. Character delimiters will be parsed as part of
column data. This option should not be specified if the data was exported using
DB2 (unless nochardel was specified at export time). It is provided to support
vendor data files that do not have character delimiters. Improper usage might
result in data loss or corruption.
This option cannot be specified with chardelx, delprioritychar or nodoubledel.
These are mutually exclusive options.
nodoubledel
Suppresses recognition of double character delimiters.
Table 40. Valid file type modifiers for the import utility: IXF file format
Modifier
Description
forcein
Directs the utility to accept data despite code page mismatches, and to suppress
translation between code pages.
Fixed length target fields are checked to verify that they are large enough for the
data. If nochecklengths is specified, no checking is done, and an attempt is made
to import each row.
indexixf
90
Directs the utility to drop all indexes currently defined on the existing table, and
to create new ones from the index definitions in the PC/IXF file. This option can
only be used when the contents of a table are being replaced. It cannot be used
with a view, or when a insert-column is specified.
Table 40. Valid file type modifiers for the import utility: IXF file format (continued)
Modifier
Description
indexschema=schema
Uses the specified schema for the index name during index creation. If schema is
not specified (but the keyword indexschema is specified), uses the connection user
ID. If the keyword is not specified, uses the schema in the IXF file.
nochecklengths
If nochecklengths is specified, an attempt is made to import each row, even if the

column. Such rows can be successfully imported if code page conversion causes
the source data to shrink; for example, 4-byte EUC data in the source could
shrink to 2-byte DBCS data in the target, and require half the space. This option
is particularly useful if it is known that the source data will fit in all cases despite
forcecreate
Specifies that the table should be created with possible missing or limited
information after returning SQL3311N during an import operation.
Table 41. IMPORT behavior when using codepage and usegraphiccodepage

codepage=N
usegraphiccodepage
IMPORT behavior
Absent
Absent
All data in the file is assumed to be in the application

code page.
Present
Absent
All data in the file is assumed to be in code page N.

Warning: Graphic data will be corrupted when
imported into the database if N is a single-byte code
page.
Absent
Present
Character data in the file is assumed to be in the

application code page. Graphic data is assumed to be in
the code page of the application graphic data.
If the application code page is single-byte, then all data
is assumed to be in the application code page.
Warning: If the application code page is single-byte,
graphic data will be corrupted when imported into the
database, even if the database contains graphic columns.
Present
Present
Character data is assumed to be in code page N. Graphic

data is assumed to be in the graphic code page of N.
If N is a single-byte or double-byte code page, then all
data is assumed to be in code page N.
Warning: Graphic data will be corrupted when
imported into the database if N is a single-byte code
page.
Note:
1. The import utility does not issue a warning if an attempt is made to use
import operation fails, and an error code is returned.
2.
Double quotation marks around the date format string are mandatory. Field
separators cannot contain any of the following: a-z, A-Z, and 0-9. The field
separator should not be the same as the character delimiter or field delimiter
in the DEL file format. A field separator is optional if the start and end
91
positions of an element are unambiguous. Ambiguity can exist if (depending

on the modifier) elements such as D, H, M, or S are used, because of the
variable length of the entries.
For time stamp formats, care must be taken to avoid ambiguity between the
will fail.
"M:YYYY" (Month)
"S:M" (Minute)
Some characters, such as double quotation marks and back slashes, must be
preceded by an escape character (for example, \).
3.
Character values provided for the chardel, coldel, or decpt file type modifiers
must be specified in the code page of the source data.
The character code point (instead of the character symbol), can be specified
using the syntax xJJ or 0xJJ, where JJ is the hexadecimal representation of the
code point. For example, to specify the # character as a column delimiter, use
one of the following statements:
... modified by coldel# ...
... modified by coldel0x23 ...
... modified by coldelX23 ...
5. The following file type modifiers are not allowed when importing into a
nickname:
v indexixf
v
v
v
v
v
indexschema
dldelfiletype
nodefaults
usedefaults
no_type_idfiletype
v generatedignore
v generatedmissing
v identityignore
v identitymissing
v lobsinfile
6. The CREATE mode is not supported for XML columns.
7. All XML data must reside in XML files that are separate from the main data
file. An XML Data Specifier (XDS) (or a NULL value) must exist for each XML
column in the main data file.
8. XML documents are assumed to be in Unicode format or to contain a
declaration tag that includes an encoding attribute, unless the XMLCHAR or
XMLGRAPHIC file type modifier is specified.
92
9. Rows containing documents that are not well-formed will be rejected.

10. If the XMLVALIDATE option is specified, documents that successfully validate
against their matching schema will be annotated with the schema information
as they are inserted. Rows containing documents that fail to validate against
their matching schema will be rejected. To successfully perform the validation,
the privileges held by the user invoking the import must include at least one
of the following:
v DBADM authority
v USAGE privilege on the XML schema to be used in the validation
11. When multiple modifiers suffixed with ignore, include, missing, and override
are specified, they are applied in the order that they are listed. In the
following statement, data for implicitly hidden columns that are not identity
columns is included in the input data. While data for all identity columns,
regardless of their implicitly hidden status, is not.
db2 import from delfile1 of del modified by
implicitlyhiddeninclude identitymissing insert into table1
However, changing the order of the file type modifiers in the following
statement means that data for all implicitly hidden columns (including hidden
identity columns) is included in the input data. While data for identity
columns that are not implicitly hidden is not.
identitymissing implicitlyhiddeninclude insert into table1
If the DB2_DMU_DEFAULT registry variable is set to

IMPLICITLYHIDDENINCLUDE, then:
db2 import from delfile1 of del modified by identitymissing insert into table1
is equivalent to:
INITIALIZE TAPE command using the ADMIN_CMD procedure:

Initializes tapes for backup and restore operations to streaming tape devices. This
command is only supported on Windows operating systems.
Authorization
v SYSADM
v SYSCTRL
v SYSMAINT
Required connection
Database
Command syntax
INITIALIZE TAPE

ON
device
USING
blksize
93
Command parameters
ON device
Specifies a valid tape device name. The default value is \\.\TAPE0. The
device specified must be relative to the server.
USING blksize
Specifies the block size for the device, in bytes. The device is initialized to
use the block size specified, if the value is within the supported range of
block sizes for the device.
The buffer size specified for the BACKUP DATABASE command and for
RESTORE DATABASE must be divisible by the block size specified here.
If a value for this parameter is not specified, the device is initialized to use
its default block size. If a value of zero is specified, the device is initialized
to use a variable length block size; if the device does not support variable
length block mode, an error is returned.
When backing up to tape, use of a variable block size is currently not
supported. If you must use this option, ensure that you have well tested
procedures in place that enable you to recover successfully, using backup
images that were created with a variable block size.
When using a variable block size, you must specify a backup buffer size
that is less than or equal to the maximum limit for the tape devices that
you are using. For optimal performance, the buffer size must be equal to
the maximum block size limit of the device being used.
Example
Initialize the tape device to use a block size of 2048 bytes, if the value is within the
supported range of block sizes for the device.
CALL SYSPROC.ADMIN_CMD( initialize tape using 2048 )
Usage notes
statement.
LOAD command using the ADMIN_CMD procedure:
Loads data into a DB2 table.
Data stored on the server can be in the form of a file, tape, or named pipe. Data
can also be loaded from a cursor defined from a query running against the
currently connected database, a different database, or by using a user-written script
or application. If the COMPRESS attribute for the table is set to YES, the data loaded is
subject to compression on every data and database partition for which a dictionary
exists in the table, including data in the XML storage object of the table.
Quick link to File type modifiers for the load utility on page 121.
Restrictions
The load utility does not support loading data at the hierarchy level. The load
utility is not compatible with range-clustered tables. The load utility does not
support the NOT LOGGED INITIALLY parameter for the CREATE TABLE or
ALTER TABLE statements.
94
Scope
This command can be issued against multiple database partitions in a single
request.
Authorization
v DATAACCESS
v LOAD authority on the database and the following privileges:
INSERT privilege on the table when the load utility is invoked in INSERT
mode, TERMINATE mode (to terminate a previous load insert operation), or
RESTART mode (to restart a previous load insert operation)
INSERT and DELETE privilege on the table when the load utility is invoked
in REPLACE mode, TERMINATE mode (to terminate a previous load replace
operation), or RESTART mode (to restart a previous load replace operation)
INSERT privilege on the exception table, if such a table is used as part of the
load operation.
v To load data into a table that has protected columns, the session authorization
ID must have LBAC credentials directly or indirectly through a group or a role
that allow write access to all protected columns in the table. Otherwise the load
fails and an error (SQLSTATE 5U014) is returned.
v To load data into a table that has protected rows, the session authorization ID
must hold a security label that meets these criteria:
The security label is part of the security policy protecting the table.
The security label was granted to the session authorization ID directly or
indirectly through a group or a role for write access or for all access.
If the session authorization ID does not hold such a security label, then the load
fails and an error (SQLSTATE 5U014) is returned. The security label protects a
loaded row if the session authorization ID LBAC credentials do not allow it to
write to the security label that protects that row in the data. This does not
happen, however, when the security policy protecting the table was created with
the RESTRICT NOT AUTHORIZED WRITE SECURITY LABEL option of the
CREATE SECURITY POLICY statement. In this case the load fails and an error
(SQLSTATE 42519) is returned.
When you load data into a table with protected rows, the target table has one
column with a data type of DB2SECURITYLABEL. If the input row of data does
not contain a value for that column, that row is rejected unless the usedefaults
file type modifier is specified in the load command, in which case the security
label you hold for write access from the security policy protecting the table is
used. If you do not hold a security label for write access, the row is rejected and
processing continues on to the next row
v If the REPLACE option is specified, the session authorization ID must have the
authority to drop the table.
v If the LOCK WITH FORCE option is specified, SYSADM authority is required.
v If the table has row access control activated, then LOAD REPLACE on that table
would require the ability to drop the table. Specifically, you must have either
CONTROL or DBADM on the table.
Since all load processes (and all DB2 server processes, in general) are owned by the
instance owner, and all of these processes use the identification of the instance
owner to access needed files, the instance owner must have read access to input
95
data files. These input data files must be readable by the instance owner, regardless
of who invokes the command.
Required connection
Database.
Instance. An explicit attachment is not required. If a connection to the database has
been established, an implicit attachment to the local instance is attempted.
Command syntax
,
LOAD
FROM
filename
pipename
device
( query-statement )
( DATABASE database-alias query-statement
OF
filetype

,
LOBS FROM lob-path
XML FROM
xml-path
MODIFIED BY
file-type-mod

,
METHOD
col-start col-end
)
,
NULL INDICATORS (
null-indicator-list
,
N
col-name
,
col-position

XMLPARSE
STRIP
PRESERVE
WHITESPACE

XMLVALIDATE USING
XDS
Ignore and Map parameters
SAVECOUNT
SCHEMA schema-sqlid
SCHEMALOCATION HINTS

ROWCOUNT n
WARNINGCOUNT
INSERT
MESSAGES ON SERVER
INTO
TEMPFILES PATH
temp-pathname
table-name
KEEPDICTIONARY
REPLACE
RESETDICTIONARY
RESETDICTIONARYONLY
RESTART
TERMINATE
96
insert-column
(3)
STATISTICS NO

STATISTICS USE PROFILE
,
(1)
(2)
FOR EXCEPTION table-name

NORANGEEXC
NOUNIQUEEXC
WITHOUT PROMPTING

COPY
NO
YES
USE TSM
OPEN
num-sess
SESSIONS
,
TO device/directory
LOAD lib-name
OPEN
num-sess
SESSIONS
NONRECOVERABLE

DATA BUFFER buffer-size
SORT BUFFER
buffer-size
CPU_PARALLELISM
DISK_PARALLELISM
ALLOW NO ACCESS

INDEXING MODE
AUTOSELECT
REBUILD
INCREMENTAL
DEFERRED
ALLOW READ ACCESS

USE
tablespace-name

FETCH_PARALLELISM
YES
NO
SET INTEGRITY PENDING CASCADE
IMMEDIATE
DEFERRED
LOCK WITH FORCE

SOURCEUSEREXIT executable
Redirect Input/Output parameters

PARALLELIZE

PARTITIONED DB CONFIG
partitioned-db-option
Ignore and Map parameters:

,
schema-sqlid
IGNORE (

,
MAP
( ( schema-sqlid ,
schema-sqlid
Redirect Input/Output parameters:
REDIRECT
INPUT FROM
BUFFER input-buffer
FILE input-file
OUTPUT TO FILE output-file
OUTPUT TO FILE output-file
Notes:
1
These keywords can appear in any order.

97
Each of these keywords can only appear once.
For column-organized tables, the default is STATISTICS USE PROFILE.
Command parameters
FROM filename | pipename | device(query-statement) | (DATABASE database-alias
query-statement)
Specifies the file, pipe or device referring to an SQL statement that contains
the data being loaded, or the SQL statement itself and the optional source
database to load from cursor.
The query-statement option is used to LOAD from a cursor. It contains only
one query statement, which is enclosed in parentheses, and can start with
VALUES, SELECT or WITH. For example,
LOAD FROM (SELECT * FROM T1) OF CURSOR INSERT INTO T2
When the DATABASE database-alias clause is included before the query

statement in the parentheses, the LOAD command will attempt to load the
data using the query-statement from the given database as indicated by the
database-alias name. Note that the LOAD will be executed using the user ID
and password explicitly provided for the currently connected database (an
implicit connection will cause the LOAD to fail).
If the input source is a file, pipe, or device, it must be accessible from the
coordinator partition on the server.
If several names are specified, they will be processed in sequence. If the
last item specified is a tape device and the user is prompted for a tape, the
LOAD will fail and the ADMIN_CMD procedure will return an error.
Note:
v A fully qualified path file name must be used and must exist on the
server.
v If data is exported into a file using the EXPORT command using the
ADMIN_CMD procedure, the data file is owned by the fenced user ID.
This file is not usually accessible by the instance owner. To run the LOAD
from CLP or the ADMIN_CMD procedure, the data file must be
accessible by the instance owner ID, so read access to the data file must
be granted to the instance owner.
v Loading data from multiple IXF files is supported if the files are
physically separate, but logically one file. It is not supported if the files
are both logically and physically separate. Note that if more than one
logically and physically separate files are specified, then any file after
the first one is ignored. (Multiple physical files would be considered
logically one if they were all created with one invocation of the EXPORT
command.)
v When loading XML data from files into tables in a partitioned database
environment, the XML data files must be read-accessible to all the
database partitions where loading is taking place.
OF filetype
Specifies the format of the data:
v ASC (non-delimited ASCII format)
v DEL (delimited ASCII format)
v IXF (Integration Exchange Format, PC version) is a binary format that is
used exclusively by DB2 databases.
98
v CURSOR (a cursor declared against a SELECT or VALUES statement).

Note:
v When using a CURSOR file type to load XML data into a table in a
distributed database environment, the PARTITION_ONLY and
LOAD_ONLY modes are not supported.
v When performing a load using the CURSOR file type where the
DATABASE keyword was specified during the DECLARE CURSOR
statement, load internally spawns a separate application to fetch the
data; whereas when the DATABASE keyword is not specified, load
fetches data within the same application. This difference between the
two cases can also cause locking behavior difference. In particular, if you
currently specify the DATABASE keyword using the same database as
the currently connected database (and same userid and password as the
current connection, if specified), there might be cases where you get into
a lock issue (such as a lock wait or lock timeout, depending on the
database configuration) which can be worked around by omitting the
DATABASE keyword.
LOBS FROM lob-path
The path to the data files containing LOB values to be loaded. The path
must end with a slash. The path must be fully qualified and accessible
from the coordinator partition on the server . The names of the LOB data
files are stored in the main data file (ASC, DEL, or IXF), in the column that
will be loaded into the LOB column. The maximum number of paths that
can be specified is 999. This will implicitly activate the LOBSINFILE
behavior.
This option is ignored when specified in conjunction with the CURSOR file
type.
MODIFIED BY file-type-mod
Specifies file type modifier options. See File type modifiers for the load
utility on page 121.
METHOD
L
Specifies the start and end column numbers from which to load
data. A column number is a byte offset from the beginning of a
row of data. It is numbered starting from 1. This method can only
be used with ASC files, and is the only valid method for that file
type.
NULL INDICATORS null-indicator-list
This option can only be used when the METHOD L parameter
is specified; that is, the input file is an ASC file). The null
indicator list is a comma-separated list of positive integers
specifying the column number of each null indicator field.
The column number is the byte offset of the null indicator
field from the beginning of a row of data. There must be
one entry in the null indicator list for each data field
defined in the METHOD L parameter. A column number of
zero indicates that the corresponding data field always
contains data.
A value of Y in the NULL indicator column specifies that
the column data is NULL. Any character other than Y in
99
the NULL indicator column specifies that the column data

is not NULL, and that column data specified by the METHOD
L option will be loaded.
The NULL indicator character can be changed using the
MODIFIED BY option.
N
Specifies the names of the columns in the data file to be loaded.

The case of these column names must match the case of the
corresponding names in the system catalogs. Each table column
that is not nullable should have a corresponding entry in the
METHOD N list. For example, given data fields F1, F2, F3, F4, F5, and
F6, and table columns C1 INT, C2 INT NOT NULL, C3 INT NOT
NULL, and C4 INT, method N (F2, F1, F4, F3) is a valid request,
while method N (F2, F1) is not valid. This method can only be
used with file types IXF or CURSOR.
Specifies the field numbers (numbered from 1) of the input data

fields to be loaded. Each table column that is not nullable should
have a corresponding entry in the METHOD P list. For example, given
data fields F1, F2, F3, F4, F5, and F6, and table columns C1 INT, C2
INT NOT NULL, C3 INT NOT NULL, and C4 INT, method P (2,
1, 4, 3) is a valid request, while method P (2, 1) is not valid.
This method can only be used with file types IXF, DEL, or
CURSOR, and is the only valid method for the DEL file type.
For each of the fields specified by method P, you need to define a
corresponding column in the action statement, unless all columns
are accounted for or the first x columns are going to be loaded, as
db2 import from datafile1.del of del method P(1, 3, 4)
replace into table1 (c1, c3, c4)
XML FROM xml-path

Specifies one or more paths that contain the XML files. XDSs are contained
in the main data file (ASC, DEL, or IXF), in the column that will be loaded
into the XML column.
XMLPARSE
Specifies how XML documents are parsed. If this option is not specified,
the parsing behavior for XML documents will be determined by the value
of the CURRENT XMLPARSE OPTION special register.
STRIP WHITESPACE
Specifies to remove whitespace when the XML document is parsed.
PRESERVE WHITESPACE
Specifies not to remove whitespace when the XML document is
parsed.
XMLVALIDATE
Specifies that XML documents are validated against a schema, when
applicable.
USING XDS
XML documents are validated against the XML schema identified
by the XML Data Specifier (XDS) in the main data file. By default,
if the XMLVALIDATE option is invoked with the USING XDS clause, the
schema used to perform validation will be determined by the SCH
100
attribute of the XDS. If an SCH attribute is not present in the XDS,

no schema validation will occur unless a default schema is
specified by the DEFAULT clause.
The DEFAULT, IGNORE, and MAP clauses can be used to modify the
schema determination behavior. These three optional clauses apply
directly to the specifications of the XDS, and not to each other. For
example, if a schema is selected because it is specified by the
DEFAULT clause, it will not be ignored if also specified by the IGNORE
clause. Similarly, if a schema is selected because it is specified as
the first part of a pair in the MAP clause, it will not be re-mapped if
also specified in the second part of another MAP clause pair.
USING SCHEMA schema-sqlid
XML documents are validated against the XML schema with the
specified SQL identifier. In this case, the SCH attribute of the XML
Data Specifier (XDS) will be ignored for all XML columns.
USING SCHEMALOCATION HINTS
XML documents are validated against the schemas identified by
XML schema location hints in the source XML documents. If a
schemaLocation attribute is not found in the XML document, no
validation will occur. When the USING SCHEMALOCATION HINTS clause
is specified, the SCH attribute of the XML Data Specifier (XDS) will
be ignored for all XML columns.
See examples of the XMLVALIDATE option in the following section.
IGNORE schema-sqlid
The IGNORE clause specifies a list of one or more schemas to ignore if they
are identified by an SCH attribute. If an SCH attribute exists in the XML
Data Specifier for a loaded XML document, and the schema identified by
the SCH attribute is included in the list of schemas to ignore, then no
schema validation will occur for the loaded XML document.
Note:
If a schema is specified in the IGNORE clause, it cannot also be present in
the left side of a schema pair in the MAP clause.
The IGNORE clause applies only to the XDS. A schema that is mapped by
the MAP clause will not be subsequently ignored if specified by the IGNORE
clause.
The schema specified through the DEFAULT clause identifies a schema to use
for validation when the XML Data Specifier (XDS) of a loaded XML
document does not contain an SCH attribute identifying an XML Schema.
The DEFAULT clause takes precedence over the IGNORE and MAP clauses. If an
XDS satisfies the DEFAULT clause, the IGNORE and MAP specifications will be
ignored.
MAP schema-sqlid
Use the MAP clause to specify alternate schemas to use in place of those
specified by the SCH attribute of an XML Data Specifier (XDS) for each
101
loaded XML document. The MAP clause specifies a list of one or more
schema pairs, where each pair represents a mapping of one schema to
another. The first schema in the pair represents a schema that is referred to
by an SCH attribute in an XDS. The second schema in the pair represents
the schema that should be used to perform schema validation.
If a schema is present in the left side of a schema pair in the MAP clause, it
cannot also be specified in the IGNORE clause.
Once a schema pair mapping is applied, the result is final. The mapping
operation is non-transitive, and therefore the schema chosen will not be
subsequently applied to another schema pair mapping.
A schema cannot be mapped more than once, meaning that it cannot
appear on the left side of more than one pair.
SAVECOUNT n
Specifies that the load utility is to establish consistency points after every n
rows. This value is converted to a page count, and rounded up to intervals
of the extent size. Since a message is issued at each consistency point, this
option should be selected if the load operation will be monitored using
LOAD QUERY. If the value of n is not sufficiently high, the synchronization of
activities performed at each consistency point will impact performance.
The default value is zero, meaning that no consistency points will be
established, unless necessary.
This option is not allowed when specified in conjunction with the
CURSOR file type or when loading a table containing an XML column.
The SAVECOUNT option is not supported for column-organized tables in this
release.
ROWCOUNT n
Specifies the number of n physical records in the file to be loaded. Allows
a user to load only the first n rows in a file.
WARNINGCOUNT n
Stops the load operation after n warnings. Set this parameter if no
warnings are expected, but verification that the correct file and table are
being used is desired. If the load file or the target table is specified
incorrectly, the load utility will generate a warning for each row that it
attempts to load, which will cause the load to fail. If n is zero, or this
option is not specified, the load operation will continue regardless of the
number of warnings issued. If the load operation is stopped because the
threshold of warnings was encountered, another load operation can be
started in RESTART mode. The load operation will automatically continue
from the last consistency point. Alternatively, another load operation can
be initiated in REPLACE mode, starting at the beginning of the input file.
MESSAGES ON SERVER
Specifies that the message file created on the server by the LOAD command
is to be saved. The result set returned will include the following two
columns: MSG_RETRIEVAL, which is the SQL statement required to
102
DB2_UTIL_MSGPATH registry variable.
TEMPFILES PATH temp-pathname
Specifies the name of the path to be used when creating temporary files
during a load operation, and should be fully qualified according to the
server database partition.
Temporary files take up file system space. Sometimes, this space
requirement is quite substantial. The following list is an estimate of how
much file system space should be allocated for all temporary files:
v 136 bytes for each message that the load utility generates
v 15 KB overhead if the data file contains long field data or LOBs. This
quantity can grow significantly if the INSERT option is specified, and
there is a large amount of long field or LOB data already in the table.
v Additional storage space (equivalent to the raw size of the input data)
on the server if the column compression dictionary is being built and the
data source (such as a pipe or a socket) cannot be reopened
INSERT One of four modes under which the load utility can execute. Adds the
loaded data to the table without changing the existing table data.
A LOAD INSERT operation into a column-organized table maintains table
statistics by default if the table was empty at the start of the load
operation.
REPLACE
One of four modes under which the load utility can execute. Deletes all
existing data from the table, and inserts the loaded data. The table
definition and index definitions are not changed. If this option is used
when moving data between hierarchies, only the data for an entire
hierarchy, not individual subtables, can be replaced.
This option cannot be used to load data into system-period temporal
tables.
A LOAD REPLACE operation into a column-organized table maintains table
statistics by default.
KEEPDICTIONARY
An existing compression dictionary is preserved across the LOAD
REPLACE operation. Provided the table COMPRESS attribute is YES,
the newly replaced data is subject to being compressed using the
dictionary that existed before the invocation of the load. If no
dictionary previously existed in the table, a new dictionary is built
using the data that is being replaced into the table as long as the
table COMPRESS attribute is YES. The amount of data that is
required to build the compression dictionary in this case is subject
to the policies of ADC. This data is populated into the table as
uncompressed. Once the dictionary is inserted into the table, the
remaining data to be loaded is subject to being compressed with
this dictionary. For a summary, see the following table.
This is the default for row-organized tables.
The following example keeps the old dictionary if it is currently in
the table:
103
CALL SYSPROC.ADMIN_CMD(load from staff.del of del replace

keepdictionary into SAMPLE.STAFF statistics use profile
data buffer 8)
Table 42. LOAD REPLACE KEEPDICTIONARY
Compress
Table row data

dictionary exists
XML storage
object dictionary
exists1
Compression dictionary
Data compression
YES
YES
YES
Preserve table row data

and XML dictionaries.
Data to be loaded is subject to

compression.
YES
YES
NO

dictionary and build a
new XML dictionary.
Table row data to be loaded is

subject to compression. After
XML dictionary is built,
remaining XML data to be
loaded is subject to
compression.
YES
NO
YES
Build table row data

dictionary and preserve
XML dictionary.
After table row data

dictionary is built, remaining
table row data to be loaded is
subject to compression. XML
data to be loaded is subject to
compression.
YES
NO
NO
Build new table row data After dictionaries are built,

remaining data to be loaded
is subject to compression.
NO
YES
YES

Data to be loaded is not

compressed.
NO
YES
NO

dictionary.

compressed.
NO
NO
YES

No effect on table row
dictionary. Preserve XML compressed.
dictionary.
NO
NO
NO
No effect.

compressed.
Note:
1. A compression dictionary can be created for the XML storage
object of a table only if the XML columns are added to the table
in DB2 Version 9.7 or later, or if the table is migrated using an
online table move.
2. If LOAD REPLACE KEEPDICTIONARY operation is interrupted, load
utility can recover after either LOAD RESTART or LOAD TERMINATE
is issued. Existing XML storage object dictionary may not be
preserved after recovery from interrupted LOAD REPLACE
KEEPDICTIONARY operation. A new XML storage object dictionary
will be created if LOAD RESTART is used
RESETDICTIONARY
This directive instructs LOAD REPLACE processing to build a new
dictionary for the table data object provided that the table
COMPRESS attribute is YES. If the COMPRESS attribute is NO and
a dictionary was already present in the table it will be removed
and no new dictionary will be inserted into the table. A
compression dictionary can be built with just one user record. If
the loaded data set size is zero and if there is a preexisting
104
dictionary, the dictionary will not be preserved. The amount of

data required to build a dictionary with this directive is not subject
to the policies of ADC. For a summary, see the following table.
This is the default for column-organized tables.
The following example will reset the current dictionary and make a
new one:
CALL SYSPROC.ADMIN_CMD(load from staff.del of del replace
resetdictionary into SAMPLE.STAFF statistics use profile
data buffer 8)
Table 43. LOAD REPLACE RESETDICTIONARY
Compress
Table row data

dictionary exists
XML storage object

Compression dictionary
dictionary exists1
Data compression
YES
YES
YES
After dictionaries are built,

Build new dictionaries .
remaining data to be loaded is
If the DATA CAPTURE
subject to compression.
CHANGES option is
enabled on the CREATE
TABLE or ALTER TABLE
statements, the current
table row data dictionary
is kept (and referred to
as the historical
compression dictionary).
YES
YES
NO

Build new dictionaries2.
If the DATA CAPTURE
CHANGES option is
enabled on the CREATE
TABLE or ALTER TABLE
statements, the current
table row data dictionary
is kept (and referred to
as the historical
compression dictionary).
YES
NO
YES
Build new dictionaries.

YES
NO
NO
Build new dictionaries.

NO
YES
YES
Remove dictionaries.

compressed.
NO
YES
NO
Remove table row data

dictionary.

compressed.
NO
NO
YES
Remove XML storage

object dictionary.

compressed.
NO
NO
NO
No effect.
All table data is not

compressed.
Notes:
1. A compression dictionary can be created for the XML storage
object of a table only if the XML columns are added to the table
in DB2 Version 9.7 or later, or if the table is migrated using an
online table move.
105
2.
If a dictionary exists and the compression attribute is enabled,

but there are no records to load into the table partition, a new
dictionary cannot be built and the RESETDICTIONARY operation
will not keep the existing dictionary.
RESETDICTIONARYONLY
This option creates a column compression dictionary based on the
input file without loading any rows. You can use this option to
create the compression dictionary prior to ingesting any data by
using SQL-based utilities. This option is applicable to
column-organized tables only.
TERMINATE
One of four modes under which the load utility can execute. Terminates a
previously interrupted load operation, and rolls back the operation to the
point in time at which it started, even if consistency points were passed.
The states of any table spaces involved in the operation return to normal,
and all table objects are made consistent (index objects might be marked as
invalid, in which case index rebuild will automatically take place at next
access). If the load operation being terminated is a LOAD REPLACE, the table
will be truncated to an empty table after the LOAD TERMINATE operation. If
the load operation being terminated is a LOAD INSERT, the table will retain
all of its original records after the LOAD TERMINATE operation. For summary
of dictionary management, see Table 3.
The LOAD TERMINATE option will not remove a backup pending state from
table spaces.
RESTART
One of four modes under which the load utility can execute. Restarts a
previously interrupted load operation. The load operation will
automatically continue from the last consistency point in the load, build, or
delete phase. For summary of dictionary management, see Table 4.
The RESTART option is not supported for column-organized tables in this
release. Use the TERMINATE or REPLACE option to recover a
column-organized table after a failed load operation.
INTO table-name
Specifies the database table into which the data is to be loaded. This table
cannot be a system table, a declared temporary table, or a created
temporary table. An alias, or the fully qualified or unqualified table name
can be specified. A qualified table name is in the form schema.tablename. If
an unqualified table name is specified, the table will be qualified with the
CURRENT SCHEMA.
If the database table contains implicitly hidden columns, you must specify
whether data for the hidden columns is included in the load operation.
included:
v Use insert-column to explicitly specify the columns into which data is to
be inserted.
db2 load from delfile1 of del
insert into table1 (c1, c2, c3,...)

implicitlyhiddeninclude when the input file contains data for the
hidden columns, or implicitlyhiddenmissing when the input file does
not.
106
db2 load from delfile1 of del modified by implicitlyhiddeninclude

insert into table1
v Use the DB2_DMU_DEFAULT registry variable on the server-side to set

implicitly hidden columns. Specify IMPLICITLYHIDDENINCLUDE when
utilities assume that the implicitly hidden columns are included, or
IMPLICITLYHIDDENMISSING when utilities assume that the implicitly
hidden columns are not included.
db2 load from delfile1 of del insert into table1
insert-column
Specifies the table column into which the data is to be inserted.
The load utility cannot parse columns whose names contain one or more
spaces. For example,
CALL SYSPROC.ADMIN_CMD(load from delfile1 of del noheader
method P (1, 2, 3, 4, 5, 6, 7, 8, 9)
insert into table1 (BLOB1, S2, I3, Int 4, I5, I6, DT7, I8, TM9))
will fail because of the Int 4 column. The solution is to enclose such
column names with double quotation marks:
CALL SYSPROC.ADMIN_CMD(load from delfile1 of del noheader
method P (1, 2, 3, 4, 5, 6, 7, 8, 9)
insert into table1 (BLOB1, S2, I3, "Int 4", I5, I6, DT7, I8, TM9))
FOR EXCEPTION table-name

Specifies the exception table into which rows in error will be copied. Any
row that is in violation of a unique index or a primary key index is copied.
If an unqualified table name is specified, the table will be qualified with
the CURRENT SCHEMA. The table cannot be a column-organized table.
Information that is written to the exception table is not written to the
dump file. In a partitioned database environment, an exception table must
be defined for those database partitions on which the loading table is
defined. The dump file, otherwise, contains rows that cannot be loaded
because they are invalid or have syntax errors.
When loading XML data, using the FOR EXCEPTION clause to specify a load
exception table is not supported in the following cases:
v When using label-based access control (LBAC).
v When loading data into a partitioned table.
NORANGEEXC
Indicates that if a row is rejected because of a range violation it will not be
inserted into the exception table.
NOUNIQUEEXC
Indicates that if a row is rejected because it violates a unique constraint it
will not be inserted into the exception table.
Instructs load to collect statistics during the load according to the profile
defined for this table. This is the default for column-organized tables. The
profile must be created before issuing the LOAD command. The profile is
created by the RUNSTATS command. For row-organized tables, if the profile
does not exist and this parameter is specified, a warning is returned and
no statistics are collected. For column-organized tables, if the profile does
not exist and this parameter is specified, default automatic statistics are
collected by using the RUNSTATS command.
107
During load, distribution statistics are not collected for columns of type
XML.
STATISTICS NO
Specifies that no statistics are to be collected, and that the statistics in the
catalogs are not to be altered. This is the default for row-organized tables.
COPY NO
Specifies that the table space in which the table resides will be placed in
backup pending state if forward recovery is enabled (that is, if either
logarchmeth1 or logarchmeth2 is set to a value other than OFF). The COPY
NO option will also put the table space state into the Load in Progress table
space state. This is a transient state that will disappear when the load
completes or aborts. The data in any table in the table space cannot be
updated or deleted until a table space backup or a full database backup is
made. However, it is possible to access the data in any table by using the
SELECT statement.
LOAD with COPY NO on a recoverable database leaves the table spaces in a
backup pending state. For example, performing a LOAD with COPY NO and
INDEXING MODE DEFERRED will leave indexes needing a refresh. Certain
queries on the table might require an index scan and will not succeed until
the indexes are refreshed. The index cannot be refreshed if it resides in a
table space which is in the backup pending state. In that case, access to the
table will not be allowed until a backup is taken. Index refresh is done
automatically by the database when the index is accessed by a query. If
one of COPY NO, COPY YES, or NONRECOVERABLE is not specified, and the
database is recoverable (logarchmeth1 or logarchmeth2 is set to value other
than OFF), then COPY NO is the default.
COPY YES
Specifies that a copy of the loaded data will be saved. This option is
invalid if forward recovery is disabled.
The COPY YES option is not supported for column-organized tables in this
release.
USE TSM
Specifies that the copy will be stored using Tivoli Storage Manager
(TSM).
OPEN num-sess SESSIONS
The number of I/O sessions to be used with TSM or the vendor
product. The default value is 1.
TO device/directory
Specifies the device or directory on which the copy image will be
created.
LOAD lib-name
The name of the shared library (DLL on Windows operating
systems) containing the vendor backup and restore I/O functions
to be used. It can contain the full path. If the full path is not given,
it will default to the path where the user exit programs reside.
NONRECOVERABLE
Specifies that the load transaction is to be marked as unrecoverable and
that it will not be possible to recover it by a subsequent roll forward
action. The roll forward utility will skip the transaction and will mark the
table into which data was being loaded as "invalid". The utility will also
ignore any subsequent transactions against that table. After the roll
108
forward operation is completed, such a table can only be dropped or

restored from a backup (full or table space) taken after a commit point
following the completion of the nonrecoverable load operation.
With this option, table spaces are not put in backup pending state
following the load operation, and a copy of the loaded data does not have
to be made during the load operation. If one of COPY NO, COPY YES, or
NONRECOVERABLE is not specified, and the database is not recoverable
(logarchmeth1 and logarchmeth2 are both set to OFF), then NONRECOVERABLE
is the default.
WITHOUT PROMPTING
Specifies that the list of data files contains all the files that are to be
loaded, and that the devices or directories listed are sufficient for the entire
load operation. If a continuation input file is not found, or the copy targets
are filled before the load operation finishes, the load operation will fail,
and the table will remain in load pending state.
This is the default. Any actions which normally require user intervention
will return an error message.
DATA BUFFER buffer-size
Specifies the number of 4 KB pages (regardless of the degree of
parallelism) to use as buffered space for transferring data within the utility.
If the value specified is less than the algorithmic minimum, the minimum
required resource is used, and no warning is returned.
This memory is allocated directly from the utility heap, whose size can be
modified through the util_heap_sz database configuration parameter.
Beginning in version 9.5, the value of the DATA BUFFER option of the
LOAD command can temporarily exceed util_heap_sz if more memory is
available in the system. In this situation, the utility heap is dynamically
increased as needed until the database_memory limit is reached. This
memory will be released once the load operation completes.
If a value is not specified, an intelligent default is calculated by the utility
at run time. The default is based on a percentage of the free space available
in the utility heap at the instantiation time of the loader, as well as some
characteristics of the table.
SORT BUFFER buffer-size
This option specifies a value that overrides the sortheap database
configuration parameter during a load operation. It is relevant only when
loading tables with indexes and only when the INDEXING MODE parameter is
not specified as DEFERRED. The value that is specified cannot exceed the
value of sortheap. This parameter is useful for throttling the sort memory
that is used when loading tables with many indexes without changing the
value of sortheap, which would also affect general query processing.
CPU_PARALLELISM n
Specifies the number of processes or threads that the load utility will create
for parsing, converting, and formatting records when building table
objects. This parameter is designed to exploit the number of processes
running per database partition. It is particularly useful when loading
presorted data, because record order in the source data is preserved. If the
value of this parameter is zero, or has not been specified, the load utility
uses an intelligent default value (usually based on the number of CPUs
available) at run time.
Note:
109
1. If this parameter is used with tables containing either LOB or LONG

VARCHAR fields, its value becomes one, regardless of the number of
system CPUs or the value specified by the user.
2. Specifying a small value for the SAVECOUNT parameter causes the loader
to perform many more I/O operations to flush both data and table
metadata. When CPU_PARALLELISM is greater than one, the flushing
operations are asynchronous, permitting the loader to exploit the CPU.
When CPU_PARALLELISM is set to one, the loader waits on I/O during
consistency points. A load operation with CPU_PARALLELISM set to two,
and SAVECOUNT set to 10 000, completes faster than the same operation
with CPU_PARALLELISM set to one, even though there is only one CPU.
DISK_PARALLELISM n
Specifies the number of processes or threads that the load utility will create
for writing data to the table space containers. If a value is not specified, the
utility selects an intelligent default based on the number of table space
containers and the characteristics of the table.
INDEXING MODE
Specifies whether the load utility is to rebuild indexes or to extend them
incrementally. Valid values are:
AUTOSELECT
The load utility will automatically decide between REBUILD or
INCREMENTAL mode. The decision is based on the amount of
data being loaded and the depth of the index tree. Information
relating to the depth of the index tree is stored in the index object.
RUNSTATS is not required to populate this information. AUTOSELECT
is the default indexing mode.
REBUILD
All indexes will be rebuilt. The utility must have sufficient
resources to sort all index key parts for both old and appended
table data.
If the LogIndexBuild database configuration parameter is turned
on, the transaction log contains the image of each index page after
it is created. If the LogIndexBuild database configuration
parameter is turned off, only the allocation and initialization of
each page is logged by the Index Manager (about 250 bytes per
page approximately as opposed to the non-empty portion of each
page).
INCREMENTAL
Indexes will be extended with new data. This approach consumes
index free space. It only requires enough sort space to append
index keys for the inserted records. This method is only supported
in cases where the index object is valid and accessible at the start
of a load operation (it is, for example, not valid immediately
following a load operation in which the DEFERRED mode was
specified). If this mode is specified, but not supported due to the
state of the index, a warning is returned, and the load operation
continues in REBUILD mode. Similarly, if a load restart operation
is begun in the load build phase, INCREMENTAL mode is not
supported.
If the LogIndexBuild database configuration parameter is turned
on, the DB2 software generates the log records for the insertion of
every key into the index as well as any page splits performed. If
110
this parameter is turned off (which is common when not using

HADR), the amount of index logging performed by the Index
Manager depends on whether or not the ALLOW READ ACCESS
option was specified. If the ALLOW READ ACCESS option is
specified, the log record is generated including logs for page splits.
If the ALLOW READ ACCESS option is not specified, no log
record from the Index Manager is generated.
DEFERRED
The load utility will not attempt index creation if this mode is
specified. Indexes will be marked as needing a refresh. The first
access to such indexes that is unrelated to a load operation might
force a rebuild, or indexes might be rebuilt when the database is
restarted. This approach requires enough sort space for all key
parts for the largest index. The total time subsequently taken for
index construction is longer than that required in REBUILD mode.
Therefore, when performing multiple load operations with deferred
indexing, it is advisable (from a performance viewpoint) to let the
last load operation in the sequence perform an index rebuild,
rather than allow indexes to be rebuilt at first non-load access.
Deferred indexing is only supported for tables with non-unique
indexes, so that duplicate keys inserted during the load phase are
not persistent after the load operation.
ALLOW NO ACCESS
Load will lock the target table for exclusive access during the load. The
table state will be set to Load In Progress during the load. ALLOW NO ACCESS
is the default behavior. It is the only valid option for LOAD REPLACE.
When there are constraints on the table, the table state will be set to Set
Integrity Pending as well as Load In Progress. The SET INTEGRITY
statement must be used to take the table out of Set Integrity Pending state.
ALLOW READ ACCESS
Load will lock the target table in a share mode. The table state will be set
to both Load In Progress and Read Access. Readers can access the
non-delta portion of the data while the table is being load. In other words,
data that existed before the start of the load will be accessible by readers to
the table, data that is being loaded is not available until the load is
complete.
Important: Starting with Version 10.1 Fix Pack 1, the ALLOW READ
ACCESS parameter is deprecated and might be removed in a future
release. For more details, see ALLOW READ ACCESS parameter in the
LOAD command is deprecated at .
The ALLOW READ ACCESS option is not supported for column-organized
tables in this release.
LOAD TERMINATE or LOAD RESTART of an ALLOW READ ACCESS load can use this
parameter; LOAD TERMINATE or LOAD RESTART of an ALLOW NO ACCESS load
cannot use this parameter. Furthermore, this option is not valid if the
indexes on the target table are marked as requiring a rebuild.
When there are constraints on the table, the table state will be set to Set
Integrity Pending as well as Load In Progress, and Read Access. At the end
of the load, the table state Load In Progress will be removed but the table
states Set Integrity Pending and Read Access will remain. The SET
INTEGRITY statement must be used to take the table out of Set Integrity
111
Pending. While the table is in Set Integrity Pending and Read Access
states, the non-delta portion of the data is still accessible to readers, the
new (delta) portion of the data will remain inaccessible until the SET
INTEGRITY statement has completed. A user can perform multiple loads
on the same table without issuing a SET INTEGRITY statement. Only the
original (checked) data will remain visible, however, until the SET
INTEGRITY statement is issued.
ALLOW READ ACCESS also supports the following modifiers:
USE tablespace-name
If the indexes are being rebuilt, a shadow copy of the index is built
in table space tablespace-name and copied over to the original table
space at the end of the load during an INDEX COPY PHASE. Only
system temporary table spaces can be used with this option. If not
specified then the shadow index will be created in the same table
space as the index object. If the shadow copy is created in the same
table space as the index object, the copy of the shadow index object
over the old index object is instantaneous. If the shadow copy is in
a different table space from the index object a physical copy is
performed. This could involve considerable I/O and time. The
copy happens while the table is offline at the end of a load during
the INDEX COPY PHASE.
Without this option the shadow index is built in the same table
space as the original. Since both the original index and shadow
index by default reside in the same table space simultaneously,
there might be insufficient space to hold both indexes within one
table space. Using this option ensures that you retain enough table
space for the indexes.
This option is ignored if the user does not specify INDEXING MODE
REBUILD or INDEXING MODE AUTOSELECT. This option will also be
ignored if INDEXING MODE AUTOSELECT is chosen and load chooses to
incrementally update the index.
FETCH_PARALLELISM YES | NO
When performing a load from a cursor where the cursor is declared using
the DATABASE keyword, or when using the API sqlu_remotefetch_entry
media entry, and this option is set to YES, the load utility attempts to
parallelize fetching from the remote data source if possible. If set to NO, no
parallel fetching is performed. The default value is YES. For more
information, see Moving data using the CURSOR file type.
SET INTEGRITY PENDING CASCADE
If LOAD puts the table into Set Integrity Pending state, the SET INTEGRITY
PENDING CASCADE option allows the user to specify whether or not Set
Integrity Pending state of the loaded table is immediately cascaded to all
descendents (including descendent foreign key tables, descendent
immediate materialized query tables and descendent immediate staging
tables).
IMMEDIATE
Indicates that Set Integrity Pending state is immediately extended
to all descendent foreign key tables, descendent immediate
materialized query tables and descendent staging tables. For a LOAD
INSERT operation, Set Integrity Pending state is not extended to
descendent foreign key tables even if the IMMEDIATE option is
specified.
112
When the loaded table is later checked for constraint violations

(using the IMMEDIATE CHECKED option of the SET INTEGRITY
statement), descendent foreign key tables that were placed in Set
Integrity Pending Read Access state will be put into Set Integrity
Pending No Access state.
DEFERRED
Indicates that only the loaded table will be placed in the Set
Integrity Pending state. The states of the descendent foreign key
tables, descendent immediate materialized query tables and
descendent immediate staging tables will remain unchanged.
Descendent foreign key tables might later be implicitly placed in
Set Integrity Pending state when their parent tables are checked for
constraint violations (using the IMMEDIATE CHECKED option of
the SET INTEGRITY statement). Descendent immediate
materialized query tables and descendent immediate staging tables
will be implicitly placed in Set Integrity Pending state when one of
its underlying tables is checked for integrity violations. A query of
a table that is in the Set Integrity Pending state might succeed if an
eligible materialized query table that is not in the Set Integrity
Pending state is accessed by the query instead of the specified
table. A warning (SQLSTATE 01586) will be issued to indicate that
descendent tables have been placed in Set Integrity Pending state.
See the Notes section of the SET INTEGRITY statement in the SQL
Reference for when these descendent tables will be put into Set
Integrity Pending state.
If the SET INTEGRITY PENDING CASCADE option is not specified:
v Only the loaded table will be placed in Set Integrity Pending state. The
state of descendent foreign key tables, descendent immediate
materialized query tables and descendent immediate staging tables will
remain unchanged, and can later be implicitly put into Set Integrity
Pending state when the loaded table is checked for constraint violations.
If LOAD does not put the target table into Set Integrity Pending state, the
SET INTEGRITY PENDING CASCADE option is ignored.
LOCK WITH FORCE
The utility acquires various locks including table locks in the process of
loading. Rather than wait, and possibly timeout, when acquiring a lock,
this option allows load to force off other applications that hold conflicting
locks on the target table. Applications holding conflicting locks on the
system catalog tables will not be forced off by the load utility. Forced
applications will roll back and release the locks the load utility needs. The
load utility can then proceed. This option requires the same authority as
the FORCE APPLICATIONS command (SYSADM or SYSCTRL).
ALLOW NO ACCESS loads might force applications holding conflicting locks at
the start of the load operation. At the start of the load the utility can force
applications that are attempting to either query or modify the table.
ALLOW READ ACCESS loads can force applications holding conflicting locks at
the start or end of the load operation. At the start of the load the load
utility can force applications that are attempting to modify the table. At the
end of the load operation, the load utility can force applications that are
attempting to either query or modify the table.
113
SOURCEUSEREXIT executable
Specifies an executable filename which will be called to feed data into the
utility.
The SOURCEUSEREXIT option is not supported for column-organized tables in
this release.
REDIRECT
INPUT FROM
BUFFER input-buffer
The stream of bytes specified in input-buffer is
passed into the STDIN file descriptor of the process
executing the given executable.
FILE input-file
The contents of this client-side file are passed into
the STDIN file descriptor of the process executing
the given executable.
OUTPUT TO
FILE output-file
The STDOUT and STDERR file descriptors are
captured to the fully qualified server-side file
specified.
PARALLELIZE
Increases the throughput of data coming into the load utility by
invoking multiple user exit processes simultaneously. This option is
only applicable in multi-partition database environments and is
ignored in single-partition database environments.
For more information, see Moving data using a customized application
(user exit).
PARTITIONED DB CONFIG partitioned-db-option
Allows you to execute a load into a table distributed across multiple
database partitions. The PARTITIONED DB CONFIG parameter allows you to
specify partitioned database-specific configuration options. The
partitioned-db-option values can be any of the following options:
PART_FILE_LOCATION x
OUTPUT_DBPARTNUMS x
PARTITIONING_DBPARTNUMS x
MODE x
MAX_NUM_PART_AGENTS x
ISOLATE_PART_ERRS x
STATUS_INTERVAL x
PORT_RANGE x
CHECK_TRUNCATION
MAP_FILE_INPUT x
MAP_FILE_OUTPUT x
TRACE x
NEWLINE
DISTFILE x
OMIT_HEADER
RUN_STAT_DBPARTNUM x
Detailed descriptions of these options are provided in Load configuration

options for partitioned database environments.
114
RESTARTCOUNT
Deprecated.
USING directory
Deprecated.
Example
Issue a load with replace option for the employee table data from a file.
CALL SYSPROC.ADMIN_CMD(LOAD FROM /home/theresax/tmp/emp_exp.dat
OF DEL METHOD P (1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14)
MESSAGES /home/theresax/tmp/emp_load.msg
REPLACE INTO THERESAX.EMPLOYEE (EMPNO, FIRSTNME, MIDINIT, LASTNAME,
WORKDEPT, PHONENO, HIREDATE, JOB, EDLEVEL, SEX, BIRTHDATE, SALARY,
BONUS, COMM) COPY NO INDEXING MODE AUTOSELECT ISOLATE_PART_ERRS
LOAD_ERRS_ONLY MODE PARTITION_AND_LOAD )
The following section is an example of output from a single-partition database.

Result set 1
-------------ROWS_READ
ROWS_SKIPPED
ROWS_LOADED
ROWS_REJECTED
...
---------...- ------------...- -----------...- -------------...- ...
32
0
32
0 ...
Return Status = 0
Output from a single-partition database (continued).

... ROWS_DELETED
ROWS_COMMITTED
MSG_RETRIEVAL
... ------------...- --------------...- ------------------------------......
0
32 SELECT SQLCODE, MSG_TEXT FROM
...
TABLE(SYSPROC.ADMIN_GET_MSGS(
...
2203498_thx)) AS MSG
Output from a single-partition database (continued).

... MSG_REMOVAL
... --------------------------------------------...... CALL SYSPROC.ADMIN_REMOVE_MSGS(2203498_thx)
...
Note: The following columns are also returned in this result set, but are set to
NULL because they are only populated when loading into a multi-partition
database: ROWS_PARTITIONED and NUM_AGENTINFO_ENTRIES.
The following section is an example of output from a multi-partition database.
Result set 1
-------------ROWS_READ
ROWS_REJECTED
ROWS_PARTITIONED
NUM_AGENTINFO_ENTRIES ...
---------...- -------------...- ----------------...- --------------------- ...
32
0
32
5 ...
...
...
Output from a multi-partition database (continued).
115
... MSG_RETRIEVAL
MSG_REMOVAL
... ----------------------------------...- -----------------------------...... SELECT DBPARTITIONNUM, AGENT_TYPE,
...
SQLCODE, MSG_TEXT FROM TABLE
(2203498_thx)
...
(SYSPROC.ADMIN_GET_MSGS
...
(2203498_thx)) AS MSG
Note: The following columns are also returned in this result set, but are set to
NULL because they are only populated when loading into a single-partition
database: ROWS_SKIPPED, ROWS_LOADED, ROWS_DELETED and
ROWS_COMMITTED.
Output from a multi-partition database (continued).
Result set 2
-------------DBPARTITIONNUM
SQLCODE
--------------...- -------...10
0
20
0
30
0
20
0
10
0
TABSTATE
--------...NORMAL
NORMAL
NORMAL
NORMAL
NORMAL
AGENTTYPE
------------...LOAD
LOAD
LOAD
PARTITION
PRE_PARTITION
Return Status = 0
Example : Loading XML data

The user has constructed a data file with XDS fields to describe the documents that
are to be inserted into the table. It might appear like this :
1, "<XDS FIL=""file1.xml"" />"
2, "<XDS FIL=file2.xml OFF=23 LEN=45 />"
For the first row, the XML document is identified by the file named file1.xml.
Note that since the character delimiter is the double quote character, and double
quotation marks exist inside the XDS, the double quotation marks contained within
the XDS are doubled. For the second row, the XML document is identified by the
file named file2.xml, and starts at byte offset 23, and is 45 bytes in length.
The user issues a load command without any parsing or validation options for the
XML column, and the data is loaded successfully:
LOAD
FROM data.del of DEL INSERT INTO mytable
Example : Loading XML data from CURSOR

Loading data from cursor is the same as with a regular relational column type. The
user has two tables, T1 and T2, each of which consist of a single XML column
named C1. To LOAD from T1 into T2, the user will first declare a cursor:
DECLARE
X1 CURSOR FOR SELECT C1 FROM T1;
Next, the user may issue a LOAD using the cursor type:
LOAD FROM X1 of
CURSOR INSERT INTO T2
116
Applying the XML specific LOAD options to the cursor type is the same as loading
from a file.
Usage notes
v Data is loaded in the sequence that appears in the input file. If a particular
sequence is desired, the data should be sorted before a load is attempted. If
preservation of the source data order is not required, consider using the
ANYORDER file type modifier, described in the following File type modifiers for
the load utility section.
v The load utility builds indexes based on existing definitions. The exception
tables are used to handle duplicates on unique keys. The utility does not enforce
referential integrity, perform constraints checking, or update materialized query
tables that are dependent on the tables being loaded. Tables that include
referential or check constraints are placed in Set Integrity Pending state.
Summary tables that are defined with REFRESH IMMEDIATE, and that are
dependent on tables being loaded, are also placed in Set Integrity Pending state.
Issue the SET INTEGRITY statement to take the tables out of Set Integrity
Pending state. Load operations cannot be carried out on replicated materialized
query tables.
v If a clustering index exists on the table, the data should be sorted on the
clustering index before loading. Data does not need to be sorted before loading
into a multidimensional clustering (MDC) table, however.
v If you specify an exception table when loading into a protected table, any rows
that are protected by invalid security labels will be sent to that table. This might
allow users that have access to the exception table to access to data that they
would not normally be authorized to access. For better security be careful who
you grant exception table access to, delete each row as soon as it is repaired and
copied to the table being loaded, and drop the exception table as soon as you
are done with it.
v Security labels in their internal format might contain newline characters. If you
load the file using the DEL file format, those newline characters can be mistaken
for delimiters. If you have this problem use the older default priority for
delimiters by specifying the delprioritychar file type modifier in the LOAD
command.
v The LOAD utility issues a COMMIT statement at the beginning of the operation
v Any path used in the LOAD command must be a valid fully-qualified path on the
server coordinator partition.
v For performing a load using the CURSOR file type where the DATABASE
keyword was specified during the DECLARE CURSOR statement, the user ID
and password used to authenticate against the database currently connected to
(for the load) will be used to authenticate against the source database (specified
by the DATABASE option of the DECLARE CURSOR statement). If no user ID
or password was specified for the connection to the loading database, a user ID
and password for the source database must be specified during the DECLARE
CURSOR statement.
v Loading a multiple-part PC/IXF file whose individual parts are copied from a
Windows system to an AIX system is supported. The names of all the files must
be specified in the LOAD command. For example, LOAD FROM DATA.IXF, DATA.002
OF IXF INSERT INTO TABLE1. Loading to the Windows operating system from
logically split PC/IXF files is not supported.
117
v When restarting a failed LOAD, the behavior will follow the existing behavior in
that the BUILD phase will be forced to use the REBUILD mode for indexes.
v The Load utility might generate a very large copy of the image file when the
COPY YES option is used. This behavior is expected when the LOAD command
writes out an entire buffer of data to the copy image for every LOB/LF column
value that is loaded. The buffer is an internal object, and its size is determined
by several internal and external factors. Typically, the buffer size is between
68KB and a few hundred KB.
v Loading XML documents between databases is not supported and returns error
message SQL1407N.
v The LOAD utility does not support loading into tables that contain columns that
reference fenced procedures. If you issue the LOAD command on such table, you
will receive error message SQL1376N. To work around this restriction, you can
redefine the routine to be unfenced, or use the import utility.
v If the database table contains implicitly hidden columns, you must specify
whether data for the hidden columns is included in the load operation.
v The IMPORT utility does not match the number of columns in a table and the
number of fields in a data file. The utility checks for a sufficient amount of data
in the data file and if a row in the data file does not contain sufficient columns
of data, the row may either be rejected with a warning message if the
corresponding table columns without data are defined as NOT NULL, or be
inserted successfully without a warning message if the corresponding table
columns are defined as NULL. On the other hand, if a row contains a higher
number of columns than required, the sufficient number of columns are
processed while the remaining columns of data are omitted and no warning
message is given.
v The STATISTICS options only work for the LOAD REPLACE option and do not work
for other LOAD command options.
Summary of LOAD TERMINATE and LOAD RESTART dictionary management
The following chart summarizes the compression dictionary management behavior
for LOAD processing under the TERMINATE directive.
Table 44. LOAD TERMINATE dictionary management
Table
COMPRESS
attribute
Does table row

data dictionary
existed before
LOAD?
XML storage object

dictionary exists
before LOAD1
TERMINATE: LOAD
REPLACE
KEEPDICTIONARY or
LOAD INSERT
YES
YES
YES
Keep existing dictionaries.
Neither dictionary is
kept. 2
YES
YES
NO
Keep existing dictionary.
Nothing is kept.
YES
NO
YES
Nothing is kept.
YES
NO
NO
Nothing is kept.
Nothing is kept.
NO
YES
YES
Nothing is kept.
NO
YES
NO
Nothing is kept.
NO
NO
YES
Nothing is kept.
NO
NO
NO
Do nothing.
Do nothing.
Note:
118
TERMINATE: LOAD
REPLACE
RESETDICTIONARY
1. A compression dictionary can be created for the XML storage object of a table
only if the XML columns are added to the table in DB2 Version 9.7 or later, or if
the table is migrated using an online table move.
2. In the special case that the table has data capture enabled, the table row data
dictionary is kept.
LOAD RESTART truncates a table up to the last consistency point reached. As part of
LOAD RESTART processing, a compression dictionary will exist in the table if it was
present in the table at the time the last LOAD consistency point was taken. In that
case, LOAD RESTART will not create a new dictionary. For a summary of the possible
conditions, see Table 4.
Table 45. LOAD RESTART dictionary management
Table
COMPRESS
Attribute
Table row data

dictionary exist
before LOAD
consistency
point?1
XML Storage object

dictionary existed
before last LOAD?2
RESTART: LOAD
REPLACE
KEEPDICTIONARY or
LOAD INSERT
YES
YES
YES
Keep existing
dictionaries.
YES
YES
NO
Keep existing table row

data dictionary and build
XML dictionary subject to
ADC.

data dictionary and
build XML dictionary.
YES
NO
YES

dictionary subject to ADC.
Keep existing XML
dictionary.

dictionary. Keep existing
XML dictionary.
YES
NO
NO
Build table row data and

XML dictionaries subject to
ADC.
Build table row data and

XML dictionaries.
NO
YES
YES
Remove existing
dictionaries.
NO
YES
NO

data dictionary.
Remove existing table

row data dictionary.
NO
NO
YES
Keep existing XML

dictionary.
Remove existing XML

dictionary.
NO
NO
NO
Do nothing.
Do nothing.
RESTART: LOAD
REPLACE
RESETDICTIONARY
Notes:
1. The SAVECOUNT option is not allowed when loading XML data, load operations
that fail during the load phase restart from the beginning of the operation.
2. A compression dictionary can be created for the XML storage object of a table
only if the XML columns are added to the table in DB2 Version 9.7 or later, or if
the table is migrated using an online table move.
statement. If execution is successful, the command returns additional information.
A single-partition database will return one result set; a multi-partition database
will return two result sets.
v Table 46 on page 120: Result set for a load operation.
119
v Table 47: Result set 2 contains information for each database partition in a
multi-partition load operation.
Table 46. Result set returned by the LOAD command
Column name
Data type
Description
ROWS_READ
BIGINT
Number of rows read during the load

operation.
ROWS_SKIPPED
BIGINT
Number of rows skipped before the load

operation started. This information is
returned for a single-partition database only.
ROWS_LOADED
BIGINT
Number of rows loaded into the target table.

This information is returned for a
single-partition database only.
ROWS_REJECTED
BIGINT
Number of rows that could not be loaded

into the target table.
ROWS_DELETED
BIGINT
Number of duplicate rows that were not

loaded into the target table. This information
is returned for a single-partition database
only.
ROWS_COMMITTED
BIGINT
Total number of rows processed: the number

of rows successfully loaded into the target
table, plus the number of skipped and
rejected rows. This information is returned
for a single-partition database only.
ROWS_PARTITIONED
BIGINT
Number of rows distributed by all database

distributing agents. This information is
returned for a multi-partition database only.
NUM_AGENTINFO_ENTRIES
BIGINT
Number of entries returned in the second

result set for a multi-partition database. This
is the number of agent information entries
produced by the load operation. This
information is returned for multi-partition
database only.
MSG_RETRIEVAL
VARCHAR(512)
SQL statement that is used to retrieve

messages created by this utility. For example,
SELECT SQLCODE, MSG
FROM TABLE
(SYSPROC.ADMIN_GET_MSGS
(2203498_thx)) AS MSG
This information is returned only if the
MESSAGES ON SERVER clause is specified.
MSG_REMOVAL
VARCHAR(512)
SQL statement that is used to clean up

messages created by this utility. For example:
(2203498_thx)
This information is returned only if the
MESSAGES ON SERVER clause is specified.
Table 47. Result set 2 returned by the LOAD command for each database partition in a multi-partition database.
Column name
Data type
Description
DBPARTITIONNUM
SMALLINT
The database partition number on which the

agent executed the load operation.
120
Table 47. Result set 2 returned by the LOAD command for each database partition in a multi-partition
database. (continued)
Column name
Data type
Description
SQLCODE
INTEGER
Final SQLCODE resulting from the load

processing.
TABSTATE
VARCHAR(20)
Table state after load operation has

completed. It is one of:
v LOADPENDING: Indicates that the load did
not complete, but the table on the partition
has been left in a LOAD PENDING state.
A load restart or terminate operation must
be done on the database partition.
v NORMAL: Indicates that the load completed
successfully on the database partition and
the table was taken out of the LOAD IN
PROGRESS (or LOAD PENDING) state.
Note that the table might still be in Set
Integrity Pending state if further
constraints processing is required, but this
state is not reported by this interface.
v UNCHANGED: Indicates that the load did not
complete due to an error, but the state of
the table has not yet been changed. It is
not necessary to perform a load restart or
terminate operation on the database
partition.
Note: Not all possible table states are
returned by this interface.
AGENTTYPE
VARCHAR(20)
Agent type and is one of:

v FILE_TRANSFER
v LOAD
v LOAD_TO_FILE
v PARTITIONING
v PRE_PARTITIONING
File type modifiers for the load utility

Table 48. Valid file type modifiers for the load utility: All file formats
Modifier
Description
anyorder
This modifier is used in conjunction with the cpu_parallelism parameter.

Specifies that the preservation of source data order is not required, yielding
significant additional performance benefit on SMP systems. If the value of
cpu_parallelism is 1, this option is ignored. This option is not supported if
SAVECOUNT > 0, since crash recovery after a consistency point requires that data be
loaded in sequence. This file type modifier is implicitly turned on for all load
operations into column-organized tables, multidimensional clustering (MDC)
tables, or range partitioned tables.
generatedignore
This modifier informs the load utility that data for all generated columns is
present in the data file but should be ignored. This results in all generated
column values being generated by the utility. This modifier cannot be used with
either the generatedmissing or the generatedoverride modifier.
121
Table 48. Valid file type modifiers for the load utility: All file formats (continued)
Modifier
Description
generatedmissing
data for the generated column (not even NULLs). This results in all generated
column values being generated by the utility. This modifier cannot be used with
either the generatedignore or the generatedoverride modifier.
generatedoverride
This modifier instructs the load utility to accept user-supplied data for all
generated columns in the table (contrary to the normal rules for these types of
columns). This is useful when migrating data from another database system, or
when loading a table from data that was recovered using the RECOVER DROPPED
TABLE option on the ROLLFORWARD DATABASE command. When this modifier is used,
any rows with no data or NULL data for a non-nullable generated column will be
rejected (SQL3116W). When this modifier is used, the table will be placed in Set
Integrity Pending state. To take the table out of Set Integrity Pending state
without verifying the user-supplied values, issue the following command after
the load operation:
SET INTEGRITY FOR table-name GENERATED COLUMN
IMMEDIATE UNCHECKED
To take the table out of Set Integrity Pending state and force verification of the
user-supplied values, issue the following command after the load operation:
SET INTEGRITY FOR table-name IMMEDIATE CHECKED.
When this modifier is specified and there is a generated column in any of the
partitioning keys, dimension keys or distribution keys, then the LOAD command
will automatically convert the modifier to generatedignore and proceed with the
load. This will have the effect of regenerating all of the generated column values.
This modifier cannot be used with either the generatedmissing or the
generatedignore modifier.
identityignore
This modifier informs the load utility that data for the identity column is present
in the data file but should be ignored. This results in all identity values being
generated by the utility. The behavior will be the same for both GENERATED
ALWAYS and GENERATED BY DEFAULT identity columns. This means that for
GENERATED ALWAYS columns, no rows will be rejected. This modifier cannot
be used with either the identitymissing or the identityoverride modifier.
identitymissing
data for the identity column (not even NULLs), and will therefore generate a
value for each row. The behavior will be the same for both GENERATED
ALWAYS and GENERATED BY DEFAULT identity columns. This modifier cannot
be used with either the identityignore or the identityoverride modifier.
identityoverride
This modifier should be used only when an identity column defined as

GENERATED ALWAYS is present in the table to be loaded. It instructs the utility
to accept explicit, non-NULL data for such a column (contrary to the normal rules
for these types of identity columns). This is useful when migrating data from
another database system when the table must be defined as GENERATED
ALWAYS, or when loading a table from data that was recovered using the
DROPPED TABLE RECOVERY option on the ROLLFORWARD DATABASE command. When
this modifier is used, any rows with no data or NULL data for the identity
column will be rejected (SQL3116W). This modifier cannot be used with either the
identitymissing or the identityignore modifier. The load utility will not attempt
to maintain or verify the uniqueness of values in the table's identity column when
this option is used.
122
Modifier
Description
If this modifier is specified, the utility assumes that the input data file contains
data for the implicitly hidden columns and this data will also be loaded. This
modifier cannot be used with the implicitlyhiddenmissing modifier. See the
Note: section for information about the precedence when multiple modifiers are
specified.
If this modifier is specified, the utility assumes that the input data file does not
contain data for the implicitly hidden columns and the utility will generate values
for those hidden columns. This modifier cannot be used with the
implicitlyhiddeninclude modifier. See the Note: section for information about
the precedence when multiple modifiers are specified.
indexfreespace=x
x is an integer between 0 and 99 inclusive. The value is interpreted as the

percentage of each index page that is to be left as free space when load rebuilds
the index. Load with INDEXING MODE INCREMENTAL ignores this option. The first
entry in a page is added without restriction; subsequent entries are added to
maintain the percent free space threshold. The default value is the one used at
CREATE INDEX time.
This value takes precedence over the PCTFREE value specified in the CREATE
INDEX statement. The indexfreespace option affects index leaf pages only.
lobsinfile
lob-path specifies the path to the files containing LOB data. The ASC, DEL, or IXF
load input files contain the names of the files having LOB data in the LOB
column.
This option is not supported in conjunction with the CURSOR filetype.
The LOBS FROM clause specifies where the LOB files are located when the
lobsinfile modifier is used. The LOBS FROM clause will implicitly activate the
lobsinfile behavior. The LOBS FROM clause conveys to the LOAD utility the list of
paths to search for the LOB files while loading the data.
filename.ext.nnn.mmm/, where filename.ext is the name of the file that contains
the LOB, nnn is the offset in bytes of the LOB within the file, and mmm is the
length of the LOB in bytes. For example, if the string db2exp.001.123.456/ is
stored in the data file, the LOB is located at offset 123 in the file db2exp.001, and
is 456 bytes long.
To indicate a null LOB , enter the size as -1. If the size is specified as 0, it is
name are ignored. For example, the LLS of a null LOB might be
db2exp.001.7.-1/.
noheader
Skips the header verification code (applicable only to load operations into tables
that reside in a single-partition database partition group).
If the default MPP load (mode PARTITION_AND_LOAD) is used against a table
residing in a single-partition database partition group, the file is not expected to
have a header. Thus the noheader modifier is not needed. If the LOAD_ONLY
mode is used, the file is expected to have a header. The only circumstance in
which you should need to use the noheader modifier is if you wanted to perform
LOAD_ONLY operation using a file that does not have a header.
norowwarnings
Suppresses all warnings about rejected rows.
123
Modifier
Description
pagefreespace=x
x is an integer between 0 and 100 inclusive. The value is interpreted as the

percentage of each data page that is to be left as free space. If the specified value
is invalid because of the minimum row size, (for example, a row that is at least
3 000 bytes long, and an x value of 50), the row will be placed on a new page. If
a value of 100 is specified, each row will reside on a new page. The PCTFREE
value of a table determines the amount of free space designated per page. If a
pagefreespace value on the load operation or a PCTFREE value on a table have
not been set, the utility will fill up as much space as possible on each page. The
value set by pagefreespace overrides the PCTFREE value specified for the table.
periodignore
This modifier informs the load utility that data for the period columns is present
in the data file but should be ignored. When this modifier is specified, all period
column values are generated by the utility. This modifier cannot be used with the
periodmissing modifier or the periodoverride modifier.
periodmissing
data for the period columns. When this modifier is specified, all period column
values are generated by the utility. This modifier cannot be used with the
periodignore modifier or the periodoverride modifier.
periodoverride
This modifier instructs the load utility to accept user-supplied data for
GENERATED ALWAYS AS ROW BEGIN and GENERATED ALWAYS AS ROW
END columns in a system-period temporal table. This behavior is contrary to the
normal rules for these types of columns. The modifier can be useful when you
want to maintain history data and load data that includes time stamps into a
system-period temporal table. When this modifier is used, any rows with no data
or NULL data in a ROW BEGIN or ROW END column are rejected.
rowchangetimestampignore
This modifier informs the load utility that data for the row change timestamp
column is present in the data file but should be ignored. This results in all ROW
CHANGE TIMESTAMPs being generated by the utility. The behavior will be the
same for both GENERATED ALWAYS and GENERATED BY DEFAULT columns.
This means that for GENERATED ALWAYS columns, no rows will be rejected.
This modifier cannot be used with either the rowchangetimestampmissing or the
rowchangetimestampoverride modifier.
rowchangetimestampmissing
data for the row change timestamp column (not even NULLs), and will therefore
generate a value for each row. The behavior will be the same for both
GENERATED ALWAYS and GENERATED BY DEFAULT columns. This modifier
cannot be used with either the rowchangetimestampignore or the
rowchangetimestampoverride modifier.
rowchangetimestampoverride
This modifier should be used only when a row change timestamp column
defined as GENERATED ALWAYS is present in the table to be loaded. It instructs
the utility to accept explicit, non-NULL data for such a column (contrary to the
normal rules for these types of row change timestamp columns). This is useful
when migrating data from another database system when the table must be
defined as GENERATED ALWAYS, or when loading a table from data that was
recovered using the DROPPED TABLE RECOVERY option on the ROLLFORWARD DATABASE
command. When this modifier is used, any rows with no data or NULL data for
the ROW CHANGE TIMESTAMP column will be rejected (SQL3116W). This
modifier cannot be used with either the rowchangetimestampmissing or the
rowchangetimestampignore modifier. The load utility will not attempt to maintain
or verify the uniqueness of values in the table's row change timestamp column
when this option is used.
124
Modifier
Description
seclabelchar
Indicates that security labels in the input source file are in the string format for
security label values rather than in the default encoded numeric format. LOAD
converts each security label into the internal format as it is loaded. If a string is
not in the proper format the row is not loaded and a warning (SQLSTATE 01H53,
SQLCODE SQL3242W) is returned. If the string does not represent a valid
security label that is part of the security policy protecting the table then the row
is not loaded and a warning (SQLSTATE 01H53, SQLCODE SQL3243W) is
returned.
This modifier cannot be specified if the seclabelname modifier is specified,
otherwise the load fails and an error (SQLCODE SQL3525N) is returned.
If you have a table consisting of a single DB2SECURITYLABEL column, the data file
might look like this:
"CONFIDENTIAL:ALPHA:G2"
"CONFIDENTIAL;SIGMA:G2"
"TOP SECRET:ALPHA:G2"
To load or import this data, the seclabelchar file type modifier must be used:
LOAD FROM input.del OF DEL MODIFIED BY SECLABELCHAR INSERT INTO t1
seclabelname
Indicates that security labels in the input source file are indicated by their name
rather than the default encoded numeric format. LOAD will convert the name to
the appropriate security label if it exists. If no security label exists with the
indicated name for the security policy protecting the table the row is not loaded
and a warning (SQLSTATE 01H53, SQLCODE SQL3244W) is returned.
This modifier cannot be specified if the seclabelchar modifier is specified,
otherwise the load fails and an error (SQLCODE SQL3525N) is returned.
If you have a table consisting of a single DB2SECURITYLABEL column, the data file
might consist of security label names similar to:
"LABEL1"
"LABEL1"
"LABEL2"
To load or import this data, the seclabelname file type modifier must be used:
LOAD FROM input.del OF DEL MODIFIED BY SECLABELNAME INSERT INTO t1
Note: If the file type is ASC, any spaces following the name of the security label
will be interpreted as being part of the name. To avoid this use the striptblanks
file type modifier to make sure the spaces are removed.
totalfreespace=x
x is an integer greater than or equal to 0. The value is interpreted as the

percentage of the total pages in the table that is to be appended to the end of the
table as free space. For example, if x is 20, and the table has 100 data pages after
the data has been loaded, 20 additional empty pages will be appended. The total
number of data pages for the table will be 120. The data pages total does not
factor in the number of index pages in the table. This option does not affect the
index object. If two loads are done with this option specified, the second load will
not reuse the extra space appended to the end by the first load.
transactionidignore
This modifier informs the load utility that data for the TRANSACTION START ID
column is present in the data file but should be ignored. When this modifier is
specified, the value for the TRANSACTION START ID column is generated by
the utility. This modifier cannot be used with the transactionidmissing modifier
or the transactionidoverride modifier.
125
Modifier
Description
transactionidmissing
data for the TRANSACTION START ID columns. When this modifier is specified,
the value for the TRANSACTION START ID column is generated by the utility.
This modifier cannot be used with the transactionidignore modifier or the
transactionidoverride modifier.
transactionidoverride
This modifier instructs the load utility to accept user-supplied data for the
GENERATED ALWAYS AS TRANSACTION START ID column in a system-period
temporal table. This behavior is contrary to the normal rules for this type of
column. When this modifier is used, any rows with no data or NULL data in a
TRANSACTION START ID column are rejected.
usedefaults
If a source column for a target table column has been specified, but it contains no
data for one or more row instances, default values are loaded. Examples of
missing data are:
v For DEL files: two adjacent column delimiters (",,") or two adjacent column
delimiters separated by an arbitrary number of spaces (", ,") are specified for a
column value.
v For DEL/ASC files: A row that does not have enough columns, or is not long
enough for the original specification. For ASC files, NULL column values are
not considered explicitly missing, and a default will not be substituted for
NULL column values. NULL column values are represented by all space
characters for numeric, date, time, and /timestamp columns, or by using the
NULL INDICATOR for a column of any type to indicate the column is NULL.
Without this option, if a source column contains no data for a row instance, one
v For DEL/ASC files: If the column is nullable, a NULL is loaded. If the column
is not nullable, the utility rejects the row.
Table 49. Valid file type modifiers for the load utility: ASCII file formats (ASC/DEL)
Modifier
Description
codepage=x
data in the input data set. Converts character data (and numeric data specified in
characters) from this code page to the database code page during the load
operation.
v For pure DBCS (graphic), mixed DBCS, and EUC, delimiters are restricted to
the range of x00 to x3F, inclusive.
v For DEL data specified in an EBCDIC code page, the delimiters might not
coincide with the shift-in and shift-out DBCS characters.
v nullindchar must specify symbols included in the standard ASCII set between
code points x20 and x7F, inclusive. This refers to ASCII symbols and code
points. EBCDIC data can use the corresponding symbols, even though the code
points will be different.
This option is not supported in conjunction with the CURSOR filetype.
126
Table 49. Valid file type modifiers for the load utility: ASCII file formats (ASC/DEL) (continued)
Modifier
Description
dateformat="x"
x is the format of the date in the source file.1 Valid date elements are:
YYYY - Year (four digits ranging from 0000 - 9999)
M
- Month (one or two digits ranging from 1 - 12)
MM
- Month (two digits ranging from 01 - 12;
mutually exclusive with M)
D
- Day (one or two digits ranging from 1 - 31)
DD
- Day (two digits ranging from 01 - 31;
mutually exclusive with D)
DDD - Day of the year (three digits ranging
from 001 - 366; mutually exclusive
examples of date formats are:
"D-M-YYYY"
"MM.DD.YYYY"
"YYYYDDD"
dumpfile = x
x is the fully qualified (according to the server database partition) name of an

exception file to which rejected rows are written. A maximum of 32 KB of data is
written per record. The following section is an example that shows how to specify
a dump file:
db2 load from data of del
modified by dumpfile = /u/user/filename
insert into table_name
The file will be created and owned by the instance owner. To override the default
file permissions, use the dumpfileaccessall file type modifier.
Note:
1. In a partitioned database environment, the path should be local to the loading
database partition, so that concurrently running load operations do not
attempt to write to the same file.
2. The contents of the file are written to disk in an asynchronous buffered mode.
In the event of a failed or an interrupted load operation, the number of
records committed to disk cannot be known with certainty, and consistency
cannot be guaranteed after a LOAD RESTART. The file can only be assumed to be
complete for a load operation that starts and completes in a single pass.
3. If the specified file already exists, it will not be re-created, but it will be
truncated.
dumpfileaccessall
Grants read access to 'OTHERS' when a dump file is created.

This file type modifier is only valid when:
1. it is used in conjunction with dumpfile file type modifier
2. the user has SELECT privilege on the load target table
3. it is issued on a DB2 server database partition that resides on a UNIX
operating system
If the specified file already exists, its permissions will not be changed.
fastparse
Use with caution. Reduces syntax checking on user-supplied column values, and
enhances performance. Tables are guaranteed to be architecturally correct (the
utility performs sufficient data checking to prevent a segmentation violation or
trap), however, the coherence of the data is not validated. Only use this option if
you are certain that your data is coherent and correct. For example, if the
user-supplied data contains an invalid timestamp column value of
:1>0-00-20-07.11.12.000000, this value is inserted into the table if fastparse is
specified, and rejected if fastparse is not specified.
127
Modifier
Description
implieddecimal
The location of an implied decimal point is determined by the column definition;

it is no longer assumed to be at the end of the value. For example, the value
12345 is loaded into a DECIMAL(8,2) column as 123.45, not 12345.00.
This modifier cannot be used with the packeddecimal modifier.
timeformat="x"
x is the format of the time in the source file.1 Valid time elements are:
H
- Hour (one or two digits ranging from 0 - 12

for a 12 hour system, and 0 - 24
for a 24 hour system)
HH
- Hour (two digits ranging from 00 - 12
for a 12 hour system, and 00 - 24
for a 24 hour system; mutually exclusive
with H)
M
- Minute (one or two digits ranging
from 0 - 59)
MM
- Minute (two digits ranging from 00 - 59;
mutually exclusive with M)
S
- Second (one or two digits ranging
from 0 - 59)
SS
- Second (two digits ranging from 00 - 59;
mutually exclusive with S)
SSSSS - Second of the day after midnight (5 digits
ranging from 00000 - 86400; mutually
exclusive with other time elements)
TT
- Meridian indicator (AM or PM)
examples of time formats are:
"HH:MM:SS"
"HH.MM TT"
"SSSSS"
128
Modifier
Description
timestampformat="x"
are:
YYYY
M
MM
- Year (four digits ranging from 0000 - 9999)

- Month (one or two digits ranging from 1 - 12)
- Month (two digits ranging from 01 - 12;
mutually exclusive with M and MMM)
MMM
- Month (three-letter case-insensitive abbreviation for
the month name; mutually exclusive with M and MM)
D
- Day (one or two digits ranging from 1 - 31)
DD
- Day (two digits ranging from 01 - 31; mutually exclusive with D)
DDD
- Day of the year (three digits ranging from 001 - 366;
mutually exclusive with other day or month elements)
H
- Hour (one or two digits ranging from 0 - 12
for a 12 hour system, and 0 - 24 for a 24 hour system)
HH
- Hour (two digits ranging from 00 - 12
for a 12 hour system, and 00 - 24 for a 24 hour system;
mutually exclusive with H)
M
- Minute (one or two digits ranging from 0 - 59)
MM
- Minute (two digits ranging from 00 - 59;
mutually exclusive with M, minute)
S
- Second (one or two digits ranging from 0 - 59)
SS
- Second (two digits ranging from 00 - 59;
mutually exclusive with S)
SSSSS - Second of the day after midnight (5 digits
ranging from 00000 - 86400; mutually
exclusive with other time elements)
U (1 to 12 times)
- Fractional seconds(number of occurrences of U represent the
number of digits with each digit ranging from 0 to 9
TT
- Meridian indicator (AM or PM)
timestampformat="x"
(Continued)
A default value of 1 is assigned for unspecified YYYY, M, MM, D, DD, or DDD

elements. A default value of 'Jan' is assigned to an unspecified MMM element. A
default value of 0 is assigned for all other unspecified elements. The following
section is an example of a time stamp format:
The valid values for the MMM element include: 'jan', 'feb', 'mar', 'apr', 'may', 'jun',
'jul', 'aug', 'sep', 'oct', 'nov' and 'dec'. These values are case insensitive.
If the timestampformat modifier is not specified, the load utility formats the
timestamp field using one of two possible formats:
YYYY-MM-DD-HH.MM.SS
YYYY-MM-DD HH:MM:SS
The load utility chooses the format by looking at the separator between the DD
and HH. If it is a dash '-', the load utility uses the regular dashes and dots format
(YYYY-MM-DD-HH.MM.SS). If it is a blank space, then the load utility expects a colon
':' to separate the HH, MM and SS.
In either format, if you include the microseconds field (UUUUUU), the load
utility expects the dot '.' as the separator. Either YYYY-MM-DD-HH.MM.SS.UUUUUU or
YYYY-MM-DD HH:MM:SS.UUUUUU are acceptable.
The following example illustrates how to load data containing user defined date
and time formats into a table called schedule:
insert into schedule
129
Modifier
Description
usegraphiccodepage
If usegraphiccodepage is given, the assumption is made that data being loaded

into graphic or double-byte character large object (DBCLOB) data field(s) is in the
graphic code page. The rest of the data is assumed to be in the character code
page. The graphic codepage is associated with the character code page. LOAD
determines the character code page through either the codepage modifier, if it is
specified, or through the code page of the database if the codepage modifier is not
specified.
This modifier should be used in conjunction with the delimited data file
generated by drop table recovery only if the table being recovered has graphic
data.
Restrictions
The usegraphiccodepage modifier MUST NOT be specified with DEL files created
by the EXPORT utility, as these files contain data encoded in only one code page.
The usegraphiccodepage modifier is also ignored by the double-byte character
large objects (DBCLOBs) in files.
xmlchar
Specifies that XML documents are encoded in the character code page.
This option is useful for processing XML documents that are encoded in the
specified character code page but do not contain an encoding declaration.
the encoding must match the character code page, otherwise the row containing
the document will be rejected. Note that the character codepage is the value
specified by the codepage file type modifier, or the application codepage if it is
not specified. By default, either the documents are encoded in Unicode, or they
contain a declaration tag with an encoding attribute.
xmlgraphic
Specifies that XML documents are encoded in the specified graphic code page.
This option is useful for processing XML documents that are encoded in a specific
graphic code page but do not contain an encoding declaration.
the encoding must match the graphic code page, otherwise the row containing
the document will be rejected. Note that the graphic code page is the graphic
component of the value specified by the codepage file type modifier, or the
graphic component of the application code page if it is not specified. By default,
documents are either encoded in Unicode, or they contain a declaration tag with
130
Table 50. Valid file type modifiers for the load utility: ASC file formats (Non-delimited ASCII)
Modifier
Description
binarynumerics
Numeric (but not DECIMAL) data must be in binary form, not the character
representation. This avoids costly conversions.
This option is supported only with positional ASC, using fixed length records
specified by the reclen option.
v No conversion between data types is performed, with the exception of BIGINT,
INTEGER, and SMALLINT.
v Data lengths must match their target column definitions.
v FLOATs must be in IEEE Floating Point format.
v Binary data in the load source file is assumed to be big-endian, regardless of
the platform on which the load operation is running.
NULLs cannot be present in the data for columns affected by this modifier.
Blanks (normally interpreted as NULL) are interpreted as a binary value when
this modifier is used.
nochecklengths
If nochecklengths is specified, an attempt is made to load each row, even if the

column. Such rows can be successfully loaded if code page conversion causes the
source data to shrink; for example, 4-byte EUC data in the source could shrink to
2-byte DBCS data in the target, and require half the space. This option is
particularly useful if it is known that the source data will fit in all cases despite
nullindchar=x
x is a single character. Changes the character denoting a NULL value to x. The

default value of x is Y.2
This modifier is case sensitive for EBCDIC data files, except when the character is
an English letter. For example, if the NULL indicator character is specified to be
the letter N, then n is also recognized as a NULL indicator.
packeddecimal
Loads packed-decimal data directly, since the binarynumerics modifier does not
include the DECIMAL field type.
This option is supported only with positional ASC, using fixed length records
specified by the reclen option.
Supported values for the sign nibble are:
+ = 0xC 0xA 0xE 0xF
- = 0xD 0xB
NULLs cannot be present in the data for columns affected by this modifier.
Blanks (normally interpreted as NULL) are interpreted as a binary value when
this modifier is used.
Regardless of the server platform, the byte order of binary data in the load source
file is assumed to be big-endian; that is, when using this modifier on Windows
operating systems, the byte order must not be reversed.
This modifier cannot be used with the implieddecimal modifier.
reclen=x
x is an integer with a maximum value of 32 767. x characters are read for each
row, and a newline character is not used to indicate the end of the row.
131
Table 50. Valid file type modifiers for the load utility: ASC file formats (Non-delimited ASCII) (continued)
Modifier
Description
striptblanks
Truncates any trailing blank spaces when loading data into a variable-length field.
If this option is not specified, blank spaces are kept.
This option cannot be specified together with striptnulls. These are mutually
exclusive options. This option replaces the obsolete t option, which is supported
for earlier compatibility only.
striptnulls
Truncates any trailing NULLs (0x00 characters) when loading data into a
variable-length field. If this option is not specified, NULLs are kept.
This option cannot be specified together with striptblanks. These are mutually
exclusive options. This option replaces the obsolete padwithzero option, which is
supported for earlier compatibility only.
zoneddecimal
Loads zoned decimal data, since the binarynumerics modifier does not include
the DECIMAL field type. This option is supported only with positional ASC,
using fixed length records specified by the reclen option.
Half-byte sign values can be one of the following value:
+ = 0xC 0xA 0xE 0xF 0x3
- = 0xD 0xB 0x7
Supported values for digits are 0x0 to 0x9.
Supported values for zones are 0x3 and 0xF.
Table 51. Valid file type modifiers for the load utility: DEL file formats (Delimited ASCII)
Modifier
Description
chardelx

mark (") as the character string delimiter, you should specify it as follows:
The single quotation mark (') can also be specified as a character string delimiter
as follows:
modified by chardel
coldelx
decplusblank
decptx
132
Table 51. Valid file type modifiers for the load utility: DEL file formats (Delimited ASCII) (continued)
Modifier
Description
delprioritychar
The current default priority for delimiters is: record delimiter, character delimiter,
column delimiter. This modifier protects existing applications that depend on the
older priority by reverting the delimiter priorities to: character delimiter, record
delimiter, column delimiter. Syntax:
db2 load ... modified by delprioritychar ...
For example, given the following DEL data file:
"Smith, Joshua",4000,34.98<row delimiter>
"Vincent,<row delimiter>, is a manager", ...
... 4005,44.37<row delimiter>
With the delprioritychar modifier specified, there will be only two rows in this
data file. The second <row delimiter> will be interpreted as part of the first data
column of the second row, while the first and the third <row delimiter> are
interpreted as actual record delimiters. If this modifier is not specified, there will
be three rows in this data file, each delimited by a <row delimiter>.
Preserves the leading and trailing blanks in each field of type CHAR, VARCHAR,
LONG VARCHAR, or CLOB. Without this option, all leading and trailing blanks
that are not inside character delimiters are removed, and a NULL is inserted into
the table for all blank fields.
keepblanks
The following example illustrates how to load data into a table called TABLE1,
while preserving all leading and trailing spaces in the data file:
modified by keepblanks
insert into table1
The load utility will assume all bytes found between the column delimiters to be
part of the column's data. Character delimiters will be parsed as part of column
data. This option should not be specified if the data was exported using a DB2
database system (unless nochardel was specified at export time). It is provided to
support vendor data files that do not have character delimiters. Improper usage
might result in data loss or corruption.
nochardel
This option cannot be specified with chardelx, delprioritychar or nodoubledel.

These are mutually exclusive options.
Suppresses recognition of double character delimiters.
nodoubledel
Table 52. Valid file type modifiers for the load utility: IXF file format
Modifier
Description
forcein
Directs the utility to accept data despite code page mismatches, and to suppress
translation between code pages.
Fixed length target fields are checked to verify that they are large enough for the
data. If nochecklengths is specified, no checking is done, and an attempt is made
to load each row.
If nochecklengths is specified, an attempt is made to load each row, even if the
column. Such rows can be successfully loaded if code page conversion causes the
source data to shrink; for example, 4-byte EUC data in the source could shrink to
2-byte DBCS data in the target, and require half the space. This option is
particularly useful if it is known that the source data will fit in all cases despite
nochecklengths
Note:
133
1. Double quotation marks around the date format string are mandatory. Field
separators cannot contain any of the following characters: a-z, A-Z, and 0-9.
The field separator should not be the same as the character delimiter or field
delimiter in the DEL file format. A field separator is optional if the start and
end positions of an element are unambiguous. Ambiguity can exist if
(depending on the modifier) elements such as D, H, M, or S are used, because
of the variable length of the entries.
For time stamp formats, care must be taken to avoid ambiguity between the
will fail.
"M:YYYY" (Month)
"S:M" (Minute)
Some characters, such as double quotation marks and back slashes, must be
preceded by an escape character (for example, \).
2. Character values provided for the chardel, coldel, or decpt file type modifiers
must be specified in the code page of the source data.
The character code point (instead of the character symbol), can be specified
using the syntax xJJ or 0xJJ, where JJ is the hexadecimal representation of the
code point. For example, to specify the # character as a column delimiter, use
one of the following statements:
... modified by coldel# ...
... modified by coldel0x23 ...
... modified by coldelX23 ...
4. The load utility does not issue a warning if an attempt is made to use
load operation fails, and an error code is returned.
5. When multiple modifiers suffixed with ignore, include, missing, and override
are specified, they are applied in the order that they are listed. In the following
statement, data for implicitly hidden columns that are not identity columns is
included in the input data. While data for all identity columns, regardless of
their implicitly hidden status, is not.
db2 load from delfile1 of del modified by
However, changing the order of the file type modifiers in the following
statement means that data for all implicitly hidden columns (including hidden
identity columns) is included in the input data. While data for identity columns
that are not implicitly hidden is not.
db2 load from delfile1 of del modified by
identitymissing implicitlyhiddeninclude insert into table1
134
Table 53. LOAD behavior when using codepage and usegraphiccodepage

codepage=N
usegraphiccodepage
LOAD behavior
Absent
Absent
All data in the file is assumed to be in the database code

page, not the application code page, even if the CLIENT
option is specified.
Present
Absent
All data in the file is assumed to be in code page N.

Warning: Graphic data will be corrupted when loaded
into the database if N is a single-byte code page.
Absent
Present
Character data in the file is assumed to be in the

database code page, even if the CLIENT option is
specified. Graphic data is assumed to be in the code
page of the database graphic data, even if the CLIENT
option is specified.
If the database code page is single-byte, then all data is
assumed to be in the database code page.
into a single-byte database.
Present
Present
Character data is assumed to be in code page N. Graphic

data is assumed to be in the graphic code page of N.
If N is a single-byte or double-byte code page, then all
data is assumed to be in code page N.
into the database if N is a single-byte code page.
PRUNE HISTORY/LOGFILE command using the ADMIN_CMD procedure:

Used to delete entries from the recovery history file or to delete log files from the
active log file path of the currently connected database partition. Deleting entries
from the recovery history file might be necessary if the file becomes excessively
large and the retention period is high.
In a partitioned environment, the PRUNE HISTORY command only performs on the
database partition it is issued on. To prune the history on multiple partitions, you
can either issue the PRUNE HISTORY command from each individual database
partition, or use the db2_all prefix to run the PRUNE HISTORY command on all
database partitions.
Important: The PRUNE LOGFILE command is deprecated and might be removed in a
future release. Use the PRUNE HISTORY command instead.
Authorization
v SYSADM
v SYSCTRL
v SYSMAINT
v DBADM
135
Required connection
Database
Command syntax
PRUNE
HISTORY timestamp
LOGFILE PRIOR TO

WITH FORCE OPTION
log-file-name
AND DELETE
Command parameters
HISTORY timestamp
Identifies a range of entries in the recovery history file that will be deleted.
A complete time stamp (in the form yyyymmddhhmmss), or an initial prefix
(minimum yyyy) can be specified. All entries with time stamps equal to or
less than the time stamp provided are deleted from the recovery history
file. When an initial prefix is specified, the unspecified components of the
time stamp are interpreted as yyyy0101000000.
WITH FORCE OPTION
Specifies that the entries will be pruned according to the time stamp
specified, even if some entries from the most recent restore set are deleted
from the file. A restore set is the most recent full database backup
including any restores of that backup image. If this parameter is not
specified, all entries from the backup image forward will be maintained in
the history.
AND DELETE
Specifies that the associated log archives will be physically deleted (based
on the location information) when the history file entry is removed. This
option is especially useful for ensuring that archive storage space is
recovered when log archives are no longer needed. If you are archiving
logs via a user exit program, the logs cannot be deleted using this option.
If you set the auto_del_rec_obj database configuration parameter to ON,
calling PRUNE HISTORY with the AND DELETE parameter will also physically
delete backup images and load copy images if their history file entry is
pruned.
LOGFILE PRIOR TO log-file-name
Specifies a string for a log file name, for example S0000100.LOG. All log
files before (but not including) the specified log file will be deleted. The
logarchmeth1 database configuration parameter must be set to a value
other than OFF.
Note: This value is not supported in DB2 pureScale environments.
Example
Example 1: Remove all entries from the recovery history file that were written on or
before December 31, 2003:
CALL SYSPROC.ADMIN_CMD (prune history 20031231)
Example 2: Delete all log files from the active log file path before (but not
including) S0000100.LOG:
CALL SYSPROC.ADMIN_CMD(prune logfile prior to S0000100.LOG)
136
Usage notes
If the WITH FORCE OPTION is used, you might delete entries that are required for
automatic restoration of databases. Manual restores will still work correctly. Use of
this command can also prevent the db2ckrst utility from being able to correctly
analyze the complete chain of required backup images. Using the PRUNE HISTORY
command without the WITH FORCE OPTION prevents required entries from being
deleted.
Those entries with status DB2HISTORY_STATUS_DO_NOT_DELETE will not be
pruned. If the WITH FORCE OPTION is used, then objects marked as
DB2HISTORY_STATUS_DO_NOT_DELETE will still be pruned or deleted. You can
set the status of recovery history file entries to
DB2HISTORY_STATUS_DO_NOT_DELETE using the UPDATE HISTORY command,
the ADMIN_CMD with UPDATE_HISTORY, or the db2HistoryUpdate API. You can
use the DB2HISTORY_STATUS_DO_NOT_DELETE status to prevent key recovery
history file entries from being pruned and to prevent associated recovery objects
from being deleted.
You can prune snapshot backup database history file entries using the PRUNE
HISTORY command, but you cannot delete the related physical recovery objects
using the AND DELETE parameter. The only way to delete snapshot backup object is
to use the db2acsutil command.
The command affects only the database partition to which the application is
currently connected.
QUIESCE DATABASE command using the ADMIN_CMD procedure:
Forces all users off the specified database and puts it into a quiesced mode.
While the database is in quiesced mode, you can perform administrative tasks on
it. After administrative tasks are complete, use the UNQUIESCE command to activate
the database and allow other users to connect to the database without having to
shut down and perform another database start.
In this mode, only users with authority in this restricted mode are allowed to
connect to the database. Users with SYSADM and DBADM authority always have
access to a database while it is quiesced.
Scope
QUIESCE DATABASE results in all objects in the database being in the quiesced mode.
Only the allowed user or group and SYSADM, SYSMAINT, DBADM, or SYSCTRL
will be able to access the database or its objects.
If a database is in the SUSPEND_WRITE state, it cannot be put in quiesced mode.
Authorization
For database level quiesce:
v SYSADM
v DBADM
137
Required connection
Database
Command syntax
QUIESCE
DATABASE
DB
IMMEDIATE
DEFER

WITH TIMEOUT
minutes
FORCE CONNECTIONS
Command parameters
DEFER
Wait for applications until they commit the current unit of work.
WITH TIMEOUT minutes
Specifies a time, in minutes, to wait for applications to commit the
current unit of work. If no value is specified, in a single-partition
database environment, the default value is 10 minutes. In a
partitioned database environment the value specified by the
start_stop_time database manager configuration parameter will be
used.
IMMEDIATE
Do not wait for the transactions to be committed, immediately roll back the
transactions.
FORCE CONNECTIONS
Force the connections off.
DATABASE
Quiesce the database. All objects in the database will be placed in quiesced
mode. Only specified users in specified groups and users with SYSADM,
SYSMAINT, and SYSCTRL authority will be able to access to the database
or its objects.
Example
Force off all users with connections to the database.
CALL SYSPROC.ADMIN_CMD( quiesce db immediate )
v This command will force all users off the database if the FORCE CONNECTIONS
option is supplied. FORCE CONNECTIONS is the default behavior; the parameter is
allowed in the command for compatibility reasons.
v The command will be synchronized with the FORCE CONNECTIONS and will only
complete once the FORCE CONNECTIONS has completed.
Usage notes
v After QUIESCE DATABASE, users with SYSADM, SYSMAINT, SYSCTRL, or
DBADM authority, and GRANT or REVOKE privileges can designate who will
be able to connect. This information will be stored permanently in the database
catalog tables.
For example,
grant quiesce_connect on database to username/groupname
revoke quiesce_connect on database from username/groupname
138
statement.
v In a DB2 pureScale environment, after quiescing a database and restarting the
instance, the database will remain quiesced across all members. An explicit
UNQUIESCE DATABASE command is required to remove the quiesce state.
QUIESCE TABLESPACES FOR TABLE command using the ADMIN_CMD
procedure:
Quiesces table spaces for a table. There are three valid quiesce modes: share, intent
to update, and exclusive.
There are three possible states resulting from the quiesce function:
v Quiesced: SHARE
v Quiesced: UPDATE
v Quiesced: EXCLUSIVE
Scope
In a single-partition environment, this command quiesces all table spaces involved
in a load operation in exclusive mode for the duration of the load operation. In a
partitioned database environment, this command acts locally on a database
partition. It quiesces only that portion of table spaces belonging to the database
partition on which the load operation is performed. For partitioned tables, all of
the table spaces listed in SYSDATAPARTITIONS.TBSPACEID and
SYSDATAPARTITIONS.LONG_TBSPACEID associated with a table and with a
status of normal, attached or detached, (for example,
SYSDATAPARTITIONS.STATUS of '"', 'A' or 'D') are quiesced.
Authorization
v SYSADM
v SYSCTRL
v SYSMAINT
v DBADM
v LOAD
Required connection
Database
Command syntax
QUIESCE TABLESPACES FOR TABLE
tablename
schema.tablename
SHARE
INTENT TO UPDATE
EXCLUSIVE
RESET
Command parameters
TABLE
139
tablename
Specifies the unqualified table name. The table cannot be a system
catalog table.
schema.tablename
Specifies the qualified table name. If schema is not provided, the
CURRENT SCHEMA will be used. The table cannot be a system
catalog table.
SHARE
Specifies that the quiesce is to be in share mode.

When a "quiesce share" request is made, the transaction requests intent
share locks for the table spaces and a share lock for the table. When the
transaction obtains the locks, the state of the table spaces is changed to
QUIESCED SHARE. The state is granted to the quiescer only if there is no
conflicting state held by other users. The state of the table spaces, along
with the authorization ID and the database agent ID of the quiescer, are
recorded in the table space table, so that the state is persistent. The table
cannot be changed while the table spaces for the table are in QUIESCED
SHARE state. Other share mode requests to the table and table spaces are
allowed. When the transaction commits or rolls back, the locks are
released, but the table spaces for the table remain in QUIESCED SHARE
state until the state is explicitly reset.
INTENT TO UPDATE
Specifies that the quiesce is to be in intent to update mode.
When a "quiesce intent to update" request is made, the table spaces are
locked in intent exclusive (IX) mode, and the table is locked in update (U)
mode. The state of the table spaces is recorded in the table space table.
EXCLUSIVE
Specifies that the quiesce is to be in exclusive mode.
When a "quiesce exclusive" request is made, the transaction requests super
exclusive locks on the table spaces, and a super exclusive lock on the table.
When the transaction obtains the locks, the state of the table spaces
changes to QUIESCED EXCLUSIVE. The state of the table spaces, along
with the authorization ID and the database agent ID of the quiescer, are
recorded in the table space table. Since the table spaces are held in super
exclusive mode, no other access to the table spaces is allowed. The user
who invokes the quiesce function (the quiescer) has exclusive access to the
table and the table spaces.
RESET
Specifies that the state of the table spaces is to be reset to normal. A

quiesce state cannot be reset if the connection that issued the quiesce
request is still active.
When a quiescer issues a reset, only the quiesce mode for that quiescer is
reset. If there are multiple quiescers, then the state of the table space will
appear unchanged.
When working with a system-period temporal table and its associated
history table, the reset operation must be performed on the same table that
was used to originally set the quiesce mode.
Example
Quiesce the table spaces containing the staff table.
CALL SYSPROC.ADMIN_CMD( quiesce tablespaces for table staff share )
140
Usage notes
This command is not supported in DB2 pureScale environments.
A quiesce is a persistent lock. Its benefit is that it persists across transaction
failures, connection failures, and even across system failures (such as power failure,
or reboot).
A quiesce is owned by a connection. If the connection is lost, the quiesce remains,
but it has no owner, and is called a phantom quiesce. For example, if a power outage
caused a load operation to be interrupted during the delete phase, the table spaces
for the loaded table would be left in quiesce exclusive state. Upon database restart,
this quiesce would be an unowned (or phantom) quiesce. The removal of a
phantom quiesce requires a connection with the same user ID used when the
quiesce mode was set.
To remove a phantom quiesce:
1. Connect to the database with the same user ID used when the quiesce mode
was set.
2. Use the LIST TABLESPACES command to determine which table space is
quiesced.
3. Re-quiesce the table space using the current quiesce state. For example:
CALL SYSPROC.ADMIN_CMD(quiesce tablespaces for table mytable exclusive )
Once completed, the new connection owns the quiesce, and the load operation can
be restarted.
There is a limit of five quiescers on a table space at any given time.
A quiescer can alter the state of a table space from a less restrictive state to a more
restrictive one (for example, S to U, or U to X). If a user requests a state lower than
one that is already held, the original state is returned. States are not downgraded.
statement.
When quiescing against a system-period temporal table, all the tables paces
associated with the system-period temporal table and the history table are
quiesced. When quiescing against a history table, all the tables paces associated
with the history table, and the associated system-period temporal table are
quiesced.
REDISTRIBUTE DATABASE PARTITION GROUP command using the
ADMIN_CMD procedure:
Redistributes data across the partitions in a database partition group. This
command affects all objects present in the database partition group and cannot be
restricted to one object alone.
Scope
This command affects all database partitions in the database partition group.
141
Authorization
One of the following authorities is required:
v SYSADM
v SYSCTRL
v DBADM
In addition, one of the following groups of authorizations is also required:
v DELETE, INSERT, and SELECT privileges on all tables in the database partition
group being redistributed
Required connection
Connection to the catalog partition.
Command syntax
REDISTRIBUTE DATABASE PARTITION GROUP db-partition-group
Action
NOT ROLLFORWARD RECOVERABLE
Action
Not rollforward recoverable options
*
* *
,
ONLY
TABLE ( table-name
EXCLUDE ( table-name
FIRST
*
*
STOP AT local-isotime
Action:
UNIFORM
Add/Drop DB partition
USING DISTFILE distfilename
USING TARGETMAP targetmapfilename
CONTINUE
ABORT
Add/Drop DB partition:

,
ADD
DBPARTITIONNUM
DBPARTITIONNUMS
n
)
TO
TO

,
DROP
142
DBPARTITIONNUM
DBPARTITIONNUMS
n
Not rollforward recoverable options:

INDEXING MODE REBUILD
*
*
DATA BUFFER n
INDEXING MODE DEFERRED
QUIESCE DATABASE YES

*
*
PRECHECK NO
PRECHECK ONLY

*
QUIESCE DATABASE NO
PRECHECK YES
*
*
STATISTICS NONE
Command parameters
DATABASE PARTITION GROUP db-partition-group
The name of the database partition group. This one-part name identifies a
database partition group described in the SYSCAT.DBPARTITIONGROUPS
catalog table. The database partition group cannot currently be undergoing
redistribution.
Note: Tables in the IBMCATGROUP and the IBMTEMPGROUP database
partition groups cannot be redistributed.
When this option is used, the REDISTRIBUTE DATABASE PARTITION GROUP
command is not rollforward recoverable.
v Data is moved in bulk instead of by internal insert and delete operations.
This reduces the number of times that a table must be scanned and accessed,
which results in better performance.
v Log records are no longer required for each of the insert and delete
operations. This means that you no longer need to manage large amounts of
active log space and log archiving space in your system when performing
data redistribution.
v When using the REDISTRIBUTE DATABASE PARTITION GROUP command with the
NOT ROLLFORWARD RECOVERABLE option, the redistribute operation uses the
INDEXING MODE DEFERRED option for tables that contain XML columns. If a
table does not contain an XML column, the redistribute operation uses the
indexing mode specified when issuing the command.
When this option is not used, extensive logging of all row movement is
performed such that the database can be recovered later in the event of any
interruptions, errors, or other business need.
UNIFORM
Specifies that the data is uniformly distributed across hash partitions (that is,
every hash partition is assumed to have the same number of rows), but the
same number of hash partitions do not map to each database partition. After
redistribution, all database partitions in the database partition group have
approximately the same number of hash partitions.
USING DISTFILE distfilename
If the distribution of distribution key values is skewed, use this option to
achieve a uniform redistribution of data across the database partitions of a
Use the distfilename to indicate the current distribution of data across the
32 768 hash partitions.
Use row counts, byte volumes, or any other measure to indicate the amount of
data represented by each hash partition. The utility reads the integer value
143
associated with a partition as the weight of that partition. When a distfilename

is specified, the utility generates a target distribution map that it uses to
redistribute the data across the database partitions in the database partition
group as uniformly as possible. After the redistribution, the weight of each
database partition in the database partition group is approximately the same
(the weight of a database partition is the sum of the weights of all hash
partitions that map to that database partition).
For example, the input distribution file might contain entries as follows:
10223
1345
112000
0
100
...
In the example, hash partition 2 has a weight of 112000, and partition 3 (with a
weight of 0) has no data mapping to it at all.
The distfilename should contain 32 768 positive integer values in character
format. The sum of the values should be less than or equal to 4 294 967 295.
The complete path name for distfilename must be included and distfilename must
exist on the server and be accessible from the connected partition.
USING TARGETMAP targetmapfilename
The file specified in targetmapfilename is used as the target distribution map.
Data redistribution is done according to this file. The complete path name for
targetmapfilename must be included and targetmapfilename must exist on the
server and be accessible from the connected partition.
The targetmapfilename should contain 32 768 integers, each representing a valid
database partition number. The number on any row maps a hash value to a
database partition. This means that if row X contains value Y, then every
record with HASHEDVALUE() of X is to be located on database partition Y.
If a database partition, included in the target map, is not in the database
partition group, an error is returned. Issue ALTER DATABASE PARTITION
GROUP ADD DBPARTITIONNUM statement before running REDISTRIBUTE
DATABASE PARTITION GROUP command.
If a database partition, excluded from the target map, is in the database
partition group, that database partition will not be included in the partitioning.
Such a database partition can be dropped using ALTER DATABASE
PARTITION GROUP DROP DBPARTITIONNUM statement either before or
after the REDISTRIBUTE DATABASE PARTITION GROUP command.
CONTINUE
Continues a previously failed or stopped REDISTRIBUTE DATABASE PARTITION
GROUP operation. If none occurred, an error is returned.
ABORT
Aborts a previously failed or stopped REDISTRIBUTE DATABASE PARTITION GROUP
operation. If none occurred, an error is returned.
ADD
DBPARTITIONNUM n
TO m
n or n TO m specifies a list or lists of database partition numbers which are
to be added into the database partition group. Any specified partition must
144
not already be defined in the database partition group (SQLSTATE 42728).

This is equivalent to executing the ALTER DATABASE PARTITION
GROUP statement with ADD DBPARTITIONNUM clause specified.
DBPARTITIONNUMS n
TO m
to be added into the database partition group. Any specified partition must
not already be defined in the database partition group (SQLSTATE 42728).
This is equivalent to executing the ALTER DATABASE PARTITION
GROUP statement with ADD DBPARTITIONNUM clause specified.
Note:
1. When a database partition is added using this option, containers for
table spaces are based on the containers of the corresponding table
space on the lowest numbered existing partition in the database
partition group. If this would result in a naming conflict among
containers, which could happen if the new partitions are on the same
physical machine as existing containers, this option should not be used.
Instead, the ALTER DATABASE PARTITION GROUP statement should
be used with the WITHOUT TABLESPACES option before issuing the
REDISTRIBUTE DATABASE PARTITION GROUP command. Table space
containers can then be created manually specifying appropriate names.
2. Data redistribution might create table spaces for all new database
partitions if the ADD DBPARTITIONNUMS parameter is specified.
DROP
DBPARTITIONNUM n
TO m
to be dropped from the database partition group. Any specified partition
must already be defined in the database partition group (SQLSTATE
42729). This is equivalent to executing the ALTER DATABASE PARTITION
GROUP statement with the DROP DBPARTITIONNUM clause specified.
DBPARTITIONNUMS n
TO m
to be dropped from the database partition group. Any specified partition
must already be defined in the database partition group (SQLSTATE
42729). This is equivalent to executing the ALTER DATABASE PARTITION
GROUP statement with the DROP DBPARTITIONNUM clause specified.
TABLE tablename
Specifies a table order for redistribution processing.
ONLY
If the table order is followed by the ONLY keyword (which is the default),
then, only the specified tables will be redistributed. The remaining tables
can be later processed by REDISTRIBUTE CONTINUE commands. This is the
default.
145
FIRST
If the table order is followed by the FIRST keyword, then, the specified
tables will be redistributed with the given order and the remaining tables
in the database partition group will be redistributed with random order.
EXCLUDE tablename
Specifies tables to omit from redistribution processing. For example, you can
temporarily omit a table until you can configure it to meet the requirements for
data redistribution. The omitted tables can be later processed by REDISTRIBUTE
CONTINUE commands.
STOP AT local-isotime
When this option is specified, before beginning data redistribution for each
table, the local-isotime is compared with the current local timestamp. If the
specified local-isotime is equal to or earlier than the current local timestamp, the
utility stops with a warning message. Data redistribution processing of tables
in progress at the stop time will complete without interruption. No new data
redistribution processing of tables begins. The unprocessed tables can be
redistributed using the CONTINUE option. This local-isotime value is specified as a
time stamp, a 7-part character string that identifies a combined date and time.
The format is yyyy-mm-dd-hh.mm.ss.nnnnnn (year, month, day, hour, minutes,
seconds, microseconds) expressed in local time.
DATA BUFFER n
Specifies the number of 4 KB pages to use as buffered space for transferring
data within the utility. This command parameter can be used only when the
NOT ROLLFORWARD RECOVERABLE parameter is also specified.
If the value specified is lower than the minimum supported value, the
minimum value is used and no warning is returned. If a DATA BUFFER value is
not specified, an intelligent default is calculated by the utility at runtime at the
beginning of processing each table. Specifically, the default is to use 50% of the
memory available in the utility heap at the time redistribution of the table
begins and to take into account various table properties as well.
This memory is allocated directly from the utility heap, whose size can be
modified through the util_heap_sz database configuration parameter. The
value of the DATA BUFFER parameter of the REDISTRIBUTE DATABASE PARTITION
GROUP command can temporarily exceed util_heap_sz if more memory is
available in the system.
INDEXING MODE
Specifies how indexes are maintained during redistribution. This command
parameter can be used only when the NOT ROLLFORWARD RECOVERABLE parameter
is also specified.
Valid values are:
REBUILD
Indexes will be rebuilt from scratch. Indexes do not have to be valid to use
this option. As a result of using this option, index pages will be clustered
together on disk.
DEFERRED
Redistribute will not attempt to maintain any indexes. Indexes will be
marked as needing a refresh. The first access to such indexes might force a
rebuild, or indexes might be rebuilt when the database is restarted.
Note: For non-MDC and non-ITC tables, if there are invalid indexes on the
tables, the REDISTRIBUTE DATABASE PARTITION GROUP command
146
automatically rebuilds them if you do not specify INDEXING MODE DEFERRED.

For an MDC or ITC table, even if you specify INDEXING MODE DEFERRED, a
composite index that is invalid is rebuilt before table redistribution begins
because the utility needs the composite index to process an MDC or ITC
table.
PRECHECK
Verifies that the database partition group can be redistributed. This command
parameter can be used only when the NOT ROLLFORWARD RECOVERABLE parameter
is also specified.
YES
This is the default value. The redistribution operation begins only if the
verification completes successfully. If the verification fails, the command
terminates and returns an error message related to the first check that
failed.
NO The redistribution operation begins immediately; no verification occurs.
ONLY
The command terminates after performing the verification; no
redistribution occurs. By default it will not quiesce the database. If the
QUIESCE DATABASE command parameter was set to YES or defaulted to a
value of YES, the database remains quiesced. To restore connectivity to the
database, perform the redistribution operation or issue UNQUIESCE DATABASE
command.
QUIESCE DATABASE
Specifies to force all users off the database and put it into a quiesced mode.
This command parameter can be used only when the NOT ROLLFORWARD
RECOVERABLE parameter is also specified.
YES
This is the default value. Only users with SYSADM, SYSMAINT, or
SYSCTRL authority or users who have been granted QUIESCE_CONNECT
authority will be able to access the database or its objects. Once the
redistribution completes successfully, the database is unquiesced.
NO The redistribution operation does not quiesce the database; no users are
forced off the database.
For more information, refer to the QUIESCE DATABASE command.
STATISTICS
Specifies that the utility should collect statistics for the tables that have a
statistics profile. This command parameter can be used only when the NOT
ROLLFORWARD RECOVERABLE parameter is also specified.
Specifying this option is more efficient than separately issuing the RUNSTATS
command after the data redistribution is completed.
USE PROFILE
Statistics will be collected for the tables with a statistics profile. For tables
without a statistics profile, nothing will be done. This is the default.
NONE
Statistics will not be collected for tables.
147
Examples
Redistribute database partition group DBPG_1 by providing the current data
distribution through a data distribution file, distfile_for_dbpg_1. Move the data
onto two new database partitions, 6 and 7.
CALL SYSPROC.ADMIN_CMD(REDISTRIBUTE DATABASE PARTITION GROUP DBPG_1
USING DISTFILE /home/user1/data/distfile_for_dbpg_1
ADD DATABASE PARTITION (6 TO 7) )
Redistribute database partition group DBPG_2 such that:

v The redistribution is not rollforward recoverable;
v Data is uniformly distributed across hash partitions;
v Indexes are rebuilt from scratch;
v Statistics are not collected;
v 180,000 4 KB pages are used as buffered space for transferring the data.
CALL SYSPROC.ADMIN_CMD(REDISTRIBUTE DATABASE PARTITION GROUP DBPG_2
UNIFORM
INDEXING MODE REBUILD
DATA BUFFER 180000
STATISTICS NONE)
This redistribution operation also quiesces the database and performs a precheck
due to the default values for the QUIESCE DATABASE and PRECHECK command
parameters.
Usage notes
v Before starting a redistribute operation, ensure that the tables are in normal state
and not in "load pending" state or "reorg pending" state. Table states can be
checked by using the LOAD QUERY command.
v When the NOT ROLLFORWARD RECOVERABLE option is specified and the database is a
recoverable database, the first time the utility accesses a table space, it is put into
the BACKUP PENDING state. All the tables in that table space will become
read-only until the table space is backed-up, which can only be done when all
tables in the table space have finished being redistributed.
v When a redistribution operation is running, it produces an event log file
containing general information about the redistribution operation and
information such as the starting and ending time of each table processed. This
event log file is written to the server:
The homeinst/sqllib/redist directory on Linux and UNIX operating systems,
using the following format for subdirectories and file name:
database-name.database-partition-group-name.timestamp.log.
The DB2INSTPROF\instance\redist directory on Windows operating systems
(where DB2INSTPROF is the value of the DB2INSTPROF registry variable), using
the following format for subdirectories and file name: databasename.database-partition-group-name.timestamp.log.
The time stamp value is the time when the command was issued.
v This utility performs intermittent COMMITs during processing. This can cause
type 2 connections to receive an SQL30090N error.
v All packages having a dependency on a table that has undergone redistribution
are invalidated. It is recommended to explicitly rebind such packages after the
redistribute database partition group operation has completed. Explicit rebinding
148
eliminates the initial delay in the execution of the first SQL request for the
invalid package. The redistribute message file contains a list of all the tables that
have undergone redistribution.
v By default, the redistribute utility will update the statistics for those tables that
have a statistics profile. For the tables without a statistics profile, it is
recommended that you separately update the table and index statistics for these
tables by calling the db2Runstats API or by issuing the RUNSTATS command after
the redistribute operation has completed.
v Database partition groups containing replicated materialized query tables or
tables defined with DATA CAPTURE CHANGES cannot be redistributed.
v Redistribution is not allowed if there are user temporary table spaces with
existing declared temporary tables or created temporary tables in the database
partition group.
v Options such as INDEXING MODE are ignored on tables, on which they do not
apply, without warning. For example, INDEXING MODE will be ignored on tables
without indexes.
statement.
v The file referenced in USING DISTFILE distfilename or USING TARGETMAP
targetmapfilename, must refer to a file on the server.
v The REDISTRIBUTE DATABASE PARTITION GROUP command might fail (SQLSTATE
55071) if an add database partition server request is either pending or in
progress. This command might also fail (SQLSTATE 55077) if a new database
partition server is added online to the instance and not all applications are
aware of the new database partition server.
Compatibilities
Tables containing XML columns that use the DB2 Version 9.5 or earlier XML record
format cannot be redistributed. Use the ADMIN_MOVE_TABLE stored procedure
to migrate the table to the new format.
REORG INDEXES/TABLE command using the ADMIN_CMD procedure:
Reorganizes an index or a table.
You can reorganize all indexes defined on a table by rebuilding the index data into
unfragmented, physically contiguous pages. On a data partitioned table, you can
reorganize a specific nonpartitioned index on a partitioned table, or you can
reorganize all the partitioned indexes on a specific data partition.
If you specify the CLEANUP option of the index clause, cleanup is performed without
rebuilding the indexes. This command cannot be used against indexes on declared
temporary tables or created temporary tables (SQLSTATE 42995).
The table option reorganizes a table by reconstructing the rows to eliminate
fragmented data, and by compacting information. On a partitioned table, you can
reorganize a single partition.
Scope
This command affects all database partitions in the database partition group.
149
Authorization
v
v
v
v
v
v
SYSADM
SYSCTRL
SYSMAINT
DBADM
SQLADM
CONTROL privilege on the table.
Required connection
Database
Command syntax
REORG
INDEXES ALL FOR TABLE table-name

INDEX index-name
FOR TABLE table-name
TABLE table-name
Table clause
Index clause

Table partitioning clause
Database partition clause
Index clause:
REBUILD
ALLOW NO ACCESS
ALLOW WRITE ACCESS
ALLOW READ ACCESS
space-reclaim-options
space-reclaim-options:
ALL
RECLAIM EXTENTS
CLEANUP
PAGES
Table clause:
CLASSIC
classic-options
inplace-options
STOP
PAUSE
ALLOW WRITE ACCESS
RECLAIM EXTENTS
ALLOW READ ACCESS
ALLOW NO ACCESS
INPLACE
150
classic-options:

ALLOW NO ACCESS
ALLOW READ ACCESS
USE
tbspace-name
INDEX
index-name

INDEXSCAN
LONGLOBDATA
USE
longtbspace-name
KEEPDICTIONARY

RESETDICTIONARY
inplace-options:
ALLOW WRITE ACCESS

ALLOW READ ACCESS
FULL
TRUNCATE TABLE
START
NOTRUNCATE TABLE
RESUME

INDEX index-name
CLEANUP OVERFLOWS
Table partitioning clause:

ON DATA PARTITION partition-name
Database partition clause:

ON
DBPARTITIONNUM
DBPARTITIONNUMS
ALL DBPARTITIONNUMS
Partition selection clause
EXCEPT
DBPARTITIONNUM
DBPARTITIONNUMS
Partition selection clause
Partition selection clause:

,
(
)
TO
Command parameters
INDEXES ALL FOR TABLE table-name
Specifies the table whose indexes are to be reorganized. The table can be in
a local or a remote database.
INDEX index-name
Specifies an individual index to be reorganized on a data partitioned table.
151
Reorganization of individual indexes are only supported for nonpartitioned

indexes on a partitioned table. This parameter is not supported for block
indexes.
FOR TABLE table-name
Specifies the name of the table on which the nonpartitioned index
index-name is created. This parameter is optional, given that index names
are unique across the database.
ALLOW NO ACCESS
For REORG INDEXES, specifies that no other users can access the
table while the indexes are being reorganized. If the ON DATA
PARTITION clause is specified for a partitioned table, only the
specified partition is restricted to the access mode level.
For REORG INDEX, specifies that no other users can access the table
while the nonpartitioned index is being reorganized.
ALLOW READ ACCESS
For REORG INDEXES, specifies that other users can have read-only
access to the table while the indexes are being reorganized. ALLOW
READ ACCESS mode is not supported for REORG INDEXES of a
partitioned table unless the CLEANUP or RECLAIM EXTENTS option or
the ON DATA PARTITION clause is specified. If the ON DATA PARTITION
clause is specified for a partitioned table, only the specified
partition is restricted to the access mode level.
For REORG INDEX, specifies that can have read-only access to the
table while the nonpartitioned index is being reorganized.
ALLOW WRITE ACCESS
For REORG INDEXES, specifies that other users can read from and
write to the table while the indexes are being reorganized. ALLOW
WRITE ACCESS mode is not supported for a partitioned table unless
the CLEANUP or RECLAIM EXTENTS option or the ON DATA PARTITION
clause is specified. If the ON DATA PARTITION clause is specified for
a partitioned table, only the specified partition is restricted to the
access mode level.
For REORG INDEX, specifies that can read from and write to the table
while the nonpartitioned index is being reorganized.
ALLOW WRITE ACCESS mode is not supported for multidimensional
clustering (MDC) or insert time clustering (ITC) tables or extended
indexes unless the CLEANUP or RECLAIM EXTENTS option is specified.
ALLOW WRITE ACCESS mode is not supported for column-organized
tables when the REBUILD option is specified.
The following items apply for a data partitioned table when the ON DATA
PARTITION clause is specified with the REORG INDEXES ALL command:
v Only the specified data partition is restricted to the access mode level.
Users are allowed to read from and write to the other partitions of the
table while the partitioned indexes of a specified partition are being
reorganized.
The following table lists the access modes supported and the concurrent
access allowed on other partitions of the table when the ON DATA
PARTITION clause is specified:
152
Table 54. Access modes supported and concurrent access allowed when the ON DATA
PARTITION clause is specified with REORG INDEXES ALL
Concurrent access allowed
on the specified partition
Access mode
Concurrent access allowed

on other partitions
ALLOW NO ACCESS
No access
Read and write access
ALLOW READ ACCESS
Read on the partition up

until index is updated
Read and write access
ALLOW WRITE ACCESS
Read and write access on the Read and write access

partition up until index is
updated
v Only the partitioned indexes for the specified partition are reorganized.
The nonpartitioned indexes on the partitioned table are not reorganized.
If there are any nonpartitioned indexes on the table marked "invalid" or
"for rebuild", these indexes are rebuilt before reorganization. If not, only
the partitioned indexes on the specified partition are reorganized or
rebuilt if the index object is marked "invalid" or "for rebuild".
v Only partitioned indexes for the specified partition are cleaned when the
CLEANUP or RECLAIM EXTENTS option is also specified.
The following table lists the supported access modes for index
reorganization of partitioned and nonpartitioned tables:
Table 55. Supported access modes for index reorganization on partitioned and nonpartitioned table
Command
Table type
Table partitioning
clause
Additional
parameters
specified for
index clause
Supported access mode
REORG INDEXES
Nonpartitioned table
Not applicable
Any
ALLOW NO ACCESS,
ALLOW READ ACCESS1,
ALLOW WRITE ACCESS
REORG INDEX
Partitioned table
Not applicable
Any
ALLOW NO ACCESS,
ALLOW READ ACCESS1,
ALLOW WRITE ACCESS
REORG INDEXES
Partitioned table
None
REBUILD (this is
the default if
none specified)
ALLOW NO ACCESS
REORG INDEXES
Partitioned table
ON DATA PARTITION
REBUILD (this is
the default if
none specified)
ALLOW NO ACCESS,
ALLOW READ ACCESS1,
ALLOW WRITE ACCESS
REORG INDEXES
Partitioned table
With or without the

ON DATA PARTITION
clause
CLEANUP or
ALLOW NO ACCESS,
RECLAIM EXTENTS ALLOW READ ACCESS1,
ALLOW WRITE ACCESS
specified
Note:
1. Default mode when an access clause is not specified.
CLEANUP
When CLEANUP is requested, a cleanup rather than a REBUILD is
done. The indexes are not rebuilt and any pages freed up are
available for reuse by indexes defined on this table only.
153
ALL
Specifies that indexes should be cleaned up by removing

committed pseudo deleted keys and committed pseudo empty
pages.
The CLEANUP ALL option will free committed pseudo empty pages,
as well as remove committed pseudo deleted keys from pages that
are not pseudo empty. This option will also try to merge adjacent
leaf pages if doing so will result in a merged leaf page that has at
least PCTFREE free space on the merged leaf page, where
PCTFREE is the percent free space defined for the index at index
creation time. The default PCTFREE is ten percent. If two pages
can be merged, one of the pages will be freed. The number of
pseudo deleted keys in an index , excluding those on pseudo
empty pages, can be determined by running RUNSTATS and then
selecting the NUMRIDS DELETED from SYSCAT.INDEXES. The
ALL option will clean the NUMRIDS DELETED and the NUM
EMPTY LEAFS if they are determined to be committed.
PAGES
Specifies that committed pseudo empty pages should be removed

from the index tree. This will not clean up pseudo deleted keys on
pages that are not pseudo empty. Since it is only checking the
pseudo empty leaf pages, it is considerably faster than using the
ALL option in most cases.
The CLEANUP PAGES option will search for and free committed
pseudo empty pages. A committed pseudo empty page is one
where all the keys on the page are marked as deleted and all these
deletions are known to be committed. The number of pseudo
empty pages in an indexes can be determined by running RUNSTATS
and looking at the NUM EMPTY LEAFS column in
SYSCAT.INDEXES. The PAGES option will clean the NUM EMPTY
LEAFS if they are determined to be committed.
Use the ALLOW READ ACCESS or ALLOW WRITE ACCESS option to allow other
transactions either read-only or read-write access to the table while the
indexes are being reorganized. No access to the table is allowed when
rebuilding an index during the period in which the reorganized copies of
the indexes are made available.
INDEX index-name REBUILD
The REBUILD option is the default and represents the same functionality
provided by index reorganization in previous releases when the CLEANUP
and CONVERT clauses were not specified. The REBUILD option of index
reorganization rebuilds the index data into physically contiguous pages.
The default access mode is dependent on the table type.
INDEX index-name RECLAIM EXTENTS
Specifies the index to reorganize and reclaim extents that are not being
used. This action moves index pages around within the index object to
create empty extents, and then free these empty extents from exclusive use
by the index object and makes the space available for use by other
database objects within the table space. Extents are reclaimed from the
index object back to the table space. ALLOW READ ACCESS is the default,
however all access modes are supported.
TABLE table-name
Specifies the table to reorganize. The table can be in a local or a remote
database. The name or alias in the form: schema.table-name can be used. The
154
schema is the user name under which the table was created. If you omit the
schema name, the default schema is assumed.
RECLAIM EXTENTS is the only option that is supported with
column-organized tables.
For typed tables, the specified table name must be the name of the
hierarchy's root table.
You cannot specify an index for the reorganization of a multidimensional
clustering (MDC) or insert time clustering (ITC) table. In place
reorganization of tables cannot be used for MDC or ITC tables.
When the ON DATA PARTITION clause is specified for a table reorganization
of a data partitioned table, only the specified data partition is reorganized:
v If there are no nonpartitioned indexes (except system-generated XML
path indexes) defined on the table, the access mode applies only to the
specified partition, users are allowed to read from and write to the other
partitions of the table.
v If there are nonpartitioned indexes defined on the table (excluding
system-generated XML path indexes), the ALLOW NO ACCESS mode is the
default and only supported access mode. In this case, the table is placed
in ALLOW NO ACCESS mode. If ALLOW READ ACCESS is specified, SQL1548N
is returned (SQLSTATE 5U047).
Table 56. Supported access mode for table reorganization on nonpartitioned and partitioned table
Command
Table type
Table partitioning clause
Supported access mode
REORG TABLE
Nonpartitioned table
Not applicable
ALLOW NO ACCESS,
ALLOW READ ACCESS1
REORG TABLE
Partitioned table
Not specified
ALLOW NO ACCESS1
REORG TABLE (There are no

Partitioned table
indexes or only partitioned
indexes defined on the table.)
ON DATA PARTITION
ALLOW NO ACCESS,
ALLOW READ ACCESS1
REORG TABLE (there are

nonpartitioned indexes
defined on the table,
excluding system-generated
XML path indexes.)
ON DATA PARTITION
ALLOW NO ACCESS1
Partitioned table
Note:
1. Default mode when an access clause is not specified.
For a data partitioned table, a table reorganization rebuilds the
nonpartitioned indexes and partitioned indexes on the table after
reorganizing the table. If the ON DATA PARTITION clause is used to
reorganize a specific data partition of a data partitioned table, a table
reorganization rebuilds the nonpartitioned indexes and partitioned indexes
only for the specified partition.
CLASSIC
Reorganizes the table by creating a new copy of the table and then
replaces the original table with the reorganized copy. Any indexes
on the table are recreated after the replacement. The original table
may be available for queries until the replace operation starts,
depending on the access clause, described next.
155
ALLOW NO ACCESS
Specifies that no other users can access the table while the
table is being reorganized.
The ALLOW NO ACCESS mode is the default and only
supported access mode when reorganizing a partitioned
table without the ON DATA PARTITION clause.
If the ON DATA PARTITION clause is specified for a data
partitioned table, only the specified data partition is
reorganized:
v If there are no nonpartitioned indexes defined on the
table (except system-generated XML path indexes), only
the specified partition is restricted to the ALLOW NO
ACCESS mode. Users are allowed to read from and write
to the other partitions of the table.
v If there are nonpartitioned indexes defined on the table
(except system-generated XML path indexes), the ALLOW
NO ACCESS mode is the default and only supported access
mode. In this case, the table is placed in ALLOW NO
ACCESS mode.
ALLOW READ ACCESS
Allow only read access to the table during reorganization.
The ALLOW READ ACCESS mode is the default mode for a
nonpartitioned table.
If the ON DATA PARTITION clause is specified for a data
partitioned table, only the specified data partition is
reorganized:
v If there are no nonpartitioned indexes defined on the
table (except system-generated XML path indexes), the
ALLOW READ ACCESS mode is the default mode and only
the specified partition is restricted to the access mode
level. Users are allowed to read from and write to the
other partitions of the table.
v If there are nonpartitioned indexes defined on the table
(except system-generated XML path indexes), the ALLOW
READ ACCESS mode is not supported. If ALLOW READ
ACCESS is specified in this case, SQL1548N is returned
(SQLSTATE 5U047)
USE tbspace-name
Specifies the name of a system temporary table space in
which to store a temporary copy of the table being
reorganized. If you do not provide a table space name, the
database manager stores a working copy of the table in the
table spaces that contain the table being reorganized.
For an 8 KB, 16 KB, or 32 KB table object, if the page size
of the system temporary table space that you specify does
not match the page size of the table spaces in which the
table data resides, the DB2 database product will try to
find a temporary table space of the correct size of the
LONG/LOB objects. Such a table space must exist for the
reorganization to succeed.
156
For partitioned tables, the temporary table space is used as

temporary storage for the reorganization of data partitions
in the table. Reorganization of the entire partitioned table
reorganizes a single data partition at a time. The temporary
table space must be able to hold the largest data partition
in the table, and not the entire table. When the ON DATA
PARTITION clause is specified, the temporary table space
must be able to hold the specified partition.
If you do not supply a table space name for a partitioned
table, the table space where each data partition is located is
used for temporary storage of that data partition. There
must be enough free space in each data partition's table
space to hold a copy of the data partition.
INDEX index-name
Specifies the index to use when reorganizing the table. If
you do not specify the fully qualified name in the form:
schema.index-name, the default schema is assumed. The
schema is the user name under which the index was
created. The database manager uses the index to physically
reorder the records in the table it is reorganizing.
For an in place table reorganization, if a clustering index is
defined on the table and an index is specified, it must be
the clustering index. If the in place option is not specified,
any index specified will be used. If you do not specify the
name of an index, the records are reorganized without
regard to order. If the table has a clustering index defined,
however, and no index is specified, then the clustering
index is used to cluster the table. You cannot specify an
index if you are reorganizing an MDC or ITC table.
If a table reorganization uses both the INDEX and ON DATA
PARTITION clauses, only the specified partition is
reorganized using the index index-name.
INDEXSCAN
For a clustering REORG an index scan will be used to
re-order table records. Reorganize table rows by accessing
the table through an index. The default method is to scan
the table and sort the result to reorganize the table, using
temporary table spaces as necessary. Even though the
index keys are in sort order, scanning and sorting is
typically faster than fetching rows by first reading the row
identifier from an index.
For tables with extended row size, the default method of
scanning and sorting the result to reorganize the table is
not supported.
For indexes that are expression-based, the default method
of scanning and sorting the result to reorganize the table is
not supported.
LONGLOBDATA
Long field and LOB data are to be reorganized.
This is not required even if the table contains long or LOB
columns. The default is to avoid reorganizing these objects
157
because it is time consuming and does not improve

clustering. However, running a reorganization with the
LONGLOBDATA option on tables with XML columns will
reclaim unused space and thereby reduce the size of the
XML storage object.
This parameter is required when converting existing LOB
data into inlined LOB data.
For tables with extended row size, the first offline REORG
after a table is altered enforces LONGLOBDATA.
USE longtbspace-name
This is an optional parameter, which can be used to specify
the name of a temporary table space to be used for
rebuilding long data. If no temporary table space is
specified for either the table object or for the long objects,
the objects will be constructed in the table space they
currently reside. If a temporary table space is specified for
the table but this parameter is not specified, then the table
space used for base reorg data will be used, unless the
page sizes differ. In this situation, the DB2 database system
will attempt to choose a temporary container of the
appropriate page size to create the long objects in.
If USE longtbspace-name is specified, USE tbspace-name must
also be specified. If it is not, the longtbspace-name argument
is ignored.
KEEPDICTIONARY
If the COMPRESS attribute for the table is YES and the table
has a compression dictionary then no new dictionary is
built. All the rows processed during reorganization are
subject to compression using the existing dictionary. If the
COMPRESS attribute is YES and a compression dictionary
doesn't exist for the table, a dictionary will only be created
(and the table compressed) in this scenario if the table is of
a certain size (approximately 1 to 2 MB) and sufficient data
exists within this table. If, instead, you explicitly state
REORG RESETDICTIONARY, then a dictionary is built as long
as there is at least 1 row in the table. If the COMPRESS
attribute for the table is NO and the table has a compression
dictionary, then reorg processing will preserve the
dictionary and all the rows in the newly reorganized table
will be in noncompressed format. It is not possible to
compress some data such as LOB data not stored in the
base table row.
When the LONGLOBDATA option is not specified, only the
table row data is reorganized. The following table describes
the behavior of KEEPDICTIONARY syntax in REORG command
when the LONGLOBDATA option is not specified.
Table 57. REORG KEEPDICTIONARY
158
Compress
Dictionary Exists
Preserve dictionary; rows compressed.
Build dictionary; rows compressed
Preserve dictionary; all rows uncompressed
Result; outcome
Table 57. REORG KEEPDICTIONARY (continued)

Compress
Dictionary Exists
Result; outcome
No effect; all rows uncompressed
The following table describes the behavior of

KEEPDICTIONARY syntax in REORG command when the
LONGLOBDATA option is specified.
Table 58. REORG KEEPDICTIONARY when LONGLOBDATA option is specified.
Table row
data
dictionary
Compress exists
XML storage
object
dictionary
exists1
Compression
dictionary
Data compression
Preserve dictionaries.
Existing data is
compressed. New data
will be compressed.
Preserve table row

dictionary and create
an XML storage object
dictionary.
Existing data is
will be compressed.
Create table row

dictionary and
preserve the XML
dictionary.
Existing data is
will be compressed.
Create table row and

XML dictionaries.
Existing data is
will be compressed.
Preserve table row and Table data is

XML dictionaries.
uncompressed. New
data will be not be
compressed.
Preserve table row

dictionary.
Table data is
uncompressed. New
data will be not be
compressed.
Preserve XML
dictionary.
Table data is
uncompressed. New
data will be not be
compressed.
No effect.
Table data is
uncompressed. New
data will be not be
compressed.
Note:
1. A compression dictionary can be created for the XML
storage object of a table only if the XML columns are
added to the table in DB2 V9.7 or later, or if the table is
migrated using the ONLINE_TABLE_MOVE stored
procedure.
For any reinitialization or truncation of a table (such as for
a replace operation), if the compress attribute for the table
is NO, the dictionary is discarded if one exists. Conversely,
159
if a dictionary exists and the compress attribute for the

table is YES then a truncation will save the dictionary and
not discard it. The dictionary is logged in its entirety for
recovery purposes and for future support with data
capture changes (that is, replication).
RESETDICTIONARY
If the COMPRESS attribute for the table is YES then a new row
compression dictionary is built. All the rows processed
during reorganization are subject to compression using this
new dictionary. This dictionary replaces any previous
dictionary. If the COMPRESS attribute for the table is NO and
the table does have an existing compression dictionary
then reorg processing will remove the dictionary and all
rows in the newly reorganized table will be in
noncompressed format. It is not possible to compress some
data such as LOB data not stored in the base table row.
If the LONGLOBDATA option is not specified, only the table
row data is reorganized. The following table describes the
behavior of RESETDICTIONARY syntax in REORG command
when the LONGLOBDATA option is not specified.
Table 59. REORG RESETDICTIONARY
Compress
Dictionary Exists
Result; outcome
Build new dictionary*; rows compressed. If

DATA CAPTURE CHANGES option is specified
on the CREATE TABLE or ALTER TABLE
statements, the current dictionary is kept
(referred to as the historical compression
dictionary).
Build new dictionary; rows compressed
Remove dictionary; all rows uncompressed. If

the DATA CAPTURE NONE option is specified
on the CREATE TABLE or ALTER TABLE
statements, the historical compression dictionary is
also removed for the specified table.
No effect; all rows uncompressed
* - If a dictionary exists and the compression attribute is

enabled but there currently isn't any data in the table, the
RESETDICTIONARY operation will keep the existing
dictionary. Rows which are smaller in size than the internal
minimum record length and rows which do not
demonstrate a savings in record length when an attempt is
made to compress them are considered "insufficient" in this
case.
The following table describes the behavior of
RESETDICTIONARY syntax in REORG command when the
LONGLOBDATA option is specified.
160
Table 60. REORG RESETDICTIONARY when LONGLOBDATA option is specified.
Compress
Table row
data
dictionary
exists
XML storage
object
dictionary
exists1
Data dictionary
Data compression
2 3
Build dictionaries .
Existing data is
will be compressed.
Existing data is
Build new table row
dictionary and create a compressed. New data
new XML dictionary3. will be compressed.
Create table row data Existing data is

dictionary and build a compressed. New data
new XML dictionary.
will be compressed.
Create dictionaries.
Remove dictionaries.
Existing table data is
Existing and new data uncompressed. New
is not compressed.
data will be not be
compressed.
Remove table row

dictionary. All data is
uncompressed.

uncompressed. New
data will be not be
compressed.
Remove XML storage

object dictionary.

uncompressed. New
data will be not be
compressed.
No effect.

uncompressed. New
data will be not be
compressed.
Existing data is
will be compressed.
Note:
1. A compression dictionary can be created for the XML
storage object of a table only if the XML columns are
added to the table in DB2 V9.7 or later, or if the table is
migrated using an online table move.
2. If a dictionary exists and the compression attribute is
enabled but there currently isn't any data in the table,
the RESETDICTIONARY operation will keep the existing
dictionary. Rows which are smaller in size than the
internal minimum record length and rows which do not
demonstrate a savings in record length when an
attempt is made to compress them are considered
insufficient in this case.
3. If DATA CAPTURE CHANGES option is specified on
the CREATE TABLE or ALTER TABLE statements, the
current data dictionary is kept (referred to as the
historical compression dictionary).
INPLACE
Reorganizes the table while permitting user access.
161
INPLACE table reorganization is allowed only on non-MDC and

non-ITC tables without extended indexes and with no indexes
defined over XML columns in the table. INPLACE table
reorganization can be run only on tables that are at least three
pages in size.
Before START can be issued for an INPLACE reorganization on a
table, any paused or running in place reorganization must be
completed or stopped on that table.
In place table reorganization takes place asynchronously, and might
not be effective immediately.
ALLOW READ ACCESS
Allow only read access to the table during reorganization.
ALLOW WRITE ACCESS
Allow write access to the table during reorganization. This
is the default behavior.
FULL
The table is reorganized to fill pages while respecting

PCTFREE for the table. Optionally, when the INDEX clause
is specified, row data is moved within the table to recluster
the data. Overflow records are also converted to normal
records as part of this process. This behavior is the default
behavior.
INDEX index-name
Specifies the index to use when reorganizing the table. If
you do not specify the fully qualified name in the form:
schema.index-name, the default schema is assumed. The
schema is the user name under which the index was
created. The database manager uses the index to physically
reorder the records in the table it is reorganizing.
For an in place table reorganization, if a clustering index is
defined on the table and an index is specified, it must be
the clustering index. If the in place option is not specified,
any index specified will be used. If you do not specify the
name of an index, the records are reorganized without
regard to order. If the table has a clustering index defined,
however, and no index is specified, then the clustering
index is used to cluster the table. You cannot specify an
index if you are reorganizing an MDC or ITC table.
If a table reorganization uses both the INDEX and ON DATA
PARTITION clauses, only the specified partition is
reorganized using the index index-name.
TRUNCATE TABLE
Reclaim all extents that are empty at the end of the table
and return them to the table space. Space reclamation is
run at the end of the in place reorganization. During
truncation, the table is S-locked, preventing updates to the
table. Updates are not possible even if ALLOW WRITE
ACCESS is specified. This behavior is the default behavior.
NOTRUNCATE TABLE
This operation allows for write access through the entire
162
reorganization when ALLOW WRITE ACCESS is specified.

There is no attempt to reclaim space that is used by the
table.
START
Start the in place REORG processing. Because this is the

default, this keyword is optional.
RESUME Continue or resume a previously paused in place table

reorganization. When an online reorganization is resumed
and you want the same options as when the reorganization
was paused, you must specify those options again while
resuming.
CLEANUP OVERFLOWS
An INPLACE CLEANUP OVERFLOWS reorganization
traverses the table and searches for pointer or overflow
records. Any record found is converted to a normal record
by the operation. This operation improves performance for
tables that have a significant number of pointer or
overflow records. The operation does not result in a
reduction of the size of the table.
STOP
Stop the in place REORG processing at its current point.
PAUSE
Suspend or pause in place REORG for the time being.
RECLAIM EXTENTS
Specifies the table to reorganize and reclaim extents that are not
being used. The table-name variable must specify a
multidimensional clustering (MDC) or insert time clustering (ITC)
table. The name or alias in the form: schema.table-name can be used.
The schema is the user name under which the table was created. If
you omit the schema name, the default schema is assumed.
For REORG TABLE RECLAIM EXTENTS when the ON DATA PARTITION
clause is specified, the access clause only applies to the named
partition. Users can read from and write to the rest of the table
while the extents on the specified partition are being reclaimed.
This situation also applies to the default access levels.
ALLOW NO ACCESS
For REORG TABLE RECLAIM EXTENTS, specifies that no other
users can access the table while the extents are being
reclaimed.
ALLOW READ ACCESS
For REORG TABLE RECLAIM EXTENTS, specifies that other
users can have read-only access to the table while the
extents are being reclaimed.
ALLOW WRITE ACCESS
For REORG TABLE RECLAIM EXTENTS, specifies that other
users can read from and write to the table while the
extents are being reclaimed.
ON DATA PARTITION partition-name
For data partitioned tables, specifies the data partition for the
reorganization.
163
For DB2 V9.7 Fix Pack 1 and later releases, the clause can be used with the
REORG INDEXES ALL command to reorganize the partitioned indexes on a
specific partition and the REORG TABLE command to reorganize data of a
specific partition.
When using the clause with a REORG TABLE or REORG INDEXES ALL command
on a partitioned table, the reorganization fails and returns SQL2222N with
reason code 1 if the partition partition-name does not exist for the specified
table. The reorganization fails and returns SQL2222N with reason code 3 if
the partition partition-name is in the attached or detached state.
If the REORG INDEX command is issued with the ON DATA PARTITION clause,
the reorganization fails and returns SQL2222N with reason code 2.
The REORG TABLE command fails and returns SQL1549N (SQLSTATE 5U047)
if the partitioned table is in the reorg pending state and there are
nonpartitioned indexes defined on the table.
ALL DBPARTITIONNUMS
Specifies that operation is to be done on all database partitions specified in
the db2nodes.cfg file. This is the default if a database partition clause is
not specified.
EXCEPT Specifies that operation is to be done on all database partitions specified in
the db2nodes.cfg file, except those specified in the database partition list.
ON DBPARTITIONNUM | ON DBPARTITIONNUMS
Perform operation on a set of database partitions.
Specifies a database partition number in the database partition list.
Specifies the second database partition number, so that all database
partitions from db-partition-number1 up to and including
db-partition-number2 are included in the database partition list.
Example
Reorganize the tables in a database partition group consisting of database
partitions 1, 3 and 4.
CALL SYSPROC.ADMIN_CMD (REORG TABLE employee
INDEX empid ON DBPARTITIONNUM (1,3,4))
Usage notes
Restrictions:
statement.
v The REORG utility issue a COMMIT statement at the beginning of the operation
v The REORG utility does not support the use of nicknames.
v The REORG TABLE command is not supported for declared temporary tables or
created temporary tables.
v The REORG TABLE command cannot be used on views.
v Reorganization of a table is not compatible with range-clustered tables, because
the range area of the table always remains clustered.
164
v REORG TABLE cannot be used on a partitioned table in a DMS table space while
an online backup of ANY table space in which the table resides, including LOBs
and indexes, is being performed.
v REORG TABLE cannot use an index that is based on an index extension.
v If a table is in reorg pending state, an inplace reorg is not allowed on the table.
v Concurrent table reorganization sharing the same temporary DMS table space is
not supported.
v If a table has an index with an expression-based key defined on it, inplace table
reorganization is not supported.
v Before running a reorganization operation against a table to which event
monitors write, you need to deactivate the event monitors on that table.
v For data partitioned tables:
The table must have an ACCESS_MODE in SYSCAT.TABLES of Full Access.
Reorganization skips data partitions that are in a restricted state due to an
attach or detach operation. If the ON DATA PARTITION clause is specified, that
partition must be fully accessible.
If an error occurs during table reorganization, some indexes or index
partitions might be left invalid. The nonpartitioned indexes of the table will
be marked invalid if the reorganization has reached or passed the replace
phase for the first data partition. The index partitions for any data partition
that has already reached or passed the replace phase will be marked invalid.
Indexes will be rebuilt on the next access to the table or data partition.
If an error occurs during index reorganization when the ALLOW NO ACCESS
mode is used, some indexes on the table might be left invalid. For
nonpartitioned RID indexes on the table, only the index that is being
reorganized at the time of the failure will be left invalid. For MDC tables with
nonpartitioned block indexes, one or more of the block indexes might be left
invalid if an error occurs. For MDC or ITC tables with partitioned indexes,
only the index object on the data partition being reorganized will be left
invalid. Any indexes marked invalid will be rebuilt on the next access to the
table or data partition.
When a data partitioned table with only partitioned indexes defined on the
table is in the reorg pending state, issuing a REORG TABLE command with the
ON DATA PARTITION clause brings only the specified data partition out of the
reorg pending state. To bring the remaining partitions of the table out of the
reorg pending state, either issue REORG TABLE command on the entire table
(without the ON DATA PARTITION clause), or issue a REORG TABLE command
with the ON DATA PARTITION clause for each of the remaining partitions.
Information about the current progress of table reorganization is written to the
history file for database activity. The history file contains a record for each
reorganization event. To view this file, execute the LIST HISTORY command for the
database that contains the table you are reorganizing.
You can also use table snapshots to monitor the progress of table reorganization.
Table reorganization monitoring data is recorded regardless of the Database
Monitor Table Switch setting.
If an error occurs, an SQLCA dump is written to the history file. For an inplace
table reorganization, the status is recorded as PAUSED.
When an indexed table has been modified many times, the data in the indexes
might become fragmented. If the table is clustered with respect to an index, the
165
table and index can get out of cluster order. Both of these factors can adversely
affect the performance of scans using the index, and can impact the effectiveness of
index page prefetching. REORG INDEX or REORG INDEXES with the REBUILD option can
be used to reorganize one or all of the indexes on a table. Index reorganization
rebuild will remove any fragmentation and restore physical clustering to the leaf
pages. Use the REORGCHK command to help determine if an index needs
reorganizing. Be sure to complete all database operations and release all locks
before invoking index reorganization. This can be done by issuing a COMMIT after
closing all cursors opened WITH HOLD, or by issuing a ROLLBACK.
A classic table reorganization (offline reorganization) rebuilds the indexes during
the last phase of the reorganization. When more than one temporary table space
exists, it is possible that a temporary table space in addition to the one specified on
the REORG TABLE command may be utilized for additional sorts that can
accompanying table reorg processing. However, the inplace table reorganization
(online reorganization) does not rebuild the indexes. It is recommended that you
issue a REORG INDEXES command after the completion of an inplace table
reorganization. An inplace table reorganization is asynchronous, therefore care
must be taken to ensure that the inplace table reorganization is complete before
issuing the REORG INDEXES command. Issuing the REORG INDEXES command before
the inplace table reorganization is complete, might cause the reorganization to fail
(SQLCODE -2219).
Tables that have been modified so many times that data is fragmented and access
performance is noticeably slow are candidates for the REORG TABLE command. You
should also invoke this utility after altering the inline length of a structured type
column in order to benefit from the altered inline length. Use the REORGCHK
command to determine whether a table needs reorganizing. Be sure to complete all
database operations and release all locks before invoking REORG TABLE. This can be
done by issuing a COMMIT after closing all cursors opened WITH HOLD, or by
issuing a ROLLBACK. After reorganizing a table, use RUNSTATS to update the table
statistics, and REBIND to rebind the packages that use this table. The reorganize
utility will implicitly close all the cursors.
With DB2 V9.7 Fix Pack 1 and later, REORG TABLE commands and REORG INDEXES
ALL commands can be issued on a data partitioned table to concurrently reorganize
different data partitions or partitioned indexes on a partition. When concurrently
reorganizing data partitions or the partitioned indexes on a partition, users can
access the unaffected partitions but cannot access the affected partitions. All the
following criteria must be met to issue REORG commands that operate concurrently
on the same table:
v Each REORG command must specify a different partition with the ON DATA
PARTITION clause.
v Each REORG command must use the ALLOW NO ACCESS mode restrict access to the
data partitions.
v The partitioned table must have only partitioned indexes if issuing REORG TABLE
commands. No nonpartitioned indexes (except system-generated XML path
indexes) can be defined on the table.
For a partitioned table T1 with no nonpartitioned indexes (except system-generated
XML path indexes) and with partitions P1, P2, P3, and P4, the following REORG
commands can run concurrently:
REORG INDEXES ALL FOR TABLE T1 ALLOW NO ACCESS ON DATA PARTITION P1
REORG TABLE T1 ALLOW NO ACCESS ON DATA PARTITION P2
REORG INDEXES ALL FOR TABLE T1 ALLOW NO ACCESS ON DATA PARTITION P3
166
Operations such as the following are not supported when using concurrent REORG
commands:
v Using a REORG command without the ON DATA PARTITION clause on the table.
v Using an ALTER TABLE statement on the table to add, attach, or detach a data
partition.
v Loading data into the table.
v Performing an online backup that includes the table.
If the table contains mixed row format because the table value compression has
been activated or deactivated, an offline table reorganization can convert all the
existing rows into the target row format.
If the table is distributed across several database partitions, and the table or index
reorganization fails on any of the affected database partitions, only the failing
database partitions will have the table or index reorganization rolled back.
If the reorganization is not successful, temporary files should not be deleted. The
database manager uses these files to recover the database.
If the name of an index is specified, the database manager reorganizes the data
according to the order in the index. To maximize performance, specify an index
that is often used in SQL queries. If the name of an index is not specified, and if a
clustering index exists, the data will be ordered according to the clustering index.
The PCTFREE value of a table determines the amount of free space designated per
page. If the value has not been set, the utility will fill up as much space as possible
on each page.
To complete a table space rollforward recovery following a table reorganization,
both regular and large table spaces must be enabled for rollforward recovery.
If the table contains LOB columns that do not use the COMPACT option, the LOB
DATA storage object can be significantly larger following table reorganization. This
can be a result of the order in which the rows were reorganized, and the types of
table spaces used (SMS or DMS).
Indexes over XML data may be recreated by the REORG INDEXES/TABLE command.
For details, see Recreation of indexes over XML data.
Indexes cannot be created on column-organized tables. An index is used internally
to track pages within these tables, and an index might be used to enforce unique
or primary key constraints.
Part of space management for column-organized tables is managing the space that
is consumed by the page map and unique enforcement indexes. A reorg operation
on the table generates pseudo deleted keys in the page map indexes, which are
cleaned up during a subsequent reorg indexes cleanup operation. Update and
delete operations result in pseudo deleted keys in any unique enforcement indexes.
Consider running a REORG INDEXES command, specifying the CLEANUP and RECLAIM
EXTENTS options. Automatic table maintenance, if enabled, will manage the cleanup
and space reclamation process for indexes.
167
RESET ALERT CONFIGURATION command using the ADMIN_CMD

procedure:
Resets the health indicator settings for specific objects to the current defaults for
that object type or resets the current default health indicator settings for an object
type to the install defaults.
Important: This command or API has been deprecated and might be removed in a
future release because the health monitor has been deprecated in Version 9.7. It is
not supported in DB2 pureScale environments. For more information, see Health
monitor has been deprecated at http://publib.boulder.ibm.com/infocenter/
db2luw/v9r7/topic/com.ibm.db2.luw.wn.doc/doc/i0055045.html.
Authorization
v SYSADM
v SYSMAINT
v SYSCTRL
Required connection
Database
Command syntax
RESET ALERT
CONFIGURATION
CONFIG
CFG
DATABASE MANAGER
DB MANAGER
DBM
CONTAINERS
DATABASES
TABLESPACES
CONTAINER container-name FOR
DATABASE
TABLESPACE tblspace-name
FOR
tblspace-name
ON
database-alias
USING health-indicator-name
Command parameters
DATABASE MANAGER | DB MANAGER | DBM
Resets alert settings for the database manager.
CONTAINERS
Resets default alert settings for all table space containers managed by the
database manager to the install default. These are the settings that apply to
all table space containers that do not have custom settings. Custom settings
are defined using the CONTAINER container-name FOR tblspace-name ON
database-alias clause.
DATABASES
Resets alert settings for all databases managed by the database manager.
These are the settings that apply to all databases that do not have custom
settings. Custom settings are defined using the DATABASE ON database-alias
clause.
TABLESPACES
Resets default alert settings for all table spaces managed by the database
manager to the install default. These are the settings that apply to all table
168
spaces that do not have custom settings. Custom settings are defined using
the TABLESPACE tblspace-name ON database-alias clause.
CONTAINER container-name FOR tblspace-name ON database-alias
Resets the alert settings for the table space container called container-name,
for the table space specified using the FOR tblspace-name clause, on the
database specified using the ON database-alias clause. If this table space
container has custom settings, then these settings are removed and the
current table space containers default is used.
DATABASE ON database-alias
Resets the alert settings for the database specified using the ON database-alias
clause. If this database has custom settings, then these settings are removed
and the install default is used.
TABLESPACE tblspace-name ON database-alias
Resets the alert settings for the table space called tblspace-name, on the
database specified using the ON database-alias clause. If this table space has
custom settings, then these settings are removed and the install default is
used.
Specifies the set of health indicators for which alert configuration will be
reset. Health indicator names consist of a two-letter object identifier
followed by a name that describes what the indicator measures. For
example:
db.sort_privmem_util
If you do not specify this option, all health indicators for the specified
object or object type will be reset.
Example
Reset alert settings for the database manager that owns the database which
contains the ADMIN_CMD procedure.
CALL SYSPROC.ADMIN_CMD( reset alert cfg for dbm )
Usage notes
statement.
The database-alias must be a local database defined in the catalog on the server
because the ADMIN_CMD procedure runs on the server only.
RESET DATABASE CONFIGURATION command using the ADMIN_CMD
procedure:
Resets the configuration of a specific database to the system defaults.
Scope
This command only affects the database partition that the application is connected
to.
169
Authorization
v SYSADM
v SYSCTRL
v SYSMAINT
Required connection
Database
Command syntax
RESET
DATABASE
DB
CONFIGURATION
CONFIG
CFG
FOR
database-alias

MEMBER member-number
Command parameters
FOR database-alias
Specifies the alias of the database whose configuration is to be reset to the
system defaults. The database alias must be one that is defined in the
catalog on the server, and must refer to a local database on the server.
If a database configuration reset is to be applied to a specific member, this
parameter may be used. If this parameter is not provided, the reset will
take effect on all members.
Example
Reset the configuration of a database cataloged with alias SAMPLE on the server
CALL SYSPROC.ADMIN_CMD( reset db cfg for SAMPLE )
Usage notes
To view or print a list of the database configuration parameters, use the
SYSIBMADM.DBCFG administration view.
To change the value of a configurable parameter, use the UPDATE DATABASE
CONFIGURATION command.
Changes to the database configuration file become effective only after they are
loaded into memory. All applications must disconnect from the database before
this can occur.
If an error occurs, the database configuration file does not change.
The database configuration file cannot be reset if the checksum is invalid. This
might occur if the database configuration file is changed without using the
appropriate command. If this happens, the database must be restored to reset the
database configuration file.
170
The RESET DATABASE CONFIGURATION command will reset the database configuration
parameters to the documented default configuration values, where auto_runstats
will be ON. Self_tuning_mem will be reset to ON on non-partitioned database
environments and to OFF on partitioned database environments.
statement.
The database-alias must be a local database defined in the catalog on the server
because the ADMIN_CMD procedure runs on the server only.
Compatibilities
RESET DATABASE MANAGER CONFIGURATION command using the
Resets the parameters in the database manager configuration file to the system
defaults for the instance that contains the currently connected database. The values
are reset by node type.
Authorization
SYSADM
Required connection
Database
Command syntax
RESET
DATABASE MANAGER
DB MANAGER
DBM
CONFIGURATION
CONFIG
CFG
Command parameters
None
Example
Reset the configuration of the instance which contains the database the
ADMIN_CMD stored procedure belongs to.
CALL SYSPROC.ADMIN_CMD( reset dbm cfg )
Usage notes
This command resets all parameters set by the installation program. This could
cause error messages to be returned when restarting DB2. For example, if the
svcename parameter is reset, the user will receive the SQL5043N error message
when trying to restart DB2.
171
Before running this command, save the output from the SYSIBMADM.DBMCFG
administrative view to a file so that you can refer to the existing settings.
Individual settings can then be updated using the UPDATE DATABASE MANAGER
CONFIGURATION command through the ADMIN_CMD procedure.
It is not recommended that the svcename parameter, set by the installation
program, be modified by the user.
To view or print a list of the database manager configuration parameters, use the
SYSIBMADM.DBMCFG administration view. To change the value of a configurable
parameter, use the UPDATE DATABASE MANAGER CONFIGURATION command through the
For more information about these parameters, refer to the summary list of
configuration parameters and the individual parameters.
Some changes to the database manager configuration file become effective only
after they are loaded into memory. For more information aboutwhich parameters
are configurable online and which ones are not, see the configuration parameter
summary. Server configuration parameters that are not reset immediately are reset
during execution of db2start. For a client configuration parameter, parameters are
reset the next time you restart the application. If the client is the command line
processor, it is necessary to invoke TERMINATE.
If an error occurs, the database manager configuration file does not change.
The database manager configuration file cannot be reset if the checksum is invalid.
This might occur if you edit the configuration file manually and do not use the
appropriate command. If the checksum is invalid, you must re-create the instance.
REWIND TAPE command using the ADMIN_CMD procedure:
Rewinds tapes for backup and restore operations to streaming tape devices. This
command is only supported on Windows operating systems.
Authorization
v SYSADM
v SYSCTRL
v SYSMAINT
Required connection
Database
Command syntax
REWIND TAPE

ON
172
device
Command parameters
ON device
Specifies a valid tape device name. The default value is \\.\TAPE0.The
Example
Rewind the tape on the device named '\\.\TAPE1'.
CALL SYSPROC.ADMIN_CMD( rewind tape on \\.\TAPE1 )
Usage notes
statement.
RUNSTATS command using the ADMIN_CMD procedure:
Updates statistics in the system catalog about the characteristics of a table and/or
associated indexes, or statistical views. These characteristics include number of
records, number of pages, and average record length. The optimizer uses these
statistics when determining access paths to the data.
For a table, call the RUNSTATS command when the table has had many updates,
or after reorganizing the table. For a statistical view, call the RUNSTATS command
when changes to underlying tables have substantially affected the rows returned
by the view. The view must have been previously enabled for use in query
optimization by using the ALTER VIEW statement.
Scope
The RUNSTATS command can be issued from any database partition in the
db2nodes.cfg file. It can be used to update the catalogs on the catalog database
partition.
For tables, this command collects statistics for a table on the database partition
from which it is invoked. If the table does not exist on that database partition, the
first database partition in the database partition group is selected.
For views, this command collects statistics using data from tables on all
participating database partitions.
Authorization
For tables, one of the following authorities:
v SYSADM
v SYSCTRL
v SYSMAINT
v DBADM
v SQLADM
v CONTROL privilege on the table
v LOAD authority
You do not need any explicit privilege to use this command on any declared
temporary table that exists within its connection.
173
For statistical views, one of the following authorities:

v SYSADM
v SYSCTRL
v SYSMAINT
v DBADM
v SQLADM
v CONTROL privilege on the statistical view
v LOAD authority
Required connection
Database
Command syntax
RUNSTATS ON
TABLE
VIEW
object-name

USE PROFILE
UNSET PROFILE
Statistics Options

UTIL_IMPACT_PRIORITY
priority
Statistics Options:
ALLOW WRITE ACCESS

ALLOW READ ACCESS
Table Object Options

Table Sampling Options
Index Sampling Options

Profile Options
Table Object Options:

FOR
Index Clause
EXCLUDING XML COLUMNS
Column Stats Clause
AND
Index Clause
Table Sampling Options:

TABLESAMPLE
BERNOULLI
SYSTEM
numeric-literal

REPEATABLE (
174
integer-literal
Index Sampling Options:

INDEXSAMPLE
BERNOULLI
SYSTEM
numeric-literal
Profile Options:
SET PROFILE NONE
SET
UPDATE
PROFILE
ONLY
Index Clause:
,
INDEXES
INDEX
SAMPLED
index-name
ALL
DETAILED
UNSAMPLED
Column Stats Clause:

On Cols Clause
Distribution Clause
On Cols Clause
On Cols Clause:
ON ALL COLUMNS
,
COLUMNS (
ON
Column Option
ALL
COLUMNS AND
KEY
ON KEY COLUMNS
Distribution Clause:
WITH DISTRIBUTION

On Dist Cols Clause

Default Dist Options
On Dist Cols Clause:

ON ALL COLUMNS
,
ON
ALL
COLUMNS AND
KEY
ON KEY COLUMNS
COLUMNS (
Column Option
)
Frequency Option
Quantile Option
175
Default Dist Option:
DEFAULT
Frequency Option
Quantile Option
Frequency Option:
NUM_FREQVALUES integer
Quantile Option:
NUM_QUANTILES integer
Column Option:
column-name
LIKE STATISTICS
,
( column-name
Command parameters
object-name
Identifies the table or statistical view on which statistics are to be collected.
This parameter must not be a hierarchy table. For typed tables, object-name
must be the name of the root table of the table hierarchy. The fully
qualified name or alias in the form: schema.object-name must be used. The
schema is the user name under which the table was created.
USE PROFILE
This option allows RUNSTATS to employ a previously stored statistics profile
to gather statistics for a table or statistical view. The statistics profile is
created using the SET PROFILE options and is updated using the UPDATE
PROFILE options.
UNSET PROFILE
Specify this option to remove an existing statistics profile. For example,
RUNSTATS ON tablemyschema.mytable UNSET PROFILE
FOR INDEXES
Collects and updates statistics for the indexes only. If no table statistics had
been previously collected on the table, basic table statistics are also
collected. These basic statistics do not include any distribution statistics.
This option cannot be used for views.
SAMPLED
Used together only with the DETAILED parameter. Specifying this option
does not change the default functionality from DETAILED. This option is left
in for compatibility with previous versions of DB2. This option cannot be
used for views.
UNSAMPLED
This option, when used with the DETAILED option, forces RUNSTATS to
176
examine every entry in the index to compute the extended index statistics.
This option cannot be used for views and it cannot be used together with
scan index sampling (INDEXSAMPLE keyword). This option significantly
increases RUNSTATS resource consumption, while rarely providing
significant improvement over the DETAILED or SAMPLED DETAILED options,
which are equivalent.
DETAILED
Calculates extended index statistics. The extended index statistics are the
CLUSTERFACTOR and PAGE_FETCH_PAIRS statistics that are gathered for
relatively large indexes. Not all index entries are examined, a CPU
sampling technique is employed instead to improve performance. This
option cannot be used for views.
index-name
Identifies an existing index defined on the table. If you do not specify the
fully qualified name in the form: schema.index-name, the default schema is
assumed. This option cannot be used for views.
Use this clause to omit all XML type columns from statistics collection.
Using this clause facilitates the collection of statistics on non-XML columns
because the inclusion of XML data can require greater system resources.
The EXCLUDING XML COLUMNS clause takes precedence over other clauses that
specify XML columns for statistics collection. For example, if you use the
EXCLUDING XML COLUMNS clause, and you also specify XML type columns
with the ON COLUMNS clause or you use the ON ALL COLUMNS clause, all XML
type columns will be ignored during statistics collection. For DB2 V9.7 Fix
Pack 1 and later releases, distribution statistics over XML type columns are
not collected when this clause is specified.
AND INDEXES
Collects and updates statistics for both the table and the indexes. This
option cannot be used for views.
ON ALL COLUMNS
To collect statistics on all eligible columns, use the ON ALL COLUMNS clause.
Columns can be specified either for basic statistics collection (On Cols
clause) or in conjunction with the WITH DISTRIBUTION clause (On Dist Cols
clause). The ON ALL COLUMNS specification is the default option if neither of
the column specific clauses are specified.
If it is specified in the On Cols clause, all columns will have only basic
column statistics collected unless specific columns are chosen as part of the
WITH DISTRIBUTION clause. Those columns specified as part of the WITH
DISTRIBUTION clause will also have basic and distribution statistics
collected.
If the WITH DISTRIBUTION ON ALL COLUMNS is specified both basic statistics
and distribution statistics are collected for all eligible columns. Anything
specified in the On Cols clause is redundant and therefore not necessary.
ON COLUMNS
To collect statistics on specific columns, column groups, or both, use the ON
COLUMNS. A column group is a parenthesized comma-separated list of
columns for which you want to collect combined statistics.
The column and column groups are specified as a parenthesized
comma-separated list.
177
When you run the RUNSTATS command on a table without gathering index
statistics and specify a subset of columns for which statistics are to be
gathered:
v Statistics for columns not specified in the RUNSTATS command but which
are the first column in an index are not reset.
v Statistics for all other columns not specified in the RUNSTATS command
are reset.
This clause can be used in the On Cols clause and the On Dist Cols clause.
Collecting distribution statistics for a group of columns is not currently
supported.
If XML type columns are specified in a column group, the XML type
columns are ignored for collecting distinct values for the group. However,
basic XML column statistics are collected for the XML type columns in the
column group.
ON KEY COLUMNS
Instead of listing specific columns, you can choose to collect statistics on
columns that make up all the indexes defined on the table. It is assumed
here that critical columns in queries are also those used to create indexes
on the table. If there are no indexes on the table, it is as good as an empty
list and no column statistics will be collected. It can be used in the On Cols
clause or the On Dist Cols clause. It is redundant in the On Cols clause if
specified in both clauses since the WITH DISTRIBUTION clause is used to
specify collection of both basic and distribution statistics. XML type
columns are by definition not a key column and will not be included for
statistics collection by the ON KEY COLUMNS clause. This option cannot be
used for views.
column-name
Name of a column in the table or statistical view. If you specify the name
of an ineligible column for statistics collection, such as a nonexistent
column or a mistyped column name, error (-205) is returned. Two lists of
columns can be specified, one without distribution and one with
distribution. If the column is specified in the list that is not associated with
the WITH DISTRIBUTION clause only basic column statistics will be collected.
If the column appears in both lists, distribution statistics will be collected
(unless NUM_FREQVALUES and NUM_QUANTILES are set to zero).
LIKE STATISTICS
When this option is specified additional column statistics might be
collected for columns of type CHAR and VARCHAR with a code page
attribute of single-byte character set (SBCS), FOR BIT DATA, or UTF-8.
The statistics are collected if the runstats utility determines that such
statistics are appropriate after analyzing column values. These statistics
are the SUB_COUNT and the SUB_DELIM_LENGTH statistics in SYSSTAT.COLUMNS.
They are used by the query optimizer to improve the selectivity estimates
for predicates of the type "column LIKE %xyz"and "column LIKE
%xyz%".
WITH DISTRIBUTION
This clause specifies that both basic statistics and distribution statistics are
to be collected on the columns. If the ON COLUMNS clause is not specified,
distribution statistics are collected on all the columns of the table or
statistical view (excluding columns that are ineligible such as CLOB and
LONG VARCHAR). If the ON COLUMNS clause is specified, distribution
178
statistics are collected only on the column list provided (excluding those
ineligible for statistics collection). If the clause is not specified, only basic
statistics are collected.
Collection of distribution statistics on column groups is currently not
supported; distribution statistics will not be collected when column groups
are specified in the WITH DISTRIBUTION ON COLUMNS clause.
DEFAULT
If NUM_FREQVALUES or NUM_QUANTILES are specified, these values will be used
to determine the maximum number of frequency and quantile statistics to
be collected for the columns, if these are not specified for individual
columns in the ON COLUMNS clause. If the DEFAULT clause is not specified, the
values used will be those in the corresponding database configuration
parameters.
NUM_FREQVALUES
Defines the maximum number of frequency values to collect. It can be
specified for an individual column in the ON COLUMNS clause. If the value is
not specified for an individual column, the frequency limit value will be
picked up from that specified in the DEFAULT clause. If it is not specified
there either, the maximum number of frequency values to be collected will
be what is set in the num_freqvalues database configuration parameter.
NUM_QUANTILES
Defines the maximum number of distribution quantile values to collect. It
can be specified for an individual column in the ON COLUMNS clause. If the
value is not specified for an individual column, the quantile limit value
will be picked up from that specified in the DEFAULT clause. If it is not
specified there either, the maximum number of quantile values to be
collected will be what is set in the num_quantiles database configuration
parameter.
For DB2 V9.7 Fix Pack 1 and later releases, distribution statistics for each
index over XML data uses a maximum of 250 quantiles as the default. The
default can be changed by specifying the NUM_QUANTILES parameter in the
ON COLUMNS or the DEFAULT clause. The num_quantiles database
configuration parameter is ignored while collecting XML distribution
statistics.
ALLOW WRITE ACCESS
Specifies that other users can read from and write to the tables while
statistics are calculated. For statistical views, these are the base tables
referenced in the view definition.
The ALLOW WRITE ACCESS option is not recommended for tables that will
have a lot of inserts, updates or deletes occurring concurrently. The
RUNSTATS command first performs table statistics and then performs index
statistics. Changes in the table's state between the time that the table and
index statistics are collected might result in inconsistencies. Although
having up-to-date statistics is important for the optimization of queries, it
is also important to have consistent statistics. Therefore, statistics should be
collected at a time when inserts, updates or deletes are at a minimum.
ALLOW READ ACCESS
Specifies that other users can have read-only access to the tables while
statistics are calculated. For statistical views, these are the base tables
referenced in the view definition.
179
TABLESAMPLE BERNOULLI
This option allows RUNSTATS to collect statistics on a sample of the rows
from the table or statistical view. Bernoulli sampling considers each row
individually, including that row with probability P/100 (where P is the
value of numeric-literal) and excluding it with probability 1-P/100. Thus, if
the numeric-literal were evaluated to be the value 10, representing a 10
percent sample, each row would be included with probability 0.1 and be
excluded with probability 0.9. Unless the optional REPEATABLE clause is
specified, each execution of RUNSTATS will usually yield a different such
sample of the table. All data pages will be retrieved through a table scan
but only the percentage of rows as specified through the numeric-literal
parameter will be used for the statistics collection.
TABLESAMPLE SYSTEM
This option allows RUNSTATS to collect statistics on a sample of the data
pages from the tables. System sampling considers each page individually,
including that page with probability P/100 (where P is the value of
numeric-literal) and excluding it with probability 1-P/100. Unless the
optional REPEATABLE clause is specified, each execution of RUNSTATS will
usually yield a different such sample of the table. The size of the sample is
controlled by the numeric-literal parameter in parentheses, representing an
approximate percentage P of the table to be returned. Only a percentage of
the data pages as specified through the numeric-literal parameter will be
retrieved and used for the statistics collection.
For statistical views, SYSTEM sampling can only be applied to a single
base table referenced in the view definition. If the view contains multiple
tables, SYSTEM sampling is possible if a single table among all the tables
in the statistical view can be identified as being joined with all primary
keys or unique index columns of the other tables used in the view. If the
statistical view does not meet those conditions, Bernoulli sampling will be
used instead and a warning will be returned.
numeric-literal
The numeric-literal parameter specifies the size of the sample to be
obtained, as a percentage P. This value must be a positive number that is
less than or equal to 100, and can be between 1 and 0. For example, a
value of 0.01 represents one one-hundredth of a percent, such that 1 row in
10,000 would be sampled, on average. A value of 0 or 100 will be treated
by the DB2 database system as if sampling was not specified, regardless of
whether TABLESAMPLE BERNOULLI or TABLESAMPLE SYSTEM is specified. A
value greater than 100 or less than 0 will be treated as an error (SQL1197N)
by the DB2 database system.
REPEATABLE (integer-literal)
Adding the REPEATABLE clause to the TABLESAMPLE clause ensures that
repeated executions of RUNSTATS return the same sample. The integer-literal
parameter is a non-negative integer representing the seed to be used in
sampling. Passing a negative seed will result in an error (SQL1197N). The
sample set might still vary between repeatable RUNSTATS invocations if
activity against the table or statistical view resulted in changes to the table
or statistical view data since the last time TABLESAMPLE REPEATABLE was
run. Also, the method by which the sample was obtained as specified by
the BERNOULLI or SYSTEM keyword, must also be the same to ensure
consistent results.
INDEXSAMPLE BERNOULLI
Use this option to collect index statistics on a sample of the rows in the
180
index. Bernoulli sampling considers each row individually, including the row
with probability P/100 (where P is the value of the numeric-literal) and
excluding it with probability 1-P/100. Thus, if the numeric-literal were
evaluated to be the value 10, representing a 10 percent sample, each row
would be included with probability 0.1 and be excluded with probability
0.9. Each execution of RUNSTATS is likely to yield a different sample of the
index. All index pages are retrieved through an index scan but only the
percentage of rows as specified through the numeric-literal parameter is
used for the statistics collection. This option is not supported on statistical
views.
INDEXSAMPLE SYSTEM
Use this option to collect statistics on a sample of the index pages. System
sampling considers each page individually, including the page with
probability P/100 (where P is the value of the numeric-literal) and
excluding it with probability 1-P/100. Each execution of the RUNSTATS
command usually yields a different sample of the index. The size of the
sample is controlled by the numeric-literal parameters in parentheses,
representing an approximate percentage P of the index to be returned.
Only a percentage of the index pages as specified through the
numeric-literal parameter is retrieved and used for the statistics collection.
This option is not supported on statistical views.
SET PROFILE NONE
Specifies that no statistics profile will be set for this RUNSTATS invocation.
SET PROFILE
Allows RUNSTATS to generate and store a specific statistics profile in the
system catalog tables and executes the RUNSTATS command options to
gather statistics.
SET PROFILE ONLY
Allows RUNSTATS to generate and store a specific statistics profile in the
system catalog tables without running the RUNSTATS command options.
UPDATE PROFILE
Allows RUNSTATS to modify an existing statistics profile in the system
catalog tables, and runs the RUNSTATS command options of the updated
statistics profile to gather statistics. You cannot use the UPDATE PROFILE
option to remove clauses that are in a statistics profile.
UPDATE PROFILE ONLY
Allows RUNSTATS to modify an existing statistics profile in the system
catalog tables without running the RUNSTATS command options of the
updated statistics profile. You cannot use the UPDATE PROFILE ONLY option
to remove clauses that are in a statistics profile.
UTIL_IMPACT_PRIORITY priority
Specifies that RUNSTATS will be throttled at the level specified by priority.
priority is a number in the range of 1 to 100, with 100 representing the
highest priority and 1 representing the lowest. The priority specifies the
amount of throttling to which the utility is subjected. All utilities at the
same priority undergo the same amount of throttling, and utilities at lower
priorities are throttled more than those at higher priorities. If priority is not
specified, the RUNSTATS will have the default priority of 50. Omitting the
UTIL_IMPACT_PRIORITY keyword will invoke the RUNSTATS utility without
throttling support. If the UTIL_IMPACT_PRIORITY keyword is specified, but
the util_impact_lim configuration parameter is set to 100, then the utility
will run unthrottled.
181
In a partitioned database, when used on tables, the RUNSTATS command collects the
statistics on only a single database partition. If the database partition from which
the RUNSTATS command is executed has a partition of the table, then the command
executes on that database partition. Otherwise, the command executes on the first
database partition in the database partition group across which the table is
partitioned.
Example
Collect statistics on all columns used in indexes and on all indexes.
CALL SYSPROC.ADMIN_CMD (RUNSTATS ON TABLE employee
ON KEY COLUMNS and INDEXES ALL)
Usage notes
1. Command execution status is returned in the SQLCA resulting from the CALL
statement.
2. It is recommended to run the RUNSTATS command:
v On tables that have been modified considerably (for example, if a large
number of updates have been made, or if a significant amount of data has
been inserted or deleted or if LOAD has been done without the statistics
option during LOAD).
v On tables that have been reorganized (using REORG, REDISTRIBUTE DATABASE
PARTITION GROUP).
v On tables which have been row compressed.
v When a new index has been created.
v Before binding applications whose performance is critical.
v When the prefetch quantity is changed.
v On statistical views whose underlying tables have been modified
substantially so as to change the rows that are returned by the view.
v After LOAD has been executed with the STATISTICS option, use the RUNSTATS
utility to collect statistics on XML columns. Statistics for XML columns are
never collected during LOAD, even when LOAD is executed with the
STATISTICS option. When RUNSTATS is used to collect statistics for XML
columns only, existing statistics for non-XML columns that have been
collected by LOAD or a previous execution of the RUNSTATS utility are
retained. In the case where statistics on some XML columns have been
collected previously, the previously collected statistics for an XML column
will either be dropped if no statistics on that XML column are collected by
the current command, or be replaced if statistics on that XML column are
collected by the current command.
3. The options chosen must depend on the specific table and the application. In
general:
v If the table is a very critical table in critical queries, is relatively small, or
does not change too much and there is not too much activity on the system
itself, it might be worth spending the effort on collecting statistics in as
much detail as possible.
v If the time to collect statistics is limited, if the table is relatively large, or if
the table is updated frequently, it might be beneficial to execute RUNSTATS
limited to the set of columns that are used in predicates. This way, you will
be able to execute the RUNSTATS command more often.
v If time to collect statistics is very limited and the effort to tailor the
RUNSTATS command on a table by table basis is a major issue, consider
182
collecting statistics for the "KEY" columns only. It is assumed that the index
contains the set of columns that are critical to the table and are most likely
to appear in predicates.
v If time to collect statistics is very limited and table statistics are to be
gathered, consider using the TABLESAMPLE option to collect statistics on a
subset of the table data.
v If time to collect statistics is very limited and index statistics are to be
gathered, consider using the INDEXSAMPLE option to collect statistics on a
subset of the index data.
v If there is skew in certain columns and predicates of the type "column =
constant", it might be beneficial to specify a larger NUM_FREQVALUES value
for that column
v Collect distribution statistics for all columns that are used in equality
predicates and for which the distribution of values might be skewed.
v For columns that have range predicates (for example "column >=
constant", "column BETWEEN constant1 AND constant2") or of the type
"column LIKE %xyz", it might be beneficial to specify a larger
NUM_QUANTILES value.
v If storage space is a concern and one cannot afford too much time on
collecting statistics, do not specify high NUM_FREQVALUES or NUM_QUANTILES
values for columns that are not used in predicates.
v If index statistics are requested, and statistics have never been run on the
table containing the index, statistics on both the table and indexes are
calculated.
v If statistics for XML columns in the table are not required, the EXCLUDING
XML COLUMNS option can be used to exclude all XML columns. This option
takes precedence over all other clauses that specify XML columns for
statistics collection.
4. After the command is run, note the following:
v A COMMIT should be issued to release the locks.
v To allow new access plans to be generated, the packages that reference the
target table must be rebound.
v Executing the command on portions of the table could result in
inconsistencies as a result of activity on the table since the command was
last issued. In this case a warning message is returned. Issuing RUNSTATS on
the table only might make table and index level statistics inconsistent. For
example, you might collect index level statistics on a table and later delete a
significant number of rows from the table. If you then issue RUNSTATS on the
table only, the table cardinality might be less than FIRSTKEYCARD, which is
an inconsistency. In the same way, if you collect statistics on a new index
when you create it, the table level statistics might be inconsistent.
5. The RUNSTATS command will drop previously collected distribution statistics if
table statistics are requested. For example, RUNSTATS ON TABLE, or RUNSTATS ON
TABLE ... AND INDEXES ALL will cause previously collected distribution
statistics to be dropped. If the command is run on indexes only then
previously collected distribution statistics are retained. For example, RUNSTATS
ON TABLE ... FOR INDEXES ALL will cause the previously collected distribution
statistics to be retained. If the RUNSTATS command is run on XML columns
only, then previously collected basic column statistics and distribution
statistics are retained. In the case where statistics on some XML columns have
been collected previously, the previously collected statistics for an XML
column will either be dropped if no statistics on that XML column are
183
collected by the current command, or be replaced if statistics on that XML

column are collected by the current command.
6. When there are detached partitions on a partitioned table, index keys that still
belong to detached data partitions which require cleanup will not be counted
as part of the keys in the statistics. These keys are not counted because they
are invisible and no longer part of the table. They will eventually get removed
from the index by asynchronous index cleanup. As a result, statistics collected
before asynchronous index cleanup is run will be misleading. If the RUNSTATS
command is issued before asynchronous index cleanup completes, it will
likely generate a false alarm for index reorganization or index cleanup based
on the inaccurate statistics. Once asynchronous index cleanup is run, all the
index keys that still belong to detached data partitions which require cleanup
will be removed and this may eliminate the need for index reorganization.
For partitioned tables, you are encouraged to issue the RUNSTATS command
after an asynchronous index cleanup has completed in order to generate
accurate index statistics in the presence of detached data partitions. To
determine whether or not there are detached data partitions in the table, you
can check the status field in the SYSCAT.DATAPARTITIONS catalog view and
look for the value L (logically detached), I (index cleanup), or D (detached
with dependent MQT).
The RUNSTATS command collects statistics for all index partitions of a
partitioned index. Statistics in the SYSSTAT.INDEXES view for the partitioned
index represent an index partition, except for FIRSTKEYCARD,
FIRST2KEYCARD, FIRST3KEYCARD, FIRST4KEYCARD, and FULLKEYCARD
statistics. Because these statistics are used in cardinality estimates, they are for
the entire index and not for an index partition. Distribution statistics (frequent
values and quantiles) are not collected for partitioned indexes, but are
gathered if RUNSTATS is run on the table. Statistics on the leading columns of a
partitioned index might not be as accurate as statistics on the leading columns
of a nonpartitioned index.
7. When the RUNSTATS command is run on a table with an expression-based
index, and the RUNSTATS command includes that index in the AND INDEXES or
FOR INDEXES clause, statistics for expression-based key columns within that
index will also be collected and will be associated with the system-generated
statistical view associated with the index. Expressions cannot be specified as
columns in the RUNSTATS command (SQL0205N). To collect customized
statistics on expression-based index key columns, you can define a statistics
profile on the statistical view that is associated with the index using the
column names as they appear in the statistics view. You also need to define a
statistics profile on the base table including the index in its INDEXES clause.
Note: When you define a statistics profile on the expression based index's
statistical view, an automatically generated statistics profile is also associated
with the base table, if one does not exist already. Once the statistics profiles
have been defined, a RUNSTATS command on the base table with the USE
PROFILE clause will result in the customized statistics being gathered on the
expression-based key columns in the index.
8. For DB2 V9.7 Fix Pack 1 and later releases, distribution statistics are collected
on indexes over XML data defined on an XML column. When the RUNSTATS
command is run on a table with the WITH DISTRIBUTION clause, the following
apply to the collection of distribution statistics on a column of type XML:
v Distribution statistics are collected for each index over XML data specified
on an XML column.
184
v The RUNSTATS command must collect both distribution statistics and table
statistics to collect distribution statistics for indexes over XML data defined
on an XML column. Table statistics must be gathered in order for
distribution statistics to be collected since XML distribution statistics are
stored with table statistics.
An index clause is not required to collect XML distribution statistics.
Specifying only an index clause does not collect XML distribution statistics
By default, XML distribution statistics use a maximum of 250 quantiles for
each index over XML data. When collecting distribution statistics on an
XML column, you can change the maximum number of quantiles by
specifying a value with NUM_QUANTILES parameter in the ON COLUMNS or the
DEFAULT clause.
v Distribution statistics are collected for indexes over XML data of type
VARCHAR, DOUBLE, TIMESTAMP, and DATE. Distribution statistics are
not collected over indexes of type VARCHAR HASHED.
v Distribution statistics are not collected for partitioned indexes over XML
data defined on a partitioned table.
9. For range-clustered tables, there is a special system-generated index in the
catalog tables which represents the range ordering property of range-clustered
tables. When statistics are collected on this type of table, if the table is to be
included as part of the statistics collection, statistics will also be collected for
the system-generated index. The statistics reflect the fast access of the range
lookups by representing the index as a two-level index with as many pages as
the base data table, and having the base data clustered perfectly along the
index order.
10. In the On Dist Cols clause of the command syntax, the Frequency Option and
Quantile Option parameters are currently not supported for column GROUPS.
These options are supported for single columns.
11. There are three prefetch statistics that cannot be computed when working in
DMS mode. When looking at the index statistics in the index catalogs, you
will see a -1 value for the following statistics:
v AVERAGE_SEQUENCE_FETCH_PAGES
v AVERAGE_SEQUENCE_FETCH_GAP
v AVERAGE_RANDOM_FETCH_PAGES
12. A statistics profile can be set or updated for the table or statistical view
specified in the RUNSTATS command, by using the set profile or update profile
options. The statistics profile is stored in a visible string format, which
represents the RUNSTATS command, in the STATISTICS_PROFILE column of the
SYSCAT.TABLES system catalog table.
13. Statistics collection on XML type columns is governed by two DB2 database
system registry values: DB2_XML_RUNSTATS_PATHID_K and
DB2_XML_RUNSTATS_PATHVALUE_K. These two parameters are similar to the
NUM_FREQVALUES parameter in that they specify the number of frequency values
to collect. If not set, a default of 200 will be used for both parameters.
14. RUNSTATS acquires an IX table lock on SYSTABLES and a U lock on the row for
the table on which statistics are being gathered at the beginning of RUNSTATS.
Operations can still read from SYSTABLES including the row with the U lock.
Write operations are also possible, providing they do not occur against the
row with the U lock. However, another reader or writer will not be able
acquire an S lock on SYSTABLES because of RUNSTATS' IX lock.
15. Statistics are not collected for columns with structured types. If they are
specified, columns with these data types are ignored.
185
16. Only AVGCOLLEN and NUMNULLS are collected for columns with LOB or
LONG data types.
17. AVGCOLLEN represents the average space in bytes when the column is
stored in database memory or a temporary table. This value represents the
length of the data descriptor for LOB or LONG data types, except when LOB
data is inlined on the data page.
Note: The average space required to store the column on disk may be
different than the value represented by this statistic.
18. The UNSAMPLED DETAILED option is available to change the way index statistics
are collected, but it should be used only in cases where its clear that the
default or DETAILED doesn't work.
19. When using the INDEXSAMPLE keyword you cannot specify different index
sampling rates for different indexes within a single command. For example:
runstats on table orders and index o_ck indexsample system(5),
index o_ok indexsample system(10)
is invalid. The following two RUNSTATS commands can be used to achieve the
required result:
runstats on table orders and index o_ck indexsample system(5)
runstats on table orders for index o_ok indexsample system(10)
SET TAPE POSITION command using the ADMIN_CMD procedure:

Sets the positions of tapes for backup and restore operations to streaming tape
devices. This command is only supported on Windows operating systems.
Authorization
v SYSADM
v SYSCTRL
v SYSMAINT
Required connection
Database
Command syntax
SET TAPE POSITION
TO
ON
position
device
Command parameters
ON device
Specifies a valid tape device name. The default value is \\.\TAPE0. The
TO position
Specifies the mark at which the tape is to be positioned. DB2 for Windows
writes a tape mark after every backup image. A value of 1 specifies the
first position, 2 specifies the second position, and so on. If the tape is
positioned at tape mark 1, for example, archive 2 is positioned to be
restored.
186
Example
Because DB2 databases write a tape mark after every backup image, specifying a
position of 1 will move the tape to the start of the second archive on the tape.
CALL SYSPROC.ADMIN_CMD( set tape position to 1 )
Usage notes
statement.
UNQUIESCE DATABASE command using the ADMIN_CMD procedure:
Restores user access to databases which have been quiesced for maintenance or
other reasons. The UNQUIESCE command restores user access without necessitating a
shutdown and database restart.
Scope
UNQUIESCE DB restores user access to all objects in the quiesced database.
To stop the instance and unquiesce it and all its databases, issue the db2stop
command. Stopping and restarting DB2 will unquiesce all instances and databases.
Authorization
For database level unquiesce:
v SYSADM
v DBADM
Command syntax
UNQUIESCE DB
Required connection
Database
Command parameters
DB
Unquiesce the database. User access will be restored to all objects in the
database.
Example : Unquiescing a database

The following command unquiesces the database that had previously been
quiesced.
CALL SYSPROC.ADMIN_CMD( unquiesce db )
The following command will unquiesce the instance instA that had previously
been quiesced.
db2 unquiesce instance instA
187
Usage notes
statement.
v In a DB2 pureScale environment, after quiescing a database and restarting the
instance, the database will remain quiesced across all members. An explicit
UNQUIESCE DATABASE command is required to remove the quiesce state.
UPDATE ALERT CONFIGURATION command using the ADMIN_CMD
procedure:
Updates the alert configuration settings for health indicators.
Important: This command or API has been deprecated and might be removed in a
Authorization
v SYSADM
v SYSMAINT
v SYSCTRL
Required Connection
Database
Command Syntax
UPDATE ALERT
188
CONFIGURATION
CONFIG
CFG
FOR
DATABASE MANAGER
DB MANAGER
DBM
DATABASES
CONTAINERS
TABLESPACES
DATABASE
TABLESPACE tblspace-name
CONTAINER container-name FOR tblspace-name
ON database-alias
,
SET parameter-name value

,

,
UPDATE ACTION
SCRIPT pathname
TASK task-name
ON
WARNING
ALARM
ALLALERT
ATTENTION state
SCRIPT pathname
TASK task-name
ON
WARNING
ALARM
ALLALERT
ATTENTION state
,
DELETE ACTION
,
ADD ACTION
SCRIPT pathname
TASK task-name
Add Script Details
ON
State and User Details
Add Script Details:

TYPE
DB2
STATEMENT TERMINATION CHARACTER

character
STMT TERM CHAR
TERM CHAR
OPERATING SYSTEM
OS
COMMAND LINE PARAMETERS
parms
PARMS
WORKING DIRECTORY pathname
State and User Details:

WARNING
ALARM
ALLALERT
ATTENTION state
USER
ON
username USING
password
hostname
Command Parameters
DATABASE MANAGER
Updates alert settings for the database manager.
DATABASES
Updates alert settings for all databases managed by the database manager.
These are the settings that apply to all databases that do not have custom
settings. Custom settings are defined using the DATABASE ON database-alias
clause.
CONTAINERS
Updates alert settings for all table space containers managed by the
database manager. These are the settings that apply to all table space
containers that do not have custom settings. Custom settings are defined
using the CONTAINER container-name ON database-alias clause.
TABLESPACES
Updates alert settings for all table spaces managed by the database
manager. These are the settings that apply to all table spaces that do not
have custom settings. Custom settings are defined using the TABLESPACE
tblspace-name ON database-alias clause.
DATABASE ON database-alias
Updates the alert settings for the database specified using the ON
189
database-alias clause. If this database has custom settings, then they override
the settings for all databases for the instance, which is specified using the
DATABASES parameter.
CONTAINER container-name FOR tblspace-name ON database-alias
Updates the alert settings for the table space container called
container-name, for the table space specified using the FOR tblspace-name
clause, on the database specified using the ON database-alias clause. If this
table space container has custom settings, then they override the settings
for all table space containers for the database, which is specified using the
CONTAINERS parameter.
TABLESPACE tblspace-name ON database-alias
Updates the alert settings for the table space called name, on the database
specified using the ON database-alias clause. If this table space has custom
settings, then they override the settings for all table spaces for the
database, which is specified using the TABLESPACES parameter.
Specifies the set of health indicators for which alert configuration will be
updated. Health indicator names consist of a two-letter object identifier
followed by a name which describes what the indicator measures. For
example:
db.sort_privmem_util

Updates the alert configuration element, parameter-name, of the health
indicator to the specified value. parameter-name must be one of the
following values:
v ALARM: the value is a health indicator unit.
v WARNING: the value is a health indicator unit.
v SENSITIVITY: the value is in seconds.
v ACTIONSENABLED: the value can be either YES or NO.
v THRESHOLDSCHECKED: the value can be either YES or NO.
The list of possible health indicator units for your specific DB2 version can
be gathered by running the following query :
SELECT SUBSTR(UNIT,1,80) AS UNIT
FROM TABLE(HEALTH_GET_IND_DEFINITION()) AS T GROUP BY UNIT
UPDATE ACTION SCRIPT pathname ON [WARNING | ALARM | ALLALERT | ATTENTION state]

Specifies that the script attributes of the predefined script with absolute
path name pathname will be updated according to the following clause:
Updates the script attribute, parameter-name, to the specified value.
parameter-name must be one of the following values:
v SCRIPTTYPE
OS or DB2 are the valid types.
v WORKINGDIR
v TERMCHAR
v CMDLINEPARMS
The command line parameters that you specify for the operating
system script will precede the default supplied parameters. The
parameters that are sent to the operating system script are:
List of user supplied parameters
Health indicator short name
190
Fully qualified object name

Health indicator value
Alert state
v USERID
v PASSWORD
v SYSTEM
UPDATE ACTION TASK task-name ON [WARNING | ALARM | ALLALERT | ATTENTION state]
Specifies that the task attributes of the task with name name will be
updated according to the following clause:
Updates the task attribute, parameter-name, to the specified value.
parameter-name must be one of the following values:
v USERID
v PASSWORD
v SYSTEM
DELETE ACTION SCRIPT pathname ON [WARNING | ALARM | ALLALERT | ATTENTION state]
Removes the action script with absolute path name pathname from the list
of alert action scripts.
DELETE ACTION TASK task-name ON [WARNING | ALARM | ALLALERT | ATTENTION state]
Removes the action task called name from the list of alert action tasks.
ADD ACTION SCRIPT pathname ON [WARNING | ALARM | ALLALERT | ATTENTION state]
Specifies that a new action script with absolute path name pathname is to
be added, the attributes of which are given by the following:
TYPE
An action script must be either a DB2 Command script or an

operating system script:
v DB2
v OPERATING SYSTEM
If it is a DB2 Command script, then the following clause allows
one to optionally specify the character, character, that is used in the
script to terminate statements:
STATEMENT TERMINATION CHARACTER ;
If it is an operating system script, then the following clause allows

one to optionally specify the command-line parameters, parms, that
would be passed to the script upon invocation: COMMAND LINE
PARAMETERS parms
WORKING DIRECTORY pathname
Specifies the absolute path name, pathname, of the directory in
which the script will be executed.
USER username USING password
Specifies the user account, username, and associated password,
password, under which the script will be executed. When using the
ADD ACTION option, the username and password might be exposed in
the network (where the username and password are sent
unencrypted), to the db2diag log file, trace files, dump file,
snapshot monitor (dynamic SQL snapshot), system monitor
snapshots, a number of event monitors (such as statement,
deadlock), explain tables, db2pd output (such as package cache and
lock timeout mechanisms) and DB2 audit records.
191
ADD ACTION TASK name ON [WARNING | ALARM | ALLALERT | ATTENTION state]

Specifies that a new task, called name, is to be added to be run ON the
specified condition.
ON [WARNING | ALARM | ALLALERT | ATTENTION state]
Specifies the condition on which the action or task will run. For
threshold-based health indicators (HIs), this is WARNING or ALARM. For
state-based HIs, this can be a numeric state as documented for each
state-based HI (for example, for the ts.ts_op_status health indicator, refer to
the tablespace_state monitor element for table space states), or a text
identifier for this state. ALLALERTS handles any changes in the state for
threshold-based HIs and state-based HIs (for example, the state changes
from warning to normal).
ATTENTION state
Valid numeric values for some of the database health indicator
states are given in the following section, as an example for the ADD
ACTION SCRIPT CLP command option:
v 0 - Active; Normal (ACTIVE)
v 1 - Quiesce pending (QUIESCE_PEND)
v 2 - Quiesced (QUIESCED)
v 3 - Rollforward (ROLLFWD)
Additional state-based health indicators are defined in the header
files sqlmon.h and sqlutil.h.
The UPDATE ALERT CFG command called by the ADMIN_CMD
stored procedure supports either a numeric value or a text
identifier for state. Valid numeric values and text identifiers for
some additional health indicator states, as an example for the table
space operational status health indicator (ts.ts_op_status), are:
v 0x1 - QUIESCED_SHARE
v 0x2 - QUIESCED_UPDATE
v 0x4 - QUIESCED_EXCLUSIVE
Using the UPDATE ALERT CFG command and the health indicator
values listed previously, the following command line entry,
ADD ACTION SCRIPT ... ON ATTENTION 2
is equivalent to
ADD ACTION SCRIPT ... ON ATTENTION QUIESCED_UPDATE
In addition, for the table space operational status health indicator

(ts.ts_op_status), you can specify multiple states using a single
numeric value by OR'ing states together. For example, you can
specify state 7 (= 0x1 + 0x2 + 0x4), the action will be performed
when the table space enters any of the Quiesced: SHARE,
Quiesced: UPDATE or Quiesce: EXCLUSIVE states. Alternatively,
you could specify QUIESCED_SHARE, QUIESCED_UPDATE, and
QUIESCED_EXCLUSIVE in three separate UPDATE ALERT CFG
command executions.
192
Example
Add an action for the db.log_fs_util indicator that will execute the script
/home/test/scripts/logfsutilact when there is an alarm on the system with
hostname 'plato'.
CALL SYSPROC.ADMIN_CMD( update alert cfg for databases using
db.log_fs_util add action script /home/test/scripts/logfsutilact
type os command line parameters "param1 param2" working
directory /tmp on alarm on plato user dricard using mypasswdv )
To check the alert configuration after it has been set, you can use the
HEALTH_GET_IND_DEFINITION and HEALTH_GET_ALERT_ACTION_CFG
table functions as follows:
SELECT OBJECTTYPE, ID, CONDITION, ACTIONTYPE,
SUBSTR(ACTIONNAME,1,50) AS ACTION_NAME
FROM TABLE(SYSPROC.HEALTH_GET_ALERT_ACTION_CFG(DB,G,,))
AS ALERT_ACTION_CFG
The following is an example of output from this query:

OBJECTTYPE ID
CONDITION ACTIONTYPE ACTION_NAME
---------- ------ ---------- ---------- ---------------------------------DB
1006 ALARM
S
/home/dricard/scripts/logfsutilact
Usage notes
For the ADD ACTION option, the supplied username and password may be exposed in
various places where SQL statement text is captured:
v
v
v
v
v
the network (username/password are passed over the wire unencrypted)

db2diag log file
trace files
dump file
snapshot monitor (dynamic SQL snapshot)
v system monitor snapshots

v a number of event monitors (statement, deadlock)
v explain tables
v db2pd output (package cache and lock timeout mechanisms, among others)
v DB2 audit records
statement.
The database-alias must be defined in the catalog on the server and be local to the
server.
The pathname must be with a fully-qualified server path name.
UPDATE CONTACT command using the ADMIN_CMD procedure:
Updates the attributes of a contact that is defined on the local system. A contact is
a user to whom the Scheduler and Health Monitor send messages.
193
To create a contact, use the ADD CONTACT command. The setting of the Database
Administration Server (DAS) contact_host configuration parameter determines
whether the list is local or global.
Authorization
None
Required connection
Command syntax
,
UPDATE CONTACT name USING
keyword value
Command parameters
UPDATE CONTACT name
The name of the contact that will be updated.
USING keyword value
Specifies the contact parameter to be updated (keyword) and the value to
which it will be set (value). The valid set of keywords is:
ADDRESS
The email address that is used by the SMTP server to send the
notification.
TYPE
Whether the address is for an email address or a pager.
MAXPAGELEN
The maximum number of characters that the pager can accept.
DESCRIPTION
A textual description of the contact. This has a maximum length of
128 characters.
Example
Update the address of user 'test' to 'newaddress@test.com'.
CALL SYSPROC.ADMIN_CMD( update contact test using address newaddress@test.com )
Usage notes
statement.
UPDATE CONTACTGROUP command using the ADMIN_CMD procedure:
Updates the attributes of a contact group that is defined on the local system. A
contact group is a list of users who should be notified by the Scheduler and the
Health Monitor.
194

Authorization
None
Required Connection
Command Syntax
,
UPDATE CONTACTGROUP name
ADD
DROP
CONTACT
GROUP
name

DESCRIPTION new description
Command Parameters
CONTACTGROUP name
Name of the contact group which will be updated.
ADD CONTACT name
Specifies the name of the new contact to be added to the group. A contact
can be defined with the ADD CONTACT command after it has been added to a
group.
DROP CONTACT name
Specifies the name of a contact in the group that will be dropped from the
group.
ADD GROUP name
Specifies the name of the new contact group to be added to the group.
DROP GROUP name
Specifies the name of a contact group that will be dropped from the group.
DESCRIPTION new description
Optional. A new textual description for the contact group.
Example
Add the contact named 'cname2' to the contact group named 'gname1':
CALL SYSPROC.ADMIN_CMD( update contactgroup gname1 add contact cname2 )
Usage notes
statement.
195
UPDATE DATABASE CONFIGURATION command using the ADMIN_CMD

procedure:
Modifies individual entries in a specific database configuration file. A database
configuration file resides on every database partition on which the database has
been created.
Scope
This command updates all database partitions or members by default, except when
the following optional clause is specified:
v MEMBER to update only one database member for a DB2 pureScale environment,
or to update only one database partition in a partitioned database environment.
Authorization
v SYSADM
v SYSCTRL
v SYSMAINT
Required connection
Database. The database connection must be local to the instance containing the
connected database.
Command syntax
UPDATE
DATABASE
DB
CONFIGURATION
CONFIG
CFG

FOR
database-alias
USING config-keyword

value
value AUTOMATIC
AUTOMATIC
MANUAL
IMMEDIATE

DEFERRED
Command parameters
FOR database-alias
Specifies the alias of the database whose configuration is to be updated.
Specifying the database alias is not required when a database connection
has already been established. The database alias must be defined locally on
the server. You can update the configuration file for another database
residing under the same database instance. For example, if you are
connected only to database db11, and issue update db config for alias
db22 using .... immediate:
196
v If there is no active connection on db22, the update will be successful

because only the configuration file needs to be updated. A new
connection (which will activate the database) will see the new change in
memory.
v If there are active connections on db22 from other applications, the
update will work on disk but not in memory. You will receive a warning
saying that the database needs to be restarted.
The MEMBER clause specifies to which member the change should be
applied. Omission of this clause results in the change being applied to all
the members.
USING config-keyword value
config-keyword specifies the database configuration parameter to be
updated. value specifies the value to be assigned to the parameter.
AUTOMATIC
Some configuration parameters can be set to AUTOMATIC, allowing DB2
database systems to automatically adjust these parameters to reflect the
current resource requirements. For a list of configuration parameters that
support the AUTOMATIC keyword, refer to the configuration parameters
summary. If a value is specified along with the AUTOMATIC keyword, it
might influence the automatic calculations. For specific details about this
behavior, refer to the documentation for the configuration parameter.
Note: The appl_memory, logindexbuild, max_log and num_log_span
database configuration parameters can only be set to AUTOMATIC using the
command line processor.
MANUAL Disables automatic tuning for the configuration parameter. The parameter
is set to its current internal value and is no longer updated automatically.
IMMEDIATE
Make the changes immediately, while the database is running. IMMEDIATE is
the default action. Since the ADMIN_CMD procedure requires a database
connection, the changes will be effective immediately for any dynamically
configurable parameters for the connected database.
This is a default clause when operating in the CLPPlus interface as well.
IMMEDIATE need not be called when using CLPPlus processor.
DEFERRED
Make the changes only in the configuration file, so that the changes take
effect the next time you reactivate the database.
Example
Set the database configuration parameter sortheap to a value of 1000 on the
database partition to which the application is currently connected to.
CALL SYSPROC.ADMIN_CMD (UPDATE DB CFG USING sortheap 1000)
Usage notes
statement.
The database-alias must be an alias name that is defined on the server.
197
The command affects all database partitions unless MEMBER is specified.

To view or print a list of the database configuration parameters, use the
SYSIBMADM.DBCFG administration view.
To reset all the database configuration parameters to the recommended defaults,
use the RESET DATABASE CONFIGURATION command using the ADMIN_CMD
procedure.
To change a database configuration parameter, use the UPDATE DATABASE
CONFIGURATION command through the ADMIN_CMD procedure. For example, to
change the logging mode to archival logging on a single-partition database
environment containing a database called ZELLMART, use:
CALL SYSPROC.ADMIN_CMD (update db cfg for zellmart using logarchmeth1 logretain)
To check that the logarchmeth1 configuration parameter has changed, use:

SELECT * FROM SYSIBMADM.DBCFG WHERE NAME=logarchmeth1
To update a database configuration parameter on a specific database partition, you

can:
1. set the DB2NODE variable to a database partition number.
2. connect to the database partition.
3. update the database configuration parameters using UPDATE DATABASE
CONFIGURATION command through the ADMIN_CMD procedure.
4. disconnect from the database partition.
or you can use MEMBER. For example, to update the logging mode to only one
specific partition (30) using MEMBER, use:
CALL SYSPROC.ADMIN_CMD (update db cfg for zellmart member 30 using
logarchmeth1 logretain)
For more information about DB2 database configuration parameters and the values
available for each type of database node, see the individual configuration
parameter descriptions. The values of these parameters differ for each type of
database node configured (server, client, or server with remote clients).
Not all parameters can be updated.
Some changes to the database configuration file become effective only after they
are loaded into memory. All applications must disconnect from the database before
this can occur. For more information aboutwhich parameters are configurable
online and which ones are not, see summary list of configuration parameters.
If an error occurs, the database configuration file does not change. The database
configuration file cannot be updated if the checksum is invalid. This might occur if
the database configuration file is changed without using the appropriate command.
If this happens, the database must be restored to reset the database configuration
file.
Compatibilities
198
UPDATE DATABASE MANAGER CONFIGURATION command using the

Modifies individual entries in the database manager configuration file for the
instance that contains the currently connected database.
Authorization
SYSADM
Required connection
Database
Command syntax
UPDATE
DATABASE MANAGER
DB MANAGER
DBM
CONFIGURATION
CONFIG
CFG

MEMBER
member-number
DEFERRED
USING config-keyword
value
value AUTOMATIC
AUTOMATIC
MANUAL
Command parameters
The MEMBER clause specifies to which member the change should be
applied. Omission of this clause results in the change being applied to all
the members.
USING config-keyword value
Specifies the database manager configuration parameter to be updated. For
a list of configuration parameters, refer to the configuration parameters
summary. value specifies the value to be assigned to the parameter.
AUTOMATIC
Some configuration parameters can be set to AUTOMATIC, allowing DB2 to
automatically adjust these parameters to reflect the current resource
requirements. For a list of configuration parameters that support the
AUTOMATIC keyword, refer to the configuration parameters summary. If a
value is specified along with the AUTOMATIC keyword, it might influence the
automatic calculations. For specific details about this behavior, refer to the
documentation for the configuration parameter.
Note: Note that the federated_async database manager configuration
parameter can only be set to AUTOMATIC using the command line processor.
MANUAL Disables automatic tuning for the configuration parameter. The parameter
is set to its current internal value and is no longer updated automatically.
199
DEFERRED
Make the changes only in the configuration file, so that the changes take
effect when the instance is restarted. This is the default.
This is a default clause when operating in the CLPPlus interface. DEFERRED
need not be called when using CLPPlus processor.
Example
Update the diagnostic level to 1 for the database manager configuration.
CALL SYSPROC.ADMIN_CMD(db2 update dbm cfg using DIAGLEVEL 1)
Usage notes
To view or print a list of the database manager configuration parameters, use the
SYSIBMADM.DBMCFG administrative view. To reset the database manager
configuration parameters to the recommended database manager defaults, use the
RESET DATABASE MANAGER CONFIGURATION command through the ADMIN_CMD
procedure. For more information about database manager configuration parameters
and the values of these parameters appropriate for each type of database node
configured (server, client, or server with remote clients), see individual
configuration parameter descriptions.
Not all parameters can be updated.
Some changes to the database manager configuration file become effective only
after they are loaded into memory. For more information aboutwhich parameters
are configurable online and which ones are not, see the configuration parameter
summary. Server configuration parameters that are not reset immediately are reset
during execution of db2start. For a client configuration parameter, parameters are
reset the next time you restart the application. If the client is the command line
processor, it is necessary to invoke TERMINATE.
If an error occurs, the database manager configuration file does not change.
The database manager configuration file cannot be updated if the checksum is
invalid. This can occur if you edit database manager configuration file and do not
use the appropriate command. If the checksum is invalid, you must reinstall the
database manager to reset the database manager configuration file.
When you update the SVCENAME, or TPNAME database manager configuration
parameters for the current instance, if LDAP support is enabled and there is an
LDAP server registered for this instance, the LDAP server is updated with the new
value or values.
statement.
Updates can only be made to the database instance that contains the connected
database.
If a parameter supports dynamic update, an attempt is made to update it
dynamically, even if the IMMEDIATE keyword is not specified. The authorization
used is the current SYSTEM_USER id.
200
UPDATE HEALTH NOTIFICATION CONTACT LIST command using the

Updates the contact list for notification about health alerts issued by an instance.
Authorization
v SYSADM
v SYSCTRL
v SYSMAINT
Required Connection
Database
Command Syntax
UPDATE
HEALTH NOTIFICATION CONTACT

NOTIFICATION
LIST
,

ADD
DROP
CONTACT
GROUP
name
Command Parameters
ADD GROUP name
Add a new contact group that will notified of the health of the instance.
ADD CONTACT name
Add a new contact that will notified of the health of the instance.
DROP GROUP name
Removes the contact group from the list of contacts that will notified of the
health of the instance.
DROP CONTACT name
Removes the contact from the list of contacts that will notified of the health
of the instance.
Example
Add the contact group 'gname1' to the health notification contact list:
CALL SYSPROC.ADMIN_CMD( update notification list add group gname1 )
Usage note
statement.
201
UPDATE HISTORY command using the ADMIN_CMD procedure:

Updates the location, device type, comment, or status in a database history records
entry on the currently connected database partition.
Authorization
v SYSADM
v SYSCTRL
v SYSMAINT
v DBADM
Required connection
Database
Command syntax
UPDATE HISTORY
FOR
EID
object-part
eid
LOCATION new-location DEVICE TYPE

COMMENT new-comment
STATUS new-status
WITH
new-device-type
Command parameters
FOR object-part
Specifies the identifier for the history entry to be updated. It is a time
stamp with an optional sequence number from 001 to 999. This parameter
cannot be used to update the entry status. To update the entry status,
specify an EID instead.
EID eid Specifies the history entry ID.
LOCATION new-location
Specifies the new physical location of a backup image. The interpretation
of this parameter depends on the device type.
DEVICE TYPE new-device-type
Specifies a new device type for storing the backup image. Valid device
types are:
202
Disk
Diskette
Tape
Tivoli Storage Manager
Snapshot backup
Scripted snapshot backup
User exit
Pipe
Null device
XBSA
SQL statement
Other
COMMENT new-comment
Specifies a new comment to describe the entry.
STATUS new-status
Specifies a new status for an entry. Only backup entries can have their
status updated. Valid values are:
A
Active. The backup image is on the active log chain. Most entries
are active.
Inactive. Backup images that no longer correspond to the current

log sequence, also called the current log chain, are flagged as
inactive.
Expired. Backup images that are no longer required, because there

are more than NUM_DB_BACKUPS active images, are flagged as
expired.
Deleted. Backup images that are no longer available for recovery

should be marked as having been deleted.
Do not delete. Recovery database history records file entries that

are marked DB2HISTORY_STATUS_DO_NOT_DELETE will not be
pruned by calls to the PRUNE HISTORY command, running the
ADMIN_CMD procedure with PRUNE HISTORY, calls to the
db2Prune API, or automated recovery database history records
pruning. You can use the
DB2HISTORY_STATUS_DO_NOT_DELETE status to protect key
recovery file entries from being pruned and the recovery objects
associated with them from being deleted. Only log files, backup
images, and load copy images can be marked as
DB2HISTORY_STATUS_DO_NOT_DELETE.
Example
To update the database history records entry for a full database backup taken on
April 13, 1997 at 10:00 a.m., enter:
CALL SYSPROC.ADMIN_CMD(update history
for 19970413100000001 with location
/backup/dbbackup.1 device type D)
Usage notes
The primary purpose of the database history records is to record information, but
the data contained in the history is used directly by automatic restore operations.
During any restore where the AUTOMATIC option is specified, the history of backup
images and their locations will be referenced and used by the restore utility to
fulfill the automatic restore request. If the automatic restore function is to be used
and backup images have been relocated since they were created, it is
recommended that the database history record for those images be updated to
reflect the current location. If the backup image location in the database history is
not updated, automatic restore will not be able to locate the backup images, but
manual restore commands can still be used successfully.
203
statement.
The object-part or eid must refer to the log history entries on the connected database
partition.
UPDATE STMM TUNING command by using the ADMIN_CMD procedure:
Update the user preferred database member number on which the self-tuning
memory manager (STMM) tuner is created.
Authorization
The privileges that are held by the authorization ID of the statement must include
at least one of the following authorities:
v DBADM
v DATAACCESS
v SQLADM
Required connection
Database
Command syntax
UPDATE STMM TUNING MEMBER
member-number
Command parameter
member-number
The value of member-number is an integer.
In a partitioned database environment:
v If a valid member number is specified, DB2 database server runs the
STMM memory tuner on that member.
v If -1 or a nonexistent member number is specified, DB2 database server
selects an appropriate member on which to run the STMM memory
tuner.
In a DB2 pureScale environment:
v If a valid member number is specified, DB2 database server runs the
STMM memory tuner on that member.
v If -2 is specified, then the DB2 database server enables STMM tuners to
run and tune independently on each member.
v If -1 or a nonexistent member number is specified, DB2 database server
selects an appropriate member on which to run the STMM memory
tuner.
Example
In a partitioned database environment, update the user preferred self-tuning
memory manager (STMM) tuning database partition to member 3.
CALL SYSPROC.ADMIN_CMD(update stmm tuning member 3)
204
Usage notes
v The STMM tuning process periodically checks for a change in the user preferred
STMM tuning member number value. The STMM tuning process moves to the
user preferred STMM tuning member if member-number exists and is an active
member. After this command changes the STMM tuning member number, an
immediate change is made to the current STMM tuning member number.
statement.
v This command commits its changes in the ADMIN_CMD procedure.
Compatibilities
ADMIN_COPY_SCHEMA procedure - Copy a specific schema and

its objects
The ADMIN_COPY_SCHEMA procedure is used to copy a specific schema and all
objects contained in it. The new target schema objects will be created using the
same object names as the objects in the source schema, but with the target schema
qualifier.
The ADMIN_COPY_SCHEMA procedure can be used to copy tables with or
without the data of the original tables.
Syntax
ADMIN_COPY_SCHEMA (
sourceschema
objectowner , sourcetbsp
, targetschema
, targettbsp
, copymode
, errortabschema
, errortab

)
Procedure parameters
sourceschema
An input argument of type VARCHAR(128) that specifies the name of the
schema whose objects are being copied. The name is case-sensitive.
targetschema
An input argument of type VARCHAR(128) that specifies a unique schema
name to create the copied objects into. The name is case-sensitive. If the
schema name already exists, the procedure call will fail and return a message
indicating that the schema must be removed before invoking the procedure.
copymode
An input argument of type VARCHAR(128) that specifies the mode of copy
operation. Valid options are:
v 'DDL': create empty copies of all supported objects from the source schema.
v 'COPY': create empty copies of all objects from the source schema, then load
each target schema table with data. Load is done in 'NONRECOVERABLE'
mode. A backup must be taken after calling the ADMIN_COPY_SCHEMA,
otherwise the copied tables will be inaccessible following recovery.
205
v 'COPYNO': create empty copies of all objects from the source schema, then
load each target schema table with data. Load is done in 'COPYNO' mode.
Note: If copymode is 'COPY' or 'COPYNO', a fully qualified filename, for
example 'COPYNO /home/mckeough/loadoutput', can be specified along
with the copymode parameter value. When a path is passed in, load messages
will be logged to the file indicated. The file name must be writable by the user
ID used for fenced routine invocations on the instance. If no path is specified,
then load message files will be discarded (default behavior).
objectowner
An input argument of type VARCHAR(128) that specifies the authorization ID
to be used as the owner of the copied objects. If NULL, then the owner will be
the authorization ID of the user performing the copy operation.
sourcetbsp
An input argument of type CLOB(2 M) that specifies a list of source table
spaces for the copy, separated by commas. Delimited table space names are
supported. For each table being created, any table space found in this list, and
the tables definition, will be converted to the nth entry in the targettbsp list. If
NULL is specified for this parameter, new objects will be created using the
same table spaces as the source objects use.
targettbsp
An input argument of type CLOB(2 M) that specifies a list of target table
spaces for the copy, separated by commas. Delimited table space names are
supported. One table space must be specified for each entry in the sourcetbsp
list of table spaces. The nth table space in the sourcetbsp list will be mapped to
the nth table space in the targettbsp list during DDL replay. It is possible to
specify 'SYS_ANY' as the final table space (an additional table space name, that
does not correspond to any name in the source list). When 'SYS_ANY' is
encountered, the default table space selection algorithm will be used when
creating objects (refer to the IN tablespace-name1 option of the CREATE TABLE
statement documentation for further information about the selection
algorithm). If NULL is specified for this parameter, new objects will be created
using the same table spaces as the source objects use.
errortabschema
An input and output argument of type VARCHAR(128) that specifies the
schema name of a table containing error information for objects that could not
be copied. This table is created for the user by the ADMIN_COPY_SCHEMA
procedure in the SYSTOOLSPACE table space. If no errors occurred, then this
parameter is NULL on output.
errortab
An input and output argument of type VARCHAR(128) that specifies the name
of a table containing error information for objects that could not be copied.
This table is created for the user by the ADMIN_COPY_SCHEMA procedure in
the SYSTOOLSPACE table space. This table is owned by the user ID that
invoked the procedure. If no errors occurred, then this parameter is NULL on
output. If the table cannot be created or already exists, the procedure operation
fails and an error message is returned. The table must be cleaned up by the
user following any call to the ADMIN_COPY_SCHEMA procedure; that is, the
table must be dropped in order to reclaim the space it is consuming in
SYSTOOLSPACE.
206
Table 61. ADMIN_COPY_SCHEMA errortab format

Column name
Data type
Description
OBJECT_SCHEMA
VARCHAR(128)
object_schema - Object
schema monitor element
OBJECT_NAME
VARCHAR(128)
object_name - Object name

monitor element
OBJECT_TYPE
VARCHAR(30)
objtype - Object type monitor

element
SQLCODE
INTEGER
The error SQLCODE.
SQLSTATE
CHAR(5)
The error SQLSTATE.
ERROR_TIMESTAMP
TIMESTAMP
Time of failure for the

operation that failed.
STATEMENT
CLOB(2 M)
DDL for the failing object. If

the failure occurred when
data was being loaded into a
target table, this field
contains text corresponding
to the load command that
failed.
DIAGTEXT
CLOB(2 K)
Error message text for the

failed operation.
Authorization
In order for the schema copy to be successful, the user must have the
CREATE_SCHEMA privilege as well as DB2 object-specific privileges.
Example: CREATE_TABLE privilege is needed to copy a table and CREATE_INDEX
privilege is needed to copy an index under the ADMIN_COPY_SCHEMA
command.
If a table in the source schema is protected by label based access control (LBAC),
the user ID must have LBAC credentials that allow creating that same protection
on the target table. If copying with data, the user ID must also have LBAC
credentials that allow both reading the data from the source table and writing that
data to the target table.
EXECUTE privilege on the ADMIN_COPY_SCHEMA procedure is also needed.

Example
CALL SYSPROC.ADMIN_COPY_SCHEMA(SOURCE_SCHEMA, TARGET_SCHEMA,
COPY, NULL, SOURCETS1 , SOURCETS2, TARGETTS1, TARGETTS2,
SYS_ANY, ERRORSCHEMA, ERRORNAME)
Restrictions
v Only DDL copymode is supported for HADR databases.
v XML with COPY or COPY NO is not supported.
207
v Using the ADMIN_COPY_SCHEMA procedure with the COPYNO option places

the table spaces in which the target database object resides in backup pending
state. After the load operation completes, target schema tables are in set integrity
pending state, and the ADMIN_COPY_SCHEMA procedure issues a SET
INTEGRITY statement to get the tables out of this state. Because the table spaces
are already in backup pending state, the SET INTEGRITY statement fails. For
information about how to resolve this problem, see Copying a schema.
Usage notes
v References to fully qualified objects within the objects being copied will not be
modified. The ADMIN_COPY_SCHEMA procedure only changes the qualifying
schema of the object being created, not any schema names that appear within
SQL expressions for those objects. This includes objects such as generated
columns and trigger bodies.
v This procedure does not support copying the following objects:
index extensions
nicknames
packages
typed tables
array types
user-defined structured types (and their transform functions)
typed views
jars (Java routine archives)
staging tables
aliases with base objects that do not belong to the same source schema
v If one of these objects exists in the schema being copied, the object is not copied
but an entry is added to the error table indicating that the object has not been
copied.
v When a replicated table is copied, the new copy of the table does not have
subscriptions enabled. The table is re-created as a basic table only.
v The operation of this procedure requires the existence of the SYSTOOLSPACE
table space. This table space is used to hold metadata used by the
ADMIN_COPY_SCHEMA procedure as well as error tables returned by this
procedure. If the table space does not exist, an error is returned.
v Statistics for the objects in the target schema are set to default.
v If a table has a generated identity column, and copymode is either 'COPY' or
'COPYNO', the data values from the source table are preserved during the load.
v A new catalog entry is created for each external routine, referencing the binary
of the original source routine.
v If a table is in set integrity pending state at the beginning of the copy operation,
the data is not loaded into the target table and an entry is logged in errortab
indicating that the data was not loaded for that table.
v If a Load or DDL operation fails, an entry is logged in errortab for any object that
was not created. All objects that are successfully created remain. To recover, a
manual load can be initiated, or the new schema can be dropped using the
ADMIN_DROP_SCHEMA procedure and the ADMIN_COPY_SCHEMA
procedure can be called again.
v During DDL replay, the default schema is overridden to the target schema if it
matches the source schema.
208
v The function path used to compile a trigger, view or SQL function is the path
used to create the source object, with the following exception: if the object's
function path contains the source schema name, this entry in the path is
modified to the target schema name during DDL replay.
v Running multiple ADMIN_COPY_SCHEMA procedures will result in deadlocks.
Only one ADMIN_COPY_SCHEMA procedure call should be issued at a time.
Changes to tables in the source schema during copy processing might mean that
the data in the target schema is not identical following a copy operation.
v Careful consideration should be taken when copying a schema with tables from
a table space in a single-partition database partition group to a table space in a
multiple-partition database partition group. Unless automatic distribution key
selection is preferred, the distribution key should be defined on the tables before
the copy schema operation is undertaken. Altering the distribution key can only
be done to a table whose table space is associated with a single-partition
Transactional considerations
v If the ADMIN_COPY_SCHEMA procedure is forced to roll back due to a
deadlock or lock timeout during its processing, any work performed in the unit
of work that called the ADMIN_COPY_SCHEMA procedure is also rolled back.
v If a failure occurs during the DDL phase of the copy, all the changes that were
made to the target schema are rolled back to a savepoint.
v If copymode is set to 'COPY' or 'COPYNO', the ADMIN_COPY_SCHEMA
procedure commits once the DDL phase of the copy is complete, also
committing any work done in the unit of work that called the procedure.
ADMIN_DROP_SCHEMA procedure - Drop a specific schema and

its objects
The ADMIN_DROP_SCHEMA procedure is used to drop a specific schema and all
objects contained in it.
Syntax
ADMIN_DROP_SCHEMA (
schema
, dropmode
, errortabschema
errortab )
schema
schema being dropped. The name must be specified in uppercase characters.
dropmode
Reserved for future use and should be set to NULL.
errortabschema
An input and output argument of type VARCHAR(128) that specifies the
schema name of a table containing error information for objects that could not
be dropped. The name is case-sensitive. This table is created for the user by the
ADMIN_DROP_SCHEMA procedure in the SYSTOOLSPACE table space. If no
errors occurred, then this parameter is NULL on output.
209
errortab
An input and output argument of type VARCHAR(128) that specifies the name
of a table containing error information for objects that could not be dropped.
The name is case-sensitive. This table is created for the user by the
ADMIN_DROP_SCHEMA procedure in the SYSTOOLSPACE table space. This
table is owned by the user ID that invoked the procedure. If no errors
occurred, then this parameter is NULL on output. If the table cannot be created
or already exists, the procedure operation fails and an error message is
returned. The table must be cleaned up by the user following any call to
ADMIN_DROP_SCHEMA; that is, the table must be dropped in order to
reclaim the space it is consuming in SYSTOOLSPACE.
Table 62. ADMIN_DROP_SCHEMA errortab format
Column name
Data type
Description
OBJECT_SCHEMA
VARCHAR(128)
OBJECT_NAME
VARCHAR(128)

monitor element
OBJECT_TYPE
VARCHAR(30)

element
SQLCODE
INTEGER
The error SQLCODE.
SQLSTATE
CHAR(5)
The error SQLSTATE.
ERROR_TIMESTAMP
TIMESTAMP
Time that the drop command

failed.
STATEMENT
CLOB(2 M)
DDL for the failing object.
DIAGTEXT
CLOB(2 K)
Error message text for the

failed drop command.
Authorization
One of the following authorizations is required:
v EXECUTE privilege on the ADMIN_DROP_SCHEMA procedure
v DBADM authority
v SQLADM authority
In addition, drop authority is needed on all objects being removed for the user
calling this procedure.

Example
CALL SYSPROC.ADMIN_DROP_SCHEMA(SCHNAME, NULL, ERRORSCHEMA, ERRORTABLE)
The following is an example of output for this procedure.

Value of output parameters
-------------------------Parameter Name : ERRORTABSCHEMA
Parameter Value : ERRORSCHEMA <-- error!
210
Parameter Name : ERRORTAB

Parameter Value : ERRORTABLE <-- error!
Return Status = 0
The return status is not zero only when an internal error has been detected (for
example, if SYSTOOLSPACE does not exist).
Errors can be checked by querying the error table:
SELECT * FROM ERRORSCHEMA.ERRORTABLE
Usage notes
v If objects in another schema depend on an object being dropped, the default
DROP statement semantics apply.
v This procedure does not support dropping the following objects:
Index extensions
Nicknames
Packages
Typed tables
Array types
User-defined structured types (and their transform functions)
Typed views
Jars (Java routine archives)
Staging tables
XSR objects
v If one of these objects exists in the schema being dropped, neither the object nor
the schema is dropped, and an entry is added to the error table indicating that
the object was not dropped.
v The operation of this procedure requires the existence of the SYSTOOLSPACE
table space. This table space is used to hold metadata used by the
ADMIN_DROP_SCHEMA procedure as well as error tables returned by this
procedure. If the table space does not exist, an error is returned.
ADMIN_EST_INLINE_LENGTH function - Estimate length required

to inline data
The ADMIN_EST_INLINE_LENGTH function returns an estimate of the inline
length that is required to inline the data stored in an XML column, BLOB column,
CLOB column, or DBCLOB column.
If the data cannot be inlined, the function returns a negative value.
If the data is already inlined, the function returns the actual length of the inlined
data.
Syntax
ADMIN_EST_INLINE_LENGTH (
column-name
The schema is SYSIBM.
211
Return value
This function returns either an INTEGER value that represents the estimated inline
length (in bytes) of the data, or one of the following values:
NULL Indicates that the inputs are NULL.
-1
Indicates that the data cannot be inlined because there is no valid inline
length that would allow the column value to be inlined.
-2
Indicates that the estimated inline length of the document cannot be

determined because the document was inserted and stored in a release
before DB2 for Linux, UNIX, and Windows Version 9.7.
Function parameters
column-name
Identifies a column of the base table with a data type of XML, BLOB, CLOB, or
DBCLOB (SQLSTATE 42884). The column must directly or indirectly reference
the column of a base table that is not generated based on an expression
(SQLSTATE 42815).
Example
Example 1: The following example returns the estimated inline length of three XML
documents that are contained in XML column xml_doc1 of TAB1 table.
db2 => SELECT PK, ADMIN_IS_INLINED(xml_doc1) as IS_INLINED,
ADMIN_EST_INLINE_LENGTH(xml_doc1) as EST_INLINE_LENGTH
from TAB1
This query results in the following output:

PK
IS_INLINED EST_INLINE_LENGTH
----------- ---------- ----------------1
1
292
2
0
450
3
0
454
In the example, the ADMIN_IS_INLINED function indicates that the first

document is inlined. Therefore, the ADMIN_EST_INLINE_LENGTH function
returns the actual length of the inlined XML document. The second document is
not inlined, so the ADMIN_EST_INLINE_LENGTH function returns the estimated
inline length that is required to inline the second XML document.
Example 2: The following example returns the estimated inline length of one XML
document that is contained in the XML column xml_doc1 of the TAB1 table. This
example includes a predicate.
db2 => SELECT PK, ADMIN_IS_INLINED(xml_doc1) as IS_INLINED,
ADMIN_EST_INLINE_LENGTH(xml_doc1) as EST_INLINE_LENGTH
from TAB1 where PK=2

PK
----------- ---------- ----------------2
0
450
212
Example 3: The following example returns the estimated inline length of three
CLOB data that are contained in CLOB column clob_1 of the TAB1 table.
db2 => SELECT PK, ADMIN_IS_INLINED(clob_1) as IS_INLINED,
ADMIN_EST_INLINE_LENGTH(clob_1) as EST_INLINE_LENGTH
from TAB1

PK
----------- ---------- ----------------1
1
68
2
0
3665
3
0
-1
Usage notes
v XML columns are only supported when the XML documents were inserted using
DB2 for Linux, UNIX, and Windows Version 9.7 or later. XML documents
inserted before this release have a different storage format. When the
ADMIN_EST_INLINE_LENGTH function encounters an incorrect storage format,
it returns a value of -2.
v If you plan to increase the column inline length, remember that this length
cannot be reduced.
v Increasing the inline length also increases the total row size and might affect the
performance of buffer pools. The total row size has the following limits.
Table 63. Row size limits
Page size
Row size limit
Inline length limit
4K
4005
4001
8K
8101
8097
16K
16 293
16 289
32K
32 677
32 673
v The estimated inline length might not be accurate if the XML storage object page
size is not same as the base table page size.
ADMIN_GET_INDEX_COMPRESS_INFO table function - returns

compressed index information
The ADMIN_GET_INDEX_COMPRESS_INFO table function returns the potential
index compression savings for uncompressed indexes.
Syntax
ADMIN_GET_INDEX_COMPRESS_INFO ( objecttype , objectschema , objectname ,
member , datapartitionid )
Table function parameters

objecttype
An input argument of type VARCHAR(1) that indicates the object type. The
value must be one of the following case-sensitive values:
v 'T', NULL, or the empty string to indicate a table
213
'I' for an index
objectschema
A case-sensitive input parameter of type VARCHAR(128) that specifies the
object schema.
If objecttype is 'T', NULL, or the empty string ("), then objectschema indicates the
table schema.
v If objectschema is specified and objectname is NULL or the empty string ("),
then information is returned for all indexes on all tables in the specified
schema.
v If both objectschema and objectname are specified, then information is returned
for all indexes on the specified table.
If objecttype is 'I', then objectschema indicates the index schema.
then information is returned for all indexes in the specified schema.
for the specified index.
v If neither objectschema or objectname are specified, then information is
returned for all indexes in all of the schemas.
If objectname is specified and objectschema is not specified, the function returns
an SQL error. A parameter value is said to be unspecified when either it has a
value of NULL or the empty string (").
objectname
object name. See the description for the objectschema parameter.
member
An input parameter of type INTEGER that specifies a database member
number. When specified, information is returned only for indexes that reside
on the specified database member. To specify that data should be returned for
all active database members, set the member parameter value to either -2 or
NULL. In single-member environments, specify -2 or NULL.
datapartitionid
An input parameter of type INTEGER that specifies the data partition ID.
When specified, information is returned only for index partitions defined on
the specified data partitions. The data partition ID should correspond to the
DATAPARTITIONID found in the SYSCAT.DATAPARTITIONS view. To specify
that data should be returned for all data partitions, set the datapartitionid
parameter value to either -2 or NULL. For nonpartitioned indexes, specify -2,
0, or NULL.
Authorization
v DBADM authority
v SQLADM authority
214

function is automatically created.
Usage notes
v Do not use this function on existing indexes to get actual compression savings;
instead run the RUNSTATS command (if statistics are not up to date), then
query either or both of the following catalog values:
SYSCAT.INDEXES.PCTPAGESSAVED
SYSCAT.INDEXPARTITIONS.PCTPAGESSAVED
Example
After database migration, all the existing indexes are uncompressed. You may want
to estimate the potential index compression savings for existing indexes on the
table "S.T1", which has a data partition ID of 3 and resides on database partition
number 2. In this example, S is the schema name and T1 is the table name, and T1
is not compressed
SELECT compress_attr, iid, dbpartitionnum, index_compressed,
pct_pages_saved, num_leaf_pages_saved
FROM TABLE(sysproc.admin_get_index_compress_info(, S, T1, 2, 3))
AS t
The following is a sample of the output from this statement.

COMPRESS_ATTR
IID DBPARTITIONNUM INDEX_COMPRESSED ...
------------- --------- -------------- ---------------- ...
N
1
2 N
...
N
2
2 N
...
... PCT_PAGES_SAVED NUM_LEAF_PAGES_SAVED
... --------------- -------------------...
50
200
...
45
150
You may decide that the savings from compression are worthwhile, and you want
to enable index compression.
ALTER INDEX INDEX1 compress yes
ALTER INDEX INDEX2 compress yes
REORG INDEXES all FOR table S.T1
As time passes, you may determine the need to create new indexes for the table
and want to estimate index compression savings for these indexes before
compressing them. You may also want to see the compression statistics from
already compressed indexes.
AS t

COMPRESS_ATTR
------------- --------- -------------- ---------------- ...
Y
1
2 Y
...
Y
2
2 Y
...
N
3
2 N
...
N
4
2 N
...
215

... --------------- -------------------...
-1
-1
...
-1
-1
...
58
230
...
49
140
As the first two indexes were already compressed, as indicated by the

index_compressed column, the statement returns values from the system catalogs.
In this case, the values from the catalogs were not collected.
After running RUNSTATS on the table, the next run of the index function yields
the corrected results.
RUNSTATS ON TABLE S.T1 FOR INDEXES ALL
AS t

COMPRESS_ATTR
------------- --------- -------------- ---------------- ...
Y
1
2 Y
...
Y
2
2 Y
...
N
3
2 N
...
N
4
2 N
...
... --------------- -------------------...
50
200
...
45
150
...
58
230
...
49
140
Information returned
Table 64. Information returned by ADMIN_GET_INDEX_COMPRESS_INFO
Column Name
Data Type
Description
INDSCHEMA
VARCHAR(128) index_schema - Index schema monitor element
INDNAME
VARCHAR(128) index_name - Index name monitor element
TABSCHEMA
VARCHAR(128) table_schema - Table schema name monitor element
TABNAME
VARCHAR(128) table_name - Table name monitor element
DBPARTITIONNUM
SMALLINT
dbpartitionnum - Database partition number monitor element
IID
SMALLINT
iid - Index identifier monitor element
DATAPARTITIONID
INTEGER
Data partition ID.
COMPRESS_ATTR
CHAR(1)
The state of the COMPRESSION attribute on the index.

v Y = Index compression is enabled
v
INDEX_COMPRESSED
CHAR(1)
N = Index compression is not enabled
Physical index format.

v Y = Index is in compressed format
v
N = Index is in uncompressed format
If the physical index format does not match the compression

attribute, an index reorganization is needed to convert index to
the defined format If the table or index is in error at the time
this function is executed, then this value is NULL.
216
Table 64. Information returned by ADMIN_GET_INDEX_COMPRESS_INFO (continued)

Column Name
Data Type
Description
PCT_PAGES_SAVED
SMALLINT
If the index is not physically compressed

(INDEX_COMPRESSED is N), then this value represents the
estimated percentage of leaf pages saved, as if the index were
actually compressed. If the index is physically compressed
(INDEX_COMPRESSED is Y), then this value reports the
PCTPAGESSAVED value from the system catalog view (either
SYSCAT.INDEXES or SYSCAT.INDEXPARTITIONS).
Note: This value is the same for each entry of an index or index
partition for each database partition in a partitioned database
environment. If the table or index is in error at the time this
function is executed, then this value is NULL.
NUM_LEAF_PAGES_SAVED
BIGINT
If the index is not physically compressed

(INDEX_COMPRESSED is N), then this value represents the
estimated number of leaf pages saved as if the index were
actually compressed. If the index is physically compressed
(INDEX_COMPRESSED is Y), then this value reports the
calculated number of leaf pages saved, based on the
PCTPAGESSAVED and NLEAF values from the system catalog
view (either SYSCAT.INDEXES or SYSCAT.INDEXPARTITIONS).
If either PCTPAGESSAVED or NLEAF are invalid values (-1),
then this value is set to -1 as well.
Note: This value is the same for each entry of an index or index
partition for each database partition in a partitioned database
environment. If the table or index is in error at the time this
ADMIN_GET_INDEX_INFO table function - returns index

information
The ADMIN_GET_INDEX_INFO table function returns index information not
available in the catalog views, such as compression information and the logical and
physical size of the index.
Syntax
ADMIN_GET_INDEX_INFO (
objecttype
, objectschema
objectname

objecttype
value must be one of the following case-sensitive values:
v 'T', NULL, or the empty string (") to indicate a table
v 'I' for an index
objectschema
object schema.
If objecttype is 'T', NULL, or the empty string (''), thenobjectschema indicates the
table schema.
217
v If objectschema is specified and objectname is NULL or the empty string (''),

then information is returned for all indexes on all tables in the specified
schema.
for all indexes on the specified table.
If objecttype is 'I', then objectschema indicates the index schema.
then information is returned for all indexes in the specified schema.
for the specified index.
v If neither objectschema or objectname are specified, then information is
returned for all indexes in all of the schemas.
If objectname is specified and objectschema is not specified, the function returns
an SQL error. A parameter value is said to be unspecified when either it has a
value of NULL or the empty string (").
objectname
object name. See the description for the objectschema parameter.
Authorization
v DBADM authority
v SQLADM authority

Example
After enabling index compression for several indexes on a table, you want to
determine which indexes are compressed and which indexes require a rebuild in
order to be compressed. In this example, S is the schema name and T1 is the table
name.
db2 SELECT iid, compress_attr, index_compressed
FROM TABLE(sysproc.admin_get_index_info(,S,T1)) AS t

IID
--------1
2
3
4
COMPRESS_ATTR
------------Y
Y
Y
N
INDEX_COMPRESSED
---------------Y
Y
N
N
Additionally, you want to see other index information for all indexes in the schema
S2. In this example:
v T2 = a partitioned table with two data partitions
v T3 = a nonpartitioned table
218
v
v
v
v
v
IND_1
IND_2
IND_3
IND_4
IND_5
=
=
=
=
=
a nonpartitioned index on T2
a partitioned index on T2
a partitioned index on T2
an index on T3
an index on T3
db2 SELECT tabname, indname, iid,index_partitioning, datapartitionid,

index_object_l_size, index_object_p_size, index_requires_rebuild,
large_rids FROM TABLE(sysproc.admin_get_index_info(I,S2,)) AS t
The following is an example of the output from this query.

TABNAME
------T2
T2
T2
T2
T2
T3
T3
INDNAME IID
------- --------IND_1
1
IND_2
2
IND_2
2
IND_3
3
IND_3
3
IND_4
4
IND_5
5
INDEX_PARTITIONING DATAPARTITIONID
------------------ --------------N
0
P
1
P
2
P
1
P
2
0
0
Output from this procedure (continued):

INDEX_OBJECT_L_SIZE INDEX_OBJECT_P_SIZE INDEX_REQUIRES_REBUILD LARGE_RIDS
------------------- ------------------- ---------------------- ---------50
51
N
Y
40
40
N
Y
45
45
N
Y
40
40
N
Y
45
45
N
Y
20
20
N
Y
20
20
N
Y
Table 65. Information returned by ADMIN_GET_INDEX_INFO
Column Name
Data Type
Description
INDSCHEMA
VARCHAR(128) index_schema - Index schema monitor element
INDNAME
VARCHAR(128) index_name - Index name monitor element
TABSCHEMA
VARCHAR(128) table_schema - Table schema name monitor element
TABNAME
VARCHAR(128) table_name - Table name monitor element
DBPARTITIONNUM
SMALLINT
IID
SMALLINT
iid - Index identifier monitor element
DATAPARTITIONID
INTEGER
Data partition ID.
COMPRESS_ATTR
CHAR(1)
The state of the COMPRESSION attribute on the index.

v Y = Index compression is enabled
v N = Index compression is not enabled
INDEX_COMPRESSED
CHAR(1)
Physical index format.

v Y = Index is in compressed format
v N = Index is in uncompressed format
If the physical index format does not match the compression
attribute, an index reorganization is needed to convert the index
to the defined format. If the table or index is in error when this
219
Table 65. Information returned by ADMIN_GET_INDEX_INFO (continued)

Column Name
Data Type
Description
INDEX_PARTITIONING
CHAR(1)
Identifies the partitioning characteristic of the index.

v N = Nonpartitioned index
v P = Partitioned index
v Blank = Index is not on a partitioned table
INDEX_OBJECT_L_SIZE
BIGINT
Logical size of the index object. For nonpartitioned tables, this is

the amount of disk space logically allocated for all indexes
defined on the table. For a nonpartitioned index on a partitioned
table, this is the amount of disk space logically allocated for the
index. For a partitioned index on a partitioned table, this is the
amount of disk space logically allocated for all index partitions
defined on the data partition. All sizes are reported in kilobytes
(KB).
The logical size is the amount of space that the table or data
partition knows about. It may be less than the amount of space
physically allocated to hold index data for the table or data
partition (for example, in the case of a logical table truncation).
The size returned takes into account full extents that are
logically allocated for the indexes and, for indexes created in
DMS table spaces, an estimate of the EMP extents. If the table or
index is in error when this function is executed, then this value
is NULL.
INDEX_OBJECT_P_SIZE
BIGINT
Physical size of the index object. For nonpartitioned tables, this

is the amount of disk space physically allocated for all indexes
defined on the table. For a nonpartitioned index on a partitioned
table, this is the amount of disk space physically allocated for
the index. For a partitioned index on a partitioned table, this is
the amount of disk space physically allocated for all index
partitions defined on the data partition. All sizes are reported in
kilobytes (KB).
The size returned takes into account full extents allocated for the
indexes and includes the EMP extents for indexes created in
DMS table spaces. If the table or index is in error when this
INDEX_REQUIRES_REBUILD
CHAR(1)
Rebuild status for the index.

v Y if the index defined on the table or data partition requires
a rebuild
v N otherwise
If the table is in error when this function is executed, then this
value is NULL.
LARGE_RIDS
CHAR(1)
Indicates whether or not the index is using large row IDs (RIDs)
(4 byte page number, 2 byte slot number).
v Y indicates that the index is using large RIDs
v N indicates that the index is not using large RIDs
v P (pending) indicates that the table that the index is defined
on supports large RIDs (that is, the table is in a large table
space), but the index for the table or data partition has not
been reorganized or rebuilt yet. Therefore, the table is still
using 4 byte RIDs, and action must be taken to convert the
table or index to large RIDs.
If the table is in error where this function is executed, then this
value is NULL.
220
Table 65. Information returned by ADMIN_GET_INDEX_INFO (continued)

Column Name
Data Type
Description
RECLAIMABLE_SPACE
BIGINT
This value applies only to an index in a DMS table space. This

value is an estimate of disk space, in kilobytes, that can be
reclaimed from the entire index object by running the REORG
INDEXES or REORG INDEX command with the RECLAIM EXTENTS
option. For any index not defined in a DMS table space, the
value is zero. If the table or index is in error when this function
is executed, then this value is NULL.
ADMIN_GET_INTRA_PARALLEL - Get intrapartition parallelism

state
The ADMIN_GET_INTRA_PARALLEL scalar function returns the current state of
intrapartition parallelism for the application. It can be used to check if current
statements are running with parallelized query access plan.
Syntax
ADMIN_GET_INTRA_PARALLEL (
Authorization
v DBADM authority
v SQLADM authority

None
This function returns a value of type VARCHAR(3) that specifies the current state
of intrapartition parallelism for the database application. One of the following
values is returned:
YES
The database application will run with intrapartition parallelism enabled.
NO
The database application will run with intrapartition parallelism disabled.
Example
Find the current state of intrapartition parallelism from DB2 CLP:
VALUES SYSPROC.ADMIN_GET_INTRA_PARALLEL
1
--NO
221
Usage notes
The value returned by ADMIN_GET_INTRA_PARALLEL can be different from the
state set by ADMIN_SET_INTRA_PARALLEL in the following cases:
v ADMIN_SET_INTRA_PARALLEL was called during a transaction and the
transaction is not yet committed or rolled back.
v ADMIN_SET_INTRA_PARALLEL was called during a transaction that opens a
with hold cursor and the current transaction has not yet closed the cursor.
v The application is associated with a DB2 workload, which has a value applied to
the MAX DEGREE workload attribute that is different than the one specified by
the call to ADMIN_SET_INTRA_PARALLEL.
ADMIN_GET_MEM_USAGE table function - Get total memory

consumption for instance
The ADMIN_GET_MEM_USAGE table function gets the total memory
consumption for a given instance.
Syntax
ADMIN_GET_MEM_USAGE (
member

member
An optional input argument of type integer that specifies the member from
which the memory usage statistics are retrieved. If -1 or the NULL value is
specified, data is returned from the currently connected member.
Authorization
v DBADM authority
v SQLADM authority

None
Table 66. Information returned for ADMIN_GET_MEM_USAGE
Column Name
Data type
Description
MEMBER
SMALLINT
member - Database member monitor

element
MAX_MEMBER_MEM
BIGINT
The maximum amount of memory

(in bytes) available for the member.
CURRENT_MEMBER_MEM
BIGINT
The amount of memory (in bytes)

currently used by the member.
222
Table 66. Information returned for ADMIN_GET_MEM_USAGE (continued)

Column Name
Data type
Description
PEAK_MEMBER_MEM
BIGINT
The peak or high watermark of

memory (in bytes) used by the
member since the instance started.
Examples
Example 1: Report memory usage for all members
SELECT MEMBER, MAX_MEMBER_MEM, CURRENT_MEMBER_MEM, PEAK_MEMBER_MEM
FROM TABLE(SYSPROC.ADMIN_GET_MEM_USAGE()) AS T
MEMBER MAX_MEMBER_MEM
CURRENT_MEMBER_MEM
PEAK_MEMBER_MEM
------ -------------------- -------------------- -------------------0
7430103040
958169088
958300160
3
7430103040
951615488
951615488
1
7430103040
952664064
952664064
2
7430103040
951615488
951615488
ADMIN_GET_MSGS table function - Retrieve messages

generated by a data movement utility that is executed through
the ADMIN_CMD procedure
The ADMIN_GET_MSGS table function is used to retrieve messages generated by
a single execution of a data movement utility command through the ADMIN_CMD
procedure.
The input parameter operation_id identifies that operation.
Syntax
ADMIN_GET_MSGS (
operation_id
Table function parameter

operation_id
An input argument of type VARCHAR(139) that specifies the operation ID of
the message file(s) produced by a data movement utility that was executed
through the ADMIN_CMD procedure. The operation ID is generated by the
Authorization
EXECUTE privilege on the ADMIN_GET_MSGS table function. The fenced user ID
must have read access to the files under the directory indicated by registry variable
DB2_UTIL_MSGPATH. If the registry variable is not set, then the fenced user ID must
have read access to the files in the tmp subdirectory of the instance directory.

223
Example
Check all the messages returned by EXPORT utility that was executed through
ADMIN_CMD procedure, with operation ID '24523_THERESAX'
SELECT * FROM TABLE(SYSPROC.ADMIN_GET_MSGS(24523_THERESAX)) AS MSG
The following output is an example of sample output from this query.

DBPARTITIONNUM AGENTTYPE SQLCODE
MSG
-------------- --------- --------- ---------------------------------------...SQL3104N The Export utility is beginning to
export data to file
"/home/theresax/rtest/data/ac_load03.del".
SQL3105N The Export utility has finished
exporting "8" rows.
Usage notes
The query statement that invokes this table function with the appropriate
operation_id can be found in the MSG_RETRIEVAL column of the first result set
returned by the ADMIN_CMD procedure.
Table 67. Information returned by the ADMIN_GET_MSGS table function
Column name
Data type
Description
DBPARTITIONNUM
INTEGER
dbpartitionnum - Database
partition number monitor
element
AGENTTYPE
CHAR(4)
Agent type. This value is

only returned for a
distributed load. The
possible values are:
v 'LOAD': for load agent
v 'PART': for partitioning
agent
v 'PREP': for pre-partitioning
agent
v NULL: no agent type
information is available
SQLCODE
VARCHAR(9)
SQLCODE of the message

being returned.
MSG
VARCHAR(1024)
Short error message that

corresponds to the
SQLCODE.
ADMIN_GET_STORAGE_PATHS table function - retrieve

automatic storage path information
The ADMIN_GET_STORAGE_PATHS table function returns a list of automatic
storage paths for each database storage group, including file system information
for each storage path.
Refer to Table 68 on page 226 for a complete list of information that can be
returned.
224
Syntax
ADMIN_GET_STORAGE_PATHS (
storage_group_name
member

storage_group_name
An input argument of type VARCHAR(128) that specifies a valid storage group
name in the currently connected database when this function is called. If the
argument is NULL or an empty string, information is returned for all storage
groups in the database. If the argument is specified, information is only
returned for the identified storage group.
member
An input argument of type INTEGER that specifies a valid member in the
same instance as the currently connected database when calling this function.
Specify -1 for the current database member, or -2 for all database members. If
the NULL value is specified, -1 is set implicitly.
Authorization
v DBADM authority
v SQLADM authority

None
Example
Determine which dropped storage paths are still being used:
SELECT VARCHAR(STORAGE_GROUP_NAME, 30) AS STOGROUP, VARCHAR(DB_STORAGE_PATH, 40)
AS STORAGE_PATH FROM TABLE(ADMIN_GET_STORAGE_PATHS(,-1)) AS T
WHERE DB_STORAGE_PATH_STATE = DROP_PENDING

STOGROUP
STORAGE_PATH
------------------------------ ---------------------------------------HOTSTORAGE
/home/hotel55/hotpath1
List all the storage paths for the currently connected database:
SELECT VARCHAR(STORAGE_GROUP_NAME, 30) AS STOGROUP, VARCHAR(DB_STORAGE_PATH, 40)
AS STORAGE_PATH FROM TABLE(ADMIN_GET_STORAGE_PATHS(,-1)) AS T

STOGROUP
STORAGE_PATH
------------------------------ ---------------------------------------IBMSTOGROUP
/home/hotel55/instowner
225
HOTSTORAGE
COLDSTORAGE
/home/hotel55/hotpath1
/home/hotel55/coldpath1
Information returned by ADMIN_GET_STORAGE_PATHS

Table 68. Information returned by the ADMIN_GET_STORAGE_PATHS table function
Description or corresponding
monitor element
Column Name
Data Type
STORAGE_GROUP_NAME
VARCHAR(128)
storage_group_name - Storage
group name
STORAGE_GROUP_ID
INTEGER
storage_group_id - Storage
group identifier
DBPARTITIONNUM
SMALLINT
partition number
DB_STORAGE_PATH
VARCHAR(256)
db_storage_path - Automatic
storage path
DB_STORAGE_PATH_WITH_DPE
VARCHAR(256)
db_storage_path_with_dpe Database storage path with

database partition expression
DB_STORAGE_PATH_STATE
VARCHAR(16)
db_storage_path_state - Storage
path state
Value is one of:
v IN_USE
v NOT_IN_USE
v DROP_PENDING
DB_STORAGE_PATH_ID
BIGINT
db_storage_path_id - Storage
path identifier
FS_ID
VARCHAR(22)
fs_id - Unique file system

identification number
FS_TOTAL_SIZE
BIGINT
fs_total_size - Total size of a file

system
FS_USED_SIZE
BIGINT
fs_used_size - Amount of space

used on a file system
STO_PATH_FREE_SIZE
BIGINT
sto_path_free_size - Automatic
Storage path free space
table function - estimate compression savings
The ADMIN_GET_TAB_COMPRESS_INFO table function estimates the
compression savings that can be gained for the table, assuming a REORG with
RESETDICTIONARY option will be performed.
This table function provides a direct replacement for the 'ESTIMATE' mode
provided by the deprecated ADMIN_GET_TAB_COMPRESS_INFO table function
in previous versions of DB2 for Linux, UNIX, and Windows.
Syntax
ADMIN_GET_TAB_COMPRESS_INFO (
226
tabschema
tabname

tabschema
An input argument of type VARCHAR(128) that specifies the schema name.
tabname
An input argument of type VARCHAR(128) that specifies the table name, a
materialized query table name or a hierarchy table name.
Authorization
v DBADM authority
v SQLADM authority

None
Table 69. Information returned for ADMIN_GET_TAB_COMPRESS_INFO
Column Name
Data Type
Description
TABSCHEMA
VARCHAR(128)
table_schema - Table schema name

monitor element
TABNAME
VARCHAR(128)
table_name - Table name monitor

element
DBPARTITIONNUM
SMALLINT
dbpartitionnum - Database partition

number monitor element
DATAPARTITIONID
INTEGER
Data partition number.
OBJECT_TYPE
VARCHAR(4)

element
ROWCOMPMODE
CHAR(1)
The current row compression mode

for the object. The returned metric
can be one of the following values:
v 'S' if Classic Row Compression is
enabled
v 'A' if Adaptive Row Compression
is enabled
v Blank if no row compression is
enabled
PCTPAGESSAVED_CURRENT
SMALLINT
Current percentage of pages saved

from row compression.
AVGROWSIZE_CURRENT
SMALLINT
Current average record length.
PCTPAGESSAVED_STATIC
SMALLINT
Estimated percentage of pages saved

from Classic Row Compression.
AVGROWSIZE_STATIC
SMALLINT
Estimated average record length from

Classic Row Compression.
227
Table 69. Information returned for ADMIN_GET_TAB_COMPRESS_INFO (continued)

Column Name
Data Type
Description
PCTPAGESSAVED_ADAPTIVE
SMALLINT
Estimated percentage of pages saved

from Adaptive Row Compression.
AVGROWSIZE_ADAPTIVE
SMALLINT
Estimated average record length from

Adaptive Row Compression.
Usage notes
v ADMIN_GET_TAB_COMPRESS_INFO is specific to row compression and is not
applicable to column-organized tables. The table function returns zero rows if a
column-organized table is specified.
v If both the tabschema and tabname are specified, information is returned for that
specific table only.
v If the tabschema is specified but tabname is empty (") or NULL, information is
returned for all tables in the given schema.
v If the tabschema is empty (") or NULL and tabname is specified, an error is
returned. To retrieve information for a specific table, the table must be identified
by both schema and table name.
v If both tabschema and tabname are empty (") or NULL, information is returned for
all tables.
v If tabschema or tabname do not exist, or tabname does not correspond to a table
name (type T) or a materialized query table name (type S), an empty result set is
returned.
v When the ADMIN_GET_TAB_COMPRESS_INFO table function is retrieving data
for a given table, it will acquire a shared lock on the corresponding row of
SYSTABLES to ensure consistency of the data that is returned (for example, to
ensure that the table is not altered while information is being retrieved for it).
The lock will only be held for as long as it takes to retrieve the compression
information for the table, and not for the duration of the table function call.
v If the specified table has one or more XML columns, the
ADMIN_GET_TAB_COMPRESS_INFO table function will return two rows per
partition. One row with OBJECT_TYPE returning 'DATA' and another row with
OBJECT_TYPE returning 'XML'. If the specified table does not have any XML
columns, then only one row per partition will be returned with OBJECT_TYPE
of 'DATA'.
v For XML object types, the estimates returned for PCTPAGESSAVED_ADAPTIVE
and PCTPAGESSAVED_STATIC are identical as adaptive compression only
applies to the data portion of the table.
Examples
Example 1: View the current compression results and estimate report of both classic
row compression and adaptive compression information of the TABLE1 table in the
SCHEMA1 schema.
SELECT SUBSTR(TABSCHEMA, 1, 10) AS TABSCHEMA, SUBSTR(TABNAME, 1, 10) AS TABNAME,
DBPARTITIONNUM, DATAPARTITIONID, OBJECT_TYPE, ROWCOMPMODE,
PCTPAGESSAVED_CURRENT, AVGROWSIZE_CURRENT,
PCTPAGESSAVED_STATIC, AVGROWSIZE_STATIC,
PCTPAGESSAVED_ADAPTIVE, AVGROWSIZE_ADAPTIVE
FROM TABLE(SYSPROC.ADMIN_GET_TAB_COMPRESS_INFO(SCHEMA1, TABLE1))
Output from this query:
228
TABSCHEMA
---------SCHEMA1
SCHEMA1
TABNAME
DBPARTITIONNUM DATAPARTITIONID OBJECT_TYPE
---------- -------------- --------------- ----------TABLE1
0
0 DATA
TABLE1
0
0 XML
ROWCOMPMODE
----------A
S
...
...
...
...
PCTPAGESSAVED_CURRENT AVGROWSIZE_CURRENT PCTPAGESSAVED_STATIC AVGROWSIZE_STATIC ...

--------------------- ------------------ -------------------- ----------------- ...
60
40
68
34 ...
58
255
62
198 ...
PCTPAGESSAVED_ADAPTIVE AVGROWSIZE_ADAPTIVE
---------------------- ------------------70
30
62
198
ADMIN_GET_TAB_DICTIONARY_INFO
table function - report properties of existing table dictionaries
The ADMIN_GET_TAB_DICTIONARY_INFO table function reports the dictionary
information of classic row compression for a specified schema and table when the
table dictionary was created.
This is a direct replacement for the 'REPORT' mode provided by the deprecated
ADMIN_GET_TAB_COMPRESS_INFO table function in previous versions of DB2
for Linux, UNIX, and Windows.
Syntax
ADMIN_GET_TAB_DICTIONARY_INFO (
tabschema
tabname

tabschema
An input argument of type VARCHAR(128) that specifies the schema name.
tabname
An input argument of type VARCHAR(128) that specifies the table name, a
Authorization
v DBADM authority
v SQLADM authority

None
229
Usage notes
v ADMIN_GET_TAB_DICTIONARY_INFO is specific to row compression and is
not applicable to column-organized tables. The table function returns zero rows
if a column-organized table is specified.
all tables.
name (type T) or a materialized query table name (type S), an empty result set is
returned.
v If the specified table has one or more XML columns, the
ADMIN_GET_TAB_DICTIONARY_INFO table function will return two rows per
partition. One row with OBJECT_TYPE returning 'DATA' and another row with
OBJECT_TYPE returning 'XML'. If the specified table does not have any XML
columns, then only one row per partition will be returned with OBJECT_TYPE
of 'DATA'.
v When the ADMIN_GET_TAB_DICTIONARY_INFO table function is retrieving
data for a given table, it will acquire a shared lock on the corresponding row of
Table 70. Information returned by ADMIN_GET_TAB_DICTIONARY_INFO
Column Name
Data Type
Description
TABSCHEMA
VARCHAR(128)

monitor element
TABNAME
VARCHAR(128)

element
DBPARTITIONNUM
SMALLINT

DATAPARTITIONID
INTEGER
Data partition number.
OBJECT_TYPE
VARCHAR(4)

element
ROWCOMPMODE
CHAR(1)
The current row compression mode

for the object. The returned metric
v 'S' if Classic Row Compression is
enabled
v 'A' if Adaptive Row Compression
is enabled
v Blank if no row compression is
enabled
230
Table 70. Information returned by ADMIN_GET_TAB_DICTIONARY_INFO (continued)

Column Name
Data Type
Description
BUILDER
VARCHAR(30)
Code path taken to build the

dictionary, which can be one of the
following values:
v 'INSPECT' = INSPECT
ROWCOMPESTIMATE
v 'LOAD' = LOAD
INSERT/REPLACE
v 'NOT BUILT' = no dictionary
available
v 'REDISTRIBUTE' = REDISTRIBUTE
v
v
'REORG' = REORG
RESETDICTIONARY
'TABLE GROWTH' = INSERT
BUILD_TIMESTAMP
TIMESTAMP
Timestamp of when the dictionary

was built. Timestamp granularity is
to the second. If no dictionary is
available, then the timestamp is
NULL.
SIZE
BIGINT
Size of the expansion dictionary

measured in bytes. If a historical
dictionary exists, this value is the
sum of the current and historical
dictionary sizes.
HISTORICAL_DICTIONARY
CHAR(1)
Indicates the presence of a historical

dictionary. The returned metric can
be one of the following values:
v 'N' = No historical dictionary exists
v 'Y' = Historical dictionary exists
ROWS_SAMPLED
INTEGER
Number of records that contributed

to building the dictionary.
PCTPAGESSAVED
SMALLINT
Percentage of pages saved from

compression. This information is a
projection, based on the records
contributing to building the
dictionary.
AVGCOMPRESSEDROWSIZE
SMALLINT
Average compressed record length of

the records contributing to building
the dictionary.
Examples
Example 1. View a report of the dictionary information of the ADMIN_VIEW table
in the PAGECOMP schema.
SELECT SUBSTR(TABSCHEMA, 1, 10) AS TABSCHEMA, SUBSTR(TABNAME, 1, 10) AS TABNAME,
DBPARTITIONNUM, DATAPARTITIONID, OBJECT_TYPE, ROWCOMPMODE, BUILDER,
BUILD_TIMESTAMP, SIZE, HISTORICAL_DICTIONARY, ROWS_SAMPLED,
PCTPAGESSAVED, AVGCOMPRESSEDROWSIZE
FROM TABLE( SYSPROC.ADMIN_GET_TAB_DICTIONARY_INFO( PAGECOMP, ADMIN_VIEW ))
231
TABSCHEMA TABNAME
DBPARTITIONNUM DATAPARTITIONID OBJECT_TYPE ROWCOMPMODE ...
---------- ---------- -------------- --------------- ----------- ----------- ...
PAGECOMP
ADMIN_VIEW
0
0 DATA
S
...
BUILDER
BUILD_TIMESTAMP
SIZE
------------------------------ -------------------------- -------------------- ...
REORG
2010-09-03-01.10.33.000000
52736 ...
HISTORICAL_DICTIONARY ROWS_SAMPLED PCTPAGESSAVED AVGCOMPRESSEDROWSIZE
--------------------- ------------ ------------- -------------------N
300000
80
38
ADMINTABINFO administrative view and ADMIN_GET_TAB_INFO

table function - retrieve table size and state information
The ADMINTABINFO administrative view and the ADMIN_GET_TAB_INFO table
function provide methods to retrieve table size and state information that is not
currently available in the catalog views.
Depending on if you are using the administrative view or the table function, refer
to one of the following sections:
v ADMINTABINFO administrative view
v ADMIN_GET_TAB_INFO table function on page 233
ADMINTABINFO administrative view

The ADMINTABINFO administrative view returns size and state information for
tables, materialized query tables (MQT) and hierarchy tables only. These table
types are reported as T for table, S for materialized query tables and H for
hierarchy tables in the SYSCAT.TABLES catalog view. The information is returned
at both the data partition level and the database partition level for a table.
In a DB2 pureScale environment, values reported for a table are identical on all
members since all members operate on a single physical partition of data. This is
unlike in a partitioned database environment, where each member operates on a
different physical partition of data, and reports different values. Because the values
on all members are always the same, the ADMINTABINFO view and the
ADMIN_GET_TAB_INFO table functions return only a single row for each table
when run on a DB2 pureScale instance.
The schema is SYSIBMADM.
Refer to the Information returned by ADMINTABINFO administrative view and
ADMIN_GET_TAB_INFO table for a complete list of information that can be
returned.
Authorization
v SELECT privilege on the ADMINTABINFO administrative view
v CONTROL privilege on the ADMINTABINFO administrative view
v DBADM authority
v SQLADM authority
232

In a non-restrictive database, SELECT privilege is granted to PUBLIC when the
view is automatically created.
Examples
Example 1: Retrieve size and state information for all tables
SELECT * FROM SYSIBMADM.ADMINTABINFO
Example 2: Determine the amount of physical space used by a large number of

sparsely populated tables.
SELECT TABSCHEMA, TABNAME, SUM(DATA_OBJECT_P_SIZE),
SUM(INDEX_OBJECT_P_SIZE), SUM(LONG_OBJECT_P_SIZE),
SUM(LOB_OBJECT_P_SIZE), SUM(XML_OBJECT_P_SIZE)
FROM SYSIBMADM.ADMINTABINFO GROUP BY TABSCHEMA, TABNAME
Example 3: Identify tables that are eligible to use large RIDs, but are not currently
enabled to use large RIDs.
SELECT TABSCHEMA, TABNAME FROM SYSIBMADM.ADMINTABINFO
WHERE LARGE_RIDS = P
Example 4: Check the current type of statistics information collected for table T1
SELECT SUBSTR(TABSCHEMA, 1, 10) AS TBSCHEMA, SUBSTR(TABNAME, 1, 10)
AS TBNAME, STATSTYPE FROM SYSIBMADM.ADMINTABINFO WHERE TABNAME = T1;
TBSCHEMA
TBNAME
STATSTYPE
---------- ---------- --------DB2USER1
T1
U
ADMIN_GET_TAB_INFO table function

The ADMIN_GET_TAB_INFO table function returns the same information as the
ADMINTABINFO administrative view, but allows you to specify a schema and
table name.
returned.
Authorization
EXECUTE privilege on the ADMIN_GET_TAB_INFO table function.

Syntax
ADMIN_GET_TAB_INFO (
tabschema
tabname

233
Routine parameters
tabschema
An input argument of type VARCHAR(128) that specifies a schema name.
tabname
An input argument of type VARCHAR(128) that specifies a table name, a
Table 71. Information Returned by ADMINTABINFO administrative view and ADMIN_GET_TAB_INFO
Column name
Data type
Description
TABSCHEMA
VARCHAR(128)
table_schema - Table schema name monitor element
TABNAME
VARCHAR(128)
table_name - Table name monitor element
TABTYPE
CHAR(1)
Table type:
v 'H' = hierarchy table
v 'S' = materialized query table
v 'T' = table
DBPARTITIONNUM
SMALLINT
dbpartitionnum - Database partition number monitor

element
DATA_PARTITION_ID
INTEGER
data_partition_id - Data partition identifier monitor

element
AVAILABLE
CHAR(1)
State of the table:

v 'N' = the table is unavailable. If the table is unavailable,
all other output columns relating to the size and state
will be NULL.
v 'Y' = the table is available.
Note: Rollforward through an unrecoverable load will put
a table into the unavailable state.
DATA_OBJECT_L_SIZE
234
BIGINT
Data object logical size. Amount of disk space logically

allocated for the table, reported in kilobytes. The logical
size is the amount of space that the table knows about. It
might be less than the amount of space physically
allocated for the table (for example, in the case of a logical
table truncation). For multidimensional clustering (MDC)
and insert time clustering (ITC) tables, this size includes
the logical size of the block map object. The size returned
takes into account full extents that are logically allocated
for the table and, for objects created in DMS table spaces,
an estimate of the Extent Map Page (EMP) extents. This
size represents the logical size of the base table only.
Space consumed by LOB data, Long Data, Indexes and
XML objects are reported by other columns.
Table 71. Information Returned by ADMINTABINFO administrative view and ADMIN_GET_TAB_INFO (continued)
Column name
Data type
Description
DATA_OBJECT_P_SIZE
BIGINT
Data object physical size, reported in kilobytes.

For row-organized tables, the data object physical size is
the amount of disk space physically allocated for the
table. For MDC and ITC tables, this size includes the size
of the block map object. The size returned takes into
account full extents allocated for the table and includes
the EMP extents for objects created in DMS table spaces.
This size represents the physical size of the base table
only. The space consumed by LOB data, long data,
indexes, and XML objects is reported by other columns.
For column-organized tables, the data object physical size
is the amount of disk space physically allocated for the
table metadata only, which is relatively small. The user
data for column-organized tables is stored in the
column-organized data object, and its physical size is
reported by COL_OBJECT_P_SIZE.
INDEX_OBJECT_L_SIZE
BIGINT
Index object logical size. Amount of disk space logically

allocated for the indexes defined on the table, reported in
kilobytes. The logical size is the amount of space that the
table knows about. It might be less than the amount of
space physically allocated to hold index data for the table
(for example, in the case of a logical table truncation). The
size returned takes into account full extents that are
logically allocated for the indexes and, for indexes created
in DMS table spaces, an estimate of the EMP extents.
For partitioned indexes on partitioned tables, this is the
logical size of the index object containing index partitions
for the data partition identified by DATA_PARTITION_ID.
This value does not take into account nonpartitioned
indexes on partitioned tables. For information about the
both partitioned and nonpartitioned indexes, you can use
the ADMIN_GET_INDEX_INFO function.
INDEX_OBJECT_P_SIZE
BIGINT
Index object physical size. Amount of disk space

physically allocated for the indexes defined on the table,
reported in kilobytes. The size returned takes into account
full extents allocated for the indexes and includes the
EMP extents for indexes created in DMS table spaces.
physical size of the index object containing index
partitions for the data partition identified by
DATA_PARTITION_ID. This value does not take into
account nonpartitioned indexes on partitioned tables. For
information about both partitioned and nonpartitioned
indexes, you can use the ADMIN_GET_INDEX_INFO
function.
235
Column name
Data type
Description
LONG_OBJECT_L_SIZE
BIGINT
Long object logical size. Amount of disk space logically

allocated for long field data in a table, reported in
space physically allocated to hold long field data for the
table (for example, in the case of a logical table
truncation). The size returned takes into account full
extents that are logically allocated for long field data and,
for long field data created in DMS table spaces, an
estimate of the EMP extents.
LONG_OBJECT_P_SIZE
BIGINT
Long object physical size. Amount of disk space

physically allocated for long field data in a table, reported
in kilobytes. The size returned takes into account full
extents allocated for long field data and includes the EMP
extents for long field data created in DMS table spaces.
LOB_OBJECT_L_SIZE
BIGINT
LOB object logical size. Amount of disk space logically

allocated for LOB data in a table, reported in kilobytes.
The logical size is the amount of space that the table
knows about. It might be less than the amount of space
physically allocated to hold LOB data for the table (for
example, in the case of a logical table truncation). The size
includes space logically allocated for the LOB allocation
object. The size returned takes into account full extents
that are logically allocated for LOB data and, for LOB
data created in DMS table spaces, an estimate of the EMP
extents.
LOB_OBJECT_P_SIZE
BIGINT
LOB object physical size. Amount of disk space physically

The size includes space allocated for the LOB allocation
allocated for LOB data and includes the EMP extents for
LOB data created in DMS table spaces.
XML_OBJECT_L_SIZE
BIGINT
XML object logical size. Amount of disk space logically

allocated for XML data in a table, reported in kilobytes.
physically allocated to hold XML data for the table (for
returned takes into account full extents that are logically
allocated for XML data and, for XML data created in DMS
table spaces, an estimate of the EMP extents.
XML_OBJECT_P_SIZE
BIGINT
XML object physical size. Amount of disk space physically

The size returned takes into account full extents allocated
for XML data and includes the EMP extents for XML data
created in DMS table spaces.
INDEX_TYPE
SMALLINT
Indicates the type of indexes currently in use for the table.

Returns 2 as type-2 indexes are used.
REORG_PENDING
CHAR(1)
A value of 'Y' indicates that a reorg recommended alter

has been applied to the table and a classic (offline) reorg
is required. Otherwise 'N' is returned.
236
Column name
Data type
Description
INPLACE_REORG_STATUS
VARCHAR(10)
Current status of an inplace table reorganization on the

table. The status value can be one of the following values:
v ABORTED (in a PAUSED state, but unable to RESUME;
STOP is required)
v EXECUTING
v NULL (if no inplace reorg has been performed on the
table)
v PAUSED
LOAD_STATUS
VARCHAR(12)
Current status of a load operation against the table. The

status value can be one of the following values:
v IN_PROGRESS
v NULL (if there is no load in progress for the table and
the table is not in load pending state)
v PENDING
READ_ACCESS_ONLY
CHAR(1)
'Y' if the table is in Read Access Only state, 'N' otherwise.

A value of 'N' should not be interpreted as meaning that
the table is fully accessible. If a load is in progress or
pending, a value of 'Y' means the table data is available
for read access, and a value of 'N' means the table is
inaccessible. Similarly, if the table status is set integrity
pending (refer to SYSCAT.TABLES STATUS column), then
a value of 'N' means the table is inaccessible.
NO_LOAD_RESTART
CHAR(1)
A value of 'Y' indicates the table is in a partially loaded

state that will not allow a load restart. A value of 'N' is
returned otherwise.
NUM_REORG_REC_ALTERS
SMALLINT
Number of reorg recommend alter operations (for

example, alter operations after which a reorganization is
required) that have been performed against this table
since the last reorganization.
INDEXES_REQUIRE_REBUILD
CHAR(1)
For nonpartitioned tables, 'Y' if any of the indexes defined

on the table require a rebuild, and 'N' otherwise. For
partitioned tables, 'Y' if any index partitions for the data
partition identified by DATA_PARTITION_ID require a
rebuild, and 'N' otherwise.
LARGE_RIDS
CHAR(1)
Indicates whether or not the table is using large row IDs

(RIDs) (4 byte page number, 2 byte slot number). A value
of 'Y' indicates that the table is using large RIDs and 'N'
indicates that it is not using large RIDs. A value of 'P'
(pending) will be returned if the table supports large RIDs
(that is, the table is in a large table space), but at least one
of the indexes for the table has not been reorganized or
rebuilt yet, so the table is still using 4 byte RIDs (which
means that action must be taken to convert the table or
indexes). This element returns the null value for
column-organized tables because the concept of RIDS
does not apply.
237
Column name
Data type
Description
LARGE_SLOTS
CHAR(1)
Indicates whether or not the table is using large slots

(which allows more than 255 rows per page). A value of
'Y' indicates that the table is using large slots and 'N'
indicates that it is not using large slots. A value of 'P'
(pending) will be returned if the table supports large slots
(that is, the table is in a large table space), but there has
been no offline table reorganization or table truncation
operation performed on the table yet, so it is still using a
maximum of 255 rows per page. This element returns the
null value for column-organized tables because the
concept of SLOTS does not apply.
DICTIONARY_SIZE
BIGINT
Size of the table dictionary, in bytes, used for row

compression if a row compression dictionary exists for the
table. If a historical dictionary exists, this value is the sum
of the current and historical dictionary sizes.
BLOCKS_PENDING_CLEANUP
BIGINT
blocks_pending_cleanup - Pending cleanup rolled-out

blocks monitor element
STATSTYPE
CHAR(1)
v 'F' = System fabricated statistics without table or index

scan. These statistics are stored in memory and are
different from what is stored in the system catalogs.
This is a temporary state and eventually full statistics
will be gathered by DB2 and stored in the system
catalogs.
v
'A'= System asynchronously gathered statistics.

Statistics have been automatically collected by DB2 by a
background process and stored in the system catalogs.
v 'S' = System synchronously gathered statistics. Statistics

have been automatically collected by DB2 during SQL
statement compilation. These statistics are stored in
memory and are different from what is stored in the
system catalogs. This is a temporary state and
eventually DB2 will store the statistics in the system
catalogs.
v 'U' = User gathered statistics. Statistics gathering was
initiated by the user through a utility such as
RUNSTATS, CREATE INDEX, LOAD, REDISTRIBUTE
or by manually updating system catalog statistics.
v NULL = unknown type
XML_RECORD_TYPE
SMALLINT
Indicates the type of XML record currently in use for the

table.
v 1 if the type-1 (single node) XML record format is being
used.
v 2 if the type-2 (multi-node) XML record format is being
used.
v Null if the table has no XML columns.
RECLAIMABLE_SPACE
238
BIGINT
For an MDC or ITC table in a DMS table space, this value

indicates the amount of disk space that can be reclaimed
by running the REORG TABLE command with the RECLAIM
EXTENTS option. For a column-organized table, this value
indicates the amount of free space that was found the last
time that the runstats utility was run. Disk space is
reported in kilobytes. For any other table, the value is
zero.
Column name
Data type
Description
XML_DICTIONARY_SIZE
BIGINT
Size of the XML dictionary, in bytes, used for data

compression if a data compression dictionary exists for
the XML storage object. If the table does not contain any
XML columns or if a compression dictionary has not been
created, the value is 0.
AMT_STATUS
VARCHAR(12)
Current status of ADMIN_MOVE_TABLE stored

procedure call against the table. Returns the value
'IN_PROGRESS' or the null value if there is no move in
progress for the table.
SPARSE_BLOCKS
BIGINT
For an insert time clustering (ITC) table, this field

represents the number of sparsely used blocks in the
table. This is the set of blocks that will be consolidated if
the REORG TABLE command is invoked with the
RECLAIM EXTENTS option.
STATS_ROWS_MODIFIED
BIGINT
stats_rows_modified - Rows modified since last

RUNSTATS
RTS_ROWS_MODIFIED
BIGINT
rts_rows_modified - Rows modified since last real time

statistics
STATS_DBPARTITION
CHAR(3)
stats_dbpartition - Automatics statistics collection

indicator
COL_OBJECT_L_SIZE
BIGINT
col_object_l_size - Column-organized data object logical

size
COL_OBJECT_P_SIZE
BIGINT
col_object_p_size - Column-organized data object physical

size
Usage notes
v If the tabschema is specified but tabname is NULL or the empty string ("), then
information is returned for all tables in the given schema.
v If the tabschema is NULL or the empty string (") and tabname is specified, then an
error is returned. To retrieve information for a specific table, the table must be
identified by both schema and table name.
v If both tabschema and tabname are NULL or the empty string ("), then information
is returned for all tables.
name (type T), a materialized query table name (type S) or a hierarchy table
name (type H), an empty result set is returned.
v When the ADMIN_GET_TAB_INFO table function is retrieving data for a given
table, it will acquire a shared lock on the corresponding row of SYSTABLES to
ensure consistency of the data that is returned (for example, to ensure that the
table is not dropped while information is being retrieved for it). The lock will
only be held for as long as it takes to retrieve the size and state information for
the table, not for the duration of the table function call.
v Physical size reported for tables in SMS table spaces is the same as logical size.
v When an inplace reorg is active on a table, the physical size for the data object
(DATA_OBJECT_P_SIZE) will not be calculated. Only the logical size will be
returned. You can tell if an inplace reorg is active on the table by looking at the
INPLACE_REORG_STATUS output column.
239
Examples
Example 1: Retrieve size and state information for the table DBUSER1.EMPLOYEE.
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_TAB_INFO(DBUSER1, EMPLOYEE))
AS T
Example 2: Suppose there exists a non-partitioned table (DBUSER1.EMPLOYEE),

with all associated objects (for example, indexes and LOBs) stored in a single table
space. Calculate how much physical space the table is using in the table space:
SELECT (data_object_p_size + index_object_p_size + long_object_p_size +
lob_object_p_size + xml_object_p_size + col_object_p_size) as total_p_size
FROM TABLE( SYSPROC.ADMIN_GET_TAB_INFO( DBUSER1, EMPLOYEE )) AS T
Calculate how much space would be required if the table were moved to another
table space, where the new table space has the same page size and extent size as
the original table space:
SELECT (data_object_l_size + index_object_l_size + long_object_l_size +
lob_object_l_size + xml_object_l_size + col_object_l_size) as total_l_size
Example 3: Determine the total size for the compression dictionaries for the table
DBUSER1.EMPLOYEE.
SELECT SUBSTR(TABSCHEMA,1,10) AS TBSCHEMA, SUBSTR(TABNAME,1,10) AS TBNAME,
DICTIONARY_SIZE + XML_DICTIONARY_SIZE AS TOTAL_DICTIONARY_SIZE
FROM TABLE(SYSPROC.ADMIN_GET_TAB_INFO(DBUSER1,EMPLOYEE))
Example 4: Determine the amount of space reclaimable from a multidimensional

clustering table SAMPLE.STAFF:
SELECT RECLAIMABLE_SPACE
FROM TABLE(SYSPROC.ADMIN_GET_TAB_INFO(SAMPLE,STAFF))
ADMINTEMPCOLUMNS administrative view and

ADMIN_GET_TEMP_COLUMNS table function - Retrieve column
information for temporary tables
The ADMINTEMPCOLUMNS administrative view and the
ADMIN_GET_TEMP_COLUMNS table function provide methods to retrieve
column attribute information for created temporary tables and declared temporary
tables.
Although the catalog views contain column attribute information for instances of
created temporary tables, they do not have this information for declared temporary
tables.
v ADMINTEMPCOLUMNS administrative view
v ADMIN_GET_TEMP_COLUMNS table function on page 241
ADMINTEMPCOLUMNS administrative view

The ADMINTEMPCOLUMNS administrative view returns column attribute
information for instances of created temporary tables and declared temporary
tables.
240
Refer to the Information returned for ADMINTEMPCOLUMNS administrative

view and ADMIN_GET_TEMP_COLUMNS table for a complete list of information
that can be returned.
Authorization
v SELECT privilege on the ADMINTEMPCOLUMNS administrative view
v CONTROL privilege on the ADMINTEMPCOLUMNS administrative view
v DBADM authority
v SQLADM authority
One of the following is required to use the table function:
v EXECUTE privilege on the ADMIN_GET_TEMP_COLUMNS table function

Examples
Example 1: Retrieve column attribute information for all instances of created
temporary tables and all declared temporary tables currently existing in the
database.
SELECT * FROM SYSIBMADM.ADMINTEMPCOLUMNS
Example 2: Determine which temporary tables active in the database are using the
user-defined data type of USMONEY.
SELECT APPLICATION_HANDLE, TABSCHEMA, TABNAME
FROM SYSIBMADM.ADMINTEMPCOLUMNS
WHERE TYPENAME = USMONEY
Example 3: Retrieve table schema, table name, and the column names for all
declared temporary tables declared by the SYSTEM_USER.
SELECT T.TABSCHEMA, T.TABNAME, C.COLNAME
FROM SYSIBMADM.ADMINTEMPCOLUMNS C, SYSIBMADM.ADMINTEMPTABLES T
WHERE T.TEMPTABTYPE = D
AND T.INSTANTIATOR = SYSTEM_USER
AND T.TABSCHEMA = C.TABSCHEMA
AND T.TABNAME = C.TABNAME
ADMIN_GET_TEMP_COLUMNS table function

The ADMIN_GET_TEMP_TABLES table function returns the same information as
the ADMINTEMPCOLUMNS administrative view, but allows you to specify a
schema name and a table name.
241
Syntax
ADMIN_GET_TEMP_COLUMNS (
application_handle
tabschema
tabname

application_handle
An input argument of type BIGINT that specifies an application handle. If
application_handle is specified, data is returned for the specified connection
only; if application_handle is NULL, data is returned for all connections.
tabschema
tabname
An input argument of type VARCHAR(128) that specifies a created temporary
table name or a declared temporary table name.
Authorization
v DBADM authority
v SQLADM authority

Examples
Example 1: Retrieve column information for the declared temporary table
TEMPEMPLOYEE for the current connection.
SELECT *
FROM TABLE (
SYSPROC.ADMIN_GET_TEMP_COLUMNS(
APPLICATION_ID(), SESSION, TEMPEMPLOYEE))
AS T
Usage notes
v If both tabschema and tabname are specified, then information is returned for that
specific temporary table only.
v If tabschema is specified but tabname is NULL or the empty string ("), then
v If tabschema is NULL or the empty string (") and tabname is specified, then an
error is returned. To retrieve information for a specific temporary table, the table
must be identified by both schema and table name.
is returned for all temporary tables for the connection or all connections,
depending on the value of application_handle.
242
v If tabschema or tabname do not exist, or tabname does not correspond to a

temporary table name, or instances of the identified temporary table do not exist
in the database, then an empty result set is returned.
Table 72. Information returned for ADMINTEMPCOLUMNS administrative view and ADMIN_GET_TEMP_COLUMNS
Column name
Data type
Description
APPLICATION_HANDLE
BIGINT
application_handle - Application handle monitor element
APPLICATION_NAME
VARCHAR(256)
appl_name - Application name monitor element
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
COLNAME
VARCHAR(128)
Name of the column.
COLNO
SMALLINT
Number of this column in the table (starting with 0).
TYPESCHEMA
VARCHAR(128)
Schema name of the data type for the column.
TYPENAME
VARCHAR(128)
Unqualified name of the data type for the column.
LENGTH
INTEGER
Maximum length of the data. 0 for distinct types. The

LENGTH column indicates precision for DECIMAL fields,
and indicates the number of bytes of storage required for
decimal floating-point columns; that is, 8 columns for
DECFLOAT(16) and 16 columns for DECFLOAT(34).
SCALE
SMALLINT
Scale if the column type is DECIMAL; or the number of

digits of fractional seconds if the column type is
TIMESTAMP; 0 otherwise.
DEFAULT
VARCHAR(254)
Default value for the column of a table expressed as a

constant, special register, or cast-function appropriate for
the data type of the column. Can also be the keyword
NULL. Values might be converted from what was
specified as a default value. For example, date and time
constants are shown in ISO format, cast-function names
are qualified with schema names, and identifiers are
delimited. Null value if a DEFAULT clause was not
specified or the column is a view column.
NULLS
CHAR(1)
Nullability attribute for the column.

v Y = Column is nullable
v N = Column is not nullable
The value can be N for a view column that is derived
from an expression or function. Nevertheless, such a
column allows null values when the statement using the
view is processed with warnings for arithmetic errors.
CODEPAGE
SMALLINT
Code page used for data in this column; 0 if the column is

defined as FOR BIT DATA or is not a string type.
LOGGED
CHAR(1)
Applies only to columns whose type is LOB or distinct

based on LOB; blank otherwise.
v Y = Column is logged
v N = Column is not logged
COMPACT
CHAR(1)

v Y = Column is compacted in storage
v N = Column is not compacted
243
Table 72. Information returned for ADMINTEMPCOLUMNS administrative view and

ADMIN_GET_TEMP_COLUMNS (continued)
Column name
Data type
Description
INLINE_LENGTH
INTEGER
Maximum size in bytes of the internal representation of

an instance of an XML document or a structured type that
can be stored in the base table; 0 when not applicable.
IDENTITY
CHAR(1)
v Y = Identity column
v N = Not an identity column
GENERATED
CHAR(1)
Type of generated column.

v A = Column value is always generated
v D = Column values is generated by default
v Blank = Column is not generated
ADMINTEMPTABLES administrative view and

ADMIN_GET_TEMP_TABLES table function - Retrieve information
for temporary tables
The ADMINTEMPTABLES administrative view and the
ADMIN_GET_TEMP_TABLES table function provide methods to retrieve table
attribute and instantiation time information for instances of created temporary
tables and declared temporary tables.
Although the catalog views contain table attribute information for created
temporary tables, they do not contain this information for declared temporary
tables. In addition, the catalog views do not contain table instantiation time
information for created temporary tables or declared temporary tables.
v ADMINTEMPTABLES administrative view
v ADMIN_GET_TEMP_TABLES table function on page 245
ADMINTEMPTABLES administrative view

The ADMINTEMPTABLES administrative view returns table attribute and
instantiation time information for instances of created temporary tables and
declared temporary tables.
Refer to the Information returned for ADMINTEMPTABLES administrative view
and ADMIN_GET_TEMP_TABLES table for a complete list of information that can
be returned.
Authorization
v SELECT privilege on the ADMINTEMPTABLES administrative view
v CONTROL privilege on the ADMINTEMPTABLES administrative view
v DBADM authority
v SQLADM authority
244

v EXECUTE privilege on the ADMIN_GET_TEMP_TABLES table function

Examples
Example 1: Retrieve table attributes and instantiation time information for all
instances of created temporary tables and declared temporary tables currently
existing in the database.
SELECT * FROM SYSIBMADM.ADMINTEMPTABLES
Example 2: Determine which connections have an instance of a created temporary

table.
FROM SYSIBMADM.ADMINTEMPTABLES
WHERE TEMPTABTYPE = C
declared temporary tables declared for all the tables instantiated by the user that
connected to the database.
SELECT TABSCHEMA, TABNAME, ONCOMMIT, ONROLLBACK,
INSTANTIATION_TIME
WHERE TEMPTABTYPE = D AND INSTANTIATOR = SYSTEM_USER

the ADMINTABINFO administrative view, but allows you to specify a schema
name and a table name.
be returned.
Syntax
ADMIN_GET_TEMP_TABLES (
application_handle
tabschema
tabname

application_handle
tabschema
245
tabname
Authorization
v DBADM authority
v SQLADM authority

Examples
instances of the created temporary table DBUSER1.EMPLOYEE for all connections.
SELECT TABSCHEMA, TABNAME, ONCOMMIT, ONROLLBACK, INSTANTIATION_TIME
FROM TABLE (SYSPROC.ADMIN_GET_TEMP_TABLES(NULL, DBUSER1, EMPLOYEE))
AS T
Example 2: Retrieve the instantiation time and table space ID for all instances of
user temporary tables for the current connection.
SELECT TABSCHEMA, TABNAME, INSTANTIATION_TIME, TBSP_ID
FROM TABLE (SYSPROC.ADMIN_GET_TEMP_TABLES(APPLICATION_ID(), , ))
AS T
Usage notes
v
Table 73. Information returned for ADMINTEMPTABLES administrative view and ADMIN_GET_TEMP_TABLES
Column name
Data type
Description
APPLICATION_HANDLE
BIGINT
APPLICATION_NAME
VARCHAR(256)
246
Table 73. Information returned for ADMINTEMPTABLES administrative view and

ADMIN_GET_TEMP_TABLES (continued)
Column name
Data type
Description
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
INSTANTIATOR
VARCHAR(128)
Authorization ID under which the created temporary

table was instantiated or declared temporary table was
declared.
INSTANTIATORTYPE
CHAR(1)
v U = The instantiator is an individual user
TEMPTABTYPE
CHAR(1)
Temporary table type:

v C = Created temporary table
v D = Declared temporary table
INSTANTIATION_TIME
TIMESTAMP
Time at which the created temporary table instance was

instantiated or the declared temporary table was declared.
COLCOUNT
SMALLINT
Number of columns, including inherited columns (if any).
TAB_FILE_ID
BIGINT
table_file_id - The file ID (FID) for the table.
TBSP_ID
BIGINT
tablespace_id - An integer that uniquely represents a table

space used by the current database.
PMAP_ID
SMALLINT
Identifier for the distribution map that is currently in use

by this table.
PARTITION_MODE
CHAR(1)
Indicates how data is distributed among database

partitions in a partitioned database system.
v H = Hashing
v Blank = No database partitioning
CODEPAGE
SMALLINT
Code page of the object. This is the default code page

used for all character columns and expression-generated
columns.
ONCOMMIT
CHAR(1)
Specifies the action taken on this table when a COMMIT

operation is performed.
v D = Delete rows
v P = Preserve rows
ONROLLBACK
CHAR(1)
Specifies the action taken on this table when a

ROLLBACK operation is performed.
v D = Delete rows
v P = Preserve rows
LOGGED
CHAR(1)
Specifies whether this table is logged.

v N = Not logged
v Y = Logged
ADMIN_IS_INLINED function - Determine if data is inlined

The ADMIN_IS_INLINED function retrieves state information about inline data for
an XML column, BLOB column, CLOB column, or DBCLOB column.
Syntax
ADMIN_IS_INLINED (
column-name
The schema is SYSIBM.

247
Return value
This function returns one of the following values of type SMALLINT, or the null
value:
1
Indicates that the data is inlined.
Indicates that the data is not inlined.
NULL Indicates that the inputs are NULL.
Function parameters
column-name
Identifies a column of the base table with a data type of XML, BLOB, CLOB, or
DBCLOB (SQLSTATE 42884). The column must directly or indirectly reference
the column of a base table that is not generated based on an expression
(SQLSTATE 42815).
Example
Example 1: The following example indicates whether the three XML documents in
the XML column xml_doc1 of the TAB1 table are inlined:
db2 => SELECT PK, ADMIN_IS_INLINED(xml_doc1) as IS_INLINED
from TAB1

PK
IS_INLINED
----------- ------------------1
1
2
0
3
0
Example 2: The following example indicates whether one of the XML documents in
the XML column xml_doc1 of the TAB1 table is inlined:
db2 => SELECT PK, ADMIN_IS_INLINED(xml_doc1) as IS_INLINED
from TAB1 where PK=1

PK
IS_INLINED
----------- ------------------1
1
Example 3: The following example indicates whether the three CLOB data
contained in the CLOB column clob_1 of the TAB1 table are inlined:
db2 => SELECT PK, ADMIN_IS_INLINED(clob_1) as IS_INLINED
from TAB1

PK
IS_INLINED
----------- ------------------1
0
2
0
3
1
248
ADMIN_MOVE_TABLE procedure - Move tables online

The ADMIN_MOVE_TABLE stored procedure moves the data in an active table
into a new table object with the same name, while the data remains online and
available for access.
This stored procedure creates a protocol table composed of rows that contain status
information and configuration options related to the table to be moved. The return
set from this procedure is the set of rows from the protocol table related to the
table to be moved.
This stored procedure uses the following terminology:
Source table
The original table name that is passed in as a parameter into the stored
procedure. This is the table to be moved.
Target table
A table created by the stored procedure using the table definition passed in
through the stored procedure. All of the data from the source table is
copied into this table and then it is renamed to the same name as the
source table.
Staging table
A table created by the stored procedure. The staging table stores any
update, delete or insert changes that occur on the source table during the
execution of the table move. This table is dropped when the move is
complete.
Syntax
There are two equally valid methods to start the ADMIN_MOVE_TABLE stored
procedure:
v Use the first method to modify only certain parts of the table definition for the
target table. For instance, if you had a table definition that is quite large (several
KB), and all you want to do is modify the table spaces for the table, you can do
so without having to determine the entire CREATE TABLE statement needed to
recreate the source table. All you need to do is to fill out the data_tbsp,
index_tbsp, and lob_tbsp parameters, leaving the other optional parameters
blank.
v The second method provides you with more control and flexibility. You can
create the target table beforehand, rather than having the stored procedure create
the target table. By creating the target table beforehand, you can create a target
table that would not be possible using the first method.
Method 1:
ADMIN_MOVE_TABLE (
tabschema
lob_tbsp , organize_by_clause
tabname
, data_tbsp
, partkey_cols
, index_tbsp
249
, data_part
, coldef
options
, operation
Method 2:
ADMIN_MOVE_TABLE (
options
tabschema
, operation
tabname
, target_tabname
The schema for both methods is SYSPROC.
tabschema
This input parameter specifies the name of the schema which contains the table
to be moved. This parameter is case sensitive and has a data type of
VARCHAR(128).
tabname
This input parameter specifies the name of the table to be moved. This
parameter is case sensitive and has a data type of VARCHAR(128)
data_tbsp
This input parameter specifies the new data table space for the target table. If a
value is provided, the index_tbsp and lob_tbsp parameters are required. If a
value is not provided, the data table space of the source table is used. This
parameter is case sensitive and has a data type of VARCHAR(128). This
parameter can be NULL or the empty string.
index_tbsp
This input parameter specifies the new index table space for the target table. If
a value is provided, the data_tbsp and lob_tbsp parameters are required. If a
value is not provided, the index table space of the source table is used. This
lob_tbsp
This input parameter specifies the new LOB table space for the target table. If a
value is provided, the data_tbsp and index_tbsp parameters are required. If a
value is not provided, the LOB table space of the source table is used. This
organize_by_clause
This input parameter can be used to specify an ORGANIZE BY clause for the
table. If the value provided does not begin with 'ORGANIZE BY' then it
provides the multi-dimensional clustering (MDC) specification for the target
table. The values are entered as a comma separated list of the columns used to
cluster data in the target table along multiple dimensions. If a value of NULL
or - is given, the ORGANIZE BY clause is not used. If an empty string or a
single blank is given, the procedure checks whether there is an MDC or ITC
specification on the source table, and uses that specification if located. If the
argument begins with 'ORGANIZE BY' it can be used to specify any option
250
related to the ORGANIZE BY clause of a CREATE TABLE statement. This

parameter has a data type of VARCHAR(32672) and has the same format as
the ORGANIZE BY DIMENSIONS clause of the CREATE TABLE statement.
This parameter can be NULL, the empty string, or a single blank.
Example 1: 'C1, C4, (C3,C1), C2'
Example 2: ORGANIZE BY INSERT TIME
partkey_cols
This input parameter provides the partitioning key columns specification for
the target table. The values are entered as a comma separated list of the key
columns that specify how the data is distributed across multiple database
partitions. If a value of NULL or - is given, the PARTITIONING KEY clause
is not used. If an empty string or a single blank is given, the procedure checks
whether there is a partitioning key columns specification on the source table,
and uses that specification if located. This parameter has a data type of
VARCHAR(32672) and has the same format as the DISTRIBUTE BY HASH
clause of the CREATE TABLE statement.
Example: 'C1, C3'
data_part
This input parameter provides the data partitioning specification for the target
table. This statement defines how to divide table data across multiple storage
objects (called data partitions), according to the values in one or more of the
table columns. If a value of NULL or - is given, the PARTITION BY RANGE
clause is not used. If an empty string or a single blank is given, the procedure
checks whether there is a data partition scheme on the source table, and uses
that information (including partition name) if located. This parameter has a
data type of VARCHAR(32672) and has the same format as the PARTITION BY
RANGE clause of the CREATE TABLE statement.
Example: '(C1) (STARTING FROM (1) EXCLUSIVE ENDING AT (1000) EVERY
(100))'
coldef
This input parameter specifies a new column definition for the target table,
allowing you to change the column types as long as they are compatible;
however, the column names must remain the same.
This also provides the ability to add new columns and drop existing columns.
When adding a column, it must be defined as either nullable or have a default
value set. Also, a column can only be dropped if there is a unique or primary
index on the table and the column to be dropped is not a part of that unique
or primary index. This parameter has a data type of VARCHAR(32672). This
Example: 'C1 INT, C2 INT DEFAULT 0'
target_tabname
This input parameter provides the name of an existing table to use as the
target table during the move. The following changes can be made to the target
table being passed in:
v The data, index and LOB table spaces can be changed
v The multi dimensional column (MDC) specification can be added or
changed
v The partitioning key columns specification can be added or changed
v The data partitioning specification can be added or changed
v Data compression can be added or removed
251
v A new column definition can be specified; however the same restrictions as

when specifying the coldef parameter apply here.
The following restrictions apply to the named table:
v The table must exist in the same schema as the source table
v The table must be empty
v No typed tables, materialized query tables (MQT), staging tables, remote
tables or clustered tables are permitted
If this parameter is set to NULL or the empty string, the stored procedure uses
the same definition as the source table. This parameter is case sensitive and
has a data type of VARCHAR(128).
options
This input parameter is a string comprised of comma separated values, which
define any options used by the stored procedure. This list of options is not case
sensitive and has a data type of VARCHAR(32672). The list value can be NULL
or the empty string. The following values are valid:
KEEP This option keeps a copy of the original source table under a different
name. If the source table name is T1, then after the move that table
will be automatically renamed to something such as T1AAAAVxo. You
can retrieve the exact name of the source table in the returned protocol
table, under the ORIGINAL key. You may set this option at any point
up to and including the SWAP phase.
COPY_USE_LOAD <load options>
Syntax for COPY_USE_LOAD
NONRECOVERABLE

MESSAGES ON SERVER
COPY
YES
USE TSM
,
TO device/directory
LOAD lib-name
If you specify any load options for COPY_USE_LOAD,

ADMIN_MOVE_TABLE uses an ADMIN_CMD load to copy the data
from the source table to the target table. If you do not specify any
options for COPY_USE_LOAD, then the NONRECOVERABLE option the
db2Load API is used to copy the data from the source table to the
target table. In releases earlier than DB2 Version 9.7 Fix Pack 2, the
FORCE option must be specified if COPY_USE_LOAD is used.
MESSAGES ON SERVER
Specifies that the message file created on the server by the LOAD
command is to be retained in case of load failures. The
WARNINGS entry in the protocol table contain the message
retrieval SQL statement that is required to retrieve all the warnings
and error messages that occur during load, and the message
removal SQL statement that is required to clean up the messages.
Note that with or without the clause, the fenced user ID must have
the authority to create files under the directory indicated by the
DB2_UTIL_MSGPATH registry variable.
COPY YES
Specifies that a copy of the loaded data will be saved. This option
is invalid if forward recovery is disabled.
252
USE TSM
Specifies that the copy will be stored using Tivoli Storage
Manager (TSM).
The number of I/O sessions to be used with TSM or the
vendor product. The default value is 1.
TO device or directory
Specifies the device or directory on which the copy image will
be created.
LOAD lib-name
The name of the shared library (DLL on Windows operating
systems) containing the vendor backup and restore I/O
functions to be used. It can contain the full path. If the full
path is not given, it will default to the path where the user exit
programs reside.
NONRECOVERABLE
Specifies that the load transaction is to be marked as
nonrecoverable and that it will not be possible to recover it by a
subsequent roll forward action. If COPY YES is not used,
NONRECOVERABLE is the default.
COPY_WITH_INDEXES
This option creates indexes before copying the source table; however,
the default is to create the indexes after copying the source table. The
advantages of this option are that index creation after copying requires
a whole table scan per index and that the index creation is a
transaction that requires active log space. If the LOGINDEXBUILD
database configuration parameter is on, significant log space is
required for building the indexes in a short time frame. One
disadvantage of this option is that copy performance is reduced
because indexes need to be maintained on the target table. Also, the
resulting indexes many contain pseudo-deleted keys, and the indexes are
not as well balanced as if the indexes were created after the copy. You
may set the COPY_WITH_INDEXES option at any point up to and
including the COPY phase.
FORCE
If the force option is set, the SWAP phase does not check to see if the
source table has changed its table definition. In releases earlier than
DB2 Version 9.7 Fix Pack 2, the FORCE option must be specified if the
COPY_USE_LOAD is used. You may set this option at any point up to
and including the SWAP phase.
NO_STATS
This option does not start RUNSTATS or any statistic copying on the
target table. If you use the AUTO_RUNSTATS or AUTO_STMT_STATS
database configuration parameters, DB2 will automatically create new
statistics afterwards. For backwards compatibility, STATS_NO is also
accepted. You may set the NO_STATS option at any point up to and
including the SWAP phase.
COPY_STATS
This option copies the statistics from the source table to the target table
before performing the swap. This may cause inaccurate physical
statistics, especially if the page size is changed. However, setting this
option saves computing time as RUNSTATS is not called to compute
253
new statistics. Also, the optimizer may choose the same access plans,
because the statistics are the same. For backwards compatibility,
STATS_COPY is also accepted. You may set the STATS_COPY option at
any point up to and including the SWAP phase.
NO_AUTO_REVAL
This option prevents automatic revalidation on the table, and instead,
re-creates all triggers and views. The NO_AUTO_REVAL option can be
set only in the INIT phase.
REORG
This option sets up an extra offline REORG on the target table before
performing the swap. If you use this option to improve your
compression dictionary, be advised that using the default sampling
approach is a better method to create an optimal compression
dictionary. However, if you require an optimal XML compression
dictionary, then REORG is the only method. You may set the REORG
option at any point up to and including the SWAP phase.
NO_TARGET_LOCKSIZE_TABLE
This option does not keep the LOCKSIZE table option on the target
table during the COPY and SWAP phases. The default is to use the
LOCKSIZE table option on the target table to prevent locking
overhead, when no unique index is specified on the source table.
CLUSTER
This option reads the data from the source table with an ORDER BY
clause when a copy index has been specified using
ADMIN_MOVE_TABLE_UTIL, a clustering index exists on the source
table or a unique index or primary key is defined in the source table.
Note: A copy index will override a clustering index; a clustering index
will be used in preference to a primary key; a primary key will be
used in preference to a unique index.
NON_CLUSTER
This option reads the data from the source table without an ORDER
BY clause regardless of whether a copy index has been specified, a
clustering index exists on the source table, or a unique index or
primary key has been defined in the source table.
Note: When neither CLUSTER or NON_CLUSTER options are
specified, ADMIN_MOVE_TABLE will read the data from the source
table with an ORDER BY clause only when a clustering index exists on
the source table.
LOAD_MSGPATH <path>
This option can be used to define the load message file path.
LOAD_MSGPATH can be used together with COPY_USE_LOAD in the
following situations:
v COPY_USE_LOAD is specified without further options (in other
words, the default COPY_USE_LOAD NONRECOVERABLE is
assumed)
v COPY_USE_LOAD NONRECOVERABLE is specified explicitly
LOAD_MSGPATH cannot be used together with COPY_USE_LOAD
when optional keywords are also specified with COPY_USE_LOAD.
254
If the LOAD_MSGPATH option is not specified, then the default path

is determined by the DB2_UTIL_MSGPATH registry variable.
operation
This input parameter specifies which operation the stored procedure is to
execute. There are two ways of calling the stored procedure: using the MOVE
command to execute all the operations at one time; or by using the individual
commands to execute the table move one step at a time. The main advantage
of this second method is that you control when the SWAP phase actually
occurs, thereby determining when the table is briefly taken offline. This allows
you to make the move during a period of low system activity. If you use the
individual commands, they must be called in the following order: INIT, COPY,
REPLAY, VERIFY (optional), and SWAP.
v MOVE: Performs the entire table move (INIT, COPY, REPLAY, and SWAP
operations) in one step.
v INIT: Verifies that a table move can take place, and initializes all of the data
needed during the table move process (the target table, staging table, and
the triggers on the source table).
v COPY: Copies the content from the source table to the target table. Any
updates, deletes, or inserts occurring on the source table during this time are
captured and stored in the staging table. New indexes are created at the end
of the COPY phase, unless the COPY_WITH_INDEXES option is selected.
Also, if needed, secondary indexes are created on the source and target
tables to improve performance during the REPLAY phase. COPY can be
used only after the INIT phase has completed.
v REDIRECT: Forwards changes directly to the target table instead of
capturing the changes in the staging table.
Note: The REDIRECT command does not work on multi-partitioned systems
on tables that do not have a unique index.
v REVERT: Reverts to the original behavior wherein the staging table captures
the changes.
v REPLAY: Copies into the target table any rows that have changed in the
source table since the COPY phase began. REPLAY can be used only after
the COPY phase has completed.
v VERIFY: Optionally checks if the table contents of the source and target
tables are identical. This process involves obtaining a shared lock on the
source and target tables, replaying any changes that have occurred on the
source table, and then performing a comparison. If the table has a unique
index, this command compares all values between columns that are in both
tables. Otherwise, this command compares all values between columns that
are in both tables (except for LONG, LOB or XML columns). This is an
expensive operation and caution should be taken to decide if it is useful for
your move. VERIFY can be used only after the COPY or REPLAY phases
have completed.
v SWAP: Executes the REPLAY phase until the number of changes applied
during the last scan of the staging table is less than the
REPLAY_THRESHOLD value stored in the protocol table. The source table is
then taken offline briefly to finish the final REPLAY, and then this command
swaps the source table with target table and brings the table back online.
SWAP can be used after the COPY phase has completed, but ideally after the
REPLAY phase has been called.
255
v CLEANUP: Drops the staging table, any non-unique indexes or triggers

created on the source table by the stored procedure, and the source table if
the KEEP option has not been set. CLEANUP can be called if the command
failed during the SWAP phase.
v CANCEL: Cancels a multi-step table move while between phases, or cancels
a failed table move operation. Executing this command requires that the
operation status is not in COMPLETED or CLEANUP state. CANCEL clears
up all intermediate data (the indexes, the staging table, the target table, and
the triggers on the source table).
This parameter is not case sensitive and has a data type of VARCHAR(128).
Authorization
You must have SQLADM or DBADM authority to invoke the
ADMIN_MOVE_TABLE stored procedure. You must also have the appropriate
object creation authorities, including authorities to issue the SELECT statement on
the source table, and to issue the INSERT statement on the target table.

Examples
This example calls the stored procedure using the first method, where the target
table is defined within the procedure, to move a table named T1 which is located
in the schema SVALENTI.
CALL SYSPROC.ADMIN_MOVE_TABLE(
SVALENTI,
T1,
ACCOUNTING,
ACCOUNT_IDX,
ACCOUNT_LONG,
,
,
,
CUSTOMER VARCHAR(80), REGION CHAR(5), YEAR INTEGER, CONTENTS CLOB,
,
MOVE)
The following is an example of output from this query

Result set 1
-----------KEY
-----------------------AUTHID
CLEANUP_END
CLEANUP_START
COPY_END
COPY_OPTS
COPY_START
COPY_TOTAL_ROWS
INDEXNAME
INDEXSCHEMA
INDEX_CREATION_TOTAL_TIME
INIT_END
INIT_START
PAR_COLDEF
256
VALUE
------------------------------------SVALENTI
2009-02-13-11.34.07.609575
2009-02-13-11.34.07.369331
2009-02-13-11.34.05.148018
BY_KEY,OVER_INDEX
2009-02-13-11.34.04.841292
100
T1_INDEX
SVALENTI
0
2009-02-13-11.34.04.552875
2009-02-13-11.34.03.013563
CUSTOMER VARCHAR(80), REGION CHAR(5),
REPLAY_END
REPLAY_START
REPLAY_TOTAL_ROWS
REPLAY_TOTAL_TIME
STATUS
SWAP_END
SWAP_RETRIES
SWAP_START
VERSION
YEAR INTEGER, CONTENTS CLOB

2009-02-13-11.34.06.198369
2009-02-13-11.34.05.164582
100
5
COMPLETE
2009-02-12-11.34.07.214447
0
2009-02-13-11.34.06.244506
09.07.0000
Return Status = 0
This example calls the stored procedure using the second method , where the
target table is created outside the procedure and is then named within the
target_tabname parameter, to move the same table as in the previous example.
The first step is to create the table manually:
CREATE TABLE SVALENTI.T1_TARGET (
CUSTOMER VARCHAR(80),
REGION CHAR(5),
YEAR INTEGER,
CONTENTS CLOB)
IN ACCOUNTING
INDEX IN ACCOUNT_IDX
LONG IN ACCOUNT_LONG
Then call the stored procedure and pass in the name of the target table:
SVALENTI,
T1,
T1_TARGET,
,
MOVE)
The following is an example of output from this query

Result set 1
-----------KEY
-----------------------AUTHID
CLEANUP_END
CLEANUP_START
COPY_END
COPY_OPTS
COPY_START
COPY_TOTAL_ROWS
INDEXNAME
INDEXSCHEMA
INIT_END
INIT_START
PAR_COLDEF
REPLAY_END
REPLAY_START
REPLAY_TOTAL_ROWS
REPLAY_TOTAL_TIME
STATUS
SWAP_END
SWAP_RETRIES
VALUE
------------------------------------------SVALENTI
2009-02-13-11.37.49.283090
2009-02-13-11.37.49.125786
2009-02-13-11.37.47.806060
BY_KEY,OVER_INDEX
2009-02-13-11.37.47.446616
0
T1_INDEX
SVALENTI
1
2009-02-13-11.37.47.287703
2009-02-13-11.37.46.052952
using a supplied target table so COLDEF
could be different
2009-02-13-11.37.48.785503
2009-02-13-11.37.47.822109
0
0
COMPLETE
2009-02-13-11.37.48.977745
0
257
SWAP_START
VERSION
2009-02-13-11.37.48.825228
09.07.0000
Return Status = 0
Use the ADMIN_MOVE_TABLE stored procedure to convert the row-organized

STAFF table into a column-organized table. This example specifies the existing
STAFF2 table as the target table.
OTM01COL,
STAFF,
STAFF2,
COPY_USE_LOAD,
MOVE
)
Use the ADMIN_MOVE_TABLE stored procedure to convert the row-organized

STAFF table into a column-organized table without specifying a target table. The
ORGANIZE BY COLUMN clause must be specified as a parameter so that the
target table is created as a column-organized table.
OTM01COL,
STAFF,
,
,
,
ORGANIZE BY COLUMN,
,
,
,
COPY_USE_LOAD,
MOVE
)
Usage notes
Suggestions for best results when using this procedure
v Avoid making multiple moves into same table space at the same time.
This prevents fragmentation on the target table space.
v Run this procedure when activity on the table is low. Avoid mass data
loads or deletes so that parallel read access is not a problem.
v Use a multi-step move operation. The INIT and COPY phases can be
called at any time. Execute the REPLAY phase multiple times in order to
keep the staging table size small, and then issue the SWAP during a
time of low activity on the table.
v Check if offline methods are a better choice for your table move,
especially when considering tables without unique indexes and for
tables with no index.
Operations that are restricted on the source table
The stored procedure relies on triggers to capture any changes made to the
source table. There are some operations that could affect the source table
but which do not fire triggers. This could result in inconsistencies between
the source and target table that cannot easily be detected by the stored
procedures. These operations include:
v TRUNCATE TABLE (without restrict when delete triggers)
v IMPORT ... REPLACE INTO ...
258
v LOAD TABLE
v ALTER TABLE
v REORG (both online and offline)
These operations will be restricted on the source table using a new
table-level state flag. The flag is set during the INIT phase and cleared
during the CLEANUP or CANCEL phase. Restricted operations will fail
with SQL0668N reason code 10 (sqlstate 57016).
Operations that will affect the table move operation
There are operations that can cause the stored procedure to fail while a
move is in progress. These operations include:
v Dropping the SYSTOOLSPACE table space
v Dropping/Renaming the source table
v Dropping/Renaming any of the temporary objects created by OTM in
the INIT phase (target table, staging table, triggers on source table,
protocol table)
v Altering values in the protocol table that are not listed as user
configurable
Naming convention for temporary objects
To avoid naming conflicts when creating temporary objects, the following
naming convention is used:
v Postfix
t for target
s for staging
o for original
g for generated
i for insert trigger
d for delete trigger

u for before update trigger
v for after update trigger
v Names are built consisting of <characters from name of
object><base64 encoded hash key over name of object><postfix>.
v If length of name would exceed object length (128 bytes) <characters
from name of object> gets shorter.
v Hash value gets calculated from the object name and is encoded similar
to base64 encoding.
Sample:
Name of object: T1
Staging object: T1AAAAVxs
Target object: T1AAAAVxt
Original object: T1AAAAVxo
Generated index: T1AAAAVxg (if table has no index)
Insert trigger: T1AAAAVxi
Delete trigger: T1AAAAVxd
Before update trigger: T1AAAAVxu
After update trigger: T1AAAAVxv
Online table move with compression and dictionary creation

There are several methods to create a data compression dictionary using
Online Table Move. Compression must either be enabled on the source
table or specified to be active in the new table definition if provided.
259
Create dictionary with sampling is the default method of Dictionary

creation through Online Table Move. If compression is turned on for the
table, then before performing the COPY operation, a system sampling of the
data from the source table is inserted into the target table, where the
amount of data sampled is specified in the DEEPCOMPRESSION_SAMPLE
field in the protocol table. The compression dictionary is then created
based off of this random sample, and therefore results in an optimal
compression dictionary.
Please note, that an XML compression dictionary will not be created
through the sampling method. This is due to the fact that db2Inspect is
used to create the compression dictionary, and db2Inspect currently does
not have the ability to create an XML compression dictionary. The XML
compression dictionary will be created through automatic dictionary
creation (ADC).
Create dictionary with automatic dictionary creation (ADC) is the standard
method of Dictionary creation with tables in DB2. By simply turning on
compression for the table, DB2 will automatically create the dictionary as
data is inserted into the table. This will result in a non-optimal
compression dictionary. Please note that the
DEEPCOMPRESSION_SAMPLE field in the protocol table will have to be
set to 0 to avoid having the stored procedure attempt to create a better
compression dictionary.
The create dictionary with REORG method of Dictionary creation results in
a dictionary being created that reflects any activity on the source table that
occurred while the COPY phase was in process. This is done by
performing a REORG before the SWAP phase with the
RESETDICTIONARY option set. An optimal dictionary will be created,
however depending on the size of the table the REORG could take a long
time. Also, if an optimal XML dictionary is required, REORG is the only
method that will produce one. It is advised to use the sampling method of
dictionary creation.
Online table move and statistics on the table
If you are using the COPY_USE_LOAD option and the source table has a
statistics profile set, the load operation will collect statistics on the target
table.
The default behavior when performing a table move on a table where
statistics are collected is to perform RUNSTATS on the table during the SWAP
phase. ADMIN_MOVE_TABLE attempts to create statistics only if the
target table does not yet have any statistics. If the target table does not yet
have statistics and you want to minimize the duration of the SWAP phase,
invoke RUNSTATS before the SWAP phase. If a statistics profile is found,
RUNSTATS will be called using the statistics profile. Otherwise, RUNSTATS will
be called with the options WITH DISTRIBUTION ON COLUMNS (...)
AND SAMPLE DETAILED INDEXES ALL.
If the COPY_STATS option has been set, the statistics from the source table
are copied to the target table before performing the swap. Copying
statistics may cause inaccurate physical statistics especially if changing
page size. However, it will save on computing time as RUNSTATS does not
have to be called to compute new statistics. Also, the optimizer may
choose the same access plans, because the statistics are the same (plan
260
stability). The statistics that are copied are in the SYSSTAT.TABLES,

SYSSTAT.COLUMNS, SYSSTAT.COLDIST, SYSSTAT.INDEXES, and
SYSSTAT.COLGROUPS catalog views.
If the NO_STATS option has been set, the stored procedure does not perform
RUNSTATS or any statistic copying on the target table. If you use
AUTO_RUNSTATS or AUTO_STMT_STATS, DB2 will automatically create new
statistics
Online table move with LOAD used for COPY
If you are using the COPY_USE_LOAD option, and if you do not specify a
sub-option or you choose NONRECOVERABLE, then it is necessary to perform a
backup of the target table space or table spaces before the SWAP phase in
order to ensure recoverability. A backup can be created by issuing a
statement such as the following:
BACKUP DB dbname TABLESPACE targetDataTablespace,
targetIndexTablespace, targetLongTablespace
ONLINE TO <destination>
Online table move with recoverable LOAD in HADR environment

If the destination for a recoverable LOAD in an HADR environment cannot
be found from the standby, the table space will be inaccessible. The
primary is not informed about this situation, so you might assume that the
standby is up to date, but if there is a failover to the standby the table will
not accessible.
In releases earlier than DB2 Version 9.7 Fix Pack 2, the FORCE option must
be specified if the COPY_USE_LOAD is used. Else, the SWAP phase will not
execute and you will receive an error.
Online table move with generated columns
The Table Move stored procedure treats any generated columns in the
source table specially. The following paragraphs describe how the different
types of generated columns are handled.
A row change timestamp column is a column that holds a timestamp
representing the time when a row was last changed.
If a row change timestamp column is found in the source table, the values
of this column after the table move operation is complete will not be the
same as they where before the table move operation. The values of the
column after the table move will represent the time at which the rows
where inserted/updated in the new table object. This is done because the
actual rows are being changed and the row change timestamp column
values should therefore reflect these changes.
If a new table definition is supplied, and a column is defined as a row
change timestamp column in the source table but not in the new table
definition, then the column will not be a row change timestamp column.
An identity column is a column that automatically generates a value for
the column when a row is inserted into the table.
If an identity column is found in the source table, the values of this
column after the Table Move operation is complete will be identical to the
values that were present before the table move operation. However, there
is no way to determine the last/next value for the identity column in the
source table. Therefore, when creating the identity column on the target
table the value generation will be set to begin from the next uncached
value. This is the same behavior that happens when the database restarts
261
(stop/start). This behavior is documented in the information center, in the

ALTER TABLE entry, under the SET NO CACHE or CACHE
integer-constant heading of the identity-alterationsection which can be
found here.
The column will initially be created as a regular column in the target table,
and then be altered to be an identity column during the brief offline period
of the SWAP phase. This is done because the column may have been
created as GENERATED ALWAYS, and that would block the stored
procedure from being able to insert the exact values from the source table
into the column in the target table.
If a new table definition is specified, and a column is specified to be an
identity column in the new table definition, then the stored procedure will
check to see if the definition of the identity column matches the definition
of the column in the source table. If they are a match, the stored procedure
will continue as previously described. If they are not a match, the stored
procedure will use the new identity column definition. Please note that this
will restart the identity column counter with whatever the start value is
specified as, however the current values of the rows in the column will
remain the same.
If a new table definition is specified, and a column that is specified as an
identity column in the source table is not specified as an identity column
in the new table definition, then the stored procedure will still create the
column as an identity column in the target table using the same
specification found in the source table. This is done so that users do not
need to look up the definition of the existing identity column and re-enter
it into the new table definition. If the user does not want to keep the
column as an Identity column, then they can alter the target table after the
call to the stored procedure to remove the identity specification from the
column.
An expression column is a column that automatically generates a value for
the column based on an expression when a row is inserted into the table.
If an expression column is found in the source table, the values of this
column after the Table move operation is complete will be identical to the
values that were present before the table move operation.
The column will originally be created as a regular column in the target
table, and then be altered to be an expression column during the brief
offline period of the SWAP phase. This is done because expression columns
are created as GENERATED ALWAYS, and do not allow inserts into that
column. However, In order to alter the column in the target table to be an
expression column, set integrity will briefly be turned off on the target
table. The ALTER statement is performed, and then integrity is set back on
with the GENERATED COLUMN IMMEDIATE UNCHECKED option.
The stored procedure will not support column expressions that include the
table name (such as table 'T1' with expression (T1.C *5)) in either the
source table or the target table. To remedy this, the user can alter the
column to change the expression to not include the table name.
If a new table definition is specified, and a column is specified to be an
expression column in the new table definition, then the stored procedure
will check to see if the definition of the expression column matches the
definition of the column in the source table by performing a basic string to
string comparison. If they are a match, the stored procedure will continue
as previously described. If they are not a match, the stored procedure will
262
use the new expression column definition. Please note that the current
values of the rows in the column will remain the same.
If a new table definition is specified, and a column that is specified as an
expression column in the source table is not specified as an expression
column in the new table definition, then the stored procedure will still
create the column as an expression column in the target table using the
same specification found in the source table. This is done so that users do
not need to look up the definition of the existing expression column and
re-enter it into the new table definition. If the user does not want to keep
the column as an Expression column, then they can alter the target table
after the call to the stored procedure to remove the Expression
Specification from the column.
Online table move and objects and privileges that are preserved
The stored procedure will preserve the following objects when a Table
Move is performed:
Views During the brief offline period during the SWAP phase, the views
are dropped from the source table and are re-created on the target
table.
Transfer of ownership is also performed to change the ownership
of the view back to the original owner.
The granted privileges for the views are preserved only if the
auto_reval configuration parameter is set to DEFERRED.
Triggers
During the brief offline period during the SWAP phase, the triggers
are dropped from the source table and are re-created on the target
table.
Transfer of ownership is also performed to change the ownership
of the trigger back to the original owner.
Indexes
Indexes are created onto the target table at several times during the
table move procedure. Indexes are first created at the end of the
COPY phase, unless the COPY_WITH_INDEXES option is set then the
indexes will first be created at the beginning of the COPY phase.
The store procedure will then also look for any newly created
indexes, judging by index name alone, at the beginning of the
REPLAY and SWAP phases. If new indexes are found, they will be
created. However, the stored procedure will not look to see if any
indexes have been deleted on the source table.
The index names will be the same as they were on the source table
for user created indexes. However, system created indexes can not
be guaranteed to have the same name.
The indexes that will be preserved are of the following type:
'REG','CLUST', and 'XVIL'.
Any user created indexes that reference a column that is being
dropped in the target table will not be preserved.
When moving from a source partitioned table to a target
partitioned table, the partitioned attribute of the index will be
preserved. When moving from a source partitioned table to a target
263
non-partitioned table, or vice-versa, the partitioned attribute will be

decided by the default behavior of the database.
Constraints
Constraints (other than referential constraints) are re-created on the
target table using the same constraint names. However, for unique
and primary constraints the underlying index name may be
different than the index name on the source table.
Table flags
The table flags of the source table are created on the target table as
soon as the target table is created in the INIT phase. These flags
are: 'append_mode', 'locksize', 'volatile', 'compression',
'datacapture', 'pctfree', 'logindexbuild', 'owner', and 'droprule'.
These flags are then checked at the end of the COPY phase and
during the SWAP phase. If there are any changes in the flags they
will be updated in the target table.
To keep the database recoverable and compatible with HADR
setups, ADMIN_MOVE_TABLE does not copy the NOT LOGGED
INITIALLY information from the source to the target table.
Grant/Revoke
During the SWAP phase, the stored procedure will go through the
entries in SYSCAT.TABAUTH and reproduce the granting of privileges
on the table to users/groups/roles.
If the caller of the stored procedure does not have ACCESSCTRL
or SECADM authority then the CONTROL privilege cannot be
granted. A list of all users/groups/roles that were not granted the
CONTROL privilege can be found in the protocol table where the
key is WARNINGS.
Usage lists
During the brief offline period during the SWAP phase, usage lists
defined on the source table or on the source table indexes are
dropped and re-created on the target table. Any usage list that was
in the active state before the move will be re-activated after the
move.
Please note that if auto_revalidation is enabled on the database, and the
USE_AUTO_REVAL option is set (which is the default if auto_revalidation is
enabled), then the views will not be dropped as outlined previously.
Instead, the views will remain and be re-validated with auto_revalidation.
Triggers will be dropped and re-created by the stored procedure as there is
currently a limitation with renaming a table with a trigger defined as the
subject.
Online table move with clustering over an index
It is possible to cluster the target table by an index. If a cluster index is
present on the source table, it will be clustered by that index by default.
The default can be changed after the INIT phase (This implies phase wise
execution of Online Table Move). Calling Online Table Move in one MOVE
phase with no cluster index present will result in the stored procedure
clustering the target table with the unique/primary index. If a cluster
index exists, the stored procedure will cluster the target table using the
cluster index.
If there is a cluster index on the source table, it is possible to not cluster
the target table on the cluster index by performing a multi-step move and
264
deleting the key entries COPY_INDEXSCHEMA and COPY_INDEXNAME

from the protocol table after the INIT phase.
It is possible to cluster the target table by any secondary index by
performing a multi-step move and inserting/updating the key entries
COPY_INDEXSCHEMA and COPY_INDEXNAME in the protocol table
with the required index to cluster the target table.
Changing index attributes
If a user wants to modify the attributes of any existing attributes (such as
index clustering, index compression, change global to local indexes and
vice versa) they can manually make these changes during a multi-step
move operation.
This can be done by performing the INIT and COPY phases of the move
via a multi-step move. Then manually make any changes to the indexes on
the target table. The name of the target table can be found in the protocol
table. After the modifications have finished, resume with the REPLAY and
SWAP phases.
Using ADMIN_MOVE_TABLE to convert row-organized tables into
column-organized tables
Conversion can be achieved in either of the following two ways:
v By specifying a column-organized target table
v By specifying the ORGANIZE BY COLUMN clause as the
organize_by_clause parameter.
The ADMIN_MOVE_TABLE stored procedure remains online. When a
row-organized table is being moved into a column-organized table,
applicable column-organized table restrictions on queries (that is, limited
isolation levels) start at the end of processing, after the new table becomes
visible to queries.
ADMIN_MOVE_TABLE requires triggers on the source table to capture
changes. Because triggers are currently not supported on column-organized
tables, the source table cannot be a column-organized table (SQL2103N).
Indexes on column-organized tables are not supported.
ADMIN_MOVE_TABLE silently converts primary key and unique indexes
into primary key or unique constraints and ignores all non-unique indexes.
Because an ALTER TABLE ADD UNIQUE CONSTRAINT statement cannot
specify columns that allow null values, create unique constraints on the
target table before calling the ADMIN_MOVE_TABLE stored procedure.
The DISTRIBUTE BY HASH clause is not supported for column-organized
tables in the DB2Version 10.5 release; specify '-' for the partkey_cols
parameter to ignore the DISTRIBUTE BY HASH clause.
The PARTITION BY RANGE clause is not supported for column-organized
tables in the DB2Version 10.5 release; specify '-' for the data_part
parameter to ignore the PARTITION BY RANGE clause.
MDC or ITC tables are converted into column-organized tables when you
specify ORGANIZE BY COLUMN for the organize_by_clause parameter.
When the load utility is used to populate a column-organized target table,
ADMIN_MOVE_TABLE inherits column-organized table restrictions that
apply to the load utility.
The REORG option is not supported.
265
A long offline SWAP phase occurs when the table has foreign key
(referential integrity) constraints defined on it, because the foreign key
relationship must be checked.
Restrictions
The following restrictions apply to the ADMIN_MOVE_TABLE stored procedure:
v Only simple tables are supported as the source table. No materialized query
tables, typed tables, range clustered tables, system tables, views, nicknames, or
aliases are permitted.
v A table cannot be moved if there is an index with an expression-based key
defined on the table.
v A table cannot be moved if an event monitor is currently active on the table.
v Tables without a unique index are subject to a complex and potentially
expensive replay phase.
v A unique index is required if the table contains LOB, XML, or LONG columns.
v A generated column cannot be part of the MDC specification.
v There is no support for text search indexes.
v Be aware of the large disk space requirements, as the procedure creates two
copies of the table and indexes, plus a staging table and log space.
v Copy performance may be an issue as most of the data is moved to the new
table using insert from select form.
v The VERIFY operation for tables without a unique index does not work on
tables with LOBs.
v In releases earlier than DB2 Version 9.7 Fix Pack 2, the DB2_SKIPDELETED registry
variable cannot be set to ON.
v The SYSTOOLSPACE table space must be created and accessible to 'PUBLIC'.
v Lock timeouts are possible during the COPY phase because of long running
transactions on the source table.
v Deadlocks can occur during the SWAP phase.
v Deadlocks can occur on a source table with non-unique indexes and several
update processes.
v With VARCHAR2 support enabled, the database treats the empty string and
NULL as equivalent values, but the single blank is a distinct value. With
VARCHAR2 support enabled, the mdc_cols, partkey_cols, and data_part parameters
can use a single blank as distinct from the empty string and NULL.
v A table cannot be moved if it is in the Set Integrity Pending state.
v A table cannot be moved if there are any XSR objects dependent on it.
Table 74. Information returned by the ADMIN_MOVE_TABLE stored procedure
Column name
Data type
Description
TABSCHEMA
VARCHAR(128)

monitor element
TABNAME
VARCHAR(128)

element
KEY
VARCHAR(32)
Name of the attribute.
VALUE
CLOB(10M)
Value of the attribute.
266
The key and value pairs that are returned in the result set can be found in
Table 75. To modify the user configurable keys in the result set, use the
ADMIN_MOVE_TABLE_UTIL stored procedure.
Table 75. Key and value pairs returned by the ADMIN_MOVE_TABLE stored procedure
Key
Return Value
User Configurable
AUTHID
Displays the authorization ID of the user who called

the stored procedure.
No
CLEANUP_END
Displays the CLEANUP phase end time.
No
CLEANUP_START
Displays the CLEANUP phase start time.
No
COMMIT_AFTER_N_ROWS
During the COPY phase, a commit is executed after

this many rows are copied. 0 means no commits
during COPY. Default value is 10000.
Yes
COPY_ARRAY_SIZE
Specifies the ARRAY size for COPY_ARRAY_INSERT. Yes

A value less than or equal to 0 means do not use
COPY_ARRAY_INSERT. Default value is 100.
COPY_END
Displays the COPY phase end time.
COPY_INDEXNAME
The name of the index used to cluster the data on the Yes
target table during the COPY phase. This value must
be set before the COPY phase. The default name is
the name of a cluster index on the source table, if it
exists; otherwise the name of the unique or primary
index on the source table.
COPY_INDEXSCHEMA
The schema of the index used to cluster the data on

the target table during the COPY phase. This value
must be set before the COPY phase. The default
schema is the schema name of a cluster index on the
source table, if it exists; otherwise the schema name
of the unique or primary index on the source table.
Yes
COPY_OPTS
The copy options used during the COPY phase.
No
COPY_START
Displays the COPY phase start time.
No
COPY_TOTAL_ROWS
Displays the total number of rows copied during the

COPY phase.
No
DEEPCOMPRESSION_SAMPLE
If the source table has compression enabled, this field Yes

specifies how much data (in KB) is sampled when
creating a dictionary for compression. 0 means no
sampling is done. Default value is 20MB (20480 KB).
Displays the total time required for creating

secondary indexes.
INDEXNAME
Displays the name of the index or the empty string if No

the table does not have an index.
INDEXSCHEMA
Displays the schema of the index or the empty string

if the table does not have an index.
No
INIT_END
Displays the INIT phase end time.
No
INIT_START
Displays the INIT phase start time.
No
LOCK
Displays the LOCK start time if another online table

move stored procedure call is active, otherwise it is
empty.
No
ORIGINAL
Displays the name of original table after the swap.
No
No
No
267
Table 75. Key and value pairs returned by the ADMIN_MOVE_TABLE stored procedure (continued)
Key
Return Value
User Configurable
REORG_USE_TEMPSPACE
If you call the REORG option, you can also specify a

temporary table space for the USE clause of the
REORG command. If a value is not specified here,
the REORG command uses the same table space as
the table being reorganized.
Yes
REPLAY_END
Displays the REPLAY phase end time.
No
REPLAY_MAX_ERR_RETRIES
Specifies the maximum retry count for errors (lock

timeouts or deadlocks) that may occur during the
REPLAY phase. Default value is 100.
Yes
REPLAY_START
Displays the REPLAY phase start time.
No
REPLAY_THRESHOLD
For a single iteration of the REPLAY phase, if the

number of rows applied to the staging table is less
than this value, then REPLAY stops, even if new
entries are made in the meantime. Default value is
100.
Yes
REPLAY_TOTAL_ROWS
Displays the accumulated number of replayed rows.
No
REPLAY_TOTAL_TIME
Displays the accumulated time in seconds used for

replaying rows.
No
STAGING
Displays the name of the staging table.
No
STATUS
Displays the current status of the online table move:
No
v INIT: INIT is in progress

v COPY: COPY is in progress or is possible
v REPLAY: REPLAY is in progress or REPLAY and
SWAP are possible
v CLEANUP: MOVE is complete, but cleanup has
not finished or CLEANUP is possible
v COMPLETE: MOVE and CLEANUP are complete
v COMPLETE_WITH_WARNINGS: MOVE and
CLEANUP are complete, however there are
warnings (listed under the WARNINGS key).
SWAP_END
Displays the SWAP phase end time.
No
SWAP_MAX_RETRIES
Specifies the maximum number of retries allowed

during the SWAP phase (if lock timeouts or
deadlocks occur). Default value is 10.
Yes
SWAP_RETRIES
Displays the number of retries performed during

SWAP phase.
No
SWAP_START
Displays the SWAP phase start time.
No
TARGET
Displays the name of the target table.
No
UTILITY_INVOCATION_ID
Displays the unique identifier for the table move

operation.
No
VERIFY_END
Displays the verification end time.
No
VERIFY_START
Displays the verification start time.
No
VERSION
Displays the version of the stored procedure.
No
268
Table 75. Key and value pairs returned by the ADMIN_MOVE_TABLE stored procedure (continued)
Key
Return Value
User Configurable
WARNINGS
Displays warnings to pass on to the user. These

warnings include:
No
v Revalidation of all failed objects

v Control could not be granted to a user, group, or
role
v An index was not created because a column it
references no longer exists
ADMIN_MOVE_TABLE_UTIL procedure - Modify the online move

table procedure
The ADMIN_MOVE_TABLE_UTIL procedure works in conjunction with the
SYSPROC.ADMIN_MOVE_TABLE stored procedure when moving active table
data. This stored procedure provides a mechanism to alter the user definable
values in the ADMIN_MOVE_TABLE protocol table, which is created and used by
the ADMIN_MOVE_TABLE procedure.
This procedure will only modify a value in the ADMIN_MOVE_TABLE protocol
table if a table move for the table referenced by the TABSCHEMA and TABNAME
parameters is already in progress, and the authorization ID of the caller of the
procedure is the same as the user executing the table move.
Syntax
ADMIN_MOVE_TABLE_UTIL ( tabschema , tabname , action , key , value )
The schema for this stored procedure is SYSPROC.
tabschema
This input parameter specifies the name of the schema containing the table
being moved. This name is case sensitive. and has a data type of
VARCHAR(128).
tabname
This input parameter specifies the name of the table being moved. This
parameter is case sensitive and has a data type of VARCHAR(128)
action
This input parameter specifies the action for the procedure to execute.
Valid values are:
v UPSERT: If the specified TABSCHEMA.TABNAME.KEY exists in the
ADMIN_MOVE_TABLE protocol table, this updates the corresponding
VALUE with the new value parameter. Otherwise, this inserts the KEY and
VALUE pair into the ADMIN_MOVE_TABLE protocol table.
v DELETE: If the specified TABSCHEMA.TABNAME. KEY exists in the
ADMIN_MOVE_TABLE protocol table, this deletes the specified KEY and
VALUE pair from the ADMIN_MOVE_TABLE protocol table.
This parameter has a datatype of VARCHAR(128).
269
key
This input parameter specifies the key that to "upsert" or delete in the
ADMIN_MOVE_TABLE protocol table.
Valid values are:
v COMMIT_AFTER_N_ROWS: During the COPY phase, a commit is executed
after this many rows are copied. A value of 0 means no commits are
executed during COPY.
v DEEPCOMPRESSION_SAMPLE: If the source table has compression
enabled, this field specifies how much data (in KB) is sampled when
creating a dictionary for compression. A value of 0 means no sampling is
done.
v COPY_ARRAY_SIZE: Specifies the ARRAY size for COPY_ARRAY_INSERT,
a value less than or equal to 0 means do not use COPY_ARRAY_INSERT.
v COPY_INDEXSCHEMA: The schema of the index used to cluster the data
on the target table during the COPY phase.
v COPY_INDEXNAME: The name of the index used to cluster the data on the
target table during the COPY phase.
v REPLAY_MAX_ERR_RETRIES: Specifies the maximum retry count for errors
(lock timeouts or deadlocks) that may occur during the REPLAY phase.
v REPLAY_THRESHOLD: For a single iteration of the REPLAY phase, if the
number of rows applied to the staging table is less than this value, then
REPLAY stops, even if new entries are made in the meantime.
v REORG_USE_TEMPSPACE: If you call the REORG option in the table move,
you can also specify a temporary table space for the USE clause of the
REORG command. If a value is not specified here, the REORG command
uses the same table space as the table being reorganized.
v SWAP_MAX_RETRIES: Specifies the maximum number of retries allowed
during the SWAP phase (if lock timeouts or deadlocks occur).
This parameter has a data type of VARCHAR(128).
value
This input parameter specifies the value to "upsert" into the
ADMIN_MOVE_TABLE protocol table. This parameter has a data type of
CLOB(10M). The parameter can be NULL or the empty string.
Authorization
One of the following authorizations is required to use the routine:
v EXECUTE privilege on the ADMIN_MOVE_TABLE_UTIL procedure
v DBADM authority
v SQLADM authority
In addition, the authorization ID used must be the same as the one used to call the
ADMIN_MOVE_TABLE stored procedure.

270
Examples
This example covers a basic call to the stored procedure in order to update the
compression value and remove the specific index information used for the target
table copying.
First, the ADMIN_MOVE_TABLE procedure is called to start the table move
process before calling the ADMIN_MOVE_TABLE_UTIL procedure in order to
update or delete a value in the ADMIN_MOVE_TABLE protocol table:
CALL SYSPROC.ADMIN_MOVE_TABLE(SVALENTI,T1,,,,,,,,,INIT)
Next, update the DEEP_COMPRESSION_SAMPLE value to 30720 KB:

CALL SYSPROC.ADMIN_MOVE_TABLE_UTIL(SVALENTI,T1,UPSERT,
DEEPCOMPRESSION_SAMPLE,30720)
Now, delete the COPY_INDEXSCHEMA and COPY_INDEXNAME values:

CALL SYSPROC.ADMIN_MOVE_TABLE_UTIL(SVALENTI,T1,DELETE,COPY_INDEXSCHEMA,)
CALL SYSPROC.ADMIN_MOVE_TABLE_UTIL(SVALENTI,T1,DELETE,COPY_INDEXNAME,)
After these changes, continue the ADMIN_MOVE_TABLE procedure using the new
values in the meta table:
CALL SYSPROC.ADMIN_MOVE_TABLE(SVALENTI,T1,,,,,,,,,COPY)
CALL SYSPROC.ADMIN_MOVE_TABLE(SVALENTI,T1,,,,,,,,,REPLAY)
CALL SYSPROC.ADMIN_MOVE_TABLE(SVALENTI,T1,,,,,,,,,SWAP)
Usage notes
More information regarding the changeable KEY values in the
ADMIN_MOVE_TABLE protocol table is available in the Usage notes section of the
ADMIN_MOVE_TABLE procedure.
ADMIN_REMOVE_MSGS procedure - Clean up messages

generated by a data movement utility that is executed through
the ADMIN_CMD procedure
The ADMIN_REMOVE_MSGS procedure is used to clean up messages generated
by a single execution of a data movement utility command through the
The input parameter operation_id identifies the operation.
Syntax
ADMIN_REMOVE_MSGS (
operation_id
Procedure parameter
operation_id
An input argument of type VARCHAR(139) that specifies the operation ID of
the message file(s) produced by a data movement utility that was executed
through the ADMIN_CMD procedure. The operation ID is generated by the
271
Authorization
EXECUTE privilege on the ADMIN_REMOVE_MSGS procedure. The fenced user
ID must be able to delete files under the directory indicated by registry variable
DB2_UTIL_MSGPATH. If the registry variable is not set, then the fenced user ID must
be able to delete the files in the tmp subdirectory of the instance directory.

Example
Clean up messages with operation ID '24523_THERESAX'.
CALL SYSPROC.ADMIN_REMOVE_MSGS(24523_THERESAX)
Usage notes
The CALL statement that invokes this procedure with the appropriate operation_id
can be found in the MSG_REMOVAL column of the first result set returned by
ADMIN_REVALIDATE_DB_OBJECTS procedure - Revalidate

invalid database objects
The ADMIN_REVALIDATE_DB_OBJECTS procedure revalidates database objects.
This procedure takes various input parameters that control the level of revalidation
that is performed:
v To revalidate all of the invalid objects in the database, either specify NULL for
all parameters, or call the procedure without parameters.
v To revalidate all of the invalid database objects under a specific schema, specify
a value for object_schema, and specify NULL for object_name and object_type.
v To revalidate a specific invalid database object, specify valid values for the first
parameters.
v To force the revalidation of compiled SQL PL or PL/SQL objects regardless of
their state being valid or invalid, specify a value for object_type, object_schema,
object_name, and specify 'Y' for force.
v To enable or disable debug on compiled SQL PL or PL/SQL objects being
revalidated, specify 'Y' or 'N' for debug_flag.
Syntax
ADMIN_REVALIDATE_DB_OBJECTS (
object_name ,
force
object_type
, debug_flag
, object_schema
object_type
An input argument of type VARCHAR(30) that identifies the type of the
database object. The following types are valid:
272

v
v
v
v
v
FUNCTION
GLOBAL VARIABLE
MASK
METHOD
MODULE
v
v
v
v
v
v
v
PERMISSION
PROCEDURE
SPECIFIC
TABLE
TRIGGER
TYPE
USAGELIST
v VIEW
This value is not case-sensitive. This value can be a null value which means
that all of the object types are considered.
If any of these types is specified, the procedure revalidates all of the invalid
objects of that type, with the exception of those that belong to a MODULE. If
you want to revalidate objects that are inside of a module, use the MODULE
type with the name of a specific module, and all of the invalid objects inside of
that module will be revalidated.
If there is a routine that has more than one parameter signature and you only
want to revalidate one of them, use the SPECIFIC type with the name of the
routine that you want to revalidate.
If you use the TABLE type, the specified tables will be reorganized and their
statistics will be collected. The procedure invokes the reorg utility, followed by
the runstats utility, against regular or materialized query tables that are in
reorg-pending state. The procedure will attempt to use a user profile for
runstats, if one exists. If not, a default runstats operation is invoked.
object_schema
An input argument of type VARCHAR(128) that identifies the schema name
used to qualify database object references. The name is case-sensitive. This
value can be NULL.
object_name
An input argument of type VARCHAR(128) that identifies a database object.
The name is case-sensitive. This value cannot be the value of a typed table or a
row function, because the procedure does not support these types of objects; if
the name of such an object is specified, an error is returned. This value can be
NULL.
force
An input argument of type CHAR(1) to indicate if revalidation should be
forced for the following objects (regardless of their current state).
v All SQL PL and PL/SQL objects if the invoking user holds DBADM
authority.
v SQL PL and PL/SQL objects that the invoking user owns.
The argument is ignored for SQL PL and PL/SQL objects that do not meet the
criteria listed previously and for any object that is not a SQL PL or PL/SQL
object.
273
Values are:
v 'Y' or 'y' - All compiled SQL PL and PL/SQL objects will be revalidated.
v 'N', 'n' or NULL - Default behavior, only invalid objects will be revalidated.
debug_flag
An input argument of type CHAR(1) to indicate whether debug mode is
enabled or disabled for the following objects processed by the procedure:
v All SQL PL and PL/SQL objects if the invoking user holds DBADM
authority or is a member of the built-in role, SYSDEBUG.
v SQL PL and PL/SQL objects that the invoking user owns.
The argument is ignored for SQL PL and PL/SQL objects that do not meet the
criteria listed previously and for any object that is not a SQL PL or PL/SQL
object.
Values are:
v 'Y' or 'y' - Compiled SQL PL and PL/SQL objects are revalidated with the
debug mode enabled.
v 'N' or 'n' - Compiled SQL PL and PL/SQL objects are revalidated with the
debug mode disabled.
v NULL - Compiled SQL PL and PL/SQL objects are revalidated with no
change in the debug mode. This is the default behavior.
Authorization
One of the following authorities is required:
v EXECUTE privilege on the ADMIN_REVALIDATE_DB_OBJECTS procedure
v SECADM authority when object_type is MASK or PERMISSION
When the value for the force option is 'Y', the invoking user must either be the
owner of the object being revlaidated or hold DBADM authority.
When the value for the debug_flag option is 'Y', the invoking user must be the
owner of the object, hold DBADM authority, or be a member of the SYSDEBUG
system defined role.

Examples
Example 1: Revalidate everything in the current database.
CALL SYSPROC.ADMIN_REVALIDATE_DB_OBJECTS(NULL, NULL, NULL)
Or, alternatively, call the procedure without any parameters.

CALL SYSPROC.ADMIN_REVALIDATE_DB_OBJECTS()
Example 2: Revalidate all objects that are qualified by the schema MY_SCHEMA.
CALL SYSPROC.ADMIN_REVALIDATE_DB_OBJECTS(NULL, MY_SCHEMA, NULL)
Example 3: Revalidate all trigger objects in the database.

CALL SYSPROC.ADMIN_REVALIDATE_DB_OBJECTS(trigger, NULL, NULL)
274
Example 4: Revalidate a specific view object.

CALL SYSPROC.ADMIN_REVALIDATE_DB_OBJECTS(view, MY_SCHEMA, MY_VIEW)
Example 5: Revalidate all procedures under MY_SCHEMA. In this example, there

are three procedures (proc1, proc2, and proc3) under this schema. The referenced
object used by proc1 does not exist. The following call revalidates proc2 and proc3,
but proc1 remains invalid. In this situation, the call returns a warning.
CALL SYSPROC.ADMIN_REVALIDATE_DB_OBJECTS(procedure, MY_SCHEMA, NULL)
Example 6: Revalidate an object that does not exist. This example returns an error.
CALL SYSPROC.ADMIN_REVALIDATE_DB_OBJECTS(procedure, MY_SCHEMA, MY_VIEW)
Example 7: Revalidate all procedures under MY_SCHEMA using the named

parameter notation.
CALL SYSPROC.ADMIN_REVALIDATE_DB_OBJECTS(
object_type=>PROCEDURE,object_schema=>MY_SCHEMA)
Usage notes
All of the non-null parameter values that are passed to the
ADMIN_REVALIDATE_DB_OBJECTS procedure must be satisfied, or the
procedure cannot identify the objects that need to be revalidated. For example, if
you specify a view name, but with a trigger type, the procedure does not
revalidate the view, because the type does not match.
This procedure will revalidate only invalid objects and regular or materialized
query tables in reorg-pending state. All invalid objects can be found in
SYSCAT.INVALIDOBJECTS. To find out which tables are in reorg-pending state,
use the ADMIN_GET_TAB_INFO table function.
If a valid object is specified as input, the procedure will not perform any operation
and returns a success code. If a failure occurs during the revalidation of tables, the
procedure fails. If a failure occurs during the revalidation of other objects, the
procedure ignores the failure and continues revalidating the other objects. If there
is at least one failure, the procedure returns a warning (SQLSTATE 0168B). If the
revalidation of all objects fails, the procedure returns an error (SQLSTATE 429C4).
The details of all revalidation failures of objects except tables can be found in
SYSCAT.INVALIDOBJECTS.
In order to revalidate invalid masks or permissions, the user that runs
ADMIN_REVALIDATE_DB_OBJECTS must have SECADM authority. If there is at
least one failure, and the first failure is because the user does not have SECADM
authority during revalidation of a mask or permission, the procedure returns a
warning (SQLSTATE 0168B, SQLCODE +361), msg-token2 contains CREATE
PERMISSION or CREATE MASK. If the revalidation of all objects fails, and the
first failure is because the user does not have SECADM authority during
revalidation of a mask or permission, the procedure returns an error (SQLSTATE
42501, SQLCODE -551).
When a global variable is revalidated, it is also instantiated for the current session.
To monitor the progress of a table revalidation, you can monitor the progress of
the associated table reorg operation. For all other objects, query the
SYSCAT.INVALIDOBJECTS catalog view; objects are deleted from this view when
they are successfully revalidated, and entries are updated if revalidation fails.
275
ADMIN_SET_INTRA_PARALLEL procedure - Enables or disables

intrapartition parallelism
The ADMIN_SET_INTRA_PARALLEL procedure enables or disables intrapartition
parallelism for a database application. Although the procedure is called in the
current transaction, it takes effect starting with the next transaction.
Syntax
ADMIN_SET_INTRA_PARALLEL (
state
state
An input argument of type VARCHAR(3) that specifies the required state of
intrapartition parallelism for the database application. The argument can be
one of the following values:
YES, or yes
The database application starts to run with intrapartition parallelism
enabled starting with the next transaction.
NO, no
The database application starts to run with intrapartition parallelism
disabled starting with the next transaction.
NULL The database application starts to run with the intrapartition
parallelism state dependent on the value of the intra_parallel
database manager configuration parameter, starting with the next
transaction.
Authorization
v DBADM authority
v SQLADM authority

None
Examples
Example 1: To run the database application with intrapartition parallelism enabled
from the next transaction:
CALL ADMIN_SET_INTRA_PARALLEL(YES)
Example 2: To run the database application with intrapartition parallelism disabled

from the next transaction:
CALL ADMIN_SET_INTRA_PARALLEL(NO)
276
Example 3: To run the database application with intrapartition parallelism state

dependent on the value of the intra_parallel database manager configuration
parameter:
CALL ADMIN_SET_INTRA_PARALLEL(NULL)
Usage notes
The required state of parallelism set through ADMIN_SET_INTRA_PARALLEL
only takes effect for the application invoking this procedure.
Calls to ADMIN_SET_INTRA_PARALLEL will not change the intra_parallel
database manager configuration parameter setting.
Intrapartition parallelism settings applied by ADMIN_SET_INTRA_PARALLEL can
be overridden if the database application is associated with a workload that has
specified a value for the MAX DEGREE workload attribute.
Intrapartition parallelism cannot be enabled by this procedure if the shared sort
heap is not available (SQL5192W).
ADMIN_SET_MAINT_MODE procedure - Set maintenance mode

for SQL compilation
The ADMIN_SET_MAINT_MODE procedure sets an internal flag for the current
connection, such that when SQL is executed, no triggers or constraints will be
expanded during SQL compilation.
Syntax
ADMIN_SET_MAINT_MODE (
settings
settings
This input parameter allows the client to set the administrative maintenance
mode. This setting affects how the client SQL is executed. The values are
specified as a VARCHAR containing a list of settings. The list of settings is as
follows:
INHIBIT_TRIG_RI_MQT
Modify the query compilation phase such that triggers, constraints, or
materialized query tables (MQTs) will not be added to the query
graph.
ALLOWGENERATED
Allow the client to specify values for 'always generated' fields.
NONE
Turn off the current settings.
Note: With exception of "NONE", settings can be combined with the AND keyword.
Authorization
277

None
Examples
1. Turn off the firing of triggers and constraints and MQTs for this client.
CALL ADMIN_SET_MAINT_MODE(INHIBIT_TRIG_RI_MQT)
2. Allow this client to specify values for fields which are normally generated. This
would usually cause an error, but this setting will allow the value to be
specified:
CALL ADMIN_SET_MAINT_MODE(ALLOWGENERATED)
3. Specify both types of setting for this client.

CALL ADMIN_SET_MAINT_MODE(INHIBIT_TRIG_RI_MQT AND ALLOWGENERATED)
4. Turn off all maintenance mode settings.

CALL ADMIN_SET_MAINT_MODE(NONE)
ADMINTABINFO administrative view and ADMIN_GET_TAB_INFO

table function - retrieve table size and state information
The ADMINTABINFO administrative view and the ADMIN_GET_TAB_INFO table
function provide methods to retrieve table size and state information that is not
currently available in the catalog views.
v ADMINTABINFO administrative view on page 232
v ADMIN_GET_TAB_INFO table function on page 233
ADMINTABINFO administrative view

The ADMINTABINFO administrative view returns size and state information for
tables, materialized query tables (MQT) and hierarchy tables only. These table
types are reported as T for table, S for materialized query tables and H for
hierarchy tables in the SYSCAT.TABLES catalog view. The information is returned
at both the data partition level and the database partition level for a table.
In a DB2 pureScale environment, values reported for a table are identical on all
members since all members operate on a single physical partition of data. This is
unlike in a partitioned database environment, where each member operates on a
different physical partition of data, and reports different values. Because the values
on all members are always the same, the ADMINTABINFO view and the
ADMIN_GET_TAB_INFO table functions return only a single row for each table
when run on a DB2 pureScale instance.
returned.
278
Authorization
v SELECT privilege on the ADMINTABINFO administrative view
v CONTROL privilege on the ADMINTABINFO administrative view
v DBADM authority
v SQLADM authority

Examples
Example 1: Retrieve size and state information for all tables
SELECT * FROM SYSIBMADM.ADMINTABINFO
Example 2: Determine the amount of physical space used by a large number of

sparsely populated tables.
SELECT TABSCHEMA, TABNAME, SUM(DATA_OBJECT_P_SIZE),
SUM(INDEX_OBJECT_P_SIZE), SUM(LONG_OBJECT_P_SIZE),
SUM(LOB_OBJECT_P_SIZE), SUM(XML_OBJECT_P_SIZE)
FROM SYSIBMADM.ADMINTABINFO GROUP BY TABSCHEMA, TABNAME
Example 3: Identify tables that are eligible to use large RIDs, but are not currently
enabled to use large RIDs.
SELECT TABSCHEMA, TABNAME FROM SYSIBMADM.ADMINTABINFO
WHERE LARGE_RIDS = P
SELECT SUBSTR(TABSCHEMA, 1, 10) AS TBSCHEMA, SUBSTR(TABNAME, 1, 10)
AS TBNAME, STATSTYPE FROM SYSIBMADM.ADMINTABINFO WHERE TABNAME = T1;
TBSCHEMA
TBNAME
STATSTYPE
---------- ---------- --------DB2USER1
T1
U
ADMIN_GET_TAB_INFO table function

The ADMIN_GET_TAB_INFO table function returns the same information as the
ADMINTABINFO administrative view, but allows you to specify a schema and
table name.
returned.
Authorization
EXECUTE privilege on the ADMIN_GET_TAB_INFO table function.
279

Syntax
ADMIN_GET_TAB_INFO (
tabschema
tabname
Routine parameters
tabschema
tabname
Table 76. Information Returned by ADMINTABINFO administrative view and ADMIN_GET_TAB_INFO
Column name
Data type
Description
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
TABTYPE
CHAR(1)
Table type:
v 'T' = table
DBPARTITIONNUM
SMALLINT

element
DATA_PARTITION_ID
INTEGER

element
AVAILABLE
CHAR(1)
State of the table:

will be NULL.
280
Column name
Data type
Description
DATA_OBJECT_L_SIZE
BIGINT

table truncation). For multidimensional clustering (MDC)
and insert time clustering (ITC) tables, this size includes
the logical size of the block map object. The size returned
takes into account full extents that are logically allocated
for the table and, for objects created in DMS table spaces,
an estimate of the Extent Map Page (EMP) extents. This
size represents the logical size of the base table only.
Space consumed by LOB data, Long Data, Indexes and
XML objects are reported by other columns.
DATA_OBJECT_P_SIZE
BIGINT
Data object physical size, reported in kilobytes.

For row-organized tables, the data object physical size is
the amount of disk space physically allocated for the
table. For MDC and ITC tables, this size includes the size
of the block map object. The size returned takes into
account full extents allocated for the table and includes
the EMP extents for objects created in DMS table spaces.
This size represents the physical size of the base table
only. The space consumed by LOB data, long data,
indexes, and XML objects is reported by other columns.
For column-organized tables, the data object physical size
is the amount of disk space physically allocated for the
table metadata only, which is relatively small. The user
data for column-organized tables is stored in the
column-organized data object, and its physical size is
reported by COL_OBJECT_P_SIZE.
INDEX_OBJECT_L_SIZE
BIGINT

indexes on partitioned tables. For information about the
both partitioned and nonpartitioned indexes, you can use
the ADMIN_GET_INDEX_INFO function.
281
Column name
Data type
Description
INDEX_OBJECT_P_SIZE
BIGINT

function.
LONG_OBJECT_L_SIZE
BIGINT

LONG_OBJECT_P_SIZE
BIGINT

LOB_OBJECT_L_SIZE
BIGINT

extents.
LOB_OBJECT_P_SIZE
BIGINT

XML_OBJECT_L_SIZE
BIGINT

282
Column name
Data type
Description
XML_OBJECT_P_SIZE
BIGINT

INDEX_TYPE
SMALLINT

Returns 2 as type-2 indexes are used.
REORG_PENDING
CHAR(1)

VARCHAR(10)

STOP is required)
v EXECUTING
table)
v PAUSED
LOAD_STATUS
VARCHAR(12)

v IN_PROGRESS
v PENDING
READ_ACCESS_ONLY
CHAR(1)

NO_LOAD_RESTART
CHAR(1)

returned otherwise.
SMALLINT

CHAR(1)

283
Column name
Data type
Description
LARGE_RIDS
CHAR(1)

indexes). This element returns the null value for
column-organized tables because the concept of RIDS
does not apply.
LARGE_SLOTS
CHAR(1)

maximum of 255 rows per page. This element returns the
null value for column-organized tables because the
concept of SLOTS does not apply.
DICTIONARY_SIZE
BIGINT

BIGINT

STATSTYPE
CHAR(1)

catalogs.
v


catalogs.
284
Column name
Data type
Description
XML_RECORD_TYPE
SMALLINT

table.
used.
used.
RECLAIMABLE_SPACE
BIGINT
For an MDC or ITC table in a DMS table space, this value

by running the REORG TABLE command with the RECLAIM
EXTENTS option. For a column-organized table, this value
indicates the amount of free space that was found the last
time that the runstats utility was run. Disk space is
reported in kilobytes. For any other table, the value is
zero.
XML_DICTIONARY_SIZE
BIGINT

AMT_STATUS
VARCHAR(12)
Current status of ADMIN_MOVE_TABLE stored

procedure call against the table. Returns the value
'IN_PROGRESS' or the null value if there is no move in
progress for the table.
SPARSE_BLOCKS
BIGINT
For an insert time clustering (ITC) table, this field

represents the number of sparsely used blocks in the
table. This is the set of blocks that will be consolidated if
the REORG TABLE command is invoked with the
RECLAIM EXTENTS option.
STATS_ROWS_MODIFIED
BIGINT

RUNSTATS
RTS_ROWS_MODIFIED
BIGINT

statistics
STATS_DBPARTITION
CHAR(3)
stats_dbpartition - Automatics statistics collection

indicator
COL_OBJECT_L_SIZE
BIGINT
col_object_l_size - Column-organized data object logical

size
COL_OBJECT_P_SIZE
BIGINT
col_object_p_size - Column-organized data object physical

size
Usage notes
285

v When the ADMIN_GET_TAB_INFO table function is retrieving data for a given
table, it will acquire a shared lock on the corresponding row of SYSTABLES to
ensure consistency of the data that is returned (for example, to ensure that the
table is not dropped while information is being retrieved for it). The lock will
only be held for as long as it takes to retrieve the size and state information for
the table, not for the duration of the table function call.
Examples
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_TAB_INFO(DBUSER1, EMPLOYEE))
AS T

lob_object_p_size + xml_object_p_size + col_object_p_size) as total_p_size
lob_object_l_size + xml_object_l_size + col_object_l_size) as total_l_size
DBUSER1.EMPLOYEE.
FROM TABLE(SYSPROC.ADMIN_GET_TAB_INFO(DBUSER1,EMPLOYEE))

FROM TABLE(SYSPROC.ADMIN_GET_TAB_INFO(SAMPLE,STAFF))
ADMINTEMPCOLUMNS administrative view and

ADMIN_GET_TEMP_COLUMNS table function - Retrieve column
information for temporary tables
The ADMINTEMPCOLUMNS administrative view and the
ADMIN_GET_TEMP_COLUMNS table function provide methods to retrieve
column attribute information for created temporary tables and declared temporary
tables.
286
Although the catalog views contain column attribute information for instances of
created temporary tables, they do not have this information for declared temporary
tables.
v ADMINTEMPCOLUMNS administrative view on page 240
v ADMIN_GET_TEMP_COLUMNS table function on page 241
ADMINTEMPCOLUMNS administrative view

The ADMINTEMPCOLUMNS administrative view returns column attribute
information for instances of created temporary tables and declared temporary
tables.
Authorization
v SELECT privilege on the ADMINTEMPCOLUMNS administrative view
v
v
v
v
CONTROL privilege on the ADMINTEMPCOLUMNS administrative view

DBADM authority
SQLADM authority


Examples
Example 1: Retrieve column attribute information for all instances of created
temporary tables and all declared temporary tables currently existing in the
database.
SELECT * FROM SYSIBMADM.ADMINTEMPCOLUMNS
Example 2: Determine which temporary tables active in the database are using the
user-defined data type of USMONEY.
FROM SYSIBMADM.ADMINTEMPCOLUMNS
WHERE TYPENAME = USMONEY
Example 3: Retrieve table schema, table name, and the column names for all
declared temporary tables declared by the SYSTEM_USER.
287
SELECT T.TABSCHEMA, T.TABNAME, C.COLNAME

FROM SYSIBMADM.ADMINTEMPCOLUMNS C, SYSIBMADM.ADMINTEMPTABLES T
WHERE T.TEMPTABTYPE = D
AND T.INSTANTIATOR = SYSTEM_USER
AND T.TABSCHEMA = C.TABSCHEMA
AND T.TABNAME = C.TABNAME
ADMIN_GET_TEMP_COLUMNS table function

the ADMINTEMPCOLUMNS administrative view, but allows you to specify a
schema name and a table name.
Syntax
ADMIN_GET_TEMP_COLUMNS (
application_handle
tabschema
tabname

application_handle
tabschema
tabname
Authorization
v DBADM authority
v SQLADM authority

Examples
Example 1: Retrieve column information for the declared temporary table
TEMPEMPLOYEE for the current connection.
288
SELECT *
FROM TABLE (
SYSPROC.ADMIN_GET_TEMP_COLUMNS(
APPLICATION_ID(), SESSION, TEMPEMPLOYEE))
AS T
Usage notes
Table 77. Information returned for ADMINTEMPCOLUMNS administrative view and ADMIN_GET_TEMP_COLUMNS
Column name
Data type
Description
APPLICATION_HANDLE
BIGINT
APPLICATION_NAME
VARCHAR(256)
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
COLNAME
VARCHAR(128)
Name of the column.
COLNO
SMALLINT
Number of this column in the table (starting with 0).
TYPESCHEMA
VARCHAR(128)
Schema name of the data type for the column.
TYPENAME
VARCHAR(128)
Unqualified name of the data type for the column.
LENGTH
INTEGER
Maximum length of the data. 0 for distinct types. The

LENGTH column indicates precision for DECIMAL fields,
and indicates the number of bytes of storage required for
decimal floating-point columns; that is, 8 columns for
DECFLOAT(16) and 16 columns for DECFLOAT(34).
SCALE
SMALLINT
Scale if the column type is DECIMAL; or the number of

digits of fractional seconds if the column type is
TIMESTAMP; 0 otherwise.
DEFAULT
VARCHAR(254)
Default value for the column of a table expressed as a

constant, special register, or cast-function appropriate for
the data type of the column. Can also be the keyword
NULL. Values might be converted from what was
specified as a default value. For example, date and time
constants are shown in ISO format, cast-function names
are qualified with schema names, and identifiers are
delimited. Null value if a DEFAULT clause was not
specified or the column is a view column.
289
Table 77. Information returned for ADMINTEMPCOLUMNS administrative view and

ADMIN_GET_TEMP_COLUMNS (continued)
Column name
Data type
Description
NULLS
CHAR(1)
Nullability attribute for the column.

v Y = Column is nullable
v N = Column is not nullable
The value can be N for a view column that is derived
from an expression or function. Nevertheless, such a
column allows null values when the statement using the
view is processed with warnings for arithmetic errors.
CODEPAGE
SMALLINT
Code page used for data in this column; 0 if the column is

defined as FOR BIT DATA or is not a string type.
LOGGED
CHAR(1)

v Y = Column is logged
v N = Column is not logged
COMPACT
CHAR(1)

v Y = Column is compacted in storage
v N = Column is not compacted
INLINE_LENGTH
INTEGER
Maximum size in bytes of the internal representation of

an instance of an XML document or a structured type that
can be stored in the base table; 0 when not applicable.
IDENTITY
CHAR(1)
v Y = Identity column
v N = Not an identity column
GENERATED
CHAR(1)
Type of generated column.

v A = Column value is always generated
v D = Column values is generated by default
v Blank = Column is not generated
ADMINTEMPTABLES administrative view and

ADMIN_GET_TEMP_TABLES table function - Retrieve information
for temporary tables
The ADMINTEMPTABLES administrative view and the
ADMIN_GET_TEMP_TABLES table function provide methods to retrieve table
attribute and instantiation time information for instances of created temporary
tables and declared temporary tables.
Although the catalog views contain table attribute information for created
temporary tables, they do not contain this information for declared temporary
tables. In addition, the catalog views do not contain table instantiation time
information for created temporary tables or declared temporary tables.
v ADMINTEMPTABLES administrative view on page 244
v ADMIN_GET_TEMP_TABLES table function on page 245
290
ADMINTEMPTABLES administrative view

The ADMINTEMPTABLES administrative view returns table attribute and
instantiation time information for instances of created temporary tables and
declared temporary tables.
be returned.
Authorization
v SELECT privilege on the ADMINTEMPTABLES administrative view
v CONTROL privilege on the ADMINTEMPTABLES administrative view
v DBADM authority
v SQLADM authority

Examples
instances of created temporary tables and declared temporary tables currently
existing in the database.
SELECT * FROM SYSIBMADM.ADMINTEMPTABLES
Example 2: Determine which connections have an instance of a created temporary

table.
WHERE TEMPTABTYPE = C
declared temporary tables declared for all the tables instantiated by the user that
connected to the database.
SELECT TABSCHEMA, TABNAME, ONCOMMIT, ONROLLBACK,
INSTANTIATION_TIME
WHERE TEMPTABTYPE = D AND INSTANTIATOR = SYSTEM_USER
291

the ADMINTABINFO administrative view, but allows you to specify a schema
name and a table name.
be returned.
Syntax
ADMIN_GET_TEMP_TABLES (
application_handle
tabschema
tabname

application_handle
tabschema
tabname
Authorization
v DBADM authority
v SQLADM authority

Examples
instances of the created temporary table DBUSER1.EMPLOYEE for all connections.
SELECT TABSCHEMA, TABNAME, ONCOMMIT, ONROLLBACK, INSTANTIATION_TIME
FROM TABLE (SYSPROC.ADMIN_GET_TEMP_TABLES(NULL, DBUSER1, EMPLOYEE))
AS T
Example 2: Retrieve the instantiation time and table space ID for all instances of
user temporary tables for the current connection.
SELECT TABSCHEMA, TABNAME, INSTANTIATION_TIME, TBSP_ID
FROM TABLE (SYSPROC.ADMIN_GET_TEMP_TABLES(APPLICATION_ID(), , ))
AS T
292
Usage notes
v
Table 78. Information returned for ADMINTEMPTABLES administrative view and ADMIN_GET_TEMP_TABLES
Column name
Data type
Description
APPLICATION_HANDLE
BIGINT
APPLICATION_NAME
VARCHAR(256)
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
INSTANTIATOR
VARCHAR(128)
Authorization ID under which the created temporary

table was instantiated or declared temporary table was
declared.
INSTANTIATORTYPE
CHAR(1)
v U = The instantiator is an individual user
TEMPTABTYPE
CHAR(1)
Temporary table type:

v C = Created temporary table
v D = Declared temporary table
INSTANTIATION_TIME
TIMESTAMP
Time at which the created temporary table instance was

instantiated or the declared temporary table was declared.
COLCOUNT
SMALLINT
Number of columns, including inherited columns (if any).
TAB_FILE_ID
BIGINT
table_file_id - The file ID (FID) for the table.
TBSP_ID
BIGINT
tablespace_id - An integer that uniquely represents a table

space used by the current database.
PMAP_ID
SMALLINT
Identifier for the distribution map that is currently in use

by this table.
PARTITION_MODE
CHAR(1)
Indicates how data is distributed among database

partitions in a partitioned database system.
v H = Hashing
v Blank = No database partitioning
CODEPAGE
SMALLINT
Code page of the object. This is the default code page

used for all character columns and expression-generated
columns.
293
Table 78. Information returned for ADMINTEMPTABLES administrative view and

ADMIN_GET_TEMP_TABLES (continued)
Column name
Data type
Description
ONCOMMIT
CHAR(1)
Specifies the action taken on this table when a COMMIT

operation is performed.
v D = Delete rows
v P = Preserve rows
ONROLLBACK
CHAR(1)
Specifies the action taken on this table when a

ROLLBACK operation is performed.
v D = Delete rows
v P = Preserve rows
LOGGED
CHAR(1)
Specifies whether this table is logged.

v N = Not logged
v Y = Logged
Administrative Task Scheduler routines and views

ADMIN_TASK_ADD procedure - Schedule a new task
The ADMIN_TASK_ADD procedure schedules an administrative task, which is any
piece of work that can be encapsulated inside a procedure.
Syntax
ADMIN_TASK_ADD ( name
, begin_timestamp
max_invocations , schedule
procedure_input , options
, end_timestamp
, procedure_schema
, remarks )
, procedure_name

,

name
An input argument of type VARCHAR(128) that specifies the name of the task.
This argument cannot be NULL.
begin_timestamp
An input argument of type TIMESTAMP that specifies the earliest time a task
can begin execution. The value of this argument cannot be in the past, and it
cannot be later than end_timestamp.
When task execution begins depends on how this argument and the schedule
argument are defined:
v If the begin_timestamp argument is not NULL:
If the schedule argument is NULL, the task execution begins at
begin_timestamp.
If the schedule argument is not NULL, the task execution begins at the next
scheduled time at or after begin_timestamp.
v If the begin_timestamp argument is NULL:
If the schedule argument is NULL, the task execution begins immediately.
294
scheduled time.
end_timestamp
An input argument of type TIMESTAMP that specifies the last time that a task
cannot be earlier than begin_timestamp. If the argument is NULL, the task can
continue to execute as scheduled indefinitely.
An executing task will not be interrupted at its end_timestamp.
max_invocations
An input argument of type INTEGER that specifies the maximum number of
executions allowed for the task. If the argument is NULL, there is no limit to the
number of times the task can execute. If the argument is 0, the task will not
execute.
This value applies to the schedule if schedule is not NULL.
If both end_timestamp and max_invocations are specified, end_timestamp takes
precedence. That is, if the end_timestamp timestamp is reached, even though the
number of task executions so far has not reached the value of max_invocations,
the task will not be executed again.
schedule
An input argument of type VARCHAR(1024) that specifies a task execution
schedule at fixed points in time. If the argument is NULL, the task is not
scheduled at fixed points in time.
The schedule string must be specified using the UNIX cron format.
Multiple schedules are not supported.
procedure_schema
An input argument of type VARCHAR(128) that specifies the schema of the
procedure that this task will execute. This argument cannot be NULL.
procedure_name
procedure that this task will execute. This argument cannot be NULL.
procedure_input
An input argument of type CLOB(2M) that specifies the input arguments of
the procedure that this task will execute. This argument must contain an SQL
statement that returns one row of data. The returned values will be passed as
arguments to the procedure. If this argument is NULL, no arguments are passed
to the procedure.
The number of columns returned by the SQL statement must match the total
number (and type) of arguments for the procedure and must contain a single
row. For output arguments, the value itself is ignored, but should be of the
same SQL data type as the procedure requires.
This SQL statement is executed every time the task is executed. If the SQL
statement fails, the task's status will be set to NOTRUN and specific SQLCODE
information will be recorded. If the statement does not return a result set, does
not return a row, returns multiple rows or result sets the task will not be
executed. The task's status will be set to NOTRUN and SQLCODE SQL1465N will
be set to indicate that this argument is invalid.
If the statement result contains serialized XML parameters, the total size of all
XML parameters combined is limited to 256 kilobytes. If the result exceeds this
295
threshold, the task's status will be set to NOTRUN. SQLCODE -302 and
SQLSTATE 22001 will be set to indicate that data truncation has occurred.
To view the task's status, use the SYSTOOL.ADMIN_TASK_STATUS view
options
An input argument of type VARCHAR(512). This argument must be NULL.
remarks
An input argument of type VARCHAR(254) that specifies a description of the
task. This argument is optional and can be NULL.
Authorization
v DBADM authority
v SQLADM authority

Usage notes
The SYSTOOLSPACE table space must exist before you call the
ADMIN_TASK_ADD procedure. If it does not exist, the procedure will return an
SQL0204N error message.
When a task is scheduled, the authorization ID of the current session user is
recorded. The scheduler switches to this session authorization ID when the
executing the task.
The administrative task scheduler does not support the execution of procedures
that perform a database connection without a specified user ID and password. For
example, the ADMIN_CMD procedure can be used to perform a LOAD from a
database. A connection to the source database is established using the user ID and
password provided for the currently connected database. This type of LOAD
operation cannot be executed by the task scheduler.
If invalid arguments are passed into the procedure, SQL0171N will be returned.
The tokens of the message will indicate which argument is invalid and the name of
the procedure.
The task cannot be scheduled for execution until the unit of work is committed
and the scheduler has fetched the task definition.
The scheduler checks for new or updated tasks every 5 minutes. To ensure the task
executes as expected, the earliest begin time, as defined by the begin_timestamp,
end_timestamp and schedule arguments, should be at least 5 minutes after the unit of
work commits.
The database must be active on all database partitions to ensure the task can be
executed by the scheduler.
296
In a partitioned database environment, the ADMIN_TASK_ADD procedure can be

called from any database partition. The scheduler, however, will execute all tasks
from the catalog database partition.
The begin_timestamp, end_timestamp, and schedule are based on the server's time
zone. Special attention is required when scheduling a task during the transition
period of daylight savings time (DST). If the task is scheduled to run 2:01 AM and
it is the time of year when the time springs forward, the task will not run as the
clock skips from 2:00 AM to 3:00 AM. If the DST change occurs when the database
is activated and there is no task scheduled during the DST change time, the first
scheduled task after the DST change will not run. Tasks will run normally from the
second task onwards. For example, if no task is scheduled between 2:00 AM to 3:00
AM but there is a task at 3:10 AM which is also the first task after DST change,
this task will not run. This is independent of the time after the DST change in
which the task is scheduled. For example, whether the first task after DST is
scheduled one day or one month after the DST change, the task will not run as
long as it is the first task after DST change and the database is kept active the
entire time. On the other hand, when the time falls back an hour, tasks that were
originally scheduled between 2:00 AM and 3:00 AM will execute twice. The user is
responsible for making adjustments for daylight savings time to ensure their
required behavior.
The scheduler will always commit after calling the procedure specified by
procedure_schema and procedure_name. If a transaction roll back is required, the
rollback must occur inside the procedure.
If the task name is not unique, the procedure will fail with SQL0601N.
Example
Example 1: Create a task that performs an online TSM backup daily at 12:00 AM,
with immediate effect:
CALL SYSPROC.ADMIN_TASK_ADD
( DAILY TSM BACKUP,
CURRENT_TIMESTAMP,
NULL,
NULL,
0 0 * * *,
SYSPROC,
ADMIN_CMD,
VALUES(BACKUP DATABASE SALES ONLINE USE TSM WITHOUT PROMPTING),
NULL,
NULL )
Example 2: Schedule a task to flush an event monitor every hour:

1. Create an SQL procedure, in the PROD schema, that flushes an event monitor
called "em":
CREATE PROCEDURE FLUSH_EVENT_MONITOR()
SPECIFIC FLUSH_EVENT_MONITOR
LANGUAGE SQL
BEGIN
DECLARE stmt VARCHAR(100) ;
SET stmt = FLUSH EVENT MONITOR em ;
EXECUTE IMMEDIATE stmt ;
END
Note: The FLUSH EVENT MONITOR SQL statement cannot be called directly
in the procedure. However, EXECUTE IMMEDIATE can be used.
297
2. Call ADMIN_TASK_ADD to schedule the task:

CALL SYSPROC.ADMIN_TASK_ADD
(FLUSH EVENT MONITOR EVERY HOUR,
NULL,
NULL,
NULL,
0 0-23 * * *,
PROD,
FLUSH_EVENT_MONITOR,
NULL,
NULL,
NULL )
UNIX cron format:

The UNIX cron format is used to specify time in the schedule parameter of the
ADMIN_TASK_ADD and ADMIN_TASK_UPDATE procedures.
The cron format has five time and date fields separated by at least one blank.
There can be no blank within a field value. Scheduled tasks are executed when the
minute, hour, and month of year fields match the current time and date, and at least
one of the two day fields (day of month, or day of week) match the current date.
Table 1 lists the time and date fields and their allowed values in cron format.
Table 79. Field names and values for the UNIX cron format
Field name
Allowed values
minute
0-59
hour
0-23
day of month
1-31
month
v 1-12, where 1 is January, 2 is February,

and so on.
v Uppercase, lowercase and mixed-case
three character strings, based on the
English name of the month. For example:
jan, feb, mar, apr, may, jun, jul, aug, sep,
oct, nov, or dec.
day of week
v 0-7, where 0 or 7 is Sunday, 1 is Monday,

and so on.
v Uppercase, and lowercase or mixed-case
three character strings, based on the
English name of the day: mon, tue, wed,
thu, fri, sat, or sun.
Ranges and lists

Ranges of numbers are allowed. Ranges are two numbers separated with a
hyphen. The specified range is inclusive. For example, the range 8-11 for an hour
entry specifies execution at hours 8, 9, 10 and 11.
Lists are allowed. A list is a set of numbers or ranges separated by commas. For
example:
1,2,5,9
0-4,8-12
298
Unrestricted range
A field can contain an asterisk (*), which represents all possible values in the field.
The day of a command's execution can be specified by two fields: day of month and
day of week. If both fields are restricted by the use of a value other than the asterisk,
the command will run when either field matches the current time. For example,
the value 30 4 1,15 * 5 causes a command to run at 4:30 AM on the 1st and 15th
of each month, plus every Friday.
Step values
Step values can be used in conjunction with ranges. The syntax range/step defines
the range and an execution interval.
If you specify first-last/step, execution takes place at first, then at all successive
values that are distant from first by step, until last.
For example, to specify command execution every other hour, use 0-23/2. This
expression is equivalent to the value 0,2,4,6,8,10,12,14,16,18,20,22.
If you specify */step, execution takes place at every interval of step through the
unrestricted range. For example, as an alternative to 0-23/2 for execution every
other hour, use */2.
Example
Table 2 lists values that you can use for the schedule argument in
ADMIN_TASK_ADD or ADMIN_TASK_UPDATE procedures for various
scheduling scenarios.
Table 80. Example task schedules and the appropriate schedule argument values
Desired task schedule
schedule value
2:10 PM every Monday
10 14 * * 1
Every day at midnight
0 0 * * *
Every weekday at midnight
0 0 * * 1-5
Midnight on 1st and 15th day of the month
0 0 1,15 * *
6.32 PM on the 17th, 21st and 29th of

November plus each Monday and
Wednesday in November each year
32 18 17,21,29 11 mon,wed
ADMIN_TASK_LIST administrative view - Retrieve information

about tasks in the scheduler
The ADMIN_TASK_LIST administrative view retrieves information about each task
defined in the administrative task scheduler.
The schema is SYSTOOLS.
This view is created the first time the ADMIN_TASK_ADD procedure is called.
299
Authorization
SELECT or CONTROL privilege on the ADMIN_TASK_LIST administrative view.
Unless the database was created with the RESTRICTIVE option, SELECT privilege is
granted to PUBLIC by default.
When you query the ADMIN_TASK_LIST view, it will only return the tasks that
were created using your session authorization ID. If you have SYSADM, SYSCTRL,
SYSMAINT, or DBADM authority, all tasks are returned.

Example
Request the list of tasks in the scheduler:
SELECT * from SYSTOOLS.ADMIN_TASK_LIST
Table 81. Information returned by the ADMIN_TASK_LIST administrative view
Column name
Data type
Description
NAME
VARCHAR(128)
The name of the task.
TASKID
INTEGER
The task identifier.
OWNER
VARCHAR(128)
The session authorization ID of the

user that created the task.
OWNERTYPE
VARCHAR(1)
The authorization ID type. Valid

values are:
v U - User
BEGIN_TIME
TIMESTAMP
The timestamp of when the task is

first able to run.1
END_TIME
TIMESTAMP
The timestamp of when the task is

last able to run.1
If this column is NULL, the task can
run indefinitely unless
MAX_INVOCATIONS is specified.
MAX_INVOCATIONS
INTEGER
The maximum number of executions

allowed for the task. If this column is
NULL, the task can run indefinitely
unless END_TIME is specified.
SCHEDULE
VARCHAR(1024)
The schedule for the task, in UNIX

cron format.
PROCEDURE_SCHEMA
VARCHAR(128)
The schema of the procedure that this

task will execute.
PROCEDURE_NAME
VARCHAR(128)
The name of the procedure that this

task will execute.
PROCEDURE_INPUT
CLOB(2M)
The input parameters of the

procedure that this task will execute.
If this column is NULL, there are no
input parameters.
300
Table 81. Information returned by the ADMIN_TASK_LIST administrative view (continued)

Column name
Data type
Description
OPTIONS
VARCHAR(512)
Options that affect the behavior of

the task.
UPDATE_TIME
TIMESTAMP
update_time - Update Response Time

monitor element
REMARKS
VARCHAR(254)
A description of the task.
Note:
v 1 The BEGIN_TIME and END_TIME are based on the database server's time
zone. The user is responsible for making adjustments for daylight savings time
(DST).
ADMIN_TASK_REMOVE procedure - Remove scheduled tasks or

task status records
The ADMIN_TASK_REMOVE procedure removes scheduled administrative tasks,
which are pieces of work that can be encapsulated inside a procedure. It also
removes task status records.
Syntax
ADMIN_TASK_REMOVE (
name
, end_timestamp )
name
An input argument of type VARCHAR(128) that specifies the name of the task.
end_timestamp
An output argument of type TIMESTAMP that specifies the status record
end_timestamp timestamp.
Authorization
v EXECUTE privilege on the ADMIN_TASK_REMOVE procedure
v DBADM authority
v SQLADM authority
Although the statement authorization ID might allow the procedure to be
executed, successful removal of task and status records depends on the value of
the current session authorization ID. The current session authorization ID must
match the session authorization ID that was recorded when the task was created.
Users with SYSADM, SYSCTRL, SYSMAINT, or DBADM authority can remove any
task or status record. If an unauthorized user attempts to remove a task or status
record, an SQL0551N is returned.
301

Usage notes
The task is not removed until the unit of work is committed.
The behavior of the task removal depends on how the name and end_timestamp
arguments are defined:
v If the end_timestamp argument is NULL:
If the name argument is NULL, all tasks and status records are removed. If one
or more tasks are currently running, then the task and associated status
records are not removed. In this case, SQL1464W is returned.
If the name argument is not NULL, the task record that matches name is
removed. If the specified task is currently running, the task is not removed
and SQL20453N is returned. If the specified task is removed, all associated
status records are removed.
v If the end_timestamp argument is not NULL:
If the name argument is NULL, all status records with end_timestamp timestamps
less than or equal to end_timestamp are removed. No task records are
removed. The procedure will not remove any status records that have a status
value of RUNNING.
If the name argument is not NULL, the status records for the task that matches
name are removed if their end_timestamp timestamp is less than or equal to
end_timestamp. No task records are removed. The procedure will not remove
any status records that have a status value of RUNNING.
If a user attempts to remove a task that does not exist, an SQL0204N is returned.
Example
Remove a backup task called 'DAILY TSM BACKUP':
CALL SYSPROC.ADMIN_TASK_REMOVE(DAILY TSM BACKUP, NULL)
ADMIN_TASK_STATUS administrative view - Retrieve task status

information
The ADMIN_TASK_STATUS administrative view retrieves information about the
status of task execution in the administrative task scheduler.
The schema is SYSTOOLS.
This view is created the first time the ADMIN_TASK_ADD procedure is called.
Authorization
SELECT or CONTROL privilege on the ADMIN_TASK_STATUS administrative
view. Unless the database was created with the RESTRICTIVE option, SELECT
privilege is granted to PUBLIC by default.
When you query the ADMIN_TASK_STATUS view, it will only return the task
status records that were created by your session authorization ID.
302

Examples
Example 1: Request the status of tasks in the scheduler:
SELECT * from SYSTOOLS.ADMIN_TASK_STATUS
Example 2: Format the data in the SQLERRMC column using the SQLERRM
function:
SELECT TASKID, STATUS, SQLCODE, SQLSTATE, RC,
VARCHAR( SQLERRM( SQL || CHAR( ABS(SQLCODE) ),
SQLERRMC, xFF, en_US, 1 ), 256) AS MSG_TXT
FROM SYSTOOLS.ADMIN_TASK_STATUS
Table 82. Information returned by the ADMIN_TASK_STATUS administrative view
Column name
Data type
Description
NAME
VARCHAR(128)
The name of the task.
TASKID
INTEGER
The task identifier.
STATUS
VARCHAR(10)
The status of the task. Valid values are:

v RUNNING - The task is currently running.
v COMPLETED - The task has finished running.
v NOTRUN - An error prevented the scheduler from calling the task's
procedure.
v UNKNOWN - The task started running but an unexpected condition
prevented the scheduler from recording the task outcome. This can
occur if the system ends abnormally or a power failure happens while
the task is running.
INVOCATION
INTEGER
The current invocation count.
BEGIN_TIME
TIMESTAMP
The time that the task began.1

If the STATUS is RUNNING, COMPLETED, or UNKNOWN, this value indicates the
time that the task started running.
If the STATUS is NOTRUN, it indicates the time that the task should have
started.
END_TIME
TIMESTAMP
The time that the task finished running.1

This value will be NULL if the STATUS is RUNNING.
If the STATUS is UNKNOWN, this value is the time the task scheduler
detected the task was no longer executing and updated the status table.
AGENT_ID
BIGINT
agent_id - Application handle (agent ID) monitor element
SQLCODE
INTEGER
If the STATUS is COMPLETED, this value indicates the SQLCODE returned

by the CALL to the procedure.
If the STATUS is NOTRUN, this value indicates the SQLCODE of the error
that prevented the task from running.
If the status is RUNNING or UNKNOWN, this value will be NULL.
303
Table 82. Information returned by the ADMIN_TASK_STATUS administrative view (continued)

Column name
Data type
Description
SQLSTATE
CHAR(5)
If the STATUS is COMPLETED, this value indicates the SQLSTATE returned

If the STATUS is NOTRUN, this value indicates the SQLSTATE of the error
SQLERRMC
VARCHAR(70) FOR Contains one or more tokens, separated by X'FF', as they appear in the
BIT DATA
SQLERRMC field of the SQLCA. These tokens are substituted for
variables in the descriptions of error conditions
If the STATUS is COMPLETED, this value indicates the SQLERRMC returned
If the STATUS is NOTRUN, this value indicates the SQLERRMC of the error
RC
INTEGER
If the STATUS is COMPLETED, this contains the return code from the CALL
to the procedure if the procedure had a return code. Otherwise, this will
be NULL.
The BEGIN_TIME and END_TIME are based on the database server's time
zone. The user is responsible for making adjustments for daylight savings time
(DST).
ADMIN_TASK_UPDATE procedure - Update an existing task

The ADMIN_TASK_UPDATE procedure updates an administrative task, which is
any piece of work that can be encapsulated inside a procedure.
Syntax
ADMIN_TASK_UPDATE (
name
max_invocations , schedule
, begin_timestamp
, options
, end_timestamp
, remarks )

name
An input argument of type VARCHAR(128) that specifies the name of an
existing task. This argument cannot be NULL.
begin_timestamp
An input argument of type TIMESTAMP that specifies the earliest time a task
cannot be later than end_timestamp.
When task execution begins depends on how this parameter and the schedule
parameter are defined:
v If the begin_timestamp argument is not NULL:
If the schedule argument is NULL, the task execution begins at
begin_timestamp.
304
scheduled time at or after begin_timestamp.
v If the begin_timestamp argument is NULL:
If the schedule argument is NULL, the task execution begins immediately.
scheduled time.
end_timestamp
An input argument of type TIMESTAMP that specifies the last time that a task
cannot be earlier than begin_timestamp. If the argument is NULL, the task can
continue to execute as scheduled indefinitely.
An executing task will not be interrupted at its end_timestamp.
max_invocations
executions allowed for the task. If the argument is NULL, there is no limit to the
number of times the task can execute. If the argument is 0, the task will not
execute.
This value applies to the schedule if schedule is not NULL.
If both end_timestamp and max_invocations are specified, end_timestamp takes
precedence. That is, if the end_timestamp timestamp is reached, even though the
number of task executions so far has not reached the value of max_invocations,
the task will not be executed again.
schedule
An input argument of type VARCHAR(1024) that specifies a task execution
schedule at fixed points in time. If the argument is NULL, the task is not
scheduled at fixed points in time.
The schedule string must be specified using the UNIX cron format.
Multiple schedules are not supported.
options
An input argument of type VARCHAR(512). This argument must be NULL.
remarks
An input argument of type VARCHAR(254) that specifies a description of the
task. This is an optional argument that can be set to NULL.
Authorization
v EXECUTE privilege on the ADMIN_TASK_UPDATE procedure
v DBADM authority
v SQLADM authority
Although the statement authorization ID might allow the procedure to be
executed, a task cannot be updated unless the current session authorization ID
matches the session authorization ID that was recorded when the task was created.
Users with SYSADM, SYSCTRL, SYSMAINT, or DBADM can update any existing
task. Attempting to update a task that was added by a different user returns
SQL0551N.
305

Usage notes
If invalid arguments are passed into the procedure, SQL0171N will be returned.
The tokens of the message will indicate which argument is invalid and the name of
the procedure.
Changes to the task do not take effect until the unit of work is committed and the
scheduler has fetched the updated task definition. Leaving the unit of work
uncommitted may delay or prevent the execution of the existing task.
The scheduler checks for updated tasks every 5 minutes. To ensure the task
executes as expected, the earliest begin time, as defined by the begin_timestamp,
end_timestamp and schedule parameters, should be at least 5 minutes after the unit
of work commits.
The database must be active on all database partitions to ensure the task can be
executed by the scheduler.
The begin_timestamp, end_timestamp, and schedule are based on the database server's
time zone. Special attention is required when scheduling a task during the
transition period of daylight savings time (DST). If the task is scheduled to run
2:01 AM and it is the time of year when the time springs forward, the task will not
run as the clock skips from 2:00 AM to 3:00 AM. If the DST change occurs when
the database is activated and there is no task scheduled during the DST change
time, the first scheduled task after the DST change will not run. Tasks will run
normally from the second task onwards. For example, if no task is scheduled
between 2:00 AM to 3:00 AM but there is a task at 3:10 AM which is also the first
task after DST change, this task will not run. This is independent of the time after
the DST change in which the task is scheduled. For example, whether the first task
after DST is scheduled one day or one month after the DST change, the task will
not run as long as it is the first task after DST change and the database is kept
active the entire time. On the other hand, when the time falls back an hour, tasks
that were originally scheduled between 2:00 AM and 3:00 AM will execute twice.
The user is responsible for making adjustments for daylight savings time to ensure
their required behavior.
When a task is updated, the task's internal invocation counter is reset. To illustrate,
consider a recurring task with a max_invocations value of 10. If the task executes 3
times, there are 3 corresponding status records in the ADMIN_TASK_STATUS
output. The entries have INVOCATION values of 1, 2, and 3. Now assume the task
creator updates the task. This update will reset the internal invocation counter. The
original status records remain in intact. Over time, new status records will be
created with INVOCATION values of 1, 2, 3, and so on. The BEGIN_TIME can be
used to distinguish between the original and updated task execution.
Audit routines and procedures

AUDIT_ARCHIVE procedure and table function - Archive audit
log file
The AUDIT_ARCHIVE procedure and table function both archive the audit log file
for the connected database.
306
Syntax
AUDIT_ARCHIVE (
directory
member

The syntax is the same for both the procedure and table function.
Procedure and table function parameters

directory
An input argument of type VARCHAR(1024) that specifies the directory where
the archived audit file(s) will be written. The directory must exist on the server
and the instance owner must be able to create files in that directory. If the
argument is null or an empty string, the default directory is used.
member
An input argument of type INTEGER that specifies a valid database member
number. Specify -1 for the current database member, NULL or -2 for an
aggregate of all members.
Authorization
Execute privilege on the AUDIT_ARCHIVE procedure or table function.

None
Examples
Example 1: Archive the audit log(s) for all members to the default directory using
the procedure.
CALL SYSPROC.AUDIT_ARCHIVE(NULL, NULL)
Example 2: Archive the audit log(s) for all members to the default directory using
the table function.
SELECT * FROM TABLE(SYSPROC.AUDIT_ARCHIVE(, -2)) AS T1
Table 83. Information returned by the AUDIT_ARCHIVE procedure and table function
Column name
Data type
Description
DBPARTITIONNUM
SMALLINT
dbpartitionnum - Database partition number

monitor element
PATH
VARCHAR(1024)
Directory location of archived file.
FILE
VARCHAR(1024)
Name of the archived file.
SQLCODE
INTEGER
The SQLCODE received while attempting to

archive file.
SQLSTATE
VARCHAR(5)
The SQLSTATE received while attempting

archive file. If SQLSTATE is NULL, the value
is zero.
307
Table 83. Information returned by the AUDIT_ARCHIVE procedure and table

function (continued)
Column name
Data type
Description
SQLERRMC
VARCHAR(70)
FOR BIT DATA
The sqlerrmc received while attempting

archive file. If SQLSTATE is NULL, the value
is zero.
MEMBER
SMALLINT
member - Database member monitor element
AUDIT_DELIM_EXTRACT - performs extract to delimited file

The AUDIT_DELIM_EXTRACT stored procedure performs an extract to a
delimited file on archived audit files of the connected database. Specifically, to
those archived audit files that have filenames that match the specified mask
pattern.
Syntax
AUDIT_DELIM_EXTRACT ( delimiter , target_directory , source_directory ,
file_mask , event_options )
delimiter
An optional input argument of type VARCHAR(1) that specifies the character
delimiter to be used in the delimited files. If the argument is null or an empty
string, a double quote will be used as the delimiter.
target_directory
An optional input argument of type VARCHAR(1024) that specifies the
directory where the delimited files will be stored. If the argument is null or an
empty string, same directory as the source_directory will be used
source_directory
directory where the archived audit log files are stored. If the argument is null
or an empty string, the audit default will be used.
file_mask
An optional input argument of type VARCHAR(1024) is a mask for which files
to extract. If the argument is null or an empty string, it will extract from all
audit log files in the source directory.
event_options
An optional input argument of type VARCHAR(1024) that specifies the string
defines which events to extract. This matches the same string in the db2audit
utility. If the argument is null or an empty string, it will extract all events.
Authorization
Execute privilege on the AUDIT_DELIM_EXTRACT function.

None
308
Examples
Note: Audit log files contain a timestamp as part of their naming convention.
Example 1:Performs a delimited extract on all audit log files archived on June 18th,
2007 in the default archive directory. This example is extracting just execute events,
using a double quote (") character delimiter, and creating or appending the
resulting extract files (<category>.del) in the $HOME/audit_delim_extract
directory.
CALL SYSPROC.AUDIT_DELIM_EXTRACT(NULL, $HOME/AUDIT_DELIM_EXTRACT, NULL,
%20070618%, CATEGORY EXECUTE)
AUDIT_LIST_LOGS table function - Lists archived audit log files

The AUDIT_LIST_LOGS table function lists the archived audit log files for a
database which are present in the specified directory.
Syntax
AUDIT_LIST_LOGS (
directory
directory
directory where the archived audit file(s) will be written. The directory must
exist on the server and the instance owner must be able to create files in that
directory. If the argument is null or an empty string, then the search default
directory is used.
Authorization
EXECUTE privilege on AUDIT_LIST_LOGS table function.

None
Examples
Example 1: Lists all archived audit logs in the default audit archive directory:
SELECT * FROM TABLE(SYSPROC.AUDIT_LIST_LOGS()) AS T1
Note: This only lists the logs in the directory for database on which the query is
run. Archived files have the format db2audit.db.<dbname>.log.<timestamp>
Information Returned
Table 84. The information returned for AUDIT_LIST_LOGS
Column Name
Data Type
Description
PATH
VARCHAR(1024)
Path location of the archived file.
FILE
VARCHAR(1024)
Filename of the archived file.
SIZE
BIGINT
File size of the archived file.

309
Automatic maintenance routines

AUTOMAINT_GET_POLICY procedure - retrieve automatic
maintenance policy
The AUTOMAINT_GET_POLICY system stored procedure retrieves the automatic
maintenance configuration for the database. This procedure takes two parameters:
the type of automatic maintenance about which to collect information; and a
pointer to a BLOB in which to return the configuration information. The
configuration information is returned in XML format.
Syntax
AUTOMAINT_GET_POLICY (
policy_type
, policy
policy_type
An input argument of type VARCHAR(128) that specifies the type of automatic
maintenance policy to retrieve. The argment can be one of the following
values:
AUTO_BACKUP
automatic backup
AUTO_REORG
automatic table and index reorganization
AUTO_RUNSTATS
automatic table runstats operations
MAINTENANCE_WINDOW
maintenance window
policy
An output argument of type BLOB(2M) that specifies the automatic
maintenance settings for the given policy type, in XML format.
Authorization
v DBADM authority
v SQLADM authority

None
Example
Here is an example of a call to the AUTOMAINT_GET_POLICY procedure from
within embedded SQL C source code.
310
v A BLOB variable is declared for the procedure output parameter.

v The procedure is called, specifying automated backup as the type of automatic
maintenance policy, and specifying the BLOB variable as the output parameter
in which the procedure will return the backup policy for the currently connected
database.
EXEC SQL BEGIN DECLARE SECTION;
SQL TYPE IS BLOB(2M) backupPolicy;
EXEC SQL END DECLARE SECTION;
EXEC SQL CALL AUTOMAINT_GET_POLICY( AUTO_BACKUP, :backupPolicy );
AUTOMAINT_GET_POLICYFILE procedure - retrieve automatic

maintenance policy
The AUTOMAINT_GET_POLICYFILE system stored procedure retrieves the
automatic maintenance configuration for the database. This procedure takes two
parameters: the type of automatic maintenance about which to collect information;
and the name of a file in which to return the configuration information. The
configuration information is returned in XML format.
Syntax
AUTOMAINT_GET_POLICYFILE (
policy_type
policy_file_name
policy_type
maintenance policy to retrieve. The argument can be one of the following
values:
AUTO_BACKUP
automatic backup
AUTO_REORG
AUTO_RUNSTATS
MAINTENANCE_WINDOW
maintenance window
policy_file_name
An input argument of type VARCHAR(2048) that specifies the name of the file
that is created in the tmp subdirectory of the DB2 instance directory.
Note: The file name may be prefixed with a path relative to tmp. In that case
the directory should exist, should have permission to create/overwrite the file
and the correct path separator for the DB2 Server must be used.
For example:
On UNIX if the instance directory is defined as $HOME/sqllib. For a policy file
named 'policy.xml', the file name will be '$HOME/sqllib/tmp/policy.xml'
On Windows, the instance directory name can be determined from the values
of the DB2INSTPROF registry variable and the DB2INSTANCE environment variable.
311
For a policy file named 'policy.xml', if db2set gives DB2INSTPROF=C:\DB2PROF

and %DB2INSTANCE%=db2, then the file name will be C:\DB2PROF\db2\tmp\
policy.xml
Authorization
v DBADM authority
v SQLADM authority

None
Example
To get the current automatic maintenance settings for backup operations:
call sysproc.automaint_get_policyfile( AUTO_BACKUP, AutoBackup.xml )
This will create an XML file named AutoBackup.xml in the tmp subdirectory under
the DB2 instance directory.
AUTOMAINT_SET_POLICY procedure - configure automatic

maintenance policy
You can use the AUTOMAINT_SET_POLICY system stored procedure to configure
automatic maintenance for the database. This procedure takes two parameters: the
type of automatic maintenance to configure; and a BLOB containing XML that
specifies the configuration.
To enable the RECLAIM EXTENTS option during the automatic reorganization
operations on multidimensional clustering (MDC) or insert time clustering (ITC)
tables, you need to specify the reclaimExtentSizeForTables attribute to the
ReorgOptions element, along with a threshold value in the XML input files.
To enable the RECLAIM EXTENTS option during the automatic reorganization
operations on indexes, you need to specify the
reclaimExtentsSizeForIndexObjects attribute to the ReorgOptions element, along
with a threshold value in the XML input files.
Note: The threshold specified for reclaimExtentsSizeForIndexObjects applies on
an index object level. For a nonpartitioned table the value applies to all indexes on
the table combined. For a partitioned table the value applies to each
nonpartitioned index separately, and to the indexes of each data partition
separately.
The threshold values specified for table or index space reclaim is the minimum
size, in kilobytes, of reclaimable space in the table or index before an online
reorganization to reclaim space is triggered. This threshold value must be 0 or
larger. For example, if you specify a value of 1024 KB for the threshold, only
objects with 1 MB of reclaimable space or more are considered for automatic
reorganization to reclaim space.
312
Syntax
AUTOMAINT_SET_POLICY (
policy_type
policy
policy_type
maintenance policy to configure. The value can be one of:
AUTO_BACKUP
automatic backup
AUTO_REORG
AUTO_RUNSTATS
MAINTENANCE_WINDOW
maintenance window
policy
An input argument of type BLOB(2M) that specifies the automatic maintenance
policy in XML format.
Authorization
v DBADM authority
v SQLADM authority

None
Examples
Example 1: To set the current automatic maintenance settings for runstats
operations:
CALL SYSPROC.AUTOMAINT_SET_POLICY
( AUTO_RUNSTATS,
BLOB( <?xml version=\"1.0\" encoding=\"UTF-8\"?>
<DB2AutoRunstatsPolicy
xmlns=\"http://www.ibm.com/xmlns/prod/db2/autonomic/config\">
<RunstatsTableScope><FilterCondition/></RunstatsTableScope>
</DB2AutoRunstatsPolicy>)
)
This replaces the current automatic statistics collection configuration with the new
configuration contained in the XML document that is passed as the second
parameter to the procedure."
313
Example 2: The automatic reorganization feature of DB2 can use the new
"RECLAIM EXTENTS" option to reorganize multidimensional clustering (MDC) or
insert time clustering (ITC) tables. To enable this feature, set the
"reclaimExtentSizeForTables" value in the AUTO_REORG policy:
CALL SYSPROC.AUTOMAINT_SET_POLICY
(AUTO_REORG,
BLOB( <?xml version=\"1.0\" encoding=\"UTF-8\"?>
<DB2AutoReorgPolicy
xmlns=\"http://www.ibm.com/xmlns/prod/db2/autonomic/config\">
<ReorgOptions dictionaryOption="Keep" indexReorgMode="Online"
useSystemTempTableSpace="false" reclaimExtentSizeForTables ="1024" >
<ReorgTableScope>
<FilterClause>TABSCHEMA NOT LIKE EMP%</FilterClause>
</ReorgTableScope>
</DB2AutoReorgPolicy>)
)
There are sample XML input files located in the SQLLIB/samples/automaintcfg

directory that you can modify to suit your requirements and then pass the XML
content in through the BLOB() scalar function as in the example.
AUTOMAINT_SET_POLICYFILE procedure - configure automatic

maintenance policy
You can use the AUTOMAINT_SET_POLICYFILE system stored procedure to
configure automatic maintenance for the database. This procedure takes two
parameters: the type of automatic maintenance to configure; and the name of an
XML document that specifies the configuration.
This procedure return the SQL success or SQL error code.
Syntax
AUTOMAINT_SET_POLICYFILE (
policy_type
policy_file_name
Procedure Parameters
policy_type
maintenance policy to configure. The argument can be one of the following
values:
AUTO_BACKUP
automatic backup
AUTO_REORG
AUTO_RUNSTATS
MAINTENANCE_WINDOW
maintenance window
policy_file_name
An input argument of type VARCHAR(2048) that specifies the name of the file
that is available in the tmp subdirectory of the DB2 instance directory.
314
Note: When the file name is specified with a relative path, the correct path
separator for the DB2 Server must be used and the directory and file should
exist with read permission.
For example:
On UNIX if the instance directory is defined as $HOME/sqllib. For a policy file
named 'automaint/policy.xml', the file name will be '$HOME/sqllib/tmp/
automaint/policy.xml'
On Windows, the instance directory name can be determined from the values
of the DB2INSTPROF registry variable and the DB2INSTANCE environment variable.
For a policy file named 'automaint\policy.xml', if db2set gives
DB2INSTPROF=C:\DB2PROF and %DB2INSTANCE%=db2, then the file name will be
C:\DB2PROF\db2\tmp\automaint\policy.xml
Authorization
v DBADM authority
v SQLADM authority

None
Example
To modify the current automatic maintenance settings for automatic backup:
call sysproc.automaint_set_policyfile( AUTO_BACKUP, AutoBackup.xml )
This will replace the current automatic backup configuration settings with the new
configuration contained in the AutoBackup.xml file located in the tmp directory
under the DB2 instance directory.
There are sample XML input files located in the SQLLIB/samples/automaintcfg
directory which can be used as reference to create policy xml files.
Common SQL API procedures

The common SQL API provides a collection of common-signature and
signature-stable stored procedures that are portable across IBM data servers. You
can use these stored procedures to create applications that perform a variety of
common administrative functions, such as getting and setting configuration
parameters, and getting system information.
The stored procedures provide syntactically identical XML parameters and error
handling across all data servers to ensure data server version independence.
Signature-stability and commonality are achieved by using simple XML documents
(with a common DTD) as parameters. Version, platform, and technology
differences are expressed through different key value pairs in hierarchical property
lists.
315
Common input and output parameters

The common SQL API stored procedures share a set of input and output
parameters.
The following table provides a brief description of these parameters. For more
detailed information, see the reference topics about the common SQL API stored
procedures.
Table 85. Common SQL API shared input and output parameters
Parameter
Description
major_version
Indicates the document type major version

that the caller supports for the XML
documents passed as parameters in the
procedure.
minor_version
Indicates the document type minor version

that the caller supports for the XML
documents passed as parameters in the
procedure.
The parameters major_version and
minor_version are used together to ensure
that the caller does not use an XML input
document of an incorrect version. The
procedure processes all XML documents in
the specified major_version and minor_version,
or returns an error if a version is not valid.
This design supports extensibility in future
releases because newer document type
versions can be added without affecting
existing applications.
316
requested_locale
Specifies the locale to use to return

translated content in the XML documents
returned in the xml_output and xml_message
parameters. Only values are translated, not
key names.
xml_input
Specifies an XML input document that

contains input values for the procedure.
xml_filter
Specifies a valid XPath query string that is

used to retrieve a single value from an
output parameter document.
xml_output
Returns a complete XML output document

encoded in UTF-8. Depending on the
procedure that is being called, this document
might contain configuration parameters and
their values, system information, or message
text. When the procedure operates in
complete mode, this parameter returns an
XML document that you can modify and
pass back to the procedure as the xml_input
parameter. This approach provides a
programmatic way to create valid XML
input documents.
xml_message
Returns a complete XML output document

of type Data Server Message in UTF-8 that
provides detailed information about a SQL
warning condition.
Versioning of XML documents

To support extensibility in future releases, the common SQL API stored procedures
return XML output documents that include version information.
Whenever the structure of an XML output document changes (for example, when
an element is added or removed), the version levels are incremented. Therefore, a
procedure might support several versions of the XML output document.
Version information in the XML document is expressed as key-value pairs for
document type major version and document type minor version. For example, an
XML output document might define the following keys and values in a dictionary
element:
<key>Document Type Name</key><string>Data Server Configuration Output</string>
<key>Document Type Major Version</key><integer>2</integer>
<key>Document Type Minor Version</key><integer>0</integer>
When you call the procedure, you specify the major version and minor version of
the XML document that you want to return. The contents of the XML output
document will vary depending on the values that you specify.
For example, the GET_CONFIG procedure retrieves the database and database
manager configuration parameters that are set for a particular instance. When this
procedure is called with major_version 2 and minor_version 0, it returns an XML
document that contains configuration parameters grouped into categories.
However, when the same procedure is called with major_version 1 and
minor_version 0, it returns an XML document that contains configuration
parameters, but they are not grouped into categories.
Likewise, the GET_MESSAGE procedure retrieves the message text and SQLSTATE
for a specified SQLCODE. When this procedure is called with major_version 2 and
minor_version 0, it returns an XML document that contains the short text message,
long text message, and SQLSTATE for the corresponding SQLCODE. However,
when the same procedure is called with major_version 1 and minor_version 0, it
returns an XML document that contains only the short text message and
SQLSTATE. The long text message is not available in version 1 of the document.
To determine the highest supported document versions for a procedure, specify
NULL for major_version, minor_version, and all other input parameters. The
procedure returns the highest supported document versions as values in the
major_version and minor_version output parameters, and sets the xml_output and
xml_message output parameters to NULL.
If you specify non-null values for major_version and minor_version, you must specify
supported document versions, or the procedure raises an error (-20457) to indicate
that the procedure encountered an unsupported version.
XML input documents can optionally include values for the document type major
version and document type minor version. If these values are specified in the XML
input document, then the values passed for major_version and minor_version in the
procedure call must exactly match the values that are specified in the XML
document, or the procedure raises an error (+20458). This behavior ensures that the
caller does not specify an unsupported version of the XML input document.
XML input documents

The XML documents that are passed as input to common SQL API stored
procedures share a simple XML format that is based on a common DTD.
317
The XML input document consists of a set of entries that are common to all stored
procedures, and a set of entries that are specific to each stored procedure. The
XML input document has the following general structure:
<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0">
<dict>
<key>Document Type Name</key><string>Data Server Message Input</string>
<key>Document Locale</key><string>en_US</string>
<key>Complete</key><false/>
<dict>

</dict>
</dict>
</plist>
Important: XML input documents must be encoded in UTF-8 and contain English
characters only.
Complete mode for returning valid XML input documents:
You can use complete mode to create a valid XML document for any common SQL
API stored procedure that accepts input. You can then customize the document
and pass it back to the procedure.
To run a procedure in complete mode, specify "true" for the Complete key in the
input XML document, and pass the following minimal content:
<dict>
<key>Complete</key><true/>
</dict>
</plist>
Any XML elements that are not required are ignored and are not returned in the
output document.
When you run the procedure, a complete XML input document is returned in the
xml_output parameter of the stored procedure. The returned XML document
includes a document type and a section for all possible required parameters and
optional parameters. The returned XML document also includes other entries (such
as display names, hints, and the document locale) that are not required, but are
typically needed when rendering the document in a client application.
After rendering the XML document and modifying it in a platform-independent
way, you can run the same stored procedure and pass in the modified XML
document as input.
XML output documents

The XML documents that are returned as output from common SQL API stored
procedures share a common set of entries.
At a minimum, XML documents returned in the xml_output parameter include the
following mandatory, key value pairs:
<dict>
<key>Document Type Name</key>
318
<string>Data Server Configuration Output</string>

<key>Data Server Product Name</key><string>DSN</string>
<key>Data Server Product Version</key><string>8.1.0.356</string>
<key>Data Server Major Version</key><integer>8</integer>
<key>Data Server Minor Version</key><integer>1</integer>
<key>Data Server Platform</key><string>z/OS</string>

</dict>
</plist>
Entries in the XML output document might be grouped using nested dictionaries.
Each entry in the XML output document describes a single piece of information.
The entry consists of the value, the display name, and a hint. Optionally, a display
unit might be provided. Display name, hint, and display unit are
language-sensitive and will be translated to the language specified in the value for
the requested_locale parameter (or the default if the requested locale is not yet
supported). In general, an entry has a structure similar to the following example:
<key>Real Storage Size</key>
<dict>
<key>Display Name</key><string>Real Storage Size</string>
<key>Value</key><integer>2048</integer>
<key>Display Unit</key><string>MB</string>
<key>Hint</key><string>Size of actual real storage online</string>
</dict>
IBM data servers have a common parameter document that includes some
keywords that are applicable to all data servers, and others that are data server
specific. Whenever a data server adds or removes a new keyword, the version
number (for all data servers) is incremented. Depending on the change, the major
version number might be increased and the minor version number set to 0 (zero),
or only the minor version number might be incremented.
XML output documents are generated in UTF-8 and contain English characters
only.
XPath expressions for filtering output:
You can use an XPath expression to filter the XML output returned by a common
SQL API stored procedure.
To filter the output, specify a valid XPath query string in the xml_filter parameter
of the procedure. The following restrictions apply to the XPath expression that you
specify:
v The XPath expression must reference a single value.
v The XPath expression must always be absolute from the root node. For example,
the following path expressions are allowed: /, nodename, ., and ... The following
expressions are not allowed: // and @
v The only predicates allowed are [path=value] and [n].
v The only axis allowed is following-sibling.
v The XPath expression must end with one of the following, and, if necessary, be
appended with the predicate [1]: following-sibling::string,
following-sibling:: data, following-sibling::date, following-sibling::real,
or following-sibling::integer.
319
v Unless the axis is found at the end of the XPath expression, it must be followed
by a ::dict, ::string, ::data, ::date, ::real, or ::integer, and if necessary, be
appended with the predicate [1].
v The only supported XPath operator is =.
v The XPath expression cannot contain a function, namespace, processing
instruction, or comment.
Tip: If the stored procedure operates in complete mode, do not apply filtering, or a
SQLCODE (+20458) is raised.
For better control over processing the XML document returned in the xml_output
parameter, you can use the XMLPARSE function available with DB2 pureXML.
Example
The following XPath expression selects the value for the Data Server Product
Version key from an XML output document:
/plist/dict/key[.=Data Server Product Version]following-sibling::string[1]
The procedure returns the string 8.1.0.356 in the xml_output parameter. Therefore,
the procedure call returns a single value rather than an XML document.
XML message documents

When a common SQL API stored procedure encounters an internal processing
error or invalid parameter, the data server returns a SQLCODE and the
corresponding SQL message to the caller.
When this occurs, the procedure returns an XML message document in the
xml_message parameter that contains more detailed information about the warning
situation.
The XML message document has the following general structure:
<dict>
<key>Document Type Name</key><string>Data Server Message</string>
<key>Data Server Product Name</key><string>QDB2/AIX64</string>
<key>Data Server Platform</key><string>AIX 64BIT</string>
<key>Short Message Text</key>
<dict>
<key>Value</key><string>
</string>
<key>Hint</key><string></string>
</dict>
</dict>
</plist>
XML message documents are generated in UTF-8 and contain English characters
only.
320
Example
In the following example, a call to the GET_MESSAGE procedure results in an SQL
warning:
db2 "CALL SYSPROC.GET_MESSAGE(NULL,NULL,en_US,NULL,NULL,?,?)"
SQL20458W The procedure "SYSPROC.GET_MESSAGE" has encountered
an internal parameter processing error in parameter "3".
The value for parameter "7" contains further information about
the error. SQLSTATE=01H54
The XML document that is returned in parameter 7 (xml_message) contains the

following content:
<dict>
<key>Document Type Name</key><string>Data Server Message</string>
<dict>
<key>Value</key><string>If parameters 1 and 2 are set to NULL, all
other input parameters must be set to NULL as well, but the value
of parameter "3" is not NULL. </string>
</dict>
</dict>
</plist>
The value for the Short Message Text key provides additional information about
the warning.
CANCEL_WORK procedure - Cancel work

The CANCEL_WORK stored procedure cancels either a specific activity (for
example, a SQL statement), or all activity for a connected application.
To cancel a specific activity, you pass in the application handle, unit of work ID,
and activity ID for the activity that you want to cancel. To cancel all activity for a
connected application, you pass in the application handle. Any changes associated
with the cancelled activity are rolled back.
Syntax
CANCEL_WORK
( major_version , minor_version ,
requested_locale ,
xml_input , xml_filter , xml_output , xml_message )

major_version
An input and output argument of type INTEGER that indicates the major
document version. On input, this argument indicates the major document
321
version that the caller supports for the XML documents passed as parameters
in the procedure (see the parameter descriptions for xml_input, xml_output, and
xml_message). The procedure processes all XML documents in the specified
version, or returns an error (+20458) if the version is not valid. On output, this
parameter specifies the highest major document version that is supported by
the procedure. To determine the highest supported document version, specify
NULL for this input parameter and all other required parameters.
Supported versions: 1
minor_version
An input and output argument of type INTEGER that indicates the minor
document version. On input, this argument specifies the minor document
for this procedure (see the parameter descriptions for xml_input, xml_output,
and xml_message). The procedure processes all XML documents in the specified
version, or returns an error if the version is not valid. On output, this
parameter indicates the highest minor document version that is supported for
the highest supported major version. To determine the highest supported
document version, specify NULL for this input parameter and all other
required parameters.
requested_locale
An input argument of type VARCHAR(33) that specifies a locale. If the
specified language is supported on the server, translated content is returned in
the xml_output and xml_message parameters. Otherwise, content is returned in
the default language. Only the language and possibly the territory information
is used from the locale. The locale is not used to format numbers or influence
the document encoding. For example, key names and values are not translated.
The only translated portion of the XML output and XML message documents
are the text for hint, display name, and display unit of each entry. The caller
should always compare the requested language to the language that is used in
the XML output document (see the document locale entry in the XML output
document).
Currently, the only supported value for requested_locale is en_US.
xml_input
An input argument of type BLOB(32MB) that specifies an XML input
document (encoded in UTF-8) that contains input values for the procedure.
For this procedure, the XML input document must specify an application
handle. If you want to cancel a specific activity, the XML input document must
also specify optional parameters that identify a unit of work ID and an activity
ID. A complete XML input document for this stored procedure looks
something like the following document:
<dict>
<key>Document Type Name</key><string>Data Server Cancel Work Input</string>
<key>Required Parameters</key>
<dict>
<key>Application Handle</key>
<dict>
<key>Display name</key><string>Application Handle</string>
322
<key>Hint</key>
<string>
Numeric value equivalent to the application handle to be cancelled
</string>
</dict>
</dict>
<key>Optional Parameters</key>
<dict>
<key>Unit Of Work Id</key>
<dict>
<key>Display Name</key><string>Unit Of Work Id</string>
<key>Hint</key>
<string>
Numeric value that specifies the unit of work id of the activity
that is to be cancelled
</string>
</dict>
<key>Activity Id</key>
<dict>
<key>Display Name</key><string>Activity Id</string>
<key>Hint</key>
<string>
Numeric value equivalent to the activity id to be cancelled
</string>
</dict>
</dict>
</dict>
</plist>
If you specify the application handle of the application where the stored
procedure is running, the procedure returns a warning (SQL20458).
xml_filter
An input argument of type BLOB(4K) that specifies a valid XPath query string.
Use a filter when you want to retrieve a single value from an XML output
document. For more information, see the topic that describes XPath filtering.
The following example selects the value for the Data Server Product Version
from the XML output document: /plist/dict/key[.=Data Server Product
Version]/following-sibling::string. If the key is not followed by the
specified sibling, an error is returned.
xml_output
An output parameter of type BLOB(32MB) that returns a complete XML output
document in UTF-8. If a filter is specified, this parameter returns a string
value. If the stored procedure is unable to return a complete output document
(for example, if a processing error occurs that results in an SQL warning or
error), this parameter is set to NULL.
The XML output is determined by the values that you specify for major_version
and minor_version:
Major version
Minor version
xml_output value
NULL
NULL
NULL
The status of the activity that

the procedure attempted to
cancel.
When the procedure operates in complete mode, this parameter returns an XML
document that you can modify and pass back to the procedure as the
323
xml_input parameter. This approach provides a programmatic way to create

valid XML input documents. For more information, see the topic about
complete mode.
xml_message
An output parameter of type BLOB(64K) that returns a complete XML output
document of type Data Server Message in UTF-8 that provides detailed
information about a SQL warning condition. This document is returned when a
call to the procedure results in a SQL warning, and the warning message
indicates that additional information is returned in the XML message output
document. If the warning message does not indicate that additional
information is returned, then this parameter is set to NULL.
Authorization
v DBADM authority
v SQLADM authority

Example
Example 1: Return the highest supported version of the procedure.
db2 "call sysproc.cancel_work(null,null,null,null,null,?,?)"

-------------------------Parameter Name : MAJOR_VERSION
Parameter Value : 1
Parameter Name : MINOR_VERSION
Parameter Value : 0
Parameter Name : XML_OUTPUT
Parameter Value : Parameter Name : XML_MESSAGE
Parameter Value : Return Status = 0
Example 2: Cancel a specific activity.

db2 "call sysproc.cancel_work(1,0,en_US,blob(
<dict>
<dict>
324
<dict>
<key>Hint</key>
<string>
</string>
</dict>
</dict>
<dict>
<key>Unit Of Work Id</key>
<dict>
<key>Display Name</key><string>Unit Of Work Id</string>
<key>Hint</key>
<string>
Numeric value that specifies the unit of work id of the activity
that is to be cancelled
</string>
</dict>
<key>Activity Id</key>
<dict>
<key>Display Name</key><string>Activity Id</string>
<key>Hint</key>
<string>
Numeric value equivalent to the activity id to be cancelled
</string>
</dict>
</dict>
</dict>
</plist> ) ,null,?,?)"

Parameter Value : 1
Parameter Value : 0
Parameter Value : x3C3F78...
Parameter Name : XML_MESSAGE
If the CANCEL_WORK procedure is able to cancel the activity, the XML output
document contains the following content:
<dict><key>Document Type Name</key><string>Data Server Cancel Work Output</string>
<key>Successful Cancel Work Message</key>
325
<dict>
<key>Display Name</key><string>Successful Cancel Work Message</string>
<key>Value</key><string>The activity has been cancelled successfully</string>
</dict>
</dict>
</plist>
Example 2: Cancel the application.

<dict>
<dict>
<dict>
<key>Hint</key>
<string>
</string>
</dict>
</dict>
</dict>
</plist> ),null,?,?)"

Parameter Value : 1
Parameter Value : 0
If the CANCEL_WORK procedure is able to cancel the application, the XML

output document contains the following content:
<dict>
<key>Document Type Name</key><string>Data Server Cancel Work Output</string>
<key>Successful Cancel Work Message</key>
<dict>
<key>Display Name</key><string>Successful Cancel Work Message</string>
326
<key>Value</key>
<string>The application has been cancelled successfully</string>
</dict>
</dict>
</plist>
Example 3: Specify a filter to return the value of a successful cancel work message.
<dict>
<dict>
<dict>
<key>Hint</key>
<string>
</string>
</dict>
</dict>
</dict>
</plist> ),blob(/plist/dict/key[.="Successful Cancel Work Message"]
/following-sibling::dict[1]/key[.="Value"]
/following-sibling::string[1]),?,?)"

Parameter Value : 1
Parameter Value : 0
The following value is returned for xml_output:

"The application has been cancelled successfully"
DESIGN_ADVISOR - retrieve design advisor recommendations

The DESIGN_ADVISOR procedure retrieves design advisor recommendations from
a IBM DB2 10.5 server.
Syntax
DESIGN_ADVISOR (
major_version
xml_input , xml_filter
, minor_version
, xml_output
, xml_message
requested_locale

327
major_version
If the xml_input parameter specifies a Document Type Major Version key and
the major_version parameter is not NULL, then the major_version parameter
takes precedence.
minor_version
If the xml_input parameter specifies a Document Type Minor Version key and
the minor_version parameter is not NULL, then the minor_version parameter
takes precedence.
requested_locale
the default language. Only the language, and possibly the territory
information, is used from the locale. The locale is not used to format numbers
or influence the document encoding. For example, key names and values are
not translated. The only translated portion of the XML output and XML
message documents is the error message text. The caller should always
compare the requested language to the language that is used in the XML
output document (see the document locale entry in the XML output
document).
xml_input
An input argument of type BLOB(32M) that specifies a PLIST XML input
string.
328
xml_filter
An input argument of type BLOB(4K). This parameter is reserved for future
use.
xml_output
An output parameter of type BLOB(12K) that returns a PLIST XML output
string.
xml_message
document of type Data Server Message, in UTF-8 encoding. This document
provides detailed information about an SQL warning condition.
Authorization
v Read access to the database.
v Read and write access to the explain tables of the currently connected schema or
the SYSTOOLS schema.
v If materialized query tables (MQTs) are used, you must have CREATE TABLE
authorization, and read and write access to the MQTs
v EXECUTE privilege on the DESIGN_ADVISOR function.

This information is always returned unless an error is generated.
Table 86. Information returned by the DESIGN_ADVISOR - retrieve design advisor
recommendations table function
Column name
Data type
Description
SCHEMA
VARCHAR(128)
Schema name of the object or the proposed

object to which this recommendation
applies.
NAME
VARCHAR(128)
Name of the object or the proposed object

to which this recommendation applies.
EXISTS
CHAR(1)
Indicates that the object exists.
RECOMMENDATION
VARCHAR(8)
Indicates the recommendation type. Valid

values are:
v M for MQT
v P for database partitioning
v C for MDC
v I for index
v D if the object is not used by the given
workload and can be considered for
deletion.
The result can be any combination of these
values. For example MC indicates that
the table is recommended as an MQT and
an MDC table.
329
Table 86. Information returned by the DESIGN_ADVISOR - retrieve design advisor

recommendations table function (continued)
Column name
Data type
Description
BENEFIT
DOUBLE
Estimated benefit, in timerons, of the

proposed object or modification to the
proposed object of the query. For base
tables or MQTs that have MDC or
partitioning recommendations, this value is
NULL.
OVERHEAD
DOUBLE
Estimated cost, in timerons, to maintain

either the proposed object or the
modification to the proposed object. Indexes
are ranked with the formula BENEFIT OVERHEAD. MQTs are ranked with BENEFIT (0.5 * OVERHEAD). For base tables or MQTs
that have MDC or partitioning
recommendations, this value is NULL.
STATEMENT_NO
INTEGER
Statement number referred to by this

recommendation. Reflects the statement
number in the ADVISE_WORKLOAD table.
When a recommendation applies to
multiple statements, only one row is
returned for each statement.
DISKUSE
DOUBLE
Estimated size, in MB, of either the

recommended object or the result of
modifications to the current object on disk.
Usage notes
XML_INPUT options
Table 87. XML_INPUT options
330
Key name
Optional
Data type
Description
MAJOR_VERSION
INTEGER
XML_OUTPUT schema major version

supported by the client as input. If the
procedure parameter of the same name
is provided, it is used. Otherwise, this
value is retrieved and required in
XML_INPUT.
MINOR_VERSION
INTEGER
XML_OUTPUT schema minor version

supported by the client as input. If the
procedure parameter of the same name
is provided, it is used. Otherwise, this
value is retrieved and required in
XML_INPUT.
REQUESTED_
LOCALE
STRING
If the locale is supported at the server,

the error messages are returned in the
requested locale. If the locale is
unsupported or invalid, the data is
returned in the default locale of the
server. If the procedure parameter of
the same name is provided, it is used.
Otherwise, this value is retrieved and
required in XML_INPUT.
Table 87. XML_INPUT options (continued)

Key name
Optional
Data type
Description
CMD_OPTIONS
STRING
List of arguments as accepted by the

db2advis command. See the Usage
notes section for a list of differences
between the command-line parameters
accepted by the db2advis command
and this procedure.
USER_TEMP_TSPACE
STRING
The name of a USER TEMPORARY

TABLESPACE where a declared global
temporary table (DGTT) can be created
to hold the result set. If no name is
provided, fenced process memory is
used instead. The supplied table space
must exist, be writeable by the caller,
and have enough space for the entire
result set. The DGTT exists and uses
system resources until the application
disconnects. Contents are deleted each
time to save space and because the
output is non-deterministic.
Note: Special characters like &, <, >, ' (single quotation mark),
and " (double quotation mark) can be specified by their corresponding
HTML entities of &, <, >, ', and quot;.
XML_OUTPUT description
The XML_OUTPUT document is always returned in a UTF-8 code page.
Code page conversion is done for database identifiers, objects, and other
possible non-UTF-8 characters. Special characters (see XML_INPUT options
for a list) are translated as well.
Table 88. XML_OUTPUT description
Key name
Data type
Description
Document Type Name
STRING
Always returns the string Data Server

Message Output
MAJOR_VERSION
INTEGER
Document version. Currently, the only

return value is 1.
MINOR_VERSION
INTEGER
Document sub-version. Currently, the only

return value is 0.
NUM_OUTPUT_ROWS
INTEGER
Number of rows returned in the result set.
ADVISE_START_TIME
STRING
Timestamp when the advisor began

working. Equivalent to the
ADVISE_INSTANCE.
START_TIME column.
WORKLOAD_NAME
STRING
Name of the workload used by the advisor.

Equivalent to the ADVISE_WORKLOAD.
WORKLOAD_NAME column.
ADVISE_SCHEMA
STRING
Name of the explain/advisor table schema.

This schema is used to read from and write
to the ADVISE_WORKLOAD.
ADVISE_INSTANCE and other
explain/advisor tables.
331
Table 88. XML_OUTPUT description (continued)

Key name
Data type
Description
TOTAL_DISK
STRING
Total initial disk space, in MB, needed if all

recommended objects are to be created.
TOTAL_DISK_
UPPER_BOUND
INTEGER
Upper bound limit for total disk space used

when evaluating solution options, in MB.
ORIG_TOTAL_COST
STRING
Total cost, in timerons, without

recommendations.
NEW_TOTAL_COST
STRING
Total cost, in timerons, with

recommendations.
NUM_SOLUTIONS_EVAL INTEGER
Number of solutions considered and

evaluated by the advisor.
Difference between db2advis command-line parameters and

DESIGN_ADVISOR
These options are not allowed because only the current database
connection is being used by the procedure:
-[db|d]
The database name. The current database connection is used.
-[user|a]
The username to connect with (and optionally, the user password).
In DESIGN_ADVISOR, this option is replaced by the
SESSION_USER special register.
-[password|x]
This parameter indicates that the password is read from the
standard input. It is not used in DESIGN_ADVISOR.
For file and directory locations, supply absolute path names whenever
possible, to ensure a consistent behavior on different database server
installations. Files and directories need to be readable (-file) or writeable
(-script) by the fenced user ID on Linux/UNIX, or the DB2USERS group
on Windows.
When the command-line options -file or -script are used, the statements
are inserted into the ADVISE_WORKLOAD table for later reference with a
unique workload name.
Clarification of the different schemas used by db2advis
Explain/advisor table schema name
The explain/advisor table schema name used by the
DESIGN_ADVISOR procedure is defined by the CURRENT_USER
special register. This special register defaults to the currently
connected user. If the explain/advisor tables are not found through
the user ID defined in the previous two options, then the
SYSTOOLS schema is used.
Recommended objects schema name
The schema name for recommended objects is optionally defined
using the -[schema|n] command-line option. If no name is
provided, the value of the SESSION_USER special register is used
by default.
Default workload schema name
The schema name for the default workload is optionally defined
332
using the -q command-line option. If no name is provided, the

value of the SESSION_USER special register is used by default.
Examples
Example 1: An example of an XML_INPUT:
<dict>
<key>MAJOR_VERSION</key><integer>1</integer>
<key>MINOR_VERSION</key><integer>0</integer>
<key>REQUESTED_LOCALE</key><string>en_US</string>
<key>CMD_OPTIONS</key><string>-w "workload 1" -t 5</string>
<key>USER_TEMP_TSPACE</key><string>MY_TEMP_TS</string>
</dict>
</plist>
Example 2: An example of an XML_OUTPUT:

<dict>
<key>Document Type Name</key><string>Data Server Message Output</string>
<key>NUM_OUTPUT_ROWS</key><integer>1</integer>
<key>NUM_RESULT_SETS</key><integer>1</integer>
<key>ADVISE_START_TIME</key><string>2011-03-10-14.22.51.707742</string>
<key>WORKLOAD_NAME</key><string>MYWORKLOAD</string>
<key>ADVISE_SCHEMA</key><string>MYSCHEMA</string>
<key>TOTAL_DISK</key><string>0.0762</string>
<key>TOTAL_DISK_UPPER_BOUND</key><string>33.3203</string>
<key>ORIG_TOTAL_COST</key><string>28434.0000</string>
<key>NEW_TOTAL_COST</key><string>11108.0000</string>
<key>NUM_SOLUTIONS_EVAL</key><integer>31</integer>
</dict>
</plist>
Example 3: An example of an XML_MESSAGE:

<dict>
<key>db2luw20458E</key><string>SQLCODE: 20458, SQLSTATE: 01H54 ,
<![CDATA[SQL20458W The procedure "SYSPROC.DESIGN_ADVISOR" has
encountered an internal parameter processing error in parameter "4".
The value for parameter "7" contains further information about
the error.]]>(Extra message: <![CDATA[Error: Unsupported major
version.]]>)</string>
</dict>
</plist>
Example 4: A full initialization and procedure call, with the resulting XML outputs.
Initializing the workload:
db2 "INSERT INTO ADVISE_WORKLOAD values(workload 1, 0,
SELECT COUNT(*) FROM EMPLOYEE,,100,0,0,0,0,)"
SELECT * FROM EMPLOYEE WHERE LASTNAME=HAAS ,,100,0,0,0,0,)"
SELECT AVG(BONUS), AVG(SALARY) FROM EMPLOYEE GROUP BY WORKDEPT
ORDER BY WORKDEPT,,1,0,0,0,0,)"
333
Call the stored procedure:

db2 "CALL SYSPROC.DESIGN_ADVISOR(1,0, en_US, blob(
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<plist version=\"1.0\">
<dict>
<key>REQUESTED_LOCALE</key><string>en_US</string>
<key>CMD_OPTIONS</key><string>-i "
/home/dricard/prog/adv spaces! sp/cli/db2advis.in" -t 5</string>
</dict>
</plist>) , NULL, ?, ?)"
The value of the output parameters:

Parameter Name : MAJOR_VERSION
Parameter Value : 1
Parameter Value : 0
Parameter Value : x
<dict>
<key>Document Type Name</key><string>Data Server Message Output</string>
<key>NUM_OUTPUT_ROWS</key><integer>3</integer>
<key>NUM_RESULT_SETS</key><integer>1</integer>
<key>ADVISE_START_TIME</key><string>2011-03-10-14.22.51.707742</string>
<key>WORKLOAD_NAME</key><string>MYWORKLOAD</string>
<key>ADVISE_SCHEMA</key><string>MYSCHEMA</string>
<key>TOTAL_DISK</key><string>0.076</string>
<key>TOTAL_DISK_UPPER_BOUND</key><string>33.377</string>
<key>ORIG_TOTAL_COST</key><string>28434.0000</string>
<key>NEW_TOTAL_COST</key><string>11108.0000</string>
<key>NUM_SOLUTIONS_EVAL</key><string>31</string>
</dict>
</plist>
Parameter Value : -
The values of the result set:

CREATOR
------------------------DRICARD
DRICARD
DRICARD
NAME
------------------------XEMP2
IDX1103211528140
IDX1103211529540
EXISTS
-----Y
N
N
RECOMMENDATION
-------------I
I
I
...
...
...
...
...
Output from the result set continued:

BENEFIT
OVERHEAD
------------------------ -----------------------+0.00000000000000E+000
+0.00000000000000E+000
+1.72000000000000E+004
+0.00000000000000E+000
+1.26000000000000E+002
+0.00000000000000E+000
STMTNO
----------0
1
2
DISKUSE
---------------------+0.00000000000000E+000
+0.06350000000000E+000
+1.27190000000000E-002
GET_CONFIG procedure - Get configuration data

The GET_CONFIG stored procedure retrieves the database configuration, database
manager configuration, and registry variables that are set for a particular instance.
334
In a partitioned database environment, this procedure retrieves database

configuration and registry variable settings from all partitions.
Syntax
GET_CONFIG (
xml_input ,
major_version
xml_filter
minor_version
xml_output
requested_locale
, xml_message

major_version
Supported versions: 1 and 2
minor_version
requested_locale
document).
xml_input
Currently, this procedure accepts no input. You must specify NULL for this
parameter, or an error (+20458) is raised to indicate that the input is not valid.
335
xml_filter
The following example selects the value for the data server product version
xml_output
and minor_version:
Major version
Minor version
xml_output value
NULL
NULL
NULL
Database manager and

database configuration
parameters and registry
variables, including their
values.
Database manager and

parameters grouped into
categories. For each
parameter, indicates whether
the parameter can be
updated. Also returns
registry variables and the
values set for the instance.
complete mode.
xml_message
Authorization
336
v DBADM authority
v SQLADM authority

Example
Example 1: Return the latest version of the procedure.
db2 "call sysproc.get_config(null,null,null,null,null,?,?)"

Parameter Value : 2
Parameter Value : 0
Example 2: Return database and database manager configuration parameters,

grouped into categories.
db2 "call sysproc.get_config(2,0,en_US,null, null, ?,?)"

Parameter Value : 2
Parameter Value : 0
Parameter Value : x3C3F78.......
The XML output document contains the following content:

<dict>
<key>Document Type Name</key><string>Data Server Configuration Output</string>
337

<key>Database Manager Configuration Parameter Settings</key>
<dict>
<key>Display Name</key>
<string>Database Manager Configuration Parameter Settings</string>
<key>Application</key>
<dict>
<key>Display Name</key><string>Application</string>
<key>agentpri</key>
<dict>
<key>Display Name</key><string>agentpri</string>
<key>Parameter Value</key>
<dict>
<key>Display Name</key><string>Parameter Value</string>
<key>Value</key><string>-1</string>
<key>Updatable</key><string>No</string>
</dict>
<key>Value Flags</key>
<dict>
<key>Display Name</key><string>Value Flags</string>
<key>Value</key><string>NONE</string>
</dict>
<key>Deferred Value</key>
<dict>
<key>Display Name</key><string>Deferred Value</string>
<key>Value</key><string>-1</string>
<key>Updatable</key><string>Yes</string>
</dict>
<key>Deferred Value Flags</key>
<dict>
<key>Display Name</key><string>Deferred Value Flags</string>
<key>Value</key><string>INTEGER</string>
</dict>
<key>Data Type</key>
<dict>
<key>Display Name</key><string>Data Type</string>
</dict>
<key>Hint</key>
<string>
Specifies the priority given to an agent and other database manager
instance processes and threads by the operating system scheduler.
Consider rebinding applications after changing this parameter.
</string>
</dict>
</dict>
</dict>
<key>Administration</key>
.
.
.
<key>Communication</key>
.
.
.
<key>Diagnostics</key>
.
.
338
.
<key>Environment</key>
.
.
.
<key>Miscellaneous</key>
.
.
.
<key>Monitor</key>
.
.
.
<key>Parallel</key>
.
.
.
<key>Performance</key>
.
.
.
</dict>
<key>Database Partition</key>
<dict>
<key>Display Name</key><string>Database Partition</string>
<key>0</key>
<dict>
<key>Display Name</key><string>0</string>
<key>Database Configuration Parameter Settings</key>
<dict>
<string>Database Configuration Parameter Settings</string>
<key>Application</key>
.
.
.
<key>Environment</key>
<dict>
<key>Display Name</key><string>Environment</string>
<key>alt_collate</key>
<dict>
<key>Display Name</key><string>alt_collate</string>
<dict>
<key>Value</key><string></string>
</dict>
<dict>
</dict>
<dict>
</dict>
<dict>
<key>Value</key><string>INTEGER</string>
339
</dict>
<key>Data Type</key>
<dict>
<key>Display Name</key><string>Data Type</string>
</dict>
<key>Hint</key>
<string>
Specifies the collating sequence to be used for Unicode tables in a
non-Unicode database. Until this parameter is set, Unicode tables and
routines cannot be created in a non-Unicode database. When set, this
parameter cannot be changed or reset. Default [range] :
Null [IDENTITY_16BIT].
</string>
</dict>
.
.
.
</dict>
<key>Logs</key>
.
.
.
<key>Maintenance</key>
.
.
.
<key>Performance</key>
.
.
.
<key>Recovery</key>
.
.
.
<key>Status</key>
.
.
.
</dict>
<key>Registry Variables Settings</key>
<dict>
<key>Display Name</key><string>Registry Variables Settings</string>
<key>DB2CODEPAGE</key>
<dict>
<key>Display Name</key><string>DB2CODEPAGE</string>
<dict>
<key>Value</key><string>1208</string>
</dict>
<key>Is Aggregate</key>
<dict>
<key>Display Name</key><string>Is Aggregate</string>
</dict>
<key>Aggregate Name</key>
<dict>
<key>Display Name</key><string>Aggregate Name</string>
</dict>
340
<key>Level</key>
<dict>
<key>Display Name</key><string>Level</string>
<key>Value</key><string>I</string>
</dict>
</dict>
.
.
.
</dict>
</dict>
</dict>
</plist>
Example 3: Return database and database manager configuration parameters.

db2 "call sysproc.get_config(1,0,en_US,null, null, ?,?)"

Parameter Value : 1
Parameter Value : 0
Parameter Value : x3C3F78.......
The XML output document contains content that is similar to example 2, but does
not group the configuration parameters into categories.
Example 4: Call the procedure from a function.
sqlint16 getconfigMaj;
sqlint16 getconfigMin;
SQL TYPE IS BLOB(2M) xmlOutput;
SQL TYPE IS BLOB(2K) xmlOutMessage;
getconfigMaj = 2;
getconfigMin = 0;
EXEC SQL CALL SYSPROC.GET_CONFIG(
:getconfigMaj,
:getconfigMin,
en_US,
null,
null,
:xmlOutput,
:xmlOutMessage );
GET_MESSAGE procedure - Get message text

The GET_MESSAGE procedure returns the short message text, long message text,
and SQLSTATE for an SQLCODE.
341
Syntax
GET_MESSAGE
( major_version , minor_version , requested_locale ,
xml_input , xml_filter ,
xml_output ,
xml_message )

major_version
If the XML document in the xml_input parameter specifies a Document Type
Major Version key, the value for that key must be equal to the value provided
in the major_version parameter, or an error (+20458) is raised.
Supported versions: 1 and 2
minor_version
Minor Version key, the value for that key must be equal to the value provided
in the minor_version parameter, or an error (+20458) is raised.
requested_locale
document).
342

xml_input
For this procedure, the XML input document contains an SQLCODE and uses
the following format:
<dict>

<dict>
<key>SQL Code</key><integer></integer>
<key>Message Identifier</key><integer></integer>
<key>Message Tokens</key><array><string>...</string></array>
</dict>
<dict>
<key>Message Token Delimiter<key><string>;</string>
</key></key></dict>
</dict>
</plist>
xml_filter
The following example selects the value for the SQLSTATE from the XML
output document: /plist/dict/key[.="SQLSTATE"]/followingsibling::dict[1]/key[.="Value"]/following-sibling::string[1]. If the key is
not followed by the specified sibling, an error is returned.
xml_output
and minor_version:
Major version
Minor version
xml_output value
NULL
NULL
NULL
Returns the short text

message and SQLSTATE for
the corresponding SQLCODE
passed in xml_input.
Returns the short text

message, long text message
and SQLSTATE for the
corresponding SQLCODE
passed in xml_input.
343

complete mode.
xml_message
Authorization
v DBADM authority
v SQLADM authority

Example
Example 1: Return the highest supported version of the procedure.
db2 "call sysproc.get_message(null,null,null,null,null,?,?)"

Parameter Value : 2
Parameter Value : 0
Example 2: Run a script called getmsglong.sql to return the short text message and
long text message for SQL1034.
getmsglong.sql:
call sysproc.get_message(2,0, en_US, blob(
<dict>
344
<dict>
<key>SQLCODE</key><string>SQL1034</string>
</dict>
</dict>
</plist>), null, ? , ?)@

Parameter Value : 2
Parameter Value : 0
Parameter Value : x3C3F786D6C20766572........................
The output XML document contains the following content:

<dict>
<string>Data Server Message Output</string>
<key>Document Type Major Version</key>
<integer>2</integer>
<key>Document Type Minor Version</key>
<key>Data Server Product Name</key>
<string>QDB2/AIX64</string>
<key>Data Server Product Version</key>
<string>9.7.0.0</string>
<key>Data Server Major Version</key>
<key>Data Server Minor Version</key>
<key>Data Server Platform</key>
<string>AIX 64BIT</string>
<key>Document Locale</key>
<string>en_US</string>
<dict>
<key>Display Name</key><string>Short Message Text</string>
<key>Value</key>
<string>
SQL1034C The database is damaged. All applications processing the database
have been stopped.
</string>
</dict>
<key>SQLSTATE</key>
<dict>
<key>Display Name</key><string>SQLSTATE</string>
<key>Value</key><string> 58031</string>
</dict>
<key>Long Message Text</key>
<dict>
<key>Display Name</key><string>Long Message Text</string>
<key>Value</key>
<array>
345
<string>
SQL1034C The database is damaged. All applications
processing the
</string>
<string>
database have been stopped.</string>
<string></string>
<string>Explanation: </string>
<string></string>
<string>
Damage has occurred to the database. It cannot be used until it is
</string>
<string>
recovered. All applications connected to the database have been
</string>
<string>
disconnected and all processes running applications on the
database have
</string>
<string>been stopped.</string>
<string></string>
<string>The command cannot be processed.</string>
<string></string>
<string>User response: </string>
<string></string>
<string>
Issue a RESTART DATABASE command to recover the database. If the RESTART
</string>
<string>
command consistently fails, you may want to restore the database from a
</string>
<string>
backup. In a partitioned database server environment, check the syslog
</string>
<string>
to find out if the RESTART command fails because of node or
</string>
<string>
communication failures before restoring the database from a backup. If
</string>
<string>
so, ensure the database manager is up and running and communication is
</string>
<string>
available among all the nodes, then resubmit the restart command.
</string>
<string></string>
<string>
If you encountered this error during roll-forward processing, you must
</string>
<string>
restore the database from a backup and perform roll-forward again.
</string>
<string></string>
<string>
Note that in a partitioned database environment, the RESTART database
</string>
<string>
command is run on a per-node basis. To ensure that the database is
</string>
<string>restarted on all nodes, use the command: </string>
<string></string>
<string>db2_all db2 restart database</string>
<string><database_name></string>
<string></string>
<string>
This command may have to be run several times to ensure that all
</string>
346
<string>in-doubt transactions have been resolved.</string>

<string></string>
<string>
If you are installing the sample database, drop it and install the
</string>
<string>sample database again.</string>
<string></string>
<string> sqlcode: -1034</string>
<string></string>
<string> sqlstate: 58031</string>
<string></string>
<string></string>
<string></string>
</array>
</dict>
</dict>
</plist>
Example 3: Run a script called getmsgshort.sql to return only the short text
message for SQL1034.
getmsgshort.sql:
call sysproc.get_message(1,0,en_US, blob(
<dict>
<dict>
</dict>
</dict>
</plist>), null, ? , ?)@

Parameter Value : 2
Parameter Value : 0
Parameter Value : x3C3F786D6C20766572........................
SQL20460W The procedure "SYSPROC.GET_MESSAGE" supports a higher version, "2",
than the specified version, "1", for parameter "1".
The XML output document contains the following content:

<dict><key>Document Type Name</key><string>Data Server Message Output</string>
347

<dict>
<key>Display Name</key><string>Short Message Text</string>
<key>Value</key>
<string>
SQL1034C The database is damaged. All applications processing the database
have been stopped.
</string>
</dict>
<key>SQLSTATE</key>
<dict>
<key>Value</key><string> 58031</string>
</dict>
</dict>
</plist>
Example 4: Specify a filter to return the SQLSTATE for SQL1034.

db2 "call sysproc.get_message(2,0, en_US, blob(
<dict>
<string>Data Server Message Input</string>
<dict>
</dict>
</dict>
</plist>),
blob(/plist/dict/key[.="SQLSTATE"]/following-sibling::dict[1]/
key[.="Value"]/following-sibling::string[1]), ? , ?)"

Parameter Value : 2
Parameter Value : 0
Parameter Value : x203538303331

58031

sqlint16 getMsgMaj;
sqlint16 getMsgMin;
348

getMsgMaj = 2;
getMsgMin = 0;
EXEC SQL CALL SYSPROC.GET_MESSAGE(
:getMsgMaj,
:getMsgMin,
en_US,
BLOB(
<dict>
<string>
Data Server Message Input
</string>
<dict>
</dict>
</dict>
</plist>),
null,
:xmlOutput,
:xmlOutMessage );
GET_SYSTEM_INFO procedure - Get system information

The GET_SYSTEM_INFO procedure returns information about the data server,
including information about the system, the current instance, installed data server
products, environment variables, available CPUs, and other system information.
Syntax
GET_SYSTEM_INFO ( major_version , minor_version , requested_locale ,
xml_input , xml_filter , xml_output , xml_message )
major_version
349
minor_version
requested_locale
document).
xml_input
Currently, this procedure accepts no input. You must specify NULL for this
parameter, or an error (+20458) is raised to indicate that the input is not valid.
xml_filter
The following example selects the value for the Data Server Product Version
xml_output
The XML output document contains instance information, including
information about the fix pack level, release, system information, and
environment variables.
xml_message
350

Authorization
v DBADM authority
v SQLADM authority

Example
Example 1: Return the highest version of the procedure.
db2 "call sysproc.get_system_info(null,null,null,null,null,?,?)"

Parameter Value : 1
Parameter Value : 0
Example 2: Return system information.

db2 "call sysproc.get_system_info(1,0,en_US,null,null,?,?)"

Parameter Value : 1
Parameter Value : 0
Parameter Value : x3C3F786D6C20766572.....
The XML output document contains something similar to the following content:
351
<dict><key>Document Type Name</key><string>Data Server System Output</string>
<key>Instance Information</key>
<dict>
<key>Display Name</key><string>Instance Information</string>
<key>Instance Name</key>
<dict>
<key>Display Name</key><string>Instance Name</string>
<key>Value</key><string>myinstance</string>
</dict>
<key>Partitionable State</key>
<dict>
<key>Display Name</key><string>Partitionable State</string>
</dict>
<key>Number of Database Partitions</key>
<dict>
<key>Display Name</key><string>Number of Database Partitions</string>
</dict>
.
.
.
</dict>
<key>Product Information</key>
<dict>
<key>Display Name</key><string>Product Information</string>
.
.
.
<key>DB2_ENTERPRISE_SERVER_EDITION</key>
<dict>
<key>Display Name</key><string>DB2_ENTERPRISE_SERVER_EDITION</string>
<key>Product short name</key>
<dict>
<key>Display Name</key><string>Product short name</string>
<key>Value</key><string>ESE</string>
</dict>
<key>Licence</key>
<dict>
<key>Display Name</key><string>Licence</string>
<key>Value</key><string>Y</string>
</dict>
<key>Product Release</key>
<dict>
<key>Display Name</key><string>Product Release</string>
<key>Value</key><string>9.7</string>
</dict>
<key>Licence type</key>
<dict>
<key>Display Name</key><string>Licence type</string>
<key>Value</key><string>DEVELOPER</string>
352
</dict>
</dict>
.
.
.
<key>Operating System Information</key>
<dict>
<key>Display Name</key><string>Operating System Information</string>
<key>Name</key>
<dict>
<key>Display Name</key><string>Name</string>
<key>Value</key><string>AIX</string>
</dict>
<key>Version</key>
<dict>
<key>Display Name</key><string>Version</string>
</dict>
<key>Release</key>
<dict>
<key>Display Name</key><string>Release</string>
</dict>
<key>Hostname</key>
<dict>
<key>Display Name</key><string>Hostname</string>
<key>Value</key><string>achilles</string>
</dict>
.
.
.
</dict>
<key>Workload Management Configuration</key>
<dict>
<key>Display Name</key><string>Workload Management Configuration</string>
<key>Service Class Information</key>
<dict>
<key>Display Name</key><string>Service Class Information</string>
<key>1</key>
<dict>
<key>Service Class Name</key>
<dict>
<key>Display Name</key><string>Service Class Name</string>
<key>Value</key><string>SYSDEFAULTSYSTEMCLASS</string>
</dict>
<key>Parent Identifier</key>
<dict>
<key>Display Name</key><string>Parent Identifier</string>
</dict>
<key>Parent Class Name</key>
<dict>
<key>Display Name</key><string>Parent Class Name</string>
</dict>
<key>Creation Time</key>
<dict>
<key>Display Name</key><string>Creation Time</string>
353
<key>Value</key><string>2008-04-21-15.14.32.956930</string>
</dict>
<key>Alter Time</key>
<dict>
<key>Display Name</key><string>Alter Time</string>
</dict>
<key>Enabled</key>
<dict>
<key>Display Name</key><string>Enabled</string>
</dict>
<key>Agent Priority</key>
<dict>
<key>Display Name</key><string>Agent Priority</string>
<key>Value</key><integer>-32768</integer>
</dict>
<key>Prefetcher Priority</key>
<dict>
<key>Display Name</key><string>Prefetcher Priority</string>
<key>Value</key><string> </string>
</dict>
.
.
.
</dict>
.
.
.
<key>Workload Information</key>
<dict>
<key>Display Name</key><string>Workload Information</string>
<key>1</key>
<dict>
<key>Workload Name</key>
<dict>
<key>Display Name</key><string>Workload Name</string>
<key>Value</key><string>SYSDEFAULTUSERWORKLOAD</string>
</dict>
<key>Evaluation Order</key>
<dict>
<key>Display Name</key><string>Evaluation Order</string>
</dict>
<key>Creation Time</key>
<dict>
<key>Display Name</key><string>Creation Time</string>
</dict>
<key>Alter Time</key>
<dict>
<key>Display Name</key><string>Alter Time</string>
</dict>
<key>Enabled</key>
<dict>
354
<key>Display Name</key><string>Enabled</string>
</dict>
<key>Allow Access</key>
<dict>
<key>Display Name</key><string>Allow Access</string>
</dict>
<key>Service Class Name</key>
<dict>
<key>Display Name</key><string>Service Class Name</string>
<key>Value</key><string>SYSDEFAULTSUBCLASS</string>
</dict>
<key>Parent Service Class Name</key>
<dict>
<key>Display Name</key><string>Parent Service Class Name</string>
<key>Value</key><string>SYSDEFAULTUSERCLASS</string>
</dict>
.
.
.
</dict>
</dict>
</dict>
</dict></dict></dict></plist>
Example 3: Call the GET_SYSTEM_INFO procure and pass in an unsupported

locale.
db2 "call sysproc. get_system_info(1,0,ja_JP,null,null,?,?)"

Parameter Value : 1
Parameter Value : 0
Parameter Value : x3C3F786D6C20766572.....
SQL20461W The procedure "SYSPROC.GET_SYSTEM_INFO" returned output in the
alternate locale, "en_US", instead of the locale, "ja_JP", specified in
parameter "3". SQLSTATE=01H57
The XML output document will contain the same content that is shown for
Example 2.
sqlint16 getSysInfMaj;
sqlint16 getSysInfMin;
355

getSysInfMaj = 1;
getSysInfMin = 0;
EXEC SQL CALL SYSPROC.GET_SYSTEM_INFO(
:getSysInfMaj,
:getSysInfMin,
en_US,
null,
null,
:xmlOutput,
:xmlOutMessage );
SET_CONFIG procedure - Set configuration parameters

The SET_CONFIG stored procedure updates the database and database manager
configuration parameters that are returned by the GET_CONFIG procedure.
The SET_CONFIG procedure accepts an input XML document that contains
configuration parameters and their values, uses this information to update the
specified configuration parameters, and returns an output XML document that
indicates the update status of each configuration parameter.
Syntax
SET_CONFIG (
xml_input ,
major_version
xml_filter ,
, minor_version
xml_output
requested_locale
xml_message

major_version
minor_version
356

Minor Version key, the value for that key must be equal to the value provided
in the minor_version parameter, or an error (+20458) is raised.
requested_locale
document).
xml_input
For this procedure, the XML input document contains database and database
manager configuration settings.
xml_filter
The following example selects the value for a specific configuration parameter
setting from the XML output document: /plist/dict/key[.="Database Manager
Configuration Parameter Settings"]/following-sibling::dict[1]/key[3]/
following-sibling::dict[1]/dict[1]/key[.="Value"]/followingsibling::string[1]. If the key is not followed by the specified sibling, an error
is returned.
xml_output
When this procedure operates in complete mode, this parameter returns an
XML document that contains the current configuration values set in the server.
You can modify this document and pass it back to the procedure as the
valid XML input documents.
xml_message
357
Authorization
v DBADM authority
v SQLADM authority

Example
Example 1: Return the latest version of the procedure.
db2 "call
sysproc.set_config (null,null,null,null,null,?,?)"

Parameter Value : 1
Parameter Value : 0
Example 2: Run a script called setconfig.sql that updates a few database and
database manager configuration parameters.
setconfig.sql:
call sysproc.set_config(1,0,en_US,blob(
<dict>
<key>Document Type Name</key><string>Data Server Set Configuration Input</string>
<dict>
<key>diaglevel</key><dict><key>Parameter Value</key>
<dict>
</dict>
</dict>
<key>fcm_num_buffers</key>
358
<dict>
<dict>
</dict>
<dict>
<key>Value</key><string>MANUAL</string>
</dict>
</dict>
<key>instance_memory</key>
<dict>
<dict>
</dict>
<dict>
<key>Value</key><string>AUTOMATIC</string>
</dict>
</dict>
</dict>
<dict>
<key>All</key>
<dict>
<dict>
<key>avg_appls</key>
<dict>
<dict>
<key>Value></key><string>2</string>
</dict>
<dict>
</dict>
</dict>
<key>database_memory</key>
<dict>
<dict>
</dict>
<dict>
</dict>
</dict>
</dict>
</dict>
</dict>
</dict>
</plist>), null, ?,?)@

Parameter Value : 1
Parameter Value : 0
359

The output XML document contains something similar to the following content:
<dict>
<string>Data Server Set Configuration Output</string>
<dict>
<string>Database Manager Configuration Parameter Settings</string>
<key>diaglevel</key>
<dict>
<key>Display Name</key><string>diaglevel</string>
<dict>
</dict>
<key>Parameter Update Status</key>
<dict>
<key>Display Name</key><string>Parameter Update Status</string>
<key>SQLCODE</key>
<dict
<key>Display Name</key><string>SQLCODE</string>
</dict>
<key>Message Tokens</key>
<dict>
<key>Display Name</key><string>Message Tokens</string>
<key>Value</key><array><string></string></array>
</dict>
<key>SQLSTATE</key>
<dict>
</dict>
</dict>
</dict>
<dict>
<key>Display Name</key><string>fcm_num_buffers</string>
<dict>
</dict>
<dict>
</dict>
360

<dict>
<key>SQLCODE</key><dict>
<key>Value</key> <integer>0</integer>
</dict>
<dict>
</dict>
<key>SQLSTATE</key>
<dict>
</dict>
</dict>
</dict>
<dict>
<key>Display Name</key><string>instance_memory</string>
<dict>
</dict>
<dict>
</dict>
<dict>
<key>SQLCODE</key>
<dict>
</dict>
<dict>
</dict>
<key>SQLSTATE</key>
<dict>
</dict>
</dict>
</dict>
</dict>
<dict>
<key>Display Name</key><string>Database Partition</string>
<key>All</key>
<dict>
<key>Display Name</key><string>All</string>
<dict>
<string>Database Configuration Parameter Settings</string>
<dict>
<key>Display Name</key><string>avg_appls</string>
361
<dict>
</dict>
<dict>
</dict>
<dict>
<key>Update Coverage</key>
<dict>
<key>Display Name</key><string>Update Coverage</string>
<key>Value</key><string>Complete</string>
</dict>
<key>SQLCODE</key>
<dict>
</dict>
<dict>
<key>Value</key><array><string></string> </array>
</dict>
<key>SQLSTATE</key>
<dict>
</dict>
</dict>
</dict>
<dict>
<key>Display Name</key><string>database_memory</string>
<dict>
</dict>
<dict>
</dict>
<dict>
<key>Update Coverage</key>
<dict>
<key>Display Name</key><string>Update Coverage</string>
<key>Value</key><string>Complete</string>
</dict>
<key>SQLCODE</key>
<dict>
</dict>
<dict>
</dict>
<key>SQLSTATE</key>
<dict>
362
</dict>
</dict>
</dict>
</dict>
</dict>
</dict>
</dict>
</plist>
Example 3: Specify a filter to return the value for a specific configuration parameter.
db2 "call sysproc.set_config(1,0, en_US, blob(
<dict>
<key>Document Type Name</key><string>Data Server Set Configuration Input</string>
<dict>
<key>diaglevel</key>
<dict>
<dict>
</dict>
</dict>
<dict>
<dict>
</dict>
<dict>
</dict>
</dict>
<dict>
<dict>
</dict>
<dict>
</dict>
</dict>
</dict>
<dict>
<key>All</key>
<dict>
<dict>
<dict>
<dict>
</dict>
<dict>
363
</dict>
</dict>
<dict>
<dict>
</dict>
<dict>
</dict>
</dict>
</dict>
</dict>
</dict>
</dict>
</plist>),
blob(/plist/dict/key[.="Database Manager Configuration Parameter Settings"]
/following-sibling::dict[1]/key[3]
/following-sibling::dict[1]/dict[1]/key[.="Value"]
/following-sibling::string[1]),?,?)"

Parameter Value : 1
Parameter Value : 0
Parameter Value : x34303936

4096

sqlint16 getconfigMaj;
sqlint16 getconfigMin;
getconfigMaj = 1;
getconfigMin = 0;
EXEC SQL CALL SYSPROC.SET_CONFIG(
:getconfigMaj,
:getconfigMin,
en_US,
BLOB(blob(
<dict>
<string>Data Server Set Configuration Input</string>
364

<dict>
<key>diaglevel</key><dict><key>Parameter Value</key>
<dict>
</dict>
</dict>
<dict>
<dict>
</dict>
<dict>
</dict>
</dict>
<dict>
<dict>
</dict>
<dict>
</dict>
</dict>
</dict>
<dict>
<key>All</key>
<dict>
<dict>
<dict>
<dict>
</dict>
<dict>
</dict>
</dict>
<dict>
<dict>
</dict>
<dict>
</dict>
</dict>
</dict>
</dict>
</dict>
</dict>
365
</plist>),
null,
:xmlOutput,
:xmlOutMessage );
Configuration routines and views

DBCFG administrative view and DB_GET_CFG table function Retrieve database configuration parameter information
The DBCFG administrative view and DB_GET_CFG table function retrieves
database configuration parameter information for the currently connected database
for all database members.
v DBCFG administrative view
v DB_GET_CFG table function on page 367
DBCFG administrative view

Authorization
v SELECT privilege on the DBCFG administrative view
v CONTROL privilege on the DBCFG administrative view
v DBADM authority
v SQLADM authority

Examples
Example 1: Retrieve the automatic maintenance settings in the database
configuration that are stored in memory for all database members.
SELECT DBPARTITIONNUM, NAME, VALUE FROM SYSIBMADM.DBCFG WHERE NAME LIKE auto_%
The following is an example of output for this query.

DBPARTITIONNUM
-------------0
0
0
0
0
0
NAME
-------------------------------auto_maint
auto_db_backup
auto_tbl_maint
auto_runstats
auto_reorg
autorestart
VALUE
-------------OFF
OFF
OFF
OFF
OFF
ON
Example 2: Retrieve all the database configuration parameters values stored on disk
for all database members.
366
SELECT NAME, DEFERRED_VALUE, DBPARTITIONNUM FROM SYSIBMADM.DBCFG

NAME
----------------...app_ctl_heap_sz
appgroup_mem_sz
applheapsz
archretrydelay
...
autorestart
avg_appls
blk_log_dsk_ful
catalogcache_sz
...
DEFERRED_VALUE
DBPARTITIONNUM
---------------...- -------------128
0
30000
0
256
0
20
0
ON
1
NO
-1
0
0
0
0
DB_GET_CFG table function

Syntax
DB_GET_CFG (
member

member
An optional input argument of type INTEGER that specifies the number of a
member in the same instance as the currently connected database. Specify -1
for the current member, or -2 for all members. If the null value is specified, -1
is set implicitly.
Authorization
v
v
v
v
EXECUTE privilege on the DB_GET_CFG table function

DBADM authority
SQLADM authority

Example
In a DB2 pureScale environment, retrieve the automatic maintenance settings in the
database configuration that are stored in memory for all members.
SELECT NAME, VARCHAR(VALUE, 20) AS VALUE, MEMBER,
DBPARTITIONNUM FROM TABLE(SYSPROC.DB_GET_CFG(-2))
WHERE NAME LIKE auto_% ORDER BY NAME, MEMBER
367
NAME
-------------------------------auto_db_backup
auto_db_backup
auto_db_backup
auto_del_rec_obj
auto_del_rec_obj
auto_del_rec_obj
auto_maint
auto_maint
auto_maint
auto_reorg
auto_reorg
auto_reorg
auto_reval
auto_reval
auto_reval
auto_runstats
auto_runstats
auto_runstats
auto_stats_views
auto_stats_views
auto_stats_views
auto_stmt_stats
auto_stmt_stats
auto_stmt_stats
auto_tbl_maint
auto_tbl_maint
auto_tbl_maint
autorestart
autorestart
autorestart
VALUE
-------------------OFF
OFF
OFF
OFF
OFF
OFF
ON
ON
ON
OFF
OFF
OFF
DEFERRED
DEFERRED
DEFERRED
ON
ON
ON
OFF
OFF
OFF
ON
ON
ON
ON
ON
ON
ON
ON
ON
MEMBER DBPARTITIONNUM
------ -------------0
0
1
0
2
0
0
0
1
0
2
0
0
0
1
0
2
0
0
0
1
0
2
0
0
0
1
0
2
0
0
0
1
0
2
0
0
0
1
0
2
0
0
0
1
0
2
0
0
0
1
0
2
0
0
0
1
0
2
0
Table 89. Information returned by the DBCFG administrative view and the DB_GET_CFG
table function
Column name
Data type
Description
NAME
VARCHAR(32)
Configuration parameter
name.
VALUE
VARCHAR(1024)
The current value of the

configuration parameter
stored in memory.
VALUE_FLAGS
VARCHAR(10)
Provides specific information

for the configuration
parameter current value.
Valid values are:
v NONE - no additional
information
v AUTOMATIC - the
has been set to automatic
368
Table 89. Information returned by the DBCFG administrative view and the DB_GET_CFG
table function (continued)
Column name
Data type
Description
DEFERRED_VALUE
VARCHAR(1024)
The value of the

configuration parameter on
disk. For some database
configuration parameters,
changes only take effect
when the database is
reactivated. In these cases, all
applications must first
disconnect from the
database. (If the database
was activated, then it must
be deactivated and
reactivated.) The changes
take effect at the next
connection to the database.
DEFERRED_VALUE_FLAGS
VARCHAR(10)

parameter deferred value.
Valid values are:
information
v AUTOMATIC - the
DATATYPE
VARCHAR(128)
data type.
DBPARTITIONNUM
SMALLINT
element
MEMBER
SMALLINT
member - Database member

monitor element
DBMCFG administrative view - Retrieve database manager

configuration parameter information
The DBMCFG administrative view returns database manager configuration
parameter information including the values in memory and the values stored on
disk.
Authorization
v
v
v
v
v
SELECT privilege on the DBMCFG administrative view

CONTROL privilege on the DBMCFG administrative view
DBADM authority
SQLADM authority
369

Examples
Example 1: Retrieve values for all the database manager configuration parameters
stored on disk:
SELECT NAME, DEFERRED_VALUE FROM SYSIBMADM.DBMCFG

NAME
-------------------------------agent_stack_sz
agentpri
alt_diagpath
alt_diagpath_resolved
alternate_auth_enc
aslheapsz
audit_buf_sz
authentication
catalog_noauth
cf_diaglevel
cf_diagpath
cf_diagpath_resolved
cf_mem_sz
cf_num_conns
cf_num_workers
clnt_krb_plugin
...
comm_bandwidth
comm_exit_list
conn_elapse
cpuspeed
cur_eff_arch_lvl
cur_eff_code_lvl
dft_account_str
dft_mon_bufpool
...
dft_mon_timestamp
dft_mon_uow
...
jdk_path
...
ssl_svcename
ssl_svr_keydb
ssl_svr_label
ssl_svr_stash
DEFERRED_VALUE
-------------------...---0
-1
AES_ONLY
15
0
SERVER
YES
2
/home/hotellnx93/db2docs2/sqllib/db2dump/
/home/hotellnx93/db2docs2/sqllib/db2dump/
131072
16
1
0.000000e+00
0
4.000000e-05
V:10 R:5 M:0 F:1 I:0 SB:0
V:10 R:5 M:0 F:1 I:0 SB:0
OFF
ON
OFF
/home/hotellnx93/db2docs2/sqllib/java/jdk64
22711
/GSKit/Keystore/key.kdb
/GSKit/Keystore/key.sth
Example 2: Retrieve all the database manager configuration parameters values.

SELECT * FROM SYSIBMADM.DBMCFG

NAME
----------------agent_stack_sz
agentpri
alt_diagpath
alt_diagpath_resolved
alternate_auth_enc
aslheapsz
audit_buf_sz
370
VALUE
--------------------------0
-1
NOT_SPECIFIED
15
0
VALUE_FLAGS
----------NONE
NONE
NONE
NONE
NONE
NONE
NONE
...
...
...
...
...
...
...
...
...
authentication
catalog_noauth
cf_diaglevel
cf_diagpath
cf_diagpath_resolved
cf_mem_sz
cf_num_conns
cf_num_workers
clnt_krb_plugin
clnt_pw_plugin
cluster_mgr
comm_bandwidth
comm_exit_list
conn_elapse
cpuspeed
cur_eff_arch_lvl
cur_eff_code_lvl
dft_account_str
dft_mon_bufpool
dft_mon_lock
dft_mon_sort
dft_mon_stmt
dft_mon_table
dft_mon_timestamp
dft_mon_uow
dftdbpath
diaglevel
diagpath
diagpath_resolved
diagsize
dir_cache
discover
discover_inst
fcm_num_anchors
fcm_num_buffers
fcm_num_channels
...
SERVER
YES
2
/home/userc/sqllib/db2dump/
/home/userc/sqllib/db2dump/
131072
16
1
0.000000e+00
0
4.000000e-05
V:10 R:5 M:0 F:1 I:0 SB:0
V:10 R:5 M:0 F:1 I:0 SB:0
OFF
OFF
OFF
OFF
OFF
ON
OFF
/home/userb
3
/home/userc/tmp/ $m
/home/userc/tmp/DIAG000
0
YES
SEARCH
ENABLE
0
0
256
NONE
NONE
NONE
NONE
NONE
AUTOMATIC
AUTOMATIC
AUTOMATIC
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
AUTOMATIC
AUTOMATIC
AUTOMATIC
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Output for this query (continued).

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
DEFERRED_VALUE
--------------------------0
-1
-------------------NONE
NONE
NONE
NONE
AES_ONLY
NONE
15
NONE
0
NONE
SERVER
NONE
YES
NONE
2
NONE
/home/userc/sqllib/db2dump/ NONE
/home/userc/sqllib/db2dump/ NONE
131072
AUTOMATIC
16
AUTOMATIC
1
AUTOMATIC
NONE
NONE
NONE
0.000000e+00
NONE
NONE
0
NONE
4.000000e-05
NONE
V:10 R:5 M:0 F:1 I:0 SB:0
NONE
V:10 R:5 M:0 F:1 I:0 SB:0
NONE
NONE
DATATYPE
-----------INTEGER
INTEGER
VARCHAR(215)
VARCHAR(215)
VARCHAR(32)
BIGINT
BIGINT
VARCHAR(32)
VARCHAR(3)
INTEGER
VARCHAR(215)
VARCHAR(215)
INTEGER
INTEGER
INTEGER
VARCHAR(32)
VARCHAR(32)
VARCHAR(262)
REAL
VARCHAR(128)
INTEGER
REAL
VARCHAR(50)
VARCHAR(50)
VARCHAR(25)
371
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
OFF
OFF
OFF
OFF
OFF
ON
OFF
/home/userb
3
/home/userc/tmp $m
/home/userc/tmp/DIAG000
0
YES
SEARCH
ENABLE
0
512
256
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
NONE
AUTOMATIC
AUTOMATIC
AUTOMATIC
VARCHAR(3)
VARCHAR(3)
VARCHAR(3)
VARCHAR(3)
VARCHAR(3)
VARCHAR(3)
VARCHAR(3)
VARCHAR(215)
INTEGER
VARCHAR(215)
VARCHAR(215)
BIGINT
VARCHAR(3)
VARCHAR(8)
VARCHAR(8)
BIGINT
BIGINT
INTEGER
Table 90. Information returned by the DBMCFG administrative view
Column name
Data type
Description
NAME
VARCHAR(32)
name.
VALUE
VARCHAR(256)
The current value of the

stored in memory.
VALUE_FLAGS
VARCHAR(10)

parameter current value.
Valid values are:
information
v AUTOMATIC - the
DEFERRED_VALUE
VARCHAR(256)
The value of the

configuration parameter on
disk. For some database
manager configuration
parameters, the database
manager must be stopped
(db2stop) and restarted
(db2start) for this value to
take effect.
VARCHAR(10)

parameter deferred value.
Valid values are:
information
v AUTOMATIC - the
DATATYPE
372
VARCHAR(128)
data type.
DB2 pureScale instance information routines and views

In a DB2 pureScale environment, certain routines provide information about the
state of the DB2 pureScale instance and its members.
DB_MEMBERS table function

The DB_MEMBERS table function returns basic member information about a DB2
pureScale instance.
Syntax
DB_MEMBERS (
Authorization
v DBADM authority
v SQLADM authority


The function has no input parameters.
Example
Retrieve instance information:
$ db2 "select * from table(SYSPROC.DB_MEMBERS()) as members"

MEMBER_NUMBER
------------0
1
2
128
129
PORT_NUMBER
----------0
0
0
0
0
HOST_NAME
PARTITION_NUMBER MEMBER_TYPE
-------------------------------- ---------------- ----------member1.mycompany.com
0 D
member2.mycompany.com
0 D
member3.mycompany.com
0 D
ca1.mycompany.com
0 C
ca2.mycompany.com
0 C
SWITCH_NAME
------------
STATUS
------
373
Table 91. Information returned by the DB_MEMBERS table function
Column name
Data type
Description
MEMBER_NUMBER
SMALLINT

monitor element
HOST_NAME
VARCHAR(256)
host_name - Host name

monitor element
PARTITION_NUMBER
SMALLINT
partition_number - Partition
Number monitor element
MEMBER_TYPE
CHAR(1)
The type of member:

v C - a CF member
v D - a database member
PORT_NUMBER
SMALLINT
port_number - Port number
SWITCH_NAME
VARCHAR(128)
The switch name of the

member on the host
STATUS
SMALLINT
Reserved for future use
DB2_CLUSTER_HOST_STATE administrative view and

DB2_GET_CLUSTER_HOST_STATE table function - get
information about hosts
The DB2_CLUSTER_HOST_STATE administrative view and
DB2_GET_CLUSTER_HOST_STATE table function retrieve information about the
hosts that are part of a DB2 pureScale instance.
v DB2_CLUSTER_HOST_STATE administrative view
v DB2_GET_CLUSTER_HOST_STATE table function on page 375
DB2_CLUSTER_HOST_STATE administrative view

The DB2_CLUSTER_HOST_STATE administrative view returns the hosts that are
part of a DB2 pureScale instance. You can obtain a list of unique hosts plus their
associated state information for the instance.
Refer to the Information returned for DB2_CLUSTER_HOST_STATE administrative
view and DB2_GET_CLUSTER_HOST_STATE table for a complete list of
information that can be returned.
Authorization
v SELECT privilege on the DB2_CLUSTER_HOST_STATE administrative view
v CONTROL privilege on the DB2_CLUSTER_HOST_STATE administrative view
v DBADM authority
v SQLADM authority
374
Example
The following example uses the DB2_CLUSTER_HOST_STATE administrative view
to obtain information for a DB2 pureScale instance with four members and two
CFs.
SELECT * FROM SYSIBMADM.DB2_CLUSTER_HOST_STATE
The output from this query looks like this:

HOSTNAME
-------so1
so2
so3
so4
so5
so6
STATE
------------------------------ACTIVE
ACTIVE
ACTIVE
ACTIVE
ACTIVE
ACTIVE
INSTANCE_STOPPED
---------------NO
NO
NO
NO
NO
NO
ALERT
-------NO
NO
NO
NO
NO
NO
DB2_GET_CLUSTER_HOST_STATE table function

The DB2_GET_CLUSTER_HOST_STATE table function returns the same
information as the DB2_CLUSTER_HOST_STATE administrative view, but allows
you to specify a host name.
Refer to the Information returned for DB2_CLUSTER_HOST_STATE administrative
view and DB2_GET_CLUSTER_HOST_STATE table for a complete list of
Syntax
DB2_GET_CLUSTER_HOST_STATE (
hostname

hostname
hostname in short or long form, for which records will be returned. If the IP
address is provided instead, no records will be returned. If this parameter is
null or an empty string (''), all records are returned.
Authorization
v EXECUTE privilege on the DB2_GET_CLUSTER_HOST_STATE table function
v DBADM authority
v SQLADM authority
.

None
375
Example
The following example uses the DB2_GET_CLUSTER_HOST_STATE table function
to retrieve information about the host named so3 in a DB2 pureScale instance with
four members and two CFs.
SELECT * FROM TABLE(DB2_GET_CLUSTER_HOST_STATE(so3)) as T
The following is an example of the output from this query:

HOSTNAME STATE
INSTANCE_STOPPED ALERT
-------- ------------------------------- ---------------- -------so3
ACTIVE
NO
NO
Table 92. Information returned for DB2_CLUSTER_HOST_STATE administrative view and
DB2_GET_CLUSTER_HOST_STATE
Column name
Data type
Description
HOSTNAME
VARCHAR(255)
hostname - Host name monitor element
STATE
VARCHAR(32)
The hosts state information:

v ACTIVE - host is available for use by the DB2 database
manager
v INACTIVE - host is not available for use by the DB2
database manager
v NULL - host state is inapplicable (for example, it is in a
partitioned database environment)
INSTANCE_STOPPED
VARCHAR(8)
Whether the instance is stopped or not on the hosts:

v YES - instance is stopped on the host
v NO - instance is not stopped on the host
v NULL - inapplicable (for example, if in a partitioned
database environment)
ALERT
VARCHAR(8)
Information about alerts on the hosts:

v YES - there is an alert on the host
v NO - there is no alert on the host
v NULL - inapplicable (for example, if in a partitioned
database environment)
DB2_INSTANCE_ALERTS view - get information about alerts

The DB2_INSTANCE_ALERTS administrative view provides information about
alerts in the DB2 pureScale instance.
Authorization
The following authorizations is required:
v SELECT privilege on the DB2_INSTANCE_ALERTS administrative view

376
Example
The following example demonstrates the kind of information you can retrieve
using the DB2_INSTANCE_ALERTS administrative view.
SELECT * FROM SYSIBMADM.DB2_INSTANCE_ALERTS
The following is an example of output for this query. The columns have been
placed on separate rows for readability.
MESSAGE
------------------------------------------------------------------------------Restart light failed for member 0 on host(s) hostC. Check the db2diag.log for
messages concerning a restart light or database crash recovery failure on these
hosts for member 0. See the DB2 Information Center for more details.
ACTION
------------------------------------------------------------------------------This alert must be cleared manually with the command:
db2cluster -clear -alert -member 0
IMPACT
------------------------------------------------------------------------------Restart light will not succeed for member 0 on the hosts listed until this
alert has been cleared.
Table 93. Information returned by the DB2_INSTANCE_ALERTS administrative view
Description or Monitor
element
Column name
Data type
MESSAGE
VARCHAR(32672)
message - Control Table

Message monitor element
ACTION
VARCHAR(32672)
Action required to clear the

alert.
IMPACT
VARCHAR(32672)
The impact to the DB2

pureScale instance if the alert
is not cleared.
DB2_MEMBER and DB2_CF administrative views and

The DB2_MEMBER and DB2_CF administrative views and
DB2_GET_INSTANCE_INFO table function return information about the members
and CFs of a DB2 pureScale instance, including state information, where
applicable.
v DB2_MEMBER and DB2_CF administrative views
v DB2_GET_INSTANCE_INFO table function on page 379
DB2_MEMBER and DB2_CF administrative views

The DB2_MEMBER administrative view returns such information as the machine
name on which a member is currently running, its state, whether any alerts are
present, and the name of the high speed interconnect for internal database
communications.
377
The DB2_CF administrative view returns similar information for cluster caching
facilities (also known as CFs).
Refer to the tables in Information returned on page 380 for a complete list of
Authorization
v SELECT privilege on the administrative view
v CONTROL privilege on the administrative view
v DBADM authority
v SQLADM authority
Examples
The following example uses the DB2_MEMBER administrative view to display the
status of all members in the DB2 instance. This is appropriate for the following
kinds of instance:
v A DB2 pureScale instance
v A partitioned or non-partitioned database instance using the DB2 High
Availability Disaster Recovery (HADR) feature.
Execute the following query to display the status of all members in the DB2
instance:
SELECT * FROM SYSIBMADM.DB2_MEMBER

ID
-----0
2
4
HOME_HOST
--------so1
so2
so3
CURRENT_HOST
-----------so1
so2
so3
STATE
---------STARTED
STARTED
STARTED
ALERT
----NO
NO
NO
The following example uses the DB2_CF administrative view to display the status
of all CFs in the DB2 instance. This is appropriate for a DB2 pureScale instance,
only.
Execute the following query to display the status of all cluster caching facilities in
the DB2 instance:
SELECT * FROM SYSIBMADM.DB2_CF

ID
-----128
129
CURRENT_HOST
-----------so5
so6
STATE
---------PRIMARY
PEER
378
ALERT
----NO
NO

The DB2_GET_INSTANCE_INFO table function returns the same information as
the DB2_MEMBER and DB2_CF administrative views, but enables you to filter the
information returned by passing input parameters, such as the current host. The
current host is the host where the member is currently running.
Syntax
DB2_GET_INSTANCE_INFO (
id ,
home_host ,
current_host ,
type ,
db_partition_num )

id An optional input argument of type INTEGER that specifies a valid member or
cluster caching facility identifier. Entries are returned for all database members
or cluster caching facilities that match the input. If this parameter is null or -2
all records are returned. If this parameter is -1, information for the currently
connected member is returned.
home_host
An optional input argument of type VARCHAR(255) that specifies the home
host for which records are to be returned. The home host is the original host
name associated with a particular member when the member was created. Use
the short format of the host name and not an IP address for the home_host
argument. If this parameter is null or an empty string, all records are returned.
current_host
An optional input argument of type VARCHAR(255) that specifies the current
host for which records are to be returned. The current host is the host where
the member is currently running, which might not be the same as the home
host, if, for example, the member had to be started on another host as part of a
restart light operation. Use the short format of the host name and not an IP
address for the current_host argument.
type
An optional input argument of type VARCHAR(32) that specifies whether to
retrieve information for members or cluster caching facilities. The possible
values are:
v CF - Returns all records for the cluster caching facilities in the current DB2
pureScale instance
v MEMBER - Returns all records for the members in the current DB2 instance.
If this parameter is null or an empty string, all records returned.
db_partition_num
An optional input argument of type INTEGER that specifies a valid database
partition number. Information is returned for all database partition numbers
that match the input. If this parameter is null or -2, all records are returned. If
this parameter is -1, information for the currently connected member is
returned. For a DB2 pureScale instance, the only valid inputs are 0 or null; all
other input values will not return data.
Authorization
EXECUTE privilege on the DB2_GET_INSTANCE_INFO table function.
379

None
Examples
The following example uses the DB2_GET_INSTANCE_INFO table function to
retrieve information from a DB2 pureScale instance with four members and two
cluster caching facilities. In this example, member number 2 is being restarted on
the host called so1:
SELECT * FROM TABLE(DB2_GET_INSTANCE_INFO(null,,,,null)) as T

ID
--0
1
2
3
128
129
HOME_HOST
--------so1
so2
so3
so4
so5
so6
CURRENT_HOST
-----------so1
so1
so3
so4
so5
so6
TYPE
-----MEMBER
MEMBER
MEMBER
MEMBER
CF
CF
STATE
---------STARTED
RESTARTING
STARTED
STARTED
PRIMARY
PEER
ALERT DB_P..._NUM LOGICAL_PORT NETNAME

----- ----------- ------------ ------NO
0
0 so1-ib0
NO
0
0 so2-ib0
NO
0
0 so3-ib0
NO
0
0 so4-ib0
NO
0 so5-ib0
NO
0 so6-ib0
The following example uses the DB2_GET_INSTANCE_INFO table function to

retrieve information from a partitioned database instance with four members using
the DB2 High Availability Disaster Recovery (HADR) feature:
SELECT * FROM TABLE(DB2_GET_INSTANCE_INFO(null,,,,null)) as T

ID
-0
2
4
7
HOME_HOST CURRENT_HOST TYPE

--------- ------------ -----so1
so1
MEMBER
so2
so2
MEMBER
so3
so3
MEMBER
so4
so4
MEMBER
STATE
------STARTED
STARTED
STARTED
STARTED
ALERT DB_PARTITION_NUM LOGICAL_PORT NETNAME

----- ---------------- ------------ ----NO
0
0 so1-ib0
NO
2
0 so2-ib0
NO
4
0 so3-ib0
NO
7
0 so4-ib0
Table 94. Information returned for DB2_MEMBER administrative view
Column name
Data type
Description
ID
SMALLINT
id - cluster caching facility identification monitor element
HOME_HOST
VARCHAR(255)
The machine which was associated with the member

when it was first added to the instance.
CURRENT_HOST
VARCHAR(255)
The machine name on which the member is currently

running.
380
Table 94. Information returned for DB2_MEMBER administrative view (continued)

Column name
Data type
Description
STATE
VARCHAR(32)
The state of the member or cluster caching facility.

The potential states for a member are STARTED,
STOPPED, RESTARTING, WAITING_FOR_FAILBACK,
ERROR, and UNKNOWN.
The potential states for a cluster caching facility include
STOPPED, RESTARTING, BECOMING_PRIMARY,
PRIMARY, CATCHUP1, PEER, ERROR, and UNKNOWN.
The NULL state for a member or a cluster caching facility
indicates that state is inapplicable. For example, if in a
partitioned database environment.
See Values for member and cluster caching facility states
and alerts for more information.
ALERT
VARCHAR(8)
Information about alerts on the instance:

v YES - there is an alert
v NO - there are no alerts
v The NULL state for a member or a cluster caching
facility indicates that state is inapplicable. For example,
if in a partitioned database environment.
Use the DB2_INSTANCE_ALERTS administrative view to
obtain more information about an alert.
Table 95. Information returned for DB2_CF administrative view

Column name
Data type
Description
ID
SMALLINT
CURRENT_HOST
VARCHAR(255)

running.
STATE
VARCHAR(32)

ERROR, and UNKNOWN.
381
Table 95. Information returned for DB2_CF administrative view (continued)

Column name
Data type
Description
ALERT
VARCHAR(8)

Table 96. Information returned for DB2_GET_INSTANCE_INFO table function

Column name
Data type
Description
ID
SMALLINT
HOME_HOST
VARCHAR(255)
The machine which was associated with the member

when it was first added to the instance.
CURRENT_HOST
VARCHAR(255)

running.
TYPE
VARCHAR(32)
Either 'MEMBER' or 'CF'.
STATE
VARCHAR(32)

ERROR, and UNKNOWN.
ALERT
VARCHAR(8)

DB_PARTITION_NUM
SMALLINT
The database partition number for this member.
LOGICAL_PORT
SMALLINT
The logical port number of the member or cluster caching

facility.
NETNAME
VARCHAR(255)
The name of the high speed interconnect for internal

database communications.
Note:
382
1. CATCHUP includes a percentage value as part of the returned state. This

percentage value represents the amount to which the secondary cluster caching
facility has caught up to the current state of the primary caching facility.
Environment routines and views

ENV_CF_SYS_RESOURCES administrative view - Get cluster
caching facility system resource information
The ENV_CF_SYS_RESOURCES administrative view returns a list of system
resources used by the cluster caching facilities (also known as CFs) on the system.
Authorization
v SELECT privilege on the view
v CONTROL privilege on the view

Examples
The following example demonstrates the information you can obtain using the
ENV_CF_SYS_RESOURCES administrative view.
SELECT * FROM SYSIBMADM.ENV_CF_SYS_RESOURCES
Table 97. Information returned by the ENV_CF_SYS_RESOURCES administrative view
Column name
Data type
Description
NAME
VARCHAR(128)
Name of the system resource, see following table for

possible values.
VALUE
VARCHAR(1024)
The value of the system resource.
DATATYPE
VARCHAR(128)
The data type of the value, see following table for

possible values.
UNIT
VARCHAR(128)
The unit represented by the value, if applicable; null

otherwise.
ID
SMALLINT
Table 98. Possible values for the NAME and DATATYPE columns
Information type
Name
Data Types
Description
Operating system
HOST_NAME
VARCHAR(256)
Name of the host the

cluster caching facility is
running on.
383
Table 98. Possible values for the NAME and DATATYPE columns (continued)
Information type
Name
Data Types
Description
Physical memory
MEMORY_TOTAL
BIGINT
Total size of physical

memory.
MEMORY_FREE
BIGINT
Amount of free physical

memory.
MEMORY_SWAP_TOTAL
BIGINT
Total amount of swap

space.
MEMORY_SWAP_FREE
BIGINT
Amount of free swap

space.
VIRTUAL_MEM_TOTAL
BIGINT
Total amount of virtual

memory on the system.
VIRTUAL_MEM_RESERVED
BIGINT
Amount of reserved
virtual memory.
CPU_USAGE_TOTAL
DECIMAL
Percentage of overall CPU

usage of the machine.
Virtual memory
CPU load
ENV_FEATURE_INFO administrative view - Return license

information for DB2 features
The ENV_FEATURE_INFO administrative view returns information about all
available features for which a license is required. For each feature, there is
information about whether or not a valid license for the feature has been installed.
Authorization
v SELECT privilege on the ENV_FEATURE_INFO administrative view
v CONTROL privilege on the ENV_FEATURE_INFO administrative view
v DBADM authority
v SQLADM authority

Example
Request the installed DB2 features license information.
SELECT * FROM SYSIBMADM.ENV_FEATURE_INFO

FEATURE_NAME
-----------DPF
POESE
SO
AAC
HFESE
XMLESE
384
FEATURE_FULLNAME
...
-------------------------------------------- ...
DB2_DATABASE_PARTITIONING_FEATURE
...
DB2_PERFORMANCE_OPTIMIZATION_FEATURE_FOR_ESE ...
DB2_STORAGE_OPTIMIZATION_FEATURE
...
DB2_ADVANCED_ACCESS_CONTROL_FEATURE
...
IBM_HOMOGENEOUS_FEDERATION_FEATURE_FOR_ESE
...
DB2_PUREXML_FEATURE_FOR_ESE
...
Output from this query (continued).

...
...
...
...
...
...
...
...
LICENSE_INSTALLED
----------------Y
Y
Y
Y
Y
N
PRODUCT_NAME
-----------ESE
ESE
ESE
ESE
ESE
ESE
FEATURE_USE_STATUS
-----------------IN_COMPLIANCE
IN_COMPLIANCE
IN_COMPLIANCE
NOT_USED
NOT_USED
IN_VIOLATION
ENV_FEATURE_INFO administrative view metadata

Table 99. ENV_FEATURE_INFO administrative view metadata
Column name
Data type
Description
FEATURE_NAME
VARCHAR(26)
Short names for DB2 features which are available

on licensed DB2 servers.
FEATURE_FULLNAME
VARCHAR(100)
Full name of DB2 features. Column values will be

displayed in English in uppercase. Words are
separated with an underscore character instead of a
space character.
LICENSE_INSTALLED
CHAR(1)
Indicates if feature is licensed. If the value is 'N', the

feature is not licensed. If the value is 'Y', the feature
is licensed.
PRODUCT_NAME
VARCHAR(26)
product_name - Product Name monitor element
FEATURE_USE_STATUS
VARCHAR(30)
Indicates the license compliance status. This value

indicates the usage status of the feature. There are
three possible values:
v IN_COMPLIANCE: Feature has been used at
least once and there is a valid license for the
feature.
v IN_VIOLATION: Feature has been used at least
once and there is no valid license for the feature.
v NOT_USED: Feature has not been used.
ENV_GET_DB2_EDU_SYSTEM_RESOURCES table function Return DB2 engine dispatchable units system information
The ENV_GET_DB2_EDU_SYSTEM_RESOURCES table function returns system
resource information metrics at the instance level for all DB2 engine dispatchable
units (EDUs).
Authorization
v SQLADM authority
v DBADM authority

None
385
Syntax
ENV_GET_DB2_EDU_SYSTEM_RESOURCES (
member
Routine parameters
member
An input parameter of type INTEGER that specifies a valid database member
from which the records are to be fetched. Specify -1 or NULL for the current
member, or -2 for information from all active database members. An active
database member is a database that is available for connection and use by
applications. The default value is NULL.
Table 100. Information returned by the ENV_GET_DB2_EDU_SYSTEM_RESOURCES
routine
Column name
Data type
Description
MEMBER
SMALLINT

monitor element
EDU_ID
BIGINT
edu_ID - Engine dispatchable

unit ID monitor element
EDU_NAME
VARCHAR(128)
edu_name - Engine
dispatchable unit name
monitor element
DB2_PROCESS_ID
BIGINT
db2_process_id - DB2 process

ID monitor element
TID
BIGINT
agent_id - Application
handle (agent ID) monitor
element
KTID
BIGINT
ktid - Kernel thread ID

monitor element
CPU_USER_TIME_MS
BIGINT
CPU user processing time in

microseconds.
CPU_SYSTEM_TIME_MS
BIGINT
CPU system processing time

in microseconds.
RESOURCE_METHOD
VARCHAR(8)
Resource policy method in

use for this EDU.
RESOURCE_BINDING
VARCHAR(20)
Resource policy binding in

use for this EDU.
Examples
1. List the EDU_NAME and DB2_PROCESS_ID on all members.
SELECT EDU_NAME, DB2_PROCESS_ID
FROM TABLE (ENV_GET_DB2_EDU_SYSTEM_RESOURCES(-2))
This query returns the following output:

EDU_NAME
DB2_PROCESS_ID
----------------------------------- -------------------db2agntdp (TEST)
4615
386
db2agntdp (TEST)
db2agent (TEST)
db2evmli (DB2DETAILDEADLOCK)
db2pcsd (TEST)
db2fw3 (TEST)
db2fw2 (TEST)
db2fw1 (TEST)
db2fw0 (TEST)
db2lused (TEST)
db2wlmd (TEST)
db2taskd (TEST)
db2pfchr (TEST)
db2pfchr (TEST)
db2pfchr (TEST)
db2pclnr (TEST)
db2pclnr (TEST)
db2pclnr (TEST)
db2pclnr (TEST)
db2lfr.0 (TEST)
db2loggw (TEST)
db2loggr (TEST)
db2dlock (TEST)
db2agent (TEST)
db2stmm (TEST)
db2resync
db2ipccm
db2wlmtm
db2wlmt
db2licc
db2thcln
db2alarm
db2sysc
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
4615
2. List TID, RESOURCE_METHOD, and CPU_USER_TIME_MS on all members.

SELECT TID, RESOURCE_METHOD, CPU_USER_TIME_MS
FROM TABLE (ENV_GET_DB2_EDU_SYSTEM_RESOURCES(-2))

TID
-------------------46913046964544
46913063741760
46913025993024
46913042770240
46913030187328
46913114073408
46913059547456
46913038575936
46913055353152
46913067936064
46913072130368
46913051158848
46913080518976
46913076324672
46913084713280
46913097296192
46913101490496
46913088907584
46913109879104
46913105684800
46913093101888
46913118267712
46913122462016
46913034381632
RESOURCE_METHOD
---------------
CPU_USER_TIME_MS
---------------6970000
14950000
1260000
0
0
0
0
0
0
60000
0
0
0
20000
20000
0
0
0
0
0
60000
70000
0
4070000
387
46913126656320
46913130850624
46913135044928
46913139239232
46913143433536
46913147627840
46913151822144
46913156016448
46912895969600
7000000
320000
50000
0
0
0
0
0
7660000
ENV_GET_DB2_SYSTEM_RESOURCES table function - Return

DB2 system information
The ENV_GET_DB2_SYSTEM_RESOURCES table function returns CPU usage and
DB2 process information for specified members in the current instance.
Syntax
ENV_GET_DB2_SYSTEM_RESOURCES (
member

member
Authorization
v EXECUTE privilege on the table function
v DBADM authority
v SQLADM authority

None
Example
SELECT VARCHAR(db2_process_name, 20) AS NAME, CPU_USER, CPU_SYSTEM
FROM TABLE(ENV_GET_DB2_SYSTEM_RESOURCES(-2))

NAME
CPU_USER CPU_SYSTEM
------------------------------ -------- ---------db2fmp
14
9
db2sysc
11752
541
db2syscr
13
8
db2fmp
24
14
388
Table 101. Information returned by the ENV_GET_DB2_SYSTEM_RESOURCES table
function
Column name
Data type
Description
MEMBER
SMALLINT

monitor element
DB2_PROCESS_NAME
VARCHAR(128)
db2_process_name - DB2
process name monitor
element
DB2_PROCESS_ID
BIGINT
db2_process_id - DB2 process

ID monitor element
CPU_USER
BIGINT
cpu_user - Non-kernel
processing time monitor
element
CPU_SYSTEM
BIGINT
cpu_system - Kernel time

monitor element
ENV_GET_NETWORK_RESOURCES table function - Return

network information
The ENV_GET_NETWORK_RESOURCES table function returns information for all
active network adaptors on the host machines running DB2.
Authorization
v DBADM authority
v SQLADM authority

None
Example
SELECT varchar(adapter_name, 20) as name,
packets_received,
packets_sent,
total_bytes_received,
total_bytes_sent
FROM TABLE(ENV_GET_NETWORK_RESOURCES())
The query returns the following input:

NAME
PACKETS_RECEIVED PACKETS_SENT TOTAL_BYTES_RECEIVED
-------------------------------- ---------------- ------------ -------------------lo
467182039
467182039
528451011980
eth0
426287355
431398744
351656704796
eth1
0
0
0
TOTAL_BYTES_SENT
389
---------------528451011980
272061746005
0
Table 102. Information returned by the ENV_GET_NETWORK_RESOURCES table function
Column name
Data type
Description
MEMBER
SMALLINT

monitor element
HOST_NAME
VARCHAR(255)

monitor element
ADAPTER_NAME
VARCHAR(255)
adapter_name - Adapter
name monitor element
PACKETS_RECEIVED
BIGINT
packets_received - Packets
received monitor element
PACKETS_SENT
BIGINT
packets_sent - Packets sent

monitor element
PACKET_RECEIVE_ERRORS BIGINT
packet_receive_errors Packet receive errors monitor

element
PACKET_SEND_ERRORS
BIGINT
packet_send_errors - Packet
send errors monitor element
TOTAL_BYTES_RECEIVED
BIGINT
total_bytes_received - Total
bytes received monitor
element
TOTAL_BYTES_SENT
BIGINT
total_bytes_sent - Total bytes

sent monitor element
ENV_GET_REG_VARIABLES table function - Retrieve DB2

registry settings in use
The ENV_GET_REG_VARIABLES table function returns the DB2 registry settings
from one or all database members.
Note: The ENV_GET_REG_VARIABLES table function replaces the deprecated
REG_VARIABLES administrative view. The ENV_GET_REG_VARIABLESfunction
is different in that it allows for a single parameter value to denote a specific
member to query, and returns an addition result for the registry setting currently
stored on disk.
Authorization
v EXECUTE privilege on the ENV_GET_REG_VARIABLES table function
v DBADM authority
v SQLADM authority
In addition, one of the following privileges or authorities is also required:
v EXECUTE privilege on the ENV_GET_REG_VARIABLES table function
390

None
Syntax
ENV_GET_REG_VARIABLES (
member
showall

member
showall
An input argument of type SMALLINT that specifies if information on all
registry variables is returned. Specify 0 to show only those registry variables
currently set, or 1 to show all registry variables. If the null value is specified, 0
is set implicitly. The default value is NULL.
Table 103. Information returned by the ENV_GET_REG_VARIABLES table function
Column name
Data type
Description
MEMBER
SMALLINT

monitor element
REG_VAR_NAME
VARCHAR(256)
Name of the DB2 registry

variable.
REG_VAR_VALUE
VARCHAR(2048)
Current setting of the DB2

registry variable in memory.
REG_VAR_ON_
DISK_VALUE
VARCHAR(2048)

registry variable on disk.
IS_AGGREGATE
SMALLINT
Indicates whether or not the

DB2 registry variable is an
aggregate variable. The
possible return values are 0
if it is not an aggregate
variable, and 1 if it is an
aggregate variable.
AGGREGATE_NAME
VARCHAR(256)
Name of the aggregate if the

DB2 registry variable is
currently obtaining its value
from a configured aggregate.
If the registry variable is not
being set through an
aggregate, or is set through
an aggregate but has been
overridden, the value of
AGGREGATE_NAME is
NULL.
391
Table 103. Information returned by the ENV_GET_REG_VARIABLES table

Column name
Data type
Description
LEVEL
CHAR(1)
Indicates the level at which

the DB2 registry variable
acquires its value. The
possible return values and
the corresponding levels that
they represent are:
v I = instance
v G = global
v N = database partition
v E = environment
REG_VAR_
DEFAULT_VALUE
VARCHAR(2048)
Default value for the registry

variable.
Examples
v Show all DB2 registry settings (including registry variables that are not set) for
all database members:
select MEMBER, REG_VAR_NAME,
REG_VAR_VALUE, REG_VAR_ON_DISK_VALUE
from table(ENV_GET_REG_VARIABLES(-2, 1)
v In this example, the registry variable DB2DBDFT, which specifies the database
alias name to use for implicit connections, is set to CORP_1. This is done before
the DB2 instance starts:
db2set db2dbdft=CORP_1
db2start
Then you can issue a query to show that registry variable setting:
select substr(reg_var_value,1,20) as VALUE,
substr(reg_var_on_disk_value,1,20) as ON_DISK_VALUE
from table(env_get_reg_variables(-1))
where reg_var_name = DB2DBDFT

VALUE
ON_DISK_VALUE
-------------------- -------------------CORP_1
CORP_1
To demonstrate the difference between in memory and on disk values for the
registry settings, the DB2DBDFT registry variable is then altered:
db2set db2dbdft=DEPT_MAJOR
Running the same query as the previous one, shows that this new value is
immediately picked up by the ENV_GET_REG_VARIABLES function:
VALUE
ON_DISK_VALUE
-------------------- -------------------CORP_1
DEPT_MAJOR
However, note that the in memory value will not change to the new value until
the DB2 instance is restarted.
392
ENV_GET_INSTANCE_CODE_LEVELS table function - Return

architectural level
The ENV_GET_INSTANCE_CODE_LEVELS table function returns the code level
for the instance, members, and cluster facilitators.
Authorization
v DBADM authority
v SQLADM authority

routine is automatically created.
Syntax
ENV_GET_INSTANCE_CODE_LEVELS (
Table 104. Information returned by the ENV_GET_INSTANCE_CODE_LEVELS routine
Column name
Data type
Description
RECORD_TYPE
VARCHAR(10)
The record type, which

specifies if rolling updates
information is specific to an
instance, cluster facilitator, or
member.
ID
SMALLINT
Host as represented in
db2nodes.cfg (0 for the
INSTANCE level record).
ARCHITECTURE_
LEVEL_DISK
VARCHAR(50)
Architecture level value

stored on disk.
ARCHITECTURE_
LEVEL_MEMORY
VARCHAR(50)
Architecture level value

stored in memory.
SECTION_LEVEL_DISK
VARCHAR(50)
Section level stored on disk.
SECTION_LEVEL_MEMORY VARCHAR(50)
Section level stored in

memory.
CODE_LEVEL_DISK
VARCHAR(50)
Code level stored on disk.
CODE_LEVEL_MEMORY
VARCHAR(50)
Code level stored in memory.
STATE
VARCHAR(60)
Rolling Updates state:

v NONE
v NOT COMPUTED
v OFFLINE UPDATE
INITIATED
393
Table 104. Information returned by the ENV_GET_INSTANCE_CODE_LEVELS

routine (continued)
Column name
Data type
Description
LAST_UPDATED
TIMESTAMP
Timestamp indicating when

this member was last
updated.
ARCHITECTURE_LEVEL_
DISK_PACKED
VARCHAR(8) FOR BIT

DATA
Packed format of the

architecture level stored on
disk.
ARCHITECTURE_LEVEL_
MEMORY_PACKED
VARCHAR(8) FOR BIT

DATA
Packed format of the

architecture level stored in
memory.
SECTION_LEVEL_
DISK_PACKED
VARCHAR(8) FOR BIT

DATA
Packed format of the section

level stored on disk.
SECTION_LEVEL_
MEMORY_PACKED
VARCHAR(8) FOR BIT

DATA
Packed format of the section

level stored in memory.
CODE_LEVEL_
DISK_PACKED
VARCHAR(8) FOR BIT

DATA
Packed format of the code

level stored on disk.
CODE_LEVEL_
MEMORY_PACKED
VARCHAR(8) FOR BIT

DATA
Packed format of the code

level stored in memory.
Example
Simulation of an online rolling update from Version 10.5 Fix Pack 1 to Fix Pack 2
for an instance named "INST1". It is assumed that Fix Pack 2 introduced a new
architecture level but the section level remained unchanged since Version 10.5.
1. The instance starts in a homogeneous state. All members are identical.
SELECT RECORD_TYPE, ID, SUBSTR(ARCHITECTURE_LEVEL_DISK,1,28)
AS ARCHITECTURE_LEVEL, SUBSTR(SECTION_LEVEL_DISK,1,26)
AS SECTION_LEVEL, SUBSTR(CODE_LEVEL_DISK,1, 28)
AS CODE_LEVEL, LAST_UPDATED
FROM TABLE (SYSPROC.ENV_GET_INSTANCE_CODE_LEVELS())

RECORD_TYPE ID
ARCHITECTURE_LEVEL
----------- ------ ---------------------------INSTANCE
- V:10 R:5 M:0 F:1 I:0 SB:0
MEMBER
0 V:10 R:5 M:0 F:1 I:0 SB:0
MEMBER
1 V:10 R:5 M:0 F:1 I:0 SB:0
MEMBER
2 V:10 R:5 M:0 F:1 I:0 SB:0
CF
128 V:10 R:5 M:0 F:1 I:0 SB:0
CF
129 V:10 R:5 M:0 F:1 I:0 SB:0
SECTION_LEVEL
-------------------------V:10 R:5 M:0 F:0 I:0 SB:0
V:10 R:5 M:0 F:0 1:0 SB:0
V:10 R:5 M:0 F:0 I:0 SB:0
-
Query output (continued):

...CODE_LEVEL
LAST_UPDATED
...----------------------------- -------------------------...V:10 R:5 M:0 F:1 I:0 SB:0
2012-10-06-19.12.00.000000
...V:10 R:5 M:0 F:1 I:0 SB:0
2012-10-06-19.12.00.000000
...V:10 R:5 M:0 F:1 I:0 SB:0
2012-10-06-19.12.00.000000
...V:10 R:5 M:0 F:1 I:0 SB:0
2012-10-06-19.12.00.000000
...V:10 R:5 M:0 F:1 I:0 SB:0
2012-10-06-19.12.00.000000
...V:10 R:5 M:0 F:1 I:0 SB:0
2012-10-06-19.12.00.000000
394
...
...
...
...
...
...
...
...
2. The user updates two cluster facilitators using the following command on both
cluster facilitators:
./installFixpack -p FP2_install_path INST1
Query output:
RECORD_TYPE ID
ARCHITECTURE_LEVEL
----------- ------ ---------------------------INSTANCE
- V:10 R:5 M:0 F:1 I:0 SB:0
MEMBER
0 V:10 R:5 M:0 F:1 I:0 SB:0
MEMBER
1 V:10 R:5 M:0 F:1 I:0 SB:0
MEMBER
2 V:10 R:5 M:0 F:1 I:0 SB:0
CF
128 V:10 R:5 M:0 F:2 I:0 SB:0
CF
129 V:10 R:5 M:0 F:2 I:0 SB:0
SECTION_LEVEL
--------------------------V:10 R:5 M:0 F:0 I:0 SB:0
V:10 R:5 M:0 F:0 I:0 SB:0
V:10 R:5 M:0 F:0 I:0 SB:0
-
...
...
...
...
...
...
...
...

...
...
...
...
...
...
...
...
CODE_LEVEL
--------------------------V:10 R:5 M:0 F:1 I:0 SB:0
V:10 R:5 M:0 F:1 I:0 SB:0
V:10 R:5 M:0 F:1 I:0 SB:0
V:10 R:5 M:0 F:1 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
LAST_UPDATED
-------------2012-10-06-19.12.00.000000
2012-10-06-19.12.00.000000
2012-10-06-19.12.00.000000
2012-10-06-19.12.00.000000
2012-10-06-19.23.44.000000
2012-10-06-19.22.49.000000
3. The three members are subsequently moved to Fix Pack 2 using the same
installFixpack command:
./installFixpack -p FP2_install_path INST1
Query output:
RECORD_TYPE ID
ARCHITECTURE_LEVEL
----------- ------ ---------------------------INSTANCE
- V:10 R:5 M:0 F:1 I:0 SB:0
MEMBER
0 V:10 R:5 M:0 F:2 I:0 SB:0
MEMBER
1 V:10 R:5 M:0 F:2 I:0 SB:0
MEMBER
2 V:10 R:5 M:0 F:2 I:0 SB:0
CF
128 V:10 R:5 M:0 F:2 I:0 SB:0
CF
129 V:10 R:5 M:0 F:2 I:0 SB:0
SECTION_LEVEL
--------------------------V:10 R:5 M:0 F:0 I:0 SB:0
V:10 R:5 M:0 F:0 I:0 SB:0
V:10 R:5 M:0 F:0 I:0 SB:0
-
...
...
...
...
...
...
...
...

...
...
...
...
...
...
...
...
CODE_LEVEL
--------------------------V:10 R:5 M:0 F:1 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
LAST_UPDATED
-------------2012-10-06-19.12.00.000000
2012-10-06-19.29.39.000000
2012-10-06-19.30.34.000000
2012-10-06-19.31.25.000000
2012-10-06-19.23.44.000000
2012-10-06-19.22.49.000000
4. The cluster is then committed at the new level of code, using the following
command:
./installFixpack -commit_new_level
Query output:
RECORD_TYPE ID
----------- -----INSTANCE
MEMBER
0
MEMBER
1
ARCHITECTURE_LEVEL
---------------------------V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
SECTION_LEVEL
--------------------------V:10 R:5 M:0 F:0 I:0 SB:0
V:10 R:5 M:0 F:0 I:0 SB:0
...
...
...
...
...
395
MEMBER
CF
CF
2 V:10 R:5 M:0 F:2 I:0 SB:0

128 V:10 R:5 M:0 F:2 I:0 SB:0
129 V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:0 I:0 SB:0

-
...
...
...

...
...
...
...
...
...
...
...
CODE_LEVEL
--------------------------V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
V:10 R:5 M:0 F:2 I:0 SB:0
LAST_UPDATED
-------------2012-10-06-19.36.40.000000
2012-10-06-19.29.39.000000
2012-10-06-19.30.34.000000
2012-10-06-19.31.25.000000
2012-10-06-19.23.44.000000
2012-10-06-19.22.49.000000
ENV_GET_SYSTEM_RESOURCES table function - Return system

information
The ENV_GET_SYSTEM_RESOURCES table function returns operating system,
CPU, memory, and other information that is related to members on the system.
The active database can reside on one or more members on the system. This table
function returns data only from members where the database that issued the
command is active.
Note: The ENV_GET_SYSTEM_RESOURCES table function replaces the
ENV_GET_SYS_RESOURCES table function and the associated
ENV_SYS_RESOURCES administrative view.
The ENV_GET_SYSTEM_RESOURCES table function returns all data in one row
with multiple columns for each member, instead of multiple rows for each
member. Additionally, data that the ENV_GET_SYS_RESOURCES table function
returns for the DBPARTITIONNUM column is returned in the MEMBER column
by the ENV_GET_SYSTEM_RESOURCES table function.
Authorization
v DBADM authority
v SQLADM authority

None
Usage notes
v In a virtualized environment (such as VMWare ESX) DB2 may be unable to
determine the CPU topology such as CPU_HMT_DEGREE or
CPU_CORES_PER_SOCKET. This occurs because of limited information that the
hypervisor makes available to the virtualized operating system. In such cases,
CPU_CORES_PER_SOCKET and CPU_HMT_DEGREE will have a value of 1.
396
Table 105. Information returned for ENV_GET_SYSTEM_RESOURCES
Column name
Data type
Description
MEMBER
SMALLINT
OS_NAME
VARCHAR(256)
os_name - Operating system name monitor element
HOST_NAME
VARCHAR(255)
host_name - Host name monitor element
OS_VERSION
VARCHAR(256)
os_version - Operating system version monitor element
OS_RELEASE
VARCHAR(256)
os_release - Operating system release monitor element
MACHINE_IDENTIFICATION
VARCHAR(256)
machine_identification - Host hardware identification

monitor element
OS_LEVEL
VARCHAR(256)
os_level - Operating system level monitor element
CPU_TOTAL
BIGINT
cpu_total - Number of CPUs monitor element
CPU_ONLINE
BIGINT
cpu_online - Number of CPUs online monitor element
CPU_CONFIGURED
BIGINT
cpu_configured - Number of configured CPUs monitor

element
CPU_SPEED
BIGINT
cpu_speed - CPU clock speed monitor element
CPU_TIMEBASE
BIGINT
cpu_timebase - Frequency of timebase register increment

monitor element
CPU_HMT_DEGREE
BIGINT
cpu_hmt_degree - Number of logical CPUs monitor

element
CPU_CORES_PER_SOCKET
BIGINT
cpu_cores_per_socket - Number of CPU cores per socket

monitor element
MEMORY_TOTAL
BIGINT
memory_total - Total physical memory monitor element
MEMORY_FREE
BIGINT
memory_free - Amount of free physical memory monitor

element
MEMORY_SWAP_TOTAL
BIGINT
memory_swap_total - Total swap space monitor element
MEMORY_SWAP_FREE
BIGINT
memory_swap_free - Total free swap space monitor

element
VIRTUAL_MEM_TOTAL
BIGINT
virtual_mem_total - Total virtual memory monitor

element
BIGINT
virtual_mem_reserved - Reserved virtual memory monitor

element
VIRTUAL_MEM_FREE
BIGINT
virtual_mem_free - Free virtual memory monitor element
CPU_LOAD_SHORT
DOUBLE
cpu_load_short - Processor load (short timeframe)

monitor element
CPU_LOAD_MEDIUM
DOUBLE
cpu_load_medium - Processor load (medium timeframe)

monitor element
CPU_LOAD_LONG
DOUBLE
cpu_load_long - Processor load (long timeframe) monitor

element
CPU_USAGE_TOTAL
SMALLINT
cpu_usage_total - Processor usage monitor element
BIGINT
cpu_user - Non-kernel processing time monitor element
CPU_USER
CPU_IDLE
CPU_IOWAIT
BIGINT
cpu_idle - Processor idle time monitor element
BIGINT
cpu_iowait - IO Wait time monitor element
BIGINT
cpu_system - Kernel time monitor element
BIGINT
swap_page_size - Swap page size monitor element
CPU_SYSTEM
SWAP_PAGE_SIZE
397
Table 105. Information returned for ENV_GET_SYSTEM_RESOURCES (continued)

Column name
Data type
Description
SWAP_PAGES_IN
BIGINT
swap_pages_in - Pages swapped in from disk monitor

element
SWAP_PAGES_OUT
BIGINT
swap_pages_out - Pages swapped out to disk monitor

element
OS_FULL_VERSION
VARCHAR(256)
os_full_version - Operating system full version monitor

element
OS_KERNEL_VERSION
VARCHAR(256)
os_kernel_version - Operating system kernel identifier

monitor element
OS_ARCH_TYPE
VARCHAR(256)
os_arch_type - Operating system architecture type

monitor element
Note:
1
These metrics have been aggregated across all logical processors on the system.
On the AIX operating system, the metrics are for the Workload partition (WPAR) and Logical partition
(LPAR) on which the DB2 server is running.
Examples
Example 1: Obtain operating system information for every member in a
three-member DB2 pureScale setup:
select MEMBER, varchar(HOST_NAME,12) as HOST_NAME, varchar(OS_NAME,8) as OS_NAME,
varchar(OS_VERSION,8) as OS_VERSION, varchar(OS_RELEASE,8)
as OS_RELEASE from table(SYSPROC.ENV_GET_SYSTEM_RESOURCES()) order by MEMBER
Sample output is as follows:

MEMBER
-----0
1
2
HOST_NAME
-----------hotel75
hotel78
hotel90
OS_NAME
-------Linux
Linux
Linux
OS_VERSION
---------2
2
2
OS_RELEASE
---------6
6
6
Example 2: Obtain memory information for the system hosting this database on a
DB2 Enterprise Server Edition system:
select varchar(HOST_NAME,12) as HOST_NAME, MEMORY_TOTAL, MEMORY_FREE,
MEMORY_SWAP_TOTAL, MEMORY_SWAP_FREE, VIRTUAL_MEM_TOTAL, VIRTUAL_MEM_FREE
from table(SYSPROC.ENV_GET_SYSTEM_RESOURCES())
Sample output is as follows. Because of space constraints, the output is continued

on a second line.
HOST_NAME
MEMORY_TOTAL
MEMORY_FREE
MEMORY_SWAP_TOTAL
...
------------ -------------------- -------------------- -------------------- ...
hotel75
32189
4370
8198 ...
... MEMORY_SWAP_FREE
VIRTUAL_MEM_TOTAL
VIRTUAL_MEM_FREE
... -------------------- -------------------- -------------------...
7316
40387
11686
Example 3: Find the load times for all the systems hosting the database, in a four
member partitioned database environment.
398
select MEMBER, varchar(HOST_NAME,12) as HOST_NAME,

CPU_LOAD_SHORT, CPU_LOAD_MEDIUM, CPU_LOAD_LONG
from table(SYSPROC.ENV_GET_SYSTEM_RESOURCES()) order by MEMBER

MEMBER
-----0
1
2
3
HOST_NAME
--------hotel75
hotel78
hotel90
hotel32
CPU_LOAD_SHORT
----------------------+5.21000000000000E+000
+1.33000000000000E+000
+9.02000000000000E+000
+1.09000000000000E+000
CPU_LOAD_MEDIUM
CPU_LOAD_LONG
---------------------- -----------------------+5.08000000000000E+000 +4.67000000000000E+000
+2.18000000000000E+000 +3.66000000000000E+000
+9.08000000000000E+000 +9.47000000000000E+000
+1.38000000000000E+000 +1.27000000000000E+000
Example 4:
select MEMBER, varchar(HOST_NAME,12) as HOST_NAME, CPU_TOTAL,
MEMORY_TOTAL, CPU_LOAD_SHORT
from table(SYSPROC.ENV_GET_SYSTEM_RESOURCES())
order by MEMBER

MEMBER
----0
1
2
3
HOST_NAME
-------------coralpib23
coralpib23
coralpib23
coralpib23
CPU_TOTAL
--------24
24
24
24
MEMORY_TOTAL
CPU_LOAD_SHORT
------------ ----------------------81920 +1.23696899414062E+000
81920 +1.23696899414062E+000
81920 +1.23696899414062E+000
81920 +1.23696899414062E+000
ENV_INST_INFO administrative view - Retrieve information about

the current instance
The ENV_INST_INFO administrative view returns information about the current
instance.
Authorization
v SELECT privilege on the ENV_INST_INFO administrative view
v CONTROL privilege on the ENV_INST_INFO administrative view
v DBADM authority
v SQLADM authority

Example
Request information about the current instance.
SELECT * FROM SYSIBMADM.ENV_INST_INFO
399
INST_NAME
IS_INST_PARTITIONABLE NUM_DBPARTITIONS INST_PTR_SIZE ...
-----------...---- --------------------- ---------------- ------------- ...
DB2
0
1
32 ...

... RELEASE_NUM
SERVICE_LEVEL
BLD_LEVEL
PTF
FIXPACK_NUM
... -----------...--- --------------...--- ----------...--- ----...--- ----------... 01010107
DB2 v9.1.0.115
n051106
0
Table 106. Information returned by the ENV_INST_INFO administrative view
Column name
Data type
Description
INST_NAME
VARCHAR(128)
Name of the current instance.
IS_INST_PARTITIONABLE
SMALLINT
Indicates whether or not the current

instance is a partitionable database
server instance. Possible return
values are 0 if it is not a partitionable
database server instance, and 1 if it is
a partitionable database server
instance.
NUM_DBPARTITIONS
INTEGER
Number of database partitions. If it is

not a partitioned database
environment, returns a value of 1.
INST_PTR_SIZE
INTEGER
Bit size of the current instance (32 or

64).
RELEASE_NUM
VARCHAR(128)
Internal release number, as returned

by the db2level command; for
example, 03030106.
SERVICE_LEVEL
VARCHAR(128)
service_level - Service Level monitor

element
BLD_LEVEL
VARCHAR(128)
Build level, as returned by the

db2level command; for example,
n041021.
PTF
VARCHAR(128)
Program temporary fix (PTF)

identifier, as returned by the db2level
command; for example, U498350.
FIXPACK_NUM
INTEGER
Fix Pack number, as returned by the

db2level command; for example, 9.
NUM_MEMBERS
INTEGER
The number of members on this

instance.
ENV_PROD_INFO administrative view - Retrieve information

about installed DB2 products
The ENV_PROD_INFO administrative view returns information about installed
DB2 database products.
400
Authorization
v SELECT privilege on the ENV_PROD_INFO administrative view
v CONTROL privilege on the ENV_PROD_INFO administrative view
v DBADM authority
v SQLADM authority

Example
Request the installed DB2 product information.
SELECT * FROM SYSIBMADM.ENV_PROD_INFO

INSTALLED_PROD INSTALLED_PROD_FULLNAME
-------------- -----------------------------ESE
DB2_ENTERPRISE_SERVER_EDITION
WSE
DB2_WORKGROUP_SERVER_EDITION
EXP
DB2_EXPRESS_EDITION
...
...
...
...
...

...
...
...
...
...
LICENSE_INSTALLED PROD_RELEASE
----------------- -----------Y
9.5
N
9.5
Y
9.5
LICENSE_TYPE
---------------------AUTHORIZED_USER_OPTION
LICENSE_NOT_REGISTERED
RESTRICTED
ENV_PROD_INFO administrative view metadata

Table 107. ENV_PROD_INFO administrative view metadata
Column name
Data type
Description
INSTALLED_PROD
VARCHAR(26)
Identifiers for DB2 products that are installed on the

system.
INSTALLED_PROD_FULLNAME
VARCHAR(100)
Full name of installed DB2 products. Column values

will be displayed in English in uppercase. Words are
separated with an underscore character.
LICENSE_INSTALLED
CHAR(1)
Indicates if product is licensed. If the value is N, the

product is not licensed. If the value is Y, the product
is licensed. For LICENSE_TYPE values TRIAL and
LICENSE_NOT_REGISTERED, the value is always
N.
PROD_RELEASE
VARCHAR(26)
Product release number.
401
Table 107. ENV_PROD_INFO administrative view metadata (continued)

Column name
Data type
Description
LICENSE_TYPE
VARCHAR(50)
Name of the type of license that is installed for the

product. The possible return values are:
v 12_MONTHS_LICENSE_AND_SUBSCRIPTION
v AUTHORIZED_USER
v AUTHORIZED_USER_OPTION
v CLIENT_DEVICE
v CPU
v CPU_OPTION
v HOST_SERVER_AND_MSU
v LICENSE_NOT_REGISTERED
v MANAGED_PROCESSOR
v N/A
v RESTRICTED
v TRIAL
v UNWARRANTED
v USER
ENV_SYS_INFO administrative view - Retrieve information about

the system
The ENV_SYS_INFO administrative view returns information about the system.
Authorization
v SELECT privilege on the ENV_SYS_INFO administrative view
v CONTROL privilege on the ENV_SYS_INFO administrative view
v DBADM authority
v SQLADM authority

Example
Request information about the system.
SELECT * from SYSIBMADM.ENV_SYS_INFO

OS_NAME
OS_VERSION
OS_RELEASE
HOST_NAME
--------...- ----------...- --------------...- ---------...WIN32_NT
5.1
Service Pack 1
D570
402

... TOTAL_CPUS CONFIGURED_CPUS TOTAL_MEMORY
... ----------- --------------- -----------...
1
2
1527
Table 108. Information returned by the ENV_SYS_INFO administrative view
Column name
Data type
Description
OS_NAME
VARCHAR(256)
Name of the operating

system.
OS_VERSION
VARCHAR(256)
Version number of the

operating system.
OS_RELEASE
VARCHAR(256)
Release number of the

operating system.
HOST_NAME
VARCHAR(256)

monitor element
TOTAL_CPUS
INTEGER
Total number of physical

CPUs on the system.
CONFIGURED_CPUS
INTEGER
Number of configured
physical CPUs on the
system.
TOTAL_MEMORY
INTEGER
Total amount of memory on

the system (in megabytes).
OS_FULL_VERSION
VARCHAR(256)
os_full_version - Operating
system full version monitor
element
OS_KERNEL_VERSION
VARCHAR(256)
os_kernel_version Operating system kernel

identifier monitor element
OS_ARCH_TYPE
VARCHAR(256)
os_arch_type - Operating
system architecture type
monitor element
Explain routines
EXPLAIN_GET_MSGS
The EXPLAIN_GET_MSGS table function queries the EXPLAIN_DIAGNOSTIC and
EXPLAIN_DIAGNOSTIC_DATA Explain tables, and returns formatted messages.
Syntax
EXPLAIN_GET_MSGS (
explain-requester
source-schema , source-version
, explain-time
, explain-level
, source-name
, stmtno
, sectno
,
,
locale )

The schema is the same as the Explain table schema.
403
Any of the following input arguments can be null. If an argument is null, it is not
used to limit the query.
explain-requester
of the initiator of this Explain request. A null value excludes this parameter
from the search condition of the query.
explain-time
An input argument of type TIMESTAMP that specifies the time of initiation for
the Explain request. A null value excludes this parameter from the search
condition of the query.
source-name
package running when the dynamic statement was explained, or the name of
the source file when the static SQL statement was explained. A null value
excludes this parameter from the search condition of the query.
source-schema
An input argument of type VARCHAR(128) that specifies the schema, or
qualifier, of the source of the Explain request. A null value excludes this
parameter from the search condition of the query.
source-version
An input argument of type VARCHAR(64) that specifies the version of the
source of the Explain request. A null value excludes this parameter from the
search condition of the query.
explain-level
An input argument of type CHAR(1) that specifies the level of Explain
information for which this row is relevant. A null value excludes this
parameter from the search condition of the query.
stmtno
An input argument of type INTEGER that specifies the statement number
within the package to which this Explain information is related. A null value
excludes this parameter from the search condition of the query.
sectno
An input argument of type INTEGER that specifies the section number within
the package to which this Explain information is related. A null value excludes
this parameter from the search condition of the query.
locale
An input argument of type VARCHAR(33) that specifies the locale of returned
messages. If the specified locale is not installed on the DB2 server, the value is
ignored.
Authorization
v DBADM authority
v SQLADM authority
v EXPLAIN authority
404

Table 109. Information returned by the EXPLAIN_GET_MSGS table function
Column name
Data type
Description
EXPLAIN_REQUESTER
VARCHAR(128)
Authorization ID of the initiator of

this Explain request.
EXPLAIN_TIME
TIMESTAMP
Time of initiation for the Explain

request.
SOURCE_NAME
VARCHAR(128)
Name of the package running when

the dynamic statement was
explained, or the name of the source
file when the static SQL statement
was explained.
SOURCE_SCHEMA
VARCHAR(128)
Schema, or qualifier, of the source of

the Explain request.
SOURCE_VERSION
VARCHAR(64)
Version of the source of the Explain

request.
EXPLAIN_LEVEL
CHAR(1)
Level of Explain information for

which this row is relevant.
STMTNO
INTEGER
Statement number within the package

to which this Explain information is
related.
SECTNO
INTEGER
Section number within the package to

which this Explain information is
related.
DIAGNOSTIC_ID
INTEGER
ID of the diagnostic for a particular

instance of a statement in the
EXPLAIN_STATEMENT table.
LOCALE
VARCHAR(33)
Locale of returned messages. This

locale will not match the specified
locale if the latter is not installed on
the DB2 server.
MSG
VARCHAR(4096)
Formatted message text.
Examples
Request formatted English messages from the Explain tables in the default schema
for requester SIMMEN that were generated in the last hour. Specify a source name
of SQLC2E03.
SELECT MSG
FROM TABLE(EXPLAIN_GET_MSGS(
SIMMEN,
CAST(NULL AS TIMESTAMP),
SQLC2E03,
CAST(NULL AS VARCHAR(128)),
CAST(NULL AS VARCHAR(64)),
CAST(NULL AS CHAR(1)),
CAST(NULL AS INTEGER),
CAST(NULL AS INTEGER),
405
en_US))
AS REGISTRYINFO
WHERE EXPLAIN_TIME >= (CURRENT TIMESTAMP - 1 HOUR)
ORDER BY DIAGNOSTIC_ID

MSG
-----------------------------------------------------------------------EXP0012W Invalid access request. The index "index1" could not be found.
Line number "554", character number "20".
EXP0012W Invalid access request. The index "index2" could not be found.
Line number "573", character number "20".
EXP0015W Invalid join request. Join refers to tables that are not in
the same FROM clause. Line number "573", character number "20".
EXPLAIN_FORMAT_STATS
This scalar function is used to display formatted statistics information which is
parsed and extracted from explain snapshot captured for a given query.
Syntax
EXPLAIN_FORMAT_STATS (
snapshot
Function parameters
snapshot
An input argument of type BLOB(10M) that is the explain snapshot captured
for a given query. It is stored as snapshot column of explain table
EXPLAIN_STATEMENT
Authorization
v
v
v
v
DBADM authority
SQLADM authority
EXPLAIN authority

The data type of the result is CLOB(50M).
Example
SELECT EXPLAIN_FORMAT_STATS(SNAPSHOT)
FROM EXPLAIN_STATEMENT
WHERE EXPLAIN_REQUESTER = DB2USER1 AND
EXPLAIN_TIME = timestamp(2006-05-12-14.38.11.109432) AND
SOURCE_NAME = SQLC2F0A AND
406
SOURCE_SCHEMA = NULLID AND

SOURCE_VERSION = AND
EXPLAIN_LEVEL = O AND
STMTNO = 1 AND
SECTNO = 201
The following is a sample output of this function:

Tablespace Context:
------------------Name:
Overhead:
Transfer Rate:
Prefetch Size:
Extent Size:
Type:
Partition Group Name:
Buffer Pool Identifier:
USERSPACE1
7.500000
0.060000
32
32
Database managed
NULLP
0
Base Table Statistics:

---------------------Name:
Schema:
Number of Columns:
Number of Pages with Rows:
Number of Pages:
Number of Rows:
Table Overflow Record Count:
Width of Rows:
Time of Creation:
Last Statistics Update:
Statistics Type:
Primary Tablespace:
Tablespace for Indexes:
Tablespace for Long Data:
Number of Referenced Columns:
Number of Indexes:
Volatile Table:
Table Active Blocks:
Number of Column Groups:
Number of Data Partitions:
Average Row Compression Ratio:
Percent Rows Compressed:
Average Compressed Row Size:
Statistics Type:
T1
DB2USER2
3
1
1
5
0
26
2006-06-16-11.46.53.041085
2006-06-26-12.23.44.814201
Fabrication
USERSPACE1
USERSPACE1
NULLP
2
1
No
1
0
1
-9.000000
-9.000000
-9
U
Column Information:
-------------------Number:
Name:
Statistics Available:
1
C1
Yes
Column Statistics:
-----------------Schema name of the column type:
Name of column type:
Maximum column length:
Scale for decimal column:
Number of distinct column values:
Average column length:
Number of most frequent values:
Number of quantiles:
Second highest data value:
Second lowest data value:
Column sequence in partition key:
Average number of sub-elements:
Average length of delimiters:
SYSIBM
INTEGER
4
0
4
5
1
5
3
2
0
-1
-1
407
Column Distribution Statistics:

------------------------------Frequency Statistics:
Valcount
Value
---------- ----------2
1
Quantile Statistics:
Valcount
Distcount
---------- ----------0
1
2
1
3
2
4
3
5
4
Value
---------1
1
2
3
4
Column Information:
-------------------Number:
Name:
2
C2
Yes
Column Statistics:
SYSIBM
INTEGER
4
0
4
5
1
5
3
2
0
-1
-1

------------------------------Frequency Statistics:
Valcount
Value
---------- ----------2
1
Quantile Statistics:
Valcount
Distcount
---------- ----------0
0
2
0
3
0
4
0
5
0
Value
----------1
1
2
4
4
Indexes defined on the table:

----------------------------Name:
Schema:
Unique Rule:
Used in Operator:
Page Fetch Pairs:
Number of Columns:
Index Leaf Pages:
Index Tree Levels:
Index First Key Cardinality:
Index Full Key Cardinality:
408
IDX_T1C1C2
DB2USER2
Duplicate index
Yes
Not Available
2
1
1
4
4
Index Cluster Ratio:

Index Cluster Factor:
Time of Creation:
Index Sequential Pages:
Index First 2 Keys Cardinality:
Index Avg Gap between Sequences:
Fetch Avg Gap between Sequences:
Index Avg Sequential Pages:
Fetch Avg Sequential Pages:
Index Avg Random Pages:
Fetch Avg Random Pages:
Index RID Count:
Index Deleted RID Count:
Index Empty Leaf Pages:
Avg Partition Cluster Ratio:
Avg Partition Cluster Factor:
Data Partition Cluster Factor:
Data Partition Page Fetch Pairs:
100
-1.000000
2006-06-16-11.46.53.596717
2006-06-26-12.23.44.814201
0
4
-1
-1
0.000000
-1.000000
0.000000
-1.000000
1.000000
-1.000000
5
0
0
-1
-1.000000
1.000000
Not Available
Base Table Statistics:

---------------------Name:
Schema:
Number of Columns:
Number of Pages with Rows:
Number of Pages:
Number of Rows:
Table Overflow Record Count:
Width of Rows:
Time of Creation:
Statistics Type:
Primary Tablespace:
Tablespace for Indexes:
Tablespace for Long Data:
Number of Referenced Columns:
Number of Indexes:
Volatile Table:
Table Active Blocks:
Number of Column Groups:
Number of Data Partitions:
T2
DB2USER2
3
1
1
2
0
26
2006-06-16-11.46.53.398092
2006-06-26-12.23.45.157028
Synchronous
USERSPACE1
USERSPACE1
NULLP
2
1
No
-1
0
1
Column Information:
-------------------Number:
Name:
1
C1
Yes
Column Statistics:
SYSIBM
INTEGER
4
0
2
5
-1
2
2
1
0
-1
-1
409

------------------------------Quantile Statistics:
Valcount
Distcount
Value
---------- ----------- ----------1
1
1
2
2
2
Column Information:
-------------------Number:
Name:
2
C2
Yes
Column Statistics:
SYSIBM
INTEGER
4
0
2
5
-1
2
2
1
0
-1
-1

------------------------------Quantile Statistics:
Valcount
Distcount
Value
---------- ----------- ----------1
0
1
2
0
2
Indexes defined on the table:
----------------------------Name :
Schema:
Unique Rule:
Used in Operator:
Page Fetch Pairs:
Number of Columns:
Index Leaf Pages:
Index Tree Levels:
Index First Key Cardinality:
Index Full Key Cardinality:
Index Cluster Ratio:
Index Cluster Factor:
Time of Creation:
Index Sequential Pages:
Index Avg Gap between Sequences:
Fetch Avg Gap between Sequences:
Index Avg Sequential Pages:
Fetch Avg Sequential Pages:
Index Avg Random Pages:
Fetch Avg Random Pages:
Index RID Count:
Index Deleted RID Count:
Index Empty Leaf Pages:
410
IDX_T2C1
DB2USER2
Duplicate index
No
Not Available
1
1
1
2
2
100
-1.000000
2006-06-16-11.46.53.857520
2006-06-26-12.23.45.157028
0
-1
-1
-1
0.000000
-1.000000
0.000000
-1.000000
1.000000
-1.000000
2
0
0
Avg Partition Cluster Ratio:

Avg Partition Cluster Factor:
Data Partition Cluster Factor:
Data Partition Page Fetch Pairs:
-1
-1.000000
1.000000
Not Available
EXPLAIN_FROM_ACTIVITY procedure - Explain statement using

activity event monitor information
The EXPLAIN_FROM_ACTIVITY procedure explains a specific execution of a
statement using the contents of the section obtained from an activity event
monitor.
The Explain output is placed in the Explain tables for processing using any
existing Explain tools (for example, db2exfmt). The Explain output contains, if
available, both the access plan and section actuals (runtime statistics for operators
in the access plan).
EXPLAIN_FROM_ACTIVITY
(
appl_id
uow_id
,
explain_requester

,
activity_id ,
explain_time ,
activity_evmon_name ,
source_name ,
explain_schema
source_schema ,
source_version )
Authorization
One of the following authorities or privileges is required to execute the routine:
v DBADM authority
v SQLADM authority
v EXPLAIN authority
In addition, all of the following privileges are required:
v INSERT privilege on the explain tables in the specified schema
v SELECT privilege on the event monitor tables for the source activity event
monitor

None

appl_id
An input argument of type VARCHAR(64) that uniquely identifies the
application that issued the activity whose section is to be explained. If appl_id
is null or an empty string, SQL2032N is returned.
uow_id
An input argument of type INTEGER specifying the unit of work identifier for
the activity whose section is to be explained. Unit of work ID is only unique
within a given application. If uow_id is null, SQL2032N is returned.
activity_id
An input argument of type INTEGER specifying the identifier of the activity
411
whose section is to be explained. Activity ID is only unique within a unit of

work. If activity_id is null, SQL2032N is returned.
activity_evmon_name
An input argument of VARCHAR(128) that specifies the name of a write to
table activity event monitor containing the activity whose section is to be
explained. If the event monitor does not exist or is not an activity event
monitor, SQL0204N is returned. If the event monitor is not a write to table
event monitor, SQL20502N is returned. If activity_evmon_name is not specified,
SQL2032N is returned. If the caller does not have SELECT privilege on the
activity event monitor tables, SQL0551N is returned.
explain_schema
An optional input or output argument of type VARCHAR(128) that specifies
the schema containing the Explain tables where the explain information should
be written. If an empty string or NULL is specified, a search is made for the
explain tables under the session authorization ID and, following that, the
SYSTOOLS schema. If the Explain tables cannot be found, SQL0219N is
returned. If the caller does not have INSERT privilege on the Explain tables,
SQL0551N is returned. On output, this parameter is set to the schema
containing the Explain tables where the information was written.
explain_requester
An output argument of type VARCHAR(128) that contains the session
authorization ID of the connection in which this routine was invoked.
explain_time
An output argument of type TIMESTAMP that contains the time of initiation
for the Explain request.
source_name
An output argument of type VARCHAR(128) that contains the name of the
package running when the statement was prepared or compiled.
source_schema
An output argument of type VARCHAR(128) that contains the schema, or
qualifier, of the source of Explain request.
source_version
An output argument of type VARCHAR(64) that contains the version of the
source of the Explain request.
Example
The following example assumes that you are mining the data collected in the
activity event monitor over a period of time and using the following query, you
notice a particularly expensive SQL statement in terms of CPU cost.
SELECT APPL_ID,
UOW_ID,
ACTIVTY_ID,
USER_CPU_TIME
FROM ACTIVITY_A
ORDER BY USER_CPU_TIME
The following example shows output from this query. The application with an ID
of N2.DB2INST1.0B5A12222841 is using a large amount of CPU time.
412
APPL_ID
UOW_ID
ACTIVITY_ID
USER_CPU_TIME
------------------------ -------- -------------- --------------*N2.DB2INST1.0B5A12222841
1
1
92782334234
*N2.DB2INST1.0B5A12725841
2
7
326
You can use the EXPLAIN_FROM_ACTIVITY procedure to investigate the access

plan for this activity, to determine if the activity could benefit from tuning, for
example, by adding an index.
CALL EXPLAIN_FROM_ACTIVITY( *N2.DB2INST1.0B5A12222841, 1, 1, A, MYSCHEMA,
?, ?, ?, ?, ? )
Usage notes
In order to run Explain on the section of the activity, you must specify the
COLLECT ACTIVITY DATA WITH SECTION clause when you enable collection of
activity data, so that the section is collected with the activity information. If there
is no section stored with the identified activity entry, SQL20501 is returned.
If section actuals were not collected for an activity, the section explain will succeed,
but the Explain output will not include actuals information. Section actuals will not
be collected in the following cases:
v The activity specified as input was captured using the
WLM_CAPTURE_ACTIVITY_IN_PROGRESS stored procedure. In this case, the
value of the partial_record element in the activity logical group is 1.
v The activity event monitor ACTIVITY table is missing the SECTION_ACTUALS
element.
v The section executed is a static section and it has not been rebound since
applying DB2 Version 9.7 Fix Pack 1.
v Section actuals were not enabled for the section that was captured. Section
actuals are enabled using the section_actuals database configuration parameter
or for a specific application using the WLM_SET_CONN_ENV procedure. By default,
section actuals are disabled.
Note: To verify that section actuals were collected for an activity, check whether
the SECTION_ACTUALS element in the ACTIVITY table has a length greater than
0.
Note: The section_actuals setting specified by the WLM_SET_CONN_ENV procedure
for an application takes effect immediately. Section actuals will be collected for the
next statement issued by the application.
Note: In a partitioned database environment, section actuals will be collected only
on members where activity data is collected. To collect actuals on all members,
ensure the activity is collected using the COLLECT ACTIVITY DATA ON ALL
MEMBERS WITH DETAILS, SECTION clause. If the user wants to enable
collection at all members for a particular application, they can include the
<collectactpartition> tag with a value of "ALL" in the second argument when calling
the WLM_SET_CONN_ENV procedure.
If no activity can be found that corresponds to the appl_id, uow_id, and activity_id
that you input, SQL20501 is returned. If multiple activities match, which may occur
if an activity was collected multiple times during execution using the
WLM_CAPTURE_ACTIVITY_IN_PROGRESS stored procedure, the most recent
entry for which a section was captured will be used for Explain.
413
The output parameters explain_requester, explain_time, source_name, source_schema,

and source_version comprise the key used to look up the Explain information for
the section in the Explain tables. Use these parameters with any existing Explain
tools (for example, db2exfmt) to format the explain information retrieved from the
section.
The EXPLAIN_FROM_ACTIVITY procedure does not issue a COMMIT statement
after inserting into the Explain tables. It is the responsibility of the caller of the
procedure to issue a COMMIT.
The following elements must be present in the ACTIVITYSTMT logical group:
STMT_TEXT, ORIGINAL_STMT_TEXT, SECTION_ENV, EXECUTABLE_ID,
APPL_ID, ACTIVITY_ID, UOW_ID. If any of these elements are missing, the stored
procedure returns SQL206.
EXPLAIN_FROM_CATALOG procedure - Explain a statement

using section information from catalogs
The EXPLAIN_FROM_CATALOG procedure explains a statement using the
contents of the section obtained from the catalogs. The Explain output is placed in
the Explain tables for processing using any existing explain tools (for example,
db2exfmt).
EXPLAIN_FROM_CATALOG
,
explain_requester
(
,
pkgschema ,
explain_time ,
pkgname ,
pkgversion ,
source_name ,
sectno ,
source_schema ,
explain_schema
source_version )
Authorization
v
v
v
v
DBADM authority
SQLADM authority
EXPLAIN authority
In addition, the following privilege is required:


None
pkgschema
An input argument of type VARCHAR(128) specifying the schema of the
package containing the section to be explained. If pkgschema is null or an
empty string, SQL2032N is returned.
pkgname
An input argument of type VARCHAR(128) specifying the package containing
the section to be explained. If pkgname is null or an empty string, SQL2032N is
returned.
414
pkgversion
An input argument of type VARCHAR(64) specifying the version identifier for
the package containing the section to be explained. Specify an empty string if
the package has no version (a blank ' ' character if VARCHAR2 compatibility
mode is enabled). If pkgversion is null, SQL2032N is returned.
sectno
An input argument of type SMALLINT specifying the section to be explained.
If sectno is null, SQL2032N is returned.
explain_schema
explain_requester
explain_time
source_name
source_schema
source_version
Example
The following example demonstrates how to explain a static statement that was
compiled and exists in the catalogs. First, you can identify the section by selecting
from the SYSCAT.STATEMENTS catalog view, for example:
SELECT pkgschema,
pkgname,
version,
Sectno
FROM SYSCAT.STATEMENTS
WHERE TEXT = select count(*) from syscat.tables
This query returns the following sample output:

PKGSCHEMA
---------NULLID
NULLID
PKGNAME
VERSION
-------------------- --------------------SQLE2G0S
SQLE2G0S
VERSION1
SECTNO
-----1
1
415
Then pass the pkgschema, pkgname, version and sectno identification information into
the EXPLAIN_FROM_CATALOG procedure, for example:
CALL EXPLAIN_FROM_CATALOG( NULLID, SQLE2G0S, , 1, MYSCHEMA, ?, ?, ?, ?, ? )
Usage notes
If no section can be found corresponding to the input parameters, SQL20501 is
returned.
source_version comprise the key used to look up the Explain information for the
section in the Explain tables. Use these parameters with any existing Explain tools
(for example, db2exfmt) to format the explain information retrieved from the
section.
The procedure does not issue a COMMIT statement after inserting into the Explain
tables. It is the responsibility of the caller of the procedure to issue a COMMIT.
EXPLAIN_FROM_DATA procedure - Explain a statement using

the input section
The EXPLAIN_FROM_DATA procedure explains a statement using the contents of
the input section. The Explain output is placed in the Explain tables for processing
using any existing Explain tools (for example, db2exfmt).

,
EXPLAIN_FROM_DATA
explain_requester
section ,
,
stmt_text ,
explain_time ,
executable_id ,
source_name ,
explain_schema
source_schema ,
source_version )

Authorization
v
v
v
v
DBADM authority
SQLADM authority
EXPLAIN authority
In addition, the following privilege is required:


None
section
An input argument of type BLOB(134M) that contains the section to be
explained. You can obtain the section from various sources, including event
monitor tables and the catalog tables. If the input section is not a valid section,
SQL20503N is returned.
416
stmt_text
An optional input argument of type CLOB(2M) that contains the text of the
statement corresponding to the input section. If stmt_text is NULL, the
formatted Explain output will not contain any statement text.
executable_id
An optional input argument of type VARCHAR(32) FOR BIT DATA that
contains the executable ID used to identify the section. If executable_id is NULL,
the formatted explain output will not contain an executable ID.
explain_schema
explain_requester
explain_time
source_name
source_schema
source_version
Example
Assume you have captured a number of statements using the package cache event
monitor and extracted the event monitor data (using the
EVMON_FORMAT_UE_TO_TABLE stored procedure) to a table named
PKGCACHE. Looking at the data in the table, you identify a particularly expensive
statement which has executable id
x'0100000000000000070000000000000000000000000200200811261904103698'.
You issue the EXPLAIN_FROM_DATA procedure to understand the access plan for
this statement, passing as input the section from the entry in the PKGCACHE
table. You place the Explain output in the explain tables in the MYSCHEMA
schema.
SET SERVEROUTPUT ON;
BEGIN
DECLARE
DECLARE
DECLARE
DECLARE
EXECUTABLE_ID VARCHAR(32) FOR BIT DATA; -SECTION BLOB(134M); -STMT_TEXT CLOB(2M); -EXPLAIN_SCHEMA VARCHAR(128); -Built-in routines and views
417
DECLARE
DECLARE
DECLARE
DECLARE
DECLARE
EXPLAIN_REQUESTER VARCHAR(128); -EXPLAIN_TIME TIMESTAMP; -SOURCE_NAME VARCHAR(128); -SOURCE_SCHEMA VARCHAR(128); -SOURCE_VERSION VARCHAR(128); --
SET EXPLAIN_SCHEMA = MYSCHEMA; -SELECT P.SECTION, P.STMT_TEXT, P.EXECUTABLE_ID INTO

SECTION, STMT_TEXT, EXECUTABLE_ID
FROM PKGCACHE WHERE EXECUTABLE_ID =
x0100000000000000070000000000000000000000000200200811261904103698; -CALL EXPLAIN_FROM_DATA( SECTION,
STMT_TEXT,
EXECUTABLE_ID,
EXPLAIN_SCHEMA,
EXPLAIN_REQUESTER,
EXPLAIN_TIME,
SOURCE_NAME,
SOURCE_SCHEMA,
SOURCE_VERSION ); -CALL
CALL
CALL
CALL
CALL
CALL
CALL
CALL
CALL
CALL
END;
DBMS_OUTPUT.PUT( EXPLAIN_REQUESTER = ); -DBMS_OUTPUT.PUT_LINE( EXPLAIN_REQUESTER ); -DBMS_OUTPUT.PUT( EXPLAIN_TIME = ); -DBMS_OUTPUT.PUT_LINE( EXPLAIN_TIME ); -DBMS_OUTPUT.PUT( SOURCE_NAME = ); -DBMS_OUTPUT.PUT_LINE( SOURCE_NAME ); -DBMS_OUTPUT.PUT( SOURCE_SCHEMA = ); -DBMS_OUTPUT.PUT_LINE( SOURCE_SCHEMA ); -DBMS_OUTPUT.PUT( SOURCE_VERSION = ); -DBMS_OUTPUT.PUT_LINE( SOURCE_VERSION ); --
SET SERVEROUTPUT OFF;
Usage notes
The input section can be obtained from a number of different sources:
v
v
v
v
Activity event monitor

Package cache event monitor
Catalog tables
Any user table or input source that has made a copy of the section from one of
the locations listed previously.

source_version comprise the key used to look up the Explain information for the
section in the Explain tables. Use these parameters with any existing Explain tools
(for example, db2exfmt) to format the explain information retrieved from the
section.
The procedure does not issue a COMMIT after inserting into the Explain tables. It
is the responsibility of the caller of the procedure to issue a COMMIT.
EXPLAIN_FROM_SECTION procedure - Explain a statement

using package cache or package cache event monitor
information
The EXPLAIN_FROM_SECTION procedure explains a statement using the contents
of the section obtained from the package cache or from the package cache event
418
monitor. The Explain output is placed in the Explain tables for processing using
any existing explain tools (for example, db2exfmt).
EXPLAIN_FROM_SECTION
( executable_id , section_source_type , section_source_name , member , explain_schema
, explain_requester , explain_time , source_name , source_schema , source_version )
Authorization
v DBADM authority
v SQLADM authority
v EXPLAIN authority
In addition, all of the following privileges are required:
v SELECT privilege on the package cache event monitor table, if the section source
name identifies a package cache event monitor

None
executable_id
An input argument of type VARCHAR(32) FOR BIT DATA that uniquely
identifies a section to be explained. If this argument is null or an empty string,
SQL2032 is returned.
section_source_type
An input argument of type CHAR(1) that specifies the source of the section to
be explained. Valid values are:
v M - Section is obtained from the in-memory package cache
v P - Section is obtained from a package cache event monitor. Either regular or
unformatted event tables can be used as the output type for the event
monitor.
For static SQL, if the section_source_type is M and the section cannot be located
in the package cache, the catalog tables are searched for the section.
section_source_name
An input argument of VARCHAR(128) that specifies the name of a package
cache event monitor if the section_source_type is P. If the section_source_type is
M, the name of a package cache event monitor can be optionally specified. The
event monitor is searched for the section if the section cannot be found in the
package cache (for example, if the section was flushed from the package cache
before the EXPLAIN_FROM_SECTION stored procedure was invoked). If the
source input event monitor is not a package cache event monitor created with
419
the COLLECT DETAILED DATA option, SQL0204N is returned. If the caller

does not have SELECT privilege on the package cache event monitor table,
SQL0551N is returned.
member
An input argument of type INTEGER that specifies the member where the
section to be explained resides in memory if the section_source_type is M. If -1 is
specified, the procedure searches for the section on the current coordinator
member and the section compilation member. This argument is ignored if the
section_source_type is anything other than M.
explain_schema
explain_requester
explain_time
source_name
source_schema
source_version
Example
This example shows how to identify and analyze a particularly expensive
statement in the package cache by looking at the monitoring metrics available per
section. First, issue a query similar to the following SELECT statement to
determine the CPU time usage of sections.
SELECT executable_id,
Total_cpu_time,
Varchar(stmt_text, 100) as stmt_text
FROM TABLE(MON_GET_PKG_CACHE_STMT (NULL, NULL,NULL, -1)) AS T
The following sample shows output from this query.

EXECUTABLE_ID
TOTAL_CPU_TIME ...
--------------------------- ...
x010000000000000012...200200811261904103698 91875622
...
x010000000000000007...200200811261904103238
300
...
420
The following sample continues the output from this query.

...STMT_TEXT
...---------------------...SELECT * FROM SYSCAT.TABLES
...INSERT INTO T1 VALUES(123)
To examine the access plan for the expensive SELECT statement, pass its
executable_id to the EXPLAIN_FROM_SECTION procedure. Place the output in the
Explain tables in the MYSCHEMA schema.
CALL EXPLAIN_FROM_SECTION
( x01000000000000001200000000000000000000000200200811261904103698,
M, NULL, 0, MYSCHEMA, ?, ?, ?, ?, ? )
Usage notes
If the section corresponding to the input executable ID cannot be found, SQL20501
is returned. The input executable_id can be obtained from the following sources
v Activity event monitor
v Package cache event monitor
v MON_GET_ACTIVITY_DETAILS table function
v MON_GET_PKG_CACHE_STMT table function
v WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES table function
v WLM_GET_SERVICE_CLASS_AGENTS table function
v MON_GET_PKG_CACHE_STMT_DETAILS table function
v MON_GET_APPL_LOCKWAIT table function
source_version comprise the key used to look up the information for the section in
the Explain tables. Use these parameters with any existing Explain tools (for
example, db2exfmt) to format the explain information retrieved from the section.
The procedure does not issue a COMMIT statement after inserting into the Explain
tables. It is the responsibility of the caller of the procedure to issue a COMMIT.
Monitor routines and views

Monitor routines and views are routines or views with names that begin with
MON, such as MON_GET_SERVICE_SUBCLASS, or EVMON, such as
EVMON_FORMAT_UE_TO_TABLES.
These routines and views perform a variety of different functions related to
querying the status of your system, or manipulating monitoring data. Some
routines are table functions that return data in the form of a table. For example,
numerous table functions provide access to monitor elements. Views are very
similar to table functions; they return data in table format, but unlike table
functions, they do not require any input parameters. Some monitor routines,
notably, the ones that begin with EVMON transform data in one format to
another. Certain other routines, such as environment or administration routines,
also return information that is relevant when monitoring.
421
Monitor (MON) views

Monitor views are an ideal place to start when interested in basic monitoring.
These views provide a condensed representation of monitoring information,
displaying the highlights, as well as providing some of the standard calculations of
most interest, such as buffer pool hit ratio.
The monitor views return metrics on various database activities, for example:
v MON_BP_UTILIZATION returns key monitoring metrics, including hit ratios
and average read and write times, for all buffer pools and all database partitions
in the currently connected database.
v MON_CURRENT_SQL returns metrics for all activities that were submitted on
all members of the database and have not yet been completed, including a
point-in-time view of currently executing SQL statements.
v MON_DB_SUMMARY returns metrics aggregated over all service classes.
v MON_LOCKWAITS returns information about agents working on behalf of
applications that are waiting to obtain locks in the currently connected database.
v MON_SERVICE_SUBCLASS_SUMMARY returns metrics for all service
subclasses, showing work executed per service class.
v MON_CURRENT_UOW returns metrics for all units of work.
v MON_WORKLOAD_SUMMARY returns metrics for all workloads, showing
incoming work per workload.
Characteristics of monitor (MON) table functions

v The "MON" routines are strategically important, therefore the names of these
routines will not change in future releases. However, they will have new output
columns added when enhancements are made in future releases. Therefore,
when you issue a query to retrieve information using a built-in routine or view,
do not use a statement of the form SELECT * .... Instead, name the result
columns in the SELECT statement. This gives the application control over the
number of result columns and the sequence in which they are returned.
v Some table functions have two versions, one of which has a _DETAILS suffix.
The version without the _DETAILS suffix provides a relational SQL interface that
returns the most commonly used data. The version with the _DETAILS suffix
provides XML-based access to the monitor data.
v The metrics returned by the monitoring table functions are never reset. They
start at 0 when the database is activated and continue to accumulate until the
database is deactivated.
v With most table functions, you can choose to receive data for a single object (for
example, service class "A") or for all objects.
v As with most table functions, when using these table functions in a DB2
pureScale environment or a partitioned database environment, you can choose to
receive data for a single member or for all members. If you choose to receive
data for all members, the table functions return one row for each member. You
can add the values across members to obtain the value of a monitor element
across members.
Monitor (MON) table functions

Monitor table functions return a diverse set of monitor elements describing system
behavior and performance that can be used for understanding, tuning, and
troubleshooting applications on the database server. These elements provide
422
information about a diverse set of system performance indicators that can affect
application response time. You can also obtain monitor data for a subset of the
workload you are interested in.
Some monitor table functions report on various aspects of the overall system
workload, for example:
v MON_GET_CONNECTION and MON_GET_CONNECTION_DETAILS
v MON_GET_SERVICE_SUBCLASS and
MON_GET_SERVICE_SUBCLASS_DETAILS
v MON_GET_UNIT_OF_WORK and MON_GET_UNIT_OF_WORK_DETAILS
v MON_GET_WORKLOAD and MON_GET_WORKLOAD_DETAILS
v MON_GET_DATABASE and MON_GET_DATABASE_DETAILS
Other table functions return data for a specific type of object, for example:
v MON_GET_APPL_LOCKWAIT
v MON_GET_BUFFERPOOL
v MON_GET_CONTAINER
v
v
v
v
v
MON_GET_EXTENDED_LATCH_WAIT
MON_GET_INDEX
MON_GET_LOCKS
MON_GET_PAGE_ACCESS_INFO
MON_GET_TABLE
v MON_GET_TABLESPACE
Use these table functions to investigate performance issues associated with a
particular data object.
Other table functions are useful for subsystem monitoring:
v MON_GET_FCM
v MON_GET_FCM_CONNECTION_LIST
v MON_GET_HADR
v MON_GET_SERVERLIST
v MON_GET_TRANSACTION_LOG
Other table functions are useful for examining activities and statements:
v MON_GET_ROUTINE
v MON_GET_AGENT
Other table functions are useful for examining details of individual activities and
statements:
v MON_GET_ACTIVITY returns details for a specific activity currently running on
the system; these details include general activity information (like statement text)
and a set of metrics.
v MON_GET_INDEX_USAGE_LIST returns information from a usage list defined
for an index.
v MON_GET_TABLE_USAGE_LIST returns information from a usage list defined
for a table.
v MON_GET_PKG_CACHE_STMT and
MON_GET_PKG_CACHE_STMT_DETAILS
423
In addition, the following table functions serve a progress monitoring role:

v MON_GET_AUTO_MAINT_QUEUE returns information about all automatic
maintenance jobs that are currently queued for execution by the autonomic
computing daemon (db2acd).
v MON_GET_AUTO_RUNSTATS_QUEUE returns information about all objects
which are currently queued for evaluation by automatic statistics collection in
v MON_GET_EXTENT_MOVEMENT_STATUS returns the status of the extent
movement operation.
v MON_GET_REBALANCE_STATUS returns the status of a rebalance operation
on a table space.
v MON_GET_RTS_RQST returns information about all real-time statistics requests
that are pending in the system, and the set of requests that are currently being
processed by the real time statistics daemon.
v MON_GET_USAGE_LIST_STATUS returns current status on a usage list.
The table functions that begin with MON_FORMAT_ return information in an
easy-to-read row-based format. The MON_FORMAT_LOCK_NAME takes the
internal binary name of a lock and returns detailed information about the lock. The
table functions that begin with MON_FORMAT_XML_ take as input an XML
metrics document returned by one of the MON_GET_*_DETAILS table functions
(or from the output of statistics, activity, unit of work, or package cache event
monitors) and returns formatted row-based output.
v MON_FORMAT_XML_COMPONENT_TIMES_BY_ROW returns formatted
row-based output on component times.
v MON_FORMAT_XML_METRICS_BY_ROW returns formatted row-based output
for all metrics.
v MON_FORMAT_XML_TIMES_BY_ROW returns formatted row-based output on
the combined hierarchy of wait and processing times.
v MON_FORMAT_XML_WAIT_TIMES_BY_ROW table function returns formatted
row-based output on wait times.
Event monitor (EVMON) routines

The event monitor routines allow you to access event monitor data, either through
an XML document, by using the EVMON_FORMAT_UE_TO_XML table function;
or through relational tables, by using the EVMON_FORMAT_UE_TO_TABLES
procedure.
Monitor procedures and functions

EVMON_FORMAT_UE_TO_TABLES procedure - move an XML document to
relational tables:
The EVMON_FORMAT_UE_TO_TABLES procedure retrieves data stored in an
unformatted event (UE) table produced by an event monitor and converts it into a
set of relational tables.
The process of creating relational tables takes place in two steps. First the data in
the UE table is converted to XML format, using the
EVMON_FORMAT_UE_TO_XML table function. This table function is run for you
automatically as part of running the EVMON_FORMAT_UE_TO_TABLES
procedure. Next, the XML document that contains the event monitor data is turned
into relational tables using XML decomposition.
424
Syntax
EVMON_FORMAT_UE_TO_TABLES (
xsrobjectname ,
tbsp_name ,
xmlschemafile
options
evmon_type
, tabschema
commit_count
xsrschema
fullselect

)

evmon_type
An input parameter of type VARCHAR(128) that represents the type of data
stored in the unformatted event table. The possible values are as follows:
LOCKING
Data stored in the unformatted event table is from a locking event
monitor.
PKGCACHE
Data stored in the unformatted event table is from a PACKAGE
CACHE event monitor.
UOW
Data stored in the unformatted event table is from a UOW event

monitor.
xsrschema
An input parameter of type VARCHAR (128) that specifies the first-part of the
name of the XSR object that describes how data from the UE file corresponds
to columns in tables. The second-part of the XSR object name is derived from
the xsrobjectname parameter. The complete XSR object name is defined as
xsrschema.xsrobjectname. If this value is NULL, then the authorization ID of the
current session user is used.
xsrobjectname
An input parameter of type VARCHAR (128) that specifies the second-part of
the name of the XSR object that describes how data from the UE file
corresponds to columns in tables. The first-part of the XSR object name is
derived from the xsrschema parameter. The complete XSR object name is
defined as xsrschema.xsrobjectname and is unique among all objects in the XSR.
If this value is NULL then the xsrobjectname is derived as
follows:EVMON_<evmon_type>_SCHEMA_<SQL release level>. For example, a
locking event monitor in DB2 Version 9.7 would have an derived xsrname of
EVMON_LOCKING_SCHEMA_SQL09070.
The XSR object is a copy of the XML schema file that describes the output of
the event monitor. It is stored in the XML schema repository (XSR), and defines
the relationship between the elements of the interim XML document produced
by the first stage of EVMON_FORMAT_UE_TO_TABLES processing, and the
tables and columns the procedure ultimately produces. The XSR object is also
used to manage the mutual dependency between any tables that have been
created and the XML schema from which those tables are derived. If the XSR
object is dropped, or if any of the tables produced by the procedure are
dropped or the columns altered, the dependency between the two is said to be
broken. If EVMON_FORMAT_UE_TO_TABLES (or the
EVMON_FORMAT_UE_TO_XML table function) has not yet been run against
the UE file for a specific type of event monitor, the XSR object that describes
425
the event monitor output will not yet exist. In this case, the XML schema file
for the event monitor is used to create and register an XSR object in the system
catalog tables.
If the database has been upgraded to a newer release, the original xsrobjectname
must be explicitly specified in order to maintain the dependency between the
relational tables and the XML schema.
xmlschemafile
An input parameter of type VARCHAR (1024) that is a fully qualified path to
the XML schema document on disk that describes the output produced by the
event monitor. The XML schema document elements are annotated with
information that maps XML elements and attributes to the relational tables and
their columns.
This parameter is used register an XSR object. If there is no XSR object
registered and enabled for the type of event monitor specified in evmon_type,
then an XSR object is registered as follows:
v If xmlschemafile is NULL, then the procedure uses the XML schema file on
disk that corresponds to value specified for evmon_type, as follows:
LOCKING
sqllib/misc/DB2EvmonLocking.xsd
PKGCACHE
sqllib/misc/DB2EvmonPkgCache.xsd
UOW sqllib/misc/DB2EvmonUOW.xsd
v If you specify the name of an XML schema file, then that file is used to
register and enable the XSR object for decomposition.
v If you specify values for the xsrschema and xsrobjectname parameters, then
XSR object is created with these names. Otherwise, the XSR object is named
as using the defaults previously described for xsrobjectname.
Important: If an XSR object has previously been registered and is enabled for
decomposition, this parameter is ignored. If you want to register an XSR object
using a different XML schema file, you must first drop the existing XSR object.
tabschema
An input parameter of type VARCHAR (128) that represents the SQL schema
name where the event monitor relational tables are created. If this value is
NULL, then the authorization ID of the current session user is used. The SQL
schema under which the tables are created is determined as follows:
v If <db2-xdb:SQLSchema> is specified, use this schema;
v If <db2-xdb:defaultSchema> is specified, use this schema;
v If neither of these values is specified, use the value from the sqlschema input
parameter.
Note: When an XML schema is registered for decomposition, the XSR schema
repository creates a dependency between each table referenced in the schema
and the XSR object that corresponds to this schema. Which means the XSR
object name is linked to a unique set of relational tables in the database. If you
reference an existing XSR object, its data is always decomposed and inserted
into the tables to which the XSR object was linked.
tbsp_name
An input parameter of type VARCHAR(128) that indicates the table space
where the relational tables are created. The default value for this parameter is
426
NULL. The table space name specified on the CREATE TABLE statement
within the XML schema file takes precedence over this input parameter.
options
An input parameter of type VARCHAR(1024) which represents a list of
keyword options supported by this table function. Each option must be
delimited using a semicolon (;) character. The possible values are:
RECREATE_FORCE
Indicates that the relational tables are dropped and re-created before
decomposition.
RECREATE_ONERROR
Indicates that the relational tables are dropped and re-created in the
following situations:
1. If the XSR object is not registered, but the tables exist.
2. On the first failed decomposition attempt. Subsequent failures are
returned, and no attempts are made to re-create the tables.
If an error occurs, for example, a table space full error or an
authorization error, the procedure does not filter the SQLCODE
returned by the decomposition procedure. The procedure treats all
negative SQLCODES equally and tries to re-create the tables.
PRUNE_UE_TABLE
Indicates that any binary events that are successfully inserted into
relational tables are to be pruned (that is, deleted) from the UE table.
Pruning occurs in the same unit of work in which the inserts into the
relational tables are performed.
UPGRADE_TABLES
Indicates that the relational tables produced by this procedure are to be
altered so that the table definitions match those defined in the XSR
object xsrobjectname for the current release. Specify this parameter if
you want to upgrade any relational tables that were created in an
earlier release to reflect any changes made for the current release. The
following types of changes might occur from release to release:
v New columns might be added to tables
v New tables might be added to output of the event monitor
v Column definitions might change (For example data type, or length).
If you do not use the UPGRADE_TABLES option, then the existing table
definitions are retained. Data for any new columns or tables added in
the current release is not written to the relational tables.
If UPGRADE_TABLES is specified, the original xsrobjectname must also be
explicitly specified.
commit_count
An input parameter of type INTEGER. The possible values are as follows:
-1
Commit after every 100 successful documents decomposed.-1 is the the

default value.
Never commit.
Commit after every n documents successfully decomposed.
fullselect
An input parameter of type CLOB(2M) that represents the fullselect statement
427
from an unformatted event table. The fullselect statement is a query that

conforms to the rules of the SELECT statement. The query must follow the
following rules:
v The query must use the "*" clause or specify all the columns of the
unformatted event table. Otherwise an error is returned. The columns must
be specified in the same order as returned by the DESCRIBE statement of
the unformatted event table.
v The query must select only from an unformatted event table.
v The WHERE clause can use any of the non-LOB columns of the unformatted
event table to filter out events.
Authorization
EXECUTE privilege on the EVMON_FORMAT_UE_TO_TABLES stored procedure.
SELECT privilege on the unformatted event table, if you did not create it.
CREATE privilege to create the relational tables in the specified SQL schema.
INSERT privilege to insert into the relational tables, if you did not create them.
All privileges required by the XDB_DECOMP_XMP_FROM_QUERY procedure.
Usage notes
Relationship of records in a UE table to the output of the
EVMON_FORMAT_UE_TO_TABLES table function
There is not a one-to-one mapping between the records written to the UE
table and the output of the EVMON_FORMAT_UE_TO_TABLES
procedure. Some events generate multiple records in the UE table; some
result in just one record being added. When writing data to relational
tables, the EVMON_FORMAT_UE_TO_TABLES procedure might, in some
cases combine information in multiple UE table records into a single
relational table, or it may produce more than one row in different output
tables.
Table creation
In order for decomposition to occur, a set of relational tables must exist.
The EVMON_FORMAT_UE_TO_TABLES procedure creates the relational
tables automatically, as follows:
v The procedure parses the event monitor XML schema file to find the
<db2-mon:createStmt> elements. Each element contains a complete
CREATE TABLE statement.
v The procedure extracts and runs the CREATE TABLE statements.
The <db2-mon:createStmt> is a child element of the existing
<db2-xdb:table> element. Only the EVMON_FORMAT_UE_TO_TABLES
procedure recognizes and uses this element. All other procedures that
parse the XML schema file, such as the XSR objects, ignore this element.
Do not qualify the table name within the <db2-mon:createStmt>.
428
XML schema files from release to release

The default XML schema files provided by each event monitor always
reflects the XML schema for the current release. So, when you run
EVMON_FORMAT_UE_TO_TABLES (or
EVMON_FORMAT_UE_TO_XML), the output reflects the monitor elements
defined for that event monitor in that release. The next section describes
what happens if the schema files for the event monitors happen to change
over time. Understanding the impact of these changes is important if you
create tables using the EVMON_FORMAT_UE_TO_TABLES procedure, and
then apply a fix pack or upgrade to a new release.
Impact of schema updates on tables produced by
EVMON_FORMAT_UE_TO_TABLES
New monitor elements are likely to be added to event monitors in future
fix packs or releases. These new monitor elements might result in new
columns or even new tables being produced by the
EVMON_FORMAT_UE_TO_TABLES procedure. However, if you already
have tables that were created by this procedure before a fix pack was
applied, or before upgrading to a new release, you need to do the
following to have the new relational columns or tables created:
For fix pack updates
If relational tables produced by
EVMON_FORMAT_UE_TO_TABLES before the installation of the
latest fix pack still exist, you must force the creation of a new set of
tables based on the new schema shipped in the fix pack if you
want to see the new monitor elements in relational format.
To force the EVMON_FORMAT_UE_TO_TABLES procedure to use
the new schema shipped in the fix pack and create new tables,
perform the following steps:
1. Break the dependency between the currently registered version
of the XML schema (see the note under the tabschema parameter
of the EVMON_FORMAT_UE_TO_TABLES procedure for more
information about schema registration) and the existing tables
by performing one of the following actions:
v Drop one of the existing tables that were produced by
EVMON_FORMAT_UE_TO_TABLES
v Drop the registered XML schema object associated with the
existing tables using the DROP XSROBJECT statement. For
example, to drop the registered XML schema object
associated with the tables produced by
EVMON_FORMAT_UE_TO_TABLES for the locking event
monitor for DB2 V9.7, use the following command: DROP
XSROBJECT EVMON_LOCKING_SCHEMA_SQL09070.
v Alter any existing column that corresponds to an annotated
monitor element in the currently registered XML schema
object.
2. Run the EVMON_FORMAT_UE_TO_TABLES procedure, using
the FORCE option. This option causes the old tables to be
dropped, and a new set of tables to be produced. If you omit
this option, a SQL0601N error is returned.
This process is illustrated in Example 5: Picking up new elements
in a fix pack update on page 432.
429
If you do not perform the preceding steps, existing tables are

updated based on the previously registered schema file. Any new
columns or tables that might have been added in the fix pack are
not reflected in the output of the
EVMON_FORMAT_UE_TO_TABLES procedure.
For release upgrades
Unless you specify otherwise, the default version of the XML
schema file for the current release is used when you call the
EVMON_FORMAT_UE_TO_TABLES procedure. So, if you upgrade
to a new release of the DB2 product, then, by default, the new
version of the schema file is used when you run the procedure.
If tables from the previous release do not exist,
EVMON_FORMAT_UE_TO_TABLES produces tables using the
most recent schema. However, if tables from the previous release
exist, you must use the FORCE or RECREATE_ONERROR options to cause
the old tables to be replaced by new ones. Otherwise, a SQL0601N
error is returned. Example 6: Picking up new elements in a release
update on page 432 shows an example of recreating the tables
using the default schema for a new release.
Alternatively, you can continue to use the existing tables, without
adding any new columns or tables that might have been
introduced in the latest release. To have the existing tables
updated, you must specify the name of the registered XML schema
file that was used to create the tables for the xsrobjectname
parameter of the EVMON_FORMAT_UE_TO_TABLES procedure.
Example 7: Using the previous relational tables on a release
update on page 433 shows an example of using the schema from
a previous release.
Note: You cannot pick up any new columns or tables introduced in fix
packs or in new releases while retaining the data that was previously in
the relational tables produced by EVMON_FORMAT_UE_TO_TABLES.
Picking up any new columns requires the tables to be re-created.
Partial events
If partial or incomplete events exist in the UE table, a message (SQL443N)
is returned when you run EVMON_FORMAT_UE_TO_TABLES. Incomplete
events can occur when an agent finishes processing before the entire event
record can be inserted in to the UE table. This situation can sometimes
arise where locking is involved, particularly in partitioned database
environments. For example, when the LOCKWAIT threshold is exceeded,
details about the holder of the lock are written to the UE table. However,
details about agents waiting for a lock on the same object are not captured
until the lock times out or the waiter acquires the lock. If
EVMON_FORMAT_UE_TO_TABLES is run before the agent waiting for the
lock has written its information, then only a part of the information about
the lock might exist in the UE table.
To see details about the incomplete events, run
EVMON_FORMAT_UE_TO_XML with the LOG_PARTIAL_EVENTS option.
Examples
v Example 1: Using default parameters on page 431
v Example 2: Attempting to use tables under a different schema on page 431
430
Example
Example
Example
Example
Example
433
v Example
page 433
v
v
v
v
v
3: Attempting to use tables under a different schema

4: Using the RECREATE_FORCE option on page 432
5: Picking up new elements in a fix pack update on page 432
6: Picking up new elements in a release update on page 432
7: Using the previous relational tables on a release update on page
8: Using the UPGRADE_TABLES and PRUNE_UE_TABLE options on
Example 1: Using default parameters

A user named Paul calls the procedure using the default parameters and requires
all events that are part of the service class STUDENTS to be inserted into the
relational tables.
UOW, NULL, NULL, NULL, NULL, NULL, NULL, -1,
SELECT * FROM UOWUE
WHERE service_subclass_name = STUDENTS
ORDER BY event_id, event_timestamp)
The results of the call are as follows:

1. The procedure parses the DB2EvmonUOW.xsd file, which is the default XML
schema file, to identify the set of relational tables to create.
2. The relational tables are created under SQL schema Paul.
3. The XML schema is registered with an XSR object name of
PAUL.EVMON_UOW_SCHEMA_SQL09070
4. XSR object is enabled for decomposition.
5. Data is decomposed and inserted into the tables under SQL schema Paul.
Example 2: Attempting to use tables under a different schema
In a continuation of the previous example, a user named Dave calls the stored
procedure, setting the tabschema parameter to Paul.
UOW, NULL, NULL, NULL, Paul, NULL, NULL, -1,
SELECT * FROM UOWTBLE
ORDER BY event_timestamp)

1. The procedure parses the DB2EvmonUOW.xsd file, which is the default XML
schema file, to identify the set of relational tables to create.
2. The procedure attempts to create the tables under schema Paul. However, an
error is returned because the relational tables currently exist under the SQL
schema PAUL. Previously existing tables cannot be used when a new XSR
object is being registered.
Example 3: Attempting to use tables under a different schema
In a continuation of the previous example, a user named Greg calls the stored
procedure setting the input parameter xsrschema to Paul.
UOW, Paul, NULL, NULL, NULL, NULL, NULL, -1,
SELECT * FROM UOWTBL
431

1. The XSR object Paul.EVMON_UOW_SCHEMA_SQL09070, which exists, is enabled for
decomposition.
2. If Greg has INSERT privileges on the tables, then data is decomposed and
inserted into the relational tables under SQL schema Paul. The existing XSR
object Paul.EVMON_UOW_SCHEMA_SQL09070 is used, so the SQL schema for the
relational tables is obtained from the XSR object, instead of being provided as
an input parameter to the procedure.
Example 4: Using the RECREATE_FORCE option
In a continuation of the previous example, Paul wants to re-create the tables again,
but in table space MYSPACE. Paul calls the procedure with the
RECREATE_FORCE option and the tbsp_name parameter.
UOW, NULL, NULL, NULL, NULL, MYSPACE, RECREATE_FORCE, -1,
SELECT * FROM UOWTBL

1. The XSR object Paul.EVMON_UOW_SCHEMA_SQL09070, which exists, is enabled for
decomposition.
2. The RECREATE_FORCE option is set.
3. The XML schema file is retrieved from the schema repository and parsed to
identify the set of relational files.
4. The current tables are dropped and created again in the MYSPACE table space.
5. Data is decomposed and inserted into the new tables.
Example 5: Picking up new elements in a fix pack update
A new XML element called db2EventNew has been added to the XML schema
file of the locking event monitor in the latest fix pack. Paul wants to pick up the
new element to use in the decomposition of an XML file. To do so, he follows the
following steps:
1. Paul drops the XSR object created in the original release:
DROP XSROBJECT EVMON_LOCKING_SCHEMA_SQL09070
2. He calls the procedure with the RECREATE_ONERROR option.

LOCKING, NULL, NULL, NULL, NULL, NULL, RECREATE_ONERROR, -1,
SELECT * FROM LOCK

a. The XSR object does not exist, so the default DB2EvmonLocking.xsd schema
file is parsed to identify the set of relational tables.
b. As the RECREATE_ONERROR option was specified, the existing tables are
dropped and re-created.
Example 6: Picking up new elements in a release update
Paul is upgrading to a new DB2 release and wants to pick up the new changes in
the event monitor XML schema file. Paul calls the procedure with the
RECREATE_ONERROR option.
432
LOCKING, NULL, NULL, NULL, NULL, NULL, RECREATE_ONERROR, -1,
SELECT * FROM LOCK

1. The XSR object Paul.EVMON_LOCKING_SCHEMA_SQL1000 does not exist.
2. As the RECREATE_ONERROR option was specified, the tables are dropped and
re-created.
Example 7: Using the previous relational tables on a release update
Greg has upgraded to a new DB2 release. Greg calls the procedure with the
xsrobjectname value from the previous release.
LOCKING, NULL, EVMON_LOCKING_SCHEMA_SQL09070, NULL, NULL, NULL, NULL, -1,
SELECT * FROM LOCK
Example 8: Using the UPGRADE_TABLES and PRUNE_UE_TABLE options

Paul created a unit of work event monitor in V9.7 that writes its output to a UE
table called UOWTABLE. He then upgrades to V10.1 and wants the relational
tables produced in the previous release by EVMON_FORMAT_UE_TO_TABLES to
be upgraded using the UPGRADE_TABLES option which occurs before the new data is
processed. Furthermore he wants to have the records from UOWTABLE deleted
using the PRUNE_UE_TABLE option after they have been processed.
UOW, NULL, EVMON_UOW_SCHEMA_SQL09070, NULL, NULL, NULL,
UPGRADE_TABLES;PRUNE_UE_TABLE, -1,
SELECT * FROM UOWTABLE
Note: In this example, the value 'EVMON_UOW_SCHEMA_SQL09070' must be

specified for the xsrobjectname parameter, since
'EVMON_UOW_SCHEMA_SQL09070' is the name of the XSR object that was used
in the most recent release where EVMON_FORMAT_UE_TO_TABLES was run to
create relational tables from a UE table.
There is no output from the procedure except the SQLCA. The SQLCA indicates
the completion status. The possible SQLCODES are:
0
All events were successfully inserted into the relational tables.
16278
One or more events were not inserted into the relational tables. The tokens
within the SQLCA contain the total number of documents that were
attempted and the total number of documents that succeeded
decomposition.
A diagnostic file is also created; and the name and location of that
diagnostic file is stored in the db2diag log files, located in the DB2
diagnostic path.
negative sqlcode
An error has occurred, and investigating the SQLCODE message can
provide additional details regarding the failure. For additional diagnostic
messages, see the db2diag log files located in the DB2 diagnostic path.
433
EVMON_FORMAT_UE_TO_XML table function - convert unformatted events to

XML:
The EVMON_FORMAT_UE_TO_XML table function extracts binary events from an
unformatted event table and formats them into an XML document.
Syntax
EVMON_FORMAT_UE_TO_XML (
FOR EACH ROW OF (
options ,
fullselect-statement

)

options
An input argument of type VARCHAR(1024) that represents a list of keyword
options supported by this table function.
LOG_TO_FILE
Indicates that the table function is to write the XML document to a file
if the XML document is greater than 100 MB. The maximum size of
each document returned by this table function per row is 100 MB. The
file is written to the <xml_document_id>.xml file, where
<xml_document_id> is the unique ID generated for each document. The
output file is written to the DB2 diagnostic path directory.
LOG_PARTIAL_EVENTS
Indicates that the table function is to write all partial (incomplete)
events to a file. See the Usage notes on page 436 section of this topic
for more information about partial events.
NULL No options selected.
fullselect-statement
The fullselect statement is a query that conforms to the rules of the SELECT
statement. The query must follow the following rules:
v The query must use the "*" clause or specify all the columns of the
unformatted event table. Otherwise an error is returned. The columns must
be specified in the same order as returned by the DESCRIBE statement of
the unformatted event table.
v The query must select only from an unformatted event table.
v The WHERE clause can use any of the non-LOB columns of the unformatted
event table to filter out events.
v The SELECT statement must be specified by the keyword FOR EACH
ROWS OF, enclosed in brackets.
Authorization
EXECUTE privilege on the EVMON_FORMAT_UE_TO_XML function.
SELECT privilege on the unformatted event table.
434

Examples
Example 1: Query all events from the unformatted event table MYLOCKS.
SELECT evmon.* FROM TABLE (
NULL,
FOR EACH ROW OF (
select * from MYLOCKS
order by EVENT_TIMESTAMP )))
AS evmon;
Example 2: Query all events of type LOCKWAIT that have occurred in the last 5
hours from the unformatted event table LOCK.
NULL,
FOR EACH ROW OF (
select * from LOCK order by EVENT_TIMESTAMP
where EVENT_TYPE = LOCKWAIT
and EVENT_TIMESTAMP >= CURRENT_TIMESTAMP - 5 hours )))
AS evmon;
Example 3: Get all events that belong to workload PAYROLL that occurred in the
last 32 hours from the unformatted event table UOW. Write the result to a file if
any document is greater than 100 MB.
EVMON_FORMAT_UE_TO_XML(
LOG TO FILE,
FOR EACH ROW OF (
select * from UOW order by EVENT_TIMESTAMP
where WORKLOAD_NAME = PAYROLL
and EVENT_TIMESTAMP = CURRENT_TIMESTAMP - 32 hours )))
AS evmon;
Example 4: Query all unit of work events from the UOWEVMON table, and use
the XMLTABLE table function to present the UOW ID, UOW start and stop times,
and the user ID for the person who issued the unit of work.
SELECT EVENT.UOW_ID, EVENT.APPLICATION_ID, EVENT.SESSION_AUTHID,
EVENT.START_TIME, EVENT.STOP_TIME
FROM TABLE(
EVMON_FORMAT_UE_TO_XML(
LOG TO FILE,
FOR EACH ROW OF(
select * from UOWEVMON )))
AS UEXML,
XMLTABLE(
XMLNAMESPACES( DEFAULT http://www.ibm.com/xmlns/prod/db2/mon ),
$uowevent/db2_uow_event
PASSING XMLPARSE( DOCUMENT UEXML.XMLREPORT ) as "uowevent"
COLUMNS UOW_ID INTEGER PATH uow_id,
MEMBER SMALLINT PATH @member,
APPLICATION_ID VARCHAR(128) PATH application_id,
SESSION_AUTHID VARCHAR(128) PATH session_authid,
START_TIME TIMESTAMP PATH start_time,
STOP_TIME TIMESTAMP PATH stop_time
)
AS EVENT
435
Usage notes
Impact of the EVMON_FORMAT_UE_TO_XML table function on memory
usage
Depending on the event monitor type that produced the UE table, the
EVMON_FORMAT_UE_TO_XML table function might map multiple
records from the unformatted event table into a single event. In such a
case, the records are cached in memory until all the records that make up
the event are received. A larger memory requirement might result if the
records passed into the table function are not in the order they were
created and inserted into the table. If the records are not sorted in this
manner, the table function must cache records for multiple events. To avoid
this issue, qualify the fullselect-statement parameter with an ORDER BY
clause that contains the following columns: EVENT_ID,
EVENT_TIMESTAMP, EVENT_TYPE, and MEMBER. Memory consumption
is reduced because at any particular time, the table function is processing
and caching records from only a single event.
Relationship of records in a UE table to the output of the
There is not a one-to-one mapping between the records written to the UE
table and the output of the EVMON_FORMAT_UE_TO_XML table
function. Some events generate multiple records in the UE table; some
result in just one record being added. The EVMON_FORMAT_UE_XML
table function always combines all records from a UE table that describe a
single event into one XML document.
Partial events
If partial or incomplete events exist in the UE table, a message (SQL443N)
is returned when you run EVMON_FORMAT_UE_TO_XML, whether or
not you specify the LOG_PARTIAL_EVENTS option. Incomplete events can
occur when an agent finishes processing before the entire event record can
be inserted in to the UE table. This situation can sometimes arise where
locking is involved, particularly in partitioned database environments. For
example, when the LOCKWAIT threshold is exceeded, details about the
holder of the lock are written to the UE table. However, details about
agents waiting for a lock on the same object are not captured until the lock
times out or the waiter acquires the lock. If
EVMON_FORMAT_UE_TO_XML is run before the agent waiting for the
lock has written its information, then only a part of the information about
the lock might exist in the UE table.
When you specify the LOG_PARTIAL_EVENTS option, incomplete events in the
UE table are written to a separate XML document. In addition, a message is
written to the db2diag log filesindicating that an incomplete event took
place. The message specifies the file name of the XML document that
contains details about the incomplete event. The XML documents produced
can be formatted using the db2evmonfmt tool.
Table 110. Information returned for EVMON_FORMAT_UE_TO_XML.
Column Name
Data Type
Description or corresponding monitor element
XMLID
VARCHAR(1024)
xmlid - XML ID monitor element
436
Table 110. Information returned for EVMON_FORMAT_UE_TO_XML. (continued)

Column Name
Data Type
XMLREPORT
BLOB(100M)
An XML document containing a single complete

event. Each document has a maximum size of 100
MB.
EVMON_UPGRADE_TABLES procedure - Upgrade event monitor target tables:

The EVMON_UPGRADE_TABLES procedure alters event monitor target SQL or
unformatted event tables to accommodate new or changed monitoring elements
that have been added since the event monitor was created.
Syntax
EVMON_UPGRADE_TABLES (
evmon_name
,
options , num_evmons_evaluated
,
num_evmons_to_upgrade ,
evmon_type
num_evmons_upgraded


evmon_name
event monitor for which existing table definitions are to be upgraded. The
event monitor target type must be table or unformatted event table. If
evmon_name is specified, any evmon_type argument is ignored.
The name may be a pattern-expression similar to that used in the LIKE
predicate which means it can include underscore (_) or percent (%) characters
as wild card characters. For more information about the LIKE predicate, see
LIKE predicate. If the pattern-expression needs to include either the underscore
or the percent character, the escape option is used to specify a character to
precede either the underscore or the percent character in the pattern.
If evmon_name is not provided or set to NULL, all event monitors with table or
unformatted event table output targets will be processed, subject to criteria
supplied by the other input parameters.
evmon_type
An input argument of type VARCHAR(128) that specifies the type of event
monitor for which existing table definitions are to be upgraded. The type
specified must be one of the values in the TYPE column of SYSCAT.EVENTS.
Refer to SYSCAT.EVENTS catalog view for details. Any event monitor for this
event type and having target type of table or unformatted event table will be
evaluated for upgrading. If evmon_type is specified, evmon_name must be
NULL. If evmon_type is not provided or set to NULL, all types of event
monitors will be evaluated, subject to the criteria supplied by the other input
parameters.
options
An input argument of type CLOB(8K) that enables you to specify one or more
437
event monitor upgrade settings. This parameter defaults to NULL. Settings are
specified as name value pairs using the format:
<setting name tag>value</setting name tag>
Each setting can be specified a maximum of one time. Setting names are case
sensitive. The setting values are case insensitive unless otherwise noted. The
available setting name tags are as follows.
v '<tbspaceName>value</tbspaceName>'
Specifies the name of a table space into which any new groups are to be
created. This value is case sensitive. If this is not specified and an event
monitor's current target tables are all in the same table space then any new
table will be created in that same table space (so that all tables are in the
same table space). Otherwise the algorithm for picking a table space as
described for the "IN" clause for "CREATE EVENT MONITOR" is used (see
CREATE EVENT MONITOR statement).
v '<createNewGroups>value</createNewGroups>'
Specifies whether or not new groups are to be created. The value can be
either "yes" or "no". If not specified it defaults to "yes" and any new group
will be created for an event monitor being upgraded.
v '<verbose>value</verbose>'
Specifies whether or not to return diagnostics from the stored procedure as a
result set. The value can be either "yes" or "no". If not specified it defaults to
"yes" and diagnostics are return in the result set. If "no" is specified no result
set is passed back. Note that a user temporary table space must exist in
order for the stored procedure to return a result set. See Table 1 for result
set.
v '<force>value</force>'
Specifies whether or not to force the checking of event monitors to
determine if upgrading is required. If not specified it defaults to "no". When
"no" is specified the VERSIONNUMBER column of
SYSCAT.EVENTMONITORS is checked; if its value equals the current
version then the event monitor is considered up to date. If "yes" is specified
the VERSIONNUMBER column of SYSCAT.EVENTMONITORS is ignored
and the event monitor's tables are rechecked to see if upgrading is required
or if new tables are to be added. Setting force to yes is useful when an event
monitor which has had a new event group added to it has already been
upgraded once using the createNewGroups option with a value of NO and
the need is to force that event monitor to be upgraded again so that a new
table is created for the new event group.
v '<escape>char</escape>'
Specifies a character to be used to modify the special meaning of the
underscore (_) and percent (%) characters in the pattern-expression of the
evmon_name. This allows the evmon_ name to be used to match values that
contain the actual percent and underscore characters. If this option is not
specified no escape character is provided.
num_evmons_evaluated
This output parameter of type INTEGER returns the number of event monitors
that were checked by the stored procedure to determine if their tables required
upgrading.
num_evmons_to_upgrade
This output parameter of type INTEGER returns the total number of event
438
monitors that had at least one target table that actually required upgrading.
This includes event monitors having new or modified elements or new event
groups.
num_evmons_upgraded
This output parameter of type INTEGER returns the total number of event
monitors whose target tables that were successfully upgraded or created.
Authorization
DBADM authority is required to execute the function.
None
Usage notes
v If evmon_name and evmon_type are both NULL, then the stored procedure will
scan the SYSCAT. EVENTTABLES catalog table and check each TABLE and UE
Table event monitor to see if it's target tables require upgrading.
v The VERSIONNUMBER column of SYSCAT.EVENTMONITORS contains the
version, release, and modification level in which the event monitor was created
or last upgraded. An event monitor target table is considered to require
upgrading if columns were added or modified between the VERSIONNUMBER
and the current release. That is, only changes made between these releases will
be taken into consideration.
During database upgrade if the VERSIONNUMBER column is not filled in it
will be filled with the release number from which the event monitor is being
upgraded.
If evmon_upgrade_tables processes an event monitor and that event monitor
requires no changes then VERSIONNUMBER is updated to the current level.
This makes it easy to see which event monitors have been processed.
v If evmon_type is specified then the stored procedure will scan the
SYSCAT.EVENTTABLES catalog table and check each event monitor that records
that event type to see if it's target tables require upgrading. If an event monitor
can record more than one event type and one of its types is selected for
upgrading then only the tables for that type are checked and upgraded if
necessary. For example, if an event monitor is created CREATE EVENT
MONITOR SAMPLE_EVMON FOR CONNECTIONS, STATEMENTS WRITE TO
TABLE and CONNECTIONS is specified for the evmon_type, then only groups
CONTROL, CONNHEADER and CONN are checked; STMT and SUBSECTION
are skipped but the event monitor version number is updated regardless. If later
it was required to upgrade the statement event tables, then the force option
would need to be used.
v Before a table is checked for an upgrade, it is first validated with the same rules
used when an event monitor activates. This validation ensures that each column
name matches a monitor element name, that the data type for each column is
compatible with that element, and that, in a partitioned database environment,
the first column of the table is PARTITION_KEY.
v For any event monitor with tables that require upgrading:
If the event monitor is active it is deactivated (the procedure waits for queued
events to drain first) and exclusive locks are acquired on its target tables. If a
table cannot be locked after 3 seconds of waiting processing moves to the
next event monitor.
439
While a table for an event monitor is being upgraded, new events for that
event monitor are lost.
The tables are altered to drop columns or add or modify columns to make
them up to date. If the '<createNewGroups>yes</createNewGroups>' option
is specified any new tables are created.
- If a table column is altered or dropped all dependent objects will be
invalidated. When these dependent objects are revalidated will be affected
by the AUTO_REVAL database configuration parameter setting. See the
documentation for more details about auto_reval.
If necessary, a table reorg is performed to make the table usable.
The exclusive table lock(s) are released.
If all the tables for an event monitor were successfully upgraded the
VERSIONNUMBER column in SYSCAT.EVENTMONITORS is updated to the
current version number and a COMMIT is issued. Otherwise the unit of work
is rolled back.
If an event monitor had been deactivated by the stored procedure, it will
reactivated after the stored procedure has completed processing.
v If the INCLUDES clause was specified on the CREATE EVENT MONITOR
statement when an event monitor table was created it is skipped. Check the
TABOPTIONS column of SYSCAT.EVENTTABLES to determine if INCLUDES
was specified. Note that if an event monitor was created before Version 10.1 and
utilized INCLUDES this information is lost and the TABOPTIONS column will
contain a blank.
v If the EXCLUDES clause was specified on the CREATE EVENT MONITOR
statement when an event monitor table was created it is a candidate for
upgrading. The table will be modified to accommodate changes since the event
monitor was created. Check the TABOPTIONS column of
SYSCAT.EVENTTABLES to determine if EXCLUDES was specified. Note that if
an event monitor was created before Version 10.1 and utilized EXCLUDES this
information is lost and the TABOPTIONS column will contain a blank.
v The procedure will not return any errors encountered while processing the
individual event monitor target tables.
v If a result set is to be returned (see Procedure parameters on page 437), keep
the following information in mind:
A user temporary table space must exist before you run the
EVMON_UPGRADE_TABLES procedure.
The table used for the result set is named
SESSION.EVMON_UPGRADE_TABLES_RESULTSET.
If SESSION.EVMON_UPGRADE_TABLES_RESULTSET already exists from a
previous execution of EVMON_UPGRADE_TABLES in the same session, the
new results will be appended to the existing table. If the table definition has
changed in any way since the existing table was created, it is dropped, and a
new version of the table is created.
SESSION.EVMON_UPGRADE_TABLES_RESULTSET is dropped
automatically when with the connection over which
EVMON_UPGRADE_TABLES runs is dropped. The user temporary table
space used for the table cannot be dropped until the
SESSION.EVMON_UPGRADE_TABLES_RESULTSET table is dropped.
Example
A user created the following event monitors in DB2 Version 9.7:
440
create event monitor lock for locking write to unformatted event table
create event monitor act for activities write to table control (in
actspace), activity (in actspace), activitystmt (in actspace), activityvals
(in actspace)
create event monitor stat for statistics write to table
create event monitor conn for connections write to table
After upgrading the database to the current release they upgrade all the event
monitor tables using the following command:
call evmon_upgrade_tables(null, null, null, ?, ?, ?)
If instead they only wanted to upgrade act, they could use this command:
call evmon_upgrade_tables(ACT, null, null, ?, ?)
Alternatively they could choose to upgrade only the activities event monitors by
using this command:
call evmon_upgrade_tables(null,ACTIVITIES, null, ?, ?, ?)
Table 111 describes the information returned in the result set if you choose to have
it created.
Table 111. Information returned by EVMON_UPGRADE_TABLES to table
SESSION.EVMON_UPGRADE_TABLES_RESULTSET
Column name
Data type
EVMON_NAME
VARCHAR(128)
Name of the event monitor for which this diagnostic

message applies.
EVMON_TYPE
VARCHAR(128)
Event type of the event monitor for which this

diagnostic message applies.
MESSAGE_TIME
TIMESTAMP
message_time - Timestamp Control Table Message

monitor element
MESSAGE_TEXT
VARCHAR(1024)
Diagnostic message.
MON_CAPTURE_ACTIVITY_IN_PROGRESS procedure - Collect activity

information for activities event monitor:
The MON_CAPTURE_ACTIVITY_IN_PROGRESS procedure gathers information
about a specified activity and writes the information to the active activities event
monitor.
When you apply this procedure to an activity with child activities, the procedure
recursively generates a record for each child activity. This information is collected
and sent when you call the procedure; the procedure does not wait until the parent
activity completes execution. The record of the activity in the event monitor is
marked as a partial record.
Authorization
v DBADM authority
v SQLADM authority
441
v WLMADM authority
None
Syntax
MON_CAPTURE_ACTIVITY_IN_PROGRESS (
uow_id ,
application_handle
activity_id )


If you do not specify all of the following parameters, no activity is found, and an
SQL0171N error with SQLSTATE 42815 is returned.
application_handle
An input argument of type BIGINT that specifies the handle of the application
whose activity information is to be captured.
uow_id
An input argument of type INTEGER that specifies the unit of work ID of the
activity whose information is to be captured.
activity_id
An input argument of type INTEGER that specifies the activity ID that
uniquely identifies the activity within the unit of work whose information is to
be captured.
Usage notes
v If there is no active activities event monitor, an SQL1633W error with SQLSTATE
01H53 is returned.
v Activity information is collected only on the coordinator member for the activity.
Example
Assume that a user complains that stored procedure MYSCHEMA.MYSLOWSTP
seems to be running slower than usual. The administrator wants to investigate the
cause of the slowdown. Investigating while the stored procedure is running is not
practical, so the administrator decides to capture information about the stored
procedure activity and all of the activities nested within it.
An event monitor for DB2 activities named DB2ACTIVITIES has been activated.
The administrator uses the MON_GET_ACTIVITY function to obtain the
application handle, unit of work ID, and activity ID for the call of this stored
procedure. Assuming that the activity is identified by an application handle of 1, a
unit of work ID of 2, and an activity ID of 3, the administrator can now issue the
call to MON_CAPTURE_ACTIVITY_IN_PROGRESS as follows:
CALL MON_CAPTURE_ACTIVITY_IN_PROGRESS(1,2,3)
After the procedure is completed, the administrator can use the following table
function to find out where the activity spent its time. The function retrieves the
information from the DB2ACTIVITIES event monitor.
442
CREATE FUNCTION SHOWCAPTUREDACTIVITY(APPHNDL BIGINT,

UOWID INTEGER,
ACTIVITYID INTEGER)
RETURNS TABLE (UOW_ID INTEGER, ACTIVITY_ID INTEGER, STMT_TEXT VARCHAR(40),
LIFE_TIME DOUBLE)
LANGUAGE SQL
READS SQL DATA
NO EXTERNAL ACTION
DETERMINISTIC
RETURN WITH RAH (LEVEL, APPL_ID, PARENT_UOW_ID, PARENT_ACTIVITY_ID,
UOW_ID, ACTIVITY_ID, STMT_TEXT, ACT_EXEC_TIME) AS
(SELECT 1, ROOT.APPL_ID, ROOT.PARENT_UOW_ID,
ROOT.PARENT_ACTIVITY_ID, ROOT.UOW_ID, ROOT.ACTIVITY_ID,
ROOTSTMT.STMT_TEXT, ACT_EXEC_TIME
FROM ACTIVITY_DB2ACTIVITIES ROOT, ACTIVITYSTMT_DB2ACTIVITIES ROOTSTMT
WHERE ROOT.APPL_ID = ROOTSTMT.APPL_ID AND ROOT.AGENT_ID = APPHNDL
AND ROOT.UOW_ID = ROOTSTMT.UOW_ID AND ROOT.UOW_ID = UOWID
AND ROOT.ACTIVITY_ID = ROOTSTMT.ACTIVITY_ID AND ROOT.ACTIVITY_ID = ACTIVITYID
UNION ALL
SELECT PARENT.LEVEL +1, CHILD.APPL_ID, CHILD.PARENT_UOW_ID,
CHILD.PARENT_ACTIVITY_ID, CHILD.UOW_ID,
CHILD.ACTIVITY_ID, CHILDSTMT.STMT_TEXT, CHILD.ACT_EXEC_TIME
FROM RAH PARENT, ACTIVITY_DB2ACTIVITIES CHILD,
ACTIVITYSTMT_DB2ACTIVITIES CHILDSTMT
WHERE PARENT.APPL_ID = CHILD.APPL_ID AND
CHILD.APPL_ID = CHILDSTMT.APPL_ID AND
PARENT.UOW_ID = CHILD.PARENT_UOW_ID AND
CHILD.UOW_ID = CHILDSTMT.UOW_ID AND
PARENT.ACTIVITY_ID = CHILD.PARENT_ACTIVITY_ID AND
CHILD.ACTIVITY_ID = CHILDSTMT.ACTIVITY_ID AND
PARENT.LEVEL < 64
)
SELECT UOW_ID, ACTIVITY_ID, SUBSTR(STMT_TEXT,1,40),
ACT_EXEC_TIME AS
LIFE_TIME
FROM RAH
The following sample query uses the table function:

SELECT * FROM TABLE(SHOWCAPTUREDACTIVITY(1, 2, 3))
AS ACTS ORDER BY UOW_ID, ACTIVITY_ID
MON_COLLECT_STATS procedure - Collect and reset statistics for workload

management objects and operating system resources:
The MON_COLLECT_STATS procedure gathers or resets statistics for service
classes, workloads, work classes, threshold queues, and operating system
resources. If there is an active statistics event monitor, writes them to the statistics
event monitor.
Authorization
v
v
v
v
v
EXECUTE privilege on the routine

DBADM authority
SQLADM authority
WLMADM authority

None
443
Syntax
MON_COLLECT_STATS (
)
wait
, statistics_timestamp

Routine parameters
wait
An optional input argument of type CHAR that specifies whether this
procedure returns immediately after initiating a statistics collection and reset. If
'Y' is specified, then the procedure will not return until all statistics have been
written and flushed to the statistics event monitor tables. Otherwise, the
procedure will return immediately after initiating a statistics collection and
reset.
statistics_timestamp
An optional output argument of type TIMESTAMP that returns the timestamp
value for the beginning of the statistics collection.
Usage notes
The MON_COLLECT_STATS procedure performs the same collection operation
(send statistics to the active statistics event monitor) and reset operation that occur
automatically on the interval defined by the wlm_collect_int database
configuration parameter.
If you call the procedure while another collection and reset request is in progress
(for example, while another invocation of the procedure is running or automatic
collection is occurring), SQL1632W with SQLSTATE 01H53 is returned, and your
new request is ignored.
In asynchronous mode, the MON_COLLECT_STATS procedure only starts the
collection and reset process. The procedure might return to the caller before all
statistics have been written to the active statistics event monitor. Depending on
how quickly the statistics collection and reset occur, the call to the
MON_COLLECT_STATS procedure (which is itself an activity) is counted in the
statistics for either the prior collection interval or the new collection interval that
has just started.
In synchronous mode, the MON_COLLECT_STATS procedure does not return until
the statistics collection is complete and all statistics are written to the tables of any
active statistics event monitors. The timestamp at which the statistics collection
began is returned via the statistics_timestamp output parameter.
Examples
1. Call MON_COLLECT_STATS to initiate statistics collection and reset.
CALL MON_COLLECT_STATS()

Return Status = 0
2. Call MON_COLLECT_STATS to collect and reset statistics, and return only

when data has been written to statistics event monitor tables.
CALL MON_COLLECT_STATS(Y, ::collect_timestamp)
444

Return Status = 0
3. Call MON_COLLECT_STATS to collect and reset statistics while another call is

in progress.
CALL MON_COLLECT_STATS()

SQL1632W The collect and reset statistics request was ignored because
another collect and reset statistics request is already in progress.
MON_FORMAT_LOCK_NAME - Format the internal lock name and return

details:
The MON_FORMAT_LOCK_NAME table function formats the internal lock name
and returns details regarding the lock in a row-based format. Each returned row
consists of a key-value pair relevant for that particular lock.
To get information about locks, use the MON_FORMAT_LOCK_NAME,
MON_GET_LOCKS, and, MON_GET_APPL_LOCKWAIT table functions instead of
the SNAPLOCKWAIT administrative view and SNAP_GET_LOCKWAIT table
function, and the SNAPLOCK administrative view and SNAP_GET_LOCK table
function, which are deprecated in Fixpack 1 of Version 9.7.
MON_FORMAT_LOCK_NAME (
lockname

lockname
An input argument of type VARCHAR(32) that specifies the internal binary
name of the lock that is to be formatted. A NULL value results in error
SQL0171N being returned.
Authorization
v DBADM authority
v SQLADM authority
None
Examples
The internal lock name is returned in a variety of situations, such as being written
to the db2diag log files, or as the value of the lock_name monitor element. The
following example shows how to use the MON_FORMAT_LOCK_NAME table
function to find out further information about the lock, in this case with a lock
name of 0000000E00000000000B00C152.
445
SELECT SUBSTR(NAME,1,20) AS NAME,

SUBSTR(VALUE,1,50) AS VALUE
FROM
TABLE( MON_FORMAT_LOCK_NAME(0000000E00000000000B00C152)) as LOCK
The following output is returned:

NAME
-------------------LOCK_OBJECT_TYPE
ROWID
DATA_PARTITION_ID
PAGEID
TBSP_NAME
VALUE
------------ROW
0
49408
184549376
SYSCATSPACE
Table 112. Information returned by the MON_FORMAT_LOCK_NAME table function
Column name
Data type
Description
NAME
VARCHAR(256)
Element of the lock name.

See following table for more
details.
VALUE
VARCHAR(1024)
Value of the element.
Not all elements that make up the specified lock name are returned; only those
key-value pairs that are relevant are returned.
The elements that can be returned are as follows:
Table 113. Monitor elements that can be returned
446
Possible values or monitor

element
Element name
Description
LOCK_OBJECT_TYPE
lock_object_type - Lock
object type waited on
monitor element
object type
DATA_PARTITION_ID
data_partition_id - Data
partition identifier monitor
element
data_partition_id - Data
partition identifier
TBSP_NAME
The name of a table space
tablespace_name - Table
space name
TABSCHEMA
table_schema - Table schema


name
TABNAME
table_name - Table name

monitor element
ROWID
Row ID of the table
PAGEID
The page ID
WORKLOAD_NAME
workload_name - Workload
name
STORAGE_GRP_ID
The storage group ID
For possible values, see

monitor element.
Table 113. Monitor elements that can be returned (continued)

Element name
Description
Possible values or monitor

element
BUFFERPOOL_NAME
Name of the buffer pool
FED_SERVER_NAME
Name of the federation

server
FED_USER_NAME
Name of the federation user

mapping
SEQ_OPERATION
Operation requesting a
sequence lock
Possible values are:

v AUTONOMIC_POLICIES
v CATALOG_ARRAY
v DESCRIBE
v INIT_EVMON
v INIT_PACKAGE
v INIT_AUDIT
v PACKAGE_CREATION
v INIT_ROUTINE_ID
v INIT_ROLE_ID
v TEMP_TBSPACE
v AUDIT_DDL
v VERSION_TIMES
v WLM
v TRUSTED_CTX
v INIT_TRUSTED_CTX
v STATIC_STMT
v USER_TEMP_TBSPACE
CONTAINER_ID
container_id - Container
identification monitor
element
STMT_UID
The statement ID
PACKAGE_TOKEN
The package token
INTERNAL
Reserved for internal use
MON_FORMAT_XML_COMPONENT
_TIMES_BY_ROW - Get formatted row-based component times:
The MON_FORMAT_XML_COMPONENT_TIMES_BY_ROW table function returns
formatted row-based output for the component times contained in an XML metrics
document.
Syntax
MON_FORMAT_XML_COMPONENT_TIMES_BY_ROW (
xmldoc
447
Authorization
v
v
v
v

DBADM authority
SQLADM authority

None
Routine parameters
xmldoc
An input argument of type BLOB(8M) that contains an XML document with
either a system_metrics or activity_metrics element. XML documents with
these elements can be obtained from the following sources:
v Returned by one of the MON_GET_*_DETAILS table functions.
v From the metrics column output by statistics and activity event monitors.
v From the formatted output of the unit of work, or package cache event
monitors.
Table 114. Information returned for MON_FORMAT_XML_COMPONENT_TIMES_BY_ROW
Column Name
Data Type
Description
METRIC_NAME
VARCHAR(128)
The unique identifier for the total time metric value.
PROC_METRIC_NAME
VARCHAR(128)
The unique identifier for the processing time metric.
TOTAL_TIME_VALUE
BIGINT
The total time value in milliseconds corresponding to

metric_name.
PROC_TIME_VALUE
BIGINT
The processing time value in milliseconds corresponding

to proc_metric_name
COUNT
BIGINT
Number of occurrences of this type of interval.
PARENT_METRIC_NAME
VARCHAR(128)
The identifier of the parent total time metric whose value

contains the total_time_value as a subset
PARENT_PROC
_METRIC_NAME
VARCHAR(128)
The identifier of the parent processing time metric whose

value contains the proc_time_value as a subset
XML documents that contain an element of type system_metrics are generated from
the following interfaces:
v MON_GET_CONNECTION_DETAILS
v MON_GET_SERVICE_SUBCLASS_DETAILS
v MON_GET_UNIT_OF_WORK_DETAILS
v MON_GET_WORKLOAD_DETAILS
v DETAILS_XML column from a STATISTICS event monitor
v METRICS column produced by EVMON_FORMAT_UE_TO_TABLES for the
UNIT OF WORK event monitor
v XMLREPORT column of EVMON_FORMAT_UE_TO_XML for the UNIT OF
WORK event monitor
448
See Table 115 for the types of metrics and their parent metrics that are returned
from the XML document in this case:
Table 115. Metric names returned by MON_FORMAT_XML_COMPONENT_TIMES_BY_ROW for XML documents
containing a system_metrics element type
Parent Proc
Metric Name
Description of metric or Monitor

element
TOTAL_SECTION_
TIME
TOTAL_
SECTION_
PROC_TIME
total_col_time - Total
column-oriented time
TOTAL_COMMIT
_PROC_TIME
TOTAL_RQST
_TIME
TOTAL_RQST
_TIME
total_commit_time - Total commit

time
TOTAL
_COMPILE
_TIME
TOTAL_COMPILE
_PROC_TIME
TOTAL_RQST
_TIME
TOTAL_RQST
_TIME
total_compile_time - Total
compile time
TOTAL
_CONNECT
_AUTHENTICATION
_TIME
TOTAL
_CONNECT
_AUTHENTICATION
_PROC_TIME
TOTAL
_CONNECT
_REQUEST_TIME
TOTAL
_CONNECT
_REQUEST
_PROC_TIME
total_connect_
authentication_time - Total
connection or switch user
authentication request time
TOTAL
_CONNECT
_REQUEST_TIME
TOTAL
_CONNECT
_REQUEST
_PROC_TIME
TOTAL_RQST
_TIME
TOTAL_RQST
_TIME
total_connect_request_time - Total
connection or switch user request
time
TOTAL
_IMPLICIT
_COMPILE_TIME
TOTAL_IMPLICIT
_COMPILE
_PROC_TIME
TOTAL_RQST
_TIME
TOTAL_RQST
_TIME
total_implicit_compile_time Total implicit compile time
TOTAL_LOAD
_TIME
TOTAL_LOAD
_PROC_TIME
TOTAL_RQST
_TIME
TOTAL_RQST
_TIME
total_load_time - Total load time
TOTAL_REORG
_TIME
TOTAL_REORG
_PROC_TIME
TOTAL_RQST
_TIME
TOTAL_RQST
_TIME
total_reorg_time - Total
reorganization time
TOTAL
_ROLLBACK
_TIME
TOTAL_ROLLBACK
_PROC_TIME
TOTAL_RQST
_TIME
TOTAL_RQST
_TIME
total_rollback_time - Total
rollback time
TOTAL
_ROUTINE
_USER_CODE
_TIME
TOTAL_ROUTINE
_USER_CODE
_PROC_TIME
TOTAL_RQST
_TIME
TOTAL_RQST
_TIME
total_routine_user_code_time Total routine user code time
TOTAL_RQST
_TIME
NULL
NULL
NULL
total_rqst_time - Total request

time
TOTAL
_RUNSTATS
_TIME
TOTAL_RUNSTATS
_PROC_TIME
TOTAL_RQST
_TIME
TOTAL_RQST
_TIME
total_runstats_time - Total
runtime statistics
TOTAL_SECTION
_SORT_TIME
TOTAL_SECTION
_SORT_PROC_TIME
TOTAL_SECTION
_TIME
TOTAL
_SECTION
_PROC_TIME
total_section_sort_time - Total
section sort time
TOTAL
_SECTION
_TIME
TOTAL_SECTION
_PROC_TIME
TOTAL_RQST
_TIME
TOTAL_RQST
_TIME
total_section_time - Total section

time
TOTAL_STATS
_FABRICATION
_TIME
TOTAL_STATS
_FABRICATION
_PROC_TIME
TOTAL_COMPILE
_TIME
TOTAL
_COMPILE
_PROC_TIME
total_stats_fabrication_time Total statistics fabrication time
TOTAL_SYNC
_RUNSTATS
_TIME
TOTAL_SYNC
_RUNSTATS
_PROC_TIME
TOTAL_COMPILE
_TIME
TOTAL
_COMPILE
_PROC_TIME
total_sync_runstats_time - Total
synchronous runstats time
Metric Name
Proc Metric Name
Parent Metric Name
TOTAL_
COL_
TIME
TOTAL_COL_
PROC_TIME
TOTAL
_COMMIT
_TIME
XML documents that contain an element of type activity_metrics are generated from
449
MON_GET_ACTIVITY_DETAILS
MON_GET_PKG_CACHE_STMT_DETAILS
DETAILS_XML column from an ACTIVITY event monitor
METRICS column produced by EVMON_FORMAT_UE_TO_TABLES for the
PACKAGE CACHE event monitor
v XMLREPORT column of EVMON_FORMAT_UE_TO_XML for the PACKAGE
CACHE event monitor
v
v
v
v
Table 116. Metric names returned by MON_FORMAT_XML_COMPONENT_TIMES_BY_ROW for XML documents
containing an activity_metrics element type
Metric Name
Proc Metric Name
Parent Metric Name
Parent Proc Metric

Name
STMT_EXEC
_TIME
NULL
NULL
NULL
stmt_exec_time - Statement
execution time
TOTAL_
COL_
TIME
TOTAL_COL_
PROC_TIME
TOTAL_SECTION_
TIME
TOTAL_SECTION_
PROC_TIME
total_col_time - Total
column-oriented time
TOTAL_ROUTINE
_NON_SECT_TIME
TOTAL_ROUTINE
_NON_SECT
_PROC_TIME
TOTAL
_ROUTINE
_TIME
STMT_EXEC
_TIME
total_routine_non_sect_time Non-section routine execution time
TOTAL_ROUTINE
_TIME
NULL
STMT_EXEC
_TIME
NULL
total_routine_time - Total routine

time
TOTAL_ROUTINE
_USER_CODE_TIME
TOTAL_ROUTINE
_USER_CODE
_PROC_TIME
TOTAL
_ROUTINE
_NON_SECT
_TIME
TOTAL_
ROUTINE
_NON_SECT
_PROC_TIME
total_routine_user_code_time - Total
routine user code time
TOTAL_SECTION
_SORT_TIME
TOTAL_SECTION
_SORT_PROC
_TIME
TOTAL_SECTION
_TIME
TOTAL_SECTION
_PROC_TIME
total_section_sort_time - Total
section sort time
TOTAL_SECTION
_TIME
TOTAL_SECTION
_PROC_TIME
STMT_EXEC
_TIME
STMT_EXEC
_TIME
total_section_time - Total section

time
Description or Monitor element
Example
The following example returns the breakdown of component times within the DB2
database manager for service subclasses, which shows both the total time spent in
any given component, as well as the amount of time that was actually spent
processing, rather than waiting, in a component.
SELECT SUBSTR(T.SERVICE_SUPERCLASS_NAME,1,19) AS SUPERCLASS,
SUBSTR(T.SERVICE_SUBCLASS_NAME,1,19) AS SUBCLASS,
T.MEMBER,
SUBSTR(COMP.METRIC_NAME,1,15) AS METRIC_NAME
SUBSTR(COMP.PARENT_METRIC_NAME,1,15) AS PARENT_NAME
COMP.TOTAL_TIME_VALUE AS TOTAL_TIME,
COMP.PROC_TIME_VALUE AS TOTAL_PROC_TIME,
COMP.COUNT
FROM TABLE (MON_GET_SERVICE_SUBCLASS_DETAILS(NULL,
NULL,-2)) AS T,
TABLE(MON_FORMAT_XML_COMPONENT_TIMES_BY_ROW(
T.DETAILS
)) AS COMP
WHERE COMP.PARENT_METRIC_NAME IS NOT NULL;
450
SUPERCLASS
------------------MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
SUBCLASS
MEMBER METRIC_NAME
PARENT_NAME
...
------------------ ------ --------------- ---------------...
MYSSC
0 TOTAL_COMPILE_T TOTAL_RQST_TIME...
MYSSC
0 TOTAL_IMPLICIT_ TOTAL_RQST_TIME...
MYSSC
0 TOTAL_SECTION_T TOTAL_RQST_TIME...
MYSSC
0 TOTAL_COMMIT_TI TOTAL_RQST_TIME...
MYSSC
0 TOTAL_ROLLBACK_ TOTAL_RQST_TIME...
MYSSC
0 TOTAL_RUNSTATS_ TOTAL_RQST_TIME...
MYSSC
0 TOTAL_REORG_TIM TOTAL_RQST_TIME...
MYSSC
0 TOTAL_LOAD_TIME TOTAL_RQST_TIME...
MYSSC
0 TOTAL_SECTION_S TOTAL_SECTION_T...
The following is a continuation of sample output from this query.

...TOTAL_TIME
TOTAL_PROC_TIME
COUNT
...-------------------- -------------------- -------------------...
100
100
1
...
0
0
0
...
1253
953
0
...
213
153
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
MON_FORMAT_XML_METRICS_BY_ROW - Get formatted row-based output

for all metrics:
The MON_FORMAT_XML_METRICS_BY_ROW table function returns formatted
row-based output for all metrics contained in an XML metrics document.
Authorization
v DBADM authority
v SQLADM authority
None
Syntax
MON_FORMAT_XML_METRICS_BY_ROW (
xmldoc

Routine parameters
xmldoc
451

monitors.
Table 117. Information returned for MON_FORMAT_XML_METRICS_BY_ROW
Column Name
Data Type
Description
METRIC_NAME
VARCHAR(128)
VALUE
BIGINT
The current value of the metric.
WORK event monitor
See Table 118 for the types of metrics that are returned from the XML document in
this case:
Table 118. Metric names returned by MON_FORMAT_XML_METRICS_BY_ROW for XML documents containing a
system_metrics element type
Metric Name
Description of metric or Monitor element
ACT_ABORTED_TOTAL
act_aborted_total - Total aborted activities
ACT_COMPLETED_TOTAL
act_completed_total - Total completed activities
ACT_REJECTED_TOTAL
act_rejected_total - Total rejected activities
ACT_RQSTS_TOTAL
act_rqsts_total - Total activity requests
AGENT_WAIT_TIME
agent_wait_time - Agent wait time
AGENT_WAITS_TOTAL
agent_waits_total - Total agent waits
APP_ACT_ABORTED_TOTAL
app_act_aborted_total - Total failed external coordinator activities
APP_ACT_COMPLETED_TOTAL
app_act_completed_total - Total successful external coordinator

activities
APP_ACT_REJECTED_TOTAL
app_act_rejected_total - Total rejected external coordinator activities
APP_RQSTS_COMPLETED_TOTAL
app_rqsts_completed_total - Total application requests completed
AUDIT_EVENTS_TOTAL
audit_events_total - Total audit events
AUDIT_FILE_WRITE_WAIT_TIME
audit_file_write_wait_time - Audit file write wait time
AUDIT_FILE_WRITES_TOTAL
audit_file_writes_total - Total audit files written
AUDIT_SUBSYSTEM_WAIT_TIME
audit_subsystem_wait_time - Audit subsystem wait time
452
system_metrics element type (continued)
Metric Name
AUDIT_SUBSYSTEM_WAITS_TOTAL
audit_subsystem_waits_total - Total audit subsystem waits
CAT_CACHE_INSERTS
cat_cache_inserts - Catalog cache inserts
CAT_CACHE_LOOKUPS
cat_cache_lookups - Catalog cache lookups
CF_WAIT_TIME
cf_wait_time - cluster caching facility wait time
CF_WAITS
cf_waits - Number of cluster caching facility waits
CLIENT_IDLE_WAIT_TIME
client_idle_wait_time - Client idle wait time
COMM_EXIT_WAIT_TIME
comm_exit_wait_time - Communication buffer exit wait time

monitor element
COMM_EXIT_WAITS
comm_exit_waits - Communication buffer exit number of waits

monitor element
DEADLOCKS
deadlocks - Deadlocks detected
DIAGLOG_WRITE_WAIT_TIME
diaglog_write_wait_time - Diagnostic log file write wait time
DIAGLOG_WRITES_TOTAL
diaglog_writes_total - Total diagnostic log file writes
DIRECT_READ_REQS
direct_read_reqs - Direct read requests
DIRECT_READ_TIME
direct_read_time - Direct read time
DIRECT_READS
direct_reads - Direct reads from database
DIRECT_WRITE_REQS
direct_write_reqs - Direct write requests
DIRECT_WRITE_TIME
direct_write_time - Direct write time
DIRECT_WRITES
direct_writes - Direct writes to database
DISABLED_PEDS
disabled_peds - Disabled partial early distincts
EVMON_WAIT_TIME
evmon_wait_time - Event monitor wait time
EVMON_WAITS_TOTAL
evmon_waits_total - Event monitor total waits
FCM_MESSAGE_RECV_VOLUME
fcm_message_recv_volume - FCM message received volume
FCM_MESSAGE_RECV_WAIT_TIME
fcm_message_recv_wait_time - FCM message received wait time
FCM_MESSAGE_RECVS_TOTAL
fcm_message_recvs_total - Total FCM message receives
FCM_MESSAGE_SEND_VOLUME
fcm_message_send_volume - FCM message send volume
FCM_MESSAGE_SEND_WAIT_TIME
fcm_message_send_wait_time - FCM message send wait time
FCM_MESSAGE_SENDS_TOTAL
fcm_message_sends_total - Total FCM message sends
FCM_RECV_VOLUME
fcm_recv_volume - FCM received volume
FCM_RECV_WAIT_TIME
fcm_recv_wait_time - FCM received wait time
FCM_RECVS_TOTAL
fcm_recvs_total - FCM receives total
FCM_SEND_VOLUME
fcm_send_volume - FCM send volume
FCM_SEND_WAIT_TIME
fcm_send_wait_time - FCM send wait time
FCM_SENDS_TOTAL
fcm_sends_total - FCM sends total
FCM_TQ_RECV_VOLUME
fcm_tq_recv_volume - FCM table queue received volume
FCM_TQ_RECV_WAIT_TIME
fcm_tq_recv_wait_time - FCM table queue received wait time
FCM_TQ_RECVS_TOTAL
fcm_tq_recvs_total - FCM table queue receives total
FCM_TQ_SEND_VOLUME
fcm_tq_send_volume - FCM table queue send volume
FCM_TQ_SEND_WAIT_TIME
fcm_tq_send_wait_time - FCM table queue send wait time
FCM_TQ_SENDS_TOTAL
fcm_tq_sends_total - FCM table queue send total

453
Metric Name
HASH_GRPBY_OVERFLOWS
hash_grpby_overflows - Hash group by overflows
IDA_RECV_VOLUME
The total volume of data the database server received from an

in-database analytics process. The value is reported in bytes.
IDA_RECV_WAIT_TIME
The total amount of time spent waiting to receive data from an

in-database analytics process.
IDA_RECVS_TOTAL
The total number of times data was received from an in-database

analytics process.
IDA_SEND_VOLUME
The total volume of data sent from the database server to an

IDA_SEND_WAIT_TIME
The total amount of time spent waiting to send data to an

IDA_SENDS_TOTAL
The total number of times data was sent to an in-database analytics

process.
INT_COMMITS
int_commits - Internal commits
INT_ROLLBACKS
int_rollbacks - Internal rollbacks
IPC_RECV_VOLUME
ipc_recv_volume - Interprocess communication received volume
IPC_RECV_WAIT_TIME
ipc_recv_wait_time - Interprocess communication received wait time
IPC_RECVS_TOTAL
ipc_recvs_total - Interprocess communication receives total
IPC_SEND_VOLUME
ipc_send_volume - Interprocess communication send volume
IPC_SEND_WAIT_TIME
ipc_send_wait_time - Interprocess communication send wait time
IPC_SENDS_TOTAL
ipc_sends_total - Interprocess communication send total
LOCK_ESCALS_GLOBAL
lock_escals_global - Number of global lock escalations
LOCK_ESCALS_LOCKLIST
lock_escals_locklist - Number of locklist lock escalations
LOCK_ESCALS_MAXLOCKS
lock_escals_maxlocks - Number of maxlocks lock escalations
LOCK_ESCALS
lock_escals - Number of lock escalations
LOCK_TIMEOUTS_GLOBAL
lock_timeouts_global - Lock timeouts global
LOCK_TIMEOUTS
lock_timeouts - Number of lock timeouts
LOCK_WAIT_TIME_GLOBAL
lock_wait_time_global - Lock wait time global
LOCK_WAIT_TIME
lock_wait_time - Time waited on locks
LOCK_WAITS_GLOBAL
lock_waits_global - Lock waits global
LOCK_WAITS
lock_waits - Lock waits
LOG_BUFFER_WAIT_TIME
log_buffer_wait_time - Log buffer wait time
LOG_DISK_WAIT_TIME
log_disk_wait_time - Log disk wait time
LOG_DISK_WAITS_TOTAL
log_disk_waits_total - Total log disk waits
NUM_LOG_BUFFER_FULL
num_log_buffer_full - Number of times full log buffer caused agents

to wait
NUM_LW_THRESH_EXCEEDED
num_lw_thresh_exceeded - Number of lock wait thresholds

exceeded
PKG_CACHE_INSERTS
pkg_cache_inserts - Package cache inserts
PKG_CACHE_LOOKUPS
pkg_cache_lookups - Package cache lookups
POOL_COL_GBP_INDEP_PAGES_
FOUND_IN_LBP
pool_col_gbp_indep_pages_found_in_lbp - Buffer pool

column-organized GBP independent pages found in local buffer pool
454
Metric Name
POOL_COL_GBP_INVALID_PAGES
pool_col_gbp_invalid_pages - Buffer pool column-organized GBP

invalid data pages
POOL_COL_GBP_L_READS
pool_col_gbp_l_reads - Buffer pool column-organized GBP logical

reads
POOL_COL_GBP_P_READS
pool_col_gbp_p_reads - Buffer pool column-organized GBP physical

reads
POOL_COL_L_READS
pool_col_l_reads - Buffer pool column-organized logical reads
POOL_COL_LBP_PAGES_FOUND
pool_col_lbp_pages_found - Buffer pool column-organized LBP

pages found
POOL_COL_P_READS
pool_col_p_reads - Buffer pool column-organized physical reads
POOL_COL_WRITES
pool_col_writes - Buffer pool column-organized writes
POOL_DATA_GBP_INDEP_PAGES_
FOUND_IN_LBP
pool_data_gbp_indep_pages_found_in_lbp - Group buffer pool

independent data pages found in local buffer pool
POOL_DATA_GBP_INVALID_PAGES
pool_data_gbp_invalid_pages - Group buffer pool invalid data pages
POOL_DATA_GBP_L_READS
pool_data_gbp_l_reads - Group buffer pool data logical reads
POOL_DATA_GBP_P_READS
pool_data_gbp_p_reads - Group buffer pool data physical reads
POOL_DATA_L_READS
pool_data_l_reads - Buffer pool data logical reads
POOL_DATA_LBP_PAGES_FOUND
pool_data_lbp_pages_found - Local buffer pool found data pages
POOL_DATA_P_READS
pool_data_p_reads - Buffer pool data physical reads
POOL_DATA_WRITES
pool_data_writes - Buffer pool data writes
POOL_FAILED_ASYNC_COL_REQS
pool_failed_async_col_reqs - Failed column-organized prefetch

requests
POOL_FAILED_ASYNC_DATA_REQS
pool_failed_async_data_reqs - Failed data prefetch requests
POOL_FAILED_ASYNC_INDEX_REQS
pool_failed_async_index_reqs - Failed index prefetch requests
POOL_FAILED_ASYNC_OTHER_REQS
pool_failed_async_other_reqs - Failed non-prefetch requests
POOL_FAILED_ASYNC_TEMP_
COL_REQS
pool_failed_async_temp_col_reqs - Failed column-organized

temporary prefetch requests
DATA_REQS
pool_failed_async_temp_data_reqs - Failed data prefetch requests for

temporary table spaces
INDEX_REQS
pool_failed_async_temp_index_reqs - Failed index prefetch requests

for temporary table spaces
XDA_REQS
pool_failed_async_temp_xda_reqs - Failed XDA prefetch requests for

POOL_FAILED_ASYNC_XDA_REQS
pool_failed_async_xda_reqs - Failed XDA prefetch requests
POOL_INDEX_GBP_INDEP_PAGES_
FOUND_IN_LBP
pool_index_gbp_indep_pages_found_in_lbp - Group buffer pool

independent index pages found in local buffer pool
POOL_INDEX_GBP_INVALID_PAGES
pool_index_gbp_invalid_pages - Group buffer pool invalid index

pages
POOL_INDEX_GBP_L_READS
pool_index_gbp_l_reads - Group buffer pool index logical reads
POOL_INDEX_GBP_P_READS
pool_index_gbp_p_reads - Group buffer pool index physical reads
POOL_INDEX_L_READS
pool_index_l_reads - Buffer pool index logical reads
POOL_INDEX_LBP_PAGES_FOUND
pool_index_lbp_pages_found - Local buffer pool index pages found
POOL_INDEX_P_READS
pool_index_p_reads - Buffer pool index physical reads

455
Metric Name
POOL_INDEX_WRITES
pool_index_writes - Buffer pool index writes
POOL_QUEUED_ASYNC_COL_PAGES
pool_queued_async_col_pages - Column-organized page prefetch

requests
POOL_QUEUED_ASYNC_COL_REQS
pool_queued_async_col_reqs - Column-organized prefetch requests
POOL_QUEUED_ASYNC_
DATA_PAGES
pool_queued_async_data_pages - Data pages prefetch requests
POOL_QUEUED_ASYNC_DATA_REQS
pool_queued_async_data_reqs - Data prefetch requests
POOL_QUEUED_ASYNC_
INDEX_PAGES
pool_queued_async_index_pages - Index pages prefetch requests
POOL_QUEUED_ASYNC_INDEX_REQS
pool_queued_async_index_reqs - Index prefetch requests
POOL_QUEUED_ASYNC_OTHER_REQS
pool_queued_async_other_reqs - Non-prefetch requests
POOL_QUEUED_ASYNC_
TEMP_COL_PAGES
pool_queued_async_temp_col_pages - Column-organized page

POOL_QUEUED_ASYNC_TEMP_COL_REQS pool_queued_async_temp_col_reqs - Column-organized temporary

prefetch requests
POOL_QUEUED_ASYNC_TEMP_
DATA_PAGES
pool_queued_async_temp_data_pages - Data pages prefetch requests

DATA_REQS
pool_queued_async_temp_data_reqs - Data prefetch requests for

INDEX_PAGES
pool_queued_async_temp_index_pages - Index pages prefetch

requests for temporary table spaces
INDEX_REQS
pool_queued_async_temp_index_reqs - Index prefetch requests for

XDA_PAGES
pool_queued_async_temp_xda_pages - XDA data pages prefetch

XDA_REQS
pool_queued_async_temp_xda_reqs - XDA data prefetch requests for

POOL_QUEUED_ASYNC_
XDA_PAGES
pool_queued_async_xda_pages - XDA pages prefetch requests
POOL_QUEUED_ASYNC_XDA_REQS
pool_queued_async_xda_reqs - XDA prefetch requests
POOL_READ_TIME
pool_read_time - Total buffer pool physical read time
POOL_TEMP_COL_L_READS
pool_temp_col_l_reads - Buffer pool column-organized temporary

logical reads
POOL_TEMP_COL_P_READS
pool_temp_col_p_reads - Buffer pool column-organized temporary

physical reads
POOL_TEMP_DATA_L_READS
pool_temp_data_l_reads - Buffer pool temporary data logical reads
POOL_TEMP_DATA_P_READS
pool_temp_data_p_reads - Buffer pool temporary data physical reads
POOL_TEMP_INDEX_L_READS
pool_temp_index_l_reads - Buffer pool temporary index logical reads
POOL_TEMP_INDEX_P_READS
pool_temp_index_p_reads - Buffer pool temporary index physical

reads
POOL_TEMP_XDA_L_READS
pool_temp_xda_l_reads - Buffer pool temporary XDA data logical

reads
POOL_TEMP_XDA_P_READS
pool_temp_xda_p_reads - Buffer pool temporary XDA data physical

reads
456
Metric Name
POOL_WRITE_TIME
pool_write_time - Total buffer pool physical write time
POOL_XDA_GBP_INDEP_PAGES_
FOUND_IN_LBP
pool_xda_gbp_indep_pages_found_in_lbp - Group buffer pool XDA

independent pages found in local buffer pool
POOL_XDA_GBP_INVALID_PAGES
pool_xda_gbp_invalid_pages - Group buffer pool invalid XDA data

pages
POOL_XDA_GBP_L_READS
pool_xda_gbp_l_reads - Group buffer pool XDA data logical read

requests
POOL_XDA_GBP_P_READS
pool_xda_gbp_p_reads - Group buffer pool XDA data physical read

requests
POOL_XDA_L_READS
pool_xda_l_reads - Buffer pool XDA data logical reads
POOL_XDA_LBP_PAGES_FOUND
pool_xda_lbp_pages_found - Local buffer pool XDA data pages

found
POOL_XDA_P_READS
pool_xda_p_reads - Buffer pool XDA data physical reads
POOL_XDA_WRITES
pool_xda_writes - Buffer pool XDA data writes
POST_SHRTHRESHOLD_SORTS
post_shrthreshold_sorts - Post shared threshold sorts
POST_THRESHOLD_HASH_GRPBYS
post_threshold_hash_grpbys - Hash group by threshold
POST_THRESHOLD_PEAS
post_threshold_peas - Partial early aggregation threshold
POST_THRESHOLD_PEDS
post_threshold_peds - Partial early distincts threshold
POST_THRESHOLD_SORTS
post_threshold_sorts - Post threshold sorts
PREFETCH_WAIT_TIME
prefetch_wait_time - Time waited for prefetch
PREFETCH_WAITS
prefetch_waits - Prefetcher wait count
RECLAIM_WAIT_TIME
reclaim_wait_time - Reclaim wait time
ROWS_MODIFIED
rows_modified - Rows modified
ROWS_READ
rows_read - Rows read
ROWS_RETURNED
rows_returned - Rows returned
RQSTS_COMPLETED_TOTAL
rqsts_completed_total - Total requests completed
SORT_OVERFLOWS
sort_overflows - Sort overflows
SPACEMAPPAGE_RECLAIM_WAIT_
TIME
spacemappage_reclaim_wait_time - Space map page reclaim wait

time
TCPIP_RECV_VOLUME
tcpip_recv_volume - TCP/IP received volume
TCPIP_RECV_WAIT_TIME
tcpip_recv_wait_time - TCP/IP received wait time
TCPIP_RECVS_TOTAL
tcpip_recvs_total - TCP/IP receives total
TCPIP_SEND_VOLUME
tcpip_send_volume - TCP/IP send volume
TCPIP_SEND_WAIT_TIME
tcpip_send_wait_time - TCP/IP send wait time
TCPIP_SENDS_TOTAL
tcpip_sends_total - TCP/IP sends total
THRESH_VIOLATIONS
thresh_violations - Number of threshold violations
TOTAL_ACT_TIME
total_act_time - Total activity time
TOTAL_ACT_WAIT_TIME
total_act_wait_time - Total activity wait time
TOTAL_APP_COMMITS
total_app_commits - Total application commits
TOTAL_APP_ROLLBACKS
total_app_rollbacks - Total application rollbacks
TOTAL_APP_RQST_TIME
total_app_rqst_time - Total application request time

457
Metric Name
TOTAL_APP_SECTION_EXECUTIONS
total_app_section_executions - Total application section executions
TOTAL_COL_EXECUTIONS
total_col_executions - Total column-organized executions
TOTAL_COL_PROC_TIME
total_col_proc_time - Total column-organized processing time
TOTAL_COL_TIME
total_col_time - Total column-organized time
TOTAL_COMMIT_PROC_TIME
total_commit_proc_time - Total commits processing time
TOTAL_COMMIT_TIME
total_commit_time - Total commit time
TOTAL_COMPILATIONS
total_compilations - Total compilations
TOTAL_COMPILE_PROC_TIME
total_compile_proc_time - Total compile processing time
TOTAL_COMPILE_TIME
total_compile_time - Total compile time
TOTAL_CONNECT_AUTHENTICATION_
PROC_TIME
total_connect_authentication_proc_time - Total connection

authentication processing time
TOTAL_CONNECT_AUTHENTICATION_
TIME
total_connect_authentication_time - Total connection or switch user

authentication request time
TOTAL_CONNECT_AUTHENTICATIONS
total_connect_authentications - Connections or switch user

authentications performed
TOTAL_CONNECT_REQUEST_
PROC_TIME
total_connect_request_proc_time - Total connection or switch user

request processing time
TOTAL_CONNECT_REQUEST_TIME
total_connect_request_time - Total connection or switch user request

time
TOTAL_CONNECT_REQUESTS
total_connect_requests - Connection or switch user requests
TOTAL_CPU_TIME
total_cpu_time - Total CPU time
TOTAL_DISP_RUN_QUEUE_TIME
total_disp_run_queue_time - Total dispatcher run queue time
TOTAL_EXTENDED_LATCH_WAIT_
TIME
total_extended_latch_wait_time - Total extended latch wait time
TOTAL_EXTENDED_LATCH_WAITS
total_extended_latch_waits - Total extended latch waits
TOTAL_HASH_GRPBYS
total_hash_grpbys - Total hash group by operations
TOTAL_IMPLICIT_COMPILATIONS
total_implicit_compilations - Total implicit complications
TOTAL_IMPLICIT_COMPILE_PROC_
TIME
total_implicit_compile_proc_time - Total implicit compile processing

time
TOTAL_IMPLICIT_COMPILE_TIME
total_implicit_compile_time - Total implicit compile time
TOTAL_LOAD_PROC_TIME
total_load_proc_time - Total load processing time
TOTAL_LOAD_TIME
TOTAL_LOADS
total_loads - Total loads
TOTAL_PEAS
total_peas - Total partial early aggregations
TOTAL_PEDS
total_peds - Total partial early distincts
TOTAL_REORG_PROC_TIME
total_reorg_proc_time - Total reorganization processing time
TOTAL_REORG_TIME
total_reorg_time - Total reorganization time
TOTAL_REORGS
total_reorgs - Total reorganizations
TOTAL_ROLLBACK_PROC_TIME
total_rollback_proc_time - Total rollback processing time
TOTAL_ROLLBACK_TIME
total_rollback_time - Total rollback time
TOTAL_ROUTINE_INVOCATIONS
total_routine_invocations - Total routine invocations
458
Metric Name
TOTAL_ROUTINE_TIME
total_routine_time - Total routine time
TOTAL_ROUTINE_USER_CODE_
PROC_TIME
total_routine_user_code_proc_time - Total routine user code

processing time
TOTAL_ROUTINE_USER_CODE_TIME
total_routine_user_code_time - Total routine user code time
TOTAL_RQST_TIME
total_rqst_time - Total request time
TOTAL_RUNSTATS_PROC_TIME
total_runstats_proc_time - Total runtime statistics processing time
TOTAL_RUNSTATS_TIME
total_runstats_time - Total runtime statistics time
TOTAL_RUNSTATS
total_runstats - Total runtime statistics
TOTAL_SECTION_PROC_TIME
total_section_proc_time - Total section processing time
TOTAL_SECTION_SORT_PROC_TIME
total_section_sort_proc_time - Total section sort processing time
TOTAL_SECTION_SORT_TIME
total_section_sort_time - Total section sort time
TOTAL_SECTION_SORTS
total_section_sorts - Total section sorts
TOTAL_SECTION_TIME
total_section_time - Total section time
TOTAL_SORTS
total_sorts - Total sorts
TOTAL_STATS_FABRICATION_
PROC_TIME
total_stats_fabrication_proc_time - Total statistics fabrication

processing time
TOTAL_STATS_FABRICATION_TIME
total_stats_fabrication_time - Total statistics fabrication time
TOTAL_STATS_FABRICATIONS
total_stats_fabrications - Total statistics fabrications
TOTAL_SYNC_RUNSTATS_PROC_TIME
total_sync_runstats_proc_time - Total synchronous RUNSTATS

processing time
TOTAL_SYNC_RUNSTATS_TIME
total_sync_runstats_time - Total synchronous RUNSTATS time
TOTAL_SYNC_RUNSTATS
total_sync_runstats - Total synchronous RUNSTATS activities
TOTAL_WAIT_TIME
total_wait_time - Total wait time
TQ_SORT_HEAP_REJECTIONS
tq_sort_heap_rejections - Table queue sort heap rejections
TQ_SORT_HEAP_REQUESTS
tq_sort_heap_requests - Table queue sort heap requests
TQ_TOT_SEND_SPILLS
tq_tot_send_spills - Total number of table queue buffers overflowed
WLM_QUEUE_ASSIGNMENTS_TOTAL
wlm_queue_assignments_total - Workload manager total queue

assignments
WLM_QUEUE_TIME_TOTAL
wlm_queue_time_total - Workload manager total queue time
v MON_GET_ACTIVITY_DETAILS
v MON_GET_PKG_CACHE_STMT_DETAILS
v DETAILS_XML column from an ACTIVITY event monitor
CACHE event monitor
See Table 119 on page 460 for the types of metrics that are returned from the XML
document in this case:
459
Table 119. Metric names returned by MON_FORMAT_XML_METRICS_BY_ROW for XML documents containing an
activity_metrics element type
Metric Name
AUDIT_EVENTS_TOTAL
CF_WAIT_TIME
CF_WAITS
COORD_STMT_EXEC_TIME
coord_stmt_exec_time - Execution time for statement by coordinator

agent
DEADLOCKS
diaglog_write_wait_time - Diagnostic log file write wait time
DIRECT_READ_REQS
DIRECT_READ_TIME
DIRECT_READS
DIRECT_WRITE_REQS
DIRECT_WRITE_TIME
DIRECT_WRITES
DISABLED_PEDS
EVMON_WAIT_TIME
EVMON_WAITS_TOTAL
fcm_message_recv_volume - FCM message received volume
fcm_message_recv_wait_time - FCM message received wait time
fcm_message_send_wait_time - FCM message send wait time
FCM_RECV_VOLUME
FCM_RECV_WAIT_TIME
FCM_RECVS_TOTAL
FCM_SEND_VOLUME
FCM_SEND_WAIT_TIME
FCM_SENDS_TOTAL
FCM_TQ_RECV_VOLUME
fcm_tq_recv_wait_time - FCM table queue received wait time
FCM_TQ_RECVS_TOTAL
FCM_TQ_SEND_VOLUME
FCM_TQ_SENDS_TOTAL
460
activity_metrics element type (continued)
Metric Name
IDA_RECV_VOLUME
The total volume of data the database server received from an

IDA_RECV_WAIT_TIME
The total amount of time spent waiting to receive data from an

IDA_RECVS_TOTAL
The total number of times data was received from an in-database

analytics process.
IDA_SEND_VOLUME
The total volume of data sent from the database server to an in-database
analytics process. The value is reported in bytes.
IDA_SEND_WAIT_TIME
The total amount of time spent waiting to send data to an in-database

analytics process.
IDA_SENDS_TOTAL
The total number of times data was sent to an in-database analytics

process.
LOCK_ESCALS_GLOBAL
lock_escals_maxlocks - Number of maxlocks lock escalations
LOCK_ESCALS
LOCK_TIMEOUTS
LOCK_WAIT_TIME
LOCK_WAITS_GLOBAL
LOCK_WAITS
LOG_DISK_WAIT_TIME
NUM_LOG_BUFFER_FULL
num_log_buffer_full - Number of times full log buffer caused agents to

wait
num_lw_thresh_exceeded - Number of lock wait thresholds exceeded
POOL_COL_GBP_INDEP_PAGES_
FOUND_IN_LBP

column-organized GBP independent pages found in local buffer pool
pool_col_gbp_invalid_pages - Buffer pool column-organized GBP invalid

data pages
pool_col_gbp_l_reads - Buffer pool column-organized GBP logical reads
pool_col_gbp_p_reads - Buffer pool column-organized GBP physical

reads
POOL_COL_L_READS
pool_col_l_reads - Buffer pool column-organized logical reads
pool_col_lbp_pages_found - Buffer pool column-organized LBP pages

found
POOL_COL_P_READS
pool_col_p_reads - Buffer pool column-organized physical reads
POOL_COL_WRITES
POOL_DATA_GBP_INDEP_PAGES_
FOUND_IN_LBP
pool_data_gbp_indep_pages_found_in_lbp - Group buffer pool

461
Metric Name
pool_data_gbp_invalid_pages - Group buffer pool invalid data pages
pool_data_gbp_l_reads - Group buffer pool data logical reads
pool_data_gbp_p_reads - Group buffer pool data physical reads
POOL_DATA_L_READS
pool_data_lbp_pages_found - Local buffer pool found data pages
POOL_DATA_P_READS
POOL_DATA_WRITES
pool_failed_async_col_reqs - Failed column-organized prefetch requests
pool_failed_async_index_reqs - Failed index prefetch requests
COL_REQS
pool_failed_async_temp_col_reqs - Failed column-organized temporary

prefetch requests
DATA_REQS
pool_failed_async_temp_data_reqs - Failed data prefetch requests for

INDEX_REQS
pool_failed_async_temp_index_reqs - Failed index prefetch requests for

XDA_REQS
pool_failed_async_temp_xda_reqs - Failed XDA prefetch requests for

POOL_INDEX_GBP_INDEP_PAGES_
FOUND_IN_LBP
pool_index_gbp_indep_pages_found_in_lbp - Group buffer pool

independent index pages found in local buffer pool
pool_index_gbp_invalid_pages - Group buffer pool invalid index pages
pool_index_gbp_l_reads - Group buffer pool index logical reads
pool_index_gbp_p_reads - Group buffer pool index physical reads
POOL_INDEX_L_READS
pool_index_lbp_pages_found - Local buffer pool index pages found
POOL_INDEX_P_READS
POOL_INDEX_WRITES
pool_queued_async_col_pages - Column-organized page prefetch

requests
pool_queued_async_col_reqs - Column-organized prefetch requests
POOL_QUEUED_ASYNC_DATA_PAGES
pool_queued_async_data_pages - Data pages prefetch requests
POOL_QUEUED_ASYNC_INDEX_PAGES pool_queued_async_index_pages - Index pages prefetch requests

POOL_QUEUED_ASYNC_OTHER_REQS pool_queued_async_other_reqs - Non-prefetch requests

COL_PAGES
pool_queued_async_temp_col_pages - Column-organized page

COL_REQS
pool_queued_async_temp_col_reqs - Column-organized temporary

prefetch requests
462
Metric Name
DATA_PAGES
pool_queued_async_temp_data_pages - Data pages prefetch requests for

DATA_REQS
pool_queued_async_temp_data_reqs - Data prefetch requests for

INDEX_PAGES
pool_queued_async_temp_index_pages - Index pages prefetch requests

INDEX_REQS
pool_queued_async_temp_index_reqs - Index prefetch requests for

XDA_PAGES
pool_queued_async_temp_xda_pages - XDA data pages prefetch

XDA_REQS
pool_queued_async_temp_xda_reqs - XDA data prefetch requests for

POOL_QUEUED_ASYNC_XDA_PAGES
pool_queued_async_xda_pages - XDA pages prefetch requests
POOL_READ_TIME
pool_temp_col_l_reads - Buffer pool column-organized temporary logical

reads
pool_temp_col_p_reads - Buffer pool column-organized temporary

physical reads
pool_temp_data_l_reads - Buffer pool temporary data logical reads
pool_temp_data_p_reads - Buffer pool temporary data physical reads
pool_temp_index_l_reads - Buffer pool temporary index logical reads
pool_temp_index_p_reads - Buffer pool temporary index physical reads
pool_temp_xda_l_reads - Buffer pool temporary XDA data logical reads
pool_temp_xda_p_reads - Buffer pool temporary XDA data physical

reads
POOL_WRITE_TIME
POOL_XDA_GBP_INDEP_PAGES_
FOUND_IN_LBP
pool_xda_gbp_indep_pages_found_in_lbp - Group buffer pool XDA

pool_xda_gbp_invalid_pages - Group buffer pool invalid XDA data

pages
pool_xda_gbp_l_reads - Group buffer pool XDA data logical read

requests
pool_xda_gbp_p_reads - Group buffer pool XDA data physical read

requests
POOL_XDA_L_READS
pool_xda_lbp_pages_found - Local buffer pool XDA data pages found
POOL_XDA_P_READS
POOL_XDA_WRITES
POST_THRESHOLD_PEAS
POST_THRESHOLD_PEDS
463
Metric Name
PREFETCH_WAIT_TIME
PREFETCH_WAITS
RECLAIM_WAIT_TIME
ROWS_MODIFIED
ROWS_READ
ROWS_RETURNED
SORT_OVERFLOWS
SPACEMAPPAGE_RECLAIM_WAIT_
TIME
spacemappage_reclaim_wait_time - Space map page reclaim wait time
STMT_EXEC_TIME
stmt_exec_time - Statement execution time
THRESH_VIOLATIONS
TOTAL_ACT_TIME
TOTAL_ACT_WAIT_TIME
total_app_section_executions - Total application section executions
TOTAL_COL_PROC_TIME
total_col_proc_time - Total column-organized processing time
TOTAL_COL_TIME
TOTAL_CPU_TIME
total_disp_run_queue_time - Total dispatcher run queue time
TOTAL_EXTENDED_LATCH_WAIT_
TIME
total_extended_latch_wait_time - Total extended latch wait time
TOTAL_HASH_GRPBYS
TOTAL_PEAS
TOTAL_PEDS
TOTAL_ROUTINE_NON_SECT_
PROC_TIME
total_routine_non_sect_proc_time - Non-section processing time
TOTAL_ROUTINE_NON_SECT_TIME
total_routine_non_sect_time - Non-section routine execution time
TOTAL_ROUTINE_TIME
TOTAL_ROUTINE_USER_CODE_PROC_
TIME
total_routine_user_code_proc_time - Total routine user code processing

time
total_section_sort_proc_time - Total section sort processing time
TOTAL_SECTION_SORTS
TOTAL_SECTION_TIME
TOTAL_SORTS
464
Metric Name
TQ_TOT_SEND_SPILLS
tq_tot_send_spills - Total number of table queue buffers overflowed
wlm_queue_assignments_total - Workload manager total queue

assignments
wlm_queue_time_total - Workload manager total queue time
Example
This example shows how to call the MON_FORMAT_XML_METRICS _BY_ROW
table function to return row-based formatted information from the XML document
produced by the MON_GET_WORKLOAD_DETAILS table function.
SELECT SUBSTR(TFXML.WORKLOAD_NAME, 1, 13) AS WORKLOAD_NAME,
SUBSTR(METRICS.METRIC_NAME, 1, 25) AS METRIC_NAME,
METRICS.VALUE
FROM
TABLE( MON_GET_WORKLOAD_DETAILS( NULL, -2 ) ) AS TFXML,
TABLE( MON_FORMAT_XML_METRICS_BY_ROW( TFXML.DETAILS )) AS METRICS
ORDER BY METRICS.VALUE DESC
The following is a partial listing of the output of this query.

WORKLOAD_NAME
------------PAYROLL
FINANCE
PAYROLL
FINANCE
FINANCE
PAYROLL
METRIC_NAME
VALUE
------------------------- --------------ACT_COMPLETED_TOTAL
15
ACT_COMPLETED_TOTAL
12
LOCK_WAITS
8
LOCK_WAITS
5
DEADLOCKS
3
DEADLOCKS
0
MON_FORMAT_XML_TIMES_BY_ROW - Get formatted row-based combined

hierarchy wait and processing times:
The MON_FORMAT_XML_TIMES_BY_ROW table function returns formatted row
based output for the combined hierarchy of wait and processing times that are
contained in an XML metrics document.
Authorization
v DBADM authority
v SQLADM authority
465
Syntax
MON_FORMAT_XML_TIMES_BY_ROW (
xmldoc

Routine parameters
xmldoc
monitors.
Table 120. Information returned for MON_FORMAT_XML_TIMES_BY_ROW
Column Name
Data Type
Description
METRIC_NAME
VARCHAR(128)
TOTAL_TIME_VALUE
BIGINT

metric_name.
COUNT
BIGINT
PARENT_METRIC_NAME
VARCHAR(128)

contains the total_time_value as a subset.
WORK event monitor
Table 121. Metric names returned by MON_FORMAT_XML_TIMES_BY_ROW for XML documents containing a
system_metrics element type
Metric Name
Parent Metric Name
AGENT_WAIT_TIME
TOTAL_WAIT_TIME
AUDIT_FILE_WRITE_WAIT
_TIME
TOTAL_WAIT_TIME
466
Metric Name
Parent Metric Name
AUDIT_SUBSYSTEM_WAIT
_TIME
TOTAL_WAIT_TIME
audit_subsystem_wait_time - Audit subsystem wait

time
CF_WAIT_TIME
TOTAL_WAIT_TIME
NULL
COMM_EXIT_WAIT_TIME
TOTAL_WAIT_TIME
comm_exit_wait_time - Communication buffer exit

wait time monitor element
DIAGLOG_WRITE_WAIT
_TIME
TOTAL_WAIT_TIME
diaglog_write_wait_time - Diagnostic log file write

wait time
DIRECT_READ_TIME
TOTAL_WAIT_TIME
DIRECT_WRITE_TIME
TOTAL_WAIT_TIME
EVMON_WAIT_TIME
TOTAL_WAIT_TIME
FCM_MESSAGE_RECV_WAIT
_TIME
FCM_RECV_WAIT_TIME
fcm_message_recv_wait_time - FCM message received

wait time
FCM_MESSAGE_SEND_WAIT
_TIME
FCM_SEND_WAIT_TIME
fcm_message_send_wait_time - FCM message send

wait time
FCM_RECV_WAIT_TIME
TOTAL_WAIT_TIME
FCM_SEND_WAIT_TIME
TOTAL_WAIT_TIME
FCM_RECV_WAIT_TIME
fcm_tq_recv_wait_time - FCM table queue received

wait time
FCM_SEND_WAIT_TIME
fcm_tq_send_wait_time - FCM table queue send wait

time
IDA_RECV_WAIT_TIME
TOTAL_WAIT_TIME
The total amount of time spent waiting to receive

data from an in-database analytics process.
IDA_SEND_WAIT_TIME
TOTAL_WAIT_TIME
The total amount of time spent waiting to send data

to an in-database analytics process.
IPC_RECV_WAIT_TIME
TOTAL_WAIT_TIME
ipc_recv_wait_time - Interprocess communication

received wait time
IPC_SEND_WAIT_TIME
TOTAL_WAIT_TIME
ipc_send_wait_time - Interprocess communication

send wait time
LOCK_WAIT_TIME
LOCK_WAIT_TIME
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
LOG_DISK_WAIT_TIME
TOTAL_WAIT_TIME
POOL_READ_TIME
TOTAL_WAIT_TIME
POOL_WRITE_TIME
TOTAL_WAIT_TIME
pool_write_time - Total buffer pool physical write

time
PREFETCH_WAIT_TIME
TOTAL_WAIT_TIME
RECLAIM_WAIT_TIME
TOTAL_WAIT_TIME
SPACEMAPPAGE_RECLAIM
_WAIT_TIME
TOTAL_WAIT_TIME
spacemappage_reclaim_wait_time - Space map page

reclaim wait time
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
467
Metric Name
Parent Metric Name
TOTAL_COL_
PROC_TIME
TOTAL_SECTION_
PROC_TIME
total_col_proc_time - Total column-oriented

processing time
TOTAL_COMMIT_
PROC_TIME
TOTAL_RQST_TIME
total_commit_proc_time - Total commits processing

time
TOTAL_COMPILE_PROC
_TIME
TOTAL_RQST_TIME
total_compile_proc_time - Total compile processing

time
TOTAL_CONNECT
_AUTHENTICATION_PROC
_TIME
TOTAL_CONNECT
_REQUEST_PROC
_TIME
total_connect_authentication_proc_time - Total
connection authentication processing time
TOTAL_CONNECT_REQUEST
_PROC_TIME
TOTAL_RQST_TIME
total_connect_request_proc_time - Total connection or

switch user request processing time
TOTAL_EXTENDED_LATCH
_WAIT_TIME
TOTAL_WAIT_TIME
total_extended_latch_wait_time - Total extended latch

wait time
TOTAL_IMPLICIT_COMPILE
_PROC_TIME
TOTAL_RQST_TIME
total_implicit_compile_proc_time - Total implicit

compile processing time
TOTAL_RQST_TIME
TOTAL_RQST_TIME
total_reorg_proc_time - Total reorganization

processing time
TOTAL_ROLLBACK_PROC
_TIME
TOTAL_RQST_TIME
total_rollback_proc_time - Total rollback processing

time
TOTAL_ROUTINE_USER
_CODE_PROC_TIME
TOTAL_RQST_TIME
total_routine_user_code_proc_time - Total routine user

code processing time
TOTAL_RQST_TIME
NULL
TOTAL_RUNSTATS_PROC
_TIME
TOTAL_RQST_TIME
total_runstats_proc_time - Total runtime statistics

processing time
TOTAL_SECTION_PROC_TIME TOTAL_RQST_TIME
TOTAL_SECTION_SORT
_PROC_TIME
TOTAL_SECTION_PROC
_TIME
total_section_sort_proc_time - Total section sort

processing time
TOTAL_STATS_FABRICATION
_PROC_TIME
TOTAL_COMPILE_PROC
_TIME
total_stats_fabrication_proc_time - Total statistics

fabrication processing time
TOTAL_SYNC_RUNSTATS
_PROC_TIME
TOTAL_COMPILE_PROC
_TIME
total_sync_runstats_proc_time - Total synchronous

RUNSTATS processing time
TOTAL_WAIT_TIME
TOTAL_RQST_TIME
TOTAL_WAIT_TIME
wlm_queue_time_total - Workload manager total

queue time
CACHE event monitor
468
Table 122. Metric names returned by MON_FORMAT_XML_TIMES_BY_ROW for XML documents containing an
activity_metrics element type
Metric Name
Parent Metric Name
AUDIT_FILE_WRITE_WAIT
_TIME
TOTAL_ACT_WAIT_TIME
audit_file_write_wait_time - Audit file write wait

time
_TIME
TOTAL_ACT_WAIT_TIME

time
CF_WAIT_TIME
TOTAL_ACT_WAIT_TIME
DIAGLOG_WRITE_WAIT
_TIME
TOTAL_ACT_WAIT_TIME

wait time
DIRECT_READ_TIME
TOTAL_ACT_WAIT_TIME
DIRECT_WRITE_TIME
TOTAL_ACT_WAIT_TIME
EVMON_WAIT_TIME
TOTAL_ACT_WAIT_TIME
FCM_MESSAGE_RECV_WAIT
_TIME
FCM_RECV_WAIT_TIME
fcm_message_recv_wait_time - FCM message

received wait time
FCM_MESSAGE_SEND_WAIT
_TIME
FCM_SEND_WAIT_TIME

wait time
FCM_RECV_WAIT_TIME
TOTAL_ACT_WAIT_TIME
FCM_SEND_WAIT_TIME
TOTAL_ACT_WAIT_TIME
FCM_RECV_WAIT_TIME

wait time
FCM_SEND_WAIT_TIME
fcm_tq_send_wait_time - FCM table queue send

wait time
IDA_RECV_WAIT_TIME
TOTAL_WAIT_TIME

IDA_SEND_WAIT_TIME
TOTAL_WAIT_TIME
The total amount of time spent waiting to send

data to an in-database analytics process.
LOCK_WAIT_TIME
LOCK_WAIT_TIME
TOTAL_ACT_WAIT_TIME
TOTAL_ACT_WAIT_TIME
LOG_DISK_WAIT_TIME
TOTAL_ACT_WAIT_TIME
POOL_READ_TIME
TOTAL_ACT_WAIT_TIME
pool_read_time - Total buffer pool physical read

time
POOL_WRITE_TIME
TOTAL_ACT_WAIT_TIME

time
PREFETCH_WAIT_TIME
TOTAL_ACT_WAIT_TIME
RECLAIM_WAIT_TIME
TOTAL_ACT_WAIT_TIME
_WAIT_TIME
TOTAL_ACT_WAIT_TIME
spacemappage_reclaim_wait_time - Space map

page reclaim wait time
STMT_EXEC_TIME
NULL
TOTAL_ACT_WAIT_TIME
STMT_EXEC_TIME
TOTAL_COL_
PROC_TIME
TOTAL_SECTION_
PROC_TIME
total_col_proc_time - Total column-oriented

processing time
469
Table 122. Metric names returned by MON_FORMAT_XML_TIMES_BY_ROW for XML documents containing an
Metric Name
Parent Metric Name
_WAIT_TIME
TOTAL_ACT_WAIT_TIME
total_extended_latch_wait_time - Total extended

latch wait time
TOTAL_ROUTINE_NON_SECT STMT_EXEC_TIME
_PROC_TIME
total_routine_non_sect_proc_time - Non-section
processing time
TOTAL_ROUTINE_USER
_CODE_PROC_TIME
total_routine_user_code_proc_time - Total routine

user code processing time
TOTAL_ROUTINE_NON
_SECT_PROC_TIME
TOTAL_SECTION_PROC_TIME STMT_EXEC_TIME
total_section_proc_time - Total section processing

time
TOTAL_SECTION_SORT
_PROC_TIME
TOTAL_SECTION
_PROC_TIME

processing time
NULL

queue time
Example
To determine where time is being spent by your application within the DB2
database manager, you can run the following query to show the combined wait
and processing time metrics in the metrics hierarchy.
SELECT SUBSTR(T.SERVICE_SUPERCLASS_NAME,1,15) as SUPERCLASS,
SUBSTR(T.SERVICE_SUBCLASS_NAME,1,15) as SUBCLASS,
T.MEMBER,
SUBSTR(U.METRIC_NAME, 1,15) AS METRIC_NAME,
SUBSTR(U.PARENT_METRIC_NAME,1,15) AS PARENT_NAME,
U.TOTAL_TIME_VALUE,
U.COUNT
FROM
TABLE(MON_GET_SERVICE_SUBCLASS_DETAILS(NULL, NULL, -2)) AS T,
TABLE(MON_FORMAT_XML_TIMES_BY_ROW(T.DETAILS)) AS U

SUPERCLASS
---------MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
MYSC
470
SUBCLASS MEMBER METRIC_NAME

PARENT_NAME
T..._VALUE COUNT
-------- ------ --------------- --------------- ---------- ----MYSSC
0 FCM_MESSAGE_REC FCM_RECV_WAIT_T
0
0
MYSSC
0 FCM_TQ_RECV_WAI FCM_RECV_WAIT_T
0
0
MYSSC
0 FCM_MESSAGE_SEN FCM_SEND_WAIT_T
0
0
MYSSC
0 FCM_TQ_SEND_WAI FCM_SEND_WAIT_T
0
0
MYSSC
0 TOTAL_COMMIT_PR TOTAL_RQST_TIME
300
1
MYSSC
0 TOTAL_COMPILE_P TOTAL_RQST_TIME
700
1
MYSSC
0 TOTAL_IMPLICIT_ TOTAL_RQST_TIME
0
0
MYSSC
0 TOTAL_LOAD_PROC TOTAL_RQST_TIME
0
0
MYSSC
0 TOTAL_REORG_PRO TOTAL_RQST_TIME
0
0
MYSSC
0 TOTAL_ROLLBACK_ TOTAL_RQST_TIME
0
0
MYSSC
0 TOTAL_RUNSTATS_ TOTAL_RQST_TIME
0
0
MYSSC
0 TOTAL_SECTION_P TOTAL_RQST_TIME
7322
1
MYSSC
0 TOTAL_WAIT_TIME TOTAL_RQST_TIME
0
0
MYSSC
0 TOTAL_SECTION_S TOTAL_SECTION_P
0
0
MYSSC
0 AGENT_WAIT_TIME TOTAL_WAIT_TIME
0
0
MYSSC
0 AUDIT_FILE_WRIT TOTAL_WAIT_TIME
0
0
MYSSC
0 AUDIT_SUBSYSTEM TOTAL_WAIT_TIME
0
0
MYSSC
0 DIAGLOG_WRITE_W TOTAL_WAIT_TIME
0
0
MYSSC
0 DIRECT_READ_TIM TOTAL_WAIT_TIME
1204
17
MYSSC
0 DIRECT_WRITE_TI TOTAL_WAIT_TIME
0
0
MYSSC
0 FCM_RECV_WAIT_T TOTAL_WAIT_TIME
0
0
MYSSC
0 FCM_SEND_WAIT_T TOTAL_WAIT_TIME
0
0
MYSSC
0 IPC_RECV_WAIT_T TOTAL_WAIT_TIME
0
0
MYSC
MYSSC
MYSC
MYSSC
MYSC
MYSSC
MYSC
MYSSC
MYSC
MYSSC
MYSC
MYSSC
MYSC
MYSSC
MYSC
MYSSC
MYSC
MYSSC
MYSC
MYSSC
MYSC
MYSSC
0
0
0
0
0
0
0
0
0
0
0
IPC_SEND_WAIT_T
LOCK_WAIT_TIME
LOG_BUFFER_WAIT
LOG_DISK_WAIT_T
POOL_READ_TIME
POOL_WRITE_TIME
TCPIP_RECV_WAIT
TCPIP_SEND_WAIT
WLM_QUEUE_TIME_
CLIENT_IDLE_WAI
TOTAL_RQST_TIME
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
-
0
0
0
523
2432
0
523
241
0
234
13245
0
0
0
2
7
0
1
1
0
1
MON_FORMAT_XML_WAIT_TIMES_BY_ROW - Get formatted row-based

output for wait times:
The MON_FORMAT_XML_WAIT_TIMES_BY_ROW table function returns
formatted row-based output for the wait times contained in an XML metrics
document.
Syntax
MON_FORMAT_XML_WAIT_TIMES_BY_ROW (
xmldoc

xmldoc
monitors.
Authorization
v DBADM authority
v SQLADM authority
None
Example
This example shows how to call the
MON_FORMAT_XML_WAIT_TIMES_BY_ROW table function to return formatted
row-based output from the XML document produced by the
MON_GET_WORKLOAD_DETAILS table function. The output shows the metrics
and their values for each workload.
471
SELECT SUBSTR(TFXML.WORKLOAD_NAME, 1, 13) AS WORKLOAD_NAME,

SUBSTR(WAITS.METRIC_NAME, 1, 25) AS METRIC_NAME,
WAITS.TOTAL_TIME_VALUE,
WAITS.COUNT
FROM
TABLE( MON_GET_WORKLOAD_DETAILS( NULL, -2 ) ) AS TFXML,
TABLE( MON_FORMAT_XML_WAIT_TIMES_BY_ROW(
TFXML.DETAILS
)) AS WAITS
ORDER BY WAITS.TOTAL_TIME_VALUE DESC
The following is a partial listing of the output of this query.

WORKLOAD_NAME
------------PAYROLL
FINANCE
PAYROLL
FINANCE
FINANCE
PAYROLL
METRIC_NAME
TOTAL_TIME_VALUE
COUNT
------------------------- ------------------- -----CLIENT_IDLE_WAIT_TIME
2193672
174
738290
16
DIRECT_READ_TIME
67892
81
DIRECT_READ_TIME
32343
8
LOCK_WAIT_TIME
8463
3
LOCK_WAIT_TIME
55
1
Table 123. Information returned for MON_FORMAT_XML_WAIT_TIMES_BY_ROW
Column Name
Data Type
Description
METRIC_NAME
VARCHAR(128)
TOTAL_TIME_VALUE
BIGINT

metric_name.
COUNT
BIGINT
PARENT_METRIC_NAME
VARCHAR(128)

contains the total_time_value as a subset.
WORK event monitor
Table 124. Metric names returned by MON_FORMAT_XML_WAIT_TIMES_BY_ROW for XML documents containing
a system_metrics element type
Metric Name
Parent Metric Name
TOTAL_WAIT_TIME

queue time
FCM_RECV_WAIT_TIME

wait time
472
a system_metrics element type (continued)
Metric Name
Parent Metric Name
FCM_MESSAGE_RECV
_WAIT_TIME
FCM_RECV_WAIT_TIME

received wait time
FCM_SEND_WAIT_TIME

time
FCM_MESSAGE_SEND
_WAIT_TIME
FCM_SEND_WAIT_TIME

wait time
AGENT_WAIT_TIME
TOTAL_WAIT_TIME
LOCK_WAIT_TIME
TOTAL_WAIT_TIME
DIRECT_READ_TIME
TOTAL_WAIT_TIME
DIRECT_WRITE_TIME
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
LOG_DISK_WAIT_TIME
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
NULL
IPC_RECV_WAIT_TIME
TOTAL_WAIT_TIME

received wait time
IPC_SEND_WAIT_TIME
TOTAL_WAIT_TIME

send wait time
TOTAL_WAIT_TIME
POOL_WRITE_TIME
TOTAL_WAIT_TIME

time
POOL_READ_TIME
TOTAL_WAIT_TIME
AUDIT_FILE_WRITE
_WAIT_TIME
TOTAL_WAIT_TIME

time
_TIME
TOTAL_WAIT_TIME

time
DIAGLOG_WRITE_WAIT
_TIME
TOTAL_WAIT_TIME

wait time
FCM_SEND_WAIT_TIME
TOTAL_WAIT_TIME
FCM_RECV_WAIT_TIME
TOTAL_WAIT_TIME
TOTAL_WAIT_TIME
TOTAL_RQST_TIME
LOCK_WAIT_TIME
RECLAIM_WAIT_TIME
TOTAL_WAIT_TIME
_WAIT_TIME
TOTAL_WAIT_TIME

reclaim wait time
CF_WAIT_TIME
TOTAL_WAIT_TIME
EVMON_WAIT_TIME
TOTAL_WAIT_TIME
_WAIT_TIME
TOTAL_WAIT_TIME

wait time
PREFETCH_WAIT_TIME
TOTAL_WAIT_TIME
COMM_EXIT_WAIT_TIME
TOTAL_WAIT_TIME

473
a system_metrics element type (continued)
Metric Name
Parent Metric Name
IDA_SEND_WAIT_TIME
TOTAL_WAIT_TIME

IDA_RECV_WAIT_TIME
TOTAL_WAIT_TIME

CACHE event monitor
an activity_metrics element type
Metric Name
Parent Metric Name
FCM_RECV_WAIT_TIME

wait time
FCM_MESSAGE_RECV
_WAIT_TIME
FCM_RECV_WAIT_TIME

received wait time
FCM_SEND_WAIT_TIME

time
FCM_MESSAGE_SEND
_WAIT_TIME
FCM_SEND_WAIT_TIME

wait time
LOCK_WAIT_TIME
TOTAL_ACT_WAIT_TIME
DIRECT_READ_TIME
TOTAL_ACT_WAIT_TIME
DIRECT_WRITE_TIME
TOTAL_ACT_WAIT_TIME
TOTAL_ACT_WAIT_TIME
LOG_DISK_WAIT_TIME
TOTAL_ACT_WAIT_TIME
POOL_WRITE_TIME
TOTAL_ACT_WAIT_TIME

time
POOL_READ_TIME
TOTAL_ACT_WAIT_TIME
AUDIT_FILE_WRITE
_WAIT_TIME
TOTAL_ACT_WAIT_TIME

time
_TIME
TOTAL_ACT_WAIT_TIME

time
DIAGLOG_WRITE_WAIT
_TIME
TOTAL_ACT_WAIT_TIME

wait time
FCM_SEND_WAIT_TIME
TOTAL_ACT_WAIT_TIME
FCM_RECV_WAIT_TIME
TOTAL_ACT_WAIT_TIME
474
an activity_metrics element type (continued)
Metric Name
Parent Metric Name
TOTAL_ACT_WAIT_TIME
STMT_EXEC_TIME
LOCK_WAIT_TIME
RECLAIM_WAIT_TIME
TOTAL_ACT_WAIT_TIME
_WAIT_TIME
TOTAL_ACT_WAIT_TIME

reclaim wait time
CF_WAIT_TIME
TOTAL_ACT_WAIT_TIME
EVMON_WAIT_TIME
TOTAL_ACT_WAIT_TIME
_WAIT_TIME
TOTAL_ACT_WAIT_TIME

latch wait time
PREFETCH_WAIT_TIME
TOTAL_ACT_WAIT_TIME
NULL

queue time
IDA_SEND_WAIT_TIME
TOTAL_WAIT_TIME

IDA_RECV_WAIT_TIME
TOTAL_WAIT_TIME

MON_GET_ACTIVITY table function - Return a list of activities:

The MON_GET_ACTIVITY function returns the list of all activities that were
submitted by the specified application on the specified member and have not yet
been completed.
returned.
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority
None
Syntax
MON_GET_ACTIVITY (
application_handle
member
475
Routine parameters
application_handle
An input argument of type BIGINT that specifies an application handle for
which a list of activities is to be returned. If the argument is null, the data is
retrieved for all the applications in the database.
member
An input argument of type INTEGER that specifies a valid member number in
the same instance as the currently connected database. Specify -1 for the
current member, or -2 for all members. If the null value is specified, -1 is set
implicitly.
Table 126. Information returned by the MON_GET_ACTIVITY routine
Column name
Data type
Description
APPLICATION_HANDLE
BIGINT
application_handle - Application handle monitor

element
DBPARTITIONNUM
SMALLINT

monitor element
COORD_PARTITION_NUM
SMALLINT
coord_partition_num - Coordinator partition

LOCAL_START_TIME
TIMESTAMP
local_start_time - Local start time monitor element
UOW_ID
INTEGER
uow_id - Unit of work ID monitor element
ACTIVITY_ID
INTEGER
activity_id - Activity ID monitor element
PARENT_UOW_ID
INTEGER
parent_uow_id - Parent unit of work ID monitor

element
PARENT_ACTIVITY_ID
INTEGER
parent_activity_id - Parent activity ID monitor

element
ACTIVITY_STATE
VARCHAR(32)
activity_state - Activity state monitor element

Possible values are as follows:
QUEUED
The activity is queued by a workload
management queuing threshold. In a
partitioned database environment, this
state might mean that the coordinator
agent has made an RPC to the catalog
member to obtain threshold tickets and
has not yet received a response. This
state might indicate that the activity has
been queued by a workload
management queuing threshold or, if
not much time has elapsed, can indicate
that the activity is in the process of
obtaining its tickets. To obtain a more
accurate picture of whether the activity
is being queued, determine what agent
is working on the activity, and find out
whether the EVENT_OBJECT value of
the object at the catalog member has a
value of WLM_QUEUE.
TERMINATING
The activity has finished running and is
being removed from the system.
476
Table 126. Information returned by the MON_GET_ACTIVITY routine (continued)

Column name
Data type
Description
ACTIVITY_TYPE
VARCHAR(32)
Activity type. Possible values are as follows:

v CALL
v DDL
v LOAD
v OTHER
v READ_DML
v WRITE_DML
NESTING_LEVEL
INTEGER
nesting_level - Nesting level monitor element
INVOCATION_ID
INTEGER
invocation_id - Invocation ID monitor element
ROUTINE_ID
INTEGER
routine_id - Routine ID monitor element
UTILITY_ID
INTEGER
utility_id - Utility ID monitor element
SERVICE_CLASS_ID
INTEGER
service_class_id - Service class ID monitor element
DATABASE_WORK_ACTION_SET_ID
INTEGER
One of the following values:

v If this activity has been categorized into a work
class of database scope, the value is the ID of
the work class set of which this work class is a
member.
v If this activity has not been categorized into a
work class of database scope, the value is null.
DATABASE_WORK_CLASS_ID
INTEGER

class of database scope, the value is the ID of
the work class.
work class of database scope, the value is null.
SERVICE_CLASS_WORK_ACTION_SET_ID
INTEGER

class of service class scope, the value is the ID
of the work action set associated with the work
class set to which the work class belongs.
work class of service class scope, the value is
null.
SERVICE_CLASS_WORK_CLASS_ID
INTEGER

class of service class scope, the value is the ID
of the work class assigned to this activity.
work class of service class scope, the value is
null.
EXECUTABLE_ID
VARCHAR(32) FOR
BIT DATA
executable_id - Executable ID monitor element
TOTAL_CPU_TIME
BIGINT
ROWS_READ
BIGINT
ROWS_RETURNED
BIGINT
QUERY_COST_ESTIMATE
BIGINT
query_cost_estimate - Query cost estimate
DIRECT_READS
BIGINT
DIRECT_WRITES
BIGINT
ENTRY_TIME
TIMESTAMP
entry_time - Entry time
MEMBER
SMALLINT
477

Column name
Data type
Description
COORD_MEMBER
SMALLINT
coord_member - Coordinator member monitor

element
PACKAGE_SCHEMA
VARCHAR(128)
package_schema - Package schema
PACKAGE_NAME
VARCHAR(128)
package_name - Package name
PACKAGE_VERSION_ID
VARCHAR(64)
package_version_id - Package version
SECTION_NUMBER
BIGINT
section_number - Section number
STMTNO
INTEGER
stmtno - Statement number monitor element
APPL_ID
VARCHAR(128)
appl_id - Application ID monitor element
CLIENT_ACCTNG
VARCHAR(255)
client_acctng - Client accounting string monitor

element
CLIENT_APPLNAME
VARCHAR(255)
client_applname - Client application name

monitor element
CLIENT_USERID
VARCHAR(255)
client_userid - Client user ID monitor element
CLIENT_WRKSTNNAME
VARCHAR(255)
client_wrkstnname - Client workstation name

monitor element
EFFECTIVE_ISOLATION
CHAR(2)
effective_isolation - Effective isolation monitor

element
EFFECTIVE_LOCK_TIMEOUT
BIGINT
effective_lock_timeout - Effective lock timeout

monitor element
EFFECTIVE_QUERY_DEGREE
BIGINT
effective_query_degree - Effective query degree

monitor element
ACTIVITYTOTALTIME_THRESHOLD_ID
INTEGER
activitytotaltime_threshold_id - Activity total time

threshold ID monitor element
ACTIVITYTOTALTIME_THRESHOLD_VALUE
BIGINT
activitytotaltime_threshold_value - Activity total

time threshold value monitor element
ACTIVITYTOTALTIME_THRESHOLD_
VIOLATED
SMALLINT
activitytotaltime_threshold_violated - Activity total

time threshold violated monitor element
AGGSQLTEMPSPACE_THRESHOLD_ID
INTEGER
aggsqltempspace_threshold_id - Aggregate SQL

temporary space threshold ID monitor element
AGGSQLTEMPSPACE_THRESHOLD_VALUE
BIGINT
aggsqltempspace_threshold_value - AggSQL
temporary space threshold value monitor element
AGGSQLTEMPSPACE_THRESHOLD_
VIOLATED
SMALLINT
aggsqltempspace_threshold_violated - AggSQL
temporary space threshold violated monitor
element
CONCURRENTDBCOORDACTIVITIES_
DB_THRESHOLD_ID
INTEGER
concurrentdbcoordactivities_db_threshold_id Concurrent database coordinator activities

database threshold ID monitor element
DB_THRESHOLD_QUEUED
SMALLINT
concurrentdbcoordactivities_
db_threshold_queued - Concurrent database
coordinator activities database threshold queued
monitor element
DB_THRESHOLD_VALUE
BIGINT
db_threshold_value - Concurrent database
coordinator activities database threshold value
monitor element
DB_THRESHOLD_VIOLATED
SMALLINT
db_threshold_violated - Concurrent database
coordinator activities database threshold violated
monitor element
SUBCLASS_THRESHOLD_ID
INTEGER
subclass_threshold_id - Concurrent database
coordinator activities service subclass threshold ID
monitor element
478

Column name
Data type
Description
SUBCLASS_THRESHOLD_QUEUED
SMALLINT
subclass_threshold_queued - Concurrent database
coordinator activities service subclass threshold
queued monitor element
SUBCLASS_THRESHOLD_VALUE
BIGINT
subclass_threshold_value - Concurrent database
value monitor element
SUBCLASS_THRESHOLD_VIOLATED
SMALLINT
subclass_threshold_violated - Concurrent database
violated monitor element
SUPERCLASS_THRESHOLD_ID
INTEGER
superclass_threshold_id - Concurrent database
coordinator activities service superclass threshold
ID monitor element
SUPERCLASS_THRESHOLD_QUEUED
SMALLINT
concurrentdbcoordactivities_s
uperclass_threshold_queued - Concurrent database
SUPERCLASS_THRESHOLD_VALUE
BIGINT
superclass_threshold_value - Concurrent database
SUPERCLASS_THRESHOLD_VIOLATED
SMALLINT
superclass_threshold_violated - Concurrent
database coordinator activities service superclass
threshold violated monitor element
WL_WAS_THRESHOLD_ID
INTEGER
wl_was_threshold_id - Concurrent database
coordinator activities workload work action set
WL_WAS_THRESHOLD_QUEUED
SMALLINT
wl_was_threshold_queued - Concurrent database
threshold queued monitor element
WL_WAS_THRESHOLD_VALUE
BIGINT
wl_was_threshold_value - Concurrent database
threshold value monitor element
WL_WAS_THRESHOLD_VIOLATED
SMALLINT
wl_was_threshold_violated - Concurrent database
WORK_ACTION_SET_THRESHOLD_ID
INTEGER
work_action_set_threshold_id - Concurrent
database coordinator activities work action set
WORK_ACTION_SET_THRESHOLD_QUEUED
SMALLINT
work_action_set_threshold_queued - Concurrent
threshold queued monitor element
WORK_ACTION_SET_THRESHOLD_VALUE
BIGINT
work_action_set_threshold_value - Concurrent
479

Column name
Data type
Description
WORK_ACTION_SET_
THRESHOLD_VIOLATED
SMALLINT
work_action_set_threshold_violated - Concurrent
CONCURRENTWORKLOADACTIVITIES_
THRESHOLD_ID
INTEGER
concurrentworkloadactivities_
threshold_id - Concurrent workload activities
THRESHOLD_VALUE
BIGINT
threshold_value - Concurrent workload activities
THRESHOLD_VIOLATED
SMALLINT
threshold_violated - Concurrent workload
activities threshold violated monitor element
CPUTIME_THRESHOLD_ID
INTEGER
cputime_threshold_id - CPU time threshold ID

monitor element
CPUTIME_THRESHOLD_VALUE
BIGINT
cputime_threshold_value - CPU time threshold

CPUTIME_THRESHOLD_VIOLATED
SMALLINT
cputime_threshold_violated - CPU time threshold

CPUTIMEINSC_THRESHOLD_ID
INTEGER
cputimeinsc_threshold_id - CPU time in service

class threshold ID monitor element
CPUTIMEINSC_THRESHOLD_VALUE
BIGINT
cputimeinsc_threshold_value - CPU time in

service class threshold value monitor element
CPUTIMEINSC_THRESHOLD_VIOLATED
SMALLINT
cputimeinsc_threshold_violated - CPU time in

service class threshold violated monitor element
DATATAGINSC_THRESHOLD_ID
INTEGER
datataginsc_threshold_id - Data tag in service

class threshold (IN condition) ID monitor element
DATATAGINSC_THRESHOLD_VALUE
VARCHAR(32)
datataginsc_threshold_value - Data tag in service

class threshold (IN condition) value monitor
element
DATATAGINSC_THRESHOLD_VIOLATED
SMALLINT
datataginsc_threshold_violated - Data tag in

service class threshold (IN condition) violated
monitor element
DATATAGNOTINSC_THRESHOLD_ID
INTEGER
datatagnotinsc_threshold_id - Data tag in service

class threshold (NOT IN condition) IDmonitor
element
DATATAGNOTINSC_THRESHOLD_VALUE
VARCHAR(32)
datatagnotinsc_threshold_value - Data tag in

service class threshold (NOT IN condition) value
monitor element
DATATAGNOTINSC_THRESHOLD_VIOLATED
SMALLINT
datatagnotinsc_threshold_violated - Data tag in

service class threshold (NOT IN condition)
ESTIMATEDSQLCOST_THRESHOLD_ID
INTEGER
estimatedsqlcost_threshold_id - Estimated SQL

cost threshold ID monitor element
ESTIMATEDSQLCOST_THRESHOLD_VALUE
BIGINT
estimatedsqlcost_threshold_value - Estimated SQL

cost threshold value monitor element
ESTIMATEDSQLCOST_
THRESHOLD_VIOLATED
SMALLINT
estimatedsqlcost_threshold_violated - Estimated
SQL cost threshold violated monitor element
LAST_REFERENCE_TIME
TIMESTAMP
last_reference_time - Last reference time monitor

element
QUERY_DATA_TAG_LIST
VARCHAR(32)
query_data_tag_list - Estimated query data tag list

monitor element
QUERY_ACTUAL_DEGREE
INTEGER
query_actual_degree - Actual runtime degree of

intrapartition parallelism monitor element
480

Column name
Data type
Description
SQLROWSREAD_THRESHOLD_ID
INTEGER
sqlrowsread_threshold_id - SQL rows read

SQLROWSREAD_THRESHOLD_VALUE
BIGINT
sqlrowsread_threshold_value - SQL rows read

SQLROWSREAD_THRESHOLD_VIOLATED
SMALLINT
sqlrowsread_threshold_violated - SQL rows read

SQLROWSREADINSC_THRESHOLD_ID
INTEGER
sqlrowsreadinsc_threshold_id - SQL rows read in

service class threshold ID monitor element
SQLROWSREADINSC_THRESHOLD_VALUE
BIGINT
sqlrowsreadinsc_threshold_value - SQL rows read

in service class threshold value monitor element
SQLROWSREADINSC_
THRESHOLD_VIOLATED
SMALLINT
sqlrowsreadinsc_threshold_violated - SQL rows

read in service class threshold violated monitor
element
SQLROWSRETURNED_THRESHOLD_ID
INTEGER
sqlrowsreturned_threshold_id - SQL rows read

returned threshold ID monitor element
SQLROWSRETURNED_THRESHOLD_VALUE
BIGINT
sqlrowsreturned_threshold_value - SQL rows read

returned threshold value monitor element
SQLROWSRETURNED_
THRESHOLD_VIOLATED
SMALLINT
sqlrowsreturned_threshold_violated - SQL rows

read returned threshold violated monitor element
SQLTEMPSPACE_THRESHOLD_ID
INTEGER
sqltempspace_threshold_id - SQL temporary space

SQLTEMPSPACE_THRESHOLD_VALUE
BIGINT
sqltempspace_threshold_value - SQL temporary

space threshold value monitor element
SQLTEMPSPACE_THRESHOLD_VIOLATED
SMALLINT
sqltempspace_threshold_violated - SQL temporary

space threshold violated monitor element
WL_WORK_ACTION_SET_ID
INTEGER
wl_work_action_set_id - Workload work action set

WL_WORK_CLASS_ID
INTEGER
wl_work_class_id - Workload work class identifier

monitor element
STMT_TEXT
CLOB(2M)
stmt_text - SQL statement text monitor element
EFF_STMT_TEXT
CLOB(2M)
eff_stmt_text - Effective statement text monitor

element
IS_SYSTEM_APPL
SMALLINT
is_system_appl - Is System Application monitor

element
NUM_AGENTS
BIGINT
num_agents - Number of Agents Working on a

Statement monitor element
AGENTS_TOP
BIGINT
agents_top - Number of Agents Created monitor

element
QUERY_CARD_ESTIMATE
BIGINT
query_card_estimate - Query Number of Rows

Estimate monitor element
VARCHAR(32) FOR
BIT DATA
utility_invocation_id - Utility invocation ID

monitor element
STMT_PKG_CACHE_ID
INTEGER
stmt_pkgcache_id - Statement package cache

INTRA_PARALLEL_STATE
VARCHAR(3)
intra_parallel_state - Current state of intrapartition

parallelism monitor element
NUM_ROUTINES
BIGINT
num_routines - Number of routines monitor

element
TOTAL_ACT_TIME
BIGINT
total_act_time - Total activity time monitor

element
TOTAL_ACT_WAIT_TIME
BIGINT

monitor element
481

Column name
Data type
Description
POOL_READ_TIME
BIGINT

time monitor element
POOL_WRITE_TIME
BIGINT

DIRECT_READ_TIME
BIGINT
direct_read_time - Direct read time monitor

element
DIRECT_WRITE_TIME
BIGINT
direct_write_time - Direct write time monitor

element
LOCK_WAIT_TIME
BIGINT
lock_wait_time - Time waited on locks monitor

element
BIGINT

monitor element
BIGINT

processing time monitor element
TOTAL_SECTION_SORTS
BIGINT
total_section_sorts - Total section sorts monitor

element
LOCK_ESCALS
BIGINT
lock_escals - Number of lock escalations monitor

element
LOCK_WAITS
BIGINT
lock_waits - Lock waits monitor element
ROWS_MODIFIED
BIGINT
rows_modified - Rows modified monitor element
DIRECT_READ_REQS
BIGINT
direct_read_reqs - Direct read requests monitor

element
DIRECT_WRITE_REQS
BIGINT
direct_write_reqs - Direct write requests monitor

element
POOL_DATA_L_READS
BIGINT

monitor element
BIGINT
pool_temp_data_l_reads - Buffer pool temporary

data logical reads monitor element
POOL_XDA_L_READS
BIGINT
pool_xda_l_reads - Buffer pool XDA data logical

reads monitor element
BIGINT
pool_temp_xda_l_reads - Buffer pool temporary

XDA data logical reads monitor element
POOL_INDEX_L_READS
BIGINT
pool_index_l_reads - Buffer pool index logical

BIGINT
pool_temp_index_l_reads - Buffer pool temporary

index logical reads monitor element
POOL_DATA_P_READS
BIGINT
pool_data_p_reads - Buffer pool data physical

BIGINT
pool_temp_data_p_reads - Buffer pool temporary

data physical reads monitor element
POOL_XDA_P_READS
BIGINT
pool_xda_p_reads - Buffer pool XDA data physical

BIGINT
pool_temp_xda_p_reads - Buffer pool temporary

XDA data physical reads monitor element
POOL_INDEX_P_READS
BIGINT
pool_index_p_reads - Buffer pool index physical

BIGINT
pool_temp_index_p_reads - Buffer pool temporary

index physical reads monitor element
POOL_DATA_WRITES
BIGINT
pool_data_writes - Buffer pool data writes monitor

element
POOL_XDA_WRITES
BIGINT

monitor element
482

Column name
Data type
Description
POOL_INDEX_WRITES
BIGINT

monitor element
TOTAL_SORTS
BIGINT
total_sorts - Total sorts monitor element
BIGINT

monitor element
BIGINT
post_shrthreshold_sorts - Post shared threshold

sorts monitor element
SORT_OVERFLOWS
BIGINT
sort_overflows - Sort overflows monitor element
BIGINT

queue time monitor element
BIGINT
wlm_queue_assignments_total - Workload
manager total queue assignments monitor element
DEADLOCKS
BIGINT
deadlocks - Deadlocks detected monitor element
FCM_RECV_VOLUME
BIGINT
fcm_recv_volume - FCM received volume monitor

element
FCM_RECVS_TOTAL
BIGINT
fcm_recvs_total - FCM receives total monitor

element
FCM_SEND_VOLUME
BIGINT
fcm_send_volume - FCM send volume monitor

element
FCM_SENDS_TOTAL
BIGINT
fcm_sends_total - FCM sends total monitor

element
FCM_RECV_WAIT_TIME
BIGINT

monitor element
FCM_SEND_WAIT_TIME
BIGINT

monitor element
LOCK_TIMEOUTS
BIGINT
lock_timeouts - Number of lock timeouts monitor

element
BIGINT

monitor element
NUM_LOG_BUFFER_FULL
BIGINT
num_log_buffer_full - Number of times full log

buffer caused agents to wait monitor element
LOG_DISK_WAIT_TIME
BIGINT
log_disk_wait_time - Log disk wait time monitor

element
BIGINT
log_disk_waits_total - Total log disk waits monitor

element
TOTAL_ROUTINE_TIME
BIGINT
total_routine_time - Total routine time monitor

element
BIGINT
total_routine_invocations - Total routine

invocations monitor elements
BIGINT
coord_stmt_exec_time - Execution time for

statement by coordinator agent monitor element
STMT_EXEC_TIME
BIGINT

monitor element
TOTAL_SECTION_TIME
BIGINT
total_section_time - Total section time monitor

element
BIGINT

TOTAL_ROUTINE_NON_SECT_TIME
BIGINT
total_routine_non_sect_time - Non-section routine

execution time monitor elements
TOTAL_ROUTINE_NON_SECT_PROC_TIME
BIGINT
LOCK_WAITS_GLOBAL
BIGINT
lock_waits_global - Lock waits global monitor

element
483

Column name
Data type
Description
BIGINT

monitor element
BIGINT

monitor element
BIGINT
lock_escals_maxlocks - Number of maxlocks lock

escalations monitor element
BIGINT
lock_escals_locklist - Number of locklist lock

LOCK_ESCALS_GLOBAL
BIGINT
lock_escals_global - Number of global lock

RECLAIM_WAIT_TIME
BIGINT
reclaim_wait_time - Reclaim wait time monitor

element
SPACEMAPPAGE_RECLAIM_WAIT_TIME
BIGINT

page reclaim wait time monitor element
CF_WAITS
BIGINT

monitor element
CF_WAIT_TIME
BIGINT

monitor element
BIGINT
pool_data_gbp_l_reads - Group buffer pool data

logical reads monitor element
BIGINT
pool_data_gbp_p_reads - Group buffer pool data

physical reads monitor element
BIGINT
pool_data_lbp_pages_found - Local buffer pool

found data pages monitor element
BIGINT
pool_data_gbp_invalid_pages - Group buffer pool

invalid data pages monitor element
BIGINT
pool_index_gbp_l_reads - Group buffer pool index

BIGINT
pool_index_gbp_p_reads - Group buffer pool

index physical reads monitor elements
BIGINT
pool_index_lbp_pages_found - Local buffer pool

index pages found monitor element
BIGINT
pool_index_gbp_invalid_pages - Group buffer

pool invalid index pages monitor element
BIGINT
pool_xda_gbp_l_reads - Group buffer pool XDA

data logical read requests monitor element
BIGINT
pool_xda_gbp_p_reads - Group buffer pool XDA

data physical read requests monitor element
BIGINT
pool_xda_lbp_pages_found - Local buffer pool

XDA data pages found monitor element
BIGINT
pool_xda_gbp_invalid_pages - Group buffer pool

invalid XDA data pages monitor element
AUDIT_EVENTS_TOTAL
BIGINT
audit_events_total - Total audit events monitor

element
BIGINT

monitor element
BIGINT

BIGINT
audit_subsystem_waits_total - Total audit

subsystem waits monitor element
BIGINT
audit_subsystem_wait_time - Audit subsystem

484

Column name
Data type
Description
BIGINT
diaglog_writes_total - Total diagnostic log file

writes monitor element
BIGINT

BIGINT
fcm_message_recvs_total - Total FCM message

receives monitor element
BIGINT
fcm_message_recv_volume - FCM message

received volume monitor element
BIGINT

received wait time monitor element
BIGINT
fcm_message_sends_total - Total FCM message

sends monitor element
BIGINT
fcm_message_send_volume - FCM message send

volume monitor element
BIGINT
fcm_message_send_wait_time - FCM message

send wait time monitor element
FCM_TQ_RECVS_TOTAL
BIGINT
fcm_tq_recvs_total - FCM table queue receives

total monitor element
FCM_TQ_RECV_VOLUME
BIGINT
fcm_tq_recv_volume - FCM table queue received

BIGINT
fcm_tq_recv_wait_time - FCM table queue

FCM_TQ_SENDS_TOTAL
BIGINT

monitor element
FCM_TQ_SEND_VOLUME
BIGINT
fcm_tq_send_volume - FCM table queue send

BIGINT

BIGINT
num_lw_thresh_exceeded - Number of lock wait

thresholds exceeded monitor element
THRESH_VIOLATIONS
BIGINT

monitor element
BIGINT
total_app_section_executions - Total application

section executions monitor element
TOTAL_ROUTINE_USER_CODE_PROC_TIME
BIGINT

user code processing time monitor element
BIGINT
total_routine_user_code_time - Total routine user

code time monitor element
TQ_TOT_SEND_SPILLS
BIGINT
tq_tot_send_spills - Total number of table queue

buffers overflowed monitor element
EVMON_WAIT_TIME
BIGINT

monitor element
EVMON_WAITS_TOTAL
BIGINT

monitor element
TOTAL_EXTENDED_LATCH_WAIT_TIME
BIGINT

latch wait time monitor element
BIGINT
total_extended_latch_waits - Total extended latch

waits monitor element
BIGINT
total_disp_run_queue_time - Total dispatcher run

TOTAL_PEDS
BIGINT
total_peds - Total partial early distincts monitor

element
485

Column name
Data type
Description
DISABLED_PEDS
BIGINT

monitor element
POST_THRESHOLD_PEDS
BIGINT
post_threshold_peds - Partial early distincts

threshold monitor element
TOTAL_PEAS
BIGINT

monitor element
POST_THRESHOLD_PEAS
BIGINT
post_threshold_peas - Partial early aggregation

BIGINT
tq_sort_heap_requests - Table queue sort heap

requests monitor element
BIGINT
tq_sort_heap_rejections - Table queue sort heap

rejections monitor element
BIGINT
pool_queued_async_data_reqs - Data prefetch

BIGINT
pool_queued_async_index_reqs - Index prefetch

BIGINT
pool_queued_async_xda_reqs - XDA prefetch

POOL_QUEUED_ASYNC_TEMP_DATA_REQS
BIGINT
pool_queued_async_temp_data_reqs - Data
prefetch requests for temporary table spaces
monitor element
POOL_QUEUED_ASYNC_TEMP_INDEX_REQS
BIGINT
pool_queued_async_temp_index_reqs - Index
monitor element
POOL_QUEUED_ASYNC_TEMP_XDA_REQS
BIGINT
pool_queued_async_temp_xda_reqs - XDA data

monitor element
BIGINT
pool_queued_async_other_reqs - Other requests

handled by prefetchers monitor element
BIGINT
pool_queued_async_data_pages - Data pages

prefetch requests monitor element
POOL_QUEUED_ASYNC_INDEX_PAGES
BIGINT
pool_queued_async_index_pages - Index pages

BIGINT
pool_queued_async_xda_pages - XDA pages

POOL_QUEUED_ASYNC_TEMP_DATA_PAGES
BIGINT
pool_queued_async_temp_data_pages - Data
pages prefetch requests for temporary table spaces
monitor element
POOL_QUEUED_ASYNC_
TEMP_INDEX_PAGES
BIGINT
pool_queued_async_temp_index_pages - Index
monitor element
POOL_QUEUED_ASYNC_TEMP_XDA_PAGES
BIGINT
pool_queued_async_temp_xda_pages - XDA data

monitor element
BIGINT
pool_failed_async_data_reqs - Failed data prefetch

BIGINT
pool_failed_async_index_reqs - Failed index

BIGINT
pool_failed_async_xda_reqs - Failed XDA prefetch

POOL_FAILED_ASYNC_TEMP_DATA_REQS
BIGINT
pool_failed_async_temp_data_reqs - Failed data

monitor element
486

Column name
Data type
Description
POOL_FAILED_ASYNC_TEMP_INDEX_REQS
BIGINT
pool_failed_async_temp_index_reqs - Failed index

monitor element
POOL_FAILED_ASYNC_TEMP_XDA_REQS
BIGINT
pool_failed_async_temp_xda_reqs - Failed XDA

monitor element
BIGINT
pool_failed_async_other_reqs - Failed non-prefetch

PREFETCH_WAIT_TIME
BIGINT

monitor element
PREFETCH_WAITS
BIGINT
prefetch_waits - Prefetcher wait count monitor

element
POOL_DATA_GBP_INDEP_PAGES_FOUND_
IN_LBP
BIGINT
pool_data_gbp_indep_pages_found_in_lbp Group buffer pool independent data pages found

in local buffer pool monitor element
POOL_INDEX_GBP_INDEP_PAGES_FOUND_
IN_LBP
BIGINT
pool_index_gbp_indep_pages_found_in_lbp Group buffer pool independent index pages found

POOL_XDA_GBP_INDEP_PAGES_FOUND_
IN_LBP
BIGINT
pool_xda_gbp_indep_pages_found_in_lbp - Group
buffer pool XDA independent pages found in local
buffer pool monitor element
IDA_SEND_WAIT_TIME
BIGINT
ida_send_wait_time - Time spent waiting to send

data monitor element
IDA_SENDS_TOTAL
BIGINT
ida_sends_total - Number of times data sent

monitor element
IDA_SEND_VOLUME
BIGINT
ida_send_volume - Total data volume sent

monitor element
IDA_RECV_WAIT_TIME
BIGINT
ida_recv_wait_time - Time spent waiting to

receive data monitor element
IDA_RECVS_TOTAL
BIGINT
ida_recvs_total - Number of times data received

monitor element
IDA_RECV_VOLUME
BIGINT
ida_recv_volume - Total data volume received

monitor element
ROWS_DELETED
BIGINT
rows_deleted - Rows deleted monitor element
ROWS_INSERTED
BIGINT
rows_inserted - Rows inserted monitor element
ROWS_UPDATED
BIGINT
rows_updated - Rows updated monitor element
TOTAL_HASH_JOINS
BIGINT
total_hash_joins - Total Hash Joins monitor

element
TOTAL_HASH_LOOPS
BIGINT
total_hash_loops - Total Hash Loops monitor

element
HASH_JOIN_OVERFLOWS
BIGINT
hash_join_overflows - Hash Join Overflows

monitor element
HASH_JOIN_SMALL_OVERFLOWS
BIGINT
hash_join_small_overflows - Hash Join Small

Overflows monitor element
POST_SHRTHRESHOLD_HASH_JOINS
BIGINT
post_shrthreshold_hash_joins - Post threshold

hash joins monitor element
TOTAL_OLAP_FUNCS
BIGINT
total_olap_funcs - Total OLAP Functions monitor

element
OLAP_FUNC_OVERFLOWS
BIGINT
olap_func_overflows - OLAP Function Overflows

monitor element
INT_ROWS_DELETED
BIGINT
int_rows_deleted - Internal Rows Deleted monitor

element
INT_ROWS_INSERTED
BIGINT
int_rows_inserted - Internal Rows Inserted

monitor element
487

Column name
Data type
Description
INT_ROWS_UPDATED
BIGINT
int_rows_updated - Internal Rows Updated

monitor element
POOL_COL_L_READS
BIGINT
pool_col_l_reads - Buffer pool column-organized

BIGINT
pool_temp_col_l_reads - Buffer pool

column-organized temporary logical reads
monitor element
POOL_COL_P_READS
BIGINT
pool_col_p_reads - Buffer pool column-organized

BIGINT
pool_temp_col_p_reads - Buffer pool

column-organized temporary physical reads
monitor element
BIGINT
pool_col_lbp_pages_found - Buffer pool

column-organized LBP pages found monitor
element
POOL_COL_WRITES
BIGINT
pool_col_writes - Buffer pool column-organized

BIGINT
pool_col_gbp_l_reads - Buffer pool

column-organized GBP logical reads monitor
element
BIGINT
pool_col_gbp_p_reads - Buffer pool

column-organized GBP physical reads monitor
element
BIGINT
pool_col_gbp_invalid_pages - Buffer pool

column-organized GBP invalid data pages monitor
element
POOL_COL_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
pool_col_gbp_indep_pages_found_in_lbp - Buffer
pool column-organized GBP independent pages
found in local buffer pool monitor element
BIGINT
pool_queued_async_col_reqs - Column-organized
POOL_QUEUED_ASYNC_TEMP_COL_REQS
BIGINT
pool_queued_async_temp_col_reqs Column-organized temporary prefetch requests

monitor element
BIGINT
pool_queued_async_col_pages Column-organized page prefetch requests monitor

element
POOL_QUEUED_ASYNC_TEMP_COL_PAGES
BIGINT
pool_queued_async_temp_col_pages Column-organized page temporary prefetch

BIGINT

POOL_FAILED_ASYNC_TEMP_COL_REQS
BIGINT
pool_failed_async_col_reqs - Failed
column-organized prefetch requests monitor
element
TOTAL_COL_TIME
BIGINT

monitor element
TOTAL_COL_PROC_TIME
BIGINT
total_col_proc_time - Total column-organized

BIGINT
total_col_executions - Total column-organized

executions monitor element
COMM_EXIT_WAIT_TIME
BIGINT

wait time
488

Column name
Data type
Description
COMM_EXIT_WAITS
BIGINT
comm_exit_waits - Communication buffer exit

number of waits
POST_THRESHOLD_HASH_JOINS
BIGINT
post_threshold_hash_joins - Hash Join Threshold

monitor element
POOL_DATA_CACHING_TIER_
L_READS
BIGINT
Reserved for future use.
POOL_INDEX_CACHING_TIER_
L_READS
BIGINT
POOL_XDA_CACHING_TIER_
L_READS
BIGINT
POOL_COL_CACHING_TIER_
L_READS
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
POOL_CACHING_TIER_PAGE_
READ_TIME
BIGINT
WRITE_TIME
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INDEP_PAGES_FOUND
BIGINT
BIGINT
489

Column name
Data type
Description
BIGINT
BIGINT
TOTAL_HASH_GRPBYS
BIGINT
total_hash_grpbys - Total hash group by

operations
BIGINT
BIGINT
post_threshold_hash_grpbys - Hash group by

threshold
POST_THRESHOLD_OLAP_FUNCS
BIGINT
post_threshold_olap_funcs - OLAP function

Examples
Activities currently running with a known application handle
After you identify the application handle, you can look up all the activities
currently running in this application. For example, suppose that an
administrator wants to list the activities of an application whose
application handle, determined by using the LIST APPLICATIONS command,
is 1. The administrator runs the following query:
SELECT SUBSTR(CHAR(COORD_MEMBER),1,5) AS COORD,
SUBSTR(CHAR(MEMBER),1,4) AS MEMB,
SUBSTR(CHAR(UOW_ID),1,5) AS UOWID,
SUBSTR(CHAR(ACTIVITY_ID),1,5) AS ACTID,
SUBSTR(CHAR(PARENT_UOW_ID),1,8) AS PARUOWID,
SUBSTR(CHAR(PARENT_ACTIVITY_ID),1,8) AS PARACTID,
ACTIVITY_TYPE AS ACTTYPE,
SUBSTR(CHAR(NESTING_LEVEL),1,7) AS NESTING
FROM TABLE(MON_GET_ACTIVITY(1, -2)) AS WLOACTS
ORDER BY MEMB, UOWID, ACTID
Sample output from the query is as follows:

COORD
----0
0
MEMB
---0
0
UOWID
----2
2
ACTID
----3
5
PARUOWID
-------2
PARACTID
-------3
ACTTYPE
-------CALL
READ_DML
NESTING
------0
1
Activities currently running on the system

The following query uses MON_GET_ACTIVITY to provide statement text
for all SQL activities currently running on the system:
SELECT t.application_handle, t.uow_id, t.activity_id,
VARCHAR(t.stmt_text, 256) as stmt_text
FROM table(MON_GET_ACTIVITY(NULL, -1)) as t

APPLICATION_HANDLE
-----------------1
47
UOW_ID
----------1
1
ACTIVITY_ID
-------------1
36
STMT_TEXT
-----------------------------SELECT * FROM SYSCAT.TABLES
INSERT INTO T1 VALUES(123)
MON_GET_ACTIVITY_DETAILS table function - Get complete activity details:

The MON_GET_ACTIVITY_DETAILS table function returns details about an
activity, including general activity information (like statement text) and a set of
metrics for the activity.
490
Authorization
v
v
v
v

DBADM authority
SQLADM authority

None
Syntax
MON_GET_ACTIVITY_DETAILS (
activity_id ,
member
application_handle
, uow_id

Routine parameters
application_handle
An input argument of type BIGINT that specifies a valid application handle. If
the argument is null, no rows are returned from this function, and an
SQL0171N error is returned.
uow_id
An input argument of type INTEGER that specifies a valid unit of work
identifier unique within the application. If the argument is null, no rows are
returned from this function, and an SQL0171N error is returned.
activity_id
An input argument of type INTEGER that specifies a valid activity ID unique
within the unit of work. If the argument is null, no rows are returned from this
function, and an SQL0171N error is returned.
member
the same instance as the currently connected database when calling this
function. Specify -1 for the current database member, or -2 for all database
members. If the null value is specified, -1 is set implicitly.
Table 127. Information returned for MON_GET_ACTIVITY_DETAILS
Column name
Data type
Description
APPLICATION_HANDLE
BIGINT
application_handle - Application handle
UOW_ID
INTEGER
uow_id - Unit of work ID
ACTIVITY_ID
INTEGER
activity_id - Activity ID
MEMBER
SMALLINT
DETAILS
BLOB(8M)
XML document that contains activity details. See

Table 128 on page 492 for a description of the elements in
this document.
491
The following example shows the structure of the XML document that is returned
in the DETAILS column.
<db2_activity_details xmlns="http://www.ibm.com/xmlns/prod/db2/mon" release="90700000">
<member>0</member>
<application_handle>70</application_handle>
<activity_id>1</activity_id>
<activity_state>IDLE</activity_state>
<activity_type>READ_DML</activity_type>
<uow_id>1</uow_id>
...
<activity_metrics release="90700000">
<lock_wait_time>2000</lock_wait_time>
...
</activity_metrics>
</db2_activity_details>
For the full schema, see sqllib/misc/DB2MonRoutines.xsd. This document uses the
following XML non-primitive type definitions:
<xs:simpleType name = "executable_id_type" >
<xs:annotation>
<xs:documentation>
The binary Executable ID
</xs:documentation>
</xs:annotation>
<xs:restriction base = "xs:hexBinary" >
<xs:maxLength value = "32" />
</xs:restriction>
</xs:simpleType>
Detailed metrics returned

Table 128. Detailed metrics returned for MON_GET_ACTIVITY_DETAILS
Element name
Data type
activity_id
xs:nonNegativeInteger activity_id - Activity ID
activity_state
xs:string
activity_state - Activity state
activity_type
xs:string
activity_type - Activity type
activitytotaltime_threshold_id
xs:int
activitytotaltime_threshold_id - Activity total time

threshold ID
activitytotaltime_threshold
_value
xs:dateTime
activitytotaltime_threshold_value - Activity total time

threshold value
activitytotaltime_threshold
_violated
xs:short (1 = yes, 0 =
no)
activitytotaltime_threshold_violated - Activity total time

threshold violated
agents_top
xs:long
agents_top - Number of Agents Created monitor element
aggsqltempspace_threshold_id
xs:int
aggsqltempspace_threshold_id - AggSQL temporary space

threshold ID.
aggsqltempspace_threshold
_value
xs:long
aggsqltempspace_threshold_value - AggSQL temporary

space threshold value
aggsqltempspace_threshold
_violated
no)
aggsqltempspace_threshold_violated - AggSQL temporary

space threshold violated
application_handle
xs:nonNegativeInteger application_handle - Application handle
audit_events_total
xs:nonNegativeInteger audit_events_total - Total audit events
audit_file_write_wait_time
xs:nonNegativeInteger audit_file_write_wait_time - Audit file write wait time
audit_file_writes_total
xs:nonNegativeInteger audit_file_writes_total - Total Audit files written
audit_subsystem_wait_time
xs:nonNegativeInteger audit_subsystem_wait_time - Audit subsystem wait time
492
Table 128. Detailed metrics returned for MON_GET_ACTIVITY_DETAILS (continued)

Element name
Data type
audit_subsystem_waits_total
xs:nonNegativeInteger audit_subsystem_waits_total - Total audit subsystem

waits
client_acctng
xs:string(255)
CURRENT CLIENT_ACCTNG special register
client_applname
xs:string(255)
CURRENT CLIENT_APPLNAME special register
client_userid
xs:string(255)
CURRENT CLIENT_USERID special register
client_wrkstnname
xs:string(255)
CURRENT CLIENT_WRKSTNNAME special register
concurrentdbcoordactivities_db
_threshold_id
xs:int
concurrentdbcoordactivities_db_threshold_id - Concurrent
database coordinator activities threshold ID
_threshold_queued
no)
concurrentdbcoordactivities_db_threshold_queued Concurrent database coordinator activities
_threshold_value
xs:long
concurrentdbcoordactivities_db_threshold_value Concurrent database coordinator activities
_threshold_violated
no)
concurrentdbcoordactivities_db_threshold_violated Concurrent database coordinator activities threshold

violated
concurrentdbcoordactivities
_subclass_threshold_id
xs:int
concurrentdbcoordactivities_subclass_threshold_id Concurrent database coordinator activities subclass

threshold ID
_subclass_threshold_queued
no)
subclass_threshold_queued - Concurrent database
coordinator activities subclass threshold queued
_subclass_threshold_value
xs:long
concurrentdbcoordactivities_subclass_threshold_value Concurrent database coordinator activities subclass

threshold value
_subclass_threshold_violated
no)
subclass_threshold_violated - Concurrent database
coordinator activities subclass threshold violated
_superclass_threshold_id
xs:int
superclass_threshold_id - Concurrent database
coordinator activities superclass
_superclass_threshold_queued
no)
superclass_threshold_queued - Concurrent database
coordinator activities superclass threshold queued
_superclass_threshold_value
xs:long
superclass_threshold_value - Concurrent database
coordinator activities superclass threshold value
_superclass_threshold_violated
no)
superclass_threshold_violated - Concurrent database
coordinator activities superclass threshold violated
_wl_was_threshold_id
xs:int
concurrentdbcoordactivities_wl_was_threshold_id Concurrent database coordinator activities workload work

action set threshold ID
_wl_was_threshold_queued
no)
concurrentdbcoordactivities_wl_was_threshold_queued Concurrent database coordinator activities workload work

action set threshold queued
_wl_was_threshold_value
xs:long
concurrentdbcoordactivities_wl_was_threshold_value Concurrent database coordinator activities workload work

action set threshold value
493

Element name
Data type
_wl_was_threshold_violated
no)
concurrentdbcoordactivities_wl_was_threshold_violated Concurrent database coordinator activities workload work

action set threshold violated
_work_action_set_threshold
_id
xs:int
concurrentdbcoordactivities_work_action
_set_threshold_id - Concurrent database coordinator
activities work action set threshold ID
_queued
no)
_set_threshold_queued - Concurrent database coordinator
activities work action set threshold queued
_value
xs:long
_set_threshold_value - Concurrent database coordinator
activities work action set threshold value
_violated
no)
_set_threshold_violated - Concurrent database coordinator
activities work action set threshold violated
threshold_id
xs:int
concurrentworkloadactivities_threshold_id - Concurrent
workload activities threshold ID monitor element
threshold_value
xs:long
concurrentworkloadactivities_threshold_value Concurrent workload activities threshold value monitor

element
threshold_violated
xs:short
concurrentworkloadactivities_threshold_violated Concurrent workload activities threshold violated monitor

element
coord_member
xs:nonNegativeInteger coord_member - Coordinator member
coord_stmt_exec_time
coord_stmt_exec_time - Execution time for statement by

coordinator agent
cputime_threshold_id
xs:int
cputime_threshold_id - CPU time threshold ID
cputime_threshold_value
xs:long
cputime_threshold_value - CPU time threshold value
cputime_threshold_violated
no)
cputime_threshold_violated - CPU time threshold violated
cputimeinsc_threshold_id
xs:int
cputimeinsc_threshold_id - CPU time in service threshold

ID
cputimeinsc_threshold_value
xs:long
cputimeinsc_threshold_value - CPU time in service

threshold value
cputimeinsc_threshold
_violated
no)
cputimeinsc_threshold_violated - CPU time in service

threshold violated
database_work_action_set_id
xs:nonNegativeInteger db_work_action_set_id - Database work action set ID
database_work_class_id
xs:nonNegativeInteger db_work_class_id - Database work class ID
datataginsc_threshold_id
xs:int
datataginsc_threshold_id - Datataginsc in threshold

identifier
datataginsc_threshold_value
xs:string(32)
datataginsc_threshold_value - Datataginsc in threshold

value
datataginsc_threshold_violated
no)
datataginsc_threshold_violated - Datataginsc in threshold

violated
datatagnotinsc_threshold_id
xs:int
datatagnotinsc_threshold_id - Datatagnotinsc not in

threshold identifier
datatagnotinsc_threshold_value
xs:string(32)
datatagnotinsc_threshold_value - Datatagnotinsc not in

threshold value
494

Element name
Data type
datatagnotinsc_threshold
_violated
no)
datatagnotinsc_threshold_violated - Datatagnotinsc not in

threshold violated
deadlocks
xs:nonNegativeInteger deadlocks - Deadlocks detected
diaglog_write_wait_time
xs:nonNegativeInteger diaglog_write_wait_time - Diag log write time
diaglog_writes_total
xs:nonNegativeInteger diaglog_writes_total - Diag log total writes
direct_read_reqs
xs:nonNegativeInteger direct_read_reqs - Direct read requests
direct_read_time
xs:nonNegativeInteger direct_read_time - Direct read time
direct_reads
xs:nonNegativeInteger direct_reads - Direct reads from database
direct_write_reqs
xs:nonNegativeInteger direct_write_reqs - Direct write requests
direct_write_time
xs:nonNegativeInteger direct_write_time - Direct write time
direct_writes
xs:nonNegativeInteger direct_writes - Direct writes to database
disabled_peds
xs:long
disabled_peds - Disabled partial early distincts monitor

element
eff_stmt_text
xs:string
eff_stmt_text - Effective statement text. The first 1024

characters of the concentrated statement text following
any literal replacement done by the statement
concentrator. Only present if the statement concentrator is
enabled and this statement was altered by the statement
concentrator.
effective_isolation
xs:string
effective_isolation - Effective isolation
effective_lock_timeout
xs:integer
effective_lock_timeout - Effective lock time-out
effective_query_degree
xs:integer
effective_query_degree - Effective query degree
entry_time
xs:dateTime
entry_time - Entry timeThe time that this activity arrived

into the system.
estimatedsqlcost_threshold_id
xs:int
estimatedsqlcost_threshold_id - Estimated SQL cost

threshold ID
estimatedsqlcost_threshold
_value
xs:long
estimatedsqlcost_threshold_value - Estimated SQL cost

threshold value
estimatedsqlcost_threshold
_violated
no)
estimatedsqlcost_threshold_violated - Estimated SQL cost

threshold violated
evmon_wait_time
xs:nonNegativeInteger evmon_wait_time - Event monitor wait time
evmon_waits_total
xs:nonNegativeInteger evmon_waits_total - Event monitor total waits
executable_id
executable_id_type
fcm_message_recv_volume
xs:nonNegativeInteger fcm_message_recv_volume - FCM message recv volume
fcm_message_recv_wait_time
xs:nonNegativeInteger fcm_message_recv_wait_time - FCM message recv wait

time
fcm_message_recvs_total
xs:nonNegativeInteger fcm_message_recvs_total - FCM message recvs total
fcm_message_send_volume
xs:nonNegativeInteger fcm_message_send_volume - FCM message send volume
fcm_message_send_wait_time
xs:nonNegativeInteger fcm_message_send_wait_time - FCM message send wait

time
fcm_message_sends_total
xs:nonNegativeInteger fcm_message_sends_total - FCM message sends total
fcm_recv_volume
xs:nonNegativeInteger fcm_recv_volume - FCM recv volume
fcm_recv_wait_time
xs:nonNegativeInteger fcm_recv_wait_time - FCM recv wait time
fcm_recvs_total
xs:nonNegativeInteger fcm_recvs_total - FCM recvs total
executable_id - Executable ID
495

Element name
Data type
fcm_send_volume
xs:nonNegativeInteger fcm_send_volume - FCM send volume
fcm_send_wait_time
xs:nonNegativeInteger fcm_send_wait_time - FCM send wait time
fcm_sends_total
xs:nonNegativeInteger fcm_sends_total - FCM sends total
fcm_tq_recv_volume
xs:nonNegativeInteger fcm_tq_recv_volume - FCM tablequeue recv volume
fcm_tq_recv_wait_time
xs:nonNegativeInteger fcm_tq_recv_wait_time - FCM tablequeue recv wait time
fcm_tq_recvs_total
xs:nonNegativeInteger fcm_tq_recvs_total - FCM tablequeue recvs total
fcm_tq_send_volume
xs:nonNegativeInteger fcm_tq_send_volume - FCM tablequeue send volume
fcm_tq_send_wait_time
xs:nonNegativeInteger fcm_tq_send_wait_time - FCM tablequeue send wait time
fcm_tq_sends_total
xs:nonNegativeInteger fcm_tq_sends_total - FCM tablequeue send total
hash_grpby_overflows
xs:long
hash_join_overflows
xs:long
hash_join_overflows - Hash Join Overflows monitor

element
hash_join_small_overflows
xs:long
hash_join_small_overflows - Hash Join Small Overflows

monitor element
ida_recv_volume
xs:nonNegativeInteger The total volume of data the database server received

from an in-database analytics process. The value is
reported in bytes.
ida_recv_wait_time
xs:nonNegativeInteger The total amount of time spent waiting to receive data

from an in-database analytics process.
ida_recvs_total
xs:nonNegativeInteger The total number of times data was received from an

ida_send_volume
xs:nonNegativeInteger The total volume of data sent from the database server to
an in-database analytics process. The value is reported in
bytes.
ida_send_wait_time
xs:nonNegativeInteger The total amount of time spent waiting to send data to an

ida_sends_total
xs:nonNegativeInteger The total number of times data was sent to an in-database

analytics process.
int_rows_deleted
xs:long

element
int_rows_inserted
xs:long
int_rows_inserted - Internal Rows Inserted monitor

element
int_rows_updated
xs:long
int_rows_updated - Internal Rows Updated monitor

element
intra_parallel_state
xs:string

invocation_id
xs:nonNegativeInteger stmt_invocation_id - Statement invocation identifier
is_system_appl
xs:short
is_system_appl - Is System Application monitor element
last_reference_time
xs:dateTime
last_reference_time - Last reference time. Every time a

request occurs in this activity, this field is updated.
local_start_time
xs:dateTime
local_start_time - Local start time.
lock_escals
xs:nonNegativeInteger lock_escals - Number of lock escalations
lock_timeouts
xs:nonNegativeInteger lock_timeouts - Number of lock timeouts
lock_wait_time
xs:nonNegativeInteger lock_wait_time - Time waited on locks
496

Element name
Data type
lock_waits
xs:nonNegativeInteger lock_waits - Lock waits
log_buffer_wait_time
xs:nonNegativeInteger log_buffer_wait_time - Log buffer wait time
log_disk_wait_time
xs:nonNegativeInteger log_disk_wait_time - Log disk wait time
log_disk_waits_total
xs:nonNegativeInteger log_disk_waits_total - Log disk waits total
member
xs:nonNegativeInteger member - Database member
nesting_level
xs:nonNegativeInteger stmt_nest_level - Statement nesting level
num_agents
xs:long
num_log_buffer_full
xs:nonNegativeInteger num_log_buffer_full - Number of full log buffers
num_lw_thresh_exceeded
xs:nonNegativeInteger num_lw_thresh_exceeded - Number of thresholds

exceeded
num_routines
xs:int
num_routines - Number of routines
olap_func_overflows
xs:long
olap_func_overflows - OLAP Function Overflows monitor

element
package_name
xs:string (128)
package_schema
xs:string (128)
package_schema - Package schema
package_version_id
xs:string (128)
package_version_id - Package version
parent_activity_id
xs:nonNegativeInteger parent_activity_id - Parent activity ID
parent_uow_id
xs:nonNegativeInteger parent_uow_id - Parent unit of work ID
pool_col_gbp_indep_
pages_found_in_lbp
xs:nonNegativeInteger pool_col_gbp_indep_pages_found_in_lbp - Buffer pool

column-organized GBP independent pages found in local
buffer pool
pool_col_gbp_invalid_pages
xs:nonNegativeInteger pool_col_gbp_invalid_pages - Buffer pool

column-organized GBP invalid data pages
pool_col_gbp_l_reads
xs:nonNegativeInteger pool_col_gbp_l_reads - Buffer pool column-organized

GBP logical reads
pool_col_gbp_p_reads
xs:nonNegativeInteger pool_col_gbp_p_reads - Buffer pool column-organized

GBP physical reads
pool_col_l_reads
xs:nonNegativeInteger pool_col_l_reads - Buffer pool column-organized logical

reads
pool_col_lbp_pages_found
xs:nonNegativeInteger pool_col_lbp_pages_found - Buffer pool

column-organized LBP pages found
pool_col_p_reads
xs:nonNegativeInteger pool_col_p_reads - Buffer pool column-organized physical

reads
pool_col_writes
xs:nonNegativeInteger pool_col_writes - Buffer pool column-organized writes
pool_data_gbp_indep_pages
_found_in_lbp
xs:nonNegativeInteger pool_data_gbp_indep_pages_found_in_lbp - Group buffer

pool independent data pages found in local buffer pool
monitor element
pool_data_l_reads
xs:nonNegativeInteger pool_data_l_reads - Buffer pool data logical reads
pool_data_p_reads
xs:nonNegativeInteger pool_data_p_reads - Buffer pool data physical reads
pool_data_writes
xs:nonNegativeInteger pool_data_writes - Buffer pool data writes
pool_failed_async_col_reqs
xs:nonNegativeInteger pool_failed_async_col_reqs - Failed column-organized

prefetch requests
num_agents - Number of Agents Working on a Statement

monitor element
497

Element name
Data type
pool_failed_async_data_reqs
xs:nonNegativeInteger pool_failed_async_data_reqs - Failed data prefetch

pool_failed_async_index_reqs
xs:nonNegativeInteger pool_failed_async_index_reqs - Failed index prefetch

pool_failed_async_other_reqs
xs:nonNegativeInteger pool_failed_async_other_reqs - Failed non-prefetch

pool_failed_async_temp
_col_reqs
xs:nonNegativeInteger pool_failed_async_temp_col_reqs - Failed

column-organized temporary prefetch requests
pool_failed_async_temp_data
_reqs
xs:nonNegativeInteger pool_failed_async_temp_data_reqs - Failed data prefetch

requests for temporary table spaces monitor element
pool_failed_async_temp_index
_reqs
xs:nonNegativeInteger pool_failed_async_temp_index_reqs - Failed index

prefetch requests for temporary table spaces monitor
element
pool_failed_async_temp_xda
_reqs
xs:nonNegativeInteger pool_failed_async_temp_xda_reqs - Failed XDA prefetch

pool_failed_async_xda_reqs
xs:nonNegativeInteger pool_failed_async_xda_reqs - Failed XDA prefetch

pool_index_gbp_indep_pages
_found_in_lbp
xs:nonNegativeInteger pool_index_gbp_indep_pages_found_in_lbp - Group

buffer pool independent index pages found in local buffer
pool monitor element
pool_index_l_reads
xs:nonNegativeInteger pool_index_l_reads - Buffer pool index logical reads
pool_index_p_reads
xs:nonNegativeInteger pool_index_p_reads - Buffer pool index physical reads
pool_index_writes
xs:nonNegativeInteger pool_index_writes - Buffer pool index writes
pool_queued_async_col_pages
xs:nonNegativeInteger pool_queued_async_col_pages - Column-organized page

prefetch requests
pool_queued_async_col_reqs
xs:nonNegativeInteger pool_queued_async_col_reqs - Column-organized prefetch

requests
pool_queued_async_data_pages
xs:nonNegativeInteger pool_queued_async_data_pages - Data pages prefetch

pool_queued_async_data_reqs
xs:nonNegativeInteger pool_queued_async_data_reqs - Data prefetch requests

monitor element
pool_queued_async_index_pages xs:nonNegativeInteger pool_queued_async_index_pages - Index pages prefetch

pool_queued_async_index_reqs
xs:nonNegativeInteger pool_queued_async_index_reqs - Index prefetch requests

monitor element
pool_queued_async_other_reqs
xs:nonNegativeInteger pool_queued_async_other_reqs - Non-prefetch requests

monitor element
pool_queued_async_
temp_col_pages
xs:nonNegativeInteger pool_queued_async_temp_col_pages - Column-organized

page temporary prefetch requests
pool_queued_async_
temp_col_reqs
xs:nonNegativeInteger pool_queued_async_temp_col_reqs - Column-organized

pool_queued_async_temp_data
_pages
xs:nonNegativeInteger pool_queued_async_temp_data_pages - Data pages

element
_reqs
xs:nonNegativeInteger pool_queued_async_temp_data_reqs - Data prefetch

498

Element name
Data type
pool_queued_async_temp_index
_pages
xs:nonNegativeInteger pool_queued_async_temp_index_pages - Index pages

element
_reqs
xs:nonNegativeInteger pool_queued_async_temp_index_reqs - Index prefetch

pool_queued_async_temp_xda
_pages
xs:nonNegativeInteger pool_queued_async_temp_xda_pages - XDA data pages

element
_reqs
xs:nonNegativeInteger pool_queued_async_temp_xda_reqs - XDA data prefetch

pool_queued_async_xda_pages
xs:nonNegativeInteger pool_queued_async_xda_pages - XDA pages prefetch

requests
pool_queued_async_xda_reqs
xs:nonNegativeInteger pool_queued_async_xda_reqs - XDA prefetch requests

monitor element
pool_read_time
xs:nonNegativeInteger pool_read_time - Total buffer pool physical read time
pool_temp_col_l_reads
xs:nonNegativeInteger pool_temp_col_l_reads - Buffer pool column-organized

temporary logical reads
pool_temp_col_p_reads
xs:nonNegativeInteger pool_temp_col_p_reads - Buffer pool column-organized

temporary physical reads
pool_temp_data_l_reads
xs:nonNegativeInteger pool_temp_data_l_reads - Buffer pool temporary data

logical reads
pool_temp_data_p_reads
xs:nonNegativeInteger pool_temp_data_p_reads - Buffer pool temporary data

physical reads
pool_temp_index_l_reads
xs:nonNegativeInteger pool_temp_index_l_reads - Buffer pool temporary index

logical reads
pool_temp_index_p_reads
xs:nonNegativeInteger pool_temp_index_p_reads - Buffer pool temporary index

physical reads
pool_temp_xda_l_reads
xs:nonNegativeInteger pool_temp_xda_l_reads - Buffer pool temporary XDA

data logical reads
pool_temp_xda_p_reads
xs:nonNegativeInteger pool_temp_xda_p_reads - Buffer pool temporary XDA

data physical reads
pool_write_time
xs:nonNegativeInteger pool_write_time - Total buffer pool physical write time
pool_xda_gbp_indep_pages
_found_in_lbp
xs:nonNegativeInteger pool_xda_gbp_indep_pages_found_in_lbp - Group buffer

pool XDA independent pages found in local buffer pool
monitor element
pool_xda_gbp_invalid_pages
xs:nonNegativeInteger pool_xda_gbp_invalid_pages - Group buffer pool invalid

XDA data pages
pool_xda_gbp_l_reads
xs:nonNegativeInteger pool_xda_gbp_l_reads - Group buffer pool XDA data

logical read requests
pool_xda_gbp_p_reads
xs:nonNegativeInteger pool_xda_gbp_p_reads - Group buffer pool XDA data

physical read requests
pool_xda_l_reads
xs:nonNegativeInteger pool_xda_l_reads - Buffer pool XDA data logical reads
pool_xda_lbp_pages_found
xs:nonNegativeInteger pool_xda_lbp_pages_found - Local buffer pool XDA data

pages found
pool_xda_p_reads
xs:nonNegativeInteger pool_xda_p_reads - Buffer pool XDA data physical reads
pool_xda_writes
xs:nonNegativeInteger pool_xda_writes - Buffer pool XDA data writes
499

Element name
Data type
post_shrthreshold_hash_joins
xs:long
post_shrthreshold_hash_joins - Post threshold hash joins

monitor element
post_shrthreshold_sorts
xs:nonNegativeInteger post_shrthreshold_sorts - Post shared threshold sorts
post_threshold_hash_grpbys
xs:long

thresholdpost_threshold_hash_grpbys - Hash group by
threshold
post_threshold_hash_joins
xs:long
post_threshold_hash_joins - Hash Join Threshold monitor

element
post_threshold_olap_funcs
xs:long
post_threshold_olap_funcs - OLAP function threshold

monitor element
post_threshold_peas
xs:long

monitor element
post_threshold_peds
xs:long

monitor element
post_threshold_sorts
xs:nonNegativeInteger post_threshold_sorts - Post threshold sorts
prefetch_wait_time
xs:nonNegativeInteger prefetch_wait_time - Time waited for prefetch
prefetch_waits
xs:nonNegativeInteger prefetch_waits - Prefetcher wait count monitor element
query_actual_degree
xs:int
query_actual_degree - Actual runtime degree of

intrapartition parallelism monitor element
query_card_estimate
xs:long
query_card_estimate - Query Number of Rows Estimate

monitor element
query_cost_estimate
xs:integer
query_data_tag_list
xs:string(32)
query_data_tag_list - Query data tag list
routine_id
xs:nonNegativeInteger routine_id - Routine ID
rows_deleted
xs:long
rows_inserted
xs:long
rows_modified
xs:nonNegativeInteger rows_modified - Rows modified
rows_read
xs:nonNegativeInteger rows_read - Rows read
rows_returned
xs:nonNegativeInteger rows_returned - Rows returned
rows_updated
xs:long
section_number
xs:integer
service_class_id
xs:integer
service_class_id - Service class
service_class_work
_action_set_id
xs:nonNegativeInteger sc_work_action_set_id - Service class work action set ID
service_class_work_class_id
xs:nonNegativeInteger sc_work_class_id - Service class work class ID
sort_overflows
xs:nonNegativeInteger sort_overflows - Sort overflows
sqlrowsread_threshold_id
xs:int
sqlrowsread_threshold_ID - SQL rows read threshold ID
sqlrowsread_threshold_value
xs:long
sqlrowsread_threshold_value - SQL rows read threshold

value
sqlrowsread_threshold_violated
no)
sqlrowsread_threshold_violated - SQL rows read

threshold violated
sqlrowsreadinsc_threshold_id
xs:int
sqlrowsreadinsc_threshold_id - SQL rows read in service

threshold ID
500

Element name
Data type
sqlrowsreadinsc_threshold
_value
xs:long
sqlrowsreadinsc_threshold_value - SQL rows read in

service threshold value
sqlrowsreadinsc_threshold
_violated
no)
sqlrowsreadinsc_threshold_violated - SQL rows read in

service threshold violated
sqlrowsreturned_threshold_id
xs:int
sqlrowsreturned_threshold_id - SQL rows read returned

threshold ID
sqlrowsreturned_threshold
_value
xs:long
sqlrowsreturned_threshold_value - SQL rows read

returned threshold value
sqlrowsreturned_threshold
_violated
no)
sqlrowsreturned_threshold_violated - SQL rows read

returned threshold violated
sqltempspace_threshold_id
xs:int
sqltempspace_threshold_id - SQL temporary space

threshold ID
sqltempspace_threshold
_value
xs:long
sqltempspace_threshold_value - SQL temporary space

threshold value
sqltempspace_threshold
_violated
no)
sqltempspace_threshold_violated - SQL temporary space

threshold violated
stmt_exec_time
xs:nonNegativeInteger stmt_exec_time - Statement execution time
stmt_pkg_cache_id
xs:nonNegativeInteger stmt_pkgcache_id - Statement package cache identifier
stmt_text
xs:string
stmt_text - SQL statement text. If the activity is dynamic

SQL or it is static SQL for which the statement text is
available, this field contains the first 1024 characters of
the statement text. Otherwise, it contains an empty string.
stmtno
xs:int
thresh_violations
xs:nonNegativeInteger thresh_violations - Number of threshold violations
total_act_time
xs:nonNegativeInteger total_act_time - Total activity time
total_act_wait_time
xs:nonNegativeInteger total_act_wait_time - Total activity wait time
total_app_section_executions
xs:nonNegativeInteger total_app_section_executions - Total section executions
total_col_executions
xs:nonNegativeInteger total_col_executions - Total column-organized executions
total_col_proc_time
xs:nonNegativeInteger total_col_proc_time - Total column-organized processing

time
total_col_time
xs:nonNegativeInteger total_col_time - Total column-organized time
total_cpu_time
xs:nonNegativeInteger total_cpu_time - Total CPU time
total_disp_run_queue_time
xs:long
total_extended_latch_wait_time
xs:nonNegativeInteger total_extended_latch_wait_time - Total extended latch

total_extended_latch_waits
xs:nonNegativeInteger total_extended_latch_waits - Total extended latch waits

monitor element
total_hash_grpbys
xs:long
total_hash_joins
xs:long
total_hash_joins - Total Hash Joins monitor element
total_hash_loops
xs:long
total_hash_loops - Total Hash Loops monitor element
total_olap_funcs
xs:long
total_olap_funcs - Total OLAP Functions monitor element
total_peas
xs:long
total_peas - Total partial early aggregations monitor

element
total_peds
xs:long
total_peds - Total partial early distincts monitor element
total_disp_run_queue_time - Total dispatcher run queue

time monitor element in microseconds
501

Element name
Data type
total_routine_invocations
xs:nonNegativeInteger total_routine_invocations - Total routine invocations
total_routine_non_
sect_proc_time
xs:nonNegativeInteger total_routine_non_sect_proc_time - Non-section

processing time
total_routine_non_
sect_time
xs:nonNegativeInteger total_routine_non_sect_time - Non-section routine

execution time
total_routine_time
xs:nonNegativeInteger total_routine_time - Total routine time
total_routine_user_
code_proc_time
xs:nonNegativeInteger total_routine_user_code_proc_time - Total routine user

total_routine_user_
code_time
xs:nonNegativeInteger total_routine_user_code_time - Total routine user code

time
total_section_proc_time
xs:nonNegativeInteger total_section_proc_time - Total section processing time
total_section_sort_
proc_time
xs:nonNegativeInteger total_section_sort_proc_time - Total section sort

processing time
total_section_sort_time
xs:nonNegativeInteger total_section_sort_time - Total section sort time.
total_section_sorts
xs:nonNegativeInteger total_section_sorts - Total section sorts.
total_section_time
xs:nonNegativeInteger total_section_time - Total section time
total_sorts
xs:nonNegativeInteger total_sorts - Total Sorts
tq_sort_heap_rejections
xs:long

monitor element
tq_sort_heap_requests
xs:long

monitor element
tq_tot_send_spills
xs:nonNegativeInteger tq_tot_send_spills - Total number of tablequeue buffers

overflowed
uow_id
xs:nonNegativeInteger uow_id - Unit of work ID
utility_id
xs:nonNegativeInteger utility_id - Utility ID
utility_invocation_id
xs:hexBinary
wl_work_action_set_id
xs:nonNegativeInteger wl_work_action_set_id - Workload work action set

wl_work_class_id
xs:nonNegativeInteger wl_work_class_id - Workload work class identifier
wlm_queue_assignments_total
xs:nonNegativeInteger wlm_queue_assignments_total - Workload manager total

queue assignments
wlm_queue_time_total
xs:nonNegativeInteger wlm_queue_time_total - Workload manager total queue

time
utility_invocation_id - Utility invocation ID monitor

element
Usage notes
The MON_GET_ACTIVITY_DETAILS function provides maximum flexibility for
formatting output because it returns detailed information for a single activity as an
XML document. The XML output includes both descriptive information (for
example, statement text) and metrics. The output can be parsed directly by an
XML parser, or it can be converted to relational format by the XMLTABLE function
as shown in the example.
502
The metrics reported through this function (for example, CPU usage) are rolled up
to the activity periodically during the lifetime of the activity. Therefore, the values
reported by this table function reflect the current state of the system at the time of
the most recent rollup.
Activity metrics are controlled through the COLLECT ACTIVITY METRICS clause
on workloads, or the mon_act_metrics database configuration parameter at the
database level. Metrics are collected if the connection that submits the activity is
associated with a workload or database for which activity metrics are enabled. If
activity metrics are not collected for an activity, all metrics are reported as 0.
The MON_GET_ACTIVITY_DETAILS table function returns one row of data for
each member on which the activity exists. No aggregation across members is
performed for the metrics. However, aggregation can be achieved through SQL
queries.
The schema for the XML document that is returned in the DETAILS column is
available in the file sqllib/misc/DB2MonRoutines.xsd. Further details can be found
in the file sqllib/misc/DB2MonCommon.xsd.
Example
Investigate a long running query to determine if it is spending its time
executing or waiting (for example, blocked on locks or I/O).
Note: The following queries can be combined into one statement and are shown in
2 steps for reasons of clarity. Also, if you want to retrieve the complete text, you
could use the executable ID to obtain the statement text from the
MON_GET_PKG_CACHE_STMT table function.
1. First use the WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES table
function to list activities and their start times.
activity_id,
uow_id,
local_start_time
FROM TABLE(
WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES(
cast(NULL as bigint), -1)
) AS T

APPLICATION_HANDLE
ACTIVITY_ID UOW_ID
LOCAL_START_TIME
-------------------- ----------- ----------- -------------------------7
1
2 2008-06-10-10.06.55.675668
16
1
7 2008-06-10-10.08.38.613610
2. Then use the MON_GET_ACTIVITY_DETAILS table function to view the

percentage of time that the activity has spent waiting.
SELECT actmetrics.application_handle,
actmetrics.activity_id,
actmetrics.uow_id,
varchar(actmetrics.stmt_text, 50) as stmt_text,
actmetrics.total_act_time,
actmetrics.total_act_wait_time,
CASE WHEN actmetrics.total_act_time > 0
THEN DEC((
FLOAT(actmetrics.total_act_wait_time) /
FLOAT(actmetrics.total_act_time)) * 100, 5, 2)
503
ELSE NULL
END AS PERCENTAGE_WAIT_TIME
FROM TABLE(MON_GET_ACTIVITY_DETAILS(7, 2, 1, -2)) AS ACTDETAILS,
XMLTABLE (XMLNAMESPACES( DEFAULT http://www.ibm.com/xmlns/prod/db2/mon),
$actmetrics/db2_activity_details
PASSING XMLPARSE(DOCUMENT ACTDETAILS.DETAILS) as "actmetrics"
COLUMNS "APPLICATION_HANDLE" INTEGER PATH application_handle,
"ACTIVITY_ID" INTEGER PATH activity_id,
"UOW_ID" INTEGER PATH uow_id,
"STMT_TEXT" VARCHAR(1024) PATH stmt_text,
"TOTAL_ACT_TIME" INTEGER PATH activity_metrics/total_act_time,
"TOTAL_ACT_WAIT_TIME" INTEGER PATH activity_metrics/total_act_wait_time
) AS ACTMETRICS;

APPLICATION_HANDLE ACTIVITY_ID UOW_ID
...
------------------ ----------- ----------- ...
7
1
2 ...
Output for query (continued).

... STMT_TEXT
...
... -------------------------------------------------- ...
... select * from syscat.tables optimize for 1 row
...

... TOTAL_ACT_TIME TOTAL_ACT_WAIT_TIME PERCENTAGE_WAIT_TIME
... -------------- ------------------- -------------------...
459
0
0.00
Use the MON_GET_ACTIVITY_DETAILS table function to create a query that

captures information about all the activities currently running on a system.
v Example 1: Run the following command using the DB2 command line processor
(CLP)
WITH A1 AS
(SELECT * FROM TABLE(wlm_get_workload_occurrence_activities(null, -1))
WHERE activity_id > 0 )
SELECT A1.application_handle,
A1.activity_id,
A1.uow_id,
total_act_time,
total_act_wait_time,
varchar(actmetrics.stmt_text, 50) AS stmt_text FROM A1,
TABLE(MON_GET_ACTIVITY_DETAILS(A1.application_handle, A1.uow_id,A1.activity_id, -1))
AS ACTDETAILS,
$actmetrics/db2_activity_details
PASSING XMLPARSE(DOCUMENT ACTDETAILS.DETAILS) AS "actmetrics"
COLUMNS "STMT_TEXT" VARCHAR(1024) PATH stmt_text,
"TOTAL_ACT_TIME" INTEGER PATH activity_metrics/total_act_time,
"TOTAL_ACT_WAIT_TIME" INTEGER PATH activity_metrics/total_act_wait_time )
AS ACTMETRICS

APP...HANDLE A..._ID UOW_ID T...ACT_TIME T...WAIT_TIME
------------ ------- ------ ------------ ------------15
1
5
16
5
15
1
3
17
5
7
1
49
0
0
SQL0445W Value "with A1 as (select * from table(wlm_get_workload
3 record(s) selected with 1 warning messages printed.
The following sample continues output from this query:

... STMT_TEXT
... ------------------------------------------------... select name from sysibm.systables
... select * from sysibm.systables
... with A1 as (select * from table(wlm_get_workload_o
_occurrence_" has been truncated. SQLSTATE=01004
504
MON_GET_AGENT table function - List agents running in a service class:

The MON_GET_AGENT function returns the list of agents, fenced mode processes
(db2fmp processes), and system entities on a specified member that are running in
a specified service class or on behalf of a specified application. The system entities
are non-agent threads and processes, such as page cleaners and prefetchers.
returned.
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority
None
Syntax
MON_GET_AGENT (
service_superclass_name
service_subclass_name ,
application_handle

,
member

Routine parameters
An input argument of type VARCHAR(128) that specifies the name of a service
superclass in the currently connected database. If the argument is null or an
empty string, data is retrieved for all the superclasses in the database.
service_subclass_name
An input argument of type VARCHAR(128) that refers to a specific subclass
within a superclass. If the argument is null or an empty string, data is
retrieved for all the subclasses in the database.
application_handle
An input argument of type BIGINT that specifies the application handle for
which agent information is to be returned. If the argument is null, data is
retrieved for all applications in the database. An application handle of 0
returns the system entities only.
member
An input argument of type INTEGER that specifies the member number in the
same instance as the currently connected database. Specify -1 for the current
database member, or -2 for all database members. If a null value is specified, -1
is set implicitly.
505
Table 129. Information returned by the MON_GET_AGENT routine
Column name
Data type
Description
SERVICE_SUPERCLASS_NAME
VARCHAR
(128)
service_superclass_name - Service superclass name monitor

element
SERVICE_SUBCLASS_NAME
VARCHAR
(128)
service_subclass_name - Service subclass name monitor

element
APPLICATION_HANDLE
BIGINT
DBPARTITIONNUM
SMALLINT

element
ENTITY
VARCHAR (32)

v If the type of entity is an agent, the value is db2agent.
v If the type of entity is a fenced mode process, the value is
db2fmp (pid) where pid is the process ID of the fenced
mode process.
v Otherwise, the value is the name of the system entity.
WORKLOAD_NAME
VARCHAR
(128)
workload_name - Workload name monitor element
WORKLOAD_OCCURRENCE_ID
INTEGER
workload_occurrence_id - Workload occurrence identifier

monitor element
UOW_ID
INTEGER
ACTIVITY_ID
INTEGER
PARENT_UOW_ID
INTEGER
parent_uow_id - Parent unit of work ID monitor element
PARENT_ACTIVITY_ID
INTEGER
parent_activity_id - Parent activity ID monitor element
AGENT_TID
BIGINT
agent_tid - Agent thread ID monitor element
AGENT_TYPE
VARCHAR (32)
Agent type. The agent types are as follows:

v COORDINATOR
v OTHER
v PDBSUBAGENT
v SMPSUBAGENT
If the value is COORDINATOR, the agent ID might change
in concentrator environments.
The SMPSUBAGENT type is returned for agents that are
processing column-organized tables.
SMP_COORDINATOR
INTEGER
Indication of whether the agent is an SMP coordinator: 1 for

yes and 0 for no.
AGENT_SUBTYPE
VARCHAR (32)
Agent subtype. The possible subtypes are as follows:

v DSS
v OTHER
v RPC
v SMP
v COLUMNAR
AGENT_STATE
VARCHAR (32)
Indication of whether an agent is associated or active. The

v ASSOCIATED
v ACTIVE
506
Table 129. Information returned by the MON_GET_AGENT routine (continued)

Column name
Data type
Description
EVENT_TYPE
VARCHAR (32)
Type of event last processed by this agent. The possible

values are as follows:
v ACQUIRE
v PROCESS
v WAIT
See Table 130 on page 510 for more information about
possible values for this column.
EVENT_OBJECT
VARCHAR (32)
Object of the event last processed by this agent. The possible

v COMPRESSION_DICTIONARY_BUILD
v IMPLICIT_REBIND
v INDEX_RECREATE
v LOCK
v LOCK_ESCALATION
v QP_QUEUE
v REMOTE_REQUEST
v REQUEST
v ROUTINE
v WLM_QUEUE
EVENT_STATE
VARCHAR (32)
State of the event last processed by this agent. The possible

v EXECUTING
v IDLE
REQUEST_ID
VARCHAR (64)
Request ID. This value is unique only in combination with

the value of application_handle. You can use this combination
to distinguish between one request that is taking a long time
and multiple requests; for example, to distinguish between
one long fetch and multiple fetches.
507

Column name
Data type
Description
REQUEST_TYPE
VARCHAR (32)
Type of request. The possible values are as follows:

v For coordinator agents:
CLOSE
COMMIT
COMPILE
DESCRIBE
EXCSQLSET
EXECIMMD
EXECUTE
FETCH
INTERNAL number, where number is the value of the
internal constant
OPEN
PREPARE
REBIND
REDISTRIBUTE
REORG
ROLLBACK
RUNSTATS
v For subagents with an AGENT_SUBTYPE of DSS, SMP, or
COLUMNAR:
If the subsection number is nonzero, the subsection
number in the form SUBSECTION:subsection number;
otherwise, returns NULL.
508

Column name
Data type
Description
REQUEST_TYPE (continued)
VARCHAR (32)
v For subagents with an AGENT_SUBTYPE of RPC:

ABP
CATALOG
INTERNAL
REORG
RUNSTATS
WLM
v For subagents with a SUBTYPE of OTHER:
ABP
APP_RBSVPT
APP_RELSVPT
BACKUP
CLOSE
EXTERNAL_RBSVPT
EVMON
FORCE
FORCE_ALL
internal constant
INTERRUPT
NOOP (if there is no request)
QP
REDISTRIBUTE
STMT_RBSVPT
STOP_USING
UPDATE_DBM_CFG
WLM
NESTING_LEVEL
INTEGER
INVOCATION_ID
INTEGER
ROUTINE_ID
INTEGER
EVENT_OBJECT_NAME
VARCHAR
(1024)
Event object name. If the value of EVENT_OBJECT is LOCK,

the value of this column is the name of the lock that the
agent is waiting on. If the value of EVENT_OBJECT is
WLM_QUEUE, the value of the column is the name of the
WLM threshold that the agent is queued on. Otherwise, the
value is NULL.
APPLICATION_NAME
VARCHAR
(128)
appl_name - Application name
APPLICATION_ID
VARCHAR
(128)
appl_id - Application ID
CLIENT_PID
BIGINT
client_pid - Client process ID
SESSION_AUTH_ID
VARCHAR
(128)
session_auth_id - Session authorization ID
REQUEST_START_TIME
TIMESTAMP
Time that the agent started processing the request on which

it is currently working
509

Column name
Data type
Description
AGENT_STATE_LAST
_UPDATE_TIME
TIMESTAMP
The last time that the event, being processed by the agent,
was changed. The event currently processed by the agent is
identified by the EVENT_TYPE, EVENT_OBJECT, and
EVENT_STATE columns.
EXECUTABLE_ID
VARCHAR (32)
FOR BIT DATA
MEMBER
SMALLINT
VARCHAR (32)
FOR BIT DATA
utility_invocation_id - Utility invocation ID
IS_SYSTEM_APPL
SMALLINT
is_system_appl - Is System Application monitor element
Note: The possible combinations of EVENT_STATE, EVENT_TYPE,

EVENT_OBJECT, and EVENT_OBJECT_NAME column values are listed in the
following table.
Table 130. Possible combinations for EVENT_STATE, EVENT_TYPE, EVENT_OBJECT, and
EVENT_OBJECT_NAME column values
Event description
EVENT_STATE value EVENT_TYPE value
EVENT_OBJECT
value
EVENT_OBJECT_
NAME value
Acquire lock
IDLE
ACQUIRE
LOCK
Lock name
Escalate lock
EXECUTING
PROCESS
LOCK_ESCALATION NULL
Process request
EXECUTING
PROCESS
REQUEST
NULL
Wait for a new

request
IDLE
WAIT
REQUEST
NULL
Wait for a request to

be processed at a
remote member
IDLE
WAIT
REMOTE_REQUEST
NULL
Wait on a WLM
threshold queue
IDLE
WAIT
WLM_QUEUE
Threshold name
Process a routine
EXECUTING
PROCESS
ROUTINE
NULL
Re-create an index
EXECUTING
PROCESS
INDEX_RECREATE
NULL
Build compression
dictionary
EXECUTING
PROCESS
COMP_DICT_BLD
NULL
Implicit rebind
EXECUTING
PROCESS
IMPLICIT_REBIND
NULL
Usage notes
The parameters are, in effect, ANDed together. That is, if you specify conflicting
input parameters, such as a service superclass SUP_A and a subclass SUB_B such
that SUB_B is not a subclass of SUP_A, no rows are returned.
Examples
1. The following query returns a list of agents that are associated with application
handle 1 for all database members. You can determine the application handle
by using the LIST APPLICATIONS command or the MON_GET_CONNECTION
table function.
510
SELECT SUBSTR(CHAR(APPLICATION_HANDLE),1,7) AS APPHANDLE,

SUBSTR(CHAR(AGENT_TID),1,9) AS AGENT_TID,
SUBSTR(AGENT_TYPE,1,11) AS AGENTTYPE,
SUBSTR(AGENT_STATE,1,10) AS AGENTSTATE,
SUBSTR(REQUEST_TYPE,1,12) AS REQTYPE,
SUBSTR(CHAR(UOW_ID),1,6) AS UOW_ID,
SUBSTR(CHAR(ACTIVITY_ID),1,6) AS ACT_ID
FROM TABLE(MON_GET_AGENT(CAST(NULL AS VARCHAR(128)),
CAST(NULL AS VARCHAR(128)), 1, -2)) AS SCDETAILS
ORDER BY APPHANDLE, MEMB, AGENT_TID

APPHANDLE
--------1
1
1
MEMB
---0
0
1
AGENT_TID
--------3
4
2
AGENTTYPE
----------COORDINATOR
SUBAGENT
SUBAGENT
AGENTSTATE
---------ACTIVE
ACTIVE
ACTIVE
REQTYPE
-------------FETCH
SUBSECTION:1
SUBSECTION:2
UOW_ID
-----1
1
1
ACT_ID
-----5
5
5
The output shows a coordinator agent and a subagent on member 0 and a

subagent on member 1 operating on behalf of an activity with UOW ID 1 and
activity ID 5. The AGENTTYPE column with a value of COORDINATOR has a value of
FETCH for the REQTYPE column (which indicates the main or initial request type).
This means that the type of request is a fetch request for the coordinator agent.
2. The following query determines which lock an agent is waiting on:
select event_object, event_type, event_state, varchar(event_object_name, 30)
as event_object_name
from table(MON_GET_AGENT(,,cast(NULL as bigint), -1)) as t

EVENT_OBJECT
--------------REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
LOCK
ROUTINE
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
EVENT_TYPE
----------------PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
WAIT
ACQUIRE
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
EVENT_STATE
------------------EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
IDLE
IDLE
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EVENT_OBJECT_NAME
-------------------------02000500000000000000000054
-
Using the same query at a later time shows that the WLM threshold has
queued an agent:
EVENT_OBJECT
--------------REQUEST
REQUEST
REQUEST
REQUEST
EVENT_TYPE
----------------PROCESS
PROCESS
PROCESS
PROCESS
EVENT_STATE
------------------EXECUTING
EXECUTING
EXECUTING
EXECUTING
EVENT_OBJECT_NAME
--------------------------
511
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
WLM_QUEUE
ROUTINE
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
WAIT
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
IDLE
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
MYCONCDBCOORDTH
-
MON_GET_APPL_LOCKWAIT - Get information about locks for which an

application is waiting:
The MON_GET_APPL_LOCKWAIT table function returns information about all
locks that each application's agents (that are connected to the current database) are
waiting to acquire.
To get information about locks, use the MON_GET_APPL_LOCKWAIT,
MON_FORMAT_LOCK_NAME, and MON_GET_LOCKS, table functions instead of
the SNAPLOCKWAIT administrative view and SNAP_GET_LOCKWAIT table
function, and the SNAPLOCK administrative view and SNAP_GET_LOCK table
function, which are deprecated in Fixpack 1 of Version 9.7.
MON_GET_APPL_LOCKWAIT ( application_handle , member
, system_appls

Routine parameters
application_handle
An optional input parameter of type BIGINT that specifies a valid application
handle in the same database as the one to which you are currently connected.
If the argument is null, locks are retrieved for all applications that are currently
waiting for locks to be acquired.
member
An input parameter of type INTEGER that specifies a valid member in the
database member, or -2 for all active members. If the NULL value is specified,
-1 is set.
system_appls
An input parameter of type SMALLINT that specifies whether information for
system applications is to be returned. The following values are valid:
v 0 or NULL: System application information is not returned. NULL is the
default if a value for system_appls is not provided.
v 1: System application information is returned.
512
Authorization
One of the following authorities or privilege is required:
v SYSADM authority
v SYSMON authority
v EXECUTE privilege on the MON_GET_APPL_LOCKWAIT table function.
None
The columns that are returned provide information in the following areas:
v The following columns represent details about the lock that the application is
currently waiting to acquire:
LOCK_WAIT_START_TIME, LOCK_NAME, LOCK_OBJECT_TYPE,
LOCK_MODE, LOCK_CURRENT_MODE, LOCK_MODE_REQUESTED,
LOCK_STATUS, LOCK_ESCALATION, LOCK_ATTRIBUTES, LOCK_RRIID,
LOCK_COUNT, TBSP_ID, TAB_FILE_ID, SUBSECTION_NUMBER.
v The following columns represent details about the application that is waiting to
acquire this lock.
REQ_APPLICATION_HANDLE, REQ_AGENT_TID, REQ_MEMBER,
REQ_EXECUTABLE_ID
v The following columns represent details about the application that is currently
holding the lock.
HLD_APPLICATION_HANDLE, HLD_MEMBER, ADDITIONAL_DETAILS
Table 131. Information returned by the MON_GET_APPL_LOCKWAIT table function
Column name
Data type
Description or monitor element
LOCK_WAIT_START_TIME
TIMESTAMP
lock_wait_start_time - Lock Wait

Start Timestamp
LOCK_NAME
VARCHAR(32)
lock_name - Lock name

The internal name can be formatted
using the
MON_FORMAT_LOCK_NAME
table function to obtain details
regarding the lock. For example,
the table and table space that the
lock references can be found, if this
is a table lock.
LOCK_OBJECT_TYPE_ID
CHAR(1) FOR BIT

DATA
LOCK_OBJECT_TYPE
VARCHAR(32)
lock_object_type - Lock object type

waited on
For possible values, see
lock_object_type - Lock object
type waited on monitor element
513
Table 131. Information returned by the MON_GET_APPL_LOCKWAIT table

Column name
Data type
Description or monitor element
LOCK_MODE
VARCHAR(3)
lock_mode - Lock mode

If the application holding this lock
cannot be found, a value of NULL
is returned.
For a global lockwait, this value is
NULL.
LOCK_CURRENT_MODE
VARCHAR(3)
lock_current_mode - Original Lock

Mode Before Conversion
If no conversion took place, then a
value of NULL is returned.
LOCK_MODE_REQUESTED VARCHAR(3)
lock_mode_requested - Lock mode

requested
LOCK_STATUS
CHAR(1)
lock_status - Lock status
LOCK_ESCALATION
CHAR(1)
lock_escalation - Lock escalation
LOCK_ATTRIBUTES
CHAR(16)
lock_attributes - Lock attributes
LOCK_RRIID
BIGINT
lock_count - Lock count monitor

element
LOCK_COUNT
BIGINT
lock_count - Lock count monitor

element
TBSP_ID
BIGINT
tablespace_id - Table space ID
TAB_FILE_ID
BIGINT
table_file_id - Table file ID
SUBSECTION_NUMBER
BIGINT
ss_number - Subsection Number

If the subsection number is not
available, then a value of NULL is
returned.
REQ_APPLICATION_
HANDLE
BIGINT
req_application_handle Requesting application handle
REQ_AGENT_TID
BIGINT
req_agent_tid - Requesting agent

TID
REQ_MEMBER
SMALLINT
req_member - Requesting member
REQ_EXECUTABLE_ID
VARCHAR (32) FOR

BIT DATA
req_executable_id - Requesting
executable ID
HLD_APPLICATION_
HANDLE
BIGINT
hld_application_handle - Holding
application handle
If the application holding this lock
is unknown or cannot be found
then a value of NULL is returned.
For a global lockwait, this value is
NULL.
514
HLD_MEMBER
SMALLINT
hld_member - Holding member
IS_SYSTEM_APPL
SMALLINT
is_system_appl - Is System
Application
Example
In this sample scenario, the MON_GET_APPL_LOCKWAIT table function is used
to investigate a hung application for the session authorization ID USER1.
1. Use the MON_GET_CONNECTION table function to look up the application
handle for all connections with the SESSION_USER value of USER1:
SELECT COORD_PARTITION_NUM, APPLICATION_HANDLE
FROM TABLE(MON_GET_CONNECTION(NULL,-2))
WHERE SESSION_USER = USER1

COORD_PARTITION_NUM
------------------------------2
APPLICATION_HANDLE
---------------------------131130
2. Use the MON_GET_AGENT table function to obtain current information about

all agents working for this connection, on all database partitions:
SELECT SUBSTR(CHAR(DBPARTITIONNUM),1,3) AS DBPART,
SUBSTR(CHAR(APPLICATION_HANDLE),1,7) AS APP_ID,
SUBSTR(CHAR(WORKLOAD_OCCURRENCE_ID),1,7) AS WLO_ID,
SUBSTR(CHAR(AGENT_TID),1,7) AS AGENT_ID,
SUBSTR(CHAR(AGENT_TYPE),1,12) AS AGENT_TYPE,
SUBSTR(AGENT_STATE,1, 8) AS STATE,
SUBSTR(EVENT_TYPE,1, 8) AS EV_TYPE,
SUBSTR(EVENT_OBJECT,1,12) AS EV_OBJECT
FROM TABLE(MON_GET_AGENT(,,131130,-2))
ORDER BY AGENT_TYPE, DBPART

DBPART
-----2
0
1
2
APP_ID
------131130
131130
131130
131130
WLO_ID
------1
1
1
1
AGENT_ID
--------3110
7054
5709
5960
AGENT_TYPE
PDBSUBAGENT
PDBSUBAGENT
PDBSUBAGENT
STATE
EV_TYPE EV_OBJECT
------ -------- ---------ACTIVE WAIT
REQUEST
ACTIVE ACQUIRE LOCK
ACTIVE ACQUIRE LOCK
ACTIVE ACQUIRE LOCK
An event of type ACQUIRE on an event object of type LOCK indicates a lock

wait scenario. Now you can investigate which object is being waited for and
which process is holding the lock on it.
3. To determine all locks that the application is waiting for, call the
MON_GET_APPL_LOCKWAIT table function with application handle 131130
and member -2 as input parameters.
SELECT lock_name,
hld_member AS member,
hld_agent_tid as TID,
hld_application_handle AS HLD_APP FROM
TABLE (MON_GET_APPL_LOCKWAIT(131130, -2))

LOCK_NAME
MEMBER TID
HLD_APP
-------------------------- ------ ------ ------00030005000000000280000452
0
1234
65564
00030005000000000280000452
1
5478
65564
00030005000000000280000452
2
4678
65564
4. Call the MON_GET_CONNECTION table function to find out more about the
application that is holding the lock (this application has an application handle
of 65564).
515
SELECT SYSTEM_AUTH_ID, APPLICATION_NAME AS APP_NAME,

WORKLOAD_OCCURRENCE_STATE AS WL_STATE
FROM TABLE(MON_GET_CONNECTION(NULL,-2))
WHERE APPLICATION_HANDLE = 65564

SYSTEM_AUTH_ID APP_NAME WL_STATE
-------------- -------- ----------ZURBIE
db2bp
UOWWAIT
MON_GET_APPLICATION_HANDLE - Get connection application handle:

The MON_GET_APPLICATION_HANDLE scalar function returns the application
handle of the invoking application.
Syntax
MON_GET_APPLICATION_HANDLE (

Authorization
v EXECUTE privilege on the function
v DBADM authority
v SQLADM authority
The data type of the result is BIGINT.
Example
The MON_GET_APPLICATION_HANDLE scalar function can be used to pass in
the application handle of the current session into monitoring functions which filter
based on the application handle, such that the session can access its own
monitoring information. For example:
select application_handle, application_name, application_id, member, rows_read
from table(sysproc.mon_get_connection(sysproc.mon_get_application_handle(), -1))
as conn

APPLICATION_HANDLE
APPLICATION_NAME APPLICATION_ID
MEMBER
-------------------- ----------------- ------------------------------- ------644
db2bp
*LOCAL.amurchis.110831180720
0
ROWS_READ
----------
516
0
MON_GET_APPLICATION_ID - Get connection application ID:

The MON_GET_APPLICATION_ID scalar function returns the application ID of
the invoking application.
The value returned by the function is unique within a 100-year interval and valid
only for the duration of the connection established before calling the function.
MON_GET_APPLICATION_ID (

Authorization
v DBADM authority
v SQLADM authority
The data type of the result is VARCHAR(128).
Example
values sysproc.mon_get_application_id()

1
------------------------------*LOCAL.amurchis.110831180720
MON_GET_AUTO_MAINT_QUEUE table function - Get information about the

automatic maintenance jobs:
The MON_GET_AUTO_MAINT_QUEUE table function returns information about
all automatic maintenance jobs (with the exception of real-time statistics which
does not submit jobs on the automatic maintenance queue) that are currently
queued for execution by the autonomic computing daemon (db2acd).
Syntax
MON_GET_AUTO_MAINT_QUEUE ()
517

Authorization
v DBADM authority
v SQLADM authority
None
Examples
Display the current jobs on the automatic maintenance queue on each partition.
SELECT MEMBER
QUEUE_POSITION,
JOB_STATUS,
JOB_TYPE,
VARCHAR(DB_NAME, 10) AS DB_NAME,
OBJECT_TYPE,
VARCHAR(OBJECT_SCHEMA, 10) AS OBJECT_SCHEMA
VARCHAR(OBJECT_NAME, 10) AS OBJECT_NAME
FROM TABLE(MON_GET_AUTO_MAINT_QUEUE()) AS T
ORDER BY MEMBER, QUEUE_POSITION ASC

MEMBER QUEUE_POSITION JOB_STATUS JOB_TYPE DB_NAME
------ -------------- ---------- -------- ------0
1 EXECUTING RUNSTATS SAMPLE
0
2 QUEUED
REORG
SAMPLE
0
3 QUEUED
REORG
SAMPLE
OBJECT_TYPE
----------TABLE
TABLE
TABLE
OBJECT_SCHEMA
------------TEST
TEST
TEST
OBJECT_NAME
----------EMPLOYEE
T1
BLAH
Display the current jobs on the automatic maintenance queue.

SELECT JOB_STATUS,
JOB_TYPE,
OBJECT_TYPE,
VARCHAR(OBJECT_NAME, 10) AS OBJECT_NAME,
VARCHAR(JOB_DETAILS,60) AS JOB_DETAILS
FROM TABLE(MON_GET_AUTO_MAINT_QUEUE()) AS T

JOB_STATUS JOB_TYPE
OBJECT_TYPE OBJECT_NAME
---------- ------------ ----------- ----------EXECUTING REORG
TABLE
TP3
JOB_DETAILS
------------------------------------------------------------
518
REORG INDEXES ALLOW WRITE CLEANUP ALL; RECLAIM EXTENTS

Usage notes
The MON_GET_AUTO_MAINT_QUEUE table function returns information about
all queued and executing automatic maintenance jobs on all members. Note that
there is a separate automatic maintenance queue per member.
Note: Jobs in the automatic maintenance queue are ordered first by earliest start
time (such as start of next maintenance window where job may run), priority (for
entries with same earliest start time) and queue entry time (for entries with the
same earliest start time and priority).
The information returned from MON_GET_AUTO_MAINT_QUEUE supplements
the information from the HEALTH_DB_HIC interface. HEALTH_DB_HIC shows
the automatic maintenance status for each table to which automatic maintenance is
applied, as well as the last time the status was updated (such as last time table
was checked to see if maintenance is needed). The
MON_GET_AUTO_MAINT_QUEUE interface provides a drill down for when the
state is AUTOMATED, providing details about where the maintenance job is in the
auto maintenance queue, and what other jobs are ahead of the job in the queue.
The MON_GET_AUTO_MAINT_QUEUE table function does not report any
automatic maintenance jobs if automatic maintenance is not enabled.
Table 132. Information returned for MON_GET_AUTO_MAINT_QUEUE
Column Name
Data Type
Description
DB_NAME
VARCHAR(128)
db_name - Database name monitor element
MEMBER
SMALLINT
OBJECT_TYPE
VARCHAR(8)
objtype - Object type monitor element
OBJECT_SCHEMA
VARCHAR(128)
object_schema - Object schema monitor element
OBJECT_NAME
VARCHAR(128)
object_name - Object name monitor element
JOB_TYPE
VARCHAR(12)
Type of automatic maintenance job. One of:

RUNSTATS
REORG
BACKUP
519
Table 132. Information returned for MON_GET_AUTO_MAINT_QUEUE (continued)

Column Name
Data Type
Description
JOB_DETAILS
VARCHAR(256)
Details about the maintenance job if type is RUNSTATS or

REORG. For RUNSTATS, indicates if the runstats job is
doing a full runstats or just sampling. For REORG, lists
the keywords that will be applied to modify the behavior
of the REORG utility (for example, INDEXES, CLEANUP,
and so on). For an index REORG, if the keywords indicate
both CLEANUP and RECLAIM EXTENTS separated by a
semicolon, index reorg cleanup is done followed by the
evaluation of and potential run of index reclaim extents
(reclaim extents is done if the evaluation of reclaimable
space compared against the
reclaimExtentsSizeForIndexObjects setting indicates
reclaim is necessary).
JOB_STATUS
VARCHAR(10)
Current status of the job. One of:

QUEUED
EXECUTING
JOB_PRIORITY
INTEGER
Numeric priority of job in the queue. Priority is only

important for jobs with the same value for
EARLIEST_START_TIME.
MAINT_WINDOW_TYPE
VARCHAR(8)
Indicates which type of maintenance window will be used

for the job. One of:
ONLINE
OFFLINE
QUEUE_POSITION
INTEGER
Indicates the position of the job in the automatic

maintenance queue.
QUEUE_ENTRY_TIME
TIMESTAMP
Time that the job was added to the automatic

maintenance queue.
EXECUTION_START_TIME
TIMESTAMP
Time that job started execution, if status is EXECUTING.

NULL otherwise.
EARLIEST_START_TIME
TIMESTAMP
Start time of next maintenance window where job is

eligible to run.
MON_GET_AUTO_RUNSTATS_QUEUE table function - Retrieve information

about objects queued for evaluation:
The MON_GET_AUTO_RUNSTATS_QUEUE table function returns information
about all objects which are currently queued for evaluation by automatic statistics
collection in the currently connected database.
Syntax
MON_GET_AUTO_RUNSTATS_QUEUE ()
520
Authorization
v
v
v
v

DBADM authority
SQLADM authority

None
Example
Display all objects that are currently under evaluation by automatic statistics
collection in the currently connected database.
SELECT QUEUE_POSITION,
OBJECT_TYPE,
OBJECT_STATUS,
VARCHAR(OBJECT_SCHEMA, 10) AS OBJECT_SCHEMA,
VARCHAR(OBJECT_NAME, 10) AS OBJECT_NAME
FROM TABLE(MON_GET_AUTO_RUNSTATS_QUEUE()) AS T
ORDER BY QUEUE_POSITION ASC

QUEUE_POSITION
-------------1
2
3
OBJECT_TYPE
----------TABLE
TABLE
TABLE
OBJECT_STATUS
-------------------JOB_SUBMITTED
EVALUATION_PENDING
EVALUATION_PENDING
OBJECT_SCHEMA
------------TEST
TEST
TEST
OBJECT_NAME
----------EMPLOYEE
T1
BLAH
Usage notes
The MON_GET_AUTO_RUNSTATS_QUEUE table function returns information
about all objects queued for evaluation by automatic statistics collection in the
currently connected database. Objects queued for evaluation will be examined by
automatic statistics collection to determine if a statistics update is required. When
an object is found to require statistics update, a job is submitted to the automatic
maintenance scheduler and evaluation temporarily blocks until the job completes
execution. Use the MON_GET_AUTO_MAINT_QUEUE interface to monitor the
progress of the statistics collection job. After an object has been evaluated by
automatic statistics collection is removed from the evaluation queue, it will not be
added to the queue again until the next automatic statistics collection evaluation
interval. For a per-object history of evaluation, refer to the HEALTH_DB_HIC
interface.
Each database has a separate automatic statistics collection evaluation queue. The
MON_GET_AUTO_RUNSTATS_QUEUE reports the evaluation queue for the
The list reported by the MON_GET_AUTO_RUNSTATS_QUEUE interface may be
empty if there are no objects currently queued for evaluation by automatic
statistics collection. For example, if automatic statistics collection has processed all
the tables that were queued for evaluation in the current evaluation interval, the
521
list of objects queued for evaluation will be empty until the next evaluation
interval. Automatic statistics collection evaluation intervals occur roughly every
two hours.
The list reported by the MON_GET_AUTO_RUNSTATS_QUEUE interface is also
empty if automatic statistics collection is not enabled.
Table 133. Information returned for MON_GET_AUTO_RUNSTATS_QUEUE
Column Name
Data Type
Description
OBJECT_TYPE
VARCHAR(8)
OBJECT_SCHEMA
VARCHAR(128)
OBJECT_NAME
VARCHAR(128)
MEMBER
SMALLINT
OBJECT_STATUS
VARCHAR(18)
Status of queued object. One of:

EVALUATION_PENDING - Automatic statistics collection
needs to look at the object to determine if a statistics
update is required.
JOB_SUBMITTED - Automatic statistics collection has
determined that a statistics update is required for an
object and has submitted a job to the automatic
maintenance scheduler. Automatic statistics collection is
waiting for the job to complete.
JOB_SUBMIT_TIME
TIMESTAMP
If the status is JOB_SUBMITTED, the time at which the

automatic statistics collection job was submitted to the
automatic maintenance scheduler. NULL otherwise.
QUEUE_POSITION
INTEGER
Indicates the position of the job in the automatic statistics

collection evaluation queue.
QUEUE_ENTRY_TIME
TIMESTAMP
Time that the job was added to the automatic statistics

collection evaluation queue
MON_GET_BUFFERPOOL table function - Get buffer pool metrics:

The MON_GET_BUFFERPOOL table function returns monitor metrics for one or
more buffer pools.
Syntax
MON_GET_BUFFERPOOL (
bp_name
, member

bp_name
An input argument of type VARCHAR(128) that specifies a valid buffer pool
name in the currently connected database when calling this function. If the
argument is null or an empty string, metrics are retrieved for all buffer pools
in the database.
522
member
the null value is specified, -1 is set implicitly.
Authorization
v DBADM authority
v SQLADM authority
None
Example
Compute the buffer pool hit ratio.
WITH BPMETRICS AS (
SELECT bp_name,
pool_data_l_reads + pool_temp_data_l_reads +
pool_index_l_reads + pool_temp_index_l_reads +
pool_xda_l_reads + pool_temp_xda_l_reads as logical_reads,
pool_data_p_reads + pool_temp_data_p_reads +
pool_index_p_reads + pool_temp_index_p_reads +
pool_xda_p_reads + pool_temp_xda_p_reads as physical_reads,
member
FROM TABLE(MON_GET_BUFFERPOOL(,-2)) AS METRICS)
SELECT
VARCHAR(bp_name,20) AS bp_name,
logical_reads,
physical_reads,
CASE WHEN logical_reads > 0
THEN DEC((1 - (FLOAT(physical_reads) / FLOAT(logical_reads))) * 100,5,2)
ELSE NULL
END AS HIT_RATIO,
member
FROM BPMETRICS;

BP_NAME
LOGICAL_READS
PHYSICAL_READS HIT_RATIO MEMBER
---------------- ---------------- -------------- --------- --------IBMDEFAULTBP
619
385
37.80
0
IBMSYSTEMBP4K
0
0
0
IBMSYSTEMBP8K
0
0
0
IBMSYSTEMBP16K
0
0
0
IBMSYSTEMBP32K
0
0
0

... HIT_RATIO MEMBER
... --------- -----...
37.80
0
523
...
...
...
...
0
0
0
0
Usage notes
The MON_GET_BUFFERPOOL table function returns one row of data per database
buffer pool and per database member. No aggregation across database members is
performed. However, aggregation can be achieved through SQL queries as shown
in the example.
Metrics collected by this function are controlled at the database level using the
mon_obj_metrics configuration parameter. By default, metrics collection is enabled.
Table 134. Information returned for MON_GET_BUFFERPOOL
Column Name
Data Type
BP_NAME
VARCHAR(128)
MEMBER
SMALLINT
AUTOMATIC
SMALLINT
automatic - Buffer pool automatic
DIRECT_READS
BIGINT
DIRECT_READ_REQS
BIGINT
DIRECT_WRITES
BIGINT
DIRECT_WRITE_REQS
BIGINT
POOL_DATA_L_READS
BIGINT
BIGINT

data logical reads
POOL_XDA_L_READS
BIGINT

reads
BIGINT

XDA data logical reads
POOL_INDEX_L_READS
BIGINT

reads
BIGINT
pool_temp_index_l_reads - Buffer pool

temporary index logical reads
POOL_DATA_P_READS
BIGINT

reads
BIGINT

data physical reads
POOL_XDA_P_READS
BIGINT
pool_xda_p_reads - Buffer pool XDA data

physical reads
BIGINT

XDA data physical reads
POOL_INDEX_P_READS
BIGINT

reads
BIGINT
pool_temp_index_p_reads - Buffer pool

temporary index physical reads
POOL_DATA_WRITES
BIGINT
524
Description
Table 134. Information returned for MON_GET_BUFFERPOOL (continued)

Column Name
Data Type
Description
POOL_XDA_WRITES
BIGINT
POOL_INDEX_WRITES
BIGINT
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT
POOL_READ_TIME
BIGINT

time
POOL_WRITE_TIME
BIGINT

time
POOL_ASYNC_DATA_READS
BIGINT
pool_async_data_reads - Buffer pool

asynchronous data reads
POOL_ASYNC_DATA_READ_REQS
BIGINT
pool_async_data_read_reqs - Buffer pool

asynchronous read requests
POOL_ASYNC_DATA_WRITES
BIGINT
pool_async_data_writes - Buffer pool

asynchronous data writes
POOL_ASYNC_INDEX_READS
BIGINT
pool_async_index_reads - Buffer pool

asynchronous index reads
POOL_ASYNC_INDEX_READ_REQS
BIGINT
pool_async_index_read_reqs - Buffer pool

asynchronous index read requests
POOL_ASYNC_INDEX_WRITES
BIGINT
pool_async_index_writes - Buffer pool

asynchronous index writes
POOL_ASYNC_XDA_READS
BIGINT
pool_async_xda_reads - Buffer pool

asynchronous XDA data reads
POOL_ASYNC_XDA_READ_REQS
BIGINT
pool_async_xda_read_reqs - Buffer pool

asynchronous XDA read requests
POOL_ASYNC_XDA_WRITES
BIGINT
pool_async_xda_writes - Buffer pool

asynchronous XDA data writes
POOL_NO_VICTIM_BUFFER
BIGINT
pool_no_victim_buffer - Buffer pool no victim

buffers
POOL_LSN_GAP_CLNS
BIGINT
pool_lsn_gap_clns - Buffer pool log space

cleaners triggered
POOL_DRTY_PG_STEAL_CLNS
BIGINT
pool_drty_pg_steal_clns - Buffer pool victim page

cleaners triggered
POOL_DRTY_PG_THRSH_CLNS
BIGINT
pool_drty_pg_thrsh_clns - Buffer pool threshold

cleaners triggered
VECTORED_IOS
BIGINT
vectored_ios - Number of vectored IO requests
PAGES_FROM_VECTORED_IOS
BIGINT
pages_from_vectored_ios - Total number of pages

read by vectored IO
BLOCK_IOS
BIGINT
block_ios - Number of block IO requests
PAGES_FROM_BLOCK_IOS
BIGINT
pages_from_block_ios - Total number of pages

read by block IO
UNREAD_PREFETCH_PAGES
BIGINT
unread_prefetch_pages - Unread prefetch pages
FILES_CLOSED
BIGINT
files_closed - Database files closed
BIGINT

BIGINT

525

Column Name
Data Type
Description
BIGINT

BIGINT
pool_data_gbp_invalid_pages - Group buffer

pool invalid data pages monitor element
BIGINT
pool_index_gbp_l_reads - Group buffer pool

BIGINT

index physical reads monitor elements
BIGINT

BIGINT
pool_index_gbp_invalid_pages - Group buffer

pool invalid index pages
POOL_ASYNC_DATA_GBP_L_READS
BIGINT
pool_async_data_gbp_l_reads - Asynchronous
group buffer pool data logical reads
POOL_ASYNC_DATA_GBP_P_READS
BIGINT
pool_async_data_gbp_p_reads - Asynchronous
group buffer pool data physical reads
POOL_ASYNC_DATA_LBP_PAGES_FOUND
BIGINT
pool_async_data_lbp_pages_found Asynchronous local buffer pool data pages found
POOL_ASYNC_DATA_GBP_INVALID
_PAGES
BIGINT
pool_async_data_gbp_invalid_pages Asynchronous group buffer pool invalid data

pages
POOL_ASYNC_INDEX_GBP_L_READS
BIGINT
pool_async_index_gbp_l_reads - Asynchronous
group buffer pool index logical reads
POOL_ASYNC_INDEX_GBP_P_READS
BIGINT
pool_async_index_gbp_p_reads - Asynchronous
group buffer pool index physical reads
POOL_ASYNC_INDEX_LBP_PAGES
_FOUND
BIGINT
pool_async_index_lbp_pages_found Asynchronous local buffer pool index pages

found
POOL_ASYNC_INDEX_GBP_INVALID
_PAGES
BIGINT
pool_async_index_gbp_invalid_pages Asynchronous group buffer pool invalid index

pages
BIGINT

data logical read requests
BIGINT

data physical read requests
BIGINT

XDA data pages found
BIGINT

invalid XDA data pages
POOL_ASYNC_XDA_GBP_L_READS
BIGINT
pool_async_xda_gbp_l_reads - Group buffer pool

XDA data asynchronous logical read requests
POOL_ASYNC_XDA_GBP_P_READS
BIGINT
pool_async_xda_gbp_p_reads - Group buffer

pool XDA data asynchronous physical read
requests
POOL_ASYNC_XDA_LBP_PAGES_FOUND
BIGINT
pool_async_xda_lbp_pages_found Asynchronous local buffer pool XDA data pages

found
526

Column Name
Data Type
Description
POOL_ASYNC_XDA_GBP_INVALID_PAGES
BIGINT
pool_async_xda_gbp_invalid_pages Asynchronous group buffer pool invalid XDA

data pages
POOL_ASYNC_READ_TIME
BIGINT
pool_async_read_time - Buffer Pool

Asynchronous Read Time
POOL_ASYNC_WRITE_TIME
BIGINT
pool_async_write_time - Buffer pool

asynchronous write time
BP_CUR_BUFFSZ
BIGINT
bp_cur_buffsz - Current Size of Buffer Pool
BIGINT

requests
BIGINT

requests
BIGINT

requests
POOL_QUEUED_ASYNC_TEMP_DATA
_REQS
BIGINT
POOL_QUEUED_ASYNC_TEMP_INDEX
_REQS
BIGINT
POOL_QUEUED_ASYNC_TEMP_XDA
_REQS
BIGINT

BIGINT
pool_queued_async_other_reqs - Non-prefetch
requests
BIGINT

prefetch requests
BIGINT

prefetch requests
BIGINT

prefetch requests
_PAGES
BIGINT
pages prefetch requests for temporary table
spaces
_PAGES
BIGINT
spaces
_PAGES
BIGINT

spaces
BIGINT
pool_failed_async_data_reqs - Failed data

prefetch requests
BIGINT

prefetch requests
BIGINT
pool_failed_async_xda_reqs - Failed XDA

prefetch requests
POOL_FAILED_ASYNC_TEMP_DATA
_REQS
BIGINT

POOL_FAILED_ASYNC_TEMP_INDEX
_REQS
BIGINT
pool_failed_async_temp_index_reqs - Failed
index prefetch requests for temporary table
spaces
527

Column Name
Data Type
Description
BIGINT

BIGINT
pool_failed_async_other_reqs - Failed
non-prefetch requests
SKIPPED_PREFETCH_DATA_P_READS
BIGINT
skipped_prefetch_data_p_reads - Skipped
prefetch data physical reads
SKIPPED_PREFETCH_INDEX_P_READS
BIGINT
skipped_prefetch_index_p_reads - Skipped
prefetch index physical reads
SKIPPED_PREFETCH_XDA_P_READS
BIGINT
skipped_prefetch_xda_p_reads - Skipped prefetch

XDA physical reads
SKIPPED_PREFETCH_TEMP_DATA_P
_READS
BIGINT
skipped_prefetch_temp_data_p_reads - Skipped
prefetch temporary data physical reads
SKIPPED_PREFETCH_TEMP_INDEX_P
_READS
BIGINT
skipped_prefetch_temp_index_p_reads - Skipped
prefetch temporary index physical reads
SKIPPED_PREFETCH_TEMP_XDA_P
_READS
BIGINT
skipped_prefetch_temp_xda_p_reads - Skipped
prefetch temporary XDA data physical reads
SKIPPED_PREFETCH_UOW_DATA_P
_READS
BIGINT
skipped_prefetch_uow_data_p_reads - Skipped
prefetch unit of work data physical reads
SKIPPED_PREFETCH_UOW_INDEX_P
_READS
BIGINT
skipped_prefetch_uow_index_p_reads - Skipped
prefetch unit of work index physical reads
SKIPPED_PREFETCH_UOW_XDA_P
_READS
BIGINT
skipped_prefetch_uow_xda_p_reads - Skipped
prefetch unit of work XDA data physical reads
SKIPPED_PREFETCH_UOW_TEMP_DATA
_P_READS
BIGINT
skipped_prefetch_uow_temp_data_p_reads Skipped prefetch unit of work temporary data

physical reads
SKIPPED_PREFETCH_UOW_TEMP_INDEX
_P_READS
BIGINT
skipped_prefetch_uow_temp_index_p_reads Skipped prefetch unit of work temporary index

physical reads
SKIPPED_PREFETCH_UOW_TEMP_XDA_P
_READS
BIGINT
skipped_prefetch_uow_temp_xda_p_reads Skipped prefetch unit of work temporary XDA

data physical reads
PREFETCH_WAIT_TIME
BIGINT
PREFETCH_WAITS
BIGINT
POOL_DATA_GBP_INDEP_PAGES_FOUND
_IN_LBP
BIGINT
pool_data_gbp_indep_pages_found_in_lbp Group buffer pool independent data pages found

POOL_INDEX_GBP_INDEP_PAGES_FOUND
_IN_LBP
BIGINT
pool_index_gbp_indep_pages_found_in_lbp Group buffer pool independent index pages

POOL_XDA_GBP_INDEP_PAGES
_FOUND_IN_LBP
BIGINT
pool_xda_gbp_indep_pages_found_in_lbp Group buffer pool XDA independent pages

POOL_ASYNC_DATA_GBP_INDEP_PAGES
_FOUND_IN_LBP
BIGINT
pool_async_data_gbp_indep_pages_found_in_lbp
- Group buffer pool independent data pages
found by asynchronous EDUs in a local buffer
pool monitor element monitor element
528

Column Name
Data Type
Description
POOL_ASYNC_INDEX_GBP_INDEP_PAGES
_FOUND_IN_LBP
BIGINT
pool_async_index_gbp_indep_pages_found_in
_lbp - Group buffer pool independent index
pages found by asynchronous EDUs in a local
buffer pool monitor element monitor element
POOL_ASYNC_XDA_GBP_INDEP_PAGES
_FOUND_IN_LBP
BIGINT
pool_async_xda_gbp_indep_pages_found_in_lbp
- Group buffer pool independent XML storage
object(XDA) pages found by asynchronous EDUs
in a local buffer pool monitor element monitor
element
POOL_COL_L_READS
BIGINT

BIGINT

POOL_COL_P_READS
BIGINT

physical reads
BIGINT

BIGINT

POOL_COL_WRITES
BIGINT

writes
POOL_ASYNC_COL_READS
BIGINT
pool_async_col_reads - Buffer pool asynchronous

column-organized reads
POOL_ASYNC_COL_READ_REQS
BIGINT
pool_async_col_read_reqs - Buffer pool

asynchronous column-organized read requests
POOL_ASYNC_COL_WRITES
BIGINT
pool_async_col_writes - Buffer pool

asynchronous column-organized writes
POOL_ASYNC_COL_LBP_
PAGES_FOUND
BIGINT
pool_async_col_lbp_pages_found - Asynchronous
local buffer pool column-organized pages found
BIGINT

column-organized GBP logical reads
BIGINT

column-organized GBP physical reads
BIGINT

POOL_COL_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
found in local buffer pool
POOL_ASYNC_COL_GBP_
L_READS
BIGINT
pool_async_col_gbp_l_reads - Asynchronous
group buffer pool column-organized logical reads
POOL_ASYNC_COL_GBP_
P_READS
BIGINT
pool_async_col_gbp_p_reads - Asynchronous
group buffer pool column-organized physical
reads
POOL_ASYNC_COL_GBP_
INVALID_PAGES
BIGINT
pool_async_col_gbp_invalid_pages Asynchronous group buffer pool invalid data

pages monitor element
POOL_ASYNC_COL_GBP_
INDEP_PAGES_FOUND_IN_LBP
BIGINT
pool_async_col_gbp_invalid_pages Asynchronous group buffer pool

column-organized invalid data pages
529

Column Name
Data Type
Description
POOL_QUEUED_ASYNC_
COL_REQS
BIGINT
prefetch requests
POOL_QUEUED_ASYNC_
TEMP_COL_REQS
BIGINT
POOL_QUEUED_ASYNC_
COL_PAGES
BIGINT
pool_queued_async_col_pages Column-organized page prefetch requests
POOL_QUEUED_ASYNC_
TEMP_COL_PAGES
BIGINT

requests
POOL_FAILED_ASYNC_
COL_REQS
BIGINT
column-organized prefetch requests
POOL_FAILED_ASYNC_
TEMP_COL_REQS
BIGINT
pool_failed_async_temp_col_reqs - Failed
SKIPPED_PREFETCH_COL_
P_READS
BIGINT
skipped_prefetch_col_p_reads - Skipped prefetch

column-organized physical reads
SKIPPED_PREFETCH_TEMP_
COL_P_READS
BIGINT
skipped_prefetch_temp_col_p_reads - Skipped
prefetch column-organized temporary physical
reads
SKIPPED_PREFETCH_UOW_
COL_P_READS
BIGINT
skipped_prefetch_uow_col_p_reads - Skipped
prefetch unit of work column-organized physical
reads
TEMP_COL_P_READS
BIGINT
skipped_prefetch_uow_temp_col_p_reads Skipped prefetch unit of work column-organized

BP_PAGES_LEFT_TO_REMOVE
BIGINT
bp_pages_left_to_remove - Number of Pages Left

to Remove monitor element
BP_TBSP_USE_COUNT
BIGINT
bp_tbsp_use_count - Number of Table Spaces

Mapped to Buffer Pool monitor element
L_READS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
530

Column Name
Data Type
Description
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
READ_TIME
BIGINT
WRITE_TIME
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
POOL_ASYNC_DATA_CACHING_
TIER_READS
BIGINT
POOL_ASYNC_INDEX_CACHING_
TIER_READS
BIGINT
POOL_ASYNC_XDA_CACHING_
TIER_READS
BIGINT
POOL_ASYNC_COL_CACHING_
TIER_READS
BIGINT
TIER_PAGE_WRITES
BIGINT
TIER_PAGE_WRITES
BIGINT
TIER_PAGE_WRITES
BIGINT
531

Column Name
Data Type
Description
TIER_PAGE_WRITES
BIGINT
TIER_PAGE_UPDATES
BIGINT
TIER_PAGE_UPDATES
BIGINT
TIER_PAGE_UPDATES
BIGINT
TIER_PAGE_UPDATES
BIGINT
TIER_PAGES_FOUND
BIGINT
TIER_PAGES_FOUND
BIGINT
TIER_PAGES_FOUND
BIGINT
TIER_PAGES_FOUND
BIGINT
TIER_GBP_INVALID_PAGES
BIGINT
BIGINT
BIGINT
BIGINT
TIER_GBP_INDEP_PAGES_FOUND
BIGINT
BIGINT
BIGINT
BIGINT
MON_GET_CF table function - Get cluster caching facility metrics:

The MON_GET_CF table function returns status information about one or more
cluster caching facilities (also known as CFs) on the system.
Syntax
MON_GET_CF (
id )
532

id An input argument of type INTEGER that specifies the identifier of the cluster
caching facility for which data will be returned. You can use the DB2_CF
administrative view to obtain the identifiers of the cluster caching facilities on
your system. If this parameter is NULL, information for all cluster caching
facilities on the system is returned.
Authorization
v DBADM authority
v SQLADM authority
None
Examples
The following query displays information about the group buffer pool size for all
cluster caching facilities on the system. It shows a resize in progress for the group
buffer pool. The CURRENT_CF_GBP_SIZE parameter shows the group buffer pool
memory currently in use. The CONFIGURED_CF_GBP_SIZE parameter shows the
group buffer pool memory currently allocated and reserved. The
TARGET_CF_GBP_SIZE parameter shows the group buffer pool dynamic resize
target.
SELECT SUBSTR(HOST_NAME,1,8) AS HOST,
SUBSTR(DB_NAME, 1,8) AS DBNAME,
CURRENT_CF_GBP_SIZE,
CONFIGURED_CF_GBP_SIZE,
TARGET_CF_GBP_SIZE
FROM TABLE( MON_GET_CF( cast(NULL as integer) ) ) AS CAMETRICS
ORDER BY HOST;

HOST
----cf15
cf16
DBNAME CURRENT_CF_GBP_SIZE CONFIGURED_CF_GBP_SIZE TARGET_CF_GBP_SIZE

------- ------------------- ---------------------- -----------------SAMPLE
2402
3000
5000
SAMPLE
1276
3000
5000
The next example returns information about the group buffer pool size for the
cluster caching facility that has the identifier of 128.
SELECT SUBSTR(HOST_NAME,1,8) AS HOST,
SUBSTR(DB_NAME, 1,8) AS DBNAME,
CURRENT_CF_GBP_SIZE,
CONFIGURED_CF_GBP_SIZE,
TARGET_CF_GBP_SIZE
FROM TABLE( MON_GET_CF( 128 ) ) AS CAMETRICS;

HOST DBNAME CURRENT_CF_GBP_SIZE CONFIGURED_CF_GBP_SIZE TARGET_CF_GBP_SIZE
----- ------ ------------------- ---------------------- -----------------cf16 SAMPLE
1276
2000
2000
533
Usage notes
The MON_GET_CF table function returns one row of data per cluster caching
facility-database pairing defined on the instance. No aggregation across cluster
caching facilities or databases is performed.
Table 135. Information returned for MON_GET_CF
Column name
Data type
HOST_NAME
VARCHAR(128)
ID
SMALLINT
id - Identification
DB_NAME
VARCHAR(128)
db_name - Database name
CURRENT_CF_GBP_SIZE
INTEGER
current_cf_gbp_size - CurrentCF group buffer pool

size
CONFIGURED_CF_GBP_SIZE
INTEGER
configured_cf_gbp_size - Configured CF group

buffer pool size
TARGET_CF_GBP_SIZE
INTEGER
target_cf_gbp_size - Target CF group buffer pool

size
CURRENT_CF_LOCK_SIZE
INTEGER
current_cf_lock_size - CurrentCF lock size
CONFIGURED_CF_LOCK_SIZE
INTEGER
configured_cf_lock_size - Configured CF lock size
TARGET_CF_LOCK_SIZE
INTEGER
target_cf_lock_size - Target CF lock size
CURRENT_CF_SCA_SIZE
INTEGER
current_cf_sca_size - Current CF shared

communication area size
CONFIGURED_CF_SCA_SIZE
INTEGER
configured_cf_sca_size - Configured CF shared

TARGET_CF_SCA_SIZE
INTEGER
target_cf_sca_size - Target CF shared

CURRENT_CF_MEM_SIZE
INTEGER
current_cf_mem_size - CurrentCF memory size
CONFIGURED_CF_MEM_SIZE
INTEGER
configured_cf_mem_size - Configured CF memory

size
MON_GET_CF_CMD - Get processing times for cluster caching facility

commands:
The MON_GET_CF_CMD table function returns information about the processing
times for cluster caching facility (CF) commands.
Syntax
MON_GET_CF_CMD (
id

id An input argument of type INTEGER that specifies the identifier of the CF for
which data is returned. You can use the DB2_CF administrative view to obtain
the identifiers for the CFs in your DB2 pureScale environment. If this
parameter is NULL, information is returned for all CFs in your DB2 pureScale
environment.
534
Authorization
v
v
v
v

DBADM authority
SQLADM authority

None
Example
The following statement is issued on a DB2 pureScale instance with multiple
members and two cluster caching facilities with identifiers CF15 and CF16:
SELECT SUBSTR(HOSTNAME,1,8) AS HOST,
SUBSTR(CF_CMD_NAME,1,20) AS CF_CMD_NAME,
TOTAL_CF_REQUESTS AS REQUESTS
FROM TABLE( MON_GET_CF_CMD(NULL) ) AS CFMETRICS
WHERE CF_CMD_NAME = SetLockState OR CF_CMD_NAME = ReadAndRegister
An example of output from this query is as follows:

HOST
----CF15
CF15
CF16
CF16
CF_CMD_NAME
----------------SetLockState
ReadAndRegister
SetLockState
ReadAndRegister
REQUESTS
--------4
7
1
1
Usage notes
Data is returned only if you issue this function in a DB2 pureScale environment.
The reported values are provided by the CF and are independent of the instance
level for a member or the number of databases that are active for a member.
The values that are returned in the TOTAL_CF_REQUESTS and
TOTAL_CF_CMD_TIME_MICRO columns are calculated since cluster startup. You cannot
reset the values; they are read-only.
You can calculate the average time by dividing the return value of the
TOTAL_CF_CMD_TIME_MICRO column by the number returned by the
TOTAL_CF_REQUESTS column.
Table 136. Information that is returned for the MON_GET_CF_CMD function
Column name
Data type
HOSTNAME
VARCHAR(255)
ID
SMALLINT
id - Identification
CF_CMD_NAME
VARCHAR(128)
Name of the CF command.
TOTAL_CF_REQUESTS
BIGINT
Total number of requests in the CF for this

command.
535
Table 136. Information that is returned for the MON_GET_CF_CMD function (continued)
Column name
Data type
TOTAL_CF_CMD_TIME_MICRO
BIGINT
Total processing time in the CF for this command,

in microseconds.
Table 137. List of CF commands that are monitored by the MON_GET_CF_CMD function
536
CF Command or alias name
Description
AllocationUnitRecovery
Recover a global lock manager (GLM) after a

local lock manager (LLM) detaches, releasing all
non-retained locks and downgrading retained
locks.
AttachLocalCache
Attach to the group buffer pool (GBP).
CrossInvalidate | XI
Send a single cross-invalidate message.
ExtendedMessageResponseBlock
Return the metric for a large message response

block transmission along with the
acknowledgment for the response transmission
from the terminating side, as measured over the
communication medium.
ExtendedMessageResponseBlockAsync
Return the metric for a large message response

block transmission over the communication
medium only. There is no waiting for an
acknowledgment for the response transmission
from the terminating side over the
communication medium; completion of the
transmission is checked separately.
LockNotification
Send a lock notification.
MessageResponseBlock
Return the metric for a message response block

transmission along with the acknowledgment for
the response transmission from the terminating
side, as measured over the communication
medium.
MessageResponseBlockAsync
Return the metric for a message response block

transmission over the communication medium
only. There is no waiting for an acknowledgment
for the response transmission from the
terminating side over the communication
medium; completion of the transmission is
checked separately.
ProcessSetLockStateExistingClient
Process the set lock state from an existing client.
ProcessSetLockStateExistingLock
Process the set lock state time for an existing lock.
ProcessSetLockStateNewClient
Process the set lock state from a new client.
ProcessSetLockStateNewLock
Process the set lock state time for a new lock.
ProcessSetLockStateSingleLock
Process the set lock state internal time for a single

lock.
ReadAndRegister | RAR
Read a single page from the CF.
ReadCacheInfo
Read the GBP cache information.
ReadCastoutClass
Read the list of pages in the castout class that are

eligible to be cast out from the CF.
ReadCCInfo
Read the castout information for a range of

castout classes from the CF.
Table 137. List of CF commands that are monitored by the MON_GET_CF_CMD

Description
ReadForCastout
Read data from the CF so that it can be cast out.
ReadForCastoutMultiple
Scan the castout queue in the CF for eligible

entries. This is a combination of the
ReadCastoutClass and ReadForCastout
commands.
ReadForCastoutMultipleList
Scan the castout queue in the CF for eligible

entries. This is a combination of the
ReadCastoutClass and ReadForCastout
commands for a specified list.
ReadLocks
Read the locks that are defined in the GLM

structure in the CF.
ReadSA
Read the aggregate value from a smart array (SA)

in the CF.
ReadSetLFS
Get or set a log flush sequence (LFS) number in

the CF.
RecordLockState | RLS
Record the lock state to the secondary CF.
RegisterPageList
Register a list of pages with the CF.
ReleaseCastoutLocks
Release castout locks on a page in the CF.
SetLockState | SLS
Set the lock state of the CF.
TestPageValidity
Test whether the local page is valid in the CF.
TryInstant
Return the commands that are issued to obtain an

instant lock from the CF.
WriteAndRegister | WAR
Send a single-page image into the CF.
WriteAndRegisterMultiple | WARM
Send a multiple-pages image into the CF.
WriteAndRegisterMultipleSubOperation Suboperation of sending a multiple-pages image

into the CF. This command returns the processing
time of each page in the CF after the data was
read from the communications medium for a
WARM operation.
Write a value into an SA and retrieve the
aggregate value in the CF.
WriteSA
MON_GET_CF_WAIT_TIME - Get wait times for cluster caching facility

commands:
The MON_GET_CF_WAIT_TIME table function returns the total time measurement
for cluster caching facility (CF) commands. This time includes the network
transport time to and from the CF and the execution time of the command within
the CF.
Syntax
MON_GET_CF_WAIT_TIME (
member

537
member
database member or -2 for all active members. If you specify the NULL value,
-1 is set implicitly.
Authorization
v DBADM authority
v SQLADM authority
None
Example
To examine the rate at which page deregistration occurs on a specific CF, which is
identified in the db2nodes.cfg file as number 128, you want to compare values
over a specific length of time. To begin, issue the following statement:
SELECT TOTAL_CF_WAIT_TIME_MICRO AS DEREG_T1,
TOTAL_CF_REQUESTS AS DEREG_RQ1
FROM TABLE (MON_GET_CF_WAIT_TIME( -1 ))
WHERE CF_CMD_NAME = DeregisterPage and ID = 128
This query returns the initial values for the comparison. Then, wait 10 seconds for
the CF to deregister additional pages.
To get the updated values, issue the following statement:
SELECT TOTAL_CF_WAIT_TIME_MICRO AS DEREG_T2,
TOTAL_CF_REQUESTS AS DEREG_RQ2
FROM TABLE (MON_GET_CF_WAIT_TIME( -1 ))
WHERE CF_CMD_NAME = DeregisterPage and ID = 128
Finally, calculate the rate at which the CF is deregistrating pages by using the
following formula:
(DEREG_RQ2 - DEREG_RQ1)
DEREG_PAGE_RATE = ----------------------(DEREG_T2 - DEREG_T1)
Usage notes
Data is returned only if you issue this function in a DB2 pureScale environment.
This table function returns one row of data per command and per member.
The values are provided at the instance level for a member, and are independent of
the number of databases active for a member, because a member is connected to a
CF at the instance level.
The values that are returned in the TOTAL_CF_REQUESTS and
TOTAL_CF_WAIT_TIME_MICRO return columns are calculated since cluster startup. You
cannot reset the values; they are read-only.
538
You can calculate the average time by dividing the return value of the
TOTAL_CF_WAIT_TIME_MICRO column by the number returned by the
TOTAL_CF_REQUESTS column.
Table 138. Information that is returned for the MON_GET_CF_WAIT_TIME function
Column name
Data type
MEMBER
SMALLINT
HOSTNAME
VARCHAR(255)
ID
SMALLINT
id - Identification
CF_CMD_NAME
VARCHAR(128)
Name of the CF command.
TOTAL_CF_REQUESTS
BIGINT
Total number of requests in the CF for this

command.
TOTAL_CF_WAIT_TIME_MICRO
BIGINT
Total wait time in the CF for this command, in

microseconds.
Table 139. List of CF commands that are monitored by the MON_GET_CF_WAIT_TIME

function
Description
DeletePage
Delete a page from the CF.
DeletePageList
Delete a list of pages from the CF.
DeleteSA
Delete an entry from a smart array (SA) in the CF.
DeleteSAList
Delete a list of entries from an SA in the CF.
DeregisterPage
Deregister a page from the CF.
DeregisterPageList
Deregister a list of pages from the CF.
GetAndIncLFS
Get and increment the log flush sequence (LFS)

number in the CF.
GetLFS
Get an LFS from the CF.
GetLSN
Get the log sequence number (LSN) from the CF.
GetNotification
Return the commands issued to get notification

messages from the global lock manager (GLM) in the
CF.
GetStatus
Get the user control structures field from the CF.
GetUDF
Get the oldest page from the CF by using the user

data field.
GLMDump
Request a dump of the GLM structure from the CF.
InitNotify
Return the commands issued to initialize message

notification from the GLM structure in the CF.
MemberUD
Access the per member user data field in the CF.
ReadAndRegister | RAR
Read a single page from the CF.
ReadAndRegisterMultiple | RARM
Read multiple pages from the CF.
ReadCastoutClass
Read list of pages in the castout class that are eligible

to be cast out from the CF.
ReadCCInfo
Read castout information for a range of castout classes

from the CF.
ReadForCastout
Read data from the CF so that it can be cast out.

539
Table 139. List of CF commands that are monitored by the MON_GET_CF_WAIT_TIME

Description
ReadForCastoutMultiple
Scan the castout queue in the CF for eligible entries.

This command is a combination of the
ReadCastoutClass and ReadForCastout commands.
ReadForCastoutMultipleList
Scan the castout queue in the CF for eligible entries.

This command is a combination of the
ReadCastoutClass and ReadForCastout) commands
for a specified list.
ReadLocks
Read the locks that are defined in the GLM structure

in the CF.
ReadSA
Read the aggregate value from an SA in the CF.
ReadSAList
Read all values for all SA variables or a particular SA

variable in the CF.
ReleaseCastoutLocks
Release the castout lock on a page in the CF.
RecordLockState | RLS
Record the lock state to the secondary CF.
RecordLockStateAsync
Record the lock state asynchronously to the secondary

CF.
RecordLockStateMultiple | RLSN
Record multiple lock states to the secondary CF.
RegisterPageList
Register a list of pages with the CF.
SetLFS
Set the LFS number in the CF.
SetLSN
Set the LSN in the CF.
SetLockState | SLS
Set the lock state to the CF.
SetLockStateAsync
Set the lock state asynchronously to the CF.
SetLockStateMultiple | SLSN
Set multiple lock states to the CF.
SetLockStateMultipleAsync
Set multiple lock states asynchronously to the CF.
SetStatus
Set the user control structures field in the CF.
TestPageValidity
Test whether a local page is valid in the CF.
TryInstant
Return the commands issued to obtain an instant lock

from the CF.
WriteAndRegister | WAR
Send a single-page image into the CF.
WriteAndRegisterMultiple | WARM
Send a multiple-pages image into the CF.
WriteSA
Write a value into an SA and retrieve the aggregate

value in the CF.
WriteSAList
Write one or more SA variables in the CF.
MON_GET_CONNECTION table function - Get connection metrics:

The MON_GET_CONNECTION table function returns metrics for one or more
connections.
Authorization
540
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_CONNECTION (
application_handle
member
, system_appls

Routine parameters
application_handle
An input parameter of type BIGINT that specifies a specific application handle
identifying the connection for which the metrics are to be returned. If the
argument is null, metrics are returned for all connections
member
system_appls
An input parameter of data type SMALLINT that specifies whether
information for system applications is returned. The following values are valid:
Table 140. Information returned for MON_GET_CONNECTION
Column name
Data type
Description
APPLICATION_HANDLE
BIGINT
APPLICATION_NAME
VARCHAR(128)
APPLICATION_ID
VARCHAR(128)
MEMBER
SMALLINT
CLIENT_WRKSTNNAME
VARCHAR(255)
CURRENT CLIENT_WRKSTNNAME special

register
CLIENT_ACCTNG
VARCHAR(255)
CLIENT_USERID
VARCHAR(255)
CLIENT_APPLNAME
VARCHAR(255)
CLIENT_PID
BIGINT
CLIENT_PRDID
VARCHAR(128)
client_prdid - Client product and version ID
CLIENT_PLATFORM
VARCHAR(12)
client_platform - Client platform

541
Table 140. Information returned for MON_GET_CONNECTION (continued)

Column name
Data type
Description
CLIENT_PROTOCOL
VARCHAR(10)
client_protocol - Client communication protocol
SYSTEM_AUTH_ID
VARCHAR(128)
system_auth_id - System authorization identifier
SESSION_AUTH_ID
VARCHAR(128)
COORD_MEMBER
SMALLINT
coord_member - Coordinating member
CONNECTION_START_TIME
TIMESTAMP
connection_start_time - Connection start time
ACT_ABORTED_TOTAL
BIGINT
ACT_COMPLETED_TOTAL
BIGINT
ACT_REJECTED_TOTAL
BIGINT
AGENT_WAIT_TIME
BIGINT
AGENT_WAITS_TOTAL
BIGINT
POOL_DATA_L_READS
BIGINT
POOL_INDEX_L_READS
BIGINT
BIGINT

data logical reads
BIGINT

index logical reads
BIGINT

POOL_XDA_L_READS
BIGINT
pool_xda_l_reads - Buffer Pool XDA Data Logical

Reads
POOL_DATA_P_READS
BIGINT
POOL_INDEX_P_READS
BIGINT

reads
BIGINT

data physical reads
BIGINT

index physical reads
BIGINT

POOL_XDA_P_READS
BIGINT

reads
POOL_DATA_WRITES
BIGINT
POOL_INDEX_WRITES
BIGINT
POOL_XDA_WRITES
BIGINT
POOL_READ_TIME
BIGINT

time
POOL_WRITE_TIME
BIGINT

time
BIGINT
DEADLOCKS
BIGINT
DIRECT_READS
BIGINT
DIRECT_READ_TIME
BIGINT
DIRECT_WRITES
BIGINT
542

Column name
Data type
Description
DIRECT_WRITE_TIME
BIGINT
DIRECT_READ_REQS
BIGINT
DIRECT_WRITE_REQS
BIGINT
FCM_RECV_VOLUME
BIGINT
fcm_recv_volume - FCM recv volume
FCM_RECVS_TOTAL
BIGINT
fcm_recvs_total - FCM recvs total
FCM_SEND_VOLUME
BIGINT
FCM_SENDS_TOTAL
BIGINT
FCM_RECV_WAIT_TIME
BIGINT
fcm_recv_wait_time - FCM recv wait time
FCM_SEND_WAIT_TIME
BIGINT
IPC_RECV_VOLUME
BIGINT
ipc_recv_volume - Interprocess communication recv

volume
IPC_RECV_WAIT_TIME
BIGINT

recv wait time
IPC_RECVS_TOTAL
BIGINT
ipc_recvs_total - Interprocess communication recvs

total
IPC_SEND_VOLUME
BIGINT
ipc_send_volume - Interprocess communication

send volume
IPC_SEND_WAIT_TIME
BIGINT

send wait time
IPC_SENDS_TOTAL
BIGINT
ipc_sends_total - Interprocess communication send

total
LOCK_ESCALS
BIGINT
LOCK_TIMEOUTS
BIGINT
LOCK_WAIT_TIME
BIGINT
LOCK_WAITS
BIGINT
BIGINT
NUM_LOG_BUFFER_FULL
BIGINT
num_log_buffer_full - Number of full log buffers
LOG_DISK_WAIT_TIME
BIGINT
BIGINT
log_disk_waits_total - Log disk waits total
NUM_LOCKS_HELD
BIGINT
locks_held - Locks held
BIGINT
ROWS_MODIFIED
BIGINT
ROWS_READ
BIGINT
ROWS_RETURNED
BIGINT
TCPIP_RECV_VOLUME
BIGINT
TCPIP_SEND_VOLUME
BIGINT
BIGINT
tcpip_recv_wait_time - TCP/IP recv wait time
TCPIP_RECVS_TOTAL
BIGINT
tcpip_recvs_total - TCP/IP recvs total
BIGINT
TCPIP_SENDS_TOTAL
BIGINT
TOTAL_APP_RQST_TIME
BIGINT
TOTAL_RQST_TIME
BIGINT

543

Column name
Data type
Description
BIGINT

queue time
BIGINT
wlm_queue_assignments_total - Workload manager

total queue assignments
TOTAL_CPU_TIME
BIGINT
TOTAL_WAIT_TIME
BIGINT
BIGINT
app_rqsts_completed_total - Total application

requests completed
BIGINT
BIGINT

processing time
TOTAL_SECTION_SORTS
BIGINT
TOTAL_SORTS
BIGINT
total_sorts - Total Sorts
BIGINT
BIGINT

sorts
SORT_OVERFLOWS
BIGINT
TOTAL_COMPILE_TIME
BIGINT
BIGINT

time
TOTAL_COMPILATIONS
BIGINT
BIGINT
total_implicit_compile_time - Total implicit compile

time
_PROC_TIME
BIGINT

BIGINT
total_implicit_compilations - Total implicit

complications
TOTAL_SECTION_TIME
BIGINT
BIGINT

time
BIGINT
total_app_section_executions - Total section

executions
TOTAL_ACT_TIME
BIGINT
TOTAL_ACT_WAIT_TIME
BIGINT
ACT_RQSTS_TOTAL
BIGINT
TOTAL_ROUTINE_TIME
BIGINT
BIGINT
TOTAL_COMMIT_TIME
BIGINT
BIGINT

time
TOTAL_APP_COMMITS
BIGINT
INT_COMMITS
BIGINT
TOTAL_ROLLBACK_TIME
BIGINT
544

Column name
Data type
Description
BIGINT

time
TOTAL_APP_ROLLBACKS
BIGINT
INT_ROLLBACKS
BIGINT
TOTAL_RUNSTATS_TIME
BIGINT
total_runstats_time - Total runtime statistics
BIGINT

processing time
TOTAL_RUNSTATS
BIGINT
TOTAL_REORG_TIME
BIGINT
BIGINT

processing time
TOTAL_REORGS
BIGINT
TOTAL_LOAD_TIME
BIGINT
BIGINT
TOTAL_LOADS
BIGINT
CAT_CACHE_INSERTS
BIGINT
CAT_CACHE_LOOKUPS
BIGINT
PKG_CACHE_INSERTS
BIGINT
PKG_CACHE_LOOKUPS
BIGINT
THRESH_VIOLATIONS
BIGINT
BIGINT
num_lw_thresh_exceeded - Number of thresholds

exceeded
LOCK_WAITS_GLOBAL
BIGINT
BIGINT
BIGINT
BIGINT

escalations
BIGINT

escalations
LOCK_ESCALS_GLOBAL
BIGINT

escalations
RECLAIM_WAIT_TIME
BIGINT
BIGINT

CF_WAITS
BIGINT
CF_WAIT_TIME
BIGINT
BIGINT

logical reads
BIGINT

physical reads
BIGINT

found data pages
545

Column name
Data type
Description
BIGINT

invalid data pages
BIGINT

logical reads
BIGINT
pool_index_gbp_p_reads - Group buffer pool index

physical reads
BIGINT

index pages found
BIGINT
pool_index_gbp_invalid_pages - Group buffer pool

invalid index pages
BIGINT

BIGINT

BIGINT
pool_xda_lbp_pages_found - Local buffer pool XDA

data pages found
BIGINT

AUDIT_EVENTS_TOTAL
BIGINT
BIGINT
audit_file_writes_total - Total Audit files written
BIGINT

time
BIGINT

subsystem waits
BIGINT

time
CLIENT_HOSTNAME
VARCHAR(255)
client_hostname - Client hostname monitor element
CLIENT_PORT_NUMBER
INTEGER
client_port_number - Client port number monitor

element
BIGINT
diaglog_writes_total - Diag log total writes
BIGINT
diaglog_write_wait_time - Diag log write time
BIGINT
fcm_message_recvs_total - FCM message recvs total
BIGINT
fcm_message_recv_volume - FCM message recv

volume
BIGINT
fcm_message_recv_wait_time - FCM message recv

wait time
BIGINT
fcm_message_sends_total - FCM message sends

total
BIGINT

volume
BIGINT

wait time
FCM_TQ_RECVS_TOTAL
BIGINT
fcm_tq_recvs_total - FCM tablequeue recvs total
FCM_TQ_RECV_VOLUME
BIGINT
fcm_tq_recv_volume - FCM tablequeue recv

volume
546

Column name
Data type
Description
BIGINT
fcm_tq_recv_wait_time - FCM tablequeue recv wait

time
FCM_TQ_SENDS_TOTAL
BIGINT
fcm_tq_sends_total - FCM tablequeue send total
FCM_TQ_SEND_VOLUME
BIGINT
fcm_tq_send_volume - FCM tablequeue send

volume
BIGINT
fcm_tq_send_wait_time - FCM tablequeue send

wait time
LAST_EXECUTABLE_ID
VARCHAR(32)
FOR BIT DATA
last_executable_id - Last executable identifier
LAST_REQUEST_TYPE
VARCHAR(32)
last_request_type - Last request type
TOTAL_ROUTINE_USER_CODE_PROC
_TIME
BIGINT

BIGINT

code time
TQ_TOT_SEND_SPILLS
BIGINT

buffers overflowed
EVMON_WAIT_TIME
BIGINT
EVMON_WAITS_TOTAL
BIGINT
BIGINT

latch wait time
BIGINT

waits
VARCHAR(3)
intra_parallel_state - Currentstate of intrapartition

parallelism
BIGINT
total_stats_fabrication_time - Total statistics

fabrication time
TOTAL_STATS_FABRICATION_PROC
_TIME
BIGINT

BIGINT
BIGINT
total_sync_runstats_time - Total synchronous

RUNSTATS time
BIGINT

TOTAL_SYNC_RUNSTATS
BIGINT
total_sync_runstats - Total synchronous RUNSTATS

activities
BIGINT

queue time
TOTAL_PEDS
BIGINT
DISABLED_PEDS
BIGINT
POST_THRESHOLD_PEDS
BIGINT

threshold
TOTAL_PEAS
BIGINT
POST_THRESHOLD_PEAS
BIGINT

threshold
BIGINT

requests
547

Column name
Data type
Description
BIGINT

rejections
BIGINT

requests
BIGINT

requests
BIGINT

requests
_REQS
BIGINT
pool_queued_async_temp_data_reqs - Data prefetch

_REQS
BIGINT
_REQS
BIGINT

BIGINT
requests
BIGINT

prefetch requests
BIGINT

prefetch requests
BIGINT

prefetch requests
_PAGES
BIGINT
pool_queued_async_temp_data_pages - Data pages

_PAGES
BIGINT
_PAGES
BIGINT

BIGINT

requests
BIGINT

prefetch requests
BIGINT

requests
_REQS
BIGINT

_REQS
BIGINT

POOL_FAILED_ASYNC_TEMP_XDA_REQS BIGINT

BIGINT

requests
PREFETCH_WAIT_TIME
BIGINT
PREFETCH_WAITS
BIGINT
BIGINT
app_act_completed_total - Total successful external

coordinator activities
548

Column name
Data type
Description
BIGINT
app_act_aborted_total - Total failed external

BIGINT
app_act_rejected_total - Total rejected external

BIGINT
total_connect_request_time - Total connection or

switch user request time
TOTAL_CONNECT_REQUEST_PROC_TIME BIGINT
total_connect_request_proc_time - Total connection

or switch user request processing time
BIGINT
total_connect_requests - Connection or switch user

requests
TOTAL_CONNECT_AUTHENTICATION
_TIME
BIGINT
total_connect_authentication_time - Total
connection or switch user authentication request
time
_PROC_TIME
BIGINT
BIGINT
total_connect_authentications - Connections or
switch user authentications performed
POOL_DATA_GBP_INDEP_PAGES
_FOUND_IN_LBP
BIGINT
Number of Group Buffer Pool (GBP) independent

data pages found in Local Buffer Pool (LBP) by
agent.
POOL_INDEX_GBP_INDEP_PAGES
_FOUND_IN_LBP
BIGINT
Number of GBP independent index pages found in

LBP by agent.
_FOUND_IN_LBP
BIGINT
Number of GBP independent XML storage object

(XDA) data pages found in LBP by agent.
COMM_EXIT_WAIT_TIME
BIGINT

COMM_EXIT_WAITS
BIGINT

number of waits monitor element
IDA_SEND_WAIT_TIME
BIGINT

IDA_SENDS_TOTAL
BIGINT
The total number of times data was sent to an

IDA_SEND_VOLUME
BIGINT
The total volume of data sent from the database

server to an in-database analytics process. The
value is reported in bytes.
IDA_RECV_WAIT_TIME
BIGINT

IDA_RECVS_TOTAL
BIGINT
The total number of times data was received from

an in-database analytics process.
IDA_RECV_VOLUME
BIGINT
The total volume of data the database server

received from an in-database analytics process. The
MEMBER_SUBSET_ID
INTEGER
member_subset_id - Member subset ID
IS_SYSTEM_APPL
SMALLINT

element
LOCK_TIMEOUT_VAL
BIGINT
lock_timeout_val - Lock timeout value monitor

element
CURRENT_ISOLATION
CHAR(2)
current_isolation - Current isolation level

549

Column name
Data type
Description
NUM_LOCKS_WAITING
BIGINT
locks_waiting - Current agents waiting on locks

monitor element
UOW_CLIENT_IDLE_WAIT_TIME
BIGINT
uow_client_idle_wait_time - Client idle time within

a unit of work
ROWS_DELETED
BIGINT
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
TOTAL_HASH_JOINS
BIGINT
TOTAL_HASH_LOOPS
BIGINT

element
HASH_JOIN_OVERFLOWS
BIGINT

element
BIGINT

BIGINT
post_shrthreshold_hash_joins - Post threshold hash

joins monitor element
TOTAL_OLAP_FUNCS
BIGINT

element
OLAP_FUNC_OVERFLOWS
BIGINT

monitor element
DYNAMIC_SQL_STMTS
BIGINT
dynamic_sql_stmts - Dynamic SQL Statements

Attempted monitor element
STATIC_SQL_STMTS
BIGINT
static_sql_stmts - Static SQL Statements Attempted

monitor element
FAILED_SQL_STMTS
BIGINT
failed_sql_stmts - Failed Statement Operations

monitor element
SELECT_SQL_STMTS
BIGINT
select_sql_stmts - Select SQL Statements Executed

monitor element
UID_SQL_STMTS
BIGINT
uid_sql_stmts - Update/Insert/Delete SQL

Statements Executed monitor element
DDL_SQL_STMTS
BIGINT
ddl_sql_stmts - Data Definition Language (DDL)

SQL Statements monitor element
MERGE_SQL_STMTS
BIGINT
merge_sql_stmts - Merge SQL statements executed
XQUERY_STMTS
BIGINT
xquery_stmts - XQuery Statements Attempted

monitor element
IMPLICIT_REBINDS
BIGINT
implicit_rebinds - number of implicit rebinds
BINDS_PRECOMPILES
BIGINT
binds_precompiles - Binds/Precompiles Attempted

monitor element
INT_ROWS_DELETED
BIGINT

element
INT_ROWS_INSERTED
BIGINT

element
INT_ROWS_UPDATED
BIGINT

element
CALL_SQL_STMTS
BIGINT
call_sql_stmts - CALL SQL statements executed
550

Column name
Data type
Description
POOL_COL_L_READS
BIGINT

logical reads
BIGINT

POOL_COL_P_READS
BIGINT

physical reads
BIGINT

BIGINT

POOL_COL_WRITES
BIGINT

writes
BIGINT

BIGINT

BIGINT

POOL_COL_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
BIGINT
prefetch requests
POOL_QUEUED_ASYNC_
TEMP_COL_REQS
BIGINT
POOL_QUEUED_ASYNC_
COL_PAGES
BIGINT
pool_queued_async_col_pages - Column-organized
page prefetch requests
POOL_QUEUED_ASYNC_
TEMP_COL_PAGES
BIGINT

requests
BIGINT
POOL_FAILED_ASYNC_
TEMP_COL_REQS
BIGINT
TOTAL_COL_TIME
BIGINT
TOTAL_COL_PROC_TIME
BIGINT

processing time
BIGINT

executions
CLIENT_IPADDR
VARCHAR(128)
client_ipaddr - Client IP address monitor element
SQL_REQS_SINCE_COMMIT
BIGINT
sql_reqs_since_commit - SQL Requests Since Last

Commit monitor element
UOW_START_TIME
TIMESTAMP
uow_start_time - Unit of work start timestamp

monitor element
UOW_STOP_TIME
TIMESTAMP
uow_stop_time - Unit of work stop timestamp

monitor element
551

Column name
Data type
Description
PREV_UOW_STOP_TIME
TIMESTAMP
prev_uow_stop_time - Previous Unit of Work

Completion Timestamp monitor element
UOW_COMP_STATUS
VARCHAR(14)
uow_comp_status - Unit of Work Completion

Status monitor element
NUM_ASSOC_AGENTS
BIGINT
num_assoc_agents - Number of Associated Agents

monitor element
ASSOCIATED_AGENTS_TOP
BIGINT
associated_agents_top - Maximum Number of

Associated Agents monitor element
WORKLOAD_OCCURRENCE_STATE
VARCHAR(32)
workload_occurrence_state - Workload occurrence

state monitor element
BIGINT

monitor element
L_READS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
READ_TIME
BIGINT
WRITE_TIME
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
552

Column name
Data type
Description
PAGES_FOUND
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
BIGINT
BIGINT
POOL_XDA_CACHING_TIER_GBP_
INDEP_PAGES_FOUND
BIGINT
BIGINT
TOTAL_HASH_GRPBYS
BIGINT
BIGINT
BIGINT

threshold
EXECUTION_ID
VARCHAR(128)
execution_id - User Login ID monitor element
BIGINT

Usage notes
The metrics returned by the MON_GET_CONNECTION table function represent
the accumulation of all metrics for requests that were submitted by a connection.
Metrics are rolled up at unit of work boundaries, and periodically during the
execution of requests. Therefore, the values reported by this table function reflect
the current state of the system at the time of the most recent rollup. Metrics are
strictly increasing in value. To determine the value of a given metric for an interval
of time, use the MON_GET_CONNECTION table function to query the metric at
the start and end of the interval, and compute the difference.
Request metrics are controlled through the COLLECT REQUEST METRICS clause
on service superclasses and the mon_req_metrics database configuration parameter
at the database level. Metrics are only collected for a request if the request is
processed by an agent in a service subclass whose parent service superclass has
request metrics enabled, or if request metrics collection is enabled for the entire
database. By default, request metrics are enabled at the database level. If request
metrics are disabled at the database level and for a service superclass, then the
metrics reported for each connection that is mapped to that service superclass will
stop increasing (or remain at 0 if request metrics were disabled at database
activation time).
553
Tip: As a connection can be mapped to more than one service superclass during
its lifetime, the metrics reported through the MON_GET_CONNECTION table
function might represent a subset of the metrics for all requests submitted over the
connection. This might occur if metrics collection is disabled for some of the
superclasses that are mapped by the connection.
The MON_GET_CONNECTION table function returns one row of data per
connection and per member. No aggregation across members (for a service class or
more), is performed. However, aggregation can be achieved through SQL queries.
Example
Display connections that return the highest volume of data to clients, ordered by
rows returned.
rows_returned,
tcpip_send_volume
FROM TABLE(MON_GET_CONNECTION(cast(NULL as bigint), -2)) AS t
ORDER BY rows_returned DESC

APPLICATION_HANDLE
ROWS_RETURNED
TCPIP_SEND_VOLUME
-------------------- -------------------- -------------------55
6
0
MON_GET_CONNECTION_DETAILS table function - Get detailed connection

metrics:
The MON_GET_CONNECTION_DETAILS table function returns detailed metrics
for one or more connections.
Authorization
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_CONNECTION_DETAILS (
member
)
, system_appls
554
application_handle

Routine parameters
application_handle
An input argument of type BIGINT that specifies a specific application handle
identifying the connection for which the metrics are to be returned. If the
argument is NULL, metrics are returned for all connections.
member
system_appls
Table 141. Information returned for MON_GET_CONNECTION_DETAILS
Column Name
Data Type
Description
APPLICATION_HANDLE
BIGINT
MEMBER
SMALLINT
DETAILS
BLOB(1M)
XML document containing detailed metrics for the unit of

work. See Table 142 on page 556 for a description of the
elements in this document.
<db2_connection xmlns="http://www.ibm.com/xmlns/prod/db2/mon" release="90700000">
<member>0</member>
<system_metrics release="90700000">
<act_aborted_total>5</act_aborted_total>
...
<wlm_queue_assignments_total>3</wlm_queue_assignments_total>
</system_metrics>
</db2_connection>
For the full schema, see sqllib/misc/DB2MonRoutines.xsd.

This document uses the following non-primitive XML type definitions:
<xs:simpleType name="db2DbObjectString">
<xs:restriction base="xs:string">
<xs:maxLength value="128"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="db2PartitionNum">
<xs:restriction base="xs:nonNegativeInteger">
<xs:maxInclusive value="999"/>
</xs:restriction>
</xs:simpleType>
555
Table 142. Detailed metrics returned for MON_GET_CONNECTION_DETAILS

Element Name
Data Type
Description
act_aborted_total
xs:nonNegativeInteger
act_completed_total
act_rejected_total
act_rqsts_total
agent_wait_time
agent_waits_total
app_act_aborted_total

app_act_completed_total

app_act_rejected_total

app_rqsts_completed_total
app_rqsts_completed_total - Total application requests

completed
application_handle
application_id
xs:string
application_name
xs:string
associated_agents_top
xs:long
associated_agents_top - Maximum Number of

Associated Agents monitor element
audit_events_total

time
audit_subsystem_waits_total - Total audit subsystem

waits
binds_precompiles
xs:long

monitor element
call_sql_stmts
xs:long
cat_cache_inserts
cat_cache_lookups
client_acctng
xs:string (255)
client_applname
xs:string (255)
client_hostname
xs:string
client_hostname - Client hostname
client_idle_wait_time
client_ipaddr
xs:string
client_pid
client_platform
xs:string
client_platform - Client platform
client_port_number
client_port_number - Client port number
client_prdid
xs:string
client_prdid - Client product and version ID
client_protocol
xs:string
client_protocol - Client communication protocol
client_userid
xs:string (255)
556
Table 142. Detailed metrics returned for MON_GET_CONNECTION_DETAILS (continued)

Element Name
Data Type
Description
client_wrkstnname
xs:string (255)
comm_exit_wait_time

comm_exit_waits
comm_exit_waits - Communication buffer exit number

of waits monitor element
connection_start_time
xs:dateTime
connection_start_time - Connection start time
coord_member
xs:short
coord_member - Coordinating member
current_isolation
xs:string
ddl_sql_stmts
xs:long
ddl_sql_stmts - Data Definition Language (DDL) SQL

Statements monitor element
deadlocks
direct_read_reqs
direct_read_time
direct_reads
direct_write_reqs
direct_write_time
direct_writes
disabled_peds
xs:long
dynamic_sql_stmts
xs:long

evmon_wait_time
evmon_waits_total
execution_id
xs:string(128)
failed_sql_stmts
xs:long
failed_sql_stmts - Failed Statement Operations monitor

element

volume
fcm_message_recv_wait_time - FCM message recv wait

time

volume

wait time
fcm_message_sends_total - FCM message sends total
fcm_recv_volume
fcm_recv_wait_time
fcm_recvs_total
fcm_send_volume
fcm_send_wait_time
fcm_sends_total

557

Element Name
Data Type
Description
fcm_tq_recv_volume
fcm_tq_recv_volume - FCM tablequeue recv volume

time
fcm_tq_recvs_total
fcm_tq_send_volume
fcm_tq_send_volume - FCM tablequeue send volume
fcm_tq_send_wait_time - FCM tablequeue send wait

time
fcm_tq_sends_total
xs:long
hash_join_overflows
xs:long

element
xs:long

ida_recv_volume
The total volume of data the database server received

reported in bytes.
ida_recv_wait_time
The total amount of time spent waiting to receive data

ida_recvs_total
The total number of times data was received from an

ida_send_volume
The total volume of data sent from the database server

to an in-database analytics process. The value is
reported in bytes.
ida_send_wait_time
The total amount of time spent waiting to send data to

ida_sends_total

implicit_rebinds
xs:long
int_commits
int_rollbacks
int_rows_deleted
xs:long

element
int_rows_inserted
xs:long

element
int_rows_updated
xs:long

element
xs:string

ipc_recv_volume

volume
ipc_recv_wait_time
ipc_recv_wait_time - Interprocess communication recv

wait time
ipc_recvs_total

total
ipc_send_volume
ipc_send_volume - Interprocess communication send

volume
558

Element Name
Data Type
Description
ipc_send_wait_time
ipc_send_wait_time - Interprocess communication send

wait time
ipc_sends_total

total
is_system_appl
xs:short

element
last_executable_id
xs:hexBinary(32)
last_request_type
xs:string(32)
lock_escals
lock_timeout_val
xs:long

element
lock_timeouts
lock_wait_time
lock_waits
log_disk_wait_time
member
member_subset_id
xs:long
merge_sql_stmts
xs:long
num_assoc_agents
xs:long

monitor element
num_locks_held
num_locks_waiting
xs:long

monitor element
num_log_buffer_full

exceeded
olap_func_overflows
xs:long

monitor element
pkg_cache_inserts
pkg_cache_lookups
pool_col_gbp_indep_
pages_found_in_lbp

column-organized GBP independent pages found in
local buffer pool

pool_col_gbp_l_reads - Buffer pool column-organized

GBP logical reads
pool_col_gbp_p_reads - Buffer pool column-organized

GBP physical reads
pool_col_l_reads

logical reads
559

Element Name
Data Type
Description

pool_col_p_reads

physical reads
pool_col_writes
pool_data_gbp_indep_pages_
found_in_lbp
pool_data_gbp_indep_pages_found_in_lbp - Group
buffer pool independent data pages found in local
pool_data_l_reads
pool_data_p_reads
pool_data_writes
pool_failed_async_col_reqs - Failed column-organized

prefetch requests

requests
pool_failed_async_index_reqs - Failed index prefetch

requests

requests
pool_failed_async_temp_
col_reqs
_reqs

_reqs

_reqs


requests
_found_in_lbp
pool_index_gbp_indep_pages_found_in_lbp - Group
buffer pool independent index pages found in local
pool_index_l_reads
pool_index_p_reads
pool_index_writes
pool_queued_async_
col_pages
prefetch requests
pool_queued_async_data_pages - Data pages prefetch

requests
pool_queued_async_index
_pages

prefetch requests

requests
560

Element Name
Data Type
Description
pool_queued_async_
temp_col_pages
pool_queued_async_temp_col_pages Column-organized page temporary prefetch requests
pool_queued_async_
temp_col_reqs
_pages

_reqs

_pages
pool_queued_async_temp_index_pages - Index pages

_reqs
pool_queued_async_temp_index_reqs - Index prefetch

_pages

_reqs

pool_read_time
pool_temp_col_l_reads - Buffer pool column-organized


pool_temp_data_l_reads - Buffer pool temporary data

logical reads
pool_temp_data_p_reads - Buffer pool temporary data

physical reads

index logical reads

pool_temp_xda_l_reads - Buffer pool temporary XDA

data logical reads
pool_temp_xda_p_reads - Buffer pool temporary XDA

data physical reads
pool_write_time
_found_in_lbp

pool_xda_gbp_l_reads - Group buffer pool XDA data

pool_xda_gbp_p_reads - Group buffer pool XDA data

pool_xda_l_reads
561

Element Name
Data Type
Description

data pages found
pool_xda_p_reads

reads
pool_xda_writes
xs:long

xs:long

threshold
xs:long

monitor element
xs:long

monitor element
post_threshold_peas
xs:long

threshold
post_threshold_peds
xs:long
prefetch_wait_time
prefetch_waits
prev_uow_stop_time
xs:dateTime

rows_deleted
xs:long
rows_inserted
xs:long
rows_modified
rows_read
rows_returned
rows_updated
xs:long
select_sql_stmts
xs:long

monitor element
session_auth_id
xs:string
sort_overflows
sql_reqs_since_commit
xs:long

static_sql_stmts
xs:long

monitor element
system_auth_id
xs:string
tcpip_recv_volume
tcpip_recv_wait_time
tcpip_recvs_total
tcpip_send_volume
tcpip_send_wait_time
562

Element Name
Data Type
Description
tcpip_sends_total
thresh_violations
total_act_time
total_act_wait_time
total_app_commits
total_app_rollbacks
total_app_rqst_time
total_app_section_executions - Total section executions

executions
total_col_proc_time

processing time
total_col_time
total_commit_proc_time

time
total_commit_time
total_compilations
total_compile_proc_time

time
total_compile_time
total_connect_authentication
_proc_time
connection authentication processing time monitor
element
_time
total_connect_authentication_time - Total connection or

switch user authentication request time monitor
element
total_connect_authentications
total_connect_authentications - Connections or switch

user authentications performed
total_connect_request_proc_time

switch user request processing time monitor element
total_connect_request_time
total_connect_request_time - Total connection or switch

user request time monitor element
total_connect_requests

requests
total_cpu_time
xs:long

queue time

wait time
total_hash_grpbys
xs:long
total_hash_joins
xs:long
total_hash_loops
xs:long
563

Element Name
Data Type
Description
total_implicit_compilations

complications
total_implicit_compile_
proc_time

total_implicit_compile_time

time
total_load_proc_time
total_load_time
total_loads
total_olap_funcs
xs:long

element
total_peas
xs:long
total_peds
xs:long
total_reorg_proc_time
total_reorg_proc_time - Total reorganization processing

time
total_reorg_time
total_reorgs
total_rollback_proc_time

time
total_rollback_time
total_routine_time
total_routine_user_code
_proc_time

total_routine_user_code_time
total_routine_user_code_time - Total routine user code

time
total_rqst_time
total_runstats
total_runstats_proc_time

processing time
total_runstats_time
total_section_sort_proc_time

processing time
total_section_sorts
total_section_time
total_sorts
total_stats_fabrication_proc
_time

total_stats_fabrication_time
total_stats_fabrication_time - Total statistics fabrication

time
total_stats_fabrications
564

Element Name
Data Type
Description
total_sync_runstats

activities
total_sync_runstats_proc_time

total_sync_runstats_time

RUNSTATS time
total_wait_time
xs:long

rejections
xs:long
tq_tot_send_spills

buffers overflowed
uid_sql_stmts
xs:long
uid_sql_stmts - Update/Insert/Delete SQL Statements

Executed monitor element
uow_client_idle_wait_time
xs:long
uow_client_idle_wait_time - Client idle time within a

unit of work
uow_comp_status
xs:string
uow_comp_status - Unit of Work Completion Status

monitor element
uow_start_time
xs:dateTime
uow_start_time - Unit of work start timestamp

monitor element
uow_stop_time
xs:dateTime
uow_stop_time - Unit of work stop timestamp monitor

element


queue time
workload_occurrence_state
xs:string
workload_occurrence_state - Workload occurrence state

monitor element
xquery_stmts
xs:long
xquery_stmts - XQuery Statements Attempted monitor

element
Usage notes
The metrics returned by the MON_GET_CONNECTION_DETAILS table function
represent the accumulation of all metrics for requests that were submitted by a
connection. This function is similar to the MON_GET_CONNECTION table
function:
v The MON_GET_CONNECTION table function returns the most commonly used
metrics in a column-based format and is the most performance efficient method
of retrieving metrics.
v The MON_GET_CONNECTION_DETAILS table function returns the entire set of
available metrics in an XML document format, which provides maximum
flexibility for formatting output. The XML-based output can be parsed directly
by an XML parser, or it can be converted to relational format by the XMLTABLE
function (see the example).
Metrics are rolled up at unit of work boundaries, and periodically during the
execution of requests. Therefore, the values reported by this table function reflect
565
the current state of the system at the time of the most recent rollup. Metrics are
strictly increasing in value. To determine the value of a given metric for an interval
of time, use the MON_GET_CONNECTION_DETAILS table function to query the
metric at the start and end of the interval, and compute the difference.
database. By default, request metrics are enabled are enabled at the database level.
If request metrics are disabled at the database level, and for a service superclass,
the metrics reported for each connection mapped to that service superclass stop
increasing (or remain at 0 if request metrics were disabled at database activation
time).
Tip: As a connection can be mapped to more than one service superclass during
its lifetime, if collection is disabled at the database level, the metrics reported
through the MON_GET_CONNECTION_DETAILS table function might represent a
subset of the metrics for all requests submitted over the connection. This might
occur if metrics collection is disabled for some of the superclasses to which the
connection maps.
The MON_GET_CONNECTION_DETAILS table function returns one row of data
per connection and per member. No aggregation across members (for a service
class or more) is performed. However, aggregation can be achieved through SQL
queries.
Example
Display connections returning the highest volume of data to clients, ordered by
rows returned.
SELECT detmetrics.application_handle,
detmetrics.rows_returned,
detmetrics.tcpip_send_volume
FROM TABLE(MON_GET_CONNECTION_DETAILS(CAST(NULL as bigint), -2))
AS CONNMETRICS,
$detmetric/db2_connection PASSING XMLPARSE(DOCUMENT CONNMETRICS.DETAILS)
as "detmetric"
COLUMNS "APPLICATION_HANDLE" INTEGER PATH application_handle,
"ROWS_RETURNED" BIGINT PATH system_metrics/rows_returned,
"TCPIP_SEND_VOLUME" BIGINT PATH system_metrics/tcpip_send_volume
) AS DETMETRICS

APPLICATION_HANDLE ROWS_RETURNED
TCPIP_SEND_VOLUME
------------------ -------------------- -------------------21
4
0
566
MON_GET_CONTAINER table function - Get table space container metrics:

The MON_GET_CONTAINER table function returns monitor metrics for one or
more table space containers.
Syntax
MON_GET_CONTAINER (
tbsp_name
, member

tbsp_name
An input argument of type VARCHAR(128) that specifies a valid table space
name in the same database as the one currently connected to when calling this
function. If the argument is null or an empty string, metrics are returned for all
containers in all table spaces in the database.
member
Authorization
v
v
v
v

DBADM authority
SQLADM authority

None
Example
Example 1: List containers on all database members that have the highest read time.
SELECT varchar(container_name,70) as container_name,
varchar(tbsp_name,20) as tbsp_name,
pool_read_time
FROM TABLE(MON_GET_CONTAINER(,-2)) AS t
ORDER BY pool_read_time DESC

CONTAINER_NAME
---------------------------------------------------------------------/home/hotel55/swalkty/swalkty/NODE0000/TEST/T0000000/C0000000.CAT
/home/hotel55/swalkty/swalkty/NODE0000/TEST/T0000002/C0000000.LRG
/home/hotel55/swalkty/swalkty/NODE0000/TEST/T0000001/C0000000.TMP
...
...
...
...
...

567
...
...
...
...
...
TBSP_NAME
POOL_READ_TIME
-------------------- -------------------SYSCATSPACE
597
USERSPACE1
42
TEMPSPACE1
0
Example 2: List any containers that are not accessible.

SELECT varchar(container_name, 70) as container_name
WHERE accessible = 0

CONTAINER_NAME
---------------------------------------------------------------------0 record(s) selected.
Example 3: List utilization of container file systems, ordered by highest utilization.

SELECT varchar(container_name, 65) as container_name,
fs_id,
fs_used_size,
fs_total_size,
CASE WHEN fs_total_size > 0
THEN DEC(100*(FLOAT(fs_used_size)/FLOAT(fs_total_size)),5,2)
ELSE DEC(-1,5,2)
END as utilization
ORDER BY utilization DESC

CONTAINER_NAME
----------------------------------------------------------------/home/hotel55/swalkty/swalkty/NODE0000/TEST/T0000000/C0000000.CAT
/home/hotel55/swalkty/swalkty/NODE0000/TEST/T0000001/C0000000.TMP
/home/hotel55/swalkty/swalkty/NODE0000/TEST/T0000002/C0000000.LRG
...
...
...
...
...

FS_ID
FS_USED_SIZE
FS_TOTAL_SIZE
UTILIZATION
-------------------- -------------------- -------------------- ----------64768
106879311872
317068410880
33.70
64768
106879311872
317068410880
33.70
64768
106879311872
317068410880
33.70
Usage notes
The MON_GET_CONTAINER table function returns one row of data per container
and per database member. Data can be returned for all containers in a given table
space, or for all containers in the database. No aggregation across database
partitions is performed. However, aggregation can be achieved through SQL
queries.
568
Table 143. Information returned for MON_GET_CONTAINER
Column Name
Data Type
TBSP_NAME
VARCHAR(128)
tablespace_name - Table space name
TBSP_ID
BIGINT
tablespace_id - Table space identification
CONTAINER_NAME
VARCHAR(256)
container_name - Container name
CONTAINER_ID
BIGINT
container_id - Container identification
MEMBER
SMALLINT
CONTAINER_TYPE
VARCHAR(16)
container_type - Container type This is a text identifier

based on the defines in sqlutil.h and is one of:
v DISK_EXTENT_TAG
v DISK_PAGE_TAG
v FILE_EXTENT_TAG
v FILE_PAGE_TAG
v PATH
STRIPE_SET
BIGINT
container_stripe_set - Stripe set
DIRECT_READS
BIGINT
DIRECT_WRITES
BIGINT
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT
PAGES_READ
BIGINT
pages_read - Number of pages read
PAGES_WRITTEN
BIGINT
pages_written - Number of pages written
VECTORED_IOS
BIGINT
BIGINT
pages_from_vectored_ios - Total number of pages read

by vectored IO
BLOCK_IOS
BIGINT
BIGINT
pages_from_block_ios - Total number of pages read by

block IO
POOL_READ_TIME
BIGINT
POOL_WRITE_TIME
BIGINT
TOTAL_PAGES
BIGINT
container_total_pages - Total pages in container
USABLE_PAGES
BIGINT
container_usable_pages - Usable pages in container
ACCESSIBLE
SMALLINT
container_accessible - Accessibility of container
FS_ID
VARCHAR(22)
fs_id - Unique file system identification number
FS_TOTAL_SIZE
BIGINT
fs_total_size - Total size of a file system
FS_USED_SIZE
BIGINT
fs_used_size - Amount of space used on a file system
569
Table 143. Information returned for MON_GET_CONTAINER (continued)

Column Name
Data Type
DBPARTITIONNUM
SMALLINT

element
For a partitioned database environment, this will be the
same value as for the MEMBER column. For DB2
Enterprise Server Edition and in a DB2 pureScale
environment, this value will be 0.
Note: DBPARTITIONNUM is different to
data_partition_id, which is used to identify a data
partition that was created by subdividing data in a
table based on a value.
DB_STORAGE_PATH_ID
BIGINT
db_storage_path_id - Storage path identifier monitor

element
MON_GET_DATABASE table function - Get database level information:

The MON_GET_DATABASE table function returns database level information
within the monitor infrastructure.
Authorization
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_DATABASE (
member

Routine parameters
member
from which the records should be fetched. Specify -1 or null for the current
applications.
Table 144. Information returned by the MON_GET_DATABASE routine
Column name
Data type
Description
MEMBER
SMALLINT
570
Table 144. Information returned by the MON_GET_DATABASE routine (continued)

Column name
Data type
Description
DB_STATUS
VARCHAR(16)
db_status - Status of database monitor element
DB_ACTIVATION_STATE
VARCHAR(10)
db_activation_state - Database activation state
DB_CONN_TIME
TIMESTAMP
db_conn_time - Database activation timestamp

monitor element
CATALOG_PARTITION
SMALLINT
catalog_node - Catalog Node Number
LAST_BACKUP
TIMESTAMP
last_backup - Last Backup Timestamp monitor

element
CONNECTIONS_TOP
BIGINT
connections_top - Maximum Number of Concurrent

Connections monitor element
TOTAL_CONS
BIGINT
total_cons - Connects Since Database Activation

monitor element
TOTAL_SEC_CONS
BIGINT
total_sec_cons - Secondary Connections monitor

element
APPLS_CUR_CONS
BIGINT
appls_cur_cons - Applications Connected Currently

monitor element
APPLS_IN_DB2
BIGINT
appls_in_db2 - Applications Executing in the

Database Currently monitor element
NUM_ASSOC_AGENTS
BIGINT

monitor element
AGENTS_TOP
BIGINT
agents_top - Number of Agents Created monitor

element
NUM_COORD_AGENTS
BIGINT
num_coord_agents - Number of coordinator agents
COORD_AGENTS_TOP
BIGINT
coord_agents_top - Maximum Number of

Coordinating Agents monitor element
NUM_LOCKS_HELD
BIGINT
locks_held - Locks held monitor element
NUM_LOCKS_WAITING
BIGINT

monitor element
LOCK_LIST_IN_USE
BIGINT
lock_list_in_use - Total lock list memory in use

monitor element
ACTIVE_SORTS
BIGINT
active_sorts - Active Sorts monitor element
ACTIVE_HASH_JOINS
BIGINT
active_hash_joins - Active hash joins monitor element
ACTIVE_OLAP_FUNCS
BIGINT
active_olap_funcs - Active OLAP Functions monitor

element
DB_PATH
VARCHAR(1024)
db_path - Database Path monitor element
ACT_ABORTED_TOTAL
BIGINT
act_aborted_total - Total aborted activities monitor

element
ACT_COMPLETED_TOTAL
BIGINT

monitor element
ACT_REJECTED_TOTAL
BIGINT
act_rejected_total - Total rejected activities monitor

element
AGENT_WAIT_TIME
BIGINT
agent_wait_time - Agent wait time monitor element
AGENT_WAITS_TOTAL
BIGINT
agent_waits_total - Total agent waits monitor element
POOL_DATA_L_READS
BIGINT

monitor element
POOL_INDEX_L_READS
BIGINT

monitor element
BIGINT

BIGINT

BIGINT

POOL_XDA_L_READS
BIGINT

POOL_DATA_P_READS
BIGINT

monitor element
POOL_INDEX_P_READS
BIGINT

571

Column name
Data type
Description
BIGINT

BIGINT

BIGINT

POOL_XDA_P_READS
BIGINT

POOL_DATA_WRITES
BIGINT

element
POOL_INDEX_WRITES
BIGINT
pool_index_writes - Buffer pool index writes monitor

element
POOL_XDA_WRITES
BIGINT

monitor element
POOL_READ_TIME
BIGINT

monitor element
POOL_WRITE_TIME
BIGINT

BIGINT
client_idle_wait_time - Client idle wait time monitor

element
DEADLOCKS
BIGINT
DIRECT_READS
BIGINT
direct_reads - Direct reads from database monitor

element
DIRECT_READ_TIME
BIGINT
direct_read_time - Direct read time monitor element
DIRECT_WRITES
BIGINT
direct_writes - Direct writes to database monitor

element
DIRECT_WRITE_TIME
BIGINT
direct_write_time - Direct write time monitor element
DIRECT_READ_REQS
BIGINT

element
DIRECT_WRITE_REQS
BIGINT

element
FCM_RECV_VOLUME
BIGINT

element
FCM_RECVS_TOTAL
BIGINT
fcm_recvs_total - FCM receives total monitor element
FCM_SEND_VOLUME
BIGINT

element
FCM_SENDS_TOTAL
BIGINT
fcm_sends_total - FCM sends total monitor element
FCM_RECV_WAIT_TIME
BIGINT

monitor element
FCM_SEND_WAIT_TIME
BIGINT
fcm_send_wait_time - FCM send wait time monitor

element
IPC_RECV_VOLUME
BIGINT
ipc_recv_volume - Interprocess communication

IPC_RECV_WAIT_TIME
BIGINT

IPC_RECVS_TOTAL
BIGINT
ipc_recvs_total - Interprocess communication receives

IPC_SEND_VOLUME
BIGINT

IPC_SEND_WAIT_TIME
BIGINT

IPC_SENDS_TOTAL
BIGINT

LOCK_ESCALS
BIGINT

element
LOCK_TIMEOUTS
BIGINT

element
LOCK_WAIT_TIME
BIGINT

element
572

Column name
Data type
Description
LOCK_WAITS
BIGINT
BIGINT
log_buffer_wait_time - Log buffer wait time monitor

element
NUM_LOG_BUFFER_FULL
BIGINT

LOG_DISK_WAIT_TIME
BIGINT

element
BIGINT

element
BIGINT

monitor element
ROWS_MODIFIED
BIGINT
ROWS_READ
BIGINT
rows_read - Rows read monitor element
ROWS_RETURNED
BIGINT
rows_returned - Rows returned monitor element
TCPIP_RECV_VOLUME
BIGINT

monitor element
TCPIP_SEND_VOLUME
BIGINT
tcpip_send_volume - TCP/IP send volume monitor

element
BIGINT

monitor element
TCPIP_RECVS_TOTAL
BIGINT
tcpip_recvs_total - TCP/IP receives total monitor

element
BIGINT

monitor element
TCPIP_SENDS_TOTAL
BIGINT
tcpip_sends_total - TCP/IP sends total monitor

element
TOTAL_APP_RQST_TIME
BIGINT

monitor element
TOTAL_RQST_TIME
BIGINT
total_rqst_time - Total request time monitor element
BIGINT

BIGINT

total queue assignments monitor element
TOTAL_RQST_MAPPED_IN
BIGINT
total_rqst_mapped_in - Total request mapped-in

monitor element
TOTAL_RQST_MAPPED_OUT
BIGINT
total_rqst_mapped_out - Total request mapped-out

monitor element
TOTAL_CPU_TIME
BIGINT
total_cpu_time - Total CPU time monitor element
TOTAL_WAIT_TIME
BIGINT
total_wait_time - Total wait time monitor element
BIGINT

requests completed monitor element
BIGINT

monitor element
BIGINT

TOTAL_SECTION_SORTS
BIGINT

element
TOTAL_SORTS
BIGINT
BIGINT
post_threshold_sorts - Post threshold sorts monitor

element
BIGINT

monitor element
SORT_OVERFLOWS
BIGINT
TOTAL_COMPILE_TIME
BIGINT
total_compile_time - Total compile time monitor

element
BIGINT

573

Column name
Data type
Description
TOTAL_COMPILATIONS
BIGINT
total_compilations - Total compilations monitor

element
BIGINT

TOTAL_IMPLICIT_COMPILE_PROC_TIME
BIGINT

compile processing time monitor element
BIGINT

complications monitor element
TOTAL_SECTION_TIME
BIGINT

element
BIGINT

BIGINT

TOTAL_ACT_TIME
BIGINT
total_act_time - Total activity time monitor element
TOTAL_ACT_WAIT_TIME
BIGINT
total_act_wait_time - Total activity wait time monitor

element
ACT_RQSTS_TOTAL
BIGINT
act_rqsts_total - Total activity requests monitor

elements
TOTAL_ROUTINE_TIME
BIGINT

element
BIGINT

monitor elements
TOTAL_COMMIT_TIME
BIGINT
total_commit_time - Total commit time monitor

element
BIGINT

TOTAL_APP_COMMITS
BIGINT

monitor elements
INT_COMMITS
BIGINT
int_commits - Internal commits monitor element
TOTAL_ROLLBACK_TIME
BIGINT
total_rollback_time - Total rollback time monitor

element
BIGINT

TOTAL_APP_ROLLBACKS
BIGINT

monitor element
INT_ROLLBACKS
BIGINT
int_rollbacks - Internal rollbacks monitor element
TOTAL_RUNSTATS_TIME
BIGINT

monitor element
BIGINT

TOTAL_RUNSTATS
BIGINT
total_runstats - Total runtime statistics monitor

element
TOTAL_REORG_TIME
BIGINT
total_reorg_time - Total reorganization time monitor

element
BIGINT

TOTAL_REORGS
BIGINT
total_reorgs - Total reorganizations monitor element
TOTAL_LOAD_TIME
BIGINT
total_load_time - Total load time monitor element
BIGINT

monitor element
TOTAL_LOADS
BIGINT
total_loads - Total loads monitor element
CAT_CACHE_INSERTS
BIGINT
cat_cache_inserts - Catalog cache inserts monitor

element
CAT_CACHE_LOOKUPS
BIGINT
cat_cache_lookups - Catalog cache lookups monitor

element
PKG_CACHE_INSERTS
BIGINT
pkg_cache_inserts - Package cache inserts monitor

element
574

Column name
Data type
Description
PKG_CACHE_LOOKUPS
BIGINT
pkg_cache_lookups - Package cache lookups monitor

element
THRESH_VIOLATIONS
BIGINT

monitor element
BIGINT

LOCK_WAITS_GLOBAL
BIGINT

element
BIGINT

monitor element
BIGINT
lock_timeouts_global - Lock timeouts global monitor

element
BIGINT

BIGINT

LOCK_ESCALS_GLOBAL
BIGINT

DATA_SHARING_REMOTE_LOCKWAIT_COUNT
BIGINT
data_sharing_remote_lockwait_count - Data sharing

remote lock wait count monitor element
DATA_SHARING_REMOTE_LOCKWAIT_TIME
BIGINT
data_sharing_remote_lockwait_time - Data sharing

remote lock wait time monitor element
RECLAIM_WAIT_TIME
BIGINT

element
BIGINT

reclaim wait time monitor element
CF_WAITS
BIGINT

monitor element
CF_WAIT_TIME
BIGINT

monitor element
BIGINT

BIGINT

BIGINT
pool_data_lbp_pages_found - Local buffer pool found

data pages monitor element
BIGINT

BIGINT

BIGINT

physical reads monitor elements
BIGINT

BIGINT

invalid index pages monitor element
BIGINT

logical read requests monitor element
BIGINT

physical read requests monitor element
BIGINT

data pages found monitor element
BIGINT

AUDIT_EVENTS_TOTAL
BIGINT

element
BIGINT

monitor element
BIGINT

575

Column name
Data type
Description
BIGINT

BIGINT

BIGINT

monitor element
BIGINT

BIGINT

BIGINT
fcm_message_recv_volume - FCM message received

BIGINT

BIGINT

monitor element
BIGINT

BIGINT

FCM_TQ_RECVS_TOTAL
BIGINT

monitor element
FCM_TQ_RECV_VOLUME
BIGINT

BIGINT

FCM_TQ_SENDS_TOTAL
BIGINT

monitor element
FCM_TQ_SEND_VOLUME
BIGINT

BIGINT

TOTAL_ROUTINE_USER_CODE_PROC_TIME
BIGINT

BIGINT

TQ_TOT_SEND_SPILLS
BIGINT

EVMON_WAIT_TIME
BIGINT
evmon_wait_time - Event monitor wait time monitor

element
EVMON_WAITS_TOTAL
BIGINT

monitor element
BIGINT

BIGINT

BIGINT

fabrication time monitor element
TOTAL_STATS_FABRICATION_PROC_TIME
BIGINT

fabrication processing time monitor element
BIGINT

monitor elements
BIGINT

RUNSTATS time monitor elements
BIGINT

RUNSTATS processing time monitor element
TOTAL_SYNC_RUNSTATS
BIGINT

activities monitor element
BIGINT

576

Column name
Data type
Description
TOTAL_PEDS
BIGINT

element
DISABLED_PEDS
BIGINT

monitor element
POST_THRESHOLD_PEDS
BIGINT

monitor element
TOTAL_PEAS
BIGINT

element
POST_THRESHOLD_PEAS
BIGINT

BIGINT

BIGINT

BIGINT

BIGINT

BIGINT

POOL_QUEUED_ASYNC_TEMP_DATA_REQS
BIGINT

POOL_QUEUED_ASYNC_TEMP_INDEX_REQS
BIGINT
element
POOL_QUEUED_ASYNC_TEMP_XDA_REQS
BIGINT

element
BIGINT
pool_queued_async_other_reqs - Other requests

handled by prefetchers monitor element
BIGINT

BIGINT

BIGINT
pool_queued_async_xda_pages - XDA pages prefetch

POOL_QUEUED_ASYNC_TEMP_DATA_PAGES
BIGINT

element
POOL_QUEUED_ASYNC_TEMP_INDEX_PAGES
BIGINT

element
POOL_QUEUED_ASYNC_TEMP_XDA_PAGES
BIGINT

monitor element
BIGINT

BIGINT

BIGINT

POOL_FAILED_ASYNC_TEMP_DATA_REQS
BIGINT

element
POOL_FAILED_ASYNC_TEMP_INDEX_REQS
BIGINT

element
BIGINT

element
BIGINT

577

Column name
Data type
Description
PREFETCH_WAIT_TIME
BIGINT

monitor element
PREFETCH_WAITS
BIGINT

element
BIGINT

coordinator activities monitor element
BIGINT

BIGINT

BIGINT

switch user request time monitor element
TOTAL_CONNECT_REQUEST_PROC_TIME
BIGINT

BIGINT

TOTAL_CONNECT_AUTHENTICATION_TIME
BIGINT
total_connect_authentication_time - Total connection

or switch user authentication request time monitor
element
TOTAL_CONNECT_AUTHENTICATION_PROC_TIME
BIGINT
element
BIGINT

user authentications performed monitor element
POOL_DATA_GBP_INDEP_PAGES_FOUND_IN_LBP
BIGINT
POOL_INDEX_GBP_INDEP_PAGES_FOUND_IN_LBP
BIGINT
POOL_XDA_GBP_INDEP_PAGES_FOUND_IN_LBP
BIGINT
COMM_EXIT_WAIT_TIME
BIGINT

COMM_EXIT_WAITS
BIGINT

BIGINT
pool_async_data_reads - Buffer pool asynchronous

data reads monitor element
BIGINT

asynchronous read requests monitor element
BIGINT
pool_async_data_writes - Buffer pool asynchronous

data writes monitor element
BIGINT
pool_async_index_reads - Buffer pool asynchronous

index reads monitor element
BIGINT

asynchronous index read requests monitor element
BIGINT
pool_async_index_writes - Buffer pool asynchronous

index writes monitor element
BIGINT
pool_async_xda_reads - Buffer pool asynchronous

XDA data reads monitor element
BIGINT

asynchronous XDA read requests monitor element
BIGINT
pool_async_xda_writes - Buffer pool asynchronous

XDA data writes monitor element
BIGINT
pool_no_victim_buffer - Buffer pool no victim buffers

monitor element
POOL_LSN_GAP_CLNS
BIGINT
pool_lsn_gap_clns - Buffer pool log space cleaners

triggered monitor element
BIGINT
pool_drty_pg_steal_clns - Buffer pool victim page

cleaners triggered monitor element
578

Column name
Data type
Description
BIGINT
pool_drty_pg_thrsh_clns - Buffer pool threshold

cleaners triggered monitor element
VECTORED_IOS
BIGINT
vectored_ios - Number of vectored I/O requests

monitor element
BIGINT

read by vectored I/O monitor element
BLOCK_IOS
BIGINT
block_ios - Number of block I/O requests monitor

element
BIGINT
pages_from_block_ios - Total number of pages read

by block I/O monitor element
BIGINT

monitor element
FILES_CLOSED
BIGINT
files_closed - Database files closed monitor element
BIGINT
pool_async_data_gbp_l_reads - Asynchronous group

buffer pool data logical reads monitor element
BIGINT
pool_async_data_gbp_p_reads - Asynchronous group

buffer pool data physical reads monitor element
POOL_ASYNC_DATA_LBP_PAGES_FOUND
BIGINT
pool_async_data_lbp_pages_found - Asynchronous
local buffer pool data pages found monitor element
POOL_ASYNC_DATA_GBP_INVALID_PAGES
BIGINT
pool_async_data_gbp_invalid_pages - Asynchronous
group buffer pool invalid data pages monitor
element
POOL_ASYNC_INDEX_GBP_L_READS
BIGINT
pool_async_index_gbp_l_reads - Asynchronous group

buffer pool index logical reads monitor element
POOL_ASYNC_INDEX_GBP_P_READS
BIGINT
pool_async_index_gbp_p_reads - Asynchronous
group buffer pool index physical reads monitor
element
POOL_ASYNC_INDEX_LBP_PAGES_FOUND
BIGINT
pool_async_index_lbp_pages_found - Asynchronous
local buffer pool index pages found monitor element
POOL_ASYNC_INDEX_GBP_INVALID_PAGES
BIGINT
pool_async_index_gbp_invalid_pages - Asynchronous
group buffer pool invalid index pages monitor
element
BIGINT

monitor element
BIGINT
pool_async_xda_gbp_p_reads - Group buffer pool

XDA data asynchronous physical read requests
monitor element
POOL_ASYNC_XDA_LBP_PAGES_FOUND
BIGINT
pool_async_xda_lbp_pages_found - Asynchronous
local buffer pool XDA data pages found monitor
element
POOL_ASYNC_XDA_GBP_INVALID_PAGES
BIGINT
pool_async_xda_gbp_invalid_pages - Asynchronous
group buffer pool invalid XDA data pages monitor
element
BIGINT
pool_async_read_time - Buffer pool asynchronous

read time
BIGINT
pool_async_write_time - Buffer pool asynchronous

write time
SKIPPED_PREFETCH_DATA_P_READS
BIGINT
skipped_prefetch_data_p_reads - Skipped prefetch

SKIPPED_PREFETCH_INDEX_P_READS
BIGINT
skipped_prefetch_index_p_reads - Skipped prefetch

BIGINT

XDA physical reads monitor element
SKIPPED_PREFETCH_TEMP_DATA_P_READS
BIGINT
prefetch temporary data physical reads monitor
element
SKIPPED_PREFETCH_TEMP_INDEX_P_READS
BIGINT
prefetch temporary index physical reads monitor
element
579

Column name
Data type
Description
SKIPPED_PREFETCH_TEMP_XDA_P_READS
BIGINT
prefetch temporary XDA data physical reads monitor
element
SKIPPED_PREFETCH_UOW_DATA_P_READS
BIGINT
prefetch unit of work data physical reads monitor
element
SKIPPED_PREFETCH_UOW_INDEX_P_READS
BIGINT
prefetch unit of work index physical reads monitor
element
SKIPPED_PREFETCH_UOW_XDA_P_READS
BIGINT
monitor element
SKIPPED_PREFETCH_UOW_TEMP_DATA_P_READS
BIGINT
skipped_prefetch_uow_temp_data_p_reads - Skipped
prefetch unit of work temporary data physical reads
monitor element
SKIPPED_PREFETCH_UOW_TEMP_INDEX_P_READS
BIGINT

SKIPPED_PREFETCH_UOW_TEMP_XDA_P_READS
BIGINT
skipped_prefetch_uow_temp_xda_p_reads - Skipped
prefetch unit of work temporary XDA data physical
POOL_ASYNC_DATA_GBP_INDEP_PAGES_FOUND_IN_LBP
BIGINT
pool_async_data_gbp_indep_pages_found_in_lbp Group buffer pool independent data pages found by

asynchronous EDUs in a local buffer pool monitor
element monitor element
POOL_ASYNC_INDEX_GBP_INDEP_PAGES_FOUND_IN_LBP
BIGINT
pool_async_index_gbp_indep_pages_found_in_lbp Group buffer pool independent index pages found by

POOL_ASYNC_XDA_GBP_INDEP_PAGES_FOUND_IN_LBP
BIGINT
pool_async_xda_gbp_indep_pages_found_in_lbp Group buffer pool independent XML storage

object(XDA) pages found by asynchronous EDUs in a
local buffer pool monitor element monitor element
CACHING_TIER
VARCHAR(8)
CACHING_TIER_IO_ERRORS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
READ_TIME
BIGINT
580

Column name
Data type
Description
WRITE_TIME
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
TIER_READS
BIGINT
TIER_READS
BIGINT
TIER_READS
BIGINT
TIER_READS
BIGINT
TIER_PAGE_WRITES
BIGINT
TIER_PAGE_WRITES
BIGINT
TIER_PAGE_WRITES
BIGINT
TIER_PAGE_WRITES
BIGINT
TIER_PAGE_UPDATES
BIGINT
TIER_PAGE_UPDATES
BIGINT
TIER_PAGE_UPDATES
BIGINT
TIER_PAGE_UPDATES
BIGINT
TIER_PAGES_FOUND
BIGINT
TIER_PAGES_FOUND
BIGINT
TIER_PAGES_FOUND
BIGINT
TIER_PAGES_FOUND
BIGINT
BIGINT
581

Column name
Data type
Description
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
ROWS_DELETED
BIGINT
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
TOTAL_HASH_JOINS
BIGINT
TOTAL_HASH_LOOPS
BIGINT
HASH_JOIN_OVERFLOWS
BIGINT

element
BIGINT

BIGINT

TOTAL_OLAP_FUNCS
BIGINT

element
OLAP_FUNC_OVERFLOWS
BIGINT

monitor element
DYNAMIC_SQL_STMTS
BIGINT

STATIC_SQL_STMTS
BIGINT

monitor element
FAILED_SQL_STMTS
BIGINT

monitor element
SELECT_SQL_STMTS
BIGINT

monitor element
UID_SQL_STMTS
BIGINT

DDL_SQL_STMTS
BIGINT

MERGE_SQL_STMTS
BIGINT
XQUERY_STMTS
BIGINT

monitor element
IMPLICIT_REBINDS
BIGINT
implicit_rebinds - Number of implicit rebinds
BINDS_PRECOMPILES
BIGINT

monitor element
INT_ROWS_DELETED
BIGINT

element
INT_ROWS_INSERTED
BIGINT

element
INT_ROWS_UPDATED
BIGINT

element
CALL_SQL_STMTS
BIGINT
POOL_COL_L_READS
BIGINT

logical reads
BIGINT

582

Column name
Data type
Description
POOL_COL_P_READS
BIGINT

physical reads
BIGINT

BIGINT

POOL_COL_WRITES
BIGINT

writes
BIGINT

column-organized reads monitor element
BIGINT
pool_async_col_read_reqs - Buffer pool asynchronous

column-organized read requests monitor element
BIGINT
pool_async_col_writes - Buffer pool asynchronous

column-organized writes monitor element
POOL_ASYNC_COL_
LBP_PAGES_FOUND
BIGINT
monitor element
BIGINT

GBP logical reads
BIGINT

BIGINT

POOL_COL_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
POOL_ASYNC_COL_GBP_
L_READS
BIGINT
pool_async_col_gbp_l_reads - Asynchronous group

buffer pool column-organized logical reads monitor
element
POOL_ASYNC_COL_GBP_
P_READS
BIGINT
pool_async_col_gbp_p_reads - Asynchronous group

buffer pool column-organized physical reads monitor
element
POOL_ASYNC_COL_GBP_
INVALID_PAGES
BIGINT
pool_async_col_gbp_invalid_pages - Asynchronous
group buffer pool column-organized invalid data
POOL_ASYNC_COL_GBP_
BIGINT
pool_async_col_gbp_indep_pages_found_in_lbp Asynchronous group buffer pool column-organized

monitor element
BIGINT
prefetch requests
POOL_QUEUED_ASYNC_
TEMP_COL_REQS
BIGINT
POOL_QUEUED_ASYNC_
COL_PAGES
BIGINT
POOL_QUEUED_ASYNC_
TEMP_COL_PAGES
BIGINT
BIGINT

prefetch requests
COL_REQS
BIGINT
SKIPPED_PREFETCH_
COL_P_READS
BIGINT

column-organized physical reads monitor element
SKIPPED_PREFETCH_
TEMP_COL_P_READS
BIGINT
prefetch column-organized temporary physical reads
monitor element
SKIPPED_PREFETCH_
UOW_COL_P_READS
BIGINT
SKIPPED_PREFETCH_
UOW_TEMP_COL_P_READS
BIGINT
skipped_prefetch_uow_temp_col_p_reads - Skipped
prefetch unit of work column-organized temporary
583

Column name
Data type
Description
TOTAL_COL_TIME
BIGINT
TOTAL_COL_PROC_TIME
BIGINT

processing time
BIGINT

executions
NUM_POOLED_AGENTS
BIGINT
num_pooled_agents - Number of pooled agents

monitor element
BIGINT

monitor element
PKG_CACHE_NUM_OVERFLOWS
BIGINT
pkg_cache_num_overflows - Package Cache

Overflows
CAT_CACHE_OVERFLOWS
BIGINT
cat_cache_overflows - Catalog Cache Overflows
TOTAL_ASYNC_RUNSTATS
BIGINT
total_async_runstats - Total number of asynchronous

RUNSTATS requests
STATS_CACHE_SIZE
BIGINT
stats_cache_size - Size of statistics cache
TOTAL_HASH_GRPBYS
BIGINT
BIGINT
BIGINT

threshold
ACTIVE_HASH_GRPBYS
BIGINT
active_hash_grpbys - Active hash group by

operations
SORT_HEAP_ALLOCATED
BIGINT
sort_heap_allocated - Total Sort Heap Allocated
SORT_SHRHEAP_ALLOCATED
BIGINT
sort_shrheap_allocated - Sort Share Heap Currently

Allocated
SORT_SHRHEAP_TOP
BIGINT
sort_shrheap_top - Sort share heap high watermark
BIGINT

monitor element
Examples
1. Determine the activation time, activation state, total connections, and
connection high water mark for the current database on all members:
SELECT DB_CONN_TIME, DB_ACTIVATION_STATE, TOTAL_CONS, CONNECTIONS_TOP
FROM TABLE (MON_GET_DATABASE(-2));

DB_CONN_TIME
-------------------------2012-09-11-16.31.42.000000
DB_ACTIVATION_STATE TOTAL_CONS CONNECTIONS_TOP

------------------- ---------- --------------NONE
23
13
2. Get the explicit hierarchical locking state for the database from all database
members.
SELECT MEMBER,
DATA_SHARING_REMOTE_LOCKWAIT_COUNT AS DSRL_COUNT,
DATA_SHARING_REMOTE_LOCKWAIT_TIME AS DSRL_TIME
FROM TABLE(MON_GET_DATABASE(-2))
The query returns the following output, indicating that one table exited from a
"NOT_SHARED" state, taking approximately 10 seconds to do so.
MEMBER DSRL_COUNT
DSRL_TIME
------ -------------------- -------------------0
0
0
1
1
10042
2
0
0
584
MON_GET_DATABASE_DETAILS table function - Get database information

metrics:
The MON_GET_DATABASE_DETAILS table function retrieves database
information metrics in an XML document.
Authorization
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_DATABASE_DETAILS (
member

Routine parameters
member
database member a database that is available for connection and use by
applications.
Table 145. Information returned by the MON_GET_DATABASE_DETAILS routine
Column name
Data type
Description
MEMBER
SMALLINT
DETAILS
BLOB(1M)
XML document that contains

activity details. See Table 146
for a description of the
Detailed metrics returned

Table 146. Detailed metrics returned for MON_GET_DATABASE_DETAILS
Element name
Data type
act_aborted_total
xs:long

act_aborted_total - Total aborted activities monitor element
act_completed_total
xs:long
act_completed_total - Total completed activities monitor

element
act_rejected_total
xs:long
act_rejected_total - Total rejected activities monitor element
act_rqsts_total
xs:long
act_rqsts_total - Total activity requests monitor elements
active_hash_grpbys
xs:long
active_hash_grpbys - Active hash group by operations
585
Table 146. Detailed metrics returned for MON_GET_DATABASE_DETAILS (continued)

Element name
Data type
active_hash_joins
xs:long
active_hash_joins - Active hash joins monitor element
active_olap_funcs
xs:long
active_olap_funcs - Active OLAP Functions monitor

element
active_sorts
xs:long
active_sorts - Active Sorts monitor element
agent_wait_time
xs:long
agent_waits_total
xs:long
agent_waits_total - Total agent waits monitor element
agents_top
xs:long
agents_top - Number of Agents Created monitor element
xs:long
app_act_aborted_total - Total failed external coordinator

xs:long

xs:long
app_act_rejected_total - Total rejected external coordinator

xs:long

completed monitor element
appls_cur_cons
xs:long
appls_cur_cons - Applications Connected Currently

monitor element
appls_in_db2
xs:long
appls_in_db2 - Applications Executing in the Database

Currently monitor element
audit_events_total
xs:long
audit_events_total - Total audit events monitor element
xs:long

monitor element
xs:long
audit_file_writes_total - Total audit files written monitor

element
xs:long

monitor element
xs:long

monitor element
binds_precompiles
xs:long
binds_precompiles - Binds/Precompiles Attempted monitor

element
block_ios
xs:long
block_ios - Number of block I/O requests monitor element
call_sql_stmts
xs:long
cat_cache_inserts
xs:long
cat_cache_inserts - Catalog cache inserts monitor element
cat_cache_lookups
xs:long

element
cat_cache_overflows
xs:long
cat_cache_overflows - Catalog Cache Overflows
catalog_partition
xs:short
catalog_node - Catalog Node Number
cf_wait_time
xs:long
cf_wait_time - cluster caching facility wait time monitor

element
cf_waits
xs:long
cf_waits - Number of cluster caching facility waits monitor

element
xs:long
client_idle_wait_time - Client idle wait time monitor

element
comm_exit_wait_time
xs:long
comm_exit_wait_time - Communication buffer exit wait

comm_exit_waits
xs:long
comm_exit_waits - Communication buffer exit number of

connections_top
xs:long
connections_top - Maximum Number of Concurrent

Connections monitor element
coord_agents_top
xs:long
coord_agents_top - Maximum Number of Coordinating

Agents monitor element
db_activation_state
xs:db2_string_type_10
db_activation_state - Database activation state
db_conn_time
xs:dateTime
db_conn_time - Database activation timestamp monitor

element
db_path
xs:long
db_path - Database Path monitor element
db_status
xs:db2_string_type_16
db_status - Status of database monitor element
586

Element name
Data type
ddl_sql_stmts
xs:long

deadlocks
xs:long
xs:long
diaglog_write_wait_time - Diagnostic log file write wait

xs:long

monitor element
direct_read_reqs
xs:long
direct_read_reqs - Direct read requests monitor element
direct_read_time
xs:long
direct_reads
xs:long
direct_reads - Direct reads from database monitor element
direct_write_reqs
xs:long
direct_write_reqs - Direct write requests monitor element
direct_write_time
xs:long
direct_write_time - Direct write time monitor element
direct_writes
xs:long
direct_writes - Direct writes to database monitor element
disabled_peds
xs:long
disabled_peds - Disabled partial early distincts monitor

element
dynamic_sql_stmts
xs:long
dynamic_sql_stmts - Dynamic SQL Statements Attempted

monitor element
evmon_wait_time
xs:long
evmon_wait_time - Event monitor wait time monitor

element
evmon_waits_total
xs:long
evmon_waits_total - Event monitor total waits monitor

element
failed_sql_stmts
xs:long

element
xs:long

xs:long
fcm_message_recv_wait_time - FCM message received wait

xs:long

monitor element
xs:long

monitor element
xs:long
fcm_message_send_wait_time - FCM message send wait

xs:long

monitor element
fcm_recv_volume
xs:long
fcm_recv_volume - FCM received volume monitor element
fcm_recv_wait_time
xs:long
fcm_recv_wait_time - FCM received wait time monitor

element
fcm_recvs_total
xs:long
fcm_recvs_total - FCM receives total monitor element
fcm_send_volume
xs:long
fcm_send_volume - FCM send volume monitor element
fcm_send_wait_time
xs:long

element
fcm_sends_total
xs:long
fcm_tq_recv_volume
xs:long

monitor element
xs:long
fcm_tq_recv_wait_time - FCM table queue received wait

fcm_tq_recvs_total
xs:long

monitor element
fcm_tq_send_volume
xs:long

monitor element
xs:long

monitor element
fcm_tq_sends_total
xs:long
fcm_tq_sends_total - FCM table queue send total monitor

element
files_closed
xs:long
files_closed - Database files closed monitor element
xs:long
587

Element name
Data type
hash_join_overflows
xs:long

element
xs:long

monitor element
implicit_rebinds
xs:long
implicit_rebinds - Number of implicit rebinds
int_commits
xs:long
int_rollbacks
xs:long
int_rows_deleted
xs:long
int_rows_deleted - Internal Rows Deleted monitor element
int_rows_inserted
xs:long
int_rows_inserted - Internal Rows Inserted monitor element
int_rows_updated
xs:long

element
ipc_recv_volume
xs:long
ipc_recv_volume - Interprocess communication received

ipc_recv_wait_time
xs:long
ipc_recv_wait_time - Interprocess communication received

ipc_recvs_total
xs:long
ipc_recvs_total - Interprocess communication receives total

monitor element
ipc_send_volume
xs:long

ipc_send_wait_time
xs:long

ipc_sends_total
xs:long

monitor element
last_backup
xs:dateTime
last_backup - Last Backup Timestamp monitor element
lock_escals
xs:long
lock_escals - Number of lock escalations monitor element
lock_escals_global
xs:long

monitor element
lock_escals_locklist
xs:long

monitor element
lock_escals_maxlocks
xs:long

lock_list_in_use
xs:long
lock_list_in_use - Total lock list memory in use monitor

element
lock_timeouts
xs:long
lock_timeouts - Number of lock timeouts monitor element
lock_timeouts_global
xs:long
lock_timeouts_global - Lock timeouts global monitor

element
lock_wait_time
xs:long
lock_wait_time - Time waited on locks monitor element
lock_wait_time_global
xs:long
lock_wait_time_global - Lock wait time global monitor

element
lock_waits
xs:long
lock_waits_global
xs:long
lock_waits_global - Lock waits global monitor element
xs:long
log_buffer_wait_time - Log buffer wait time monitor

element
log_disk_wait_time
xs:long
log_disk_wait_time - Log disk wait time monitor element
xs:long
log_disk_waits_total - Total log disk waits monitor element
member
xs:short
merge_sql_stmts
xs:long
num_assoc_agents
xs:long
num_assoc_agents - Number of Associated Agents monitor

element
num_coord_agents
xs:long
num_coord_agents - Number of coordinator agents
num_locks_held
xs:long
locks_held - Locks held monitor
num_locks_waiting
xs:long
num_log_buffer_full
xs:long
num_log_buffer_full - Number of times full log buffer

caused agents to wait monitor element
xs:long
num_lw_thresh_exceeded - Number of lock wait thresholds

exceeded monitor element
588

Element name
Data type
num_pooled_agents
xs:long
num_pooled_agents - Number of pooled agents monitor

element
olap_func_overflows
xs:long

element
pages_from_block_ios
xs:long
pages_from_block_ios - Total number of pages read by

block I/O monitor element
pages_from_vectored_ios
xs:long
pages_from_vectored_ios - Total number of pages read by

vectored I/O monitor element
pkg_cache_inserts
xs:long
pkg_cache_inserts - Package cache inserts monitor element
pkg_cache_lookups
xs:long
pkg_cache_lookups - Package cache lookups monitor

element
pkg_cache_num_overflows
xs:long
pkg_cache_num_overflows - Package Cache Overflows
pool_async_col_gbp_indep_pages_found_in_lbp
pool_async_col_gbp_indep_pages_found_in_lbp Asynchronous group buffer pool column-organized

independent data pages found in local buffer pool monitor
element
pool_async_col_gbp_invalid_pages
pool_async_col_gbp_invalid_pages - Asynchronous group

buffer pool column-organized invalid data pages monitor
element
pool_async_col_gbp_l_reads
pool_async_col_gbp_l_reads - Asynchronous group buffer

pool column-organized logical reads monitor element
pool_async_col_gbp_p_reads
pool_async_col_gbp_p_reads - Asynchronous group buffer

pool column-organized physical reads monitor element
pool_async_col_lbp_pages_found
pool_async_col_lbp_pages_found - Asynchronous local

buffer pool column-organized pages found monitor
element
pool_async_col_read_reqs
pool_async_col_read_reqs - Buffer pool asynchronous

column-organized read requests monitor element
pool_async_col_reads

column-organized reads monitor element
pool_async_col_writes

pool_async_data_gbp_indep_pages_found_in_lbp
xs:long
pool_async_data_gbp_indep_pages_found_in_lbp - Group
buffer pool independent data pages found by asynchronous
EDUs in a local buffer pool monitor element monitor
element
pool_async_data_gbp_invalid_pages
xs:long
pool_async_data_gbp_invalid_pages - Asynchronous group

buffer pool invalid data pages monitor element
pool_async_data_gbp_l_reads
xs:long
pool_async_data_gbp_l_reads - Asynchronous group buffer

pool data logical reads monitor element
pool_async_data_gbp_p_reads
xs:long
pool_async_data_gbp_p_reads - Asynchronous group buffer

pool data physical reads monitor element
pool_async_data_lbp_pages_found
xs:long
pool_async_data_lbp_pages_found - Asynchronous local

buffer pool data pages found monitor element
pool_async_data_read_reqs
xs:long
pool_async_data_read_reqs - Buffer pool asynchronous read

pool_async_data_reads
xs:long
pool_async_data_reads - Buffer pool asynchronous data

pool_async_data_writes
xs:long
pool_async_data_writes - Buffer pool asynchronous data

pool_async_index_gbp_indep_pages_found_in_lbp
xs:long
pool_async_index_gbp_indep_pages_found_in_lbp - Group
buffer pool independent index pages found by
asynchronous EDUs in a local buffer pool monitor element
monitor element
pool_async_index_gbp_invalid_pages
xs:long
pool_async_index_gbp_invalid_pages - Asynchronous
group buffer pool invalid index pages monitor element
pool_async_index_gbp_l_reads
xs:long
pool_async_index_gbp_l_reads - Asynchronous group

buffer pool index logical reads monitor element
pool_async_index_gbp_p_reads
xs:long
pool_async_index_gbp_p_reads - Asynchronous group

buffer pool index physical reads monitor element
589

Element name
Data type
pool_async_index_lbp_pages_found
xs:long
pool_async_index_lbp_pages_found - Asynchronous local

buffer pool index pages found monitor element
pool_async_index_read_reqs
xs:long
pool_async_index_read_reqs - Buffer pool asynchronous

index read requests monitor element
pool_async_index_reads
xs:long
pool_async_index_reads - Buffer pool asynchronous index

pool_async_index_writes
xs:long
pool_async_index_writes - Buffer pool asynchronous index

pool_async_read_time
xs:long
pool_async_read_time - Buffer Pool Asynchronous Read

Time monitor element
pool_async_write_time
xs:long
pool_async_write_time - Buffer pool asynchronous write

pool_async_xda_gbp_indep_pages_found_in_lbp
xs:long
pool_async_xda_gbp_indep_pages_found_in_lbp - Group
buffer pool independent XML storage object(XDA) pages
found by asynchronous EDUs in a local buffer pool
monitor element monitor element
pool_async_xda_gbp_invalid_pages
xs:long
pool_async_xda_gbp_invalid_pages - Asynchronous group

buffer pool invalid XDA data pages monitor element
pool_async_xda_gbp_l_reads
xs:long
pool_async_xda_gbp_l_reads - Group buffer pool XDA data

asynchronous logical read requests monitor element
pool_async_xda_gbp_p_reads
xs:long
pool_async_xda_gbp_p_reads - Group buffer pool XDA

data asynchronous physical read requests monitor element
pool_async_xda_lbp_pages_found
xs:long
pool_async_xda_lbp_pages_found - Asynchronous local

buffer pool XDA data pages found monitor element
pool_async_xda_read_reqs
xs:long
pool_async_xda_read_reqs - Buffer pool asynchronous XDA

read requests monitor element
pool_async_xda_reads
xs:long
pool_async_xda_reads - Buffer pool asynchronous XDA

data reads monitor element
pool_async_xda_writes
xs:long
pool_async_xda_writes - Buffer pool asynchronous XDA

data writes monitor element
pool_col_gbp_indep_pages_found_in_lbp

buffer pool

pool_col_gbp_l_reads - Buffer pool column-organized GBP

logical reads
pool_col_gbp_p_reads - Buffer pool column-organized GBP

physical reads
pool_col_l_reads
pool_col_l_reads - Buffer pool column-organized logical

reads
pool_col_lbp_pages_found - Buffer pool column-organized

LBP pages found
pool_col_p_reads
pool_col_p_reads - Buffer pool column-organized physical

reads
pool_col_writes
pool_data_gbp_indep_pages_found_in_lbp
xs:long
pool_data_gbp_indep_pages_found_in_lbp - Group buffer

monitor element
pool_data_gbp_invalid_pages
xs:long
pool_data_gbp_invalid_pages - Group buffer pool invalid

data pages monitor element
pool_data_gbp_l_reads
xs:long
pool_data_gbp_l_reads - Group buffer pool data logical

pool_data_gbp_p_reads
xs:long
pool_data_gbp_p_reads - Group buffer pool data physical

pool_data_l_reads
xs:long
pool_data_l_reads - Buffer pool data logical reads monitor

element
pool_data_lbp_pages_found
xs:long
pool_data_lbp_pages_found - Local buffer pool found data

pool_data_p_reads
xs:long

monitor element
590

Element name
Data type
pool_data_writes
xs:long
pool_data_writes - Buffer pool data writes monitor element
pool_drty_pg_steal_clns
xs:long
pool_drty_pg_steal_clns - Buffer pool victim page cleaners

pool_drty_pg_thrsh_clns
xs:long
pool_drty_pg_thrsh_clns - Buffer pool threshold cleaners


prefetch requests
xs:long

monitor element
xs:long

xs:long

monitor element
pool_failed_async_temp_col_reqs
pool_failed_async_temp_col_reqs - Failed column-organized

pool_failed_async_temp_data_reqs
xs:long
pool_failed_async_temp_data_reqs - Failed data prefetch

pool_failed_async_temp_index_reqs
xs:long
pool_failed_async_temp_index_reqs - Failed index prefetch

pool_failed_async_temp_xda_reqs
xs:long
pool_failed_async_temp_xda_reqs - Failed XDA prefetch

xs:long

monitor element
pool_index_gbp_indep_pages_found_in_lbp
xs:long
pool_index_gbp_indep_pages_found_in_lbp - Group buffer

pool independent index pages found in local buffer pool
monitor element
pool_index_gbp_invalid_pages
xs:long
pool_index_gbp_invalid_pages - Group buffer pool invalid

index pages monitor element
pool_index_gbp_l_reads
xs:long
pool_index_gbp_l_reads - Group buffer pool index logical

pool_index_gbp_p_reads
xs:long

pool_index_l_reads
xs:long

monitor element
pool_index_lbp_pages_found
xs:long
pool_index_lbp_pages_found - Local buffer pool index

pages found monitor element
pool_index_p_reads
xs:long

monitor element
pool_index_writes
xs:long
pool_index_writes - Buffer pool index writes monitor

element
pool_lsn_gap_clns
xs:long
pool_lsn_gap_clns - Buffer pool log space cleaners triggered

monitor element
pool_no_victim_buffer
xs:long
pool_no_victim_buffer - Buffer pool no victim buffers

monitor element
pool_queued_async_col_pages - Column-organized page

prefetch requests
pool_queued_async_col_reqs - Column-organized prefetch

requests
xs:long

xs:long

monitor element
pool_queued_async_index_pages
xs:long
pool_queued_async_index_pages - Index pages prefetch

xs:long

monitor element
xs:long
pool_queued_async_other_reqs - Other requests handled by

prefetchers monitor element
pool_queued_async_temp_col_pages
pool_queued_async_temp_col_pages - Column-organized
591

Element name
Data type
pool_queued_async_temp_col_reqs
pool_queued_async_temp_col_reqs - Column-organized
pool_queued_async_temp_data_pages
xs:long
pool_queued_async_temp_data_pages - Data pages prefetch

pool_queued_async_temp_data_reqs
xs:long

pool_queued_async_temp_index_pages
xs:long

element
pool_queued_async_temp_index_reqs
xs:long

pool_queued_async_temp_xda_pages
xs:long
pool_queued_async_temp_xda_pages - XDA data pages

element
pool_queued_async_temp_xda_reqs
xs:long
pool_queued_async_temp_xda_reqs - XDA data prefetch

xs:long

xs:long

monitor element
pool_read_time
xs:long

monitor element

pool_temp_col_p_reads - Buffer pool column-organized

xs:long

xs:long

xs:long
pool_temp_index_l_reads - Buffer pool temporary index

xs:long
pool_temp_index_p_reads - Buffer pool temporary index

xs:long
pool_temp_xda_l_reads - Buffer pool temporary XDA data

xs:long
pool_temp_xda_p_reads - Buffer pool temporary XDA data

pool_write_time
xs:long

monitor element
pool_xda_gbp_indep_pages_found_in_lbp
xs:long
pool_xda_gbp_indep_pages_found_in_lbp - Group buffer

monitor element
xs:long
pool_xda_gbp_invalid_pages - Group buffer pool invalid

XDA data pages monitor element
xs:long

logical read requests monitor element
xs:long

physical read requests monitor element
pool_xda_l_reads
xs:long

monitor element
xs:long
pool_xda_lbp_pages_found - Local buffer pool XDA data

pages found monitor element
pool_xda_p_reads
xs:long

monitor element
pool_xda_writes
xs:long
pool_xda_writes - Buffer pool XDA data writes monitor

element
xs:long

monitor element
xs:long

monitor element
592

Element name
Data type
xs:long

monitor element
xs:long

element
xs:long

monitor element
post_threshold_peas
xs:long

monitor element
post_threshold_peds
xs:long

monitor element
xs:long
post_threshold_sorts - Post threshold sorts monitor element
prefetch_wait_time
xs:long
prefetch_wait_time - Time waited for prefetch monitor

element
prefetch_waits
xs:long
prefetch_waits - Prefetcher wait count monitor element
reclaim_wait_time
xs:long
reclaim_wait_time - Reclaim wait time monitor element
rows_deleted
xs:long
rows_inserted
xs:long
rows_modified
xs:long
rows_read
xs:long
rows_returned
xs:long
rows_updated
xs:long
xs:long
rqsts_completed_total - Total requests completed monitor

element
select_sql_stmts
xs:long
select_sql_stmts - Select SQL Statements Executed monitor

element
skipped_prefetch_
col_p_reads

column-organized physical reads monitor element
skipped_prefetch_data_p_reads
xs:long
skipped_prefetch_data_p_reads - Skipped prefetch data

skipped_prefetch_index_p_reads
xs:long
skipped_prefetch_index_p_reads - Skipped prefetch index

skipped_prefetch_
temp_col_p_reads
skipped_prefetch_temp_col_p_reads - Skipped prefetch

column-organized temporary physical reads monitor
element
skipped_prefetch_temp_data_p_reads
xs:long
skipped_prefetch_temp_data_p_reads - Skipped prefetch

temporary data physical reads monitor element
skipped_prefetch_temp_index_p_reads
xs:long
skipped_prefetch_temp_index_p_reads - Skipped prefetch

temporary index physical reads monitor element
skipped_prefetch_temp_xda_p_reads
xs:long
skipped_prefetch_temp_xda_p_reads - Skipped prefetch

temporary XDA data physical reads monitor element
skipped_prefetch_
uow_col_p_reads
skipped_prefetch_uow_col_p_reads - Skipped prefetch unit

of work column-organized physical reads monitor element
skipped_prefetch_uow_data_p_reads
xs:long
skipped_prefetch_uow_data_p_reads - Skipped prefetch

unit of work data physical reads monitor element
skipped_prefetch_uow_index_p_reads
xs:long
skipped_prefetch_uow_index_p_reads - Skipped prefetch

unit of work index physical reads monitor element
skipped_prefetch_
uow_temp_col_p_reads
skipped_prefetch_uow_temp_data_p_reads
xs:long
skipped_prefetch_uow_temp_data_p_reads - Skipped
prefetch unit of work temporary data physical reads
monitor element
skipped_prefetch_uow_temp_index_p_reads
xs:long
skipped_prefetch_uow_temp_index_p_reads - Skipped
prefetch unit of work temporary index physical reads
monitor element
skipped_prefetch_uow_temp_xda_p_reads
xs:long
prefetch unit of work temporary XDA data physical reads
monitor element
593

Element name
Data type
skipped_prefetch_uow_xda_p_reads
xs:long
skipped_prefetch_uow_xda_p_reads - Skipped prefetch unit

of work XDA data physical reads monitor element
skipped_prefetch_xda_p_reads
xs:long
skipped_prefetch_xda_p_reads - Skipped prefetch XDA

sort_heap_allocated
xs:long
sort_heap_allocated - Total Sort Heap Allocated monitor

element
sort_overflows
xs:long
sort_shrheap_allocated
xs:long
sort_shrheap_allocated - Sort Share Heap Currently

Allocated monitor element
sort_shrheap_top
xs:long
sort_shrheap_top - Sort share heap high watermark

monitor element
spacemappage_reclaim_wait_time
xs:long

reclaim wait time monitor element
static_sql_stmts
xs:long
static_sql_stmts - Static SQL Statements Attempted monitor

element
stats_cache_size
xs:long
tcpip_recv_volume
xs:long
tcpip_recv_volume - TCP/IP received volume monitor

element
xs:long
tcpip_recv_wait_time - TCP/IP received wait time monitor

element
tcpip_recvs_total
xs:long
tcpip_recvs_total - TCP/IP receives total monitor element
tcpip_send_volume
xs:long
tcpip_send_volume - TCP/IP send volume monitor element
xs:long
tcpip_send_wait_time - TCP/IP send wait time monitor

element
tcpip_sends_total
xs:long
tcpip_sends_total - TCP/IP sends total monitor element
thresh_violations
xs:long
thresh_violations - Number of threshold violations monitor

element
total_act_time
xs:long
total_act_wait_time
xs:long
total_act_wait_time - Total activity wait time monitor

element
total_app_commits
xs:long
total_app_commits - Total application commits monitor

elements
total_app_rollbacks
xs:long
total_app_rollbacks - Total application rollbacks monitor

element
total_app_rqst_time
xs:long

monitor element
xs:long
total_app_section_executions - Total application section

executions monitor element
total_async_runstats
xs:long
total_async_runstats - Total number of asynchronous

RUNSTATS requests
total_col_proc_time
total_col_proc_time - Total column-organized processing

time
total_col_time
xs:long

monitor element
total_commit_time
xs:long
total_commit_time - Total commit time monitor element
total_compilations
xs:long
total_compilations - Total compilations monitor element
xs:long

monitor element
total_compile_time
xs:long
total_compile_time - Total compile time monitor element
total_connect_authentication_proc_time
xs:long
total_connect_authentication_proc_time - Total connection

authentication processing time monitor element
total_connect_authentication_time
xs:long

switch user authentication request time monitor element
xs:long
total_connect_authentications - Connections or switch user

authentications performed monitor element
594

Element name
Data type
total_connect_request_proc_time
xs:long

xs:long

user request time monitor element
xs:long
total_connect_requests - Connection or switch user requests

monitor element
total_cons
xs:long
total_cons - Connects Since Database Activation monitor

element
total_cpu_time
xs:long
xs:long

xs:long
total_extended_latch_wait_time - Total extended latch wait

xs:long

monitor element
total_hash_grpbys
xs:long
total_hash_joins
xs:long
total_hash_loops
xs:long
xs:long

monitor element
total_implicit_compile_proc_time
xs:long
total_implicit_compile_proc_time - Total implicit compile

xs:long

monitor element
xs:long
total_load_proc_time - Total load processing time monitor

element
total_load_time
xs:long
total_loads
xs:long
total_olap_funcs
xs:long
total_peas
xs:long

element
total_peds
xs:long
total_peds - Total partial early distincts monitor element
xs:long

total_reorg_time
xs:long

element
total_reorgs
xs:long
xs:long

monitor element
total_rollback_time
xs:long
total_rollback_time - Total rollback time monitor element
xs:long

monitor elements
total_routine_time
xs:long
total_routine_time - Total routine time monitor element
total_routine_user_code_proc_time
xs:long
total_routine_user_code_proc_time - Total routine user code

xs:long

monitor element
total_rqst_mapped_in
xs:long
total_rqst_mapped_in - Total request mapped-in monitor

element
total_rqst_mapped_out
xs:long
total_rqst_mapped_out - Total request mapped-out monitor

element
total_rqst_time
xs:long
total_runstats
xs:long
total_runstats - Total runtime statistics monitor element
xs:long

total_runstats_time
xs:long
total_runstats_time - Total runtime statistics time monitor

element
595

Element name
Data type
total_sec_cons
xs:long
total_sec_cons - Secondary Connections monitor element
xs:long

monitor element
xs:long
total_section_sort_proc_time - Total section sort processing

xs:long
total_section_sort_time - Total section sort time monitor

element
total_section_sorts
xs:long
total_section_sorts - Total section sorts monitor element
total_section_time
xs:long
total_section_time - Total section time monitor element
total_sorts
xs:long
total_stats_fabrication_proc_time
xs:long
total_stats_fabrication_proc_time - Total statistics fabrication

xs:long
total_stats_fabrication_time - Total statistics fabrication time

monitor element
xs:long
total_stats_fabrications - Total statistics fabrications monitor

elements
total_sync_runstats
xs:long

xs:long

xs:long
total_sync_runstats_time - Total synchronous RUNSTATS

time monitor elements
total_wait_time
xs:long
xs:long

monitor element
xs:long

monitor element
tq_tot_send_spills
xs:long
tq_tot_send_spills - Total number of table queue buffers

overflowed monitor element
uid_sql_stmts
xs:long

unread_prefetch_pages
xs:long
unread_prefetch_pages - Unread prefetch pages monitor

element
vectored_ios
xs:long
vectored_ios - Number of vectored I/O requests monitor

element
xs:long
wlm_queue_assignments_total - Workload manager total

queue assignments monitor element
xs:long
wlm_queue_time_total - Workload manager total queue

xquery_stmts
xs:long

element
Usage notes
Example
Retrieve information about rows_read, num_locks_waiting, total_cpu_time, and
direct_reads, at the database level on the current member.
SELECT wlmetrics.member as member,
detmetrics.rows_read as rows_read,
detmetrics.num_locks_waiting as num_locks_waiting,
detmetrics.total_cpu_time as total_cpu_time,
detmetrics.direct_reads as direct_reads
596
FROM TABLE(MON_GET_DATABASE_DETAILS(NULL)) AS WLMETRICS,

$detmetric/db2_database
PASSING XMLPARSE(DOCUMENT WLMETRICS.DETAILS) as "detmetric"
COLUMNS "ROWS_READ" INTEGER PATH system_metrics/rows_read,
"NUM_LOCKS_WAITING" INTEGER PATH system_metrics/lock_waits,
"TOTAL_CPU_TIME" INTEGER PATH system_metrics/total_cpu_time,
"DIRECT_READS" INTEGER PATH system_metrics/direc_reads
) AS DETMETRICS;

MEMBER ROWS_READ
NUM_LOCKS_WAITING TOTAL_CPU_TIME DIRECT_READS
------ ----------- ----------------- -------------- -----------0
3288
0
2330014
-
MON_GET_EXTENDED_LATCH_WAIT table function - Return information for

latches:
This function returns information for latches which have been involved in
extended latch waits. This information includes the member, latch name, number
of extended waits, and time spent in extended waits.
Syntax
MON_GET_EXTENDED_LATCH_WAIT (
member

member
The member ID for which to return data. If NULL or -1 is specified, data for
the currently connected member will be returned. If -2 is specified, data from
all members will be returned. Otherwise, only data for the specified member
will be returned. If an invalid, undefined, or offline member is specified, no
data will be returned.
Authorization
v DBADM authority
v SQLADM authority
None
Usage notes
The MON_GET_EXTENDED_LATCH_WAIT returns informations about which
latches on a given member have been involved in extended latch waits, including
how much time and how many times the particular latch has been involved in
extended latch waits. This information will be collected as part of the base monitor
metrics.
597
Table 147. Information returned for MON_GET_EXTENDED_LATCH_WAIT
Column Name
Data Type
Description
MEMBER
SMALLINT
LATCH_NAME
VARCHAR(256)
The name of the latch. This value corresponds to latch

names that are reported in DB2 diagnostic files such as
the db2diag log files or the stack files.
_WAITS
BIGINT
_WAIT_TIME
BIGINT

wait time
MON_GET_EXTENT_MOVEMENT_STATUS - get extent movement progress:

The MON_GET_EXTENT_MOVEMENT_STATUS table function returns the status
of the extent movement operation.
Syntax
MON_GET_EXTENT_MOVEMENT_STATUS (
tbsp_name
member

tbsp_name
An input argument of type VARCHAR(128) that specifies the table space to
query. If the argument value is null, the function returns information for all
table spaces.
member
An input argument of type INTEGER that specifies a valid member inside the
database member, or -2 for all database members. If the argument value is null,
Authorization
v DBADM authority
v SQLADM authority
None
Example
Retrieve all information about the current extent progress for all table spaces:
SELECT * FROM TABLE(SYSPROC.MON_GET_EXTENT_MOVEMENT_STATUS(, -1))
598
Here is an example of the output from the preceding query:

TBSP_NAME
TBSP_ID MEMBER CURRENT_EXTENT LAST_EXTENT NUM_EXTENTS_MOVED
--------------- ------ -------------- ----------- ----------------SYSCATSPACE
0
0
-1
-1
-1
TEMPSPACE1
1
0
-1
-1
-1
USERSPACE1
2
0
-1
-1
-1
TS1
3
0
1
2
3
SYSTOOLSPACE
4
0
-1
-1
-1
Output from the query continued:

... NUM_EXTENTS_LEFT TOTAL_MOVE_TIME ADDITIONAL_DETAILS
... ---------------- --------------- -----------------...
-1
-1
...
-1
-1
...
-1
-1
...
4
0
...
-1
-1
-
Table 148. Information returned for MON_GET_EXTENT_MOVEMENT_STATUS
Column Name
Data Type
monitor element
TBSP_NAME
VARCHAR(128)
TBSP_ID
BIGINT
tablespace_id - Table space identifier
MEMBER
SMALLINT
member - Member from which this

information was collected
CURRENT_EXTENT
INTEGER
current_extent - Current extent being

moved
LAST_EXTENT
INTEGER
last_extent - Last extent moved
NUM_EXTENTS_MOVED
INTEGER
num_extents_moved - Number of
extents moved so far during this
extent movement operation
NUM_EXTENTS_LEFT
INTEGER
num_extents_left - Number of extents

left to move during this extent
movement operation
TOTAL_MOVE_TIME
BIGINT
total_move_time - Total move time

for all extents moved (in
milliseconds)
MON_GET_FCM - Get FCM metrics:

The MON_GET_FCM table function returns metrics for the fast communication
manager (FCM).
Syntax
MON_GET_FCM (
member
599

member
number. Specify -1 for the current database member, or -2 for information
from all active database members. An active database member is where the
database is available for connection and use by applications.
Authorization
v DBADM authority
v SQLADM authority
None
Example
To retrieve information about the fast communication manager message buffers on
all members:
SELECT member, buff_free, buff_free_bottom
FROM TABLE (MON_GET_FCM (-2))
This query returns the following:

MEMBER BUFF_FREE
BUFF_FREE_BOTTOM
------ ------------------- ----------------2
13425
13416
10
13425
13416
1
13425
13416
Table 149. Information returned for MON_GET_FCM
Column Name
Data Type
HOSTNAME
VARCHAR(128)
hostname - Host name
MEMBER
SMALLINT
BUFF_MAX
BIGINT
buff_max - Maximum possible number of FCM buffers
BUFF_TOTAL
BIGINT
buff_total - Number of currently allocated FCM buffers
BUFF_FREE
BIGINT
buff_free - FCM buffers currently free
BUFF_FREE_BOTTOM
BIGINT
buff_free_bottom - Minimum FCM buffers free
BUFF_AUTO_TUNING
SMALLINT
buff_auto_tuning - FCM buffer auto-tuning indicator
CH_MAX
BIGINT
ch_max - Maximum possible number of FCM channels
CH_TOTAL
BIGINT
ch_total - Number of currently allocated FCM channels
CH_FREE
BIGINT
ch_free - Channels currently free
CH_FREE_BOTTOM
BIGINT
ch_free_bottom - Minimum channels free
CH_AUTO_TUNING
SMALLINT
ch_auto_tuning - FCM channel auto-tuning indicator
600
Note: The metrics provided by this table function apply to all members on a given
host machine. All members on a given host machine share the same set of buffers
and channels. This means that the individual metrics will usually be the same for
each member on given host machine. However, each member executes
independently and the metrics might differ slightly as the resource numbers
change in between the sampling on different members.
MON_GET_FCM_CONNECTION_LIST - Get details for all FCM connections:
The MON_GET_FCM_CONNECTION_LIST table function returns monitor metrics
for all the fast communication manager (FCM) connections on the specified
member or members.
Syntax
MON_GET_FCM_CONNECTION_LIST (
member )

member
number. Specify -1 for the current database member, or -2 for information
from all active database members. An active database member is where the
Authorization
v DBADM authority
v SQLADM authority
None
Table 150. Information returned for MON_GET_FCM_CONNECTION_LIST
Column Name
Data Type
MEMBER
SMALLINT
REMOTE_MEMBER
SMALLINT
remote_member - Remote member
CONNECTION_STATUS
VARCHAR(16)
connection_status - Connection status
TOTAL_BUFFERS_SENT
BIGINT
total_buffers_sent - Total FCM buffers sent
TOTAL_BUFFERS_RCVD
BIGINT
total_buffers_rcvd - Total FCM buffers received
FCM_CONGESTION_TIME
BIGINT
fcm_congestion_time - FCM congestion time
FCM_CONGESTED_SENDS
BIGINT
fcm_congested_sends - FCM congested sends

601
Table 150. Information returned for MON_GET_FCM_CONNECTION_LIST (continued)

Column Name
Data Type
FCM_NUM_CONGESTION_
TIMEOUTS
BIGINT
fcm_num_congestion_timeouts - FCM congestion

timeouts
FCM_SEND_VOLUME
BIGINT
FCM_RECV_VOLUME
BIGINT
FCM_MESSAGE_SEND_
VOLUME
BIGINT
FCM_MESSAGE_RECV_
VOLUME
BIGINT

volume
FCM_TQ_SEND_VOLUME
BIGINT
FCM_TQ_RECV_VOLUME
BIGINT
FCM_NUM_CONN_LOST
BIGINT
fcm_num_conn_lost - FCM lost connections
FCM_NUM_CONN_TIMEOUTS BIGINT
fcm_num_conn_timeouts - FCM connection timeouts
MON_GET_GROUP_BUFFERPOOL:
The MON_GET_GROUP_BUFFERPOOL table function returns statistics about the
group buffer pool (GBP).
Syntax
MON_GET_GROUP_BUFFERPOOL (
member

member
database member, or -2 for all active members. If the NULL value is specified,
Authorization
v DBADM authority
v SQLADM authority
None
Example
If the group buffer pool (GBP) does not have sufficient space when attempting to
register a page or write a page to the GBP, a GBP_FULL error occurs.
602
The following example returns the number of times the GBP_FULL error is
encountered from all members.
SELECT SUM(T.NUM_GBP_FULL) AS NUM_GBP_FULL
FROM TABLE(MON_GET_GROUP_BUFFERPOOL(-2)) AS T

NUM_GBP_FULL
-----------123
If the value of NUM_GBP_FULL increases by more than one per minute, then the
current size of the GBP likely does not meet your needs. In this case, increase the
size of the GBP with the command:
UPDATE DB CFG USING CF_GBP_SIZE <new_size>
For this command, the value of <new_size> grows the group buffer pool to a size
sufficient to slow or stop the increasing number of GBP_FULL errors.
Table 151. Information returned for MON_GET_GROUP_BUFFERPOOL
Column name
Data type
MEMBER
SMALLINT
NUM_GBP_FULL
BIGINT
Number of times the GBP_FULL error occurs.
MON_GET_HADR table function - Returns high availability disaster recovery

(HADR) monitoring information:
This function returns high availability disaster recovery (HADR) monitoring
information.
Authorization
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_HADR (
member
603
Routine parameters
member
An input argument of type INTEGER that specifies a member number.
Returned rows represent log streams being processed by the member. Specify
-1 for the current database member, or -2 for all database members. If the null
value is specified, -1 is set implicitly.
Table 152. Information returned for MON_GET_HADR
Column Name
Data Type
Description
HADR_ROLE
VARCHAR(13)
hadr_role - HADR Role monitor element

This interface returns a text identifier based on the defines
in sqlmon.h, and is one of:
v PRIMARY
v STANDBY
REPLAY_TYPE
VARCHAR(9)
Type of HADR replication.

v PHYSICAL
HADR_SYNCMODE
VARCHAR(10)
hadr_syncmode - HADR Synchronization Mode monitor

element
v ASYNC
v STANDBY
v SYNC
v SUPERASYNC
STANDBY_ID
SMALLINT
Standby identifier. The id is system generated. Id to

database mapping may change from query to query.
When query is issued on the primary, all its standbys are
represented in returned data. This id is used to
differentiate the standbys. It is system generated and id to
standby mapping may change from query to query.
However, the id "1" is always assigned to the principal
standby (or the only standby in single standby systems).
When query is issued on the standby database, other
standbys are not visible, therefore 0 is always returned.
LOG_STREAM_ID
INTEGER
Identifies log stream being shipped. Stream ID on source

database is returned.
HADR_STATE
VARCHAR(23)
hadr_state - HADR State monitor element

v DISCONNECTED
v LOCAL_CATCHUP
v REMOTE_CATCHUP_PENDING
v REMOTE_CATCHUP
v PEER
v DISCONNECTED_PEER
604
Table 152. Information returned for MON_GET_HADR (continued)

Column Name
Data Type
Description
HADR_FLAGS
VARCHAR(512)
Flags for HADR information. HADR_FLAGS is a space

delimited string made from the following flags:
ASSISTED_REMOTE_CATCHUP
The stream is in assisted remote catchup state.
ASSISTED_MEMBER_ACTIVE
During assisted remote catchup, the primary
member being assisted is active. This is an
abnormal condition because an active member is
expected to connect to the standby database
directly.
STANDBY_LOG_RETRIEVAL
The standby database is interacting with the log
archive device to retrieve log files.
STANDBY_RECV_BLOCKED
The standby database temporarily cannot receive
logs. The following conditions are possible
causes of this flag:
v When log spooling is disabled, the buffer that
receives logs is full
(STANDBY_RECV_BUF_PERCENT is 100%).
v When log spooling is enabled, spooling has
reached the spool limit
(STANDBY_SPOOL_PERCENT is 100%).
v The Standby log device is full
(STANDBY_LOG_DEVICE_FULL flag is set).
This condition can happen when spooling is
enabled or disabled.
In all cases, progress made during replay will
release space and let log receiving resume.
STANDBY_LOG_DEVICE_FULL
The standby log device is full. This condition
blocks receiving of logs until space is released as
replay proceeds.
PRIMARY_MEMBER_HOST
VARCHAR(255)
HADR_LOCAL_HOST of the primary member processing

the log stream.
PRIMARY_INSTANCE
VARCHAR(128)
Instance name of the primary member processing the log

stream.
PRIMARY_MEMBER
SMALLINT
Primary member processing the log stream.
STANDBY_MEMBER_HOST
VARCHAR(255)
HADR_LOCAL_HOST of the standby member processing

the log stream.
STANDBY_INSTANCE
VARCHAR(128)
Instance name of the standby member processing the log

stream.
STANDBY_MEMBER
SMALLINT
Standby member processing the log stream.
HADR_CONNECT_STATUS
VARCHAR(12)
hadr_connect_status - HADR Connection Status monitor

element
HADR_CONNECT_STATUS
_TIME
TIMESTAMP
Shows one of the following values: connection start time,

congestion start time, or disconnection time, depending
on CONNECT_STATUS
605

Column Name
Data Type
Description
HEARTBEAT_INTERVAL
BIGINT
Heartbeat interval. The interval is computed from various

factors like HADR_TIMEOUT and PEER_WINDOW. This
element indicates how often primary and standby
exchange monitor information. Units are milliseconds.
HADR_TIMEOUT
BIGINT
hadr_timeout - HADR Timeout monitor element
TIME_SINCE_LAST_RECV
BIGINT
Time since last message was received. Normally, this

number is no more than HEARTBEAT_INTERVAL
because an HADR database sends out a heartbeat
message on heartbeat interval when the channel is idle.
Larger number indicates delay in message delivery. When
this number reaches HADR_TIMEOUT, connection is
closed. Units are milliseconds.
PEER_WAIT_LIMIT
BIGINT
Reflects peer wait limit configuration (set via the registry

variable DB2_HADR_PEER_WAIT_LIMIT). Units are
milliseconds.
LOG_HADR_WAIT_CUR
BIGINT
Current logger waiting time on an HADR log shipping

request. Returns 0 if logger is not waiting. When wait
time reaches peer wait limit, HADR will break out of peer
state to unblock the primary database. If logger is
completely blocked, LOG_HADR_WAIT_CUR and
LOG_HADR_WAIT_TIME will grow in real time, while
LOG_HADR_WAITS_TOTAL stays the same. Units are
milliseconds.
LOG_HADR_WAIT_TIME
BIGINT
Accumulated time, the logger spent, waiting for HADR to

ship logs. With LOG_HADR_WAIT_TIME and
LOG_HADR_WAITS_TOTAL, you can compute average
HADR wait time per log flush in arbitrary interval. The
two fields are also reported by table function
MON_GET_TRANSACTION_LOG. Units are
milliseconds.
LOG_HADR_WAITS_TOTAL
BIGINT
Total count of HADR wait events in logger. Count is

incremented every time logger initiates a wait on HADR
log shipping, even if the wait returns immediately. Thus
this count is effectively the number of log flushes in peer
state. With LOG_HADR_WAIT_TIME and
LOG_HADR_WAITS_TOTAL, you can compute average
HADR wait time per log flush in arbitrary interval. The
two fields are also reported by table function
MON_GET_TRANSACTION_LOG.
SOCK_SEND_BUF
_REQUESTED
BIGINT
Number of bytes for requested socket send buffer size

(registry variable DB2_HADR_SOSNDBUF). Value is 0 for
no request (use system default).
SOCK_SEND_BUF_ACTUAL
BIGINT
Number of bytes for actual socket send buffer size. This

may differ from the requested size.
SOCK_RECV_BUF
_REQUESTED
BIGINT
Number of bytes for requested socket receive buffer size

(registry variable DB2_HADR_SORCVBUF). Value is 0 for
no request (use system default).
SOCK_RECV_BUF_ACTUAL
BIGINT
Number of bytes for actual socket receive buffer size. This

may differ from the requested size.
PRIMARY_LOG_FILE
VARCHAR(12)
The name of the current log file on this log stream on the
primary HADR database.
606

Column Name
Data Type
Description
PRIMARY_LOG_PAGE
BIGINT
The page number in the current log file corresponding to

the current log position on the primary HADR database.
The page number is relative to the log file. For example,
page zero is the beginning of the file.
PRIMARY_LOG_POS
BIGINT
The current log position on this log stream on the

primary HADR database. This is a byte offset.
PRIMARY_LOG_TIME
TIMESTAMP
The latest transaction timestamp on this log stream on the

primary HADR database.
STANDBY_LOG_FILE
VARCHAR(12)
The name of the log file corresponding to the standby

received log position on this log stream.
STANDBY_LOG_PAGE
BIGINT
The page number in STANDBY_LOG_FILE corresponding

to standby receive log position. The page number is
relative to the log file. For example, page zero is the
beginning of the file.
STANDBY_LOG_POS
BIGINT
Standby receive log position on this log stream. This is a

byte offset.The receive and replay positions are reported
separately for more detailed standby status. Spooling
allows receive and replay positions to differ greatly.
STANDBY_LOG_POS shows receive position. When
compared with PRIMARY_LOG_POS, the
STANDBY_LOG_POS indicates risk of data loss in case of
failover. STANDBY_REPLAY_LOG_POS affects how long
a takeover (forced and not forced) would take, since the
takeover has to complete the replay of all received logs.
The STANDBY_REPLAY_LOG_POS also indicates how
up-to-date data read on standby will be. In Version 9.7
and earlier, the reported standby log position is the replay
position.
STANDBY_LOG_TIME
TIMESTAMP
The latest transaction timestamp of received logs on this

log stream on the standby HADR database.
HADR_LOG_GAP
BIGINT
hadr_log_gap - HADR Log Gap monitor element
STANDBY_REPLAY_LOG_FILE VARCHAR(12)
The name of the log file corresponding to the standby

replay log position on this log stream.
STANDBY_REPLAY_LOG
_PAGE
BIGINT
The page number in STANDBY_REPLAY_LOG_FILE

corresponding to standby replay log position. The page
number is relative to the log file. For example, page zero
is the beginning of the file.
STANDBY_REPLAY_LOG_POS
BIGINT
Standby replay log position on this log stream. This is a

byte offset.
STANDBY_REPLAY_LOG
_TIME
TIMESTAMP
The transaction timestamp of logs being replayed on the

standby HADR database.
607

Column Name
Data Type
Description
STANDBY_RECV_REPLAY
_GAP
BIGINT
This element shows the recent average of the gap between

the standby log receive position and the standby log
replay position. The gap is measured in number of bytes.
It generally will not exceed sum of
STANDBY_RECV_BUF_SIZE + STANDBY_SPOOL_LIMIT.
A small amount over the sum is possible due to flexibility
in buffer and spool management. When the gap reaches
the combined buffer and spool limit, standby will stop
receiving logs which will block primary in peer state.
Standby may also run out of buffer and spool space when
reported receive-replay gap is smaller than sum of buffer
and spool, because a partial page can be sent multiple
times and occupy multiple pages of space in buffer
(always one page in spool though). However, the log gap
calculation does not take multiple sends into account.
STANDBY_REPLAY_DELAY
BIGINT
This element reflects the HADR_REPLAY_DELAY

configuration on the standby database. Units are
milliseconds.
STANDBY_RECV_BUF_SIZE
BIGINT
Standby receive buffer size in pages.
STANDBY_RECV_BUF
_PERCENT
DOUBLE
Percentage of standby receive buffer in use. When

spooling is enabled, standby can continue to receive logs
even when receive buffer is full (100% used).
STANDBY_SPOOL_LIMIT
BIGINT
Maximal number of pages to spool. 0 for spooling

disabled and -1 for no limit. This element reflects the
HADR_SPOOL_LIMIT configuration on the standby
database.
STANDBY_SPOOL_PERCENT
DOUBLE
Percentage of spool space used, relative to the configured

spool limit. If the spool limit is 0 (spooling disabled) or -1
(unlimited spooling), NULL is returned. When the spool
percentage reaches 100%, the standby database will stop
receiving logs until space is released as replay proceeds.
Spooling can stop before the limit is reached if the spool
device (standby log path) is full.
PEER_WINDOW
BIGINT
The HADR_PEER_WINDOW database configuration parameter.

Units are milliseconds.
PEER_WINDOW_END
TIMESTAMP
End time of current peer window. NULL if peer window

is not enabled.
TAKEOVER_APP_REMAINING BIGINT
_PRIMARY
During non forced takeover, the number of applications

still to be forced off on primary. Return NULL if not in
takeover.
TAKEOVER_APP_REMAINING BIGINT
_STANDBY
During takeover (forced and non forced), number of reads

on standby applications still to be forced off on standby.
Return NULL if not in takeover.
READS_ON_STANDBY
_ENABLED
Verify whether the reads on standby feature is enabled.

Controlled by registry variable DB2_HADR_ROS. One of:
CHAR(1)
v Y (Yes)
v N (No)
STANDBY_REPLAY_ONLY
_WINDOW_ACTIVE
CHAR(1)
Replay only window status. Values are:

v Y: ACTIVE
v N: INACTIVE
608

Column Name
Data Type
Description
STANDBY_REPLAY_ONLY
_WINDOW_START
TIMESTAMP
Replay only window start time.
STANDBY_REPLAY_ONLY
_WINDOW_TRAN_COUNT
BIGINT
Total number of uncommitted DDL or maintenance

transactions executed so far in the current replay only
window.
Usage notes
HADR pair view
Certain fields are applicable to primary or standby only. For example,
PEER_WAIT_LIMIT is applicable only to primary,
STANDBY_RECV_BUF_SIZE, STANDBY_SPOOL_LIMIT,
READS_ON_STANDBY_ENABLED are applicable only to standby. When
this kind of information is reported, the database currently in the role is
used (which may be the remote database), rather than the local database.
For example, PEER_WAIT_LIMIT seen on a standby database is the value
configured on the primary database, not the local config of standby
database (which will be used only when the standby turns into primary).
Information about remote database
Primary and standby exchange monitoring information via heartbeat
messages. Therefore information about the remote database can be slightly
out of date. See heartbeat interval (reported in table function) to estimate
timeliness of information (network latency can add additional delay). If a
database has never connected to its partner database since activation,
information about remote database may be returned as SQL NULL to
indicate "unknown".
Log shipping channel end points
The end points for a log shipping channel is uniquely identified by host,
instance and member:
v Primary side: PRIMARY_MEMBER_HOST, PRIMARY_INSTANCE,
PRIMARY_MEMBER
v Standby side: STANDBY_MEMBER_HOST, STANDBY_INSTANCE,
STANDBY_MEMBER
Until a connection is made, end point information of remote end may not
be available. When information not available, empty strings will be
returned for host and instance names and zero returned for member ID. In
addition when in a DB2 Enterprise Server Edition environment, 0 is always
returned for the member ID.
Note on unit of time duration
Per monitor table function convention, all MON_GET_HADR time
duration fields use milliseconds as unit. For those fields reflecting a
configuration parameter (such as HADR_TIMEOUT,
HADR_PEER_WINDOW) whose unit in configuration is seconds, the
number returned by MON_GET_HADR table function will be different
from the number used in db2 get/update db cfg command, and the
number returned by SYSIBMADM.DBCFG admin view or
SYSPROC.DB_GET_CFG() table function. For example, for a 60 second
HADR_TIMEOUT value, MON_GET_HADR will return 60000, while the
609
configuration oriented interfaces will return 60. To convert the millisecond

number to second, use column_name/1000 in your query.
Usage during takeover
During takeover, there may be a period when clients cannot connect to
either primary or standby database. The recommended monitoring method
during takeover is db2pd -hadr.
Column Order and Groups:
1. Cluster level summary: HADR_ROLE, REPLAY_TYPE, HADR_SYNCMODE.
2. Log stream level summary: STANDBY_ID, LOG_STREAM_ID, HADR_STATE
3. Log shipping channel end points:
a. Primary side: PRIMARY_MEMBER_HOST, PRIMARY_INSTANCE,
PRIMARY_MEMBER
b. Standby side: STANDBY_MEMBER_HOST, STANDBY_INSTANCE,
STANDBY_MEMBER
The end points uniquely identify an HADR log shipping channel in all
scenarios. Host, instance or MEMBER_ID uniquely identifies a member.
4. Connection details:
a. Status: HADR_CONNECT_STATUS, HADR_CONNECT_STATUS_TIME
b. Network timing: HEARTBEAT_INTERVAL, HADR_TIMEOUT,
TIME_SINCE_LAST_RECV
c. Logger wait timing: PEER_WAIT_LIMIT, LOG_HADR_WAIT_CUR,
LOG_HADR_WAIT_TIME, LOG_HADR_WAITS_TOTAL
d. TCP buffer size: SOCK_SEND_BUF_REQUESTED,
SOCK_SEND_BUF_ACTUAL, SOCK_RECV_BUF_REQUESTED,
SOCK_RECV_BUF_ACTUAL
5. Log position details:
a. Primary log position: PRIMARY_LOG_FILE, PRIMARY_LOG_PAGE,
PRIMARY_LOG_POS, PRIMARY_LOG_TIME
b. Standby log receive position: STANDBY_LOG_FILE,
STANDBY_LOG_PAGE, STANDBY_LOG_POS, STANDBY_LOG_TIME
c. Primary-standby log gap: HADR_LOG_GAP
d. Standby log replay position: STANDBY_REPLAY_LOG_FILE,
STANDBY_REPLAY_LOG_PAGE, STANDBY_REPLAY_LOG_POS,
STANDBY_REPLAY_LOG_TIME
e. Standby receive-replay gap: STANDBY_RECV_REPLAY_GAP
6.
7.
8.
9.
610
f. Replay delay: STANDBY_REPLAY_DELAY

Log buffer and spooling: STANDBY_RECV_BUF_SIZE,
STANDBY_RECV_BUF_PERCENT, STANDBY_SPOOL_LIMIT
Peer window: PEER_WINDOW, PEER_WINDOW_END
Takeover: TAKEOVER_APP_REMAINING_PRIMARY,
TAKEOVER_APP_REMAINING_STANDBY
Reads on Standby: READS_ON_STANDBY_ENABLED,
STANDBY_REPLAY_ONLY_WINDOW_ACTIVE,
STANDBY_REPLAY_ONLY_WINDOW_START,
STANDBY_REPLAY_ONLY_WINDOW_TRAN_COUNT
Examples
1. SELECT HADR_ROLE, STANDBY_ID, HADR_STATE, varchar(PRIMARY_MEMBER_HOST ,20)
as PRIMARY_MEMBER_HOST, varchar(STANDBY_MEMBER_HOST ,20)
as STANDBY_MEMBER_HOST from table(MON_GET_HADR(NULL))

HADR_ROLE
STANDBY_ID HADR_STATE
PRIMARY_MEMBER_HOST
------------- ---------- ----------------------- -------------------PRIMARY
1 PEER
hostP.ibm.com
PRIMARY
2 REMOTE_CATCHUP
hostP.ibm.com
PRIMARY
3 REMOTE_CATCHUP
hostP.ibm.com
STANDBY_MEMBER_HOST
-------------------hostS1.ibm.com
hostS2.ibm.com
hostS3.ibm.com
Query is issued to a primary database with 3 standbys in which 3 rows are

returned. Each row represents a primary-standby log shipping channel. The
HADR_ROLE column represents the role of the database to which the query is
issued. Therefore it is PRIMARY on all rows.
2. SELECT HADR_ROLE, STANDBY_ID, HADR_STATE, varchar(PRIMARY_MEMBER_HOST ,20)
as PRIMARY_MEMBER_HOST, varchar(STANDBY_MEMBER_HOST ,20)
as STANDBY_MEMBER_HOST from table(MON_GET_HADR(NULL))

HADR_ROLE
STANDBY_ID HADR_STATE
PRIMARY_MEMBER_HOST
------------- ---------- ----------------------- -------------------STANDBY
0 PEER
hostP.ibm.com
STANDBY_MEMBER_HOST
-------------------hostS1.ibm.com
Query is issued to a standby database with reads on standby enabled. Standby

only knows about its own primary. Only one row is returned even if the
standby is part of a multiple standby system. STANDBY_ID is always zero
when query is issued to a standby.
3. The following example is for HADR in a DB2 pureScale environment only. The
environment for this example has three member clusters. Primary member 0 is
assisting member 1. Standby member 0 is the replay member.
v With member ID 0, the HADR information for log stream 0, and the assisted
log stream (log stream 1) is output:
SELECT LOG_STREAM_ID, PRIMARY_MEMBER, STANDBY_MEMBER, HADR_STATE, HADR_FLAGS
FROM TABLE (MON_GET_HADR(0))
LOG_STREAM_ID
------------0
1
PRIMARY_MEMBER
-------------0
0
STANDBY_MEMBER
-------------0
0
HADR_STATE
HADR_FLAGS
-------------- ----------------------PEER
REMOTE_CATCHUP ASSISTED_REMOTE_CATCHUP
v With member ID 1, the HADR information for log steam 1 is output:

LOG_STREAM_ID PRIMARY_MEMBER STANDBY_MEMBER HADR_STATE
HADR_FLAGS
------------- -------------- -------------- --------------- ---------1
1
0
DISCONNECTED
v For log stream ID 2, the HADR information for log stream 2 is output:
611

LOG_STREAM_ID PRIMARY_MEMBER STANDBY_MEMBER HADR_STATE
HADR_FLAGS
------------- -------------- -------------- -------------- ---------2
2
0
PEER
v When specifying -2 as member ID, HADR information on all log streams is

reported. For assisted remote catchup, only the record from the assisting
member is returned, and HADR_FLAGS indicates that it is in an assisted
remote catchup state.
FROM TABLE (MON_GET_HADR(-2))
LOG_STREAM_ID
------------0
1
2
PRIMARY_MEMBER
-------------0
0
2
STANDBY_MEMBER
-------------0
0
0
HADR_STATE
HADR_FLAGS
---------------- ----------------------PEER
REMOTE_CATCHUP ASSISTED_REMOTE_CATCHUP
PEER
MON_GET_INDEX table function - get index metrics:

The MON_GET_INDEX table function returns metrics for one or more indexes.
Syntax
MON_GET_INDEX (
tabschema
, tabname
, member

tabschema
An input argument of type VARCHAR(128) that specifies a valid table schema
name in the same database as the one currently connected to when calling this
function. If the argument is NULL or an empty string, metrics are retrieved for
indexes of tables in all schemas in the database. If the argument is specified,
metrics are only returned for indexes for tables in the specified schema.
tabname
An input argument of type VARCHAR(128) that specifies a valid table name in
the same database as the one currently connected to when calling this function.
Metrics are returned for all indexes on the specified table. If the argument is
null or an empty string, metrics are retrieved for all indexes for all tables in the
database.
member
Specify a -1 for the current database member, or -2 for all database members. If
the NULL value is specified, -1 is set implicitly
Authorization
v DBADM authority
v SQLADM authority
612

None
Example
Identify the most frequently used indexes on the DMEXT002.TABLE1 table, since
the last database activation:
SELECT VARCHAR(S.INDSCHEMA, 10) AS INDSCHEMA,
VARCHAR(S.INDNAME, 10) AS INDNAME,
T.DATA_PARTITION_ID,
T.MEMBER,
T.INDEX_SCANS,
T.INDEX_ONLY_SCANS
FROM TABLE(MON_GET_INDEX(DMEXT002,TABLE1, -2)) as T, SYSCAT.INDEXES AS S
WHERE T.TABSCHEMA = S.TABSCHEMA AND
T.TABNAME = S.TABNAME AND
T.IID = S.IID
ORDER BY INDEX_SCANS DESC

INDSCHEMA
---------DMEXT002
DMEXT002
DMEXT002
DMEXT002
DMEXT002
DMEXT002
INDNAME
DATA_PARTITION_ID MEMBER
INDEX_SCANS
INDEX_ONLY_SCANS
---------- ----------------- -------------- -------------------- -------------------INDEX3
0
1
1
INDEX4
0
1
0
INDEX1
0
0
0
INDEX2
0
0
0
INDEX5
0
0
0
INDEX6
0
0
0
Usage notes
The MON_GET_INDEX table function returns one row of data per index, and per
database member. If partitioned indexes are being used, one row is returned for
each index partition per database member. No aggregation across database
members is performed. However, aggregation can be achieved through SQL
queries as shown in the previous example.
Metrics will only be returned for indexes on tables that have been accessed since
the database was activated. All counters represent data since the current database
activation. For example, the pseudo_empty_pages counter is the number of pages
that have been identified as pseudo empty since the database was activated. it is
not the current number of pseudo empty pages in the index.
The metrics returned by this function are collected at two levels. Some metrics are
always collected, while the collection of other metrics is controlled at the database
level using the mon_obj_metrics configuration parameter. Refer to the descriptions
provided in the following table to determine if any settings must be active for data
to be collected for a particular metric.
Table 153. Information returned for MON_GET_INDEX
Column Name
Data Type
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
IID
SMALLINT
iid - Index identifier

613
Table 153. Information returned for MON_GET_INDEX (continued)

Column Name
Data Type
MEMBER
SMALLINT
DATA_PARTITION_ID
INTEGER
data_partition_id - Data partition identifier
NLEAF
BIGINT
nleaf - Number of leaf pages
NLEVELS
SMALLINT
nlevels - Number of index levels
INDEX_SCANS
BIGINT
index_scans - Index scans
INDEX_ONLY_SCANS
BIGINT
index_only_scans - Index-only scans
KEY_UPDATES
BIGINT
key_updates - Key updates
INCLUDE_COL_UPDATES
BIGINT
include_col_updates - Include column updates
PSEUDO_DELETES
BIGINT
pseudo_deletes - Pseudo deletes
DEL_KEYS_CLEANED
BIGINT
del_keys_cleaned - Pseudo deleted keys cleaned
ROOT_NODE_SPLITS
BIGINT
root_node_splits - Root node splits
INT_NODE_SPLITS
BIGINT
int_node_splits - Intermediate node splits
BOUNDARY_LEAF
_NODE_SPLITS
BIGINT
boundary_leaf_node_splits - Boundary leaf node

splits
NONBOUNDARY_LEAF
_NODE_SPLITS
BIGINT
nonboundary_leaf_node_splits - Non-boundary leaf

node splits
PAGE_ALLOCATIONS
BIGINT
page_allocations - Page allocations
PSEUDO_EMPTY_PAGES
BIGINT
pseudo_empty_pages - Pseudo empty pages
EMPTY_PAGES_REUSED
BIGINT
empty_pages_reused - Empty pages reused
EMPTY_PAGES_DELETED
BIGINT
empty_pages_deleted - Empty pages deleted
PAGES_MERGED
BIGINT
pages_merged - Pages merged
OBJECT_INDEX_L_READS
BIGINT
object_index_l_reads - Buffer pool index logical

reads for an index
OBJECT_INDEX_P_READS
BIGINT
object_index_p_reads - Buffer pool index physical

reads for an index
OBJECT_INDEX_GBP_L_READS
BIGINT
object_index_gbp_l_reads - Group buffer pool index

logical reads for an index
OBJECT_INDEX_GBP_P_READS
BIGINT
object_index_gbp_p_reads - Group buffer pool index

physical reads for an index
OBJECT_INDEX_GBP_INVALID_PAGES BIGINT
object_index_gbp_invalid_pages - Group buffer pool

invalid index pages for an index
OBJECT_INDEX_LBP_PAGES_FOUND
BIGINT
object_index_lbp_pages_found - Local buffer pool

index pages found for an index
OBJECT_INDEX_GBP_INDEP_PAGES
_FOUND_IN_LBP
BIGINT
object_index_gbp_indep_pages_found_in_lbp Group buffer pool independent index pages found

in local buffer pool
INDEX_JUMP_SCANS
BIGINT
index_jump_scans - Index jump scans
OBJECT_INDEX_CACHING_
TIER_L_READS
BIGINT
TIER_PAGES_FOUND
BIGINT
BIGINT
614
Table 153. Information returned for MON_GET_INDEX (continued)

Column Name
Data Type
BIGINT
MON_GET_INDEX_USAGE_LIST table function - Returns information from an

index usage list:
The MON_GET_INDEX_USAGE_LIST table function returns information from a
usage list defined for an index.
Syntax
MON_GET_INDEX_USAGE_LIST ( usagelistschema
, usagelistname, member

usagelistschema
An input argument of type VARCHAR(128) that specifies a valid schema name
in the currently connected database when calling this function. If the argument
is null or an empty string, usage lists are retrieved in all schemas in the
database. If the argument is specified, usage lists are only returned for the
specified schema. The default is NULL.
usagelistname
An input argument of type VARCHAR(128) that specifies a usage list defined
for an index that resides in the currently connected database when calling this
function. If usagelistname is null or an empty string, then all usage lists defined
for an index from the schemas identified by the usagelistschema that exist are
retrieved. If specified, only the usage list specified from the schemas identified
by the usagelistschema is returned. The default is NULL.
member
Authorization
v DBADM authority
v SQLADM authority
None
615
Example
Return the usage list USL_MON_IND1 from all database members
SELECT * FROM TABLE(
MON_GET_INDEX_USAGE_LIST(NULL, USL_MON_IND1, -2))
USAGELISTSCHEMA
-----------------ISAYYID
ISAYYID
USAGELISTNAME
---------------USL_MON_IND1
USL_MON_IND1
INDSCHEMA
-------------ISAYYID
ISAYYID
INDNAME
--------------I1
I1
MEMBER
-----0
0
DATA_PARTITION_ID
----------------EXECUTABLE_ID
------------------------------------------------------------------x0100000000000000490000000000000000000000020020110706093802577065
x01000000000000004B0000000000000000000000020020110706093825981548
MON_INTERVAL_ID
LAST_UPDATED
NUM_REFERENCES
---------------------------------------------- -------------------02011-07-06-09.38.15.881668
1
02011-07-06-09.38.25.984147
1
NUM_REF_WITH_METRICS OBJECT_INDEX_L_READSOBJECT_INDEX_P_READS
-------------------- ---------------------------------------1
1
0
1
1
0
OBJECT_INDEX_GBP_L_READS OBJECT_INDEX_GBP_P_READS
------------------------ -----------------------0
0
0
0
OBJECT_INDEX_GBP_INVALID_PAGES OBJECT_INDEX_LBP_PAGES_FOUND
------------------------------ ---------------------------0
0
0
0
Usage notes
Each row returned by this function represents the total number of times
(num_references) a unique section (DML statement only, executable ID) has
referenced a particular object during a particular time interval (monitor interval ID)
since being added to the list. The statistics collected for this row represents the
total aggregated value across these executions during this time interval.
Use the num_ref_with_metrics column instead of the num_references column when
computing averages, since the num_references column counts all executions of the
section, regardless of whether or not the execution of the section contributed to the
metrics that are reported.
616
Table 154. Information returned for MON_GET_INDEX_USAGE_LIST
Column Name
Data Type
Description
USAGELISTSCHEMA
VARCHAR (128)
usage_list_schema - Usage list schema
USAGELISTNAME
VARCHAR (128)
usage_list_name - Usage list name
INDSCHEMA
VARCHAR (128)
index_schema - Index schema
INDNAME
VARCHAR (128)
index_name - Index name
MEMBER
SMALLINT
DATA_PARTITION_ID
INTEGER
EXECUTABLE_ID
VARCHAR (32) FOR

BIT DATA
MON_INTERVAL_ID
BIGINT
mon_interval_id - Monitor interval identifier
LAST_UPDATED
TIMESTAMP
last_updated - Last update time stamp
NUM_REFERENCES
BIGINT
num_references - Number of references
NUM_REF_WITH_METRICS
BIGINT
num_ref_with_metrics - Number of references with

metrics
OBJECT_INDEX_L_READS
BIGINT
object_index_l_reads - Buffer pool index logical reads for

an index
OBJECT_INDEX_P_READS
BIGINT
object_index_p_reads - Buffer pool index physical reads

for an index
OBJECT_INDEX_GBP_L
_READS
BIGINT
object_index_gbp_l_reads - Group buffer pool index

logical reads for an index
OBJECT_INDEX_GBP_P
_READS
BIGINT
object_index_gbp_p_reads - Group buffer pool index

physical reads for an index
OBJECT_INDEX_GBP
_INVALID_PAGES
BIGINT
object_index_gbp_invalid_pages - Group buffer pool

invalid index pages for an index
OBJECT_INDEX_LBP
_PAGES_FOUND
BIGINT
object_index_lbp_pages_found - Local buffer pool index

pages found for an index
OBJECT_INDEX_GBP_INDEP
_PAGES_FOUND_IN_LBP
BIGINT
object_index_gbp_indep_pages_found_in_lbp - Group
pool
TIER_L_READS
BIGINT
TIER_PAGES_FOUND
BIGINT
BIGINT
TIER_GBP_INDEP_PAGES_
FOUND
BIGINT
MON_GET_INSTANCE table function - Get instance level information:

The MON_GET_INSTANCE table function returns DB2 instance level information
within the monitor infrastructure.
617
Authorization
v
v
v
v

DBADM authority
SQLADM authority

None
Syntax
MON_GET_INSTANCE (
member

Routine parameters
member
applications.
Table 155. Information returned by the MON_GET_INSTANCE routine
618
Column name
Data type
Description
MEMBER
SMALLINT

monitor element
DB2_STATUS
VARCHAR(12)
db2_status - Status of DB2

instance monitor element
DB2START_TIME
TIMESTAMP
db2start_time - Start
Database Manager
Timestamp monitor element
TIMEZONEOFFSET
INTEGER
timezoneoffset - Time
difference from UCT monitor
element
TIMEZONEID
VARCHAR(255)
timezoneid - Time zone

CON_LOCAL_DBASES
BIGINT
con_local_dbases - Local
Databases with Current
Connects monitor element
TOTAL_CONNECTIONS
BIGINT
total_connections - Total
connections
AGENTS_REGISTERED
BIGINT
agents_registered - Agents
Registered monitor element
Table 155. Information returned by the MON_GET_INSTANCE routine (continued)

Column name
Data type
Description
AGENTS_REGISTERED_TOP BIGINT
agents_registered_top Maximum Number of Agents

Registered monitor element
IDLE_AGENTS
BIGINT
idle_agents - Number of Idle

Agents monitor element
AGENTS_FROM_POOL
BIGINT
agents_from_pool - Agents
Assigned From Pool monitor
element
AGENTS_CREATED_
EMPTY_POOL
BIGINT
agents_created_empty_pool Agents Created Due to

Empty Agent Pool monitor
element
NUM_COORD_AGENTS
BIGINT
num_coord_agents - Number
of coordinator agents
COORD_AGENTS_TOP
BIGINT
coord_agents_top Maximum Number of

Coordinating Agents monitor
element
AGENTS_STOLEN
BIGINT
agents_stolen - Stolen Agents

monitor element
GW_TOTAL_CONS
BIGINT
gw_total_cons - Total
Number of Attempted
Connections for DB2 Connect
monitor element
GW_CUR_CONS
BIGINT
gw_cur_cons - Current
Number of Connections for
DB2 Connect monitor
element
GW_CONS_WAIT_HOST
BIGINT
gw_cons_wait_host Number of Connections

Waiting for the Host to Reply
monitor element
GW_CONS_WAIT_CLIENT
BIGINT
gw_cons_wait_client Number of Connections

Waiting for the Client to
Send Request monitor
element
NUM_GW_CONN_
SWITCHES
BIGINT
num_gw_conn_switches Connection Switches monitor

element
PRODUCT_NAME
VARCHAR(32)
product_name - Product
Name monitor element
SERVICE_LEVEL
VARCHAR(64)
service_level - Service Level

monitor element
SERVER_PLATFORM
VARCHAR(32)
server_platform - Server
Operating System monitor
element
619
Example
Determine the start time and total number of current connections on all members:
SELECT DB2START_TIME, TOTAL_CONNECTIONS
FROM TABLE (MON_GET_INSTANCE(-2));

DB2START_TIME
-------------------------2012-09-11-15.39.05.000000
TOTAL_CONNECTIONS
-------------------2
MON_GET_LOCKS - List all locks in the currently connected database:

The MON_GET_LOCKS table function returns a list of all locks in the currently
connected database.
To get information about locks, use the MON_GET_LOCKS,
MON_FORMAT_LOCK_NAME, and MON_GET_APPL_LOCKWAIT table
functions, and the MON_LOCKWAIT administrative view instead of the
SNAPLOCKWAIT administrative view and SNAP_GET_LOCKWAIT table
function, the SNAPLOCK administrative view and SNAP_GET_LOCK table
function, and the LOCKS_HELD administrative view which are deprecated in Fix
Pack 1 of Version 9.7.
MON_GET_LOCKS (
search_args
, member

search_args
An input parameter of type CLOB(1K) that represents a list of key-value pairs.
If the list is empty or NULL, all locks in the currently connected database are
returned. Otherwise, all locks that match all of the conditions represented by
the list of key-value pairs are returned. A key-value pair must follow this format:
v A key is a string that consists of an opening tag, followed by the value,
followed by a closing tag.
v An opening tag consists of an opening angle bracket, followed by the key
name, followed by a closing angle bracket. No spaces are allowed.
v A closing tag consists of an opening angle bracket, followed by a forward
slash, followed by the key name, followed by a closing angle bracket. No
spaces are allowed.
v All keys are case-sensitive and can only be specified once in the search_args
parameter.
v The order of the keys does not matter.
SQLCODE -171 is returned for an invalid key-value pair.
SQLCODE -204 is returned if the table does not exist.
An AND operation is performed between different keys. An OR operation is
performed between multiple values of the same key. For example, the
following use of the search_args parameter returns a list of all locks of type
Table or Row, that are held, or waiting to be acquired, in either Shared or
Exclusive mode, by the application with the handle 123:
620
CLOB(<application_handle>123</application_handle>
<lock_object_type>Table:Row</lock_object_type>
<lock_mode>S:X</lock_mode>)
The available keys for the MON_GET_LOCKS table function are as follows:
v application_handle
Returns a list of all locks that are currently held or are in the process of
being acquired by the specified application handle. Only a single occurrence
of the key value can be specified. The value is specified as an INTEGER. For
example:
CLOB(<application_handle>145</application_handle>)
v lock_name
Returns a list of all locks that match the specified lock name. Only a single
occurrence of the key value can be specified. The value is specified as a
string of maximum length 32. For example:
CLOB(<lock_name>00030005000000000280000452</lock_name>)
v lock_object_type
Returns a list of all locks that match the specified lock object type. Multiple
occurrences of the key value can be specified (to a maximum of 5). Each
value (case insensitive) must be separated by a colon (:) and is specified as a
string of a maximum length of 32 characters. For example:
CLOB(<lock_object_type>Table:Chunk:Plan</lock_object_type>)
For a list of possible input values, see lock_object_type - Lock object type
waited on monitor element.
v lock_mode
Returns a list of all locks that match the specified lock mode. Multiple
occurrences of the key value can be specified (to a maximum of 5). Each
value (case insensitive) is separated by a colon (:) and is specified as a string
of maximum length 3. For example:
CLOB(<lock_mode>IS:IN:U</lock_mode>)
For a list of possible input values, see lock_mode - Lock mode monitor
element.
v lock_status
Returns a list of all locks in the specified status. Only a single occurrence of
the key value can be specified. The value is specified as a character.
CLOB(<lock_status>W</lock_status>)
For a list of possible input values, see lock_status - Lock status monitor
element.
v table_schema
Returns a list of all locks that are qualified by the specified schema name.
The table_name key must also be specified. Only a single occurrence of the
key value can be specified. The value is specified as a string of maximum
length 128.
v table_name
Returns a list of all locks that reference the specified table. The table_schema
key must also be specified. Only a single occurrence of the key value can be
specified. The value is specified as a string of maximum length 128. For
example:
CLOB(<table_schema>USER1</table_schema>
<table_name>INVENTORY</table_name>)
621
The following examples demonstrate how to use key-value pairs in the

search_args parameter.
1. To search for all ROW and TABLE locks:
CLOB(<lock_object_type>Table:Row</lock_object_type>)
2. To search for all locks that application handle 123 is holding or waiting to
acquire that reference table T1, and were created by user USER1:
CLOB(<application_handle>123</application_handle>
<table_schema>USER1</table_schema>
<table_name>T1</table_name>)
3. To search for all TABLE, ROW, and BUFFERPOOL locks that are currently
held in Shared mode:
CLOB(<lock_mode>S</lock_mode>
<lock_status>G</lock_status>
<lock_object_type>Table:Row:Bufferpool</lock_object_type>)
member
An input argument of type INTEGER that specifies from which member the
data is returned. Specify -1 for the current member, and -2 for all active
members.
Authorization
One of the following authorities or privilege is required:
v SYSADM authority
v SYSMON authority
None
Example
In this sample scenario, the MON_GET_LOCKS and
MON_GET_APPL_LOCKWAIT table functions are used to investigate the locking
situation in the current connected database, on all members.
1. Call the MON_GET_APPL_LOCKWAIT table function to determine all the
locks that are waiting to be acquired in the current connected database, on all
members:
SELECT lock_name,
hld_member,
lock_status,
hld_application_handle FROM
TABLE (MON_GET_APPL_LOCKWAIT(NULL, -2))

LOCK_NAME
-------------------------00030005000000000280000452
00030005000000000280000452
00030005000000000280000452
HLD_MEMBER LOCK_STATUS HLD_APPLICATION_HANDLE

---------- ----------- ----------------------2
W
-2
W
-2
W
The records that show HLD_MEMBER is -2 indicate that the lock

0x00030005000000000280000452 is being held at a remote member.
2. Call the MON_GET_LOCKS table function to determine the holder of the lock,
by specifying the lock name, 0x00030005000000000280000452, as the search
argument:
622
SELECT lock_name,
member,
lock_status,
application_handle FROM
TABLE (MON_GET_LOCKS(
CLOB(<lock_name>00030005000000000280000452</lock_name>),
-2))

LOCK_NAME
-------------------------00030005000000000280000452
00030005000000000280000452
00030005000000000280000452
00030005000000000280000452
MEMBER
-----0
1
2
3
LOCK_STATUS APPLICATION_HANDLE
----------- -----------------W
12562
W
12562
G
65545
W
12562
To find out more about the application holding the lock, you can call the
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES or
WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES table functions.
Table 156. Information returned by the MON_GET_LOCKS table function
Column name
Data type
APPLICATION_HANDLE
BIGINT
Description or monitor
element
application_handle Application handle
If the LOCK_STATUS
column is G, this represents
the application that is
currently holding the lock.
If the LOCK_STATUS
column is W or C, this
represents the application
that is currently waiting to
acquire the lock.
MEMBER
SMALLINT

from which the data was
retrieved for this row.
LOCK_NAME
VARCHAR(32)
LOCK_OBJECT_TYPE_ID
CHAR(1) FOR BIT DATA
623
Table 156. Information returned by the MON_GET_LOCKS table function (continued)

Column name
Data type
LOCK_OBJECT_TYPE
VARCHAR(32)
element
object type
If the LOCK_STATUS
the type of object that the
application is currently
holding.
If the LOCK_STATUS
column is W or C, then this
represents the type of object
that the application is
currently waiting to acquire.
For possible input values, see
monitor element.
LOCK_MODE
VARCHAR(3)

If the LOCK_STATUS
the mode that the application
is currently holding the lock
in.
If the LOCK_STATUS
column is W or C, this
represents the mode that the
application is currently
waiting to acquire the lock
in.
If the mode is unknown, a
value of NULL is returned
for this column.
LOCK_CURRENT_MODE
VARCHAR(3)
lock_current_mode - Original
Lock Mode Before
Conversion
If the mode is unknown, a
value of NULL is returned
for this column.
624
LOCK_STATUS
CHAR(1)
lock_status - Lock status
LOCK_ATTRIBUTES
CHAR(16)
lock_attributes - Lock
attributes
LOCK_RELEASE_FLAGS
CHAR(16)
lock_release_flags - Lock
release flags monitor element
LOCK_RRIID
BIGINT

LOCK_COUNT
BIGINT
Lock_count monitor element
LOCK_HOLD_COUNT
BIGINT
lock_hold_count monitor
element
Table 156. Information returned by the MON_GET_LOCKS table function (continued)

Column name
Data type
TBSP_ID
BIGINT
element
tablespace_id - Table space
ID
For locks that do not
reference a table space, a
TAB_FILE_ID
BIGINT
MON_GET_MEMORY_POOL - get
memory pool information:
The MON_GET_MEMORY_POOL table function retrieves metrics from the
memory pools contained within a memory set.
Syntax
MON_GET_MEMORY_POOL (
memory_set_type
db_name
, member

memory_set_type
An input argument of type VARCHAR(32) that specifies the type of the
memory set when calling this function. If the argument is NULL or an empty
string, then metrics are retrieved for all memory sets at the instance and
database level. Otherwise metrics for the specified memory set are retrieved.
These parameter values are accepted:
Value
Scope
Description
DBMS
Instance
DB2 database manager (DBM) memory set
FMP
Instance
Fenced mode process (FMP) memory set
PRIVATE
Instance
Private memory set
DATABASE
Database
Database memory set
APPLICATION
Database
Application memory set
FCM
Host - there is only

Fast communication manager (FCM)
one FCM memory set memory set
allocated per machine
for an instance.
NULL
All
All memory sets at the instance and

database level
db_name
An input argument of type VARCHAR(128) that specifies a valid database
name in the same instance as the currently connected database when calling
this function.
The database must have a directory entry type of either INDIRECT or
HOME, as returned by a LIST DATABASE DIRECTORY command. The
625
database must be active. Alternatively, the CURRENT_SERVER special register

can be specified to retrieve metrics from the currently connected database. The
register value contains the actual name of the database, not an alias.
If the argument is NULL or an empty string, metrics are taken from all active
databases in the instance. This input argument applies only to database level
memory sets.
member
data is returned. Specify -1 for the current database member, or -2 for all active
members. If the NULL value is specified, -1 is set implicitly.
Authorization
v DBADM authority
v SQLADM authority
None
Example
Example 1: Retrieve memory set metrics for the current instance and the currently
connected database.
SELECT varchar(memory_set_type, 20) AS set_type,
varchar(memory_pool_type,20) AS pool_type,
varchar(db_name, 20) AS dbname,
memory_pool_used,
memory_pool_used_hwm
FROM TABLE(
MON_GET_MEMORY_POOL(NULL, CURRENT_SERVER, -2))
An example of output from this query.

SET_TYPE
-----------DBMS
DBMS
DBMS
DBMS
DBMS
DBMS
DBMS
DBMS
DBMS
DBMS
DBMS
DBMS
FMP
DATABASE
DATABASE
DATABASE
DATABASE
DATABASE
DATABASE
626
POOL_TYPE
---------------FCM_LOCAL
FCM_SESSION
FCM_CHANNEL
FCMBP
FCM_CHANNEL
MONITOR
RESYNC
OSS_TRACKER
APM
BSU
KERNEL_CONTROL
EDU
MISC
UTILITY
PACKAGE_CACHE
XMLCACHE
CAT_CACHE
BP
BP
DBNAME
MEMORY_POOL_USED MEMORY_POOL_USED_HWM
------------ ---------------- -------------------0
0
2359296
2359296
589824
589824
983040
983040
35520512
35520512
458752
589824
262144
262144
7667712
7667712
13041664
13238272
3932160
4390912
3932160
4390912
655360
655360
655360
655360
TESTDB
65536
65536
TESTDB
983040
983040
TESTDB
196608
196608
TESTDB
458752
458752
TESTDB
850132992
850132992
TESTDB
655360
655360
APPLICATION
APPLICATION
APPLICATION
APPLICATION
TESTDB
TESTDB
393216
262144
393216
262144
Usage notes
In a partitioned database environment, the fast communication manager (FCM)
memory set is allocated per host; all members on this host machine share this set.
The MON_GET_MEMORY_POOL function retrieves data from each member. Since
the FCM memory set is shared among all members on the host, the metrics
reported for FCM memory for each member on the host represent information
about the same shared memory set. For this reason, when examining metrics for
FCM memory, examine the data for each unique host. For hosts with multiple
members, use data from only one member on that host, as the metrics for FCM
memory represent the aggregated total for all members on the given host.
Table 157. Information returned for MON_GET_MEMORY_POOL
Column name
Data type
Description
MEMBER
SMALLINT
HOST_NAME
VARCHAR(255)
DB_NAME
VARCHAR(128)
MEMORY_SET_TYPE
VARCHAR(32)
memory_set_type - Memory set type. See the

memory_set_type input parameter for the list of possible
types.
MEMORY_POOL_TYPE
VARCHAR(32)
memory_pool_type - Memory pool type.
MEMORY_POOL_ID
BIGINT
memory_pool_id - Memory pool identifier
APPLICATION_HANDLE
BIGINT
application_handle - Application handle. Only

applicable to APPLICATION, STATISTICS, STATEMENT,
and SORT_PRIVATE memory pool types. Otherwise, the
value is NULL.
EDU_ID
BIGINT
edu_id - Engine dispatchable unit identifier. Only

applicable for memory pools allocated from the
PRIVATE memory set type. Otherwise, the value is
NULL.
MEMORY_POOL_USED
BIGINT
memory_pool_used - Amount of memory pool in use
MEMORY_POOL_USED_HWM
BIGINT
memory_pool_used_hwm - Memory pool high water

mark
MON_GET_MEMORY_SET - get
memory set information:
The MON_GET_MEMORY_SET table function retrieves metrics from the allocated
memory sets, both at the instance level, and for all active databases within the
instance.
Syntax
MON_GET_MEMORY_SET (
memory_set_type
, db_name
member
627

memory_set_type
An input argument of type VARCHAR(32) that specifies the type of the
memory set when calling this function. If the argument is NULL or an empty
string, then metrics are retrieved for all memory sets at the instance and
database level. Otherwise metrics for the specified memory set are retrieved.
These parameter values are accepted:
Value
Scope
Description
DBMS
Instance
DB2 database manager (DBM) memory set
FMP
Instance
Fenced mode process (FMP) memory set
PRIVATE
Instance
Private memory set
DATABASE
Database
Database memory set
APPLICATION
Database
Application memory set
FCM
Host - there is only

Fast communication manager (FCM)
one FCM memory set memory set
allocated per machine
for an instance.
NULL
All
All memory sets at the instance and

database level
db_name
this function.
The database must have a directory entry type of either INDIRECT or
HOME, as returned by a LIST DATABASE DIRECTORY command. The
database must be active. Alternatively, the CURRENT_SERVER special register
can be specified to retrieve metrics from the currently connected database. The
register value contains the actual name of the database, not an alias.
If the argument is NULL or an empty string, metrics are taken from all active
databases in the instance. This input argument applies only to database level
memory sets.
member
data is returned. Specify -1 for the current database member, or -2 for all active
Authorization
v DBADM authority
v SQLADM authority
628

None
Example
Example 1: Retrieve memory set metrics for the current instance and the currently
connected database.
SELECT varchar(memory_set_type, 20) as set_type,
varchar(db_name, 20) as dbname,
memory_set_used,
memory_set_used_hwm
FROM TABLE(
MON_GET_MEMORY_SET(NULL, CURRENT_SERVER, -2))
An example of output from this query.

SET_TYPE
-----------DBMS
FMP
PRIVATE
DATABASE
APPLICATION
DBNAME
MEMORY_SET_USED MEMORY_SET_USED_HWM
---------------- --------------- ------------------86080
87360
0
704
10624
16256
TESTDB
928000
928000
TESTDB
1472
2752
Usage notes
In a partitioned database environment, the fast communication manager (FCM)
memory set is allocated per host; all members on this host machine share this set.
The MON_GET_MEMORY_SET function retrieves data from each member. Since
the FCM memory set is shared among all members on the host, the metrics
reported for FCM memory for each member on the host represent information
about the same shared memory set. For this reason, when examining metrics for
FCM memory, examine the data for each unique host. For hosts with multiple
members, use data from only one member on that host, as the metrics for FCM
memory represent the aggregated total for all members on the given host.
Table 158. Information returned for MON_GET_MEMORY_SET
Column name
Data type
Description
MEMBER
SMALLINT
HOST_NAME
VARCHAR(255)
DB_NAME
VARCHAR(128)
MEMORY_SET_TYPE
VARCHAR(32)
memory_set_type - Memory set type. See the

memory_set_type input parameter for the list of possible
types.
MEMORY_SET_ID
BIGINT
memory_set_id - Memory set identifier.
MEMORY_SET_SIZE
BIGINT
memory_set_size - Memory set size. The value is in KB.
MEMORY_SET_COMMITTED
BIGINT
memory_set_committed - Memory currently committed.

The value is in KB.
MEMORY_SET_USED
BIGINT
memory_set_used - Memory in use by this set. The

value is in KB.
629
Table 158. Information returned for MON_GET_MEMORY_SET (continued)

Column name
Data type
Description
MEMORY_SET_USED_HWM
BIGINT
memory_set_used_hwm - Memory set high water mark.

The value is in KB.
MON_GET_PAGE_ACCESS_INFO table function - Get buffer pool page waiting

information:
The MON_GET_PAGE_ACCESS_INFO table function returns information about
bufferpool pages that are being waited on for a specified table. This is only
applicable to DB2 pureScale instances.
Syntax
MON_GET_PAGE_ACCESS_INFO (
tabschema
tabname
, member

tabschema
An input argument of type VARCHAR(128) that specifies the database schema
to query. If the argument is null or an empty string, information for all
schemas is returned.
tabname
An input argument of type VARCHAR(128) that specifies the table name to
query. If the argument is null or an empty string, information for all tables is
returned.
member
members. If the null value is specified, -1 is set implicitly.
Authorization
v DBADM authority
v SQLADM authority
None
Example
This example returns page reclaim counts for all tables in schema BASETAB on the
currently connected member. It shows that applications are waiting for pages for
table TABLE1 (an example of what could cause this situation is updating different
rows on the same page from two different members).
630
SELECT SUBSTR(TABNAME,1,8) AS NAME,

SUBSTR(OBJTYPE,1,5) AS TYPE,
PAGE_RECLAIMS_X AS PGRCX,
PAGE_RECLAIMS_S AS PGRCS,
SPACEMAPPAGE_PAGE_RECLAIMS_X AS SMPPGRCX,
SPACEMAPPAGE_PAGE_RECLAIMS_S AS SMPPGRCS
FROM TABLE( MON_GET_PAGE_ACCESS_INFO(BASETAB, NULL, NULL) ) AS WAITMETRICS
ORDER BY NAME;

NAME
-------TABLE1
TABLE1
TABLE2
TABLE2
TYPE PGRCX
PGRCS SMPPGRCX SMPPGRCS
----- ------ ----- -------- -------TABLE 12641
320
72
17
INDEX
5042
78
7
0
TABLE
420
12
9
0
INDEX
7
0
0
0
Usage notes
The MON_GET_PAGE_ACCESS_INFO table function returns one or two rows of
data for each table per member that it gathers data from. One row of data shows
information for INDEX pages. The second row shows information for DATA pages.
No aggregation across members is performed.
Table 159. Information returned for MON_GET_PAGE_ACCESS_INFO
Column name
Data type
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
OBJTYPE
VARCHAR(128)
objtype - Object type
MEMBER
SMALLINT
PAGE_RECLAIMS_X
BIGINT
page_reclaims_x - Page reclaims exclusive access
PAGE_RECLAIMS_S
BIGINT
page_reclaims_s - Page reclaims shared access
SPACEMAPPAGE_PAGE_
RECLAIMS_X
BIGINT
spacemappage_page_reclaims_x - Space map page

reclaims exclusive access
SPACEMAPPAGE_PAGE_
RECLAIMS_S
BIGINT
spacemappage_page_reclaims_s - Space map page

reclaims shared access
PAGE_RECLAIMS_INITIATED_X
BIGINT
page_reclaims_initiated_x - Page reclaims initiated

exclusive access
PAGE_RECLAIMS_INITIATED_S
BIGINT
page_reclaims_initiated_s - Page reclaims initiated

shared access
SPACEMAPPAGE_PAGE_
RECLAIMS_INITIATED_X
BIGINT
spacemappage_reclaims_initiated_x - Space map

page reclaims initiated exclusive access
SPACEMAPPAGE_PAGE_
RECLAIMS_INITIATED_S
BIGINT
spacemappage_reclaims_initiated_s - Space map

page reclaims initiated shared access
RECLAIM_WAIT_TIME
BIGINT
BIGINT

DATA_PARTITION_ID
INTEGER
631
Table 159. Information returned for MON_GET_PAGE_ACCESS_INFO (continued)

Column name
Data type
IID
SMALLINT
iid - Index identifier. This monitor element only

returns a value when the OBJTYPE is INDEX and
the index is a nonpartitioned type on a partitioned
table. Otherwise, the value of this monitor element
is NULL.
MON_GET_PKG_CACHE_STMT table function - Get SQL statement activity

metrics in the package cache:
The MON_GET_PKG_CACHE_STMT table function returns a point-in-time view of
both static and dynamic SQL statements in the database package cache.
Syntax
MON_GET_PKG_CACHE_STMT (
executable_id ,
section_type
search_args
, member
,
)


Authorization
v DBADM authority
v SQLADM authority
None
Routine parameters
section_type
An optional input argument (either "D" or "S") of type CHAR(1) that specifies
information type for the returned statement. If the argument is NULL or the
empty string, information is returned for all SQL statements. Not
case-sensitive: D stands for dynamic; S for static.
executable_id
An optional input argument of type VARCHAR (32) for bit data that specifies
a unique section of the database package cache. If a null value is specified,
information is returned for all SQL statements. When the executable_id is
specified, the section_type argument is ignored. For example, if an executable_id
is specified for a dynamic statement, the dynamic statement details will be
returned by this table function even if section_type is specified as static ("S").
search_args
An optional input parameter of type CLOB(1K), that allows you to specify one
or more optional search argument strings. For example:
632
<modified_within>5</modified_within><update_boundary_time>myPkgEvmon
</update_boundary_time>
The available search argument tags are as follows:

v '<modified_within>X</modified_within>'
Returns only those statement entries that have either been inserted into the
cache or executed within the last X minutes (where X is a positive integer
value). If the argument is not specified, all entries in the cache are returned.
v '<update_boundary_time>evmon_name</update_boundary_time>'
Updates the event monitor boundary timestamp to the current time for the
package cache event monitor specified by evmon_name. If this event monitor
specifies where updated_since_boundary_time as an output criteria in its
WHERE clause, only package cache entries that subsequently have their
metrics updated are captured when evicted from the package cache. This
operation only has an effect if the specified package cache event monitor is
active when the command is issued.
Each input argument can be specified only once. The search argument tags
must be specified in lowercase.
member
An optional input argument of type INTEGER that specifies a valid member in
members. If the null value is specified, -1 is set.
Table 160. Information returned for MON_GET_PKG_CACHE_STMT
Column Name
Data Type
MEMBER
SMALLINT
SECTION_TYPE
CHAR(1)
section_type - Section type indicator.
INSERT_TIMESTAMP
TIMESTAMP
insert_timestamp - Statement insert timestamp
EXECUTABLE_ID
VARCHAR(32) FOR executable_id - Executable ID.

BIT DATA
PACKAGE_SCHEMA
VARCHAR(128)
package_schema - Package schema. This output is

valid for static SQL statements only. A NULL value
is returned if the statement is dynamic.
PACKAGE_NAME
VARCHAR(128)
package_name - Package name. This output is valid

for static SQL statements only. A NULL value is
returned if the statement is dynamic.
PACKAGE_VERSION_ID
VARCHAR(64)
package_version_id - Package version. This output

is valid for static SQL statements only. A NULL
value is returned if the statement is dynamic or if
you did not specify the package version for static
statement. An empty string will be returned for
static statement if the package version identifier was
not specified by you when the package was created.
SECTION_NUMBER
BIGINT
section_number - Section number. A NULL value is

EFFECTIVE_ISOLATION
CHAR(2)
effective_isolation - Effective isolation. This is the

isolation value in effect for the section; it can be
different from what it was originally requested at
compilation time.
633
Table 160. Information returned for MON_GET_PKG_CACHE_STMT (continued)

Column Name
Data Type
NUM_EXECUTIONS
BIGINT
num_executions - Statement executions
NUM_EXEC_WITH_METRICS
BIGINT
num_exec_with_metrics - Number of executions

with metrics collected.
PREP_TIME
BIGINT
prep_time - Preparation time Note that PREP_TIME

is only valid for dynamic SQL statements.
PREP_TIME is reported as 0 for static SQL
statements.
TOTAL_ACT_TIME
BIGINT
TOTAL_ACT_WAIT_TIME
BIGINT
TOTAL_CPU_TIME
BIGINT
POOL_READ_TIME
BIGINT

time
POOL_WRITE_TIME
BIGINT

time
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT
LOCK_WAIT_TIME
BIGINT
BIGINT
BIGINT

processing time
TOTAL_SECTION_SORTS
BIGINT
LOCK_ESCALS
BIGINT
LOCK_WAITS
BIGINT
ROWS_MODIFIED
BIGINT
ROWS_READ
BIGINT
ROWS_RETURNED
BIGINT
DIRECT_READS
BIGINT
DIRECT_READ_REQS
BIGINT
DIRECT_WRITES
BIGINT
DIRECT_WRITE_REQS
BIGINT
POOL_DATA_L_READS
BIGINT
BIGINT

data logical reads
POOL_XDA_L_READS
BIGINT
pool_xda_l_reads - Buffer Pool XDA Data Logical

Reads
BIGINT

POOL_INDEX_L_READS
BIGINT
BIGINT

index logical reads
POOL_DATA_P_READS
BIGINT
BIGINT

data physical reads
634

Column Name
Data Type
POOL_XDA_P_READS
BIGINT

reads
BIGINT

POOL_INDEX_P_READS
BIGINT

reads
BIGINT

POOL_DATA_WRITES
BIGINT
POOL_XDA_WRITES
BIGINT
POOL_INDEX_WRITES
BIGINT
TOTAL_SORTS
BIGINT
BIGINT
BIGINT
SORT_OVERFLOWS
BIGINT
BIGINT

queue time
WLM_QUEUE_ASSIGNMENTS_TOTAL BIGINT

DEADLOCKS
BIGINT
FCM_RECV_VOLUME
BIGINT
FCM_RECVS_TOTAL
BIGINT
FCM_SEND_VOLUME
BIGINT
FCM_SENDS_TOTAL
BIGINT
FCM_RECV_WAIT_TIME
BIGINT
FCM_SEND_WAIT_TIME
BIGINT
LOCK_TIMEOUTS
BIGINT
BIGINT
NUM_LOG_BUFFER_FULL
BIGINT
LOG_DISK_WAIT_TIME
BIGINT
BIGINT
LAST_METRICS_UPDATE
TIMESTAMP
last_metrics_update - Metrics last update timestamp
NUM_COORD_EXEC
BIGINT
num_coord_exec - Number of executions by

coordinator agent
NUM_COORD_EXEC_WITH_METRICS BIGINT
num_coord_exec_with_metrics - Number of
executions by coordinator agent
VALID
CHAR(1)
valid - Section validity indicator.
TOTAL_ROUTINE_TIME
BIGINT
BIGINT
ROUTINE_ID
BIGINT
STMT_TYPE_ID
VARCHAR(32)
stmt_type_id - Statement type identifier
QUERY_COST_ESTIMATE
BIGINT
635

Column Name
Data Type
STMT_PKG_CACHE_ID
BIGINT
stmt_pkgcache_id - Statement package cache

identifier
BIGINT

statement by coordinator agent
STMT_EXEC_TIME
BIGINT
TOTAL_SECTION_TIME
BIGINT
BIGINT

time
TOTAL_ROUTINE_NON
_SECT_TIME
BIGINT

execution time
TOTAL_ROUTINE_NON
_SECT_PROC_TIME
BIGINT
processing time
LOCK_WAITS_GLOBAL
BIGINT
BIGINT
BIGINT
BIGINT

escalations
BIGINT

escalations
LOCK_ESCALS_GLOBAL
BIGINT

escalations
RECLAIM_WAIT_TIME
BIGINT
SPACEMAPPAGE_RECLAIM_WAIT
_TIME
BIGINT

reclaim wait time
CF_WAITS
BIGINT
CF_WAIT_TIME
BIGINT
BIGINT

logical reads
BIGINT

physical reads
BIGINT

found data pages
BIGINT

invalid data pages
BIGINT

logical reads
BIGINT

physical reads
BIGINT

index pages found
BIGINT

invalid index pages
BIGINT

BIGINT

636

Column Name
Data Type
BIGINT

data pages found
BIGINT

AUDIT_EVENTS_TOTAL
BIGINT
BIGINT
BIGINT

time
BIGINT

waits
BIGINT

time
BIGINT
BIGINT
BIGINT
BIGINT

volume
BIGINT

wait time
BIGINT

total
BIGINT

volume
BIGINT

wait time
FCM_TQ_RECVS_TOTAL
BIGINT
FCM_TQ_RECV_VOLUME
BIGINT
BIGINT

time
FCM_TQ_SENDS_TOTAL
BIGINT
FCM_TQ_SEND_VOLUME
BIGINT

volume
BIGINT

time
BIGINT

exceeded
THRESH_VIOLATIONS
BIGINT
BIGINT

executions
TOTAL_ROUTINE_USER_CODE_PROC BIGINT
_TIME

BIGINT

code time
TQ_TOT_SEND_SPILLS
BIGINT

buffers overflowed
637

Column Name
Data Type
EVMON_WAIT_TIME
BIGINT
EVMON_WAITS_TOTAL
BIGINT
TOTAL_EXTENDED_LATCH_WAIT
_TIME
BIGINT

latch wait time
BIGINT

waits
MAX_COORD_STMT_EXEC_TIME
BIGINT
max_coord_stmt_exec_time - Maximum coordinator

statement execution time
MAX_COORD_STMT_EXEC
_TIMESTAMP
TIMESTAMP
max_coord_stmt_exec_timestamp - Maximum
coordinator statement execution timestamp monitor
element
BIGINT

queue time
QUERY_DATA_TAG_LIST
VARCHAR(32)
BIGINT

fabrication time
BIGINT
BIGINT

RUNSTATS time
TOTAL_SYNC_RUNSTATS
BIGINT

activities
TOTAL_PEDS
BIGINT
DISABLED_PEDS
BIGINT
POST_THRESHOLD_PEDS
BIGINT

threshold
TOTAL_PEAS
BIGINT
POST_THRESHOLD_PEAS
BIGINT

threshold
BIGINT

requests
BIGINT

rejections
POOL_QUEUED_ASYNC_DATA_REQS BIGINT

POOL_QUEUED_ASYNC_INDEX
_REQS
BIGINT

BIGINT

POOL_QUEUED_ASYNC_TEMP_DATA BIGINT
_REQS

POOL_QUEUED_ASYNC_TEMP
_INDEX_REQS
BIGINT
element
_XDA_REQS
BIGINT

element
638

Column Name
Data Type
POOL_QUEUED_ASYNC_OTHER
_REQS
BIGINT
POOL_QUEUED_ASYNC_DATA
_PAGES
BIGINT

_PAGES
BIGINT

POOL_QUEUED_ASYNC_XDA_PAGES BIGINT

_PAGES

element
_INDEX_PAGES
BIGINT
monitor element
_PAGES
BIGINT

monitor element
BIGINT

BIGINT

BIGINT

_REQS
BIGINT

element
_REQS
BIGINT

element
POOL_FAILED_ASYNC_TEMP_XDA
_REQS
BIGINT

element
BIGINT

PREFETCH_WAIT_TIME
BIGINT
PREFETCH_WAITS
BIGINT

element
_FOUND_IN_LBP
BIGINT
_FOUND_IN_LBP
BIGINT
_FOUND_IN_LBP
BIGINT
NUM_WORKING_COPIES
BIGINT
Number of working copies.
639

Column Name
Data Type
IDA_SEND_WAIT_TIME
BIGINT

IDA_SENDS_TOTAL
BIGINT

IDA_SEND_VOLUME
BIGINT

server to an in-database analytics process. The value
is reported in bytes.
IDA_RECV_WAIT_TIME
BIGINT

IDA_RECVS_TOTAL
BIGINT

IDA_RECV_VOLUME
BIGINT

STMTNO
INTEGER
NUM_ROUTINES
INTEGER
ROWS_DELETED
BIGINT
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
TOTAL_HASH_JOINS
BIGINT
TOTAL_HASH_LOOPS
BIGINT

element
HASH_JOIN_OVERFLOWS
BIGINT

element
BIGINT

POST_SHRTHRESHOLD_HASH_JOINS BIGINT

TOTAL_OLAP_FUNCS
BIGINT

element
OLAP_FUNC_OVERFLOWS
BIGINT

monitor element
INT_ROWS_DELETED
BIGINT

element
INT_ROWS_INSERTED
BIGINT

element
INT_ROWS_UPDATED
BIGINT

element
POOL_COL_L_READS
BIGINT

logical reads
BIGINT

POOL_COL_P_READS
BIGINT

physical reads
BIGINT

640

Column Name
Data Type
BIGINT

POOL_COL_WRITES
BIGINT

writes
BIGINT

BIGINT

BIGINT

POOL_COL_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
BIGINT
prefetch requests
POOL_QUEUED_ASYNC_
TEMP_COL_REQS
BIGINT
POOL_QUEUED_ASYNC_
COL_PAGES
BIGINT
POOL_QUEUED_ASYNC_
TEMP_COL_PAGES
BIGINT
BIGINT
POOL_FAILED_ASYNC_
TEMP_COL_REQS
BIGINT
TOTAL_COL_TIME
BIGINT
TOTAL_COL_PROC_TIME
BIGINT

processing time
BIGINT

executions
COMM_EXIT_WAIT_TIME
BIGINT

wait time
COMM_EXIT_WAITS
BIGINT

number of waits
BIGINT

monitor element
L_READS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
PAGE_WRITES
BIGINT
641

Column Name
Data Type
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
POOL_CACHING_TIER_
PAGE_READ_TIME
BIGINT
POOL_CACHING_TIER_
PAGE_WRITE_TIME
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
TOTAL_HASH_GRPBYS
BIGINT
BIGINT
BIGINT

threshold
642

Column Name
Data Type
BIGINT

STMT_TEXT
CLOB(2M)
stmt_text - SQL statement text
COMP_ENV_DESC
BLOB(10K)
comp_env_desc - Compilation environment handle.

You can use the existing COMPILATION_ENV table
function to get the detailed compilation
environment of the specific statement if needed.
MAX_COORD_STMT_EXEC_TIME
_ARGS
BLOB(10M)
max_coord_stmt_exec_time_args - Maximum
coordinator statement execution time arguments
Usage notes
The MON_GET_PKG_CACHE_STMT table function returns a point-in-time view of
both static and dynamic SQL statements in the database package cache. This allows
you to examine the aggregated metrics for a particular SQL statement, allowing
you to quickly determine the reasons for poor query performance. The metrics
returned are aggregates of the metrics gathered during each execution of the
statement.
It also allows you to compare the behavior of an individual cached section, relative
to the other statements, to assist in identifying the most expensive section or
statements (in terms of the execution costs).
The activity metrics reported by this function are rolled up to the global package
cache at the end of the execution of the activity.
Metrics collection for the execution of any statement is controlled through the
COLLECT ACTIVITY METRICS clause on workloads, or the mon_act_metrics
database configuration parameter at the database level. Metrics are only collected
for executions of the statement if the statement was submitted by a connection
associated with a workload or database for which activity metrics are enabled. The
num_exec_with_metrics element returned by the MON_GET_PKG_CACHE_STMT
function indicates how many executions of the statement have had metrics
collected and have contributed to the aggregate metrics reported. If no metrics are
collected for any execution of the statement, then the num_exec_with_metrics
element is 0 and all metric values are returned as 0.
Example
List all the dynamic SQL statements from the database package cache ordered by
the average CPU time.
db2 SELECT MEMBER,
SECTION_TYPE ,
TOTAL_CPU_TIME/NUM_EXEC_WITH_METRICS as
AVG_CPU_TIME,EXECUTABLE_ID
FROM TABLE(MON_GET_PKG_CACHE_STMT ( D, NULL, NULL, -2)) as T
WHERE T.NUM_EXEC_WITH_METRICS <> 0 ORDER BY AVG_CPU_TIME

MEMBER
-----0
0
SECTION_TYPE AVG_CPU_TIME
------------ -------------------D
754
D
2964
EXECUTABLE_ID
------------------------------------------------------------------x01000000000000007A0000000000000000000000020020081126171554951791
x0100000000000000790000000000000000000000020020081126171533551120
643
0 D
0 D
0 D
5664 x01000000000000007C0000000000000000000000020020081126171720728997
5723 x01000000000000007B0000000000000000000000020020081126171657272914
9762 x01000000000000007D0000000000000000000000020020081126172409987719
Note: It takes a longer time period to build the compilation environment and to
transfer statement text (which can be as large as 2 MB) between members. To
improve performance when retrieving a list of all the statements from the package
cache, do not to select the STMT_TEXT and the COMP_ENV_DESC columns.
With the earlier output, you can use the executable_id to find out the details about
the most expensive statement (in terms of the average CPU time):
db2 SELECT STMT_TEXT FROM TABLE(MON_GET_PKG_CACHE_STMT
(null, x01000000000000007D0000000000000000000000020020081126172409987719, null, -2))
STMT_TEXT
------------------------------------------------------------------------------------------SELECT * FROM EMPLOYEE
As another example, assume a user named Alex has a connection associated to

workload A which has the COLLECT ACTIVITY METRICS set. Another user,
Brent, is associated to workload B that has the COLLECT ACTIVITY METRICS set
to NONE. In addition, the database mon_act_metrics configuration parameter is set
to NONE. When Brent executes the query:
SELECT count(*) FROM syscat.tables
all metrics are returned as 0 and the value of num_exec_with_metrics is also 0.

Then Alex executes the same statement afterwards, but the metrics are collected
this time for the execution of the statement and num_exec_with_metrics increments.
So, after Brent and Alex execute that statement, the result of this query:
SELECT num_executions, num_exec_with_metrics, SUBSTR(stmt_text,1,50) AS stmt_text
FROM TABLE (MON_GET_PKG_CACHE_STMT(d, null, null, -1)) AS tf
WHERE stmt_text LIKE SELECT count%
shows that the SELECT statement ran twice and one of the execution times had the
activity metrics collected.
NUM_EXECUTIONS NUM_EXEC_WITH_METRICS STMT_TEXT
-------------- --------------------- -------------------2
1 SELECT count(*) FROM syscat.tables
MON_GET_PKG_CACHE_STMT_DETAILS - Get detailed metrics for package

cache entries:
The MON_GET_PKG_CACHE_STMT_DETAILS table function returns detailed
metrics for one or more package cache entries.
The metrics returned by the MON_GET_PKG_CACHE_STMT_DETAILS table
function represent the accumulation of all metrics for statements in the package
cache. Statement metrics are rolled up to the package cache upon activity
completion.
Authorization
644
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_PKG_CACHE_STMT_DETAILS (
executable_id ,
search_args
section_type
member

Routine parameters
section_type
An optional input argument (either "D" or "S") of type CHAR(1) that specifies
information type for the returned statement. If the argument is NULL or an
empty string, information is returned for all SQL statements. Not case
sensitive: D stands for dynamic; S for static.
executable_id
An optional input argument of type VARCHAR (32) for bit data that specifies
a unique section of the database package cache. If a null value is specified,
information is returned for all SQL statements. When the executable_id is
specified, the section_type argument is ignored. For example, if an executable_id
is specified for a dynamic statement, the dynamic statement details will be
returned by this table function even if section_type is specified as static ("S").
search_args
An optional input parameter of type CLOB(1K), that allows you to specify one
or more optional search argument strings. For example:
<modified_within>5</modified_within><update_boundary_time>myPkgEvmon
</update_boundary_time>
The available search argument tags are as follows:

v '<modified_within>X</modified_within>'
Returns only those statement entries that have either been inserted into the
cache or executed within the last X minutes (where X is a positive integer
value). If the argument is not specified, all entries in the cache are returned.
v '<update_boundary_time>evmon_name</update_boundary_time>'
Updates the event monitor boundary timestamp to the current time for the
package cache event monitor specified by evmon_name. If this event monitor
specifies where updated_since_boundary_time as an output criteria in its
WHERE clause, only package cache entries that subsequently have their
metrics updated are captured when evicted from the package cache. This
operation only has an effect if the specified package cache event monitor is
active when the command is issued.
v '<stmt_details>true</stmt_details>' or '<stmt_details>false</stmt_details>'
Includes or excludes the stmt_text and comp_env_desc data in the resulting
XML document. This allows you to exclude these relatively large portions of
the document when you do not need them (for example, if you are using the
XML document to provide input for the MON_FORMAT_XML_* table
645
functions that return formatted row-based output). If this argument tag is

not specified, the stmt_text and comp_env_desc data are included by default.
Each input argument can be specified only once. The search argument tags
must be specified in lowercase.
member
members. If the null value is specified, -1 is set.
Table 161. Information returned for MON_GET_PKG_CACHE_STMT_DETAILS
Column Name
Data Type
MEMBER
SMALLINT
SECTION_TYPE
CHAR(1)
EXECUTABLE_ID
VARCHAR(32) FOR executable_id - Executable ID.

BIT DATA
DETAILS
BLOB(20M)
XML document containing detailed metrics for the

unit of work. See Table 162 for a description of the
Table 162. Detailed metrics returned for MON_GET_PKG_CACHE_STMT_DETAILS

Element Name
Data Type
Description
audit_events_total
xs:long
xs:long
xs:long
xs:long

time
xs:long

waits
comp_env_desc
xs:hexBinary(10240)
comp_env_desc - Compilation environment handle.

You can use the existing COMPILATION_ENV table
function to get the detailed compilation environment
of the specific statement if needed.
coord_stmt_exec_time
xs:long
coord_stmt_exec_time - Execution time for statement

by coordinator agent
deadlocks
xs:long
xs:long
xs:long
direct_read_reqs
xs:long
direct_read_time
xs:long
direct_reads
xs:long
direct_write_reqs
xs:long
direct_write_time
xs:long
direct_writes
xs:long
disabled_peds
xs:long
646
Table 162. Detailed metrics returned for MON_GET_PKG_CACHE_STMT_DETAILS (continued)

Element Name
Data Type
Description
effective_isolation
xs:string(2)
effective_isolation - Effective isolation. This is the

isolation value in effect for the section; it can be
different from what it was originally requested at
compilation time.
evmon_wait_time
evmon_waits_total
executable_id
xs:hexBinary(32)
executable_id - Executable ID.
xs:long

volume
xs:long

time
xs:long
xs:long

volume
xs:long

wait time
xs:long
fcm_recv_volume
xs:long
fcm_recv_wait_time
xs:long
fcm_recvs_total
xs:long
fcm_send_volume
xs:long
fcm_send_wait_time
xs:long
fcm_sends_total
xs:long
fcm_tq_recv_volume
xs:long
xs:long

time
fcm_tq_recvs_total
xs:long
fcm_tq_send_volume
xs:long
xs:long

time
fcm_tq_sends_total
xs:long
xs:long
hash_join_overflows
xs:long

element
xs:long

ida_recv_volume

reported in bytes.
ida_recv_wait_time
The total amount of time spent waiting to receive data

ida_recvs_total

647

Element Name
Data Type
Description
ida_send_volume
The total volume of data sent from the database server

to an in-database analytics process. The value is
reported in bytes.
ida_send_wait_time
The total amount of time spent waiting to send data to

ida_sends_total

insert_timestamp
xs:dateTime
insert_timestamp - Statement insert timestamp
int_rows_deleted
xs:long

element
int_rows_inserted
xs:long

element
int_rows_updated
xs:long

element
last_metrics_update
xs:dateTime
last_metrics_update - Metrics last update timestamp
lock_escals
xs:long
lock_timeouts
xs:long
lock_wait_time
xs:long
lock_waits
xs:long
xs:long
log_disk_wait_time
xs:long
xs:long
max_coord_stmt_exec_time
max_coord_stmt_exec_time - Maximum coordinator

statement execution time
max_coord_stmt_exec_time
_args
logical-grouping
max_coord_stmt_exec_time_args - Maximum
coordinator statement execution time arguments
max_coord_stmt_exec
_timestamp
xs:dateTime
max_coord_stmt_exec_timestamp - Maximum
coordinator statement execution timestamp
member
xs:short
num_coord_exec
xs:long
num_coord_exec - Number of executions by

coordinator agent
num_coord_exec_with_metrics
xs:long
num_coord_exec_with_metrics - Number of executions

by coordinator agent with metrics
num_exec_with_metrics
num_exec_with_metrics - Number of executions with

metrics collected.
num_executions
num_log_buffer_full
xs:long
xs:long

exceeded
num_routines
xs:int
num_routines -Number of routines
num_working_copies
xs:long
Number of working copies.
olap_func_overflows
xs:long

monitor element
648

Element Name
Data Type
Description
package_name
xs:string(128)
package_name - Package name. This output is valid for

static SQL statements only. A NULL value is returned
if the statement is dynamic.
package_schema
xs:string(128)
package_schema - Package schema. This output is

valid for static SQL statements only. A NULL value is
package_version_id
xs:string(64)
package_version_id - Package version. This output is

valid for static SQL statements only. This element is
not produced if the statement is dynamic or if you did
not specify the package version for static statement. If
you did not specify the package version identifier
when the package was created, an empty string is
returned for a static statement.
pool_col_gbp_indep_
pages_found_in_lbp

local buffer pool


GBP logical reads

GBP physical reads
pool_col_l_reads

logical reads

pool_col_p_reads

physical reads
pool_col_writes
_found_in_lbp
pool_data_l_reads
xs:long
pool_data_p_reads
xs:long
pool_data_writes
xs:long

prefetch requests



col_reqs
_reqs

element
649

Element Name
Data Type
Description
_reqs

element
_reqs

element

_found_in_lbp
pool_index_l_reads
xs:long
pool_index_p_reads
xs:long
pool_index_writes
xs:long
pool_queued_async_
col_pages
prefetch requests


monitor element
_pages



monitor element
pool_queued_async_
temp_col_pages
pool_queued_async_
temp_col_reqs
_pages

element
_reqs

pool_queued_async_temp_index xs:nonNegativeInteger
_pages

element
pool_queued_async_temp_index xs:nonNegativeInteger
_reqs

_pages

monitor element
_reqs

element
650

Element Name
Data Type
Description

monitor element
pool_read_time
xs:long


xs:long

logical reads
xs:long

physical reads
xs:long

index logical reads
xs:long

xs:long

data physical reads
pool_write_time
xs:long
_found_in_lbp




data pages found
pool_xda_p_reads
xs:long

reads
pool_xda_writes
xs:long
xs:long

xs:long
xs:long

thresholdpost_threshold_hash_grpbys - Hash group by
threshold
xs:long

monitor element
xs:long

monitor element
post_threshold_peas
xs:long

threshold
post_threshold_peds
xs:long
xs:long
651

Element Name
Data Type
Description
prefetch_wait_time
prefetch_waits
prep_time
prep_time - Preparation time Note that PREP_TIME is

only valid for dynamic SQL statements. PREP_TIME is
reported as 0 for static SQL statements.
query_cost_estimate
xs:long
query_data_tag_list
xs:string(32)
routine_id
xs:long
routine_id - Routine ID. For CALL statements provides

the routine identifier for the target procedure. For all
other types of statements the value is 0.
rows_deleted
xs:long
rows_inserted
xs:long
rows_modified
xs:long
rows_read
xs:long
rows_returned
xs:long
rows_updated
xs:long
section_number
xs:short
section_number - Section number. This element is not

produced if the statement is dynamic.
section_type
xs:string(1)
sort_overflows
xs:long
stmt_exec_time
xs:long
stmt_pkg_cache_id
xs:long
stmt_pkgcache_id - Statement package cache identifier
stmt_text
xs:string(2097152)
stmt_type_id
xs:string
stmt_type_id - Statement type identifier
stmt_value_data
xs:string(32768)
stmt_value_data - Value data
stmt_value_index
stmt_value_index - Value index
stmt_value_isnull
xs:string(20)
stmt_value_isnull - Value has null value
stmt_value_isreopt
xs:string(20)
stmt_value_isreopt - Variable used for statement

reoptimization
stmt_value_type
xs:string(255)
stmt_value_type - Value type
stmtno
xs:int
thresh_violations
xs:long
total_act_time
xs:long
total_act_wait_time
xs:long
xs:long

executions
total_col_proc_time

processing time
total_col_time
total_cpu_time
xs:long
xs:long

queue time
652

Element Name
Data Type
Description

wait time
total_hash_grpbys
xs:long
total_hash_joins
xs:long
total_hash_loops
xs:long
total_olap_funcs
xs:long

element
total_peas
xs:long
total_peds
xs:long
xs:long
total_routine_non_
sect_proc_time
xs:long
processing time
total_routine_non_sect_time
xs:long

execution time
total_routine_time
xs:long
total_routine_user_
code_proc_time
xs:long

xs:long

time
xs:long
xs:long

processing time
xs:long
total_section_sorts
xs:long
total_section_time
xs:long
total_sorts
xs:long

time
total_sync_runstats

activities

RUNSTATS time
xs:long

rejections
xs:long
tq_tot_send_spills
xs:long

buffers overflowed
valid
xs:string(1)
valid - Section validity indicator
xs:long

xs:long

queue time
653
Usage notes
The metrics returned by this function represent the accumulation of all metrics for
statements in the package cache. Statement metrics are rolled up to the package
cache upon activity completion.
Examples
The first example demonstrates how to examine the package cache and select the
10 statements that have read and returned the largest number of rows.
Additionally, the results show the cumulative amount of time spent executing each
of these statements (in the STMT_EXEC_TIME output column).
SELECT SUBSTR(DETMETRICS.STMT_TEXT, 1, 40) STMT_TEXT,
DETMETRICS.ROWS_RETURNED,
DETMETRICS.STMT_EXEC_TIME
FROM TABLE(MON_GET_PKG_CACHE_STMT_DETAILS(CAST(NULL AS CHAR(1)),
CAST(NULL AS VARCHAR(32) FOR BIT DATA),
CAST(NULL AS CLOB(1K)), -1)) AS STMT_METRICS,
$DETMETRICS/db2_pkg_cache_stmt_details PASSING
XMLPARSE(DOCUMENT STMT_METRICS.DETAILS) as "DETMETRICS"
COLUMNS "STMT_TEXT" CLOB PATH stmt_text,
"ROWS_RETURNED" BIGINT PATH activity_metrics/rows_returned,
"STMT_EXEC_TIME" BIGINT PATH activity_metrics/stmt_exec_time
) AS DETMETRICS
FETCH FIRST 10 ROWS ONLY

STMT_TEXT
ROWS_RETURNED STMT_EXEC_TIME
---------------------------------------- ------------- -------------SELECT CREATOR, NAME, CTIME FROM SYSIBM.
134
38
SELECT SUBSTR(DETMETRICS.STMT_TEXT, 1, 4
44
336
10
333
SELECT COLNAME, TYPENAME FROM SYSCAT.CO
10
6
10
334
SELECT TRIGNAME FROM SYSCAT.TRIGGERS WH
8
1
SELECT COUNT(*) FROM SYSCAT.TABLESPACES
2
0
SELECT POLICY FROM SYSTOOLS.POLICY WHERE
1
0
CALL SYSPROC.POLICY_INSTALL (I,DB2Tab
1
62
CALL SYSPROC.POLICY_INSTALL (I,DB2Tab
1
64
The second example shows, for dynamic SQL statements that have waited on a
lock while executing, the number of executions, number of lock waits and average
time spent per lock wait. The output shows values accumulated over the lifetime
of the package cache entries, but restricts information to statements that have
executed within the last minute (by setting the modified_within argument tag to
1). The query excludes the statement details (stmt_text and comp_env_desc data)
because they are not required and they are computationally expensive to report (by
setting the stmt_details argument tag to false).
SELECT NUM_EXEC_WITH_METRICS, LOCK_WAITS,
(LOCK_WAIT_TIME / LOCK_WAITS) AVG_LOCK_WAIT_TIME
FROM TABLE(MON_GET_PKG_CACHE_STMT_DETAILS(D, CAST(NULL
AS VARCHAR(32) FOR BIT DATA),
CLOB(
<modified_within>1</modified_within><stmt_details>false</stmt_details>)
, -1))
654
AS STMT_METRICS,
$DETMETRICS/db2_pkg_cache_stmt_details PASSING
XMLPARSE(DOCUMENT STMT_METRICS.DETAILS) as "DETMETRICS"
COLUMNS "NUM_EXEC_WITH_METRICS" BIGINT PATH num_exec_with_metrics,
"LOCK_WAITS" BIGINT PATH lock_waits,
"LOCK_WAIT_TIME" BIGINT PATH activity_metrics/lock_wait_time
) AS DETMETRICS
WHERE LOCK_WAITS <> 0
ORDER BY AVG_LOCK_WAIT_TIME DESC

NUM_EXEC_WITH_METRICS LOCK_WAITS
AVG_LOCK_WAIT_TIME
--------------------- -------------------- -------------------4
2
139
9
3
90
MON_GET_QUEUE_STATS table function - Return threshold queue statistics:

The MON_GET_QUEUE_STATS function returns basic statistics for one or more
threshold queues on all active members. This function returns one row of statistics
Authorization
v
v
v
v

DBADM authority
SQLADM authority
v WLMADM authority
None
Syntax
MON_GET_QUEUE_STATS (
threshold_predicate
threshold_name , threshold_id
threshold_domain


Routine parameters
threshold_predicate
An input argument of type VARCHAR(27) that specifies a threshold predicate.
The possible values are as follows:
CONCDBC
Concurrent database coordinator activities threshold
DBCONN
Total database member connections threshold
SCCONN
Total service class member connections threshold
655
If the argument is null or an empty string, data is returned for all thresholds
that meet the other criteria.
The threshold_predicate values match those of the THRESHOLDPREDICATE
column in the SYSCAT.THRESHOLDS view.
threshold_domain
An input argument of type VARCHAR(18) that specifies a threshold domain.
The possible values are as follows:
DB
Database
SB
Service subclass
SP
Service superclass
WA
Work action set
If the argument is null or an empty string, data is returned for all thresholds
that meet the other criteria.
The threshold_domain values match those of the DOMAIN column in the
SYSCAT.THRESHOLDS view.
threshold_name
An input argument of type VARCHAR(128) that specifies a threshold name. If
the argument is null or an empty string, data is returned for all thresholds that
meet the other criteria. The threshold_name values match those of the
THRESHOLDNAME column in the SYSCAT.THRESHOLDS view.
threshold_id
An input argument of type INTEGER that specifies a threshold ID. If the
argument is null or -1, data is returned for all thresholds that meet the other
criteria. The threshold_id values match those of the THRESHOLDID column in
the SYSCAT.THRESHOLDS view.
Table 163. Information returned by the MON_GET_QUEUE_STATS routine
Column name
Data type
Description
THRESHOLD_PREDICATE
VARCHAR(27)
threshold_predicate - Threshold
predicate monitor element
THRESHOLD_DOMAIN
VARCHAR(18)
threshold_domain - Threshold domain

monitor element
THRESHOLD_NAME
VARCHAR(128)
threshold_name - Threshold name

monitor element
THRESHOLD_ID
INTEGER
thresholdid - Threshold ID monitor

element
DBPARTITIONNUM
SMALLINT

VARCHAR(128)
service_superclass_name - Service
superclass name monitor element
VARCHAR(128)
service_subclass_name - Service
subclass name monitor element
WORK_ACTION_SET_NAME
VARCHAR(128)
work_action_set_name - Work action

set name monitor element
WORK_CLASS_NAME
VARCHAR(128)
work_class_name - Work class name

monitor element
656
Table 163. Information returned by the MON_GET_QUEUE_STATS routine (continued)

Column name
Data type
Description
WORKLOAD_NAME
VARCHAR(128)
workload_name - Workload name

monitor element
LAST_RESET
TIMESTAMP
last_reset - Last Reset Timestamp

monitor element
QUEUE_SIZE_TOP
INTEGER
queue_size_top - Queue size top

monitor element
QUEUE_TIME_TOTAL
BIGINT
queue_time_total - Queue time total

monitor element
QUEUE_ASSIGNMENTS_TOTAL
BIGINT
queue_assignments_total - Queue
assignments total monitor element
QUEUE_SIZE_CURRENT
INTEGER
Number of connections or activities in

the queue.
QUEUE_TIME_LATEST
BIGINT
Time spent in the queue by the last

connection or activity to leave the
queue. Units are milliseconds.
QUEUE_EXIT_TIME_LATEST
TIMESTAMP
Time that the last connection or

activity left the queue.
THRESHOLD_CURRENT_CONCURRENCY
INTEGER
Number of connections or activities

that are currently running according to
the threshold.
THRESHOLD_MAX_CONCURRENCY
INTEGER
Maximum number of connections or

activities that the threshold allows to
be concurrently running.
MEMBER
SMALLINT

element
Usage notes
The function does not aggregate data across queues (on a member) or across
members (for one or more queues). However, you can use SQL queries to
aggregate data, as shown in the example.
Example
The following query displays the basic statistics for all the queues on a system,
across all members:
SELECT substr(THRESHOLD_NAME, 1, 6) THRESHNAME,
THRESHOLD_PREDICATE,
THRESHOLD_DOMAIN,
MEMBER MEMB,
QUEUE_SIZE_TOP,
QUEUE_TIME_TOTAL,
QUEUE_ASSIGNMENTS_TOTAL QUEUE_ASSIGN
FROM table(MON_GET_QUEUE_STATS(, , , -1)) as QSTATS

THRESHNAME
---------LIMIT1
LIMIT2
LIMIT3
THRESHOLD_PREDICATE
--------------------------CONCDBC
SCCONN
DBCONN
THRESHOLD_DOMAIN
-----------------DB
SP
DB
...
...
...
...
...
657
...
...
...
...
...
MEMB QUEUE_SIZE_TOP QUEUE_TIME_TOTAL QUEUE_ASSIGN

---- -------------- ---------------- -----------0
12
1238540
734
0
4
741249
24
0
7
412785
128
MON_GET_REBALANCE_STATUS table function - get rebalance progress for a

table space:
The MON_GET_REBALANCE_STATUS table function returns the status of a
rebalance operation on a table space.
Syntax
MON_GET_REBALANCE_STATUS (
tbsp_name
dbpartitionnum

tbsp_name
An input argument of type VARCHAR(128) that specifies the name of the table
space to query. If the argument value is null, the function returns information
for all table spaces.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
in the same instance as the currently connected database when calling this
function. Specify -1 for the current database partition, or -2 for all database
partitions. If the NULL value is specified, -1 is set implicitly.
Authorization
v DBADM authority
v SQLADM authority
None
Example
List all active rebalance operations on the database and display their current state
and progress.
select
varchar(tbsp_name, 30) as tbsp_name,
dbpartitionnum,
member,
rebalancer_mode,
rebalancer_status,
rebalancer_extents_remaining,
rebalancer_extents_processed,
rebalancer_start_time
from table(mon_get_rebalance_status(NULL,-2)) as t
658
TBSP_NAME
DBPARTITIONNUM MEMBER REBALANCER_MODE
------------------------------ -------------- ------ -----------------------------SYSCATSPACE
0
0 REV_REBAL
REBALANCER_STATUS REBALANCER_EXTENTS_REMAINING REBALANCER_EXTENTS_PROCESSED
----------------- ---------------------------- ---------------------------ACTIVE
6517
4
REBALANCER_START_TIME
-------------------------2011-12-01-12.08.16.000000
Usage notes
The MON_GET_REBALANCE_STATUS table function only returns data for a table
space if a rebalance is in progress. Otherwise, no data is returned.
Table 164. Information returned for MON_GET_REBALANCE_STATUS
Column Name
Data Type
TBSP_NAME
VARCHAR(128)
tablespace_name - Table space name monitor element
TBSP_ID
BIGINT
tablespace_id - Table space identification monitor element
DBPARTITIONNUM
SMALLINT
dbpartitionnum - Database partition number. Indicates the

data being rebalanced.
MEMBER
SMALLINT
member - Database member. Indicates the processing

member doing the rebalance. Rebalance is not supported
on DB2 pureScale
REBALANCER_MODE
VARCHAR(30)
rebalancer_mode - Rebalancer Mode

Rebalancer mode is one of:
v FWD_REBAL
v REV_REBAL
v FWD_REBAL_OF_2PASS
v REV_REBAL_OF_2PASS
REBALANCER_STATUS
VARCHAR(10)
rebalancer_status - Rebalancer status rebalancer_status Rebalancer status
REBALANCER_EXTENTS_
REMAINING
BIGINT
rebalancer_extents_remaining - Total number of extents to

be processed by the rebalancer
REBALANCER_EXTENTS_
PROCESSED
BIGINT
rebalancer_extents_processed - Number of extents the

rebalance has processed
REBALANCER_PRIORITY
BIGINT
rebalancer_priority - Current rebalancer priority
REBALANCER_LAST_
EXTENT_MOVED
BIGINT
rebalancer_last_extent_moved - Last extent moved by the

rebalancer
REBALANCER_START_TIME
TIMESTAMP
rebalancer_start_time - Rebalancer start time
REBALANCER_RESTART_
TIME
TIMESTAMP
rebalancer_restart_time - Rebalancer restart time
REBALANCER_SOURCE_
STORAGE_GROUP_NAME
VARCHAR(128)
rebalancer_source_storage_group_name - Rebalancer source

storage group name
659
Table 164. Information returned for MON_GET_REBALANCE_STATUS (continued)

Column Name
Data Type
REBALANCER_SOURCE_
STORAGE_GROUP_ID
INTEGER
rebalancer_source_storage_group_id - Rebalancer source

storage group identifier
REBALANCER_TARGET_
STORAGE_GROUP_NAME
VARCHAR(128)
rebalancer_target_storage_group_name - Rebalancer target

storage group name
REBALANCER_TARGET_
STORAGE_GROUP_ID
INTEGER
tablespace_rebalancer_target_storage_group_id - Rebalancer
target storage group identifier
MON_GET_ROUTINE table function - get aggregated execution metrics for

routines:
The MON_GET_ROUTINE table function returns aggregated execution metrics for
procedures, external procedures, compiled functions, external functions, compiled
triggers, and anonymous blocks invoked since the database was activated.
Authorization
v SQLADM authority
v DBADM authority
None
Syntax
MON_GET_ROUTINE (
routine_type
routine_module , routine_name
routines_chema
member


Routine parameters
routine_type
An input parameter of type CHAR(2) that specifies the type of routine or
compiled trigger for which data is returned:
v "P" for a procedure
v "SP" for the specific name of a procedure
v "F" for a compiled function
v "SF" for the specific name of a compiled function
v "T" for a compiled trigger
v "C" for a dynamically prepared compound SQL statement or an anonymous
block in PL/SQL
If the "P","F","T" or "C" routine type is specified and no input name is
specified, all routines of the given type will be returned. If the routine type is
"SP" or "SF", the specific name of the routine must be provided.
660
If the routine type is an empty string, NULL, or blanks, all routines of all types
are returned.
routine_schema
An input parameter of type VARCHAR(128) that specifies the schema for the
routine or trigger. For dynamically prepared compound SQL statements or
anonymous blocks, the schema can be determined using the
MON_GET_SECTION_ROUTINES table function. Use NULL or an empty
string to return the routines and triggers in all schemas. This parameter is case
sensitive.
routine_module_name
An input parameter of type VARCHAR(128) that specifies the name of the
module for the input routine, if applicable. Use NULL or an empty string to
return the routines in all modules. This parameter is case sensitive.
routine_name
routine. If the input parameter is "SP" or "SF", the specific name of the routine
must be provided. For dynamically prepared compound SQL statements or
anonymous blocks, the name can be determined using the
string to return all routines that match the other input parameters. This
parameter is case sensitive.
member
the NULL value is specified, -1 is implicitly set.
Table 165. Information returned for MON_GET_ROUTINE
Column name
Data type
Description or corresponding monitor

element
ROUTINE_TYPE
CHAR(1)
routine_type - Routine type monitor element
ROUTINE_SCHEMA
VARCHAR(128)
routine_schema - Routine schema monitor

element
ROUTINE_MODULE_NAME
VARCHAR(128)
routine_module_name - Routine module

ROUTINE_NAME
VARCHAR(128)
routine_name - Routine name monitor

element
SPECIFIC_NAME
VARCHAR(128)
specific_name - Specific name monitor

element
DYN_COMPOUND_EXEC_ID
VARCHAR(32) FOR
BIT DATA
dyn_compound_exec_id - Dynamic
compound statement executable identifier
monitor element
MEMBER
SMALLINT
ROUTINE_ID
INTEGER
SUBROUTINE_ID
INTEGER
subroutine_id - Subroutine identifier monitor

element
LIB_ID
BIGINT
lib_id - Library identifier monitor element
EXEC_LIST_MEM_EXCEEDED
CHAR(1)
exec_list_mem_exceeded - Execution list

memory exceeded monitor element
661
Table 165. Information returned for MON_GET_ROUTINE (continued)

element
Column name
Data type
EXEC_LIST_CLEANUP_TIME
TIMESTAMP
exec_list_cleanup_time - Execution list

cleanup time monitor element
TOTAL_TIMES_ROUTINE_INVOKED
BIGINT
total_times_routine_invoked - Total routine

invoked occurrences monitor element
TOTAL_NESTED_INVOCATIONS
BIGINT
total_nested_invocations - Total nested

invocations monitor element
TOTAL_ROUTINE_COORD_TIME
BIGINT
total_routine_coord_time - Total routine

coordinator time monitor element
ACT_ABORTED_TOTAL
BIGINT
ACT_COMPLETED_TOTAL
BIGINT
act_completed_total - Total completed

activities
ACT_REJECTED_TOTAL
BIGINT
POOL_DATA_L_READS
BIGINT
pool_data_l_reads - Buffer pool data logical

reads
POOL_INDEX_L_READS
BIGINT
pool_index_l_reads - Buffer pool index

logical reads
BIGINT
pool_temp_data_l_reads - Buffer pool

temporary data logical reads
BIGINT

BIGINT
pool_temp_xda_l_reads - Buffer pool

temporary XDA data logical reads
POOL_XDA_L_READS
BIGINT
pool_xda_l_reads - Buffer Pool XDA Data

Logical Reads
POOL_DATA_P_READS
BIGINT
pool_data_p_reads - Buffer pool data

physical reads
POOL_INDEX_P_READS
BIGINT
pool_index_p_reads - Buffer pool index

physical reads
BIGINT
pool_temp_data_p_reads - Buffer pool

temporary data physical reads
BIGINT

BIGINT
pool_temp_xda_p_reads - Buffer pool

temporary XDA data physical reads
POOL_XDA_P_READS
BIGINT

physical reads
POOL_DATA_WRITES
BIGINT
POOL_INDEX_WRITES
BIGINT
POOL_XDA_WRITES
BIGINT
pool_xda_writes - Buffer pool XDA data

writes
POOL_READ_TIME
BIGINT
pool_read_time - Total buffer pool physical

read time
POOL_WRITE_TIME
BIGINT
pool_write_time - Total buffer pool physical

write time
DEADLOCKS
BIGINT
662

Column name
Data type

element
DIRECT_READS
BIGINT
DIRECT_READ_TIME
BIGINT
DIRECT_WRITES
BIGINT
DIRECT_WRITE_TIME
BIGINT
DIRECT_READ_REQS
BIGINT
DIRECT_WRITE_REQS
BIGINT
FCM_RECV_VOLUME
BIGINT
FCM_RECVS_TOTAL
BIGINT
FCM_SEND_VOLUME
BIGINT
FCM_SENDS_TOTAL
BIGINT
FCM_RECV_WAIT_TIME
BIGINT
fcm_recv_wait_time - FCM received wait

time
FCM_SEND_WAIT_TIME
BIGINT
LOCK_ESCALS
BIGINT
LOCK_TIMEOUTS
BIGINT
llock_timeouts - Number of lock timeouts
LOCK_WAIT_TIME
BIGINT
LOCK_WAITS
BIGINT
BIGINT
NUM_LOG_BUFFER_FULL
BIGINT
num_log_buffer_full - Number of times full

log buffer caused agents to wait
LOG_DISK_WAIT_TIME
BIGINT
BIGINT
BIGINT
rqsts_completed_total - Total requests

completed
ROWS_MODIFIED
BIGINT
ROWS_READ
BIGINT
ROWS_RETURNED
BIGINT
TOTAL_APP_RQST_TIME
BIGINT
total_app_rqst_time - Total application

request time
TOTAL_RQST_TIME
BIGINT
total_rqst_time - Total request time.
BIGINT
wlm_queue_time_total - Workload manager

total queue time
BIGINT
manager total queue assignments
TOTAL_CPU_TIME
BIGINT
total_cpu_time - Total CPU time.
TOTAL_WAIT_TIME
BIGINT
BIGINT

requests completed
BIGINT
total_section_sort_time - Total section sort

time
BIGINT
total_section_sort_proc_time - Total section

sort processing time
663

Column name
Data type

element
TOTAL_SECTION_SORTS
BIGINT
TOTAL_SORTS
BIGINT
BIGINT
BIGINT
post_shrthreshold_sorts - Post shared

threshold sorts
SORT_OVERFLOWS
BIGINT
TOTAL_COMPILE_TIME
BIGINT
BIGINT
total_compile_proc_time - Total compile

processing time
TOTAL_COMPILATIONS
BIGINT
BIGINT
total_implicit_compile_time - Total implicit

compile time
BIGINT
total_implicit_compile_proc_time - Total
implicit compile processing time
BIGINT

complications
TOTAL_SECTION_TIME
BIGINT
BIGINT
total_section_proc_time - Total section

processing time
BIGINT
total_app_section_executions - Total
application section executions
TOTAL_ACT_TIME
BIGINT
TOTAL_ACT_WAIT_TIME
BIGINT
ACT_RQSTS_TOTAL
BIGINT
TOTAL_ROUTINE_TIME
BIGINT
total_routine_time - Total routine time.
BIGINT

invocations. The total number of times a
routine was invoked by this routine.
TOTAL_COMMIT_TIME
BIGINT
BIGINT
total_commit_proc_time - Total commits

processing time
TOTAL_APP_COMMITS
BIGINT
total_app_commits - Total application

commits
INT_COMMITS
BIGINT
TOTAL_ROLLBACK_TIME
BIGINT
BIGINT
total_rollback_proc_time - Total rollback

processing time
TOTAL_APP_ROLLBACKS
BIGINT
total_app_rollbacks - Total application

rollbacks
INT_ROLLBACKS
BIGINT
TOTAL_RUNSTATS_TIME
BIGINT
BIGINT
total_runstats_proc_time - Total runtime

statistics processing time
664

Column name
Data type

element
TOTAL_RUNSTATS
BIGINT
TOTAL_REORG_TIME
BIGINT
BIGINT

processing time
TOTAL_REORGS
BIGINT
TOTAL_LOAD_TIME
BIGINT
BIGINT
total_load_proc_time - Total load processing

time
TOTAL_LOADS
BIGINT
CAT_CACHE_INSERTS
BIGINT
CAT_CACHE_LOOKUPS
BIGINT
PKG_CACHE_INSERTS
BIGINT
PKG_CACHE_LOOKUPS
BIGINT
THRESH_VIOLATIONS
BIGINT
thresh_violations - Number of threshold

violations
BIGINT
num_lw_thresh_exceeded - Number of lock

wait thresholds exceeded
LOCK_WAITS_GLOBAL
BIGINT
BIGINT
lock_wait_time_global - Lock wait time

global
BIGINT
BIGINT
lock_escals_maxlocks - Number of maxlocks

lock escalations
BIGINT

escalations
LOCK_ESCALS_GLOBAL
BIGINT

escalations
RECLAIM_WAIT_TIME
BIGINT
BIGINT
spacemappage_reclaim_wait_time - Space
map page reclaim wait time
CF_WAITS
BIGINT
cf_waits - Number of cluster caching facility

waits
CF_WAIT_TIME
BIGINT
cf_wait_time - cluster caching facility wait

time
BIGINT
pool_data_gbp_l_reads - Group buffer pool

data logical reads
BIGINT
pool_data_gbp_p_reads - Group buffer pool

data physical reads
BIGINT
pool_data_lbp_pages_found - Local buffer

pool found data pages
BIGINT

pool invalid data pages
BIGINT

index logical reads
665

element
Column name
Data type
BIGINT

BIGINT
pool_index_lbp_pages_found - Local buffer

pool index pages found
BIGINT
pool_index_gbp_invalid_pages - Group
buffer pool invalid index pages
BIGINT
pool_xda_gbp_l_reads - Group buffer pool

XDA data logical read requests
BIGINT
pool_xda_gbp_p_reads - Group buffer pool

XDA data physical read requests
BIGINT
pool_xda_lbp_pages_found - Local buffer

pool XDA data pages found
BIGINT
pool_xda_gbp_invalid_pages - Group buffer

pool invalid XDA data pages
AUDIT_EVENTS_TOTAL
BIGINT
BIGINT
audit_file_writes_total - Total audit files

written
BIGINT
audit_file_write_wait_time - Audit file write

wait time
BIGINT

subsystem waits
BIGINT
audit_subsystem_wait_time - Audit
subsystem wait time
BIGINT
diaglog_writes_total - Total diagnostic log

file writes
BIGINT
diaglog_write_wait_time - Diagnostic log file

write wait time
BIGINT
fcm_message_recvs_total - Total FCM

message receives
BIGINT

received volume
BIGINT

received wait time
BIGINT
fcm_message_sends_total - Total FCM

message sends
BIGINT
fcm_message_send_volume - FCM message

send volume
BIGINT
fcm_message_send_wait_time - FCM
message send wait time
FCM_TQ_RECVS_TOTAL
BIGINT
fcm_tq_recvs_total - FCM table queue

receives total
FCM_TQ_RECV_VOLUME
BIGINT
fcm_tq_recv_volume - FCM table queue

received volume
BIGINT

received wait time
666

element
Column name
Data type
FCM_TQ_SENDS_TOTAL
BIGINT
fcm_tq_sends_total - FCM table queue send

total
FCM_TQ_SEND_VOLUME
BIGINT
fcm_tq_send_volume - FCM table queue

send volume
BIGINT
fcm_tq_send_wait_time - FCM table queue

send wait time
TOTAL_ROUTINE_USER_
CODE_PROC_TIME
BIGINT
total_routine_user_code_proc_time - Total
routine user code processing time
TOTAL_ROUTINE_USER_
CODE_TIME
BIGINT
total_routine_user_code_time - Total routine

user code time
TQ_TOT_SEND_SPILLS
BIGINT
tq_tot_send_spills - Total number of table

queue buffers overflowed
EVMON_WAIT_TIME
BIGINT
EVMON_WAITS_TOTAL
BIGINT
evmon_waits_total - Event monitor total

waits
TOTAL_EXTENDED_LATCH_
WAIT_TIME
BIGINT
total_extended_latch_wait_time - Total
extended latch wait time
BIGINT
total_extended_latch_waits - Total extended

latch waits
BIGINT

fabrication time
TOTAL_STATS_FABRICATION_
PROC_TIME
BIGINT
total_stats_fabrication_proc_time - Total
statistics fabrication processing time
BIGINT
total_stats_fabrications - Total statistics

fabrications
BIGINT

RUNSTATS time
TOTAL_SYNC_RUNSTATS_
PROC_TIME
BIGINT
total_sync_runstats_proc_time - Total
synchronous RUNSTATS processing time
TOTAL_SYNC_RUNSTATS
BIGINT
total_sync_runstats - Total synchronous

RUNSTATS activities
BIGINT
total_disp_run_queue_time - Total dispatcher

run queue time
TOTAL_PEDS
BIGINT
DISABLED_PEDS
BIGINT
disabled_peds - Disabled partial early

distincts
POST_THRESHOLD_PEDS
BIGINT

threshold
TOTAL_PEAS
BIGINT
POST_THRESHOLD_PEAS
BIGINT
post_threshold_peas - Partial early

aggregation threshold
BIGINT
tq_sort_heap_requests - Table queue sort

heap requests
BIGINT
tq_sort_heap_rejections - Table queue sort

heap rejections
667

element
Column name
Data type
POOL_QUEUED_ASYNC_
DATA_REQS
BIGINT
pool_queued_async_data_reqs - Data
prefetch requests
POOL_QUEUED_ASYNC_
INDEX_REQS
BIGINT
pool_queued_async_index_reqs - Index
prefetch requests
POOL_QUEUED_ASYNC_
XDA_REQS
BIGINT

requests
POOL_QUEUED_ASYNC_
TEMP_DATA_REQS
BIGINT
POOL_QUEUED_ASYNC_
TEMP_INDEX_REQS
BIGINT
POOL_QUEUED_ASYNC_
TEMP_XDA_REQS
BIGINT
pool_queued_async_temp_xda_reqs - XDA
data prefetch requests for temporary table
spaces
POOL_QUEUED_ASYNC_
OTHER_REQS
BIGINT
pool_queued_async_other_reqs - Other
requests handled by prefetchers
POOL_QUEUED_ASYNC_
DATA_PAGES
BIGINT

prefetch requests
POOL_QUEUED_ASYNC_
INDEX_PAGES
BIGINT
pool_queued_async_index_pages - Index
pages prefetch requests
POOL_QUEUED_ASYNC_
XDA_PAGES
BIGINT

prefetch requests
POOL_QUEUED_ASYNC_
TEMP_DATA_PAGES
BIGINT
spaces
POOL_QUEUED_ASYNC_
TEMP_INDEX_PAGES
BIGINT
pool_queued_async_temp_index_pages Index pages prefetch requests for temporary

table spaces
POOL_QUEUED_ASYNC_
TEMP_XDA_PAGES
BIGINT
pool_queued_async_temp_xda_pages - XDA
data pages prefetch requests for temporary
table spaces
POOL_FAILED_ASYNC_
DATA_REQS
BIGINT

prefetch requests
POOL_FAILED_ASYNC_
INDEX_REQS
BIGINT

prefetch requests
POOL_FAILED_ASYNC_
XDA_REQS
BIGINT

prefetch requests
POOL_FAILED_ASYNC_
TEMP_DATA_REQS
BIGINT
pool_failed_async_temp_data_reqs - Failed
spaces
POOL_FAILED_ASYNC_
TEMP_INDEX_REQS
BIGINT
spaces
POOL_FAILED_ASYNC_
TEMP_XDA_REQS
BIGINT
pool_failed_async_temp_xda_reqs - Failed
XDA prefetch requests for temporary table
spaces
POOL_FAILED_ASYNC_
OTHER_REQS
BIGINT
668

element
Column name
Data type
PREFETCH_WAIT_TIME
BIGINT
prefetch_wait_time - Time waited for

prefetch
PREFETCH_WAITS
BIGINT
POOL_DATA_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
pool_data_gbp_indep_pages_found_in_lbp Group buffer pool independent data pages

POOL_INDEX_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT

POOL_XDA_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT

COMM_EXIT_WAIT_TIME
BIGINT
comm_exit_wait_time - Communication
buffer exit wait time
COMM_EXIT_WAITS
BIGINT
comm_exit_waits - Communication buffer

exit number of waits
IDA_SEND_WAIT_TIME
BIGINT
ida_send_wait_time - Time spent waiting to

send data
IDA_SENDS_TOTAL
BIGINT
IDA_SEND_VOLUME
BIGINT
IDA_RECV_WAIT_TIME
BIGINT

receive data
IDA_RECVS_TOTAL
BIGINT
ida_recvs_total - Number of times data

received
IDA_RECV_VOLUME
BIGINT
ida_recv_volume - Total data volume

received
POOL_COL_L_READS
BIGINT
pool_col_l_reads - Buffer pool

column-organized logical reads monitor
element
BIGINT

monitor element
POOL_COL_P_READS
BIGINT
pool_col_p_reads - Buffer pool

column-organized physical reads monitor
element
BIGINT

monitor element
BIGINT

element
POOL_COL_WRITES
BIGINT
pool_col_writes - Buffer pool

BIGINT

element
669

element
Column name
Data type
BIGINT

monitor element
BIGINT

monitor element
POOL_COL_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
pool_col_gbp_indep_pages_found_in_lbp Buffer pool column-organized GBP

monitor element
BIGINT
pool_queued_async_col_reqs Column-organized prefetch requests monitor

element
COL_REQS
BIGINT
pool_queued_async_temp_col_reqs Column-organized temporary prefetch

BIGINT
pool_queued_async_col_pages Column-organized page prefetch requests

monitor element
COL_PAGES
BIGINT

BIGINT

COL_REQS
BIGINT
element
TOTAL_COL_TIME
BIGINT

monitor element
TOTAL_COL_PROC_TIME
BIGINT

BIGINT
total_col_executions - Total
column-organized executions monitor
element
ROWS_DELETED
BIGINT
rows_deleted - Rows deleted monitor

element
ROWS_INSERTED
BIGINT
rows_inserted - Rows inserted monitor

element
ROWS_UPDATED
BIGINT
rows_updated - Rows updated monitor

element
TOTAL_HASH_JOINS
BIGINT

element
TOTAL_HASH_LOOPS
BIGINT

element
HASH_JOIN_OVERFLOWS
BIGINT

monitor element
670

element
Column name
Data type
BIGINT

BIGINT
post_shrthreshold_hash_joins - Post
threshold hash joins monitor element
TOTAL_OLAP_FUNCS
BIGINT
total_olap_funcs - Total OLAP Functions

monitor element
OLAP_FUNC_OVERFLOWS
BIGINT
olap_func_overflows - OLAP Function

DYNAMIC_SQL_STMTS
BIGINT
dynamic_sql_stmts - Dynamic SQL

Statements Attempted monitor element
STATIC_SQL_STMTS
BIGINT
static_sql_stmts - Static SQL Statements

FAILED_SQL_STMTS
BIGINT
failed_sql_stmts - Failed Statement

Operations monitor element
SELECT_SQL_STMTS
BIGINT
select_sql_stmts - Select SQL Statements

UID_SQL_STMTS
BIGINT

DDL_SQL_STMTS
BIGINT
ddl_sql_stmts - Data Definition Language

(DDL) SQL Statements monitor element
MERGE_SQL_STMTS
BIGINT
merge_sql_stmts - Merge SQL statements

executed monitor element
XQUERY_STMTS
BIGINT
xquery_stmts - XQuery Statements

IMPLICIT_REBINDS
BIGINT

monitor element
BINDS_PRECOMPILES
BIGINT
binds_precompiles - Binds/Precompiles
INT_ROWS_DELETED
BIGINT
int_rows_deleted - Internal Rows Deleted

monitor element
INT_ROWS_INSERTED
BIGINT

monitor element
INT_ROWS_UPDATED
BIGINT

monitor element
CALL_SQL_STMTS
BIGINT
call_sql_stmts - CALL SQL statements

BIGINT
post_threshold_hash_joins - Hash Join

Threshold monitor element
POOL_DATA_CACHING_TIER_L_READS
BIGINT
POOL_INDEX_CACHING_TIER_L_READS
BIGINT
POOL_XDA_CACHING_TIER_L_READS
BIGINT
POOL_COL_CACHING_TIER_L_READS
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
671

Column name
Data type

element
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
POOL_CACHING_TIER_
PAGE_READ_TIME
BIGINT
POOL_CACHING_TIER_
PAGE_WRITE_TIME
BIGINT
POOL_DATA_CACHING_
TIER_PAGES_FOUND
BIGINT
POOL_INDEX_CACHING_
TIER_PAGES_FOUND
BIGINT
POOL_XDA_CACHING_
TIER_PAGES_FOUND
BIGINT
POOL_COL_CACHING_
TIER_PAGES_FOUND
BIGINT
POOL_DATA_CACHING_
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
TOTAL_HASH_GRPBYS
BIGINT

operations
BIGINT
hash_grpby_overflows - Hash group by

overflows
BIGINT

threshold
672

Column name
Data type
BIGINT

element
Usage notes
Use the MON_GET_ROUTINE table function to identify the most expensive
routines on the database server.
This table function returns one row of metrics for each routine or trigger and each
member that matches the input arguments. Input argument values are
complementary. Metrics returned are aggregates of all executions of the routine on
that member. No aggregation across members is performed. However, an
aggregation across members is possible through SQL queries (as shown in the
Examples section). If a routine executes subroutines, the work done in the
subroutines is included in the metrics of the parent routine.
Routine monitoring data collection must be explicitly enabled using the
mon_rtn_data database configuration parameter. If this configuration parameter is
set to NONE, no information is returned.
The counters and time-spent monitor elements returned by this table function are
controlled with the COLLECT REQUEST METRICS clause on service classes and
the mon_req_metrics database configuration parameter at the database level. If
neither control is enabled, the counters and time-spent monitor elements reported
are 0.
When the package for a dynamically prepared compound SQL statements is
removed from the package cache, information for this routine is no longer reported
by MON_GET_ROUTINE function. Similarly, when a routine or trigger is dropped,
information about the routine or trigger is no longer reported.
Any routines that were not executed during the previous 24 hour period are
pruned from memory and not returned.
Examples
1. List the highest CPU consuming routines of any type in module MOD1.
SELECT ROUTINE_TYPE, ROUTINE_SCHEMA, ROUTINE_NAME, SPECIFIC_NAME, TOTAL_CPU_TIME
FROM TABLE(MON_GET_ROUTINE(NULL, NULL, MOD1, NULL, NULL))
AS T ORDER BY TOTAL_CPU_TIME DESC
returns
ROUTINE_TYPE
-----------F
F
P
C
P
F
F
ROUTINE_SCHEMA
--------------DRICARD
DRICARD
DRICARD
SYSIBMINTERNAL
SYSPROC
DRICARD
DRICARD
ROUTINE_NAME
--------------------------FUNCTION3
FUNCTION4
P1
COMPILED_ANON_BLOCK_INVOKE
SYSINSTALLOBJECTS
FUNCTION1
FUNCTION2
SPECIFIC_NAME
TOTAL_CPU_TIME
------------------- -------------FUNCTION3
19425
FUNCTION4
5780
SQL120801142627900
4685
SQL120801153841490
3471
SYSINSTALLOBJECTS
1158
FUNCTION1
2632
FUNCTION2
2029
2. List aggregate monitor data for all stored procedures.

SELECT * FROM TABLE(MON_GET_ROUTINE(P, NULL, NULL, NULL, -2)) AS T
673
3. List aggregate monitor data for routines of all types.

SELECT * FROM TABLE(MON_GET_ROUTINE(NULL, NULL, NULL, NULL, -2)) AS T
4. List aggregate monitor data for all procedures named PROC1 in schema TEST.
SELECT * FROM TABLE(MON_GET_ROUTINE(P, TEST, NULL, PROC1, -2)) AS T
5. List aggregate monitor data for overloaded procedure PROC1 with specific
name PROC1_OVERLOAD in schema TEST.
SELECT * FROM TABLE(MON_GET_ROUTINE(SP, TEST, NULL, PROC1_OVERLOAD, -2))
AS T
6. List aggregate monitor data for the anonymous block with executable id
x'0100000000000000520100000000000001000000010020120822205618607103'.
SELECT * FROM TABLE(MON_GET_ROUTINE
(A, MYSCHEMA, NULL, SQL181500027522310, -1)) AS T
WHERE
DYN_COMPOUND_EXEC_ID = x0100000000000000520100000000000001000000010020120822205618607103
MON_GET_ROUTINE_DETAILS table function - get aggregated execution

metric details for routines:
The MON_GET_ROUTINE_DETAILS table function returns aggregated execution
metrics for procedures, external functions, compiled functions, compiled triggers,
and anonymous blocks invoked since the database was activated. The metrics are
returned in an XML document.
Authorization
v SQLADM authority
v DBADM authority
None
Syntax
MON_GET_ROUTINE_DETAILS (
routine_module_name ,
routine_type
routine_name
routine_schema
, member

Routine parameters
routine_type
compiled trigger for which data is returned:
v
v
v
v
v
674
"P" for a procedure

"SP" for the specific name of a procedure
"F" for a compiled function
"SF" for the specific name of a compiled function
"T" for a compiled trigger

v "C" for an anonymous block

If the "P", "F"', "T", or "C" routine type is specified and no input name is
specified, all routines of the given type will be returned. If the routine type is
"SP" or "SF", the specific name of the routine must be provided.
All routines of all types will be returned if the routine type is NULL, an empty
string, or blanks.
routine_schema
routine or trigger. For dynamically prepared compound SQL statements and
PL/SQL anonymous blocks, the schema can be determined using the
sensitive.
routine_module_name
module for the input routine, if applicable. Use NULL or an empty string to
routine_name
should be provided. For dynamically prepared compound SQL statements and
PL/SQL anonymous blocks, the name can be determined using the
string to return all routines matching the other input parameters. This
member
Table 166. Information returned for MON_GET_ROUTINE_DETAILS
monitor element
Column name
Data type
ROUTINE_TYPE
CHAR(1)
routine_type - Routine type monitor

element
ROUTINE_SCHEMA
VARCHAR(128)
routine_schema - Routine schema

monitor element
ROUTINE_MODULE_NAME
VARCHAR(128)
routine_module_name - Routine
module name monitor element
ROUTINE_NAME
VARCHAR(128)
routine_name - Routine name

monitor element
SPECIFIC_NAME
VARCHAR(128)
specific_name - Specific name

monitor element
DYN_COMPOUND_EXEC_ID VARCHAR(32) FOR dyn_compound_exec_id - Dynamic

BIT DATA
compound statement executable
MEMBER
SMALLINT

element
675
Table 166. Information returned for MON_GET_ROUTINE_DETAILS (continued)

monitor element
Column name
Data type
ROUTINE_ID
INTEGER
routine_id - Routine ID monitor

element
SUBROUTINE_ID
INTEGER
subroutine_id - Subroutine identifier

monitor element
LIB_ID
BIGINT
lib_id - Library identifier monitor

element
DETAILS
BLOB(1M)
XML document that contains the

monitor information for the routine.
See Table 2 for a description of the
<db2_routine xmlns="http://www.ibm.com/xmlns/prod/db2/mon" release="100102000">
<routine_type>P</routine_type>
<routine_schema>TEST</routine_schema>
<routine_module></routine_module>
<routine_name>PROC1</routine_name>
...
</system_metrics>
</db2_routine>
See sqllib/misc/DB2MonRoutines.xsd for the full schema.

Table 167. Detailed metrics returned for MON_GET_ROUTINE_DETAILS
Element name
Data type

element
act_aborted_total
xs:long
act_completed_total
xs:long

activities
act_rejected_total
xs:long
act_rqsts_total
xs:long
xs:long

requests completed
audit_events_total
xs:long
xs:long
audit_file_write_wait_time - Audit file write

wait time
xs:long
audit_file_writes_total - Total audit files

written
xs:long
audit_subsystem_wait_time - Audit
subsystem wait time
xs:long

subsystem waits
binds_precompiles
xs:long
binds_precompiles - Binds/Precompiles
call_sql_stmts
xs:long
call_sql_stmts - CALL SQL statements

676
Table 167. Detailed metrics returned for MON_GET_ROUTINE_DETAILS (continued)

Element name
Data type

element
cat_cache_inserts
xs:long
cat_cache_lookups
xs:long
cf_wait_time
xs:long
cf_wait_time - cluster caching facility wait

time
cf_waits
xs:long
cf_waits - Number of cluster caching facility

waits
comm_exit_wait_time
xs:long
comm_exit_wait_time - Communication
buffer exit wait time
comm_exit_waits
xs:long
comm_exit_waits - Communication buffer

exit number of waits
ddl_sql_stmts
xs:long
ddl_sql_stmts - Data Definition Language

(DDL) SQL Statements monitor element
deadlocks
xs:long
xs:long
diaglog_write_wait_time - Diagnostic log file

write wait time
xs:long
diaglog_writes_total - Total diagnostic log

file writes
direct_read_reqs
xs:long
direct_read_time
xs:long
direct_reads
xs:long
direct_write_reqs
xs:long
direct_write_time
xs:long
direct_writes
xs:long
disabled_peds
xs:long
disabled_peds - Disabled partial early

distincts
dyn_compound_exec_id
xs:hexBinary(32)
monitor element
dynamic_sql_stmts
xs:long

Statements Attempted monitor element
evmon_wait_time
xs:long
evmon_waits_total
xs:long
evmon_waits_total - Event monitor total

waits
exec_list_cleanup_time
xs:dateTime
exec_list_cleanup_time - Execution list

cleanup time monitor element
exec_list_mem_exceeded
xs:string(1)
exec_list_mem_exceeded - Execution list

memory exceeded monitor element
failed_sql_stmts
xs:long
failed_sql_stmts - Failed Statement

Operations monitor element
xs:long

received volume
xs:long

received wait time
xs:long
fcm_message_recvs_total - Total FCM

message receives
677

element
Element name
Data type
xs:long
fcm_message_send_volume - FCM message

send volume
xs:long
fcm_message_send_wait_time - FCM
message send wait time
xs:long
fcm_message_sends_total - Total FCM

message sends
fcm_recv_volume
xs:long
fcm_recv_wait_time
xs:long
fcm_recv_wait_time - FCM received wait

time
fcm_recvs_total
xs:long
fcm_send_volume
xs:long
fcm_send_wait_time
xs:long
fcm_sends_total
xs:long
fcm_tq_recv_volume
xs:long
fcm_tq_recv_volume - FCM table queue

received volume
xs:long

received wait time
fcm_tq_recvs_total
xs:long
fcm_tq_recvs_total - FCM table queue

receives total
fcm_tq_send_volume
xs:long
fcm_tq_send_volume - FCM table queue

send volume
xs:long
fcm_tq_send_wait_time - FCM table queue

send wait time
fcm_tq_sends_total
xs:long
fcm_tq_sends_total - FCM table queue send

total
xs:long
hash_grpby_overflows - Hash group by

overflows
hash_join_overflows
xs:long

monitor element
xs:long

ida_recv_volume
xs:long
ida_recv_volume - Total data volume

received
ida_recv_wait_time
xs:long

receive data
ida_recvs_total
xs:long
ida_recvs_total - Number of times data

received
ida_send_volume
xs:long
ida_send_wait_time
xs:long
ida_send_wait_time - Time spent waiting to

send data
ida_sends_total
xs:long
implicit_rebinds
xs:long

monitor element
int_commits
xs:long
int_rollbacks
xs:long
678

element
Element name
Data type
int_rows_deleted
xs:long
int_rows_deleted - Internal Rows Deleted

monitor element
int_rows_inserted
xs:long

monitor element
int_rows_updated
xs:long

monitor element
lib_id
xs:long
lock_escals
xs:long
lock_escals_global
xs:long

escalations
lock_escals_locklist
xs:long

escalations
lock_escals_maxlocks
xs:long
lock_escals_maxlocks - Number of maxlocks

lock escalations
lock_timeouts
xs:long
llock_timeouts - Number of lock timeouts
lock_timeouts_global
xs:long
lock_wait_time
xs:long
lock_wait_time_global
xs:long

global
lock_waits
xs:long
lock_waits_global
xs:long
xs:long
log_disk_wait_time
xs:long
xs:long
member
xs:short
merge_sql_stmts
xs:long
merge_sql_stmts - Merge SQL statements

num_log_buffer_full
xs:long
num_log_buffer_full - Number of times full

log buffer caused agents to wait
xs:long
num_lw_thresh_exceeded - Number of lock

wait thresholds exceeded
olap_func_overflows
xs:long
olap_func_overflows - OLAP Function

pkg_cache_inserts
xs:long
pkg_cache_lookups
xs:long
pool_col_gbp_indep_pages_found_in_lbp
xs:nonNegativeInteger pool_col_gbp_indep_pages_found_in_lbp Buffer pool column-organized GBP

monitor element

monitor element
xs:nonNegativeInteger pool_col_gbp_l_reads - Buffer pool

element
679

element
Element name
Data type
xs:nonNegativeInteger pool_col_gbp_p_reads - Buffer pool

monitor element
pool_col_l_reads
xs:nonNegativeInteger pool_col_l_reads - Buffer pool

column-organized logical reads monitor
element

element
pool_col_p_reads
xs:nonNegativeInteger pool_col_p_reads - Buffer pool

column-organized physical reads monitor
element
pool_col_writes
xs:nonNegativeInteger pool_col_writes - Buffer pool

pool_data_gbp_indep_pages_found_in_lbp
xs:long
pool_data_gbp_indep_pages_found_in_lbp Group buffer pool independent data pages

pool_data_gbp_invalid_pages
xs:long

pool invalid data pages
pool_data_gbp_l_reads
xs:long
pool_data_gbp_l_reads - Group buffer pool

data logical reads
pool_data_gbp_p_reads
xs:long
pool_data_gbp_p_reads - Group buffer pool

data physical reads
pool_data_l_reads
xs:long

reads
pool_data_lbp_pages_found
xs:long
pool_data_lbp_pages_found - Local buffer

pool found data pages
pool_data_p_reads
xs:long

physical reads
pool_data_writes
xs:long
xs:nonNegativeInteger pool_failed_async_col_reqs - Failed

element
xs:long

prefetch requests
xs:long

prefetch requests
xs:long
pool_failed_async_temp_col_reqs

column-organized temporary prefetch
pool_failed_async_temp_data_reqs
xs:long
pool_failed_async_temp_data_reqs - Failed
spaces
pool_failed_async_temp_index_reqs
xs:long
spaces
680

element
Element name
Data type
pool_failed_async_temp_xda_reqs
xs:long
pool_failed_async_temp_xda_reqs - Failed
XDA prefetch requests for temporary table
spaces
xs:long

prefetch requests
pool_index_gbp_indep_pages_found_in_lbp
xs:long

pool_index_gbp_invalid_pages
xs:long
pool_index_gbp_invalid_pages - Group
buffer pool invalid index pages
pool_index_gbp_l_reads
xs:long

index logical reads
pool_index_gbp_p_reads
xs:long

pool_index_l_reads
xs:long

logical reads
pool_index_lbp_pages_found
xs:long
pool_index_lbp_pages_found - Local buffer

pool index pages found
pool_index_p_reads
xs:long

physical reads
pool_index_writes
xs:long
xs:nonNegativeInteger pool_queued_async_col_pages Column-organized page prefetch requests

monitor element
xs:nonNegativeInteger pool_queued_async_col_reqs Column-organized prefetch requests monitor

element
xs:long

prefetch requests
xs:long
pool_queued_async_data_reqs - Data
prefetch requests
pool_queued_async_index_pages
xs:long
pool_queued_async_index_pages - Index
pages prefetch requests
xs:long
pool_queued_async_index_reqs - Index
prefetch requests
xs:long
pool_queued_async_other_reqs - Other
requests handled by prefetchers
pool_queued_async_temp_col_pages
xs:nonNegativeInteger pool_queued_async_temp_col_pages Column-organized page temporary prefetch

pool_queued_async_temp_col_reqs
xs:nonNegativeInteger pool_queued_async_temp_col_reqs Column-organized temporary prefetch

pool_queued_async_temp_data_pages
xs:long
spaces
681

element
Element name
Data type
pool_queued_async_temp_data_reqs
xs:long
pool_queued_async_temp_index_pages
xs:long
pool_queued_async_temp_index_pages Index pages prefetch requests for temporary

table spaces
pool_queued_async_temp_index_reqs
xs:long
pool_queued_async_temp_xda_pages
xs:long
pool_queued_async_temp_xda_pages - XDA
data pages prefetch requests for temporary
table spaces
pool_queued_async_temp_xda_reqs
xs:long
pool_queued_async_temp_xda_reqs - XDA
spaces
xs:long

prefetch requests
xs:long

requests
pool_read_time
xs:long

read time
xs:nonNegativeInteger pool_temp_col_l_reads - Buffer pool

monitor element
xs:nonNegativeInteger pool_temp_col_p_reads - Buffer pool

monitor element
xs:long

xs:long

xs:long

xs:long

xs:long
pool_temp_xda_l_reads - Buffer pool

temporary XDA data logical reads
xs:long
pool_temp_xda_p_reads - Buffer pool

temporary XDA data physical reads
pool_write_time
xs:long

write time
pool_xda_gbp_indep_pages_found_in_lbp
xs:long

xs:long
pool_xda_gbp_invalid_pages - Group buffer

pool invalid XDA data pages
xs:long
pool_xda_gbp_l_reads - Group buffer pool

XDA data logical read requests
682

element
Element name
Data type
xs:long
pool_xda_gbp_p_reads - Group buffer pool

XDA data physical read requests
pool_xda_l_reads
xs:long

Logical Reads
xs:long
pool_xda_lbp_pages_found - Local buffer

pool XDA data pages found
pool_xda_p_reads
xs:long

physical reads
pool_xda_writes
xs:long
pool_xda_writes - Buffer pool XDA data

writes
xs:long
threshold hash joins monitor element
xs:long

threshold sorts
xs:long

thresholdpost_threshold_hash_grpbys - Hash
group by threshold
xs:long
post_threshold_hash_joins - Hash Join

Threshold monitor element
xs:long

post_threshold_peas
xs:long
post_threshold_peas - Partial early

aggregation threshold
post_threshold_peds
xs:long

threshold
xs:long
prefetch_wait_time
xs:long

prefetch
prefetch_waits
xs:long
reclaim_wait_time
xs:long
routine_id
xs:int
routine_module_name
xs:string(128)

routine_name
xs:string(128)

element
routine_schema
xs:string(128)

element
routine_type
xs:string(1)
routine_type - Routine type monitor element
rows_deleted
xs:long
rows_deleted - Rows deleted monitor

element
rows_inserted
xs:long
rows_inserted - Rows inserted monitor

element
rows_modified
xs:long
rows_read
xs:long
rows_returned
xs:long
683

element
Element name
Data type
rows_updated
xs:long
rows_updated - Rows updated monitor

element
xs:long
rqsts_completed_total - Total requests

completed
select_sql_stmts
xs:long
select_sql_stmts - Select SQL Statements

sort_overflows
xs:long
spacemappage_reclaim_wait_time
xs:long
spacemappage_reclaim_wait_time - Space
map page reclaim wait time
specific_name
xs:string(128)

element
static_sql_stmts
xs:long
static_sql_stmts - Static SQL Statements

subroutine_id
xs:int
subroutine_id - Subroutine identifier monitor

element
thresh_violations
xs:long
thresh_violations - Number of threshold

violations
total_act_time
xs:long
total_act_wait_time
xs:long
total_app_commits
xs:long

commits
total_app_rollbacks
xs:long

rollbacks
total_app_rqst_time
xs:long
total_app_rqst_time - Total application

request time
xs:long
total_app_section_executions - Total
application section executions
xs:nonNegativeInteger total_col_executions - Total

column-organized executions monitor
element
total_col_proc_time
xs:nonNegativeInteger total_col_proc_time - Total column-organized

total_col_time

monitor element
xs:long
total_commit_proc_time - Total commits

processing time
total_commit_time
xs:long
total_compilations
xs:long
xs:long
total_compile_proc_time - Total compile

processing time
total_compile_time
xs:long
total_cpu_time
xs:long
total_cpu_time - Total CPU time.
xs:long
total_disp_run_queue_time - Total dispatcher

run queue time
684

element
Element name
Data type
xs:long
total_extended_latch_wait_time - Total
extended latch wait time
xs:long
total_extended_latch_waits - Total extended

latch waits
total_hash_grpbys
xs:long

operations
total_hash_joins
xs:long

element
total_hash_loops
xs:long

element
xs:long

complications
total_implicit_compile_proc_time
xs:long
total_implicit_compile_proc_time - Total
implicit compile processing time
xs:long
total_implicit_compile_time - Total implicit

compile time
xs:long
total_load_proc_time - Total load processing

time
total_load_time
xs:long
total_loads
xs:long
total_nested_invocations
xs:long
total_nested_invocations - Total nested

invocations monitor element
total_olap_funcs
xs:long
total_olap_funcs - Total OLAP Functions

monitor element
total_peas
xs:long
total_peds
xs:long
xs:long

processing time
total_reorg_time
xs:long
total_reorgs
xs:long
xs:long
total_rollback_proc_time - Total rollback

processing time
total_rollback_time
xs:long
total_routine_coord_time
xs:long
total_routine_coord_time - Total routine

coordinator time monitor element
xs:long

invocations. The total number of times a
routine was invoked by this routine.
total_routine_time
xs:long
total_routine_time - Total routine time.
total_routine_user_code_proc_time
xs:long
total_routine_user_code_proc_time - Total
routine user code processing time
xs:long
total_routine_user_code_time - Total routine

user code time
total_rqst_time
xs:long
total_rqst_time - Total request time.
total_runstats
xs:long

685

element
Element name
Data type
xs:long
total_runstats_proc_time - Total runtime

statistics processing time
total_runstats_time
xs:long
xs:long
total_section_proc_time - Total section

processing time
xs:long
total_section_sort_proc_time - Total section

sort processing time
xs:long
total_section_sort_time - Total section sort

time
total_section_sorts
xs:long
total_section_time
xs:long
total_sorts
xs:long
total_stats_fabrication_proc_time
xs:long
total_stats_fabrication_proc_time - Total
statistics fabrication processing time
xs:long

fabrication time
xs:long
total_stats_fabrications - Total statistics

fabrications
total_sync_runstats
xs:long

RUNSTATS activities
xs:long
total_sync_runstats_proc_time - Total
synchronous RUNSTATS processing time
xs:long

RUNSTATS time
total_times_routine_invoked
xs:long
total_times_routine_invoked - Total routine

invoked occurrences monitor element
total_wait_time
xs:long
xs:long
tq_sort_heap_rejections - Table queue sort

heap rejections
xs:long
tq_sort_heap_requests - Table queue sort

heap requests
tq_tot_send_spills
xs:long
tq_tot_send_spills - Total number of table

queue buffers overflowed
uid_sql_stmts
xs:long

xs:long
xs:long
wlm_queue_time_total - Workload manager

total queue time
xquery_stmts
xs:long
xquery_stmts - XQuery Statements

Usage notes
Use the MON_GET_ROUTINE_DETAILS table function to identify the most
expensive routines on the database server.
686
This table function returns one row of metrics for each routine or trigger and each
member that matches the input arguments. Input argument values are
complementary. Metrics returned are aggregates of all executions of the routine on
that member. No aggregation across members is performed. However, an
Examples section). If a routine executes subroutines, the work done in the
subroutines is included in the metrics of the parent routine.
Routine monitoring data collection must be explicitly enabled using the
mon_rtn_data database configuration parameter. If this configuration parameter is
set to NONE, no information is returned.
controlled with the COLLECT REQUEST METRICS clause on service classes and
the mon_req_metrics database configuration parameter at the database level. If
neither control is enabled, the counters and time-spent monitor elements reported
are 0.
When the package for a dynamically prepared compound SQL statement has been
removed from the package cache, information for this routine will no longer be
reported by MON_GET_ROUTINE_DETAILS function. Similarly, when a routine is
dropped, information about the routine is no longer be reported.
Any routines that were not executed during the previous 24 hour period are
pruned from memory and not returned.
Example
List where time was spent during the processing of the TEST.PROC1 stored
procedure, identifying the top 5 areas where time is spent.
SELECT B.* FROM TABLE(MON_GET_ROUTINE_DETAILS(P,TEST,NULL,PROC1, -1))
AS A, TABLE(MON_FORMAT_XML_TIMES_BY_ROW(A.DETAILS)) AS B
ORDER BY TOTAL_TIME_VALUE DESC FETCH FIRST 5 ROWS ONLY
returns
METRIC_NAME
TOTAL_TIME_VALUE COUNT PARENT_METRIC_NAME
--------------------------------- ---------------- ----- -----------------TOTAL_RQST_TIME
1055
0 TOTAL_ROUTINE_USER_CODE_PROC_TIME
673
0 TOTAL_RQST_TIME
TOTAL_WAIT_TIME
317
- TOTAL_RQST_TIME
POOL_READ_TIME
236
142 TOTAL_WAIT_TIME
DIRECT_READ_TIME
81
39 TOTAL_WAIT_TIME
MON_GET_ROUTINE_EXEC_LIST table function - get list of statements

executed by routine:
The MON_GET_ROUTINE_EXEC_LIST table function returns a list of all
statements (sections) executed by each procedure, external function, compiled
function, compiled trigger, and anonymous block invoked since the database was
activated.
687
Authorization
v
v
v
v

SQLADM authority
DBADM authority

None
Syntax
MON_GET_ROUTINE_EXEC_LIST (
routine_module_name ,
routine_type
routine_name
, routine_schema
, member


Routine parameters
routine_type
compiled trigger for which data is be returned:
v "P" for a procedure
v
v
v
v
v
"SP" for the specific name of a procedure

"F" for a compiled function
"SF" for the specific name of a compiled function
"T" for a compiled trigger
"C" for a dynamically prepared compound SQL statement in SQL PL or an
anonymous block in PL/SQL
If the "P", "F", "T", or "C" routine type is specified and no input name is
specified, all routines of the given type are returned. If the routine type is "SP"
or "SF", the specific name of the routine must be provided.
If the routine type is an empty string, NULL, or blanks, all routines of all types
are returned.
routine_schema
routine or trigger. For dynamically prepared compound SQL statements or
anonymous blocks, the schema can be determined using the
sensitive.
routine_module_name
module for the input routine, if applicable. Using NULL or an empty string to
routine_name
688
must be provided. For dynamically prepared compound SQL statements or

anonymous blocks, the name can be determined using the
MON_GET_SECTION_ROUTINES table function. Using NULL or an empty
string to return all routines matching the other input parameters. This
member
Table 168. Information returned for MON_GET_ROUTINE_EXEC_LIST
element
Column name
Data type
ROUTINE_TYPE
CHAR(1)
routine_type - Routine type monitor

element
ROUTINE_SCHEMA
VARCHAR(128)

element
ROUTINE_MODULE_NAME
VARCHAR(128)

ROUTINE_NAME
VARCHAR(128)

element
SPECIFIC_NAME
VARCHAR(128)

element
DYN_COMPOUND_EXEC_ID
VARCHAR(32) FOR
BIT DATA
monitor element
MEMBER
SMALLINT

element
ROUTINE_ID
INTEGER
SUBROUTINE_ID
INTEGER
subroutine_id - Subroutine identifier

monitor element
LIB_ID
BIGINT
SECTION_TYPE
CHAR(1)
PACKAGE_SCHEMA
VARCHAR(128)
package_schema - Package schema.
PACKAGE_NAME
VARCHAR(128)
package_name - Package name.
PACKAGE_VERSION_ID
VARCHAR(64)
package_version_id - Package version ID.
SECTION_NUMBER
BIGINT
section_number - Section number.
STMTNO
INTEGER
stmtno - Statement number monitor

element
EXECUTABLE_ID
VARCHAR(32) FOR
BIT DATA
executable_id - Executable ID.
NUM_ROUTINES
INTEGER
CALL_STMT_ROUTINE_ID
INTEGER
call_stmt_routine_id - Call statement

routine identifier monitor element
CALL_STMT_SUBROUTINE_ID
INTEGER
call_stmt_subroutine_id - Call statement

subroutine identifier monitor element
689
Table 168. Information returned for MON_GET_ROUTINE_EXEC_LIST (continued)

Column name
Data type

element
NUM_EXECUTIONS
BIGINT
num_executions - Statement executions.
NUM_EXEC_WITH_METRICS
BIGINT
num_exec_with_metrics - Number of
executions with metrics collected.
NUM_COORD_EXEC
BIGINT
num_coord_exec - Number of executions

by coordinator agent.
NUM_COORD_EXEC_WITH_METRICS
BIGINT
num_coord_exec_with_metrics - Number of
executions by coordinator agent with
metrics.
BIGINT

statement by coordinator agent
TOTAL_ACT_TIME
BIGINT
TOTAL_ACT_WAIT_TIME
BIGINT
total_act_wait_time - Total activity wait

time
LOCK_WAIT_TIME
BIGINT
LOCK_WAITS
BIGINT
BIGINT
BIGINT

threshold sorts
ROWS_READ
BIGINT
SORT_OVERFLOWS
BIGINT
TOTAL_CPU_TIME
BIGINT
TOTAL_SORTS
BIGINT
Usage notes
The MON_GET_ROUTINE_EXEC_LIST table function returns one row for each
unique statement (section) executed by a routine or trigger. The function also
returns a set of metrics aggregated across all executions of that statement within
the routine or trigger. No aggregation across members is performed. However, an
Examples section).
The aggregate metrics do not include metrics for any child statements. For
example, if a CALL statement is executed by a routine, the metrics returned in
MON_GET_ROUTINE_EXEC_LIST for the CALL statement do not include metrics
for any work executed by other statements invoked by the CALL. The only
exception is coord_stmt_exec_time monitor element that returns the elapsed time
of the statement and so implicitly captures any time spent in child statements.
Routine monitoring data collection and statement monitoring must be explicitly
enabled using the mon_rtn_data and mon_rtn_execlist database configuration
parameters. If these configuration parameters are disabled, no information is
returned.
controlled with the COLLECT ACTIVITY METRICS clause on workloads and the
690
mon_act_metrics database configuration parameter at the database level. If neither

control is enabled, the counters and time-spent monitor elements reported are 0.
When the package for a dynamically prepared compound SQL statement or an
anonymous block is cleaned up from the package cache, information for this
statement is no longer be reported by MON_GET_ROUTINE_EXEC_LIST function.
Similarly, when a routine or trigger is dropped, information about the routine or
trigger is no longer be reported.
Statements executed by routines that were subsequently dropped or not executed
during the previous 24 hour period are pruned from memory and not returned.
Examples
1. List all the statements executed by function TEST.X.
SELECT SUBSTR(P.STMT_TEXT,1,45) AS TEXT
FROM TABLE(MON_GET_ROUTINE_EXEC_LIST(F, TEST, NULL, X, -1))
AS T, TABLE(MON_GET_PKG_CACHE_STMT(NULL,NULL,NULL,-1)) AS P
WHERE T.EXECUTABLE_ID = P.EXECUTABLE_ID
returns
TEXT
--------------------------------------------WITH PID_VALUES (WIDEBAND,ENGN_TEMP) AS SEL
insert into GSO_LOGS values(8.7, 145, 1.406)
call SYSIBMSUBROUTINE.TEST_66613_1157394573()
2. List all the statements in procedure TEST.PROC1 by the percentage of

coordinator statement execution time that they are consuming.
SELECT 100*B.COORD_STMT_EXEC_TIME / A.TOTAL_ROUTINE_COORD_EXEC_TIME
AS PERCENT_EXEC_TIME, SUBSTR(C.STMT_TEXT,1,45)
AS STMT_TEXT FROM TABLE(MON_GET_ROUTINE(SP,NULL,NULL,PROC1, -1)) AS A,
TABLE(MON_GET_ROUTINE_EXEC_LIST(SP,NULL,NULL,PROC1, -1)) AS B,
TABLE(MON_GET_PKG_CACHE_STMT(NULL,NULL,NULL,-1)) AS C
WHERE B.EXECUTABLE_ID = C.EXECUTABLE_ID ORDER BY B.COORD_STMT_EXEC_TIME DESC
returns
PERCENT_EXEC_TIME
-----------------10
3
STMT_TEXT
--------------------------------------------SELECT WAFR, MPHX64, ENGN_RPM FROM KB28_LOGS
SELECT ( ENGN_TQ * ENGN_RPM )/5252 AS HP FRO
MON_GET_RTS_RQST table function - Retrieve information about real-time

statistics requests:
The MON_GET_RTS_RQST table function returns information about all real-time
statistics requests that are pending in the system, and the set of requests that are
currently being processed by the real time statistics daemon (such as on the
real-time statistics processing queue).
Syntax
MON_GET_RTS_RQST ()

691
Authorization
v
v
v
v

DBADM authority
SQLADM authority

None
Example
Display all pending and currently queued or executing real-time statistics requests.
SELECT MEMBER
QUEUE_POSITION,
REQUEST_STATUS,
REQUEST_TYPE,
OBJECT_TYPE,
VARCHAR(OBJECT_SCHEMA, 10) AS SCHEMA,
VARCHAR(OBJECT_NAME, 10) AS NAME
FROM TABLE(MON_GET_RTS_RQST()) AS T

MEMBER QUEUE_POSITION REQUEST_STATUS REQUEST_TYPE
------ -------------- -------------- --------------0
1 EXECUTING
COLLECT_STATS
0
2 QUEUED
COLLECT_STATS
0
3 QUEUED
WRITE_STATS
0
- PENDING
WRITE_STATS
1
- PENDING
COLLECT_STATS
1
- PENDING
WRITE_STATS
2
- PENDING
WRITE_STATS
OBJECT_TYPE
----------TABLE
TABLE
TABLE
TABLE
TABLE
TABLE
TABLE
SCHEMA
--------TEST
TEST
TEST
TEST
TEST
TEST
TEST
NAME
------EMPLOYEE
T1
T3
BLAH
DEPT
SALES
SALARY
Usage notes
The MON_GET_RTS_REQUEST table function returns information about all
real-time statistics requests that are pending on all members. The queue for
processing real-time statistics requests exists only on a single member.
The MON_GET_RTS_REQUEST table function does not report any real-time
statistics requests if real-time statistics collection is not enabled.
Table 169. Information returned for MON_GET_RTS_RQST
Column Name
Data Type
Description
OBJECT_TYPE
VARCHAR(8)
OBJECT_SCHEMA
VARCHAR(128)
OBJECT_NAME
VARCHAR(128)
MEMBER
SMALLINT
692
Table 169. Information returned for MON_GET_RTS_RQST (continued)

Column Name
Data Type
Description
REQUEST_TYPE
VARCHAR(14)
One of:
WRITE_STATS - Request is to write already collected
statistics to the catalogs.
COLLECT_STATS - Request is to perform full statistics
collection.
REQUEST_STATUS
VARCHAR(10)
One of:
PENDING - Request is waiting to be picked up the
real-time statistics daemon
QUEUED - Request has been gathered by the real-time
statistics daemon and is awaiting processing
EXECUTING - Request is currently being processed by
the real-time statistics daemon
REQUEST_TIME
TIMESTAMP
Time that request was submitted.
QUEUE_POSITION
INTEGER
If REQUEST_STATUS is QUEUED, position of the request

in the real-time statistics daemon processing queue.
QUEUE_ENTRY_TIME
TIMESTAMP
If REQUEST_STATUS is QUEUED, time that the request

was added to the real-times statistics daemon processing
queue.
EXECUTION_START_TIME
TIMESTAMP
If REQUEST_STATUS is EXECUTION, time that the

request began execution. NULL otherwise.
MON_GET_SECTION_ROUTINE table function - get list of routines for input

section:
The MON_GET_SECTION_ROUTINE table function returns a list of all procedures,
external functions, compiled functions, and compiled triggers that might be
invoked during the execution of the input section.
Authorization
v SQLADM authority
v DBADM authority
None
Syntax
MON_GET_SECTION_ROUTINE (
executable_id
693
Routine parameters
executable_id
An input parameter of type VARCHAR(32) FOR BIT DATA that uniquely
identifies a section for which the list of routines is to be returned. If this
argument is null, an empty string, or the section cannot be found in memory,
SQL0171 is returned.
Table 170. Information returned for MON_GET_SECTION_ROUTINE
monitor element
Column name
Data type
ROUTINE_TYPE
CHAR(1)
routine_type - Routine type

monitor element
ROUTINE_SCHEMA
VARCHAR(128)
routine_schema - Routine schema

monitor element
ROUTINE_MODULE_NAME
VARCHAR(128)
routine_module_name - Routine
module name monitor element
ROUTINE_NAME
VARCHAR(128)
routine_name - Routine name

monitor element
SPECIFIC_NAME
VARCHAR(128)
specific_name - Specific name

monitor element
ROUTINE_ID
INTEGER
routine_id - Routine ID monitor

element
SUBROUTINE_ID
INTEGER
subroutine_id - Subroutine
LIB_ID
BIGINT
lib_id - Library identifier monitor

element
Usage notes
The input section must reside in the package cache.
Objects returned by this function are not necessarily invoked during execution of
the input section. For example, in the following select statement FUNCTION1 is a
compiled function:
SELECT CASE WHEN COL1 = 0 THEN FUNCTION1() ELSE NULL END AS T1 FROM TABLE1
FThe MON_GET_SECTION_ROUTINE table function will return a row with the

FUNCTION1 function when executable_id is passed as an argument, identifying
the section for this statement. However, FUNCTION1 will be invoked during
execution of the statement only if TABLE1 contains the value 0 for COL1 in one of
its rows.
Examples
1. List all routines that might be executed by the section in the package cache
with executable ID
x'0100000000000000520100000000000001000000010020120822205618607103'.
SELECT * FROM
TABLE(MON_GET_SECTION_ROUTINE(
x0100000000000000520100000000000001000000010020120822205618607103))
AS T
694
returns
ROUTINE_TYPE ROUTINE_SCHEMA
------------ --------------F SPEEDY
P SPEEDY
ROUTINE_MODULE_NAME
------------------TANKS
TANKS
ROUTINE_NAME
-----------ANALYZE_LOG1
POST_PROCESS
...
...
...
...
2. A user notices that the insert statement with executable ID

x'0100000000000000520100000000000001000000010020120822205618607103' ran
for a long time. Run the following statement to check if any compiled triggers
were invoked during the execution of the insert:
SELECT * FROM
TABLE(MON_GET_SECTION_ROUTINE(
x0100000000000000520100000000000001000000010020120822205618607103))
AS T WHERE ROUTINETYPE = T
returns
ROUTINE_TYPE ROUTINE_SCHEMA ROUTINE_MODULE_NAME ROUTINE_NAME
...
------------ -------------- ------------------- ------------------ ...
T MIKE
INVALID_WELD_VALUE ...
P MIKE
INSERT_WELD_SPECS ...
3. Find the internal schema and procedure name for an anonymous block with
executable ID
x'0100000000000000520100000000000001000000010020120822205618607103'.
SELECT ROUTINESCHEMA, ROUTINENAME, SPECIFICNAME
FROM TABLE(MON_GET_SECTION_ROUTINE(
x0100000000000000520100000000000001000000010020120822205618607103))
AS T
returns
ROUTINE_SCHEMA ROUTINE_NAME
SPECIFIC_NAME
...
--------------- ------------------ ------------------ ...
GSOSCHEMA
PING_RUBBLE
SQL120801135351900 ...
MON_GET_SERVERLIST table function - get member priority details:

The MON_GET_SERVERLIST table function returns metrics on the server list for
the currently connected database as cached on one or more members.
For each active member, the server list contains its connectivity and priority
information, which enables a remote client to perform workload balancing (WLB)
and automatic client reroute (ACR). The member parameter corresponds to the
member where the server list is cached.
Syntax
MON_GET_SERVERLIST (
member
, member_subset_name

member
695
Specify -1 for the current database member, or -2 for all database members.
That is, -1 is equivalent to issuing db2pd -serverlist -db dbname, where
dbname is the name of the database currently connected to, only on the current
member, whereas -2 is equivalent to issuing the same command for all
database members. If the NULL value is specified, -1 is set implicitly.
member_subset_name
An input argument of type VARCHAR(128) that identifies the member subset
for which server list metrics should be returned. If the argument is null or the
empty string, metrics are returned for all server lists. The default value is
NULL.
Authorization
v DBADM authority
v SQLADM authority
None
Table 171. Information returned for MON_GET_SERVERLIST
Column name
Data type
Description
MEMBER
SMALLINT
CACHED_TIMESTAMP
TIMESTAMP
cached_timestamp - Cached timestamp
HOSTNAME
VARCHAR(255)
PORT_NUMBER
INTEGER
port_number - Port number
SSL_PORT_NUMBER
INTEGER
ssl_port_number - SSL port number
PRIORITY
SMALLINT
priority - Priority value
MEMBER_SUBSET_ID
INTEGER
Usage notes
v The MON_GET_SERVERLIST table function returns one row for each member
address cached in a server list that matches the input arguments. Each row
contains connectivity information and relative priority which enable a remote
client to perform workload balancing and automatic client reroute.
v The MEMBER column indicates which member cached the server list
information; the SUBSET_ID column indicates what member subset the server
list information was cached for.
Examples
1. Assume a connection to database SAMPLE on member 0, where the database
has been accessed by a remote client. List all server list metrics as cached on
this member for this database:
SELECT MEMBER, CACHED_TIMESTAMP, VARCHAR(HOSTNAME, 30)
AS HOSTNAME, PORT_NUMBER, SSL_PORT_NUMBER, PRIORITY
FROM TABLE (MON_GET_SERVERLIST (-1))
696
Output results for connection to database SAMPLE on member 0.

MEMBER
-----0
0
CACHED_TIMESTAMP
-------------------------2011-02-19-17.39.33.000000
2011-02-19-17.39.33.000000
HOSTNAME
-------------------------coralxib23.torolab.ibm.com
coralxib24.torolab.ibm.com
...
...
...
...

... PORT_NUMBER SSL_PORT_NUMBER PRIORITY
... ----------- ---------------- -------------------------...
49712
0
67
...
49712
0
32
2. Assume a connection to database SAMPLE on member 0 and that the database

has been accessed on both members 0 and 1 by a remote client. List all server
list metrics as cached on both members for this database:
SELECT MEMBER, CACHED_TIMESTAMP, VARCHAR(HOSTNAME, 30)
FROM TABLE (MON_GET_SERVERLIST (-2))
Output results for connection to database SAMPLE on member 0, which is

currently active on members 0 and 1.
MEMBER
-----0
0
1
1
CACHED_TIMESTAMP
-------------------------2011-02-19-17.39.33.000000
2011-02-19-17.39.33.000000
2011-02-19-17.39.33.000000
2011-02-19-17.39.33.000000
HOSTNAME
-------------------------coralxib23.torolab.ibm.com
...
...
...
...
...
...

... PORT_NUMBER SSL_PORT_NUMBER PRIORITY
... ----------- ---------------- -------------------------...
49712
0
67
...
49712
0
32
...
49712
0
32
...
49712
0
67
3. Assume a connection to the database alias MY_ALIAS exists on member 0 and

the database has been accessed on all members. Assume that the connection
has been assigned to the member subset MY_SUBSET which includes members
0 and 1 and excludes member 2. List the server list metrics for the member
subset MY_SUBSET as cached on member 0.
SELECT MEMBER, SUBSET_ID, CACHED_TIMESTAMP, VARCHAR(HOSTNAME, 30)
FROM TABLE (MON_GET_SERVERLIST(0, MY_SUBSET)

MEMBER
-----0
0
SUBSET_ID
--------1
1
CACHED_TIMESTAMP
HOSTNAME
PORT_NUMBER
-------------------------- -------------------------- ----------2011-02-19-17.39.33.000000 coralxib14.torolab.ibm.com 33163
2011-02-19-17.39.33.000000 coralxib15.torolab.ibm.com 33163
MON_GET_SERVICE_SUBCLASS table function - Get service subclass metrics:

The MON_GET_SERVICE_SUBCLASS table function returns metrics for one or
more service subclasses.
Authorization
697
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_SERVICE_SUBCLASS (
service_subclass_name , member


Routine parameters
An input argument of type VARCHAR(128) that specifies a valid service
superclass name in the currently connected database when calling this
function. If the argument is null or an empty string, metrics are retrieved for
all the superclasses in the database.
subclass name in the currently connected database when calling this function.
If the argument is null or an empty string, metrics are retrieved for all the
subclasses in the database.
member
Note: In the rows returned by this function that describe the default subclass
SYSDEFAULTSUBCLASS under the superclass SYSDEFAULTSYSTEMCLASS, all
columns that report metrics have a value of 0.
Table 172. Information returned for MON_GET_SERVICE_SUBCLASS
Column Name
Data Type
VARCHAR(128) service_superclass_name - Service superclass name

monitor element
VARCHAR(128) service_subclass_name - Service subclass name

monitor element
SERVICE_CLASS_ID
INTEGER
MEMBER
SMALLINT
ACT_ABORTED_TOTAL
BIGINT
act_aborted_total - Total aborted activities monitor

element
ACT_COMPLETED_TOTAL
BIGINT

monitor element
698
Description
Table 172. Information returned for MON_GET_SERVICE_SUBCLASS (continued)

Column Name
Data Type
Description
ACT_REJECTED_TOTAL
BIGINT
act_rejected_total - Total rejected activities monitor

element
AGENT_WAIT_TIME
BIGINT
AGENT_WAITS_TOTAL
BIGINT
agent_waits_total - Total agent waits monitor

element
POOL_DATA_L_READS
BIGINT

monitor element
POOL_INDEX_L_READS
BIGINT

monitor element
BIGINT

BIGINT

BIGINT

XDA data logical reads monitor element
POOL_XDA_L_READS
BIGINT

POOL_DATA_P_READS
BIGINT

monitor element
POOL_INDEX_P_READS
BIGINT

BIGINT

BIGINT

BIGINT

POOL_XDA_P_READS
BIGINT

POOL_DATA_WRITES
BIGINT

element
POOL_INDEX_WRITES
BIGINT

monitor element
POOL_XDA_WRITES
BIGINT

monitor element
POOL_READ_TIME
BIGINT

POOL_WRITE_TIME
BIGINT

BIGINT

monitor element
DEADLOCKS
BIGINT
DIRECT_READS
BIGINT
direct_reads - Direct reads from database monitor

element
DIRECT_READ_TIME
BIGINT
DIRECT_WRITES
BIGINT
direct_writes - Direct writes to database monitor

element
699

Column Name
Data Type
Description
DIRECT_WRITE_TIME
BIGINT
direct_write_time - Direct write time monitor

element
DIRECT_READ_REQS
BIGINT

element
DIRECT_WRITE_REQS
BIGINT

element
FCM_RECV_VOLUME
BIGINT

element
FCM_RECVS_TOTAL
BIGINT
fcm_recvs_total - FCM receives total monitor

element
FCM_SEND_VOLUME
BIGINT

element
FCM_SENDS_TOTAL
BIGINT
FCM_RECV_WAIT_TIME
BIGINT

monitor element
FCM_SEND_WAIT_TIME
BIGINT

element
IPC_RECV_VOLUME
BIGINT

IPC_RECV_WAIT_TIME
BIGINT

IPC_RECVS_TOTAL
BIGINT
ipc_recvs_total - Interprocess communication

receives total monitor element
IPC_SEND_VOLUME
BIGINT

send volume monitor element
IPC_SEND_WAIT_TIME
BIGINT

IPC_SENDS_TOTAL
BIGINT

LOCK_ESCALS
BIGINT

element
LOCK_TIMEOUTS
BIGINT

element
LOCK_WAIT_TIME
BIGINT

element
LOCK_WAITS
BIGINT
BIGINT

monitor element
NUM_LOG_BUFFER_FULL
BIGINT

LOG_DISK_WAIT_TIME
BIGINT

element
BIGINT

element
BIGINT

monitor element
ROWS_MODIFIED
BIGINT
700

Column Name
Data Type
Description
ROWS_READ
BIGINT
ROWS_RETURNED
BIGINT
TCPIP_RECV_VOLUME
BIGINT

monitor element
TCPIP_SEND_VOLUME
BIGINT
tcpip_send_volume - TCP/IP send volume monitor

element
BIGINT

monitor element
TCPIP_RECVS_TOTAL
BIGINT
tcpip_recvs_total - TCP/IP receives total monitor

element
BIGINT

monitor element
TCPIP_SENDS_TOTAL
BIGINT
tcpip_sends_total - TCP/IP sends total monitor

element
TOTAL_APP_RQST_TIME
BIGINT

monitor element
TOTAL_RQST_TIME
BIGINT
BIGINT

BIGINT

total queue assignments monitor element
TOTAL_RQST_MAPPED_IN
BIGINT
total_rqst_mapped_in - Total request mapped-in

monitor element
TOTAL_RQST_MAPPED_OUT
BIGINT
total_rqst_mapped_out - Total request mapped-out

monitor element
TOTAL_CPU_TIME
BIGINT
TOTAL_WAIT_TIME
BIGINT
BIGINT

requests completed monitor element
BIGINT

monitor element
BIGINT

TOTAL_SECTION_SORTS
BIGINT

element
TOTAL_SORTS
BIGINT
BIGINT
post_threshold_sorts - Post threshold sorts monitor

element
BIGINT

sorts monitor element
SORT_OVERFLOWS
BIGINT
TOTAL_COMPILE_TIME
BIGINT
total_compile_time - Total compile time monitor

element
BIGINT

701

Column Name
Data Type
Description
TOTAL_COMPILATIONS
BIGINT
total_compilations - Total compilations monitor

element
BIGINT

BIGINT

compile processing time monitor element
BIGINT

complications monitor element
TOTAL_SECTION_TIME
BIGINT

element
BIGINT

BIGINT

TOTAL_ACT_TIME
BIGINT
TOTAL_ACT_WAIT_TIME
BIGINT

monitor element
ACT_RQSTS_TOTAL
BIGINT
act_rqsts_total - Total activity requests monitor

elements
TOTAL_ROUTINE_TIME
BIGINT

element
BIGINT

monitor elements
TOTAL_COMMIT_TIME
BIGINT
total_commit_time - Total commit time monitor

element
BIGINT

TOTAL_APP_COMMITS
BIGINT

monitor elements
INT_COMMITS
BIGINT
TOTAL_ROLLBACK_TIME
BIGINT
total_rollback_time - Total rollback time monitor

element
BIGINT

TOTAL_APP_ROLLBACKS
BIGINT

monitor element
INT_ROLLBACKS
BIGINT
TOTAL_RUNSTATS_TIME
BIGINT

monitor element
BIGINT

TOTAL_RUNSTATS
BIGINT
total_runstats - Total runtime statistics monitor

element
TOTAL_REORG_TIME
BIGINT

element
BIGINT

702

Column Name
Data Type
Description
TOTAL_REORGS
BIGINT
TOTAL_LOAD_TIME
BIGINT
BIGINT

monitor element
TOTAL_LOADS
BIGINT
CAT_CACHE_INSERTS
BIGINT
cat_cache_inserts - Catalog cache inserts monitor

element
CAT_CACHE_LOOKUPS
BIGINT

element
PKG_CACHE_INSERTS
BIGINT
pkg_cache_inserts - Package cache inserts monitor

element
PKG_CACHE_LOOKUPS
BIGINT

monitor element
THRESH_VIOLATIONS
BIGINT

monitor element
BIGINT

LOCK_WAITS_GLOBAL
BIGINT

element
BIGINT

monitor element
BIGINT

monitor element
BIGINT

BIGINT

LOCK_ESCALS_GLOBAL
BIGINT

RECLAIM_WAIT_TIME
BIGINT

element
BIGINT

page reclaim wait time monitor element
CF_WAITS
BIGINT

monitor element
CF_WAIT_TIME
BIGINT

monitor element
BIGINT

BIGINT

BIGINT

BIGINT

BIGINT

703

Column Name
Data Type
Description
BIGINT

BIGINT

BIGINT

BIGINT

data logical read requests monitor element
BIGINT

data physical read requests monitor element
BIGINT

data pages found monitor element
BIGINT

AUDIT_EVENTS_TOTAL
BIGINT

element
BIGINT

monitor element
BIGINT

BIGINT

subsystem waits monitor element
BIGINT

BIGINT
diaglog_writes_total - Total diagnostic log file

BIGINT

BIGINT

BIGINT

BIGINT

BIGINT
fcm_message_sends_total - Total FCM message

sends monitor element
BIGINT

BIGINT

FCM_TQ_RECVS_TOTAL
BIGINT

monitor element
FCM_TQ_RECV_VOLUME
BIGINT

BIGINT

704

Column Name
Data Type
Description
FCM_TQ_SENDS_TOTAL
BIGINT

monitor element
FCM_TQ_SEND_VOLUME
BIGINT

BIGINT

_TIME
BIGINT

BIGINT

TQ_TOT_SEND_SPILLS
BIGINT

EVMON_WAIT_TIME
BIGINT

monitor element
EVMON_WAITS_TOTAL
BIGINT

monitor element
BIGINT

latch wait time monitor element
BIGINT

BIGINT

fabrication time monitor element
TOTAL_STATS_FABRICATION_PROC_TIME BIGINT

fabrication processing time monitor element
BIGINT

monitor elements
BIGINT

RUNSTATS time monitor elements
BIGINT

TOTAL_SYNC_RUNSTATS
BIGINT

BIGINT

TOTAL_PEDS
BIGINT

element
DISABLED_PEDS
BIGINT

monitor element
POST_THRESHOLD_PEDS
BIGINT

TOTAL_PEAS
BIGINT

element
POST_THRESHOLD_PEAS
BIGINT

BIGINT

705

Column Name
Data Type
Description
BIGINT

BIGINT

BIGINT

BIGINT

_REQS
BIGINT

requests for temporary table spaces monitor
element
_REQS
BIGINT
monitor element
_REQS
BIGINT

monitor element
BIGINT
BIGINT

BIGINT

BIGINT

_PAGES
BIGINT

monitor element
_PAGES
BIGINT
monitor element
_PAGES
BIGINT

monitor element
BIGINT

BIGINT

BIGINT

_REQS
BIGINT

monitor element
_REQS
BIGINT

monitor element
BIGINT

monitor element
706

Column Name
Data Type
Description
BIGINT

PREFETCH_WAIT_TIME
BIGINT

monitor element
PREFETCH_WAITS
BIGINT

element
BIGINT

BIGINT

BIGINT

BIGINT

TOTAL_CONNECT_REQUEST_PROC
_TIME
BIGINT

or switch user request processing time monitor
element
BIGINT

_TIME
BIGINT
_PROC_TIME
BIGINT
element
BIGINT
switch user authentications performed monitor
element
POOL_DATA_GBP_INDEP_PAGES_FOUND BIGINT
_IN_LBP
_FOUND_IN_LBP
BIGINT

POOL_XDA_GBP_INDEP_PAGES_FOUND
_IN_LBP
BIGINT
COMM_EXIT_WAIT_TIME
BIGINT

COMM_EXIT_WAITS
BIGINT

IDA_SEND_WAIT_TIME
BIGINT
ida_send_wait_time - Time spent waiting to send

IDA_SENDS_TOTAL
BIGINT

monitor element
IDA_SEND_VOLUME
BIGINT
ida_send_volume - Total data volume sent monitor

element
707

Column Name
Data Type
Description
IDA_RECV_WAIT_TIME
BIGINT
ida_recv_wait_time - Time spent waiting to receive

IDA_RECVS_TOTAL
BIGINT

monitor element
IDA_RECV_VOLUME
BIGINT

monitor element
ROWS_DELETED
BIGINT
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
TOTAL_HASH_JOINS
BIGINT
TOTAL_HASH_LOOPS
BIGINT

element
HASH_JOIN_OVERFLOWS
BIGINT

element
BIGINT

BIGINT

TOTAL_OLAP_FUNCS
BIGINT

element
OLAP_FUNC_OVERFLOWS
BIGINT

monitor element
DYNAMIC_SQL_STMTS
BIGINT

STATIC_SQL_STMTS
BIGINT

monitor element
FAILED_SQL_STMTS
BIGINT

monitor element
SELECT_SQL_STMTS
BIGINT

monitor element
UID_SQL_STMTS
BIGINT

DDL_SQL_STMTS
BIGINT

MERGE_SQL_STMTS
BIGINT
XQUERY_STMTS
BIGINT

monitor element
IMPLICIT_REBINDS
BIGINT
BINDS_PRECOMPILES
BIGINT

monitor element
INT_ROWS_DELETED
BIGINT

element
INT_ROWS_INSERTED
BIGINT

element
INT_ROWS_UPDATED
BIGINT

element
708

Column Name
Data Type
Description
CALL_SQL_STMTS
BIGINT
POOL_COL_L_READS
BIGINT

logical reads
BIGINT

POOL_COL_P_READS
BIGINT

physical reads
BIGINT

BIGINT

POOL_COL_WRITES
BIGINT

writes
BIGINT

BIGINT

BIGINT

POOL_COL_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
BIGINT
prefetch requests
POOL_QUEUED_ASYNC_
TEMP_COL_REQS
BIGINT
POOL_QUEUED_ASYNC_
COL_PAGES
BIGINT
POOL_QUEUED_ASYNC_
TEMP_COL_PAGES
BIGINT

requests
BIGINT
POOL_FAILED_ASYNC_
TEMP_COL_REQS
BIGINT
TOTAL_COL_TIME
BIGINT
TOTAL_COL_PROC_TIME
BIGINT

processing time
BIGINT

executions
BIGINT

monitor element
L_READS
BIGINT
L_READS
BIGINT
709

Column Name
Data Type
Description
POOL_XDA_CACHING_TIER_L_
READS
BIGINT
POOL_COL_CACHING_TIER_L_
READS
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
READ_TIME
BIGINT
WRITE_TIME
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
BIGINT
BIGINT
BIGINT
710

Column Name
Data Type
Description
BIGINT
TOTAL_HASH_GRPBYS
BIGINT
BIGINT
BIGINT

threshold
BIGINT

Usage notes
The metrics returned by the MON_GET_SERVICE_SUBCLASS table function
represent the accumulation of all metrics for requests that have executed under the
indicated service subclass. Metrics are rolled up to a service class on unit of work
boundaries, and periodically during the execution of requests. Therefore, the
values reported by this table function reflect the current state of the system at the
time of the most recent rollup. Metrics are strictly increasing in value. To determine
the value of a given metric for an interval of time, use the
MON_GET_SERVICE_SUBCLASS table function to query the metric at the start
and end of the interval, and compute the difference.
metrics are disabled at the database level and for a service superclass, the metrics
reported for each connection mapped to that service superclass stop increasing (or
remain at 0 if request metrics were disabled at database activation time).
The MON_GET_SERVICE_SUBCLASS table function returns one row of data per
service subclass and per member. No aggregation across service classes (on a
member), or across members (for a service class or more), is performed. However,
aggregation can be achieved through SQL queries as shown in the example. The
input parameters have the effect of being ANDed together. Therefore, if you
specify conflicting input parameters (for example, a superclass name SUPA and
subclass name SUBB that is not a subclass of SUPA), no rows are returned.
Tip: A request might execute in more than one service subclass. For example, this
situation might occur if a request is mapped from one service subclass to another
by using a Workload Manager (WLM) threshold with a REMAP ACTIVITY action.
Although the time spent metrics are updated for each service subclass under which
the request executes, the request counters are incremented for the service subclass
where the request completed. Therefore, you should not analyze the averages of
request times for a single subclass. All subclasses to which an activity can be
mapped must be analyzed in conjunction with one another. For example, if a
threshold exists that can map activities from service subclass A to service subclass
B, then when you compute averages of requests, you should aggregate the
counters and metrics for service subclasses A and B, and compute the averages
using the aggregates.
711
Example
Display the total CPU time used and total number of requests processed for each
service class, ordered by CPU usage.
SELECT varchar(service_superclass_name,30) as service_superclass,
varchar(service_subclass_name,30) as service_subclass,
sum(total_cpu_time) as total_cpu,
sum(app_rqsts_completed_total) as total_rqsts
FROM TABLE(MON_GET_SERVICE_SUBCLASS(,,-2)) AS t
GROUP BY service_superclass_name, service_subclass_name
ORDER BY total_cpu desc

SERVICE_SUPERCLASS
-----------------------------SYSDEFAULTUSERCLASS
SYSDEFAULTMAINTENANCECLASS
SYSDEFAULTSYSTEMCLASS
SERVICE_SUBCLASS
-----------------------------SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
...
...
...
...
...

... TOTAL_CPU
TOTAL_RQSTS
... -------------------- -------------------...
967673
100
.. .
0
0
...
0
0
MON_GET_SERVICE_SUBCLASS_DETAILS table function - Get detailed

service subclass metrics:
The MON_GET_SERVICE_SUBCLASS_DETAILS table function returns detailed
metrics for one or more service subclasses.
Authorization
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_SERVICE_SUBCLASS_DETAILS (
712

Routine parameters
function. If the argument is null or an empty string, metrics are retrieved for
all the superclasses in the database.
If the argument is null or an empty string, metrics are retrieved for all the
subclasses in the database.
member
Table 173. Information returned for MON_GET_SERVICE_SUBCLASS_DETAILS
Column Name
Data Type
Description
SERVICE_SUPERCLASS_NAME VARCHAR(128)
service_superclass_name - Service superclass name
VARCHAR(128)
service_subclass_name - Service subclass name
SERVICE_CLASS_ID
INTEGER
service_class_id - Service class ID
MEMBER
SMALLINT
DETAILS
BLOB(1M)
XML document that contains detailed metrics for the

service class. See Table 174 for a description of the
<db2_service_subclass xmlns="http://www.ibm.com/xmlns/prod/db2/mon" release="90700000">
<service_superclass_name>SYSDEFAULTSYSTEMCLASS</service_superclass_name>
<service_subclass_name>SYSDEFAULTSUBCLASS</service_subclass_name>
<service_subclass_id>11</service_subclass_id>
<member>0</member>
...
</system_metrics>
</db2_service_subclass>

Table 174. Detailed metrics returned for MON_GET_SERVICE_SUBCLASS_DETAILS
Element Name
Data Type
act_aborted_total
xs:nonNegativeInteger act_aborted_total - Total aborted activities
act_completed_total
xs:nonNegativeInteger act_completed_total - Total completed activities
act_rejected_total
xs:nonNegativeInteger act_rejected_total - Total rejected activities
act_rqsts_total
xs:nonNegativeInteger act_rqsts_total - Total activity requests
agent_wait_time
xs:nonNegativeInteger agent_wait_time - Agent wait time

713
Table 174. Detailed metrics returned for MON_GET_SERVICE_SUBCLASS_DETAILS (continued)

Element Name
Data Type
agent_waits_total
xs:nonNegativeInteger agent_waits_total - Total agent waits
xs:nonNegativeInteger app_act_aborted_total - Total failed external coordinator

xs:nonNegativeInteger app_act_completed_total - Total successful external

xs:nonNegativeInteger app_act_rejected_total - Total rejected external coordinator

xs:nonNegativeInteger app_rqsts_completed_total - Total application requests

completed
audit_events_total
xs:nonNegativeInteger audit_events_total - Total audit events
xs:nonNegativeInteger audit_file_write_wait_time - Audit file write wait time
xs:nonNegativeInteger audit_file_writes_total - Total Audit files written
xs:nonNegativeInteger audit_subsystem_wait_time - Audit subsystem wait time
xs:nonNegativeInteger audit_subsystem_waits_total - Total audit subsystem waits
binds_precompiles
xs:long

monitor element
call_sql_stmts
xs:long
call_sql_stmts - CALL SQL statements executed monitor

element
cat_cache_inserts
xs:nonNegativeInteger cat_cache_inserts - Catalog cache inserts
cat_cache_lookups
xs:nonNegativeInteger cat_cache_lookups - Catalog cache lookups
xs:nonNegativeInteger client_idle_wait_time - Client idle wait time
comm_exit_wait_time
xs:nonNegativeInteger comm_exit_wait_time - Communication buffer exit wait

comm_exit_waits
xs:nonNegativeInteger comm_exit_waits - Communication buffer exit number of

ddl_sql_stmts
xs:long
deadlocks
xs:nonNegativeInteger deadlocks - Deadlocks detected
xs:nonNegativeInteger diaglog_write_wait_time - Diag log write time
xs:nonNegativeInteger diaglog_writes_total - Diag log total writes
direct_read_reqs
xs:nonNegativeInteger direct_read_reqs - Direct read requests
direct_read_time
xs:nonNegativeInteger direct_read_time - Direct read time
direct_reads
xs:nonNegativeInteger direct_reads - Direct reads from database
direct_write_reqs
xs:nonNegativeInteger direct_write_reqs - Direct write requests
direct_write_time
xs:nonNegativeInteger direct_write_time - Direct write time
direct_writes
xs:nonNegativeInteger direct_writes - Direct writes to database
disabled_peds
xs:long
dynamic_sql_stmts
xs:long
dynamic_sql_stmts - Dynamic SQL Statements Attempted

monitor element
evmon_wait_time
xs:nonNegativeInteger evmon_wait_time - Event monitor wait time
evmon_waits_total
xs:nonNegativeInteger evmon_waits_total - Event monitor total waits
failed_sql_stmts
xs:long
714


element

Element Name
Data Type
xs:nonNegativeInteger fcm_message_recv_volume - FCM message recv volume
xs:nonNegativeInteger fcm_message_recv_wait_time - FCM message recv wait

time
xs:nonNegativeInteger fcm_message_recvs_total - FCM message recvs total
xs:nonNegativeInteger fcm_message_send_volume - FCM message send volume
xs:nonNegativeInteger fcm_message_send_wait_time - FCM message send wait

time
xs:nonNegativeInteger fcm_message_sends_total - FCM message sends total
fcm_recv_volume
xs:nonNegativeInteger fcm_recv_volume - FCM recv volume
fcm_recv_wait_time
xs:nonNegativeInteger fcm_recv_wait_time - FCM recv wait time
fcm_recvs_total
xs:nonNegativeInteger fcm_recvs_total - FCM recvs total
fcm_send_volume
xs:nonNegativeInteger fcm_send_volume - FCM send volume
fcm_send_wait_time
xs:nonNegativeInteger fcm_send_wait_time - FCM send wait time
fcm_sends_total
xs:nonNegativeInteger fcm_sends_total - FCM sends total
fcm_tq_recv_volume
xs:nonNegativeInteger fcm_tq_recv_volume - FCM tablequeue recv volume
xs:nonNegativeInteger fcm_tq_recv_wait_time - FCM tablequeue recv wait time
fcm_tq_recvs_total
xs:nonNegativeInteger fcm_tq_recvs_total - FCM tablequeue recvs total
fcm_tq_send_volume
xs:nonNegativeInteger fcm_tq_send_volume - FCM tablequeue send volume
xs:nonNegativeInteger fcm_tq_send_wait_time - FCM tablequeue send wait time
fcm_tq_sends_total
xs:nonNegativeInteger fcm_tq_sends_total - FCM tablequeue send total
xs:long
hash_join_overflows
xs:long

element
xs:long

monitor element
ida_recv_volume
xs:nonNegativeInteger The total volume of data the database server received

reported in bytes.
ida_recv_wait_time
xs:nonNegativeInteger The total amount of time spent waiting to receive data

ida_recvs_total
xs:nonNegativeInteger The total number of times data was received from an

ida_send_volume
xs:nonNegativeInteger The total volume of data sent from the database server to
an in-database analytics process. The value is reported in
bytes.
ida_send_wait_time
xs:nonNegativeInteger The total amount of time spent waiting to send data to an

ida_sends_total
xs:nonNegativeInteger The total number of times data was sent to an in-database

analytics process.
implicit_rebinds
xs:long
int_commits
xs:nonNegativeInteger int_commits - Internal commits
int_rollbacks
xs:nonNegativeInteger int_rollbacks - Internal rollbacks
implicit_rebinds - Number of implicit rebinds monitor

element
715

Element Name
Data Type
int_rows_deleted
xs:long

element
int_rows_inserted
xs:long

element
int_rows_updated
xs:long

element
ipc_recv_volume
xs:nonNegativeInteger ipc_recv_volume - Interprocess communication recv

volume
ipc_recv_wait_time
xs:nonNegativeInteger ipc_recv_wait_time - Interprocess communication recv

wait time
ipc_recvs_total
xs:nonNegativeInteger ipc_recvs_total - Interprocess communication recvs total
ipc_send_volume
xs:nonNegativeInteger ipc_send_volume - Interprocess communication send

volume
ipc_send_wait_time
xs:nonNegativeInteger ipc_send_wait_time - Interprocess communication send

wait time
ipc_sends_total
xs:nonNegativeInteger ipc_sends_total - Interprocess communication send total
lock_escals
xs:nonNegativeInteger lock_escals - Number of lock escalations
lock_timeouts
xs:nonNegativeInteger lock_timeouts - Number of lock timeouts
lock_wait_time
xs:nonNegativeInteger lock_wait_time - Time waited on locks
lock_waits
xs:nonNegativeInteger lock_waits - Lock waits
xs:nonNegativeInteger log_buffer_wait_time - Log buffer wait time
log_disk_wait_time
xs:nonNegativeInteger log_disk_wait_time - Log disk wait time
xs:nonNegativeInteger log_disk_waits_total - Log disk waits total
member
xs:nonNegativeInteger member - Database member
merge_sql_stmts
xs:long
num_log_buffer_full
xs:nonNegativeInteger num_log_buffer_full - Number of full log buffers
xs:nonNegativeInteger num_lw_thresh_exceeded - Number of thresholds

exceeded
olap_func_overflows
xs:long
pkg_cache_inserts
xs:nonNegativeInteger pkg_cache_inserts - Package cache inserts
pkg_cache_lookups
xs:nonNegativeInteger pkg_cache_lookups - Package cache lookups
pool_col_gbp_indep_
pages_found_in_lbp
xs:nonNegativeInteger pool_col_gbp_indep_pages_found_in_lbp - Buffer pool

buffer pool

xs:nonNegativeInteger pool_col_gbp_l_reads - Buffer pool column-organized

GBP logical reads
xs:nonNegativeInteger pool_col_gbp_p_reads - Buffer pool column-organized

GBP physical reads
pool_col_l_reads
xs:nonNegativeInteger pool_col_l_reads - Buffer pool column-organized logical

reads
716

monitor element

element

Element Name
Data Type

pool_col_p_reads
xs:nonNegativeInteger pool_col_p_reads - Buffer pool column-organized physical

reads
pool_col_writes
xs:nonNegativeInteger pool_col_writes - Buffer pool column-organized writes
_found_in_lbp
xs:nonNegativeInteger pool_data_gbp_indep_pages_found_in_lbp - Group buffer

monitor element
pool_data_l_reads
xs:nonNegativeInteger pool_data_l_reads - Buffer pool data logical reads
pool_data_p_reads
xs:nonNegativeInteger pool_data_p_reads - Buffer pool data physical reads
pool_data_writes
xs:nonNegativeInteger pool_data_writes - Buffer pool data writes
xs:nonNegativeInteger pool_failed_async_col_reqs - Failed column-organized

prefetch requests
xs:nonNegativeInteger pool_failed_async_data_reqs - Failed data prefetch

xs:nonNegativeInteger pool_failed_async_index_reqs - Failed index prefetch

xs:nonNegativeInteger pool_failed_async_other_reqs - Failed non-prefetch

col_reqs

_reqs
xs:nonNegativeInteger pool_failed_async_temp_data_reqs - Failed data prefetch

_reqs
xs:nonNegativeInteger pool_failed_async_temp_index_reqs - Failed index

element
_reqs
xs:nonNegativeInteger pool_failed_async_temp_xda_reqs - Failed XDA prefetch

xs:nonNegativeInteger pool_failed_async_xda_reqs - Failed XDA prefetch

_found_in_lbp
xs:nonNegativeInteger pool_index_gbp_indep_pages_found_in_lbp - Group

pool_index_l_reads
xs:nonNegativeInteger pool_index_l_reads - Buffer pool index logical reads
pool_index_p_reads
xs:nonNegativeInteger pool_index_p_reads - Buffer pool index physical reads
pool_index_writes
xs:nonNegativeInteger pool_index_writes - Buffer pool index writes
pool_queued_async_
col_pages
xs:nonNegativeInteger pool_queued_async_col_pages - Column-organized page

prefetch requests
xs:nonNegativeInteger pool_queued_async_col_reqs - Column-organized prefetch

requests
pool_queued_async_data_pages xs:nonNegativeInteger pool_queued_async_data_pages - Data pages prefetch

xs:nonNegativeInteger pool_queued_async_data_reqs - Data prefetch requests

monitor element
_pages
xs:nonNegativeInteger pool_queued_async_index_pages - Index pages prefetch

717

Element Name
Data Type
xs:nonNegativeInteger pool_queued_async_index_reqs - Index prefetch requests

monitor element
xs:nonNegativeInteger pool_queued_async_other_reqs - Non-prefetch requests

monitor element
pool_queued_async_
temp_col_pages
xs:nonNegativeInteger pool_queued_async_temp_col_pages - Column-organized

pool_queued_async_
temp_col_reqs
xs:nonNegativeInteger pool_queued_async_temp_col_reqs - Column-organized

_pages
xs:nonNegativeInteger pool_queued_async_temp_data_pages - Data pages

element
_reqs
xs:nonNegativeInteger pool_queued_async_temp_data_reqs - Data prefetch

pool_queued_async_temp_index xs:nonNegativeInteger pool_queued_async_temp_index_pages - Index pages

_pages
element
pool_queued_async_temp_index xs:nonNegativeInteger pool_queued_async_temp_index_reqs - Index prefetch
_reqs
_pages
xs:nonNegativeInteger pool_queued_async_temp_xda_pages - XDA data pages

element
_reqs
xs:nonNegativeInteger pool_queued_async_temp_xda_reqs - XDA data prefetch

xs:nonNegativeInteger pool_queued_async_xda_reqs - XDA prefetch requests

monitor element
pool_read_time
xs:nonNegativeInteger pool_read_time - Total buffer pool physical read time
xs:nonNegativeInteger pool_temp_col_l_reads - Buffer pool column-organized

xs:nonNegativeInteger pool_temp_col_p_reads - Buffer pool column-organized

xs:nonNegativeInteger pool_temp_data_l_reads - Buffer pool temporary data

logical reads
xs:nonNegativeInteger pool_temp_data_p_reads - Buffer pool temporary data

physical reads
xs:nonNegativeInteger pool_temp_index_l_reads - Buffer pool temporary index

logical reads
xs:nonNegativeInteger pool_temp_index_p_reads - Buffer pool temporary index

physical reads
xs:nonNegativeInteger pool_temp_xda_l_reads - Buffer pool temporary XDA data

logical reads
xs:nonNegativeInteger pool_temp_xda_p_reads - Buffer pool temporary XDA

data physical reads
pool_write_time
xs:nonNegativeInteger pool_write_time - Total buffer pool physical write time
_found_in_lbp
xs:nonNegativeInteger pool_xda_gbp_indep_pages_found_in_lbp - Group buffer

monitor element
xs:nonNegativeInteger pool_xda_gbp_invalid_pages - Group buffer pool invalid

XDA data pages
718

Element Name
Data Type
xs:nonNegativeInteger pool_xda_gbp_l_reads - Group buffer pool XDA data

xs:nonNegativeInteger pool_xda_gbp_p_reads - Group buffer pool XDA data

pool_xda_l_reads
xs:nonNegativeInteger pool_xda_l_reads - Buffer pool XDA data logical reads
xs:nonNegativeInteger pool_xda_lbp_pages_found - Local buffer pool XDA data

pages found
pool_xda_p_reads
xs:nonNegativeInteger pool_xda_p_reads - Buffer pool XDA data physical reads
pool_xda_writes
xs:nonNegativeInteger pool_xda_writes - Buffer pool XDA data writes
xs:long
xs:long
xs:long

element
xs:long

monitor element
post_threshold_peas
xs:long
post_threshold_peds
xs:long
prefetch_wait_time
xs:nonNegativeInteger prefetch_wait_time - Time waited for prefetch
prefetch_waits
xs:nonNegativeInteger prefetch_waits - Prefetcher wait count monitor element
rows_deleted
xs:long
rows_inserted
xs:long
rows_modified
xs:nonNegativeInteger rows_modified - Rows modified
rows_read
xs:nonNegativeInteger rows_read - Rows read
rows_returned
xs:nonNegativeInteger rows_returned - Rows returned
rows_updated
xs:long
xs:nonNegativeInteger rqsts_completed_total - Total requests completed
select_sql_stmts
xs:long
service_class_id
xs:nonNegativeInteger service_class_id - Service class ID
xs:string(128)
xs:string(128)
sort_overflows
xs:nonNegativeInteger sort_overflows - Sort overflows
static_sql_stmts
xs:long
tcpip_recv_volume
xs:nonNegativeInteger tcpip_recv_volume - TCP/IP received volume
xs:nonNegativeInteger tcpip_recv_wait_time - TCP/IP recv wait time
tcpip_recvs_total
xs:nonNegativeInteger tcpip_recvs_total - TCP/IP recvs total
tcpip_send_volume
xs:nonNegativeInteger tcpip_send_volume - TCP/IP send volume
xs:nonNegativeInteger tcpip_send_wait_time - TCP/IP send wait time

monitor element
select_sql_stmts - Select SQL Statements Executed monitor

element

monitor element
719

Element Name
Data Type
tcpip_sends_total
xs:nonNegativeInteger tcpip_sends_total - TCP/IP sends total
thresh_violations
xs:nonNegativeInteger thresh_violations - Number of threshold violations
total_act_time
xs:nonNegativeInteger total_act_time - Total activity time
total_act_wait_time
xs:nonNegativeInteger total_act_wait_time - Total activity wait time
total_app_commits
xs:nonNegativeInteger total_app_commits - Total application commits
total_app_rollbacks
xs:nonNegativeInteger total_app_rollbacks - Total application rollbacks
total_app_rqst_time
xs:nonNegativeInteger total_app_rqst_time - Total application request time
xs:nonNegativeInteger total_app_section_executions - Total section executions
xs:nonNegativeInteger total_col_executions - Total column-organized executions
total_col_proc_time
xs:nonNegativeInteger total_col_proc_time - Total column-organized processing

time
total_col_time
xs:nonNegativeInteger total_commit_proc_time - Total commits processing time
total_commit_time
xs:nonNegativeInteger total_commit_time - Total commit time
total_compilations
xs:nonNegativeInteger total_compilations - Total compilations
xs:nonNegativeInteger total_compile_proc_time - Total compile processing time
total_compile_time
xs:nonNegativeInteger total_compile_time - Total compile time
_proc_time
xs:nonNegativeInteger total_connect_authentication_proc_time - Total connection

authentication processing time
_time
xs:nonNegativeInteger total_connect_authentication_time - Total connection or

switch user authentication request time
xs:nonNegativeInteger total_connect_authentications - Connections or switch

total_connect_request_proc_time xs:nonNegativeInteger total_connect_request_proc_time - Total connection or

xs:nonNegativeInteger total_connect_request_time - Total connection or switch

user request time
xs:nonNegativeInteger total_connect_requests - Connection or switch user

requests
total_cpu_time
xs:nonNegativeInteger total_cpu_time - Total CPU time
xs:long
xs:nonNegativeInteger total_extended_latch_wait_time - Total extended latch

wait time
xs:nonNegativeInteger total_extended_latch_waits - Total extended latch waits
total_hash_grpbys
xs:long
total_hash_joins
xs:long
total_hash_loops
xs:long
xs:nonNegativeInteger total_implicit_compilations - Total implicit complications
total_implicit_compile
_proc_time
xs:nonNegativeInteger total_implicit_compile_proc_time - Total implicit compile

processing time
xs:nonNegativeInteger total_implicit_compile_time - Total implicit compile time
xs:nonNegativeInteger total_load_proc_time - Total load processing time
720

time

Element Name
Data Type
total_load_time
xs:nonNegativeInteger total_load_time - Total load time
total_loads
xs:nonNegativeInteger total_loads - Total loads
total_olap_funcs
xs:long
total_peas
xs:long
total_peds
xs:long
xs:nonNegativeInteger total_reorg_proc_time - Total reorganization processing

time
total_reorg_time
xs:nonNegativeInteger total_reorg_time - Total reorganization time
total_reorgs
xs:nonNegativeInteger total_reorgs - Total reorganizations
xs:nonNegativeInteger total_rollback_proc_time - Total rollback processing time
total_rollback_time
xs:nonNegativeInteger total_rollback_time - Total rollback time
xs:nonNegativeInteger total_routine_invocations - Total routine invocations
total_routine_time
xs:nonNegativeInteger total_routine_time - Total routine time
total_routine_user_
code_proc_time
xs:nonNegativeInteger total_routine_user_code_proc_time - Total routine user

total_routine_user_
code_time
xs:nonNegativeInteger total_routine_user_code_time - Total routine user code

time
total_rqst_mapped_in
xs:nonNegativeInteger total_rqst_mapped_in - Total request mapped-in
total_rqst_mapped_out
xs:nonNegativeInteger total_rqst_mapped_out - Total request mapped-out
total_rqst_time
xs:nonNegativeInteger total_rqst_time - Total request time
xs:nonNegativeInteger total_runstats_proc_time - Total runtime statistics

processing time
total_runstats
xs:nonNegativeInteger total_runstats - Total runtime statistics
total_runstats_time
xs:nonNegativeInteger total_runstats_time - Total runtime statistics
xs:nonNegativeInteger total_section_proc_time - Total section processing time
xs:nonNegativeInteger total_section_sort_proc_time - Total section sort processing

time
xs:nonNegativeInteger total_section_sort_time - Total section sort time
total_section_sorts
xs:nonNegativeInteger total_section_sorts - Total section sorts
total_section_time
xs:nonNegativeInteger total_section_time - Total section time
total_sorts
xs:nonNegativeInteger total_sorts - Total Sorts
total_stats_fabrication_proc
_time
xs:nonNegativeInteger total_stats_fabrication_proc_time - Total statistics

xs:nonNegativeInteger total_stats_fabrication_time - Total statistics fabrication

time
xs:nonNegativeInteger total_stats_fabrications - Total statistics fabrications
total_sync_runstats
xs:nonNegativeInteger total_sync_runstats - Total synchronous RUNSTATS

activities
xs:nonNegativeInteger total_sync_runstats_proc_time - Total synchronous

xs:nonNegativeInteger total_sync_runstats_time - Total synchronous RUNSTATS

time
total_wait_time
xs:nonNegativeInteger total_wait_time - Total wait time

721

Element Name
Data Type
xs:long
xs:long
tq_tot_send_spills
xs:nonNegativeInteger tq_tot_send_spills - Total number of table queue buffers

overflowed
uid_sql_stmts
xs:long
xs:nonNegativeInteger wlm_queue_assignments_total - Workload manager total

queue assignments
xs:nonNegativeInteger wlm_queue_time_total - Workload manager total queue

time
xquery_stmts
xs:long


element
Usage notes
The metrics returned by the MON_GET_SERVICE_SUBCLASS_DETAILS table
function represent the accumulation of all metrics for requests that have executed
under the indicated service subclass. This function is similar to the
MON_GET_SERVICE_SUBCLASS table function:
v The the MON_GET_SERVICE_SUBCLASS table function returns the most
commonly used metrics in a column based format and is the most performance
efficient method of retrieving metrics.
v The MON_GET_SERVICE_SUBCLASS_DETAILS table function returns the entire
set of available metrics in an XML document format, which provides maximum
flexibility for formatting output. The XML-based output can be parsed directly
Metrics are rolled up to a service class on unit of work boundaries, and
periodically during the execution of requests. Therefore, the values reported by this
table function reflect the current state of the system at the time of the most recent
rollup. Metrics are strictly increasing in value. To determine the value of a given
metric for an interval of time, use the MON_GET_SERVICE_SUBCLASS_DETAILS
table function to query the metric at the start and end of the interval, and compute
the difference.
on service superclasses, and the mon_req_metrics database configuration parameter
database. By default request metrics are enabled at the database level. If request
metrics are disabled at the database level and for a service superclass, the metrics
reported for each connection mapped to that service superclass stop increasing (or
remain at 0 if request metrics were disabled at database activation time).
The MON_GET_SERVICE_SUBCLASS_DETAILS table function returns one row of
data per service subclass and per member. No aggregation across service classes
(on a member), or across members (for a service class or more), is performed.
However, aggregation can be achieved through SQL queries (see the example). The
722
input parameters have the effect of being ANDed together. Therefore, if you
specify conflicting input parameters (for example, a superclass name SUPA and
subclass name SUBB that is not a subclass of SUPA), no rows are returned.
In the data returned by this function that describe the default subclass
SYSDEFAULTSUBCLASS under the superclass SYSDEFAULTSYSTEMCLASS, all
metrics have a value of 0.
Tip: A request might execute in more than one service subclass. For example, this
situation might occur if a request is mapped from one service subclass to another
by using a Workload Manager (WLM) threshold with a REMAP ACTIVITY action.
Although the time spent metrics are updated for each service subclass under which
the request executes, the request counters are incremented for the service subclass
where the request completed. Therefore, you should not analyze the averages of
request times for a single subclass. All subclasses to which an activity can be
mapped must be analyzed in conjunction with one another. For example, if a
threshold exists that can map activities from service subclass A to service subclass
B, then when you compute averages of requests, you should aggregate the
counters and metrics for service subclasses A and B, and compute the averages
using the aggregates.
Example
Display the total CPU time used and total number of requests processed for each
service superclass, ordered by CPU usage in relational format (using XMLTABLE).
SELECT varchar(scmetrics.service_superclass_name,30) as service_superclass,
sum(detmetrics.total_cpu_time) as total_cpu,
sum(detmetrics.app_rqsts_completed_total) as total_rqsts
FROM TABLE(MON_GET_SERVICE_SUBCLASS_DETAILS(,,-2)) AS SCMETRICS,
$detmetric/db2_service_subclass
PASSING XMLPARSE(DOCUMENT SCMETRICS.DETAILS)
as "detmetric"
COLUMNS "TOTAL_CPU_TIME" INTEGER PATH system_metrics/total_cpu_time,
"APP_RQSTS_COMPLETED_TOTAL" INTEGER PATH
system_metrics/app_rqsts_completed_total)
AS DETMETRICS
GROUP BY service_superclass_name
ORDER BY total_cpu desc

SERVICE_SUPERCLASS
TOTAL_CPU
TOTAL_RQSTS
------------------------------ -------------------- -------------------SYSDEFAULTUSERCLASS
2428188
26
0
0
0
0
MON_GET_SERVICE_SUBCLASS_STATS table function - Return statistics of

service subclasses:
The MON_GET_SERVICE_SUBCLASS_STATS function returns basic statistics for
723
Authorization
v
v
v
v
v

DBADM authority
SQLADM authority
WLMADM authority

None
Syntax
MON_GET_SERVICE_SUBCLASS_STATS (


Routine parameters
empty string, the data is retrieved for all of the superclasses in the database.
subclass in the currently connected database. If the argument is null or an
empty string, the data is retrieved for all of the subclasses in the database.
member
current member, or -2 for all database members. If the null value is specified,
Table 175. Information returned by the MON_GET_SERVICE_SUBCLASS_STATS routine
Column name
Data type
Description
VARCHAR(128)
VARCHAR(128)
service_subclass_name - Service subclass

DBPARTITIONNUM
SMALLINT

LAST_RESET
TIMESTAMP
last_reset - Last Reset Timestamp monitor

element
COORD_ACT_COMPLETED_TOTAL
BIGINT
coord_act_completed_total - Coordinator
activities completed total monitor element
724
Table 175. Information returned by the MON_GET_SERVICE_SUBCLASS_STATS routine (continued)

Column name
Data type
Description
COORD_ACT_ABORTED_TOTAL
BIGINT
coord_act_aborted_total - Coordinator
activities aborted total monitor element
COORD_ACT_REJECTED_TOTAL
BIGINT
coord_act_rejected_total - Coordinator
activities rejected total monitor element
CONCURRENT_ACT_TOP
INTEGER
concurrent_act_top - Concurrent activity

top monitor element
COORD_ACT_LIFETIME_TOP
BIGINT
coord_act_lifetime_top - Coordinator
activity lifetime top monitor element
COORD_ACT_LIFETIME_AVG
DOUBLE
coord_act_lifetime_avg - Coordinator
activity lifetime average monitor element
COORD_ACT_LIFETIME_STDDEV
DOUBLE
Standard deviation of lifetime for

coordinator activities at nesting level 0 that
were associated with this service subclass
since the last reset. If the COLLECT
AGGREGATE ACTIVITY DATA parameter
of the service class is set to NONE, the
value of the column is null. Units are
milliseconds.
This standard deviation is computed from
the coordinator activity lifetime histogram
and may be inaccurate if the histogram is
not correctly sized to fit the data. The value
of -1 is returned if any values fall into the
last histogram bin.
The COORD_ACT_LIFETIME_STDDEV
value of a service subclass is unaffected by
activities that pass through the service
subclass but are remapped to a different
subclass before they are completed.
COORD_ACT_EXEC_TIME_AVG
DOUBLE
coord_act_exec_time_avg - Coordinator
activities execution time average monitor
element
COORD_ACT_EXEC_TIME_STDDEV
DOUBLE
Standard deviation of the execution times

for coordinator activities at nesting level 0
that were associated with this service
subclass since the last reset. Units are
milliseconds.
the coordinator activity executetime
histogram and may be inaccurate if the
histogram is not correctly sized to fit the
data. The value of -1 is returned if any
values fall into the last histogram bin.
The execution time standard deviation of a
service subclass is unaffected by activities
that pass through the subclass but are
remapped to a different subclass before
they are completed.
COORD_ACT_QUEUE_TIME_AVG
DOUBLE
coord_act_queue_time_avg - Coordinator
activity queue time average monitor
element
725

Column name
Data type
Description
COORD_ACT_QUEUE_TIME_STDDEV
DOUBLE
Standard deviation of the queue time for

milliseconds.
the coordinator activity queuetime
The queue time standard deviation is
counted only toward the service subclass in
which the activity was queued.
NUM_REQUESTS_ACTIVE
BIGINT
Number of requests that are running in the

service subclass at the time that this table
function is running.
NUM_REQUESTS_TOTAL
BIGINT
Number of requests that finished running

in this service subclass since the last reset.
This finished state applies to any request
regardless of its membership in an activity.
If the COLLECT AGGREGATE ACTIVITY
DATA parameter of the service class is set
to NONE, the value of the column is null.
The NUM_REQUESTS_TOTAL value of a
service subclass is unaffected by requests
that pass through the service subclass but
are not completed in it.
REQUEST_EXEC_TIME_AVG
DOUBLE
request_exec_time_avg - Request execution

time average monitor element
REQUEST_EXEC_TIME_STDDEV
DOUBLE

for requests that were associated with this
service subclass since the last reset. Units
are milliseconds. If the COLLECT
AGGREGATE REQUEST DATA parameter
value of this column is NULL.
the request executetime histogram and may
be inaccurate if the histogram is not
correctly sized to fit the data. The value of
-1 is returned if any values fall into the last
histogram bin.
that pass through the subclass but were not
completed in it.
726

Column name
Data type
Description
REQUEST_EXEC_TIME_TOTAL
BIGINT
Sum of the execution times for requests

milliseconds. If the COLLECT
This total is computed from the request
execution time histogram and may be
inaccurate if the histogram is not correctly
sized to fit the data. The value of -1 is
returned if any values fall into the last
histogram bin.
The execution time total of a service
subclass is unaffected by requests that pass
through the subclass but are not completed
in it.
ACT_REMAPPED_IN
BIGINT
act_remapped_in - Activities remapped in

monitor element
ACT_REMAPPED_OUT
BIGINT
act_remapped_out - Activities remapped

out monitor element
CONCURRENT_WLO_TOP
INTEGER
concurrent_wlo_top - Concurrent workload

occurrences top monitor element
UOW_TOTAL_TIME_TOP
BIGINT
uow_total_time_top - UOW total time top

monitor element
UOW_THROUGHPUT
DOUBLE
uow_throughput - Unit of work

throughput monitor element
The unit of work throughput since the last
reset of the statistics.
UOW_LIFETIME_AVG
DOUBLE
uow_lifetime_avg - Unit of work lifetime

average monitor element
UOW_COMPLETED_TOTAL
BIGINT
uow_completed_total - Total completed

units of work monitor element
TOTAL_CPU_TIME
BIGINT
total_cpu_time - Total CPU time monitor

element
BIGINT
total_disp_run_queue_time - Total
dispatcher run queue time monitor element
ACT_THROUGHPUT
DOUBLE
act_throughput - Activity throughput

monitor element
CPU_UTILIZATION
DOUBLE
cpu_utilization - CPU utilization monitor

element
BIGINT
app_act_completed_total - Total successful

external coordinator activities monitor
element
BIGINT

BIGINT
app_act_rejected_total - Total rejected

external coordinator activities monitor
element
727

Column name
Data type
Description
MEMBER
SMALLINT

element
Usage notes
Some statistics are returned only if you set the COLLECT AGGREGATE ACTIVITY
DATA and COLLECT AGGREGATE REQUEST DATA parameters for the
corresponding service subclass to a value other than NONE.
The MON_GET_SERVICE_SUBCLASS_STATS table function returns one row of
data per service subclass and per member. The function does not aggregate data
across service classes (on a partition) or across partitions (for one or more service
classes). However, you can use SQL queries to aggregate data.
input parameters, such as a superclass named SUPA and a subclass named SUBB
such that SUBB is not a subclass of SUPA, no rows are returned.
Examples
Example 1: Because every activity must be mapped to a DB2 service class before
being run, you can monitor the global state of the system by using the service class
statistics table functions and querying all of the service classes on all members. In
the following example, a null value is passed for service_superclass_name and
service_subclass_name to return statistics for all service classes, and the value -2 is
specified for member to return statistics for all members:
SELECT SUBSTR(SERVICE_SUPERCLASS_NAME,1,19) AS SUPERCLASS_NAME,
SUBSTR(SERVICE_SUBCLASS_NAME,1,18) AS SUBCLASS_NAME,
CAST(COORD_ACT_LIFETIME_AVG / 1000 AS DECIMAL(9,3))
AS AVGLIFETIME,
CAST(COORD_ACT_LIFETIME_STDDEV / 1000 AS DECIMAL(9,3))
AS STDDEVLIFETIME,
SUBSTR(CAST(LAST_RESET AS VARCHAR(30)),1,16) AS LAST_RESET
FROM TABLE(MON_GET_SERVICE_SUBCLASS_STATS(CAST(NULL AS VARCHAR(128)),
CAST(NULL AS VARCHAR(128)), -2)) AS SCSTATS
ORDER BY SUPERCLASS_NAME, SUBCLASS_NAME, MEMB
The statement returns service class statistics such as average activity lifetime and
standard deviation in seconds, as shown in the following sample output:
SUPERCLASS_NAME
------------------SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SUBCLASS_NAME
-----------------SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
MEMB
---0
1
2
3
...
...
...
...
...
...
... AVGLIFETIME STDDEVLIFETIME LAST_RESET

... ----------- -------------- ---------------...
691.242
34.322 2006-07-24-11.44
...
644.740
22.124 2006-07-24-11.44
...
612.431
43.347 2006-07-24-11.44
...
593.451
28.329 2006-07-24-11.44
Example 2: The same table function can also give the highest value for average
concurrency of coordinator activities running in the service class on each member:
728

CONCURRENT_ACT_TOP AS ACTTOP,
CONCURRENT_WLO_TOP AS CONNTOP
ORDER BY SUPERCLASS_NAME, SUBCLASS_NAME, MEMB

SUPERCLASS_NAME
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SUBCLASS_NAME
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
MEMB ACTTOP
CONNTOP
---- --------- --------0
10
7
1
0
0
2
0
0
3
0
0
By checking the average execution times and numbers of activities in the output of
this table function, you can get a good high-level view of the load on each member
for a specific database. Any significant variations in the high-level gauges returned
by this table function might indicate a change in the load on the system.
Example 3: If an activity uses thresholds with REMAP ACTIVITY TO actions, the
activity might spend time in more than one service class during its lifetime. You
can determine how many activities have passed through a set of service classes by
looking at the ACT_REMAPPED_IN and ACT_REMAPPED_OUT columns, as
ACT_REMAPPED_IN AS MAPPED_IN,
ACT_REMAPPED_OUT AS MAPPED_OUT
ORDER BY SUPERCLASS_NAME, SUBCLASS_NAME

SUPERCLASS_NAME
SUPERCLASS1
SUPERCLASS1
SUPERCLASS1
SUBCLASS_NAME
MAPPED_IN MAPPED_OUT
------------------ --------- ---------SYSDEFAULTSUBCLASS
0
0
SYSDEFAULTSUBCLASS
0
0
SUBCLASS1
0
7
SUBCLASS2
7
0
MON_GET_SERVICE_SUPERCLASS_STATS - Return statistics of service

superclasses:
The MON_GET_SERVICE_SUPERCLASS_STATS function returns basic statistics of
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority
729

None
Syntax
MON_GET_SERVICE_SUPERCLASS_STATS (
, member

Routine parameters
member
current database member, or -2 for all database members. If the null value is
specified, -1 is set implicitly.
Table 176. Information returned by the MON_GET_SERVICE_SUPERCLASS_STATS routine
Column name
Data type
Description
VARCHAR(128)

monitor element
DBPARTITIONNUM
SMALLINT

monitor element
LAST_RESET
TIMESTAMP
last_reset - Last Reset Timestamp monitor element
CONCURRENT_CONNECTION_TOP
INTEGER
concurrent_connection_top - Concurrent
connection top monitor element
MEMBER
SMALLINT
Usage notes
The MON_GET_SERVICE_SUPERCLASS_STATS table function returns one row of
data per service superclass and per member. The function does not aggregate data
across service superclasses (on a member) or across members (for one or more
service superclasses). However, you can use SQL queries to aggregate data, as
shown in the previous example.
Example
The following query displays the basic statistics for all the service superclasses on
the system, across all database members:
SELECT SUBSTR(SERVICE_SUPERCLASS_NAME, 1, 26) SERVICE_SUPERCLASS_NAME,
MEMBER,
LAST_RESET,
CONCURRENT_CONNECTION_TOP CONCURRENT_CONN_TOP
FROM TABLE(MON_GET_SERVICE_SUPERCLASS_STATS(, -2)) as SCSTATS
730

MEMBER
-------------------------- -------------SYSDEFAULTSYSTEMCLASS
0
0
SYSDEFAULTUSERCLASS
0
...
...
...
...
...
...
...
...
...
...
LAST_RESET
CONCURRENT_CONN_TOP
-------------------------- ------------------2006-09-05-09.38.44.396788
0
2006-09-05-09.38.44.396795
0
2006-09-05-09.38.44.396796
1
MON_GET_TABLE table function - get table metrics:

The MON_GET_TABLE table function returns monitor metrics for one or more
tables.
Syntax
MON_GET_TABLE (
tabschema
, tabname
, member

tabschema
An input argument of type VARCHAR(128) that specifies a valid table schema
argument is null or an empty string, metrics are retrieved for all tables in all
schemas in the database. If the argument is specified, metrics are only returned
for tables in the specified schema.
tabname
An input argument of type VARCHAR(128) that specifies a valid table name in
the currently connected database when calling this function. If the argument is
null or an empty string, metrics are retrieved for all the tables in the database.
member
Authorization
v DBADM authority
v SQLADM authority
None
731
Table 177. Information returned for MON_GET_TABLE
Column Name
Data Type
Description
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
MEMBER
SMALLINT
TAB_TYPE
VARCHAR(14)
table_type - Table type
TAB_FILE_ID
BIGINT
DATA_PARTITION_ID
INTEGER
TBSP_ID
BIGINT
INDEX_TBSP_ID
BIGINT
index_tbsp_id - Index table space ID
LONG_TBSP_ID
BIGINT
long_tbsp_id - Long table space ID
TABLE_SCANS
BIGINT
table_scans - Table scans
ROWS_READ
BIGINT
ROWS_INSERTED
BIGINT
rows_inserted - Rows inserted
ROWS_UPDATED
BIGINT
rows_updated - Rows updated
ROWS_DELETED
BIGINT
rows_deleted - Rows deleted
OVERFLOW_ACCESSES
BIGINT
overflow_accesses - Accesses to overflowed records
OVERFLOW_CREATES
BIGINT
overflow_creates - Overflow creates
PAGE_REORGS
BIGINT
page_reorgs - Page reorganizations
DATA_OBJECT_L_PAGES
BIGINT
data_object_l_pages - Logical data object pages
LOB_OBJECT_L_PAGES
BIGINT
lob_object_l_pages - Logical LOB object pages
LONG_OBJECT_L_PAGES
BIGINT
long_object_l_pages - Logical Long object pages
INDEX_OBJECT_L_PAGES
BIGINT
index_object_l_pages - Logical index object pages
XDA_OBJECT_L_PAGES
BIGINT
xda_object_l_pages - Logical XDA object pages
DBPARTITIONNUM
SMALLINT
NO_CHANGE_UPDATES
BIGINT
no_change_updates - Number of no change row updates
LOCK_WAIT_TIME
BIGINT
BIGINT
LOCK_WAITS
BIGINT
LOCK_WAITS_GLOBAL
BIGINT
LOCK_ESCALS
BIGINT
LOCK_ESCALS_GLOBAL
BIGINT
DATA_SHARING_STATE
VARCHAR(19)
data_sharing_state - Data sharing state monitor element
DATA_SHARING_STATE
_CHANGE_TIME
TIMESTAMP
data_sharing_state_change_time - Data sharing state

change time monitor element
DATA_SHARING_REMOTE
_LOCKWAIT_COUNT
BIGINT
data_sharing_remote_lockwait_count - Data sharing

remote lock wait count monitor element
DATA_SHARING_REMOTE
_LOCKWAIT_TIME
BIGINT
data_sharing_remote_lockwait_time - Data sharing remote

lock wait time monitor element
DIRECT_WRITES
BIGINT
DIRECT_WRITE_REQS
BIGINT
DIRECT_READS
BIGINT
732
Table 177. Information returned for MON_GET_TABLE (continued)

Column Name
Data Type
Description
DIRECT_READ_REQS
BIGINT
OBJECT_DATA_L_READS
BIGINT
object_data_l_reads - Buffer pool data logical reads for a

table
OBJECT_DATA_P_READS
BIGINT
object_data_p_reads - Buffer pool data physical reads for a

table
OBJECT_DATA_GBP_L_READS BIGINT
object_data_gbp_l_reads - Group buffer pool data logical

reads for a table
OBJECT_DATA_GBP_P_READS BIGINT
object_data_gbp_p_reads - Group buffer pool data

physical reads for a table
OBJECT_DATA_GBP_INVALID
_PAGES
BIGINT
object_data_gbp_invalid_pages - Group buffer pool

invalid data pages for a table
OBJECT_DATA_LBP_PAGES
_FOUND
BIGINT
object_data_lbp_pages_found - Local buffer pool found

data pages for a table
OBJECT_DATA_GBP_INDEP
_PAGES_FOUND_IN_LBP
BIGINT
object_data_gbp_indep_pages_found_in_lbp - Group
buffer pool independent data pages found in local buffer
pool
OBJECT_XDA_L_READS
BIGINT
object_xda_l_reads - Buffer pool XDA data logical reads

for a table
OBJECT_XDA_P_READS
BIGINT
object_xda_p_reads - Buffer pool XDA data physical reads

for a table
OBJECT_XDA_GBP_L_READS
BIGINT
object_xda_gbp_l_reads - Group buffer pool XDA data

logical read requests for a table
OBJECT_XDA_GBP_P_READS
BIGINT
object_xda_gbp_p_reads - Group buffer pool XDA data

physical read requests for a table
OBJECT_XDA_GBP_INVALID
_PAGES
BIGINT
object_xda_gbp_invalid_pages - Group buffer pool invalid

XDA data pages for a table
OBJECT_XDA_LBP_PAGES
_FOUND
BIGINT
object_xda_lbp_pages_found - Local buffer pool XDA data

pages found for a table
OBJECT_XDA_GBP_INDEP
_PAGES_FOUND_IN_LBP
BIGINT
object_xda_gbp_indep_pages_found_in_lbp - Group buffer

NUM_PAGE_DICT_BUILT
BIGINT
num_page_dict_built - Number of page-level compression

dictionaries created or re-created
STATS_ROWS_MODIFIED
BIGINT

RUNSTATS
RTS_ROWS_MODIFIED
BIGINT

statistics
COL_OBJECT_L_PAGES
BIGINT
col_object_l_pages - Column-organized logical pages
TAB_ORGANIZATION
CHAR(1)
tab_organization - Data organization in table
OBJECT_COL_L_READS
BIGINT
object_col_l_reads - Column-organized logical reads
OBJECT_COL_P_READS
BIGINT
object_col_p_reads - Column-organized physical reads
OBJECT_COL_GBP_L_READS
BIGINT
object_col_gbp_l_reads - Group buffer pool

column-organized logical reads
OBJECT_COL_GBP_P_READS
BIGINT
object_col_gbp_p_reads - Group buffer pool

OBJECT_COL_GBP_
INVALID_PAGES
BIGINT
object_col_gbp_invalid_pages - Group buffer pool

column-organized invalid data pages
733
Table 177. Information returned for MON_GET_TABLE (continued)

Column Name
Data Type
Description
OBJECT_COL_LBP_
PAGES_FOUND
BIGINT
object_col_lbp_pages_found - Local buffer pool

column-organized pages found
OBJECT_COL_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
object_col_gbp_indep_pages_found_in_lbp - Group buffer

pool column-organized index pages found in local buffer
pool
NUM_COLUMNS_
REFERENCED
BIGINT
num_columns_referenced - Number of columns referenced
SECTION_EXEC_WITH_
COL_REFERENCES
BIGINT
section_exec_with_col_references - Section execution with

column-organized references
OBJECT_DATA_CACHING_
TIER_L_READS
BIGINT
TIER_PAGES_FOUND
BIGINT
BIGINT
TIER_GBP_INDEP_
PAGES_FOUND
BIGINT
OBJECT_XDA_CACHING_
TIER_L_READS
BIGINT
OBJECT_XDA_CACHING_
TIER_PAGES_FOUND
BIGINT
OBJECT_XDA_CACHING_
BIGINT
OBJECT_XDA_CACHING_
TIER_GBP_INDEP_
PAGES_FOUND
BIGINT
OBJECT_COL_CACHING_
TIER_L_READS
BIGINT
OBJECT_COL_CACHING_
TIER_PAGES_FOUND
BIGINT
OBJECT_COL_CACHING_
BIGINT
OBJECT_COL_CACHING_
TIER_GBP_INDEP_
PAGES_FOUND
BIGINT
Usage notes
The MON_GET_TABLE table function returns one row of data per database table
and per database member. If range-partitioned tables are being used, one row is
returned for each table partition per database member. No aggregation across
database members is performed. However, aggregation can be achieved through
SQL queries as shown in the example.
Metrics are returned only for tables accessed since the database was activated.
The metrics returned by this function are collected at two levels. Some metrics are
always collected, while the collection of other metrics is controlled at the database
734
level using the mon_obj_metrics configuration parameter. Refer to the descriptions

provided in the preceding table to determine if any settings must be active for data
to be collected for a particular metric.
Examples
1. List the activity on all tables accessed since the database was activated,
aggregated across all database members, ordered by highest number of reads.
SELECT varchar(tabschema,20) as tabschema,
varchar(tabname,20) as tabname,
sum(rows_read) as total_rows_read,
sum(rows_inserted) as total_rows_inserted,
sum(rows_updated) as total_rows_updated,
sum(rows_deleted) as total_rows_deleted
FROM TABLE(MON_GET_TABLE(,,-2)) AS t
GROUP BY tabschema, tabname
ORDER BY total_rows_read DESC

TABSCHEMA
-------------------SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
SYSIBM
TABNAME
TOTAL_ROWS_READ
-------------------- -------------------SYSHISTO
113
SYSWORKL
22
SYSROUTI
13
SYSSERVI
13
SYSTHRES
6
SYSTABLE
3
SYSCONTE
2
SYSDBAUT
2
SYSEVENT
2
SYSPLAN
1
SYSSURRO
1
SYSVERSI
1
SYSXMLST
1
SYSAUDIT
0
SYSROLEA
0
SYSROLES
0
SYSTASKS
0
SYSWORKA
0
SYSXMLPA
0
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...

... TOTAL_ROWS_INSERTED TOTAL_ROWS_UPDATED
TOTAL_ROWS_DELETED
... -------------------- -------------------- -------------------...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
...
0
0
0
735
2. Get the explicit hierarchical locking state for tables in the schema JOE from
member 1:
SELECT SUBSTR(TABNAME,1,8) AS TABNAME,
MEMBER,
DATA_SHARING_STATE AS DS_STATE,
DATA_SHARING_REMOTE_LOCKWAIT_COUNT AS DSRL_COUNT,
DATA_SHARING_REMOTE_LOCKWAIT_TIME AS DSRL_TIME
FROM
TABLE(MON_GET_TABLE(JOE,,1))

TABNAME MEMBER DS_STATE
DSRL_COUNT
DSRL_TIME
-------- ------ ------------------- -------------------- -------------------T1
1 NOT_SHARED
0
0
T2
1 SHARED
2
21844
T3
1 SHARED
0
0
This output shows that table T1 is currently in a "NOT_SHARED" state and has
never been forced out of this state during the current database activation. Table
T3 has never entered a "NOT_SHARED" state. Table T2 has been in a
"NOT_SHARED" state twice and has had to exit both times.
MON_GET_TABLESPACE table function - Get table space metrics:
The MON_GET_TABLESPACE table function returns monitor metrics for one or
more table spaces.
Syntax
MON_GET_TABLESPACE (
tbsp_name
, member

tbsp_name
An input argument of type VARCHAR(128) that specifies a valid table space
argument is null or an empty string, metrics are retrieved for all table spaces in
the database.
member
Authorization
v DBADM authority
v SQLADM authority
736

None
Example
List table spaces ordered by number of physical reads from table space containers.
SELECT varchar(tbsp_name, 30) as tbsp_name,
member,
tbsp_type,
pool_data_p_reads
FROM TABLE(MON_GET_TABLESPACE(,-2)) AS t
ORDER BY pool_data_p_reads DESC

TBSP_NAME
MEMBER TBSP_TYPE POOL_DATA_P_READS
------------------------------ ------ ---------- -------------------SYSCATSPACE
0 DMS
79
USERSPACE1
0 DMS
34
TEMPSPACE1
0 SMS
0
Usage notes
The MON_GET_TABLESPACE table function returns one row of data per database
table space and per database member. No aggregation across database members is
performed. However, aggregation can be achieved through SQL queries.
Table 178. Information returned for MON_GET_TABLESPACE
Column Name
Data Type
TBSP_NAME
VARCHAR(128)
TBSP_ID
BIGINT
MEMBER
SMALLINT
TBSP_TYPE
VARCHAR(10)
tablespace_type - Table space type. This interface

returns a text identifier based on defines in sqlutil.h,
and is one of:
v DMS
v SMS
TBSP_CONTENT_TYPE
VARCHAR(10)
tablespace_content_type - Table space content type.

This interface returns a text identifier based on
defines in sqlmon.h, and is one of:
v ANY
v LARGE
v SYSTEMP
v USRTEMP
TBSP_PAGE_SIZE
BIGINT
tablespace_page_size - Table space page size
TBSP_EXTENT_SIZE
BIGINT
tablespace_extent_size - Table space extent size
TBSP_PREFETCH_SIZE
BIGINT
tablespace_prefetch_size - Table space prefetch size

737
Table 178. Information returned for MON_GET_TABLESPACE (continued)

Column Name
Data Type
TBSP_CUR_POOL_ID
BIGINT
tablespace_cur_pool_id - Buffer pool currently being

used
TBSP_NEXT_POOL_ID
BIGINT
tablespace_next_pool_id - Buffer pool that will be

used at next startup
FS_CACHING
SMALLINT
fs_caching - File system caching
TBSP_REBALANCER_MODE
VARCHAR(30)
tablespace_rebalancer_mode - Rebalancer mode.

This interface returns a text identifier based on
v NO_REBAL
v FWD_REBAL
v REV_REBAL
TBSP_USING_AUTO_STORAGE
SMALLINT
tablespace_using_auto_storage - Table space enabled

for automatic storage
TBSP_AUTO_RESIZE_ENABLED
SMALLINT
tablespace_auto_resize_enabled - Table space

automatic resizing enabled
DIRECT_READS
BIGINT
DIRECT_READ_REQS
BIGINT
DIRECT_WRITES
BIGINT
DIRECT_WRITE_REQS
BIGINT
POOL_DATA_L_READS
BIGINT
BIGINT

data logical reads
POOL_XDA_L_READS
BIGINT

reads
BIGINT

POOL_INDEX_L_READS
BIGINT
BIGINT

index logical reads
POOL_DATA_P_READS
BIGINT
BIGINT

data physical reads
POOL_XDA_P_READS
BIGINT

reads
BIGINT

POOL_INDEX_P_READS
BIGINT

reads
BIGINT

POOL_DATA_WRITES
BIGINT
POOL_XDA_WRITES
BIGINT
POOL_INDEX_WRITES
BIGINT
738

Column Name
Data Type
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT
POOL_READ_TIME
BIGINT

time
POOL_WRITE_TIME
BIGINT

time
BIGINT
pool_async_data_reads - Buffer pool asynchronous

data reads
BIGINT

BIGINT
pool_async_data_writes - Buffer pool asynchronous

data writes
BIGINT
pool_async_index_reads - Buffer pool asynchronous

index reads
BIGINT

BIGINT
pool_async_index_writes - Buffer pool asynchronous

index writes
BIGINT
pool_async_xda_reads - Buffer pool asynchronous

XDA data reads
BIGINT

asynchronous XDA read requests
BIGINT
pool_async_xda_writes - Buffer pool asynchronous

XDA data writes
VECTORED_IOS
BIGINT
BIGINT

read by vectored IO
BLOCK_IOS
BIGINT
BIGINT
pages_from_block_ios - Total number of pages read

by block IO
BIGINT
FILES_CLOSED
BIGINT
TBSP_STATE
VARCHAR(256)
tablespace_state - Table space state
TBSP_USED_PAGES
BIGINT
tablespace_used_pages - Used pages in table space
TBSP_FREE_PAGES
BIGINT
tablespace_free_pages - Free pages in table space
TBSP_USABLE_PAGES
BIGINT
tablespace_usable_pages - Usable pages in table

space
TBSP_TOTAL_PAGES
BIGINT
tablespace_total_pages - Total pages in table space
TBSP_PENDING_FREE_PAGES
BIGINT
tablespace_pending_free_pages - Pending free pages

in table space
TBSP_PAGE_TOP
BIGINT
tablespace_page_top - Table space high watermark
TBSP_MAX_PAGE_TOP
BIGINT
tbsp_max_page_top - Maximum table space page

high watermark
RECLAIMABLE_SPACE_ENABLED
SMALLINT
reclaimable_space_enabled - Reclaimable space

enabled indicator
739

Column Name
Data Type
AUTO_STORAGE_HYBRID
SMALLINT
auto_storage_hybrid - Hybrid automatic storage

table space indicator
TBSP_PATHS_DROPPED
SMALLINT
tablespace_paths_dropped - Table space using

dropped path
BIGINT

BIGINT

BIGINT

BIGINT

BIGINT

BIGINT

BIGINT

BIGINT

BIGINT
pool_async_data_gbp_l_reads - Group buffer pool

asynchronous data logical reads monitor element
BIGINT
pool_async_data_gbp_p_reads - Group buffer pool

asynchronous data physical reads monitor element
POOL_ASYNC_DATA_
LBP_PAGES_FOUND
BIGINT
pool_async_data_lbp_pages_found - Local buffer

pool asynchronous data pages found monitor
element
POOL_ASYNC_DATA_
GBP_INVALID_PAGES
BIGINT
pool_async_data_gbp_invalid_pages - Group buffer

pool invalid asynchronous data pages monitor
element
POOL_ASYNC_INDEX_
GBP_L_READS
BIGINT
pool_async_index_gbp_l_reads - Group buffer pool

asynchronous index logical reads monitor element
POOL_ASYNC_INDEX_
GBP_P_READS
BIGINT
pool_async_index_gbp_p_reads - Group buffer pool

asynchronous index physical reads monitor element
POOL_ASYNC_INDEX_
LBP_PAGES_FOUND
BIGINT
pool_async_index_lbp_pages_found - Local buffer

pool asynchronous index pages found monitor
element
POOL_ASYNC_INDEX_
GBP_INVALID_PAGES
BIGINT
pool_async_index_gbp_invalid_pages - Group buffer

pool invalid asynchronous index pages monitor
element
TABLESPACE_MIN_RECOVERY_TIME
TIMESTAMP
tablespace_min_recovery_time - Minimum recovery

time for rollforward monitor element
740

Column Name
Data Type
DBPARTITIONNUM
SMALLINT

monitor element
For a partitioned database environment, this will be
the same value as for the MEMBER column. For
DB2 Enterprise Server Edition and in a DB2
pureScale environment, this value will be 0.
Note: DBPARTITIONNUM is different to
data_partition_id, which is used to identify a data
partition that was created by subdividing data in a
table based on a value.
BIGINT

BIGINT

BIGINT

data pages found
BIGINT

BIGINT

BIGINT
pool_async_xda_gbp_p_reads - Group buffer pool

XDA data asynchronous physical read requests
POOL_ASYNC_XDA_LBP_PAGES
_FOUND
BIGINT
pool_async_xda_lbp_pages_found - Asynchronous
local buffer pool XDA data pages found
POOL_ASYNC_XDA_GBP_INVALID
_PAGES
BIGINT
pool_async_xda_gbp_invalid_pages - Asynchronous
group buffer pool invalid XDA data pages
BIGINT
pool_async_read_time - Buffer Pool Asynchronous

Read Time monitor element
BIGINT
pool_async_write_time - Buffer pool asynchronous

write time monitor element
TBSP_TRACKMOD_STATE
VARCHAR(32)
tbsp_trackmod_state - Table space trackmod state..

This interface returns a text identifier, and is one of:
v CLEAN
v DIRTY
v ININCREMENTAL
v READFULL
v READINCREMENTAL
v UNAVAILABLE
STORAGE_GROUP_NAME
VARCHAR(128)
storage_group_name - Storage group name monitor

element
STORAGE_GROUP_ID
INTEGER
storage_group_id - Storage group identifier monitor

element
TBSP_DATATAG
SMALLINT
tbsp_datatag - Table space data tag monitor element
TBSP_LAST_CONSEC_PAGE
BIGINT
tbsp_last_consec_page - Last consecutive object table

page monitor element
BIGINT

741

Column Name
Data Type
_REQS
BIGINT

BIGINT

_REQS

_INDEX_REQS
BIGINT
element
_REQS
BIGINT

element
_REQS
BIGINT
_PAGES
BIGINT

_PAGES
BIGINT

POOL_QUEUED_ASYNC_XDA
_PAGES
BIGINT

_PAGES

element
_INDEX_PAGES
BIGINT
monitor element
_PAGES
BIGINT

monitor element
BIGINT

BIGINT

BIGINT

_REQS
BIGINT

element
_REQS
BIGINT

element
_REQS
BIGINT

element
BIGINT

SKIPPED_PREFETCH_DATA_P_READS BIGINT
skipped_prefetch_data_p_reads - Skipped prefetch

742

Column Name
Data Type
SKIPPED_PREFETCH_INDEX_P
_READS
BIGINT
skipped_prefetch_index_p_reads - Skipped prefetch

BIGINT

XDA physical reads monitor element
SKIPPED_PREFETCH_TEMP_DATA_P
_READS
BIGINT
prefetch temporary data physical reads monitor
element
SKIPPED_PREFETCH_TEMP_INDEX_P
_READS
BIGINT
prefetch temporary index physical reads monitor
element
SKIPPED_PREFETCH_TEMP_XDA_P
_READS
BIGINT
prefetch temporary XDA data physical reads
monitor element
SKIPPED_PREFETCH_UOW_DATA_P
_READS
BIGINT
prefetch unit of work data physical reads monitor
element
SKIPPED_PREFETCH_UOW_INDEX_P
_READS
BIGINT
prefetch unit of work index physical reads monitor
element
SKIPPED_PREFETCH_UOW_XDA_P
_READS
BIGINT
monitor element
SKIPPED_PREFETCH_UOW_TEMP
_DATA_P_READS
BIGINT
skipped_prefetch_uow_temp_data_p_reads Skipped prefetch unit of work temporary data

_INDEX_P_READS
BIGINT

_XDA_P_READS
BIGINT
prefetch unit of work temporary XDA data physical
PREFETCH_WAIT_TIME
BIGINT
PREFETCH_WAITS
BIGINT

element
_FOUND_IN_LBP
BIGINT
_FOUND_IN_LBP
BIGINT
_FOUND_IN_LBP
BIGINT
POOL_ASYNC_DATA_GBP_INDEP
_PAGES_FOUND_IN_LBP
BIGINT
pool_async_data_gbp_indep_pages_found_in_lbp Group buffer pool independent data pages found by

743

Column Name
Data Type
POOL_ASYNC_INDEX_GBP_INDEP
_PAGES_FOUND_IN_LBP
BIGINT
pool_async_index_gbp_indep_pages_found_in_lbp Group buffer pool independent index pages found

by asynchronous EDUs in a local buffer pool
monitor element monitor element
POOL_ASYNC_XDA_GBP_INDEP
_PAGES_FOUND_IN_LBP
BIGINT
pool_async_xda_gbp_indep_pages_found_in_lbp Group buffer pool independent XML storage

object(XDA) pages found by asynchronous EDUs in
a local buffer pool monitor element monitor element
TBSP_NUM_CONTAINERS
BIGINT
tablespace_num_containers - Number of Containers

in Table Space
TBSP_INITIAL_SIZE
BIGINT
tablespace_initial_size - Initial table space size
TBSP_MAX_SIZE
BIGINT
tablespace_max_size - Maximum table space size
TBSP_INCREASE_SIZE
BIGINT
tablespace_increase_size - Increase size in bytes
TBSP_INCREASE_SIZE_PERCENT
SMALLINT
tablespace_increase_size_percent - Increase size by

percent
TBSP_LAST_RESIZE_TIME
TIMESTAMP
tablespace_last_resize_time - Time of last successful

resize
TBSP_LAST_RESIZE_FAILED
SMALLINT
tablespace_last_resize_failed - Last resize attempt

failed
POOL_COL_L_READS
BIGINT

BIGINT

POOL_COL_P_READS
BIGINT

physical reads
BIGINT
BIGINT

POOL_COL_WRITES
BIGINT

writes
BIGINT

BIGINT
pool_async_col_read_reqs - Buffer pool

asynchronous column-organized read requests
BIGINT

column-organized writes
POOL_ASYNC_COL_LBP_
PAGES_FOUND
BIGINT
BIGINT

BIGINT

BIGINT

POOL_COL_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
744

Column Name
Data Type
POOL_ASYNC_COL_GBP_
L_READS
BIGINT
pool_async_col_gbp_l_reads - Asynchronous group

buffer pool column-organized logical reads
POOL_ASYNC_COL_GBP_
P_READS
BIGINT
pool_async_col_gbp_p_reads - Asynchronous group

buffer pool column-organized physical reads
POOL_ASYNC_COL_GBP_
INVALID_PAGES
BIGINT
POOL_ASYNC_COL_GBP_
BIGINT
pool_async_col_gbp_invalid_pages - Asynchronous
group buffer pool column-organized invalid data
pages
POOL_QUEUED_ASYNC_
COL_REQS
BIGINT
prefetch requests
POOL_QUEUED_ASYNC_
TEMP_COL_REQS
BIGINT
POOL_QUEUED_ASYNC_
COL_PAGES
BIGINT
POOL_QUEUED_ASYNC_
TEMP_COL_PAGES
BIGINT
POOL_FAILED_ASYNC_
COL_REQS
BIGINT
POOL_FAILED_ASYNC_
TEMP_COL_REQS
BIGINT
SKIPPED_PREFETCH_COL_
P_READS
BIGINT

SKIPPED_PREFETCH_TEMP_
COL_P_READS
BIGINT
prefetch column-organized temporary physical reads
COL_P_READS
BIGINT
reads
TEMP_COL_P_READS
BIGINT
physical reads
TBSP_NUM_QUIESCERS
BIGINT
tablespace_num_quiescers
TBSP_NUM_RANGES
BIGINT
tablespace_num_ranges
CACHING_TIER
VARCHAR(8)
L_READS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
745

Column Name
Data Type
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
READ_TIME
BIGINT
WRITE_TIME
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
TIER_READS
BIGINT
TIER_READS
BIGINT
TIER_READS
BIGINT
746

Column Name
Data Type
TIER_READS
BIGINT
TIER_PAGE_WRITES
BIGINT
TIER_PAGE_WRITES
BIGINT
TIER_PAGE_WRITES
BIGINT
TIER_PAGE_WRITES
BIGINT
TIER_PAGE_UPDATES
BIGINT
TIER_PAGE_UPDATES
BIGINT
TIER_PAGE_UPDATES
BIGINT
TIER_PAGE_UPDATES
BIGINT
TIER_PAGES_FOUND
BIGINT
TIER_PAGES_FOUND
BIGINT
TIER_PAGES_FOUND
BIGINT
TIER_PAGES_FOUND
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
747
MON_GET_TABLE_USAGE_LIST table function - Returns information from a

table usage list:
The MON_GET_TABLE_USAGE_LIST table function returns information from a
usage list defined for a table.
Authorization
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_TABLE_USAGE_LIST ( usagelistschema
, usagelistname
, member

Routine parameters
usagelistschema
is null or an empty string, usage lists are retrieved in all schemas in the
specified schema.
usagelistname
An input argument of type VARCHAR(128) that specifies a usage list defined
for a table that resides in the currently connected database when calling this
function. If usagelistname is null or an empty string, then all usage lists defined
for a table from the schemas identified by the usagelistschema that exist are
retrieved. If specified, only the usage list specified from the schemas identified
by the usagelistschema is returned.
member
Table 179. Information returned for MON_GET_TABLE_USAGE_LIST
Column Name
Data Type
Description
USAGELISTSCHEMA
VARCHAR (128)
USAGELISTNAME
VARCHAR (128)
TABSCHEMA
VARCHAR(128)
748
Table 179. Information returned for MON_GET_TABLE_USAGE_LIST (continued)

Column Name
Data Type
Description
TABNAME
VARCHAR(128)
MEMBER
SMALLINT
DATA_PARTITION_ID
INTEGER
EXECUTABLE_ID
VARCHAR(32) FOR
BIT DATA
MON_INTERVAL_ID
BIGINT
mon_interval_id - Monitor interval

identifier
LAST_UPDATED
TIMESTAMP
last_updated - Last update time stamp
NUM_REFERENCES
BIGINT
num_references - Number of references
NUM_REF_WITH_METRICS
BIGINT
num_ref_with_metrics - Number of
references with metrics
ROWS_INSERTED
BIGINT
ROWS_DELETED
BIGINT
ROWS_UPDATED
BIGINT
ROWS_READ
BIGINT
OVERFLOW_CREATES
BIGINT
overflow_creates - Overflow creates
OVERFLOW_ACCESSES
BIGINT
overflow_accesses - Accesses to overflowed

records
LOCK_WAIT_TIME
BIGINT
BIGINT

global
LOCK_WAITS
BIGINT
LOCK_WAITS_GLOBAL
BIGINT
LOCK_ESCALS
BIGINT
LOCK_ESCALS_GLOBAL
BIGINT

escalations
DIRECT_WRITES
BIGINT
DIRECT_WRITE_REQS
BIGINT
DIRECT_READS
BIGINT
DIRECT_READ_REQS
BIGINT
OBJECT_DATA_L_READS
BIGINT
object_data_l_reads - Buffer pool data

logical reads for a table
OBJECT_DATA_P_READS
BIGINT
object_data_p_reads - Buffer pool physical

data reads for a table
OBJECT_DATA_GBP_L_READS
BIGINT
object_data_gbp_l_reads - GBP data logical

reads for a table
OBJECT_DATA_GBP_P_READS
BIGINT
object_data_gbp_p_reads - GBP data

OBJECT_DATA_GBP_INVALID_PAGES
BIGINT
object_data_gbp_invalid_pages - GBP
invalid data pages for a table
OBJECT_DATA_LBP_PAGES_FOUND
BIGINT
object_data_lbp_pages_found - LBP data

pages found for a table
749

Column Name
Data Type
Description
OBJECT_DATA_GBP_INDEP_PAGES_FOUND
_IN_LBP
BIGINT
object_data_gbp_indep_pages_found_in_lbp
- Group buffer pool independent data pages
OBJECT_XDA_L_READS
BIGINT
object_xda_l_reads - Buffer pool XDA data

logical reads for a table
OBJECT_XDA_P_READS
BIGINT
object_xda_p_reads - Buffer pool XDA data

OBJECT_XDA_GBP_L_READS
BIGINT
object_xda_gbp_l_reads - GBP XDA data

logical read requests for a table
OBJECT_XDA_GBP_P_READS
BIGINT
object_xda_gbp_p_reads - GBP XDA data

physical read requests for a table
OBJECT_XDA_GBP_INVALID_PAGES
BIGINT
object_xda_gbp_invalid_pages - GBP invalid

XDA data pages for a table
OBJECT_XDA_LBP_PAGES_FOUND
BIGINT
object_xda_lbp_pages_found - LBP XDA

data pages found for a table
OBJECT_XDA_GBP_INDEP_PAGES_FOUND
_IN_LBP
BIGINT
object_xda_gbp_indep_pages_found_in_lbp
- Group buffer pool XDA independent
pages found in local buffer pool
OBJECT_COL_L_READS
BIGINT
object_col_l_reads - Column-organized
logical reads
OBJECT_COL_P_READS
BIGINT
object_col_p_reads - Column-organized
physical reads
OBJECT_COL_GBP_L_READS
BIGINT
object_col_gbp_l_reads - Group buffer pool

column-organized logical reads
OBJECT_COL_GBP_P_READS
BIGINT
object_col_gbp_p_reads - Group buffer pool

OBJECT_COL_GBP_
INVALID_PAGES
BIGINT
object_col_gbp_invalid_pages - Group
buffer pool column-organized invalid data
pages
OBJECT_COL_LBP_
PAGES_FOUND
BIGINT
object_col_lbp_pages_found - Local buffer

pool column-organized pages found
OBJECT_COL_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
object_col_gbp_indep_pages_found_in_lbp Group buffer pool column-organized index

pages found in local buffer pool
OBJECT_DATA_CACHING_TIER_
L_READS
BIGINT
PAGES_FOUND
BIGINT
GBP_INVALID_PAGES
BIGINT
BIGINT
OBJECT_XDA_CACHING_TIER_
L_READS
BIGINT
PAGES_FOUND
BIGINT
GBP_INVALID_PAGES
BIGINT
750

Column Name
Data Type
Description
BIGINT
OBJECT_COL_CACHING_TIER_
L_READS
BIGINT
PAGES_FOUND
BIGINT
GBP_INVALID_PAGES
BIGINT
BIGINT
Usage notes
Each row returned by this function represents the total number of times
(num_references) a unique section (DML statement only, executable ID) has
referenced a particular object during a particular time interval (monitor interval ID)
since being added to the list. The statistics collected for this row represents the
total aggregated value across these executions during this time interval.
Use the num_ref_with_metrics column instead of the num_references column when
computing averages, since the num_references column counts all executions of the
section, regardless of whether or not the execution of the section contributed to the
metrics that are reported.
Example
Retrieve the usage list USL_MON_PAYROLL from member 3
SELECT * FROM TABLE(
MON_GET_TABLE_USAGE_LIST(NULL, USL_MON_PAYROLL, 3))
USAGELISTSCHEMA
--------------ISAYYID
ISAYYID
MEMBER . .
------ . .
3 . .
3 . .
USAGELISTNAME
--------------USL_MON_PAYROLL
USL_MON_PAYROLL
TABSCHEMA
--------ISAYYID
ISAYYID
TABNAME
------T1
T1
. LAST_UPDATED
. .
. -------------------------- . .
. 2011-07-06-10.20.22.727803 . .
. 2011-07-06-10.20.58.202161 . .
.
.
.
.
MON_GET_TRANSACTION_LOG table function - Get log information:

The MON_GET_TRANSACTION_LOG table function returns information about
the transaction logging subsystem for the currently connected database.
Syntax
751
MON_GET_TRANSACTION_LOG (
member

member
Authorization
v DBADM authority
v SQLADM authority
None
Example
Select MEMBER, CUR_COMMIT_DISK_LOG_READS, CURRENT_ACTIVE_LOG,
APPLID_HOLDING_OLDEST_XACT from table(mon_get_transaction_log(-1)) as t
order by member asc
MEMBER
-----0
CUR_COMMIT_DISK_LOG_READS
------------------------9999
CURRENT_ACTIVE_LOG APPLID_HOLDING_OLDEST_XACT
------------------ -------------------------1
7
Table 180. Information returned for MON_GET_TRANSACTION_LOG. There will be one row per member for both
DB2 pureScale and partitioned database environments.
Column Name
Data Type
Description
MEMBER
SMALLINT
TOTAL_LOG_AVAILABLE
BIGINT
total_log_available - Total Log Available monitor element
TOTAL_LOG_USED
BIGINT
total_log_used - Total Log Space Used monitor element
SEC_LOG_USED_TOP
BIGINT
sec_log_used_top - Maximum Secondary Log Space Used

monitor element
TOT_LOG_USED_TOP
BIGINT
tot_log_used_top - Maximum Total Log Space Used

monitor element
SEC_LOGS_ALLOCATED
BIGINT
sec_logs_allocated - Secondary Logs Allocated Currently

monitor element
LOG_READS
BIGINT
log_reads - Number of Log Pages Read monitor element
LOG_READ_TIME
BIGINT
log_read_time - Log Read Time monitor element
LOG_WRITES
BIGINT
log_writes - Number of Log Pages Written monitor

element
LOG_WRITE_TIME
BIGINT
log_write_time - Log Write Time monitor element
752
Table 180. Information returned for MON_GET_TRANSACTION_LOG (continued). There will be one row per
member for both DB2 pureScale and partitioned database environments.
Column Name
Data Type
Description
NUM_LOG_WRITE_IO
BIGINT
num_log_write_io - Number of Log Writes monitor

element
NUM_LOG_READ_IO
BIGINT
num_log_read_io - Number of Log Reads monitor

element
NUM_LOG_PART_PAGE_IO
BIGINT
num_log_part_page_io - Number of Partial Log Page

Writes monitor element
NUM_LOG_BUFFER_FULL
BIGINT
num_log_buffer_full - Number of times full log buffer

caused agents to wait monitor element
NUM_LOG_DATA_FOUND_IN BIGINT
_BUFFER
num_log_data_found_in_buffer - Number of Log Data

Found In Buffer monitor element
APPLID_HOLDING_OLDEST
_XACT
BIGINT
Application handle holding the oldest transaction
LOG_TO_REDO_FOR
_RECOVERY
BIGINT
log_to_redo_for_recovery - Amount of Log to be Redone

for Recovery monitor element
LOG_HELD_BY_DIRTY_PAGES BIGINT
log_held_by_dirty_pages - Amount of Log Space

Accounted for by Dirty Pages monitor element
FIRST_ACTIVE_LOG
BIGINT
first_active_log - First Active Log File Number monitor

element
LAST_ACTIVE_LOG
BIGINT
last_active_log - Last Active Log File Number monitor

element
CURRENT_ACTIVE_LOG
BIGINT
current_active_log - Current Active Log File Number

monitor element
CURRENT_ARCHIVE_LOG
BIGINT
current_archive_log - Current Archive Log File Number

monitor element
CUR_COMMIT_DISK_LOG
_READS
BIGINT
The number of times the currently committed version of a

row was retrieved via a log read from disk (versus log
buffer)
CUR_COMMIT_TOTAL_LOG
_READS
BIGINT
The total number of times the currently committed

version of a row was retrieved from the logs (log buffer
and disk)
CUR_COMMIT_LOG_BUFF
_LOG_READS
BIGINT
This is calculated as
CUR_COMMIT_TOTAL_LOG_READS CUR_COMMIT_DISK_LOG_READS
ARCHIVE_METHOD1_STATUS SMALLINT
The result of the most recent log archive attempt. Possible

values are 1 for Success or 0 for Failure or Null if not
applicable.
METHOD1_NEXT_LOG_TO
_ARCHIVE
BIGINT
The next log file to be archived.
METHOD1_FIRST_FAILURE
BIGINT
The first log file that was unsuccessfully archived.
ARCHIVE_METHOD2_STATUS SMALLINT
The result of the most recent secondary log archive

attempt. Possible values are 1 for Success or 0 for Failure
or Null if not applicable.
METHOD2_NEXT_LOG_TO
_ARCHIVE
BIGINT
The next secondary log file to be archived.
METHOD2_FIRST_FAILURE
BIGINT
The first secondary log file that was unsuccessfully

archived.
LOG_CHAIN_ID
BIGINT
The identifier of the log chain number

753
Table 180. Information returned for MON_GET_TRANSACTION_LOG (continued). There will be one row per
member for both DB2 pureScale and partitioned database environments.
Column Name
Data Type
Description
CURRENT_LSO
BIGINT
The current log sequence offset
CURRENT_LSN
BIGINT
The current log sequence number
OLDEST_TX_LSN
BIGINT
The log sequence number associated with the oldest

transaction running.
NUM_LOGS_AVAIL_FOR
_RENAME
INTEGER
If using log archiving, this is the number of log files

maintained in the log path for the purpose of reusing
them. Otherwise its value is 0.
NUM_INDOUBT_TRANS
BIGINT
num_indoubt_trans - Number of Indoubt Transactions

monitor element
LOG_HADR_WAIT_TIME
BIGINT
Time spent waiting on HADR processing.
LOG_HADR_WAITS_TOTAL
BIGINT
Total number of times the transaction log sub-system

waited for HADR processing.
MON_GET_UNIT_OF_WORK table function - Get unit of work metrics:

The MON_GET_UNIT_OF_WORK table function returns metrics for one or more
units of work.
Authorization
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_UNIT_OF_WORK (
application_handle ,
member
)
,
system_appls

Routine parameters
application_handle
An optional input argument of type BIGINT that specifies a valid application
handle in the same database as the one currently connected to when calling
this function. If the argument is null, metrics are retrieved for units of work
running in all superclasses in the database.
member
754
system_appls
Table 181. Information returned for MON_GET_UNIT_OF_WORK
Column Name
Data Type
VARCHAR(128)
VARCHAR(128)
SERVICE_CLASS_ID
INTEGER
MEMBER
SMALLINT
COORD_MEMBER
SMALLINT
coord_member - Coordinator member
APPLICATION_HANDLE
BIGINT
APPLICATION_ID
VARCHAR(128)
WORKLOAD_NAME
VARCHAR(128)
INTEGER
workload_occurrence_id - Workload occurrence

identifier. This ID does not uniquely identify the
workload occurrence unless it is coupled with the
coordinator member and the workload name.
UOW_ID
INTEGER
VARCHAR(32)

state
CLIENT_WRKSTNNAME
VARCHAR(255)
CURRENT CLIENT_WRKSTNNAME special

register
CLIENT_ACCTNG
VARCHAR(255)
CLIENT_USERID
VARCHAR(255)
CLIENT_APPLNAME
VARCHAR(255)
UOW_START_TIME
TIMESTAMP
uow_start_time - Unit of Work Start Timestamp
SESSION_AUTH_ID
VARCHAR(128)
ACT_ABORTED_TOTAL
BIGINT
ACT_COMPLETED_TOTAL
BIGINT
ACT_REJECTED_TOTAL
BIGINT
AGENT_WAIT_TIME
BIGINT
AGENT_WAITS_TOTAL
BIGINT
POOL_DATA_L_READS
BIGINT
POOL_INDEX_L_READS
BIGINT

reads
BIGINT

data logical reads
755
Table 181. Information returned for MON_GET_UNIT_OF_WORK (continued)

Column Name
Data Type
BIGINT

index logical reads
BIGINT

POOL_XDA_L_READS
BIGINT

reads
POOL_DATA_P_READS
BIGINT

reads
POOL_INDEX_P_READS
BIGINT

reads
BIGINT

data physical reads
BIGINT

BIGINT

POOL_XDA_P_READS
BIGINT

reads
POOL_DATA_WRITES
BIGINT
POOL_INDEX_WRITES
BIGINT
POOL_XDA_WRITES
BIGINT
POOL_READ_TIME
BIGINT

time
POOL_WRITE_TIME
BIGINT

time
BIGINT
DEADLOCKS
BIGINT
DIRECT_READS
BIGINT
DIRECT_READ_TIME
BIGINT
DIRECT_WRITES
BIGINT
DIRECT_WRITE_TIME
BIGINT
DIRECT_READ_REQS
BIGINT
DIRECT_WRITE_REQS
BIGINT
FCM_RECV_VOLUME
BIGINT
FCM_RECVS_TOTAL
BIGINT
FCM_SEND_VOLUME
BIGINT
FCM_SENDS_TOTAL
BIGINT
FCM_RECV_WAIT_TIME
BIGINT
FCM_SEND_WAIT_TIME
BIGINT
IPC_RECV_VOLUME
BIGINT

recv volume
IPC_RECV_WAIT_TIME
BIGINT

recv wait time
756

Column Name
Data Type
IPC_RECVS_TOTAL
BIGINT

total
IPC_SEND_VOLUME
BIGINT

send volume
IPC_SEND_WAIT_TIME
BIGINT

send wait time
IPC_SENDS_TOTAL
BIGINT

total
LOCK_ESCALS
BIGINT
LOCK_TIMEOUTS
BIGINT
LOCK_WAIT_TIME
BIGINT
LOCK_WAITS
BIGINT
BIGINT
NUM_LOG_BUFFER_FULL
BIGINT
LOG_DISK_WAIT_TIME
BIGINT
BIGINT
NUM_LOCKS_HELD
BIGINT
BIGINT
ROWS_MODIFIED
BIGINT
ROWS_READ
BIGINT
ROWS_RETURNED
BIGINT
TCPIP_RECV_VOLUME
BIGINT
TCPIP_SEND_VOLUME
BIGINT
BIGINT
TCPIP_RECVS_TOTAL
BIGINT
BIGINT
TCPIP_SENDS_TOTAL
BIGINT
TOTAL_APP_RQST_TIME
BIGINT
total_app_rqst_time - Total application request

time
TOTAL_RQST_TIME
BIGINT
BIGINT

queue time
WLM_QUEUE_ASSIGNMENTS
_TOTAL
BIGINT
TOTAL_CPU_TIME
BIGINT
TOTAL_WAIT_TIME
BIGINT
BIGINT

requests completed
BIGINT
BIGINT

processing time
TOTAL_SECTION_SORTS
BIGINT
TOTAL_SORTS
BIGINT

757

Column Name
Data Type
BIGINT
BIGINT

sorts
SORT_OVERFLOWS
BIGINT
TOTAL_COMPILE_TIME
BIGINT
BIGINT

time
TOTAL_COMPILATIONS
BIGINT
BIGINT

time
_PROC_TIME
BIGINT

BIGINT

complications
TOTAL_SECTION_TIME
BIGINT
BIGINT

time
BIGINT

executions
TOTAL_ACT_TIME
BIGINT
TOTAL_ACT_WAIT_TIME
BIGINT
ACT_RQSTS_TOTAL
BIGINT
TOTAL_ROUTINE_TIME
BIGINT
BIGINT

invocations
TOTAL_COMMIT_TIME
BIGINT
BIGINT

time
TOTAL_APP_COMMITS
BIGINT
INT_COMMITS
BIGINT
TOTAL_ROLLBACK_TIME
BIGINT
BIGINT

time
TOTAL_APP_ROLLBACKS
BIGINT
INT_ROLLBACKS
BIGINT
TOTAL_RUNSTATS_TIME
BIGINT
BIGINT

processing time
TOTAL_RUNSTATS
BIGINT
TOTAL_REORG_TIME
BIGINT
BIGINT

processing time
TOTAL_REORGS
BIGINT
758

Column Name
Data Type
TOTAL_LOAD_TIME
BIGINT
BIGINT
TOTAL_LOADS
BIGINT
CAT_CACHE_INSERTS
BIGINT
CAT_CACHE_LOOKUPS
BIGINT
PKG_CACHE_INSERTS
BIGINT
PKG_CACHE_LOOKUPS
BIGINT
THRESH_VIOLATIONS
BIGINT
BIGINT

exceeded
UOW_LOG_SPACE_USED
BIGINT
uow_log_space_used - Unit of Work Log Space

Used
LOCK_WAITS_GLOBAL
BIGINT
BIGINT
BIGINT
BIGINT

escalations
BIGINT

escalations
LOCK_ESCALS_GLOBAL
BIGINT

escalations
RECLAIM_WAIT_TIME
BIGINT
_TIME
BIGINT

CF_WAITS
BIGINT
CF_WAIT_TIME
BIGINT
BIGINT

logical reads
BIGINT

physical reads
BIGINT

found data pages
BIGINT

invalid data pages
BIGINT

logical reads
BIGINT

physical reads
BIGINT

index pages found
BIGINT

invalid index pages
BIGINT

759

Column Name
Data Type
BIGINT

BIGINT

XDA data pages found
BIGINT

AUDIT_EVENTS_TOTAL
BIGINT
BIGINT
BIGINT

time
BIGINT

subsystem waits
BIGINT
audit_subsystem_wait_time - Audit subsystem

wait time
CLIENT_HOSTNAME
VARCHAR(255)
client_hostname - Client hostname monitor

element
CLIENT_PORT_NUMBER
INTEGER
client_port_number - Client port number monitor

element
BIGINT
BIGINT
BIGINT
fcm_message_recvs_total - FCM message recvs

total
BIGINT

volume
BIGINT

wait time
BIGINT

total
BIGINT

volume
BIGINT

wait time
FCM_TQ_RECVS_TOTAL
BIGINT
FCM_TQ_RECV_VOLUME
BIGINT
fcm_tq_recv_volume - FCM tablequeue recv

volume
BIGINT
fcm_tq_recv_wait_time - FCM tablequeue recv

wait time
FCM_TQ_SENDS_TOTAL
BIGINT
FCM_TQ_SEND_VOLUME
BIGINT

volume
BIGINT
fcm_tq_send_wait_time - FCM tablequeue send

wait time
LAST_EXECUTABLE_ID
VARCHAR(32) FOR last_executable_id - Last executable identifier

BIT DATA
LAST_REQUEST_TYPE
VARCHAR(32)
760

Column Name
Data Type
_TIME
BIGINT

BIGINT

code time
TQ_TOT_SEND_SPILLS
BIGINT

buffers overflowed
EVMON_WAIT_TIME
BIGINT
EVMON_WAITS_TOTAL
BIGINT
_TIME
BIGINT

latch wait time
BIGINT

waits
VARCHAR(3)
intra_parallel_state - Currentstate of intrapartition

parallelism
BIGINT

fabrication time
TOTAL_STATS_FABRICATION_PROC
_TIME
BIGINT

BIGINT
BIGINT

RUNSTATS time
BIGINT

TOTAL_SYNC_RUNSTATS
BIGINT

RUNSTATS activities
BIGINT

queue time
TOTAL_PEDS
BIGINT
DISABLED_PEDS
BIGINT
POST_THRESHOLD_PEDS
BIGINT

threshold
TOTAL_PEAS
BIGINT
POST_THRESHOLD_PEAS
BIGINT

threshold
BIGINT

requests
BIGINT

rejections
BIGINT

BIGINT

BIGINT

761

Column Name
Data Type
_REQS
BIGINT
monitor element
POOL_QUEUED_ASYNC_TEMP_INDEX BIGINT
_REQS
monitor element
_REQS

monitor element
BIGINT
POOL_QUEUED_ASYNC_OTHER_REQS BIGINT
POOL_QUEUED_ASYNC_DATA_PAGES BIGINT

_PAGES
BIGINT

BIGINT

_PAGES
BIGINT

monitor element
POOL_QUEUED_ASYNC_TEMP_INDEX BIGINT
_PAGES
monitor element
_PAGES
BIGINT

monitor element
BIGINT

BIGINT

BIGINT

_REQS
BIGINT

monitor element
_REQS
BIGINT

monitor element
_REQS
BIGINT

monitor element
BIGINT

PREFETCH_WAIT_TIME
BIGINT
PREFETCH_WAITS
BIGINT

element
BIGINT

762

Column Name
Data Type
BIGINT

BIGINT

BIGINT

_TIME
BIGINT

or switch user request processing time monitor
element
BIGINT

TOTAL_CONNECT_AUTHENTICATION BIGINT
_TIME
TOTAL_CONNECT_AUTHENTICATION BIGINT
_PROC_TIME
element
TOTAL_CONNECT
_AUTHENTICATIONS
BIGINT
switch user authentications performed monitor
element
_FOUND_IN_LBP
BIGINT
_FOUND_IN_LBP
BIGINT

_FOUND_IN_LBP
BIGINT
COMM_EXIT_WAIT_TIME
BIGINT

COMM_EXIT_WAITS
BIGINT

IDA_SEND_WAIT_TIME
BIGINT

IDA_SENDS_TOTAL
BIGINT

IDA_SEND_VOLUME
BIGINT

server to an in-database analytics process. The
IDA_RECV_WAIT_TIME
BIGINT

IDA_RECVS_TOTAL
BIGINT

IDA_RECV_VOLUME
BIGINT

MEMBER_SUBSET_ID
INTEGER
763

Column Name
Data Type
IS_SYSTEM_APPL
SMALLINT

element
LOCK_TIMEOUT_VAL
BIGINT

element
CURRENT_ISOLATION
CHAR(2)
NUM_LOCKS_WAITING
BIGINT

monitor element
ROWS_DELETED
BIGINT
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
TOTAL_HASH_JOINS
BIGINT

element
TOTAL_HASH_LOOPS
BIGINT

element
HASH_JOIN_OVERFLOWS
BIGINT

monitor element
BIGINT

BIGINT

TOTAL_OLAP_FUNCS
BIGINT

element
OLAP_FUNC_OVERFLOWS
BIGINT

monitor element
DYNAMIC_SQL_STMTS
BIGINT

STATIC_SQL_STMTS
BIGINT

monitor element
FAILED_SQL_STMTS
BIGINT

monitor element
SELECT_SQL_STMTS
BIGINT

monitor element
UID_SQL_STMTS
BIGINT

DDL_SQL_STMTS
BIGINT

MERGE_SQL_STMTS
BIGINT
XQUERY_STMTS
BIGINT

monitor element
IMPLICIT_REBINDS
BIGINT
BINDS_PRECOMPILES
BIGINT

monitor element
INT_ROWS_DELETED
BIGINT

element
INT_ROWS_INSERTED
BIGINT

element
764

Column Name
Data Type
INT_ROWS_UPDATED
BIGINT

monitor element
CALL_SQL_STMTS
BIGINT
POOL_COL_L_READS
BIGINT

logical reads
BIGINT

POOL_COL_P_READS
BIGINT

physical reads
BIGINT

BIGINT

POOL_COL_WRITES
BIGINT

writes
BIGINT

BIGINT

BIGINT

POOL_COL_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
BIGINT
prefetch requests
POOL_QUEUED_ASYNC_
TEMP_COL_REQS
BIGINT
POOL_QUEUED_ASYNC_
COL_PAGES
BIGINT
POOL_QUEUED_ASYNC_
TEMP_COL_PAGES
BIGINT

requests
BIGINT
POOL_FAILED_ASYNC_
TEMP_COL_REQS
BIGINT
TOTAL_COL_TIME
BIGINT
TOTAL_COL_PROC_TIME
BIGINT

processing time
BIGINT

executions
CLIENT_IPADDR
VARCHAR(128)
BIGINT

UOW_STOP_TIME
TIMESTAMP

monitor element
765

Column Name
Data Type
PREV_UOW_STOP_TIME
TIMESTAMP

UOW_COMP_STATUS
VARCHAR(14)
uow_comp_status - Unit of Work Completion

Status monitor element
NUM_ASSOC_AGENTS
BIGINT

monitor element
BIGINT

monitor element
L_READS
BIGINT
L_READS
BIGINT
POOL_XDA_CACHING_TIER_L_
READS
BIGINT
POOL_COL_CACHING_TIER_L_
READS
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
READ_TIME
BIGINT
WRITE_TIME
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
GBP_INVALID_PAGES
BIGINT
766

Column Name
Data Type
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
TOTAL_HASH_GRPBYS
BIGINT

operations
BIGINT
BIGINT

threshold
EXECUTION_ID
VARCHAR(128)
BIGINT

Usage notes
The metrics returned by the MON_GET_UNIT_OF_WORK table function represent
the accumulation of all metrics for requests that were submitted during a unit of
work. Metrics are rolled up periodically during the unit of work. Therefore, the
values reported by this table function reflect the current state of the system at the
time of the most recent rollup. Metrics are strictly increasing in value. To determine
the value of a given metric for an in interval of time, use the function to query the
metric at the start and end of the interval, and compute the difference.
metrics have been disabled at the database level, and for a service superclass, the
metrics reported for each unit of work mapped to that service superclass stop
time).
The MON_GET_UNIT_OF_WORK table function returns one row of data per unit
of work and per member. No aggregation across units of work (on a member), or
across members (for a service class or more), is performed. However, aggregation
can be achieved through SQL queries. The input parameters have the effect of
being ANDed together.
767
Example
Identify the units of work that are consuming the highest amount of CPU time on
the system.
uow_id,
total_cpu_time,
app_rqsts_completed_total,
FROM TABLE(MON_GET_UNIT_OF_WORK(NULL,-1)) AS t

APPLICATION_HANDLE
UOW_ID
TOTAL_CPU_TIME
...
-------------------- ----------- -------------------- ...
46
5
27959 ...

... APP_RQSTS_COMPLETED_TOTAL RQSTS_COMPLETED_TOTAL
... ------------------------- --------------------...
72
48
MON_GET_UNIT_OF_WORK_DETAILS table function - Get detailed unit of

work metrics:
The MON_GET_UNIT_OF_WORK_DETAILS table function returns detailed
metrics for one or more units of work.
Authorization
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_UNIT_OF_WORK_DETAILS (
application_handle ,
member
)
,
system_appls

Routine parameters
application_handle
An input argument of type BIGINT that specifies a valid application handle in
768
the same database as the one currently connected to when calling this function.
If the argument is null, metrics are retrieved for units of work running in all
superclasses in the database.
member
system_appls
v 0 or NULL: System application information is not returned
v 1: System application information is returned
Table 182. Information returned for MON_GET_UNIT_OF_WORK_DETAILS
Column Name
Data Type
VARCHAR(128)
service_superclass_name - Service superclass

name
VARCHAR(128)
SERVICE_CLASS_ID
INTEGER
MEMBER
SMALLINT
COORD_MEMBER
SMALLINT
coord_member - Coordinator member Database

member for the coordinator partition of the given
unit of work.
APPLICATION_HANDLE
BIGINT
WORKLOAD_NAME
VARCHAR(128)
INTEGER

identifier. This ID does not uniquely identify the
workload occurrence unless it is coupled with
the coordinator database partition number and
the workload name.
UOW_ID
INTEGER
DETAILS
BLOB(1M)
XML document that contains detailed metrics for

the unit of work. See Table 183 on page 770 for a
description of the elements in this document.
<db2_unit_of_work xmlns="http://www.ibm.com/xmlns/prod/db2/mon" release="90700000">
<service_superclass_name>SYSDEFAULTUSERCLASS</service_superclass_name>
<service_subclass_name>SYSDEFAULTSUBCLASS</service_subclass_name>
<service_class_id>13</service_class_id>
<workload_name>SYSDEFAULTUSERWORKLOAD</workload_name>
<member>0</member>
<coord_member>0</coord_member>
<workload_occurrence_id>1</workload_occurrence_id>
<uow_id>2</uow_id>
<workload_occurrence_state>UOWEXEC</workload_occurrence_state>
<system_metrics>
769
...
</system_metrics>
</db2_unit_of_work_metrics>

Table 183. Detailed metrics returned for MON_GET_UNIT_OF_WORK_DETAILS
Element Name
Data Type
act_aborted_total
act_completed_total
act_rejected_total
act_rqsts_total
agent_wait_time
agent_waits_total




requests completed
application_handle
application_id
xs:string
audit_events_total
xs:nonNetagiveIngteger

time

time

waits
binds_precompiles
xs:long

monitor element
call_sql_stmts
xs:long
cat_cache_inserts
cat_cache_lookups
client_acctng
xs:string
client_applname
xs:string
client_hostname
xs:string
client_hostname - Client hostname
client_ipaddr
xs:string
client_port_number
client_port_number - Client port number
client_userid
xs:string
client_wrkstnname
xs:string
770
Table 183. Detailed metrics returned for MON_GET_UNIT_OF_WORK_DETAILS (continued)

Element Name
Data Type
comm_exit_wait_time

comm_exit_waits

coord_member
coord_member - Coordinator member
current_isolation
xs:string
ddl_sql_stmts
xs:long

deadlocks
direct_read_reqs
direct_read_time
direct_reads
direct_write_reqs
direct_write_time
direct_writes
disabled_peds
xs:long
dynamic_sql_stmts
xs:long

evmon_wait_time
evmon_waits_total
execution_id
xs:string(128)
failed_sql_stmts
xs:long

monitor element

volume

wait time

volume

wait time
fcm_recv_volume
fcm_recv_wait_time
fcm_recvs_total
fcm_send_volume
fcm_send_wait_time
fcm_sends_total
fcm_tq_recv_volume
771

Element Name
Data Type

time
fcm_tq_recvs_total
fcm_tq_send_volume

time
fcm_tq_sends_total
xs:long
hash_join_overflows
xs:long

element
xs:long

ida_recv_volume

reported in bytes.
ida_recv_wait_time

ida_recvs_total

ida_send_volume

server to an in-database analytics process. The value
is reported in bytes.
ida_send_wait_time

ida_sends_total

implicit_rebinds
xs:long
int_commits
int_rollbacks
int_rows_deleted
xs:long

element
int_rows_inserted
xs:long

element
int_rows_updated
xs:long

element
xs:string

ipc_recv_volume

volume
ipc_recv_wait_time

recv wait time
ipc_recvs_total

total
ipc_send_volume

volume
772

Element Name
Data Type
ipc_send_wait_time

send wait time
ipc_sends_total

total
is_system_appl
xs:short

element
last_executable_id
xs:hexBinary(32)
last_request_type
xs:string(32)
lock_escals
lock_timeout_val
xs:long

element
lock_timeouts
lock_wait_time
lock_waits
log_disk_wait_time
member
member_subset_id
xs:long
merge_sql_stmts
xs:long
num_assoc_agents
xs:long

monitor element
num_locks_held
num_locks_waiting
xs:long
num_log_buffer_full

exceeded
olap_func_overflows
xs:long

monitor element
pkg_cache_inserts
pkg_cache_lookups
pool_col_gbp_indep_
pages_found_in_lbp


GBP logical reads

pool_col_l_reads

logical reads

773

Element Name
Data Type
pool_col_p_reads

physical reads
pool_col_writes

writes
_found_in_lbp
pool_data_l_reads
pool_data_p_reads
pool_data_writes

prefetch requests



col_reqs
_reqs

element
_index_reqs

element
_reqs

element

_found_in_lbp
pool_index_l_reads
pool_index_p_reads

reads
pool_index_writes
pool_queued_async_
col_pages
prefetch requests
pool_queued_async_data_pages xs:nonNegativeInteger


774

Element Name
Data Type
_pages


pool_queued_async_
temp_col_pages
pool_queued_async_
temp_col_reqs
_pages

element
_reqs

pool_queued_async_temp
_index_pages

element
_index_reqs
element
_pages

monitor element
_reqs

element
The number of XML storage object (XDA) data pages

successfully requested for prefetching.

pool_read_time



logical reads

data physical reads

index logical reads


data logical reads

775

Element Name
Data Type
pool_write_time

time
_found_in_lbp



pool_xda_l_reads

reads

data pages found
pool_xda_p_reads

reads
pool_xda_writes
xs:long

xs:long

threshold
xs:long

monitor element
xs:long

monitor element
post_threshold_peas
xs:long

threshold
post_threshold_peds
xs:long
prefetch_wait_time
prefetch_waits

element
prev_uow_stop_time
xs:dateTime

rows_deleted
xs:long
rows_inserted
xs:long
rows_modified
rows_read
rows_returned
rows_updated
xs:long
select_sql_stmts
xs:long

monitor element
776

Element Name
Data Type
service_class_id
xs:string (128)
xs:string (128)
session_auth_id
xs:string
sort_overflows
sql_reqs_since_commit
xs:long

static_sql_stmts
xs:long

monitor element
tcpip_recv_volume
tcpip_recvs_total
tcpip_send_volume
tcpip_sends_total
thresh_violations
total_act_time
total_act_wait_time
total_app_commits
total_app_rollbacks
total_app_rqst_time

executions

executions
total_col_proc_time

processing time
total_col_time

time
total_commit_time
total_compilations

time
total_compile_time
total_connect
_authentication_proc_time
total_connect
_authentication_time

or switch user authentication request time

total_connect_request_proc
_time

777

Element Name
Data Type

switch user request time

requests
total_cpu_time
xs:long

queue time
total_extended_latch_wait
_time

wait time

waits
total_hash_grpbys
xs:long
total_hash_joins
xs:long
total_hash_loops
xs:long

complications
total_implicit_compile
_ proc_time


time
total_load_time
total_loads
total_olap_funcs
xs:long

element
total_peas
xs:long
total_peds
xs:long

processing time
total_reorg_time
total_reorgs

time
total_rollback_time
total_routine_time
total_routine_user_code
_proc_time


code time
total_rqst_time
total_runstats

processing time
778

Element Name
Data Type
total_runstats_time

time

processing time
total_section_sorts
total_section_time
total_sorts
total_stats_fabrication
_proc_time


fabrication time
total_sync_runstats

activities
total_sync_runstats_proc
_time


RUNSTATS time
total_wait_time
xs:long

rejections
xs:long

requests
tq_tot_send_spills

buffers overflowed
uid_sql_stmts
xs:long

uow_comp_status
xs:string
uow_comp_status - Unit of Work Completion Status

monitor element
uow_id
uow_log_space_used
uow_log_space_used - Unit of Work Log Space Used
uow_start_time
xs:dateTime
uow_start_time - Unit of Work Start Timestamp
uow_stop_time
xs:dateTime

monitor element


queue time
workload_name
xs:string (128)
workload_occurrence_id

identifier This ID does not uniquely identify the
workload occurrence unless it is coupled with the
coordinator member and the workload name.
779

Element Name
Data Type
workload_occurrence_state
xs:string

state
xquery_stmts
xs:long

monitor element
Usage notes
The metrics returned by the MON_GET_UNIT_OF_WORK_DETAILS function
represent the accumulation of all metrics for requests that were submitted during a
unit of work. This function is similar to the MON_GET_UNIT_OF_WORK table
function:
v The MON_GET_UNIT_OF_WORK table function returns the most commonly
used metrics in a column based format and is the most performance efficient
method of retrieving metrics.
v The MON_GET_UNIT_OF_WORK_DETAILS table function returns the entire set
of available metrics in an XML document format, which provides maximum
flexibility for formatting output. The XML based output can be parsed directly
Metrics are rolled up periodically during the unit of work. Therefore, the values
reported by this table function reflect the current state of the system at the time of
the most recent rollup. Metrics are strictly increasing in value. To determine the
value of a given metric for an interval of time, use the MON_GET_UNIT OF
WORK_DETAILS table function to query the metric at the start and end of the
interval, and compute the difference.
metrics reported for each unit of work that are mapped to that service superclass
activation time).
The MON_GET_UNIT_OF_WORK_DETAILS table function returns one row of
data per unit of work and per member. No aggregation across units of work (on a
member), or across members (for a service class or more), is performed. However,
aggregation can be achieved through SQL queries. The input parameters have the
effect of being ANDed together.
Example
Identify the units of work that are consuming the highest amount of CPU time on
the system.
780
SELECT detmetrics.application_handle,
detmetrics.uow_id,
detmetrics.total_cpu_time,
detmetrics.app_rqsts_completed_total,
detmetrics.rqsts_completed_total
FROM TABLE(MON_GET_UNIT_OF_WORK_DETAILS(NULL,-2)) AS UOWMETRICS,
XMLTABLE (
XMLNAMESPACES( DEFAULT http://www.ibm.com/xmlns/prod/db2/mon),
$detmetric/db2_unit_of_work PASSING
XMLPARSE(DOCUMENT UOWMETRICS.DETAILS)
as "detmetric"
COLUMNS
"APPLICATION_HANDLE" INTEGER PATH application_handle,
"UOW_ID" INTEGER PATH uow_id,
"TOTAL_CPU_TIME" INTEGER PATH system_metrics/total_cpu_time,
"APP_RQSTS_COMPLETED_TOTAL" INTEGER
PATH system_metrics/app_rqsts_completed_total,
"RQSTS_COMPLETED_TOTAL" INTEGER
PATH system_metrics/rqsts_completed_total
) AS DETMETRICS

APPLICATION_HANDLE
UOW_ID
TOTAL_CPU_TIME
...
-------------------- ----------- -------------------- ...
46
5
27959 ...

... APP_RQSTS_COMPLETED_TOTAL RQSTS_COMPLETED_TOTAL
... ------------------------- --------------------...
72
48
MON_GET_USAGE_LIST_STATUS table function - Returns the status on a

usage list:
The MON_GET_USAGE_LIST_STATUS table function returns current status of a
usage list.
Syntax
MON_GET_USAGE_LIST_STATUS ( usagelistschema
usagelistname , member

usagelistschema
is NULL or an empty string, usage lists are retrieved in all schemas in the
specified schema.
usagelistname
An input argument of type VARCHAR(128) that specifies a usage list that
resides in the currently connected database when calling this function. If
781
usagelistname is NULL or an empty string, then the status for all usage lists
from the schemas identified by the usagelistschema that exist are retrieved. If
specified, only the status for the usage list specified from the schemas
identified by the usagelistschema is returned.
member
Authorization
v DBADM authority
v SQLADM authority
None
Usage notes
The MON_GET_USAGE_LIST_STATUS function does not report information about
usage lists that are in the released state. A usage list is considered to be in the
released state if it is defined and has not been activated (explicitly or
automatically) or has been released using the SET USAGE LIST STATE statement.
If a usage list is activated (explicitly or automatically) then the state of the usage
list is set to activation pending and the memory allocation for the usage list is
deferred until the table or index for which the usage list is defined is first
referenced by a section. At which point the state of the usage list is set to active. If
the memory for the usage list cannot be allocated, then the state of the usage list is
set to failed and it must be explicitly activated using the SET USAGE LIST STATE
statement.
Table 184. Information returned for MON_GET_USAGE_LIST_STATUS
Column Name
Data Type
Description
USAGELISTSCHEMA
VARCHAR(128)
USAGELISTNAME
VARCHAR(128)
OBJECTSCHEMA
VARCHAR(128)
object_schema - Object schema
OBJECTNAME
VARCHAR(128)
OBJECTTYPE
CHAR(1)
objtype - Object type
MEMBER
SMALLINT
DATA_PARTITION_ID
INTEGER
STATE
CHAR(1)
usage_list_state - Usage list state
LAST_STATE_CHANGE
TIMESTAMP
usage_list_last_state_change - Last state change
LIST_SIZE
INTEGER
usage_list_size - Usage list size
782
Table 184. Information returned for MON_GET_USAGE_LIST_STATUS (continued)

Column Name
Data Type
Description
USED_ENTRIES
INTEGER
usage_list_used_entries - Usage list used entries
LIST_MEM_SIZE
INTEGER
usage_list_mem_size - Usage list memory size
WRAPPED
CHAR(1)
usage_list_wrapped - Usage list wrap indicator
MON_GET_UTILITY table function - Get utilities running on the database:

The MON_GET_UTILITY table function returns information about utilities
currently running on the database.
Authorization
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_UTILITY (
member

Routine parameters
member
applications.
Table 185. Information returned by the MON_GET_UTILITY routine
Column name
Data type
Description
MEMBER
SMALLINT

monitor element
COORD_MEMBER
SMALLINT
coord_member - Coordinator
member monitor element
APPLICATION_HANDLE
BIGINT
application_handle - Application
handle monitor element
APPLICATION_ID
VARCHAR(128)
appl_id - Application ID monitor

element
APPLICATION_NAME
VARCHAR(128)

monitor element
783
Table 185. Information returned by the MON_GET_UTILITY routine (continued)

Column name
Data type
Description
SESSION_AUTH_ID
VARCHAR(128)
session_auth_id - Session
authorization ID monitor
element
CLIENT_WRKSTNNAME
VARCHAR(255)
client_wrkstnname - Client
workstation name monitor
element
CLIENT_ACCTNG
VARCHAR(255)
client_acctng - Client accounting

string monitor element
CLIENT_USERID
VARCHAR(255)
client_userid - Client user ID

monitor element
CLIENT_APPLNAME
VARCHAR(255)
client_applname - Client
application name monitor
element
VARCHAR(32) FOR BIT DATA
utility_invocation_id - Utility
invocation ID monitor element
UTILITY_ID
INTEGER
utility_id - Utility ID
Unique to a database partition.
UTILITY_START_TIME
TIMESTAMP
utility_start_time - Utility start

time
UTILITY_TYPE
VARCHAR(16)
utility_type - Utility type

This interface returns a text
identifier based on the defines in
sqlmon.h and is one of:
v ASYNC_INDEX_CLEANUP
v BACKUP
v CRASH_RECOVERY
v LOAD
v REBALANCE
v REDISTRIBUTE
v RESTART_RECREATE_INDEX
v RESTORE
v ROLLFORWARD_RECOVERY
v RUNSTATS
v GROUP_CRASH_RECOVERY
v MEMBER_CRASH_RECOVERY
UTILITY_OPERATION_TYPE
CHAR(1)
utility_operation_type - Utility
operation type monitor element
UTILITY_INVOKER_TYPE
VARCHAR(4)
utility_invoker_type - Utility
invoker type
v AUTO
v USER
UTILITY_PRIORITY
INTEGER
utility_priority - Utility priority

Priority if utility supports
throttling, otherwise null.
784
OBJECT_TYPE
VARCHAR(16)

element
OBJECT_SCHEMA
VARCHAR(128)
object_schema - Object schema

monitor element
Table 185. Information returned by the MON_GET_UTILITY routine (continued)

Column name
Data type
Description
OBJECT_NAME
VARCHAR(128)

monitor element
NUM_TBSPS
INTEGER
num_tbsps - Number of table

spaces monitor element
TBSP_NAMES
CLOB(5M)
tbsp_names - Table space names

monitor element
UTILITY_DETAIL
CLOB(2M)
utility_detail - Utility detail

monitor element
Example
List all LOAD commands currently running on the database server and provide
information about the applications and the users running the command.
SELECT COORD_MEMBER, APPLICATION_HANDLE AS APPHDL,
SUBSTR(APPLICATION_NAME, 1, 10) AS APPNAME,
SUBSTR(SESSION_AUTH_ID, 1, 10) AS USER,
SUBSTR(UTILITY_DETAIL, 1, 150) AS CMD
FROM TABLE(MON_GET_UTILITY(-2)) AS T
The following result is output:

COORD_MEMBER APPHDL
------------ -------------------0
736
0
724
APPNAME
---------db2bp
db2bp
USER
---------USER2
USER1
...
...
...
...
...
...
...
...
CMD
---------------------------------------------------------------------------- ...
[LOADID: 63.2013-02-01-09.48.42.976823.0 (2;21)] [*LOCAL.user2.130201144359] ...
[LOADID: 20.2013-02-01-09.43.49.510806.0 (2;20)] [*LOCAL.user1.130201144240] ...
...
...
...
...
CMD (continued)
---------------------------------------------------------------------------OFFLINE LOAD DEL AUTOMATIC INDEXING INSERT COPY NO SCHEMA2.T2
OFFLINE LOAD DEL AUTOMATIC INDEXING INSERT COPY NO SCHEMA1.T1
MON_GET_WORKLOAD table function - Get workload metrics:

The MON_GET_WORKLOAD table function returns metrics for one or more
workloads.
Authorization
v
v
v
v

DBADM authority
SQLADM authority

None
785
Syntax
MON_GET_WORKLOAD (
workload_name
, member

Routine parameters
workload_name
An input argument of type VARCHAR(128) that specifies a specific workload
for which the metrics are to be returned. If the argument is NULL or an empty
string, metrics are returned for all workloads.
member
Table 186. Information returned for MON_GET_WORKLOAD
Column Name
Data Type
WORKLOAD_NAME
VARCHAR(128)
WORKLOAD_ID
INTEGER
workload_id - Workload ID
MEMBER
SMALLINT
ACT_ABORTED_TOTAL
BIGINT
ACT_COMPLETED_TOTAL
BIGINT
ACT_REJECTED_TOTAL
BIGINT
AGENT_WAIT_TIME
BIGINT
AGENT_WAITS_TOTAL
BIGINT
POOL_DATA_L_READS
BIGINT
POOL_INDEX_L_READS
BIGINT
BIGINT

logical reads
BIGINT

index logical reads
BIGINT

data logical reads
POOL_XDA_L_READS
BIGINT

reads
POOL_DATA_P_READS
BIGINT
POOL_INDEX_P_READS
BIGINT

reads
BIGINT

data physical reads
BIGINT

BIGINT

786
Table 186. Information returned for MON_GET_WORKLOAD (continued)

Column Name
Data Type
POOL_XDA_P_READS
BIGINT

reads
POOL_DATA_WRITES
BIGINT
POOL_INDEX_WRITES
BIGINT
POOL_XDA_WRITES
BIGINT
POOL_READ_TIME
BIGINT
POOL_WRITE_TIME
BIGINT

time
BIGINT
DEADLOCKS
BIGINT
DIRECT_READS
BIGINT
DIRECT_READ_TIME
BIGINT
DIRECT_WRITES
BIGINT
DIRECT_WRITE_TIME
BIGINT
DIRECT_READ_REQS
BIGINT
DIRECT_WRITE_REQS
BIGINT
FCM_RECV_VOLUME
BIGINT
FCM_RECVS_TOTAL
BIGINT
FCM_SEND_VOLUME
BIGINT
FCM_SENDS_TOTAL
BIGINT
FCM_RECV_WAIT_TIME
BIGINT
FCM_SEND_WAIT_TIME
BIGINT
IPC_RECV_VOLUME
BIGINT

volume
IPC_RECV_WAIT_TIME
BIGINT

wait time
IPC_RECVS_TOTAL
BIGINT

total
IPC_SEND_VOLUME
BIGINT

volume
IPC_SEND_WAIT_TIME
BIGINT

send wait time
IPC_SENDS_TOTAL
BIGINT

total
LOCK_ESCALS
BIGINT
LOCK_TIMEOUTS
BIGINT
LOCK_WAIT_TIME
BIGINT
LOCK_WAITS
BIGINT
BIGINT
NUM_LOG_BUFFER_FULL
BIGINT
LOG_DISK_WAIT_TIME
BIGINT
BIGINT
787

Column Name
Data Type
BIGINT
ROWS_MODIFIED
BIGINT
ROWS_READ
BIGINT
ROWS_RETURNED
BIGINT
TCPIP_RECV_VOLUME
BIGINT
TCPIP_SEND_VOLUME
BIGINT
BIGINT
TCPIP_RECVS_TOTAL
BIGINT
BIGINT
TCPIP_SENDS_TOTAL
BIGINT
TOTAL_APP_RQST_TIME
BIGINT
TOTAL_RQST_TIME
BIGINT
BIGINT

queue time
WLM_QUEUE_ASSIGNMENTS
_TOTAL
BIGINT

TOTAL_CPU_TIME
BIGINT
TOTAL_WAIT_TIME
BIGINT
BIGINT

completed
BIGINT
BIGINT

processing time
TOTAL_SECTION_SORTS
BIGINT
TOTAL_SORTS
BIGINT
BIGINT
BIGINT
SORT_OVERFLOWS
BIGINT
TOTAL_COMPILE_TIME
BIGINT
BIGINT

time
TOTAL_COMPILATIONS
BIGINT
BIGINT

time
_PROC_TIME
BIGINT

BIGINT

complications
TOTAL_SECTION_TIME
BIGINT
BIGINT
BIGINT

executions
TOTAL_ACT_TIME
BIGINT
total_activity_time - Total activity time
788

Column Name
Data Type
TOTAL_ACT_WAIT_TIME
BIGINT
total_activity_wait_time - Total activity wait time
ACT_RQSTS_TOTAL
BIGINT
TOTAL_ROUTINE_TIME
BIGINT
BIGINT
TOTAL_COMMIT_TIME
BIGINT
BIGINT

time
TOTAL_APP_COMMITS
BIGINT
INT_COMMITS
BIGINT
TOTAL_ROLLBACK_TIME
BIGINT
BIGINT

time
TOTAL_APP_ROLLBACKS
BIGINT
INT_ROLLBACKS
BIGINT
TOTAL_RUNSTATS_TIME
BIGINT
BIGINT

processing time
TOTAL_RUNSTATS
BIGINT
TOTAL_REORG_TIME
BIGINT
BIGINT

processing time
TOTAL_REORGS
BIGINT
TOTAL_LOAD_TIME
BIGINT
BIGINT
TOTAL_LOADS
BIGINT
CAT_CACHE_INSERTS
BIGINT
CAT_CACHE_LOOKUPS
BIGINT
PKG_CACHE_INSERTS
BIGINT
PKG_CACHE_LOOKUPS
BIGINT
THRESH_VIOLATIONS
BIGINT
hresh_violations - Number of threshold violations
BIGINT

exceeded
LOCK_WAITS_GLOBAL
BIGINT
BIGINT
BIGINT
BIGINT

escalations
BIGINT

escalations
LOCK_ESCALS_GLOBAL
BIGINT
RECLAIM_WAIT_TIME
BIGINT
789

Column Name
Data Type
_TIME
BIGINT

reclaim wait time
CF_WAITS
BIGINT
CF_WAIT_TIME
BIGINT
BIGINT

logical reads
BIGINT

physical reads
BIGINT
pool_data_lbp_pages_found - Local buffer pool found

data pages
BIGINT

invalid data pages
BIGINT

logical reads
BIGINT

physical reads
BIGINT

index pages found
BIGINT

invalid index pages
BIGINT

BIGINT

BIGINT

data pages found
BIGINT

AUDIT_EVENTS_TOTAL
BIGINT
BIGINT
BIGINT

time
BIGINT

waits
BIGINT

time
BIGINT
BIGINT
BIGINT
BIGINT

volume
BIGINT

wait time
BIGINT
BIGINT

volume
790

Column Name
Data Type
BIGINT

wait time
FCM_TQ_RECVS_TOTAL
BIGINT
FCM_TQ_RECV_VOLUME
BIGINT
BIGINT

time
FCM_TQ_SENDS_TOTAL
BIGINT
FCM_TQ_SEND_VOLUME
BIGINT
BIGINT

time
TOTAL_ROUTINE_USER_CODE
_PROC_TIME
BIGINT

BIGINT

code time
TQ_TOT_SEND_SPILLS
BIGINT

buffers overflowed
EVMON_WAIT_TIME
BIGINT
EVMON_WAITS_TOTAL
BIGINT
_TIME
BIGINT

wait time
BIGINT

waits
BIGINT

fabrication time
TOTAL_STATS_FABRICATION
_PROC_TIME
BIGINT

BIGINT
BIGINT

RUNSTATS time
TOTAL_SYNC_RUNSTATS_PROC
_TIME
BIGINT

TOTAL_SYNC_RUNSTATS
BIGINT

activities
BIGINT

queue time
TOTAL_PEDS
BIGINT
DISABLED_PEDS
BIGINT
POST_THRESHOLD_PEDS
BIGINT
TOTAL_PEAS
BIGINT
POST_THRESHOLD_PEAS
BIGINT

threshold
BIGINT

requests
BIGINT

rejections
791

Column Name
Data Type
BIGINT

_REQS
BIGINT

BIGINT

monitor element
_REQS
BIGINT

_INDEX_REQS
BIGINT

_REQS
BIGINT

element
_REQS
BIGINT
_PAGES
BIGINT

_PAGES
BIGINT

BIGINT

_PAGES
BIGINT

element
_INDEX_PAGES
BIGINT

element
_PAGES
BIGINT

monitor element
BIGINT

BIGINT

BIGINT

_REQS
BIGINT

element
POOL_FAILED_ASYNC_TEMP
_INDEX_REQS
BIGINT

element
_REQS
BIGINT

element
BIGINT

PREFETCH_WAIT_TIME
BIGINT
792

Column Name
Data Type
PREFETCH_WAITS
BIGINT

element
BIGINT

BIGINT

BIGINT

BIGINT

_TIME
BIGINT

BIGINT

TOTAL_CONNECT
_AUTHENTICATION_TIME
BIGINT

or switch user authentication request time monitor
element
TOTAL_CONNECT
_AUTHENTICATION_PROC_TIME
BIGINT
element
TOTAL_CONNECT
_AUTHENTICATIONS
BIGINT

user authentications performed monitor element
_FOUND_IN_LBP
BIGINT
_FOUND_IN_LBP
BIGINT
_FOUND_IN_LBP
BIGINT
COMM_EXIT_WAIT_TIME
BIGINT

COMM_EXIT_WAITS
BIGINT

IDA_SEND_WAIT_TIME
BIGINT
ida_send_wait_time - Time spent waiting to send data

monitor element
IDA_SENDS_TOTAL
BIGINT
ida_sends_total - Number of times data sent monitor

element
IDA_SEND_VOLUME
BIGINT

element
IDA_RECV_WAIT_TIME
BIGINT
ida_recv_wait_time - Time spent waiting to receive

IDA_RECVS_TOTAL
BIGINT

monitor element
IDA_RECV_VOLUME
BIGINT

monitor element
ROWS_DELETED
BIGINT

793

Column Name
Data Type
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
TOTAL_HASH_JOINS
BIGINT
TOTAL_HASH_LOOPS
BIGINT
HASH_JOIN_OVERFLOWS
BIGINT

element
BIGINT

BIGINT

TOTAL_OLAP_FUNCS
BIGINT

element
OLAP_FUNC_OVERFLOWS
BIGINT

monitor element
DYNAMIC_SQL_STMTS
BIGINT

STATIC_SQL_STMTS
BIGINT

monitor element
FAILED_SQL_STMTS
BIGINT

monitor element
SELECT_SQL_STMTS
BIGINT

monitor element
UID_SQL_STMTS
BIGINT

DDL_SQL_STMTS
BIGINT

MERGE_SQL_STMTS
BIGINT
XQUERY_STMTS
BIGINT

monitor element
IMPLICIT_REBINDS
BIGINT
BINDS_PRECOMPILES
BIGINT

monitor element
INT_ROWS_DELETED
BIGINT

element
INT_ROWS_INSERTED
BIGINT

element
INT_ROWS_UPDATED
BIGINT

element
CALL_SQL_STMTS
BIGINT
POOL_COL_L_READS
BIGINT

logical reads
BIGINT

POOL_COL_P_READS
BIGINT

physical reads
794

Column Name
Data Type
BIGINT

BIGINT

POOL_COL_WRITES
BIGINT

writes
BIGINT

GBP logical reads
BIGINT

GBP physical reads
BIGINT

POOL_COL_GBP_INDEP_
PAGES_FOUND_IN_LBP
BIGINT
BIGINT
prefetch requests
POOL_QUEUED_ASYNC_
TEMP_COL_REQS
BIGINT
POOL_QUEUED_ASYNC_
COL_PAGES
BIGINT
POOL_QUEUED_ASYNC_
TEMP_COL_PAGES
BIGINT
BIGINT

prefetch requests
POOL_FAILED_ASYNC_
TEMP_COL_REQS
BIGINT
TOTAL_COL_TIME
BIGINT
TOTAL_COL_PROC_TIME
BIGINT

processing time
BIGINT

executions
BIGINT

monitor element
L_READS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
L_READS
BIGINT
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
795

Column Name
Data Type
PAGE_WRITES
BIGINT
PAGE_WRITES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
PAGE_UPDATES
BIGINT
READ_TIME
BIGINT
WRITE_TIME
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
PAGES_FOUND
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
GBP_INVALID_PAGES
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
TOTAL_HASH_GRPBYS
BIGINT
BIGINT
BIGINT

threshold
BIGINT

monitor element
796
Usage notes
The metrics returned by the MON_GET_WORKLOAD table function represent the
accumulation of all metrics for requests that were submitted by connections
mapped to the identified workload object. Metrics are rolled up to a workload on
unit of work boundaries, and periodically during the execution of requests.
Therefore, the values reported by this table function reflect the current state of the
system at the time of the most recent rollup. Metrics are strictly increasing in
value. To determine the value of a given metric for an interval of time, use the
MON_GET_WORKLOAD table function to query the metric at the start and end of
the interval, and compute the difference.
metrics have been disabled at the database level, and for a service superclass, then
the metrics reported for each workload that is mapped to that service superclass
activation time).
The MON_GET_WORKLOAD table function returns one row of data per workload
and per member. No aggregation across workloads (on a member), or across
members (for a service class or more), is performed. However, aggregation can be
achieved through SQL queries (see the example).
Example
Display lock information for each workload, aggregated across member, ordered by
highest lock wait time.
SELECT varchar(workload_name,30) as workload_name,
sum(lock_wait_time) as total_lock_wait_time,
sum(lock_waits) as total_lock_waits,
sum(lock_timeouts) as total_lock_timeouts,
sum(lock_escals) as total_lock_escals
FROM TABLE(MON_GET_WORKLOAD(,-2)) AS t
GROUP BY workload_name
ORDER BY total_lock_wait_time DESC

WORKLOAD_NAME
TOTAL_LOCK_WAIT_TIME TOTAL_LOCK_WAITS
...
------------------------------ -------------------- -------------------- ...
SYSDEFAULTADMWORKLOAD
0
0 ...
SYSDEFAULTUSERWORKLOAD
0
0 ...

... TOTAL_LOCK_TIMEOUTS TOTAL_LOCK_ESCALS
... -------------------- -------------------...
0
0
...
0
0
797
MON_GET_WORKLOAD_DETAILS table function - Get detailed workload

metrics:
The MON_GET_WORKLOAD_DETAILS table function returns detailed metrics for
one or more workloads.
Authorization
v DBADM authority
v SQLADM authority
None
Syntax
MON_GET_WORKLOAD_DETAILS (
workload_name
, member

Routine parameters
workload_name
string, metrics are returned for all workloads.
member
Table 187. Information returned for MON_GET_WORKLOAD_DETAILS
Column Name
Data Type
Description
WORKLOAD_NAME
VARCHAR(128)
WORKLOAD_ID
INTEGER
MEMBER
SMALLINT
DETAILS
BLOB(1M)
XML document that contains detailed metrics for the

workload. See Table 188 on page 799 for a description of
the elements in this document.
<db2_workload xmlns="http://www.ibm.com/xmlns/prod/db2/mon" release="90700000">
<workload_name>SYSDEFAULTADMWORKLOAD</workload_name>
<workload_id>11</workload_id>
798
<member>0</member>
...
</system_metrics>
</db2_workload>

Table 188. Detailed metrics returned for MON_GET_WORKLOAD_DETAILS
Element Name
Data Type
act_aborted_total
act_completed_total
act_rejected_total
act_rqsts_total
agent_wait_time
agent_waits_total
app_act_aborted_total - Total failed external coordinator




completed
audit_events_total
xs:nonNetagiveIngteger audit_events_total - Total audit events

waits
binds_precompiles
xs:long

monitor element
call_sql_stmts
xs:long
call_sql_stmts - CALL SQL statements executed monitor

element
cat_cache_inserts
cat_cache_lookups
comm_exit_wait_time
comm_exit_wait_time - Communication buffer exit wait

comm_exit_waits
comm_exit_waits - Communication buffer exit number

of waits monitor element
ddl_sql_stmts
xs:long

deadlocks
direct_read_reqs

799
Table 188. Detailed metrics returned for MON_GET_WORKLOAD_DETAILS (continued)

Element Name
Data Type
direct_read_time
direct_reads
direct_write_reqs
direct_write_time
direct_writes
disabled_peds
xs:long
dynamic_sql_stmts
xs:long

evmon_wait_time
evmon_waits_total
failed_sql_stmts
xs:long

element
fcm_message_recv_volume - FCM message recv volume

time
fcm_message_send_wait_time - FCM message send wait

time
fcm_recv_volume
fcm_recv_wait_time
fcm_recvs_total
fcm_send_volume
fcm_send_wait_time
fcm_sends_total
fcm_tq_recv_volume
fcm_tq_recv_wait_time - FCM tablequeue recv wait time
fcm_tq_recvs_total
fcm_tq_send_volume

time
fcm_tq_sends_total
xs:long
hash_join_overflows
xs:long

element
xs:long

monitor element
ida_recv_volume
ida_recv_volume - Total data volume received monitor

element
ida_recv_wait_time
ida_recv_wait_time - Time spent waiting to receive data

monitor element
800

Element Name
Data Type
ida_recvs_total
ida_recvs_total - Number of times data received monitor

element
ida_send_volume

element
ida_send_wait_time
ida_send_wait_time - Time spent waiting to send data

monitor element
ida_sends_total
ida_sends_total - Number of times data sent monitor

element
implicit_rebinds
xs:long
implicit_rebinds - Number of implicit rebinds monitor

element
int_commits
int_rollbacks
int_rows_deleted
xs:long

element
int_rows_inserted
xs:long

element
int_rows_updated
xs:long

element
ipc_recv_volume

volume
ipc_recv_wait_time

wait time
ipc_recvs_total
ipc_recvs_total - Interprocess communication recvs total
ipc_send_volume

volume
ipc_send_wait_time

wait time
ipc_sends_total
lock_escals
lock_timeouts
lock_wait_time
lock_waits
log_disk_wait_time
member
merge_sql_stmts
xs:long

monitor element
num_log_buffer_full

exceeded
olap_func_overflows
xs:long

monitor element
pkg_cache_inserts
801

Element Name
Data Type
pkg_cache_lookups
pool_col_gbp_indep_
pages_found_in_lbp

local buffer pool


GBP logical reads

GBP physical reads
pool_col_l_reads
pool_col_l_reads - Buffer pool column-organized logical

reads

pool_col_p_reads

physical reads
pool_col_writes
_found_in_lbp
buffer pool independent data pages found in local buffer
pool_data_l_reads
pool_data_p_reads
pool_data_writes

prefetch requests



col_reqs
_reqs
pool_failed_async_temp_data_reqs - Failed data prefetch

_index_reqs

element
_reqs
pool_failed_async_temp_xda_reqs - Failed XDA prefetch


_found_in_lbp
pool_index_l_reads
pool_index_p_reads
802

Element Name
Data Type
pool_index_writes
pool_queued_async_
col_pages
pool_queued_async_col_pages - Column-organized page

prefetch requests
prefetch requests


monitor element
_pages
pool_queued_async_index_pages - Index pages prefetch


monitor element

monitor element
pool_queued_async_
temp_col_pages
pool_queued_async_temp_col_pages - Column-organized
pool_queued_async_
temp_col_reqs
pool_queued_async_temp_col_reqs - Column-organized
_pages

element
_reqs

_index_pages

element
_index_reqs

_pages
pool_queued_async_temp_xda_pages - XDA data pages

element
_reqs
pool_queued_async_temp_xda_reqs - XDA data prefetch


monitor element
pool_read_time



logical reads

physical reads
pool_temp_index_l_reads - Buffer pool temporary index

logical reads
803

Element Name
Data Type
pool_temp_index_p_reads - Buffer pool temporary index

physical reads

data logical reads

data physical reads
pool_write_time
_found_in_lbp
pool_xda_gbp_indep_pages_found_in_lbp - Group buffer

monitor element
pool_xda_gbp_invalid_pages - Group buffer pool invalid

XDA data pages


pool_xda_l_reads
pool_xda_lbp_pages_found - Local buffer pool XDA data

pages found
pool_xda_p_reads
pool_xda_writes
xs:long

monitor element
xs:long
xs:long

monitor element
xs:long

monitor element
post_threshold_peas
xs:long
post_threshold_peds
xs:long
prefetch_wait_time
prefetch_waits
rows_deleted
xs:long
rows_inserted
xs:long
rows_modified
rows_read
rows_returned
rows_updated
xs:long
select_sql_stmts
xs:long

monitor element
sort_overflows
804

Element Name
Data Type
static_sql_stmts
xs:long

monitor element
tcpip_recv_volume
tcpip_recvs_total
tcpip_send_volume
tcpip_sends_total
thresh_violations
total_act_time
total_act_wait_time
total_app_commits
total_app_rollbacks
total_app_rqst_time
total_col_proc_time
total_col_proc_time - Total column-organized processing

time
total_col_time
total_commit_time
total_compilations
total_compile_time
_proc_time
_time

switch user authentication request time

total_connect_request_proc
_time


user request time

requests
total_cpu_time
xs:long

time
total_extended_latch_wait
_time

wait time
total_hash_grpbys
xs:long

805

Element Name
Data Type
total_hash_joins
xs:long
total_hash_loops
xs:long
total_implicit_compile_
proc_time
total_implicit_compile_proc_time - Total implicit compile

processing time
total_load_time
total_loads
total_olap_funcs
xs:long

element
total_peas
xs:long
total_peds
xs:long

time
total_reorg_time
total_reorgs
total_rollback_time
total_routine_time
total_routine_user_
code_proc_time

total_routine_user_
code_time

time
total_rqst_time
total_runstats

processing time
total_runstats_time

processing time
total_section_sorts
total_section_time
total_sorts
total_stats_fabrication
_proc_time


time
806

Element Name
Data Type
total_sync_runstats

activities
total_sync_runstats_proc
_time

total_sync_runstats_time - Total synchronous RUNSTATS

time
total_wait_time
xs:long
xs:long
tq_tot_send_spills
tq_tot_send_spills - Total number of table queue buffers

overflowed
uid_sql_stmts
xs:long

wlm_queue_assignments_total - Workload manager total

queue assignments
wlm_queue_time_total - Workload manager total queue

time
workload_id
workload_name
xs:string (128)
xquery_stmts
xs:long

element
Usage notes
The metrics returned by the MON_GET_WORKLOAD_DETAILS function represent
the accumulation of all metrics for requests that were submitted by connections
mapped to the identified workload object. This function is similar to the
MON_GET_WORKLOAD table function:
v The MON_GET_WORKLOAD table function returns the most commonly used
metrics in a column-based format and is the most performance efficient method
of retrieving metrics.
v The MON_GET_WORKLOAD_DETAILS table function returns the entire set of
available metrics in an XML document format, which provides maximum
flexibility for formatting output. The XML based output can be parsed directly
Metrics are rolled up to a workload on unit of work boundaries, and periodically
during the execution of requests. Therefore, the values reported by this table
function reflect the current state of the system at the time of the most recent rollup.
Metrics are strictly increasing in value. To determine the value of a given metric
for an interval of time, use the MON_GET_WORKLOAD_DETAILS table function
to query the metric at the start and end of the interval, and compute the difference.
807
metrics reported for each workload mapped to that service superclass stop
time).
The MON_GET_WORKLOAD_DETAILS table function returns one row of data per
workload and per member. No aggregation across workloads (on a member), or
across members (for a service class or more), is performed. However, aggregation
can be achieved through SQL queries as shown in the example.
Example
Display lock information for each workload, aggregated across members, ordered
by highest lock wait time.
SELECT varchar(wlmetrics.workload_name,30) as workload_name,
sum(detmetrics.lock_wait_time) as total_lock_wait_time,
sum(detmetrics.lock_waits) as total_lock_waits,
sum(detmetrics.lock_timeouts) as total_lock_timeouts,
sum(detmetrics.lock_escals) as total_lock_escals
FROM TABLE(MON_GET_WORKLOAD_DETAILS(,-2)) AS WLMETRICS,
$detmetric/db2_workload PASSING
XMLPARSE(DOCUMENT WLMETRICS.DETAILS)
as "detmetric"
COLUMNS "LOCK_WAIT_TIME" INTEGER PATH system_metrics/lock_wait_time,
"LOCK_WAITS" INTEGER PATH system_metrics/lock_waits,
"LOCK_TIMEOUTS" INTEGER PATH system_metrics/lock_timeouts,
"LOCK_ESCALS" INTEGER PATH system_metrics/lock_escals
) AS DETMETRICS
ORDER BY total_lock_wait_time desc;

WORKLOAD_NAME
TOTAL_LOCK_WAIT_TIME TOTAL_LOCK_WAITS ...
------------------------------ -------------------- ---------------- ...
0
0 ...
0
0 ...

... TOTAL_LOCK_TIMEOUTS TOTAL_LOCK_ESCALS
... ------------------- ----------------...
0
0
...
0
0
MON_GET_WORKLOAD_STATS table function - Return workload statistics:

The MON_GET_WORKLOAD_STATS function returns one row of workload
statistics for every combination of workload name and database member number.
808
Authorization
v
v
v
v
v

DBADM authority
SQLADM authority
WLMADM authority

None
Syntax
MON_GET_WORKLOAD_STATS (
workload_name
member

Routine parameters
workload_name
An input argument of type VARCHAR(128) that specifies a workload for
which the statistics are to be returned. If the argument is NULL or an empty
string, statistics are returned for all workloads.
member
An input argument of type INTEGER that specifies the number of a member in
current member, or -2 for all members. If a null value is specified, -1 is set
implicitly.
Table 189. Information returned by MON_GET_WORKLOAD_STATS
Column name
Data type
Description
WORKLOAD_NAME
VARCHAR(128)
DBPARTITIONNUM
SMALLINT

monitor element
LAST_RESET
TIMESTAMP
CONCURRENT_WLO_TOP
INTEGER

CONCURRENT_WLO_ACT_TOP
INTEGER
concurrent_wlo_act_top - Concurrent WLO activity

top monitor element
BIGINT
coord_act_completed_total - Coordinator activities

completed total monitor element
BIGINT
coord_act_aborted_total - Coordinator activities

aborted total monitor element
BIGINT
coord_act_rejected_total - Coordinator activities

rejected total monitor element
WLO_COMPLETED_TOTAL
BIGINT
wlo_completed_total - Workload occurrences

809
Table 189. Information returned by MON_GET_WORKLOAD_STATS (continued)

Column name
Data type
Description
BIGINT
coord_act_lifetime_top - Coordinator activity

lifetime top monitor element
DOUBLE
coord_act_lifetime_avg - Coordinator activity

lifetime average monitor element
DOUBLE
Standard deviation of lifetime for completed or

aborted coordinator activities at nesting level 0 that
are associated with this workload. Units are
milliseconds. If the COLLECT AGGREGATE
ACTIVITY DATA parameter of the workload is set
to NONE, the value of the column is null. This
standard deviation is computed from the
coordinator activity lifetime histogram and may be
inaccurate if the histogram is not correctly sized to
fit the data. If any values fall into the last
histogram bin, the value -1 is returned.
DOUBLE
coord_act_exec_time_avg - Coordinator activities

execution time average monitor element
DOUBLE
Standard deviation of the execution times for

completed or aborted coordinator activities at
nesting level 0 that are associated with this
workload. Units are milliseconds. This standard
deviation is computed from the coordinator activity
executetime histogram and may be inaccurate if the
histogram is not correctly sized to fit the data. If
any values fall into the last histogram bin, the value
-1 is returned. If the COLLECT AGGREGATE
DOUBLE
coord_act_queue_time_avg - Coordinator activity

queue time average monitor element
DOUBLE
Standard deviation of the queue time for completed

or aborted coordinator activities at nesting level 0
that are associated with this workload. Units are
coordinator activity queuetime histogram and may
be inaccurate if the histogram is not correctly sized
to fit the data. If any values fall into the last
UOW_TOTAL_TIME_TOP
BIGINT
uow_total_time_top - UOW total time top monitor

element
UOW_THROUGHPUT
DOUBLE
uow_throughput - Unit of work throughput

monitor element
UOW_LIFETIME_AVG
DOUBLE
uow_lifetime_avg - Unit of work lifetime average

monitor element
UOW_COMPLETED_TOTAL
BIGINT
uow_completed_total - Total completed units of

work monitor element
TOTAL_CPU_TIME
BIGINT
BIGINT

810
Table 189. Information returned by MON_GET_WORKLOAD_STATS (continued)

Column name
Data type
Description
ACT_THROUGHPUT
DOUBLE
act_throughput - Activity throughput monitor

element
CPU_UTILIZATION
DOUBLE
cpu_utilization - CPU utilization monitor element
BIGINT

BIGINT

BIGINT

MEMBER
SMALLINT
Usage notes
The function does not aggregate data across workloads, members, or service
classes. However, you can use SQL queries to aggregate data.
Example
The following query displays statistics for workloads:
SELECT SUBSTR(WORKLOAD_NAME,1,18) AS WL_DEF_NAME,
COORD_ACT_LIFETIME_TOP,
COORD_ACT_LIFETIME_AVG,
FROM TABLE(MON_GET_WORKLOAD_STATS(CAST(NULL AS VARCHAR(128)), -2)) AS WLSTATS
ORDER BY WL_DEF_NAME, MEMB

WL_DEF_NAME
-----------------SYSDEFAULTADMWORKL
SYSDEFAULTUSERWORK
WL1
...
...
...
...
...
MEMB COORD_ACT_LIFETIME_TOP ...

---- ---------------------- ...
0
-1 ...
0
-1 ...
0
2 ...
------------------------ -------------------------1.00000000000000E+000
-1.00000000000000E+000
-1.00000000000000E+000
-1.00000000000000E+000
+2.56000000000000E+000
+6.00000000000001E-002
MON_GET_WORK_ACTION_SET_STATS - Return work action set statistics:

The MON_GET_WORK_ACTION_SET_STATS function returns the statistics for a
work action set.
Authorization
v
v
v
v
v

DBADM authority
SQLADM authority
WLMADM authority
811

None
Syntax
MON_GET_WORK_ACTION_SET_STATS (
work_action_set_name
, member

Routine parameters
work_action_set_name
An input argument of type VARCHAR(128) that specifies the work action set
to return statistics for. If the argument is null or an empty string, statistics are
returned for all work action sets.
member
Table 190. Information returned for MON_GET_WORK_ACTION_SET_STATS
Column name
Data type
Description
VARCHAR(128)
work_action_set_name - Work action set name monitor

element
DBPARTITIONNUM
SMALLINT

element
LAST_RESET
TIMESTAMP
WORK_CLASS_NAME
VARCHAR(128)
work_class_name - Work class name monitor element
ACT_TOTAL
BIGINT
act_total - Activities total monitor element
MEMBER
SMALLINT
Example
Assume that there are three work classes: ReadClass, WriteClass, and LoadClass.
There is a work action associated with ReadClass and a work action associated
with LoadClass, but there is no work action associated with WriteClass. On
member 0, the number of activities currently running or queued are as follows:
v
v
v
v
ReadClass class: eight

WriteClass class: four
LoadClass class: two
Unassigned: three
SELECT SUBSTR(WORK_ACTION_SET_NAME,1,18) AS WORK_ACTION_SET_NAME,

SUBSTR(WORK_CLASS_NAME,1,15) AS WORK_CLASS_NAME,
LAST_RESET,
SUBSTR(CHAR(ACT_TOTAL),1,14) AS ACT_TOTAL
812
FROM TABLE(MON_GET_WORK_ACTION_SET_STATS
(CAST(NULL AS VARCHAR(128)), -2)) AS WASSTATS
ORDER BY WORK_ACTION_SET_NAME, WORK_CLASS_NAME, MEMB
Sample output is as follows. Because there is no work action associated with the
WriteClass work class, the four activities to which it applies are counted in the
artificial class denoted by an asterisk (*) in the output. The three activities that
were not assigned to any work class are also included in the artificial class.
-------------------AdminActionSet
AdminActionSet
AdminActionSet
AdminActionSet
AdminActionSet
AdminActionSet
MEMB
---0
1
0
1
0
1
WORK_CLASS_NAME
--------------ReadClass
ReadClass
LoadClass
LoadClass
*
*
LAST_RESET
-------------------------2005-11-25-18.52.49.343000
2005-11-25-18.52.50.478000
2005-11-25-18.52.49.343000
2005-11-25-18.52.50.478000
2005-11-25-18.52.49.343000
2005-11-25-18.52.50.478000
ACT_TOTAL
-------------8
0
2
0
7
0
MON_INCREMENT_INTERVAL_ID procedure - increment the monitoring

interval:
The MON_INCREMENT_INTERVAL_ID procedure increments the monitoring
interval by 1 and returns the new value in the output argument. The current
monitoring interval is indicated by the MON_INTERVAL_ID database global
variable.
Syntax
MON_INTERVAL_INCREMENT_ID (
new_id

new_id
An output argument of type BIGINT that returns the new monitoring interval.
Authorization
v
v
v
v

DBADM authority
SQLADM authority

None
Usage notes
As an autonomous procedure, MON_INCREMENT_INTERVAL_ID executes in its
own transaction scope.
When the value of MON_INTERVAL_ID reaches the maximum BIGINT value, it is
cycled back to 1.
813
Example
To increment the interval ID and return the new value in the argument. This
example assumes that MY_ID is a previously created session global variable.
CALL SYSPROC.MON_INCREMENT_INTERVAL_ID(MY_ID)
MON_SAMPLE_SERVICE_CLASS_METRICS - Get sample service class

metrics:
The MON_SAMPLE_SERVICE_CLASS_METRICS table function reads system
metrics for one or more service classes across one or more databases at two points
in time: at the time the function is called and after a given amount of time has
passed. It computes various statistics from these metrics.
Syntax
MON_SAMPLE_SERVICE_CLASS_METRICS (
service_superclass_name ,
sample_time ,
member
hostname
db_name
,


hostname
An input argument of type VARCHAR(255) that specifies a fully qualified host
name or an IP address of the node from which to generate the report. If the
argument is NULL or an empty string, metrics are taken from all active
databases in the instance.
db_name
this function. The database must have a directory entry type of either "Indirect"
or "Home", as returned by a LIST DATABASE DIRECTORY command. If the
argument is NULL or an empty string, metrics are taken from all databases in
the instance.
function. If the argument is NULL or an empty string, performance metrics are
retrieved for all the superclasses in the instance whose database name satisfies
the constraint imposed by the db_name parameter.
If the argument is NULL or an empty string, performance metrics are retrieved
for all the subclasses in the instance whose database name and service
superclass name satisfy the constraints imposed by the db_name and
service_superclass_name parameters, respectively.
814
sample_time
The amount of time the function collects data before computing a result on
that data. This value is measured in seconds and must be greater than or equal
to 1.
member
Authorization
v DBADM authority
v SQLADM authority
None
Example 1
Show the activity throughput and CPU velocity for a 30 second period for each
service subclass across all partitions.
SELECT varchar(service_superclass_name,30) AS service_superclass,
varchar(service_subclass_name,30) AS service_subclass,
decimal(sum(act_throughput),10,2) AS act_throughput,
decimal(sum(total_cpu_time) /
(sum(total_cpu_time) +
sum(total_disp_run_queue_time)),3,2) AS cpu_velocity
FROM TABLE(MON_SAMPLE_SERVICE_CLASS_METRICS
(null, current server, , , 30, -2)) AS t
WHERE service_subclass_name IS NOT NULL
GROUP BY service_superclass_name, service_subclass_name
ORDER BY service_superclass_name, service_subclass_name
This an example of output from this query.

SERVICE_SUPERCLASS
--------------------------SYSDEFAULTUSERCLASS
SERVICE_SUBCLASS
----------------------SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
...
...
...
...
...

... ACT_THROUGHPUT CPU_VELOCITY
... --------------- ----------------...
214.76
0.72
...
0
0
...
0
0
815
Example 2
Show the configured shares, the estimated CPU entitlement, and the actual CPU
utilization for a 5 minute period, for each service class across all databases and
partitions on the system.
SELECT varchar(db_name,18) AS db_name,
varchar(service_superclass_name,30) AS service_superclass,
varchar(service_subclass_name,30) AS service_subclass,
cpu_shares,
cpu_limit,
decimal(estimated_cpu_entitlement, 9, 2) AS estimated_cpu_entitlement,
decimal( cpu_utilization, 3, 2) AS cpu_utilization
FROM TABLE(MON_SAMPLE_SERVICE_CLASS_METRICS
(null, null, , , 300, -2)) AS t
ORDER BY db_name, service_superclass_name, service_subclass_name, member

DB_NAME
-----------------SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
OTHER
OTHER
OTHER
OTHER
OTHER
OTHER
SERVICE_SUPERCLASS
--------------------------SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
...
...
...
...
...
...
...
...
...
...
...
...
...
...

SERVICE_SUBCLASS
CPU_SHARES CPU_LIMIT ...
----------------------- ---------- --------- ...
SYSDEFAULTSUBCLASS
1000
- ...
2000
70 ...
SYSDEFAULTSUBCLASS
1000
- ...
1000
- ...
SYSDEFAULTSUBCLASS
- ...
- ...
SYSDEFAULTSUBCLASS
1000
- ...
5000
70 ...
SYSDEFAULTSUBCLASS
1000
- ...
2000
- ...
SYSDEFAULTSUBCLASS
- ...
- ...

ESTIMATED_CPU_ENTITLEMENT CPU_UTILIZATION
------------------------- --------------0.20
0.16
0.20
0.16
0.10
0.09
0.10
0.09
0.10
0.10
0.50
0.45
0.50
0.45
816
0.20
0.20
-
0.11
0.11
0.09
0.09
Usage notes
The MON_SAMPLE_SERVICE_CLASS_METRICS table function returns one row of
data per service class and per member for each database. The table function
performs no aggregation across service classes (on a member), or across members
(for a service class or more). However, aggregation can be achieved through SQL
queries. The input parameters have the effect of being ANDed together.
Therefore, if you specify conflicting input parameters (for example, a superclass
named SUPA, and subclass named SUBB which is not a subclass of SUPA), then no
rows are returned.
Table 191. Information returned for MON_SAMPLE_SERVICE_CLASS_METRICS
Description or
corresponding monitor
element
Column name
Data type
HOSTNAME
VARCHAR(255)

monitor element
DB_NAME
VARCHAR(128)

monitor element
SERVICE_SUPERCLASS
_NAME
VARCHAR(128)
service_superclass_name Service superclass name
SERVICE_SUBCLASS_NAME VARCHAR(128)
service_subclass_name Service subclass name
SERVICE_CLASS_ID
INTEGER
service_class_id - Service
class ID
MEMBER
SMALLINT
UOW_THROUGHPUT
DOUBLE
uow_throughput - Unit of
work throughput monitor
element
UOW_LIFETIME_AVG
DOUBLE
uow_lifetime_avg - Unit of
work lifetime average
monitor element
UOW_COMPLETED_TOTAL BIGINT
uow_completed_total - Total
completed units of work
monitor element
ACT_THROUGHPUT
DOUBLE
act_throughput - Activity
ACT_COMPLETED_TOTAL
BIGINT
act_completed_total - Total
completed activities
TOTAL_CPU_TIME
BIGINT
total_cpu_time - Total CPU

TOTAL_DISP_RUN_QUEUE
_TIME
BIGINT
total_disp_run_queue_time Total dispatcher run queue

817
Table 191. Information returned for

MON_SAMPLE_SERVICE_CLASS_METRICS (continued)
Description or
element
Column name
Data type
CPU_SHARES
INTEGER
cpu_shares - WLM
dispatcher CPU shares
monitor element
CPU_SHARE_TYPE
VARCHAR(4)
cpu_share_type - WLM
dispatcher CPU share type
monitor element
CPU_LIMIT
SMALLINT
cpu_limit - WLM dispatcher

CPU limit monitor element
ESTIMATED_CPU
_ENTITLEMENT
DOUBLE
estimated_cpu_entitlement Estimated CPU entitlement

monitor element
CPU_UTILIZATION
DOUBLE
cpu_utilization - CPU
utilization monitor element
CPU_VELOCITY
DOUBLE
cpu_velocity - CPU velocity

monitor element
MON_SAMPLE_WORKLOAD_METRICS - Get sample:

The MON_SAMPLE_WORKLOAD_METRICS table function reads system metrics
for one or more workloads across one or more databases at two points in time: at
the time the function is called and after a given amount of time has passed. It
computes various statistics from these metrics.
Syntax
MON_SAMPLE_SERVICE_CLASS_METRICS (
workload_name , sample_time
hostname
member
db_name


hostname
An input argument of type VARCHAR(255) that specifies a fully qualified host
name or an IP address of the node from which to generate the report. If the
argument is NULL or an empty string, metrics are taken from all nodes in the
instance.
db_name
this function. The database must have a directory entry type of either "Indirect"
or "Home", as returned by a LIST DATABASE DIRECTORY command. If the
argument is NULL or an empty string, metrics are taken from all active
databases in the instance.
workload_name
818
string, metrics are returned for all workloads in the instance whose database
name satisfies the constraint imposed by the db_name parameter.
sample_time
The amount of time the function collects data before computing a result on
that data. This value is measured in seconds and must be greater than or equal
to 1.
member
Authorization
v DBADM authority
v SQLADM authority
None
Example
Display the unit of work (UOW) throughput, activity throughput, and average
CPU utilization for a 30 second period, for each workload and across all partitions.
SELECT varchar(workload_name,30) AS workload_name,
decimal(sum(uow_throughput),10,2) AS uow_throughput,
decimal(sum(act_throughput),10,2) AS act_throughput,
decimal(sum(cpu_utilization),3,2) AS cpu_utilization
FROM TABLE(MON_SAMPLE_WORKLOAD_METRICS
(null, current server, ,30 ,-2)) AS t
ORDER BY workload_name

WORKLOAD_NAME
UOW_THROUGHPUT
----------------------- ----------------------SYSDEFAULTUSERWORKLOAD
124.43
0
...
...
...
...

... ACT_THROUGHPUT CPU_UTILIZATION
... --------------- ----------------...
214.76
0.89
...
0
0
Usage notes
The MON_SAMPLE_WORKLOAD_METRICS table function returns one row of
data per workload and per member for each database. The table function performs
819
no aggregation across workloads (on a member), or across members (for a

workload or more). However, aggregation can be achieved through SQL queries.
Table 192. Information returned from MON_SAMPLE_WORKLOAD_METRICS
monitor element
Column name
Data type
HOSTNAME
VARCHAR(255)
hostname - Host name monitor

element
DB_NAME
VARCHAR(128)
db_name - Database name monitor

element
WORKLOAD_NAME
VARCHAR(128)

monitor element
WORKLOAD_ID
INTEGER
workload_id - Workload ID monitor

element
MEMBER
SMALLINT
UOW_THROUGHPUT
DOUBLE
uow_throughput - Unit of work

UOW_LIFETIME_AVG
DOUBLE
uow_lifetime_avg - Unit of work

UOW_COMPLETED_TOTAL BIGINT
uow_completed_total - Total
completed units of work monitor
element
TOTAL_CPU_TIME
BIGINT

monitor element
TOTAL_DISP_RUN_QUEUE
_TIME
BIGINT
total_disp_run_queue_time - Total
dispatcher run queue time monitor
element
ACT_THROUGHPUT
DOUBLE
act_throughput - Activity throughput

monitor element
ACT_COMPLETED_TOTAL
BIGINT

activities
CPU_UTILIZATION
DOUBLE
cpu_utilization - CPU utilization

monitor element
CPU_VELOCITY
DOUBLE
cpu_velocity - CPU velocity monitor

element
Monitor views
MON_BP_UTILIZATION administrative view - Retrieve metrics for
bufferpools:
The MON_BP_UTILIZATION administrative view returns key monitoring metrics,
including hit ratios and average read and write times, for all buffer pools and all
database partitions in the currently connected database.
It provides information that is critical for performance monitoring, because it helps
you check how efficiently you are using your buffer pools.
820
Authorization
v
v
v
v
v
SELECT privilege on the MON_BP_UTILIZATION administrative view

CONTROL privilege on the MON_BP_UTILIZATION administrative view
DBADM authority
SQLADM authority

None
Table 193. Information returned by the MON_BP_UTILIZATION administrative view
Column name
Data type
BP_NAME
VARCHAR(128)
bp_name - Buffer pool name
MEMBER
SMALLINT
DATA_PHYSICAL_READS
BIGINT
Indicates the number of data pages

read from the table space containers
(physical) for temporary as well as
regular and large table spaces. This
is calculated as (pool_data_p_reads +
pool_temp_data_p_reads) where
pool_data_p_reads and
pool_temp_data_p_reads represent the
following monitor elements:
DATA_HIT_RATIO_
PERCENT
DECIMAL(5,2)
pool_data_p_reads - Buffer pool

data physical reads
pool_temp_data_p_reads - Buffer
pool temporary data physical
reads
Data hit ratio, that is, the percentage

of time that the database manager
did not need to load a page from
disk to service a data page request.
In DB2 pureScale environments, this
value is the percentage of time that
the database manager located a data
page in the local buffer pool.
821
Table 193. Information returned by the MON_BP_UTILIZATION administrative

view (continued)
Column name
Data type
INDEX_PHYSICAL_READS
BIGINT
Indicates the number of index pages

read from the table space containers
is calculated as (pool_index_p_reads +
pool_temp_index_p_reads) where
pool_index_p_reads +
pool_temp_index_p_reads represent the
pool_index_p_reads - Buffer pool
pool_temp_index_p_reads Buffer pool temporary index

physical reads
INDEX_HIT_RATIO_
PERCENT
DECIMAL(5,2)
Index hit ratio, that is, the

percentage of time that the database
manager did not need to load a
page from disk to service an index
data page request. In DB2 pureScale
environments, this value is the
manager located a data page in the
local buffer pool.
XDA_PHYSICAL_READS
BIGINT
Indicates the number of data pages

for XML storage objects (XDAs) read
from the table space containers
is calculated as (pool_xda_p_reads +
pool_temp_xda_p_reads) where
pool_xda_p_reads and
pool_temp_xda_p_reads represent the
XDA_HIT_RATIO_PERCENT
822
DECIMAL(5,2)
pool_xda_p_reads - Buffer pool

pool_temp_xda_p_reads - Buffer
pool temporary XDA data
physical reads
Auxiliary storage objects hit ratio,

that is, the percentage of time that
the database manager did not need
to load a page from disk to service a
data page request for XML storage
objects (XDAs). In a DB2 pureScale
environment, this value is the
percentage of time the database
manager used to locate a data page
for an XDA in the local buffer pool.

view (continued)
Column name
Data type
COL_PHYSICAL_READS
BIGINT
Indicates the number of

column-organized table data pages
read from the physical table space
containers for temporary, regular,
and large table spaces. This is
calculated as (pool_col_p_reads +
pool_temp_col_p_reads) where
pool_col_p_reads and
pool_temp_col_p_reads represent the
v pool_col_p_reads - Buffer pool
v pool_temp_col_p_reads - Buffer
pool column-organized temporary
physical reads
COL_HIT_RATIO_PERCENT
DECIMAL(5,2)
Column-organized table data hit

ratio. The percentage of time that
the database manager did not need
to load a page from disk to service a
column-organized table data page
request. In DB2 pureScale
manager located a data page in the
local buffer pool.
823

view (continued)
Column name
Data type
TOTAL_PHYSICAL_READS
BIGINT
Indicates the number of data pages,

index pages, and data pages for
XML storage objects (XDAs) read
from the table space containers
regular and large table spaces.
This is calculated as
(pool_data_p_reads +
pool_temp_data_p_reads +
pool_temp_index_p_reads +
pool_xda_p_reads +
pool_temp_xda_p_reads +
pool_col_p_reads +
pool_temp_col_p_reads)where
pool_data_p_reads,
pool_temp_data_p_reads,
pool_index_p_reads,
pool_temp_index_p_reads,
pool_xda_p_reads,
pool_temp_xda_p_reads,
pool_col_p_reads, and
v

data physical reads
reads


physical reads

physical reads

physical reads
824

view (continued)
Column name
Data type
AVG_PHYSICAL_
READ_TIME
BIGINT
Average time, in milliseconds, spent

reading pages from the table space
containers (physical) for all types of
table spaces.
If the sum of physical reads is
greater than zero, this is calculated
as pool_read_time / (pool_data_p_reads
+ pool_temp_data_p_reads +
pool_temp_index_p_reads +
pool_xda_p_reads +
pool_temp_xda_p_reads +
pool_col_p_reads +
pool_read_time, pool_data_p_reads,
pool_temp_data_p_reads,
pool_index_p_reads,
pool_temp_index_p_reads,
pool_xda_p_reads,
pool_temp_xda_p_reads,
pool_col_p_reads, and
v
pool_read_time - Total buffer

pool physical read time

data physical reads
reads


physical reads

physical reads

physical reads
If the sum of physical reads is not
greater than zero, NULL is returned.
825

view (continued)
Column name
Data type
PREFETCH_RATIO_
PERCENT
DECIMAL(5,2)
Percentage of pages read

asynchronously (with prefetching). If
many applications are reading data
synchronously without prefetching,
your system might not be tuned
optimally.
ASYNC_NOT_READ_
PERCENT
DECIMAL(5,2)
Percentage of pages read

asynchronously from disk, but never
accessed by a query. If too many
pages are read asynchronously from
disk into the bufferpool, but no
query ever accesses those pages, the
prefetching might degrade
performance.
If the sum of asynchronous reads is
as unread_prefetch_pages /
(pool_async_data_reads +
pool_async_index_reads +
pool_async_xda_reads +
pool_async_col_reads)where
unread_prefetch_pages,
pool_async_data_reads,
pool_async_index_reads,
pool_async_xda_reads, and
pool_async_col_reads represent the
v
unread_prefetch_pages - Unread
prefetch pages
pool_async_data_reads - Buffer
pool asynchronous data reads
pool_async_index_reads - Buffer
pool asynchronous index reads
pool_async_xda_reads - Buffer
pool asynchronous XDA data
reads
v pool_async_col_reads - Buffer
pool asynchronous
If the sum of asynchronous reads is
not greater than zero, NULL is
returned.
826

view (continued)
Column name
Data type
TOTAL_WRITES
BIGINT
The number of times a data, index,

or data page for an XML storage
object (XDA) was physically written
to disk.
This is calculated as (pool_data_writes
+ pool_index_writes + pool_xda_writes
+ pool_col_writes)where
pool_data_writes, pool_index_writes,
pool_xda_writes, and pool_col_writes
represent the following monitor
elements:
v
pool_data_writes - Buffer pool

data writes
pool_index_writes - Buffer pool

index writes
pool_xda_writes - Buffer pool

XDA data writes
v pool_col_writes - Buffer pool

AVG_WRITE_TIME
BIGINT

physically writing pages from the
buffer pool to disk.
If the sum of write operations is
as pool_write_time / (pool_data_writes
+ pool_index_writes + pool_xda_writes
+ pool_col_writes)where
pool_write_time, pool_data_writes,
pool_index_writes, pool_xda_writes,
and pool_col_writes represent the
v
pool_write_time - Total buffer

pool physical write time
pool_data_writes - Buffer pool

data writes

index writes
pool_xda_writes - Buffer pool

XDA data writes
v pool_col_writes - Buffer pool

If the sum of write operations is not
greater than zero, NULL is returned.
SYNC_WRITES_PERCENT
DECIMAL(5,2)
Percentage of write operations that

are synchronous.
827

view (continued)
828
Column name
Data type
GBP_DATA_HIT_RATIO
_PERCENT
DECIMAL(5,2)
Group bufferpool data hit ratio. The

manager did not need to load a
page from disk in order to service a
data page request because the page
was already in the group bufferpool.
Outside of a DB2 pureScale
environment, this value is null.
GBP_INDEX_HIT_RATIO
_PERCENT
DECIMAL(5,2)
Group bufferpool index hit ratio.

The percentage of time that the
database manager did not need to
load a page from disk in order to
service an index page request
because the page was already in the
group bufferpool. Outside of a DB2
pureScale environment, this value is
null.
GBP_XDA_HIT_RATIO
_PERCENT
DECIMAL(5,2)
Group bufferpool auxiliary storage

object hit ratio. The percentage of
time that the database manager did
not need to load a page from disk in
order to service a data page request
for XML storage object (XDAs)
pureScale environment, this value is
null.
GBP_COL_HIT_RATIO
_PERCENT
DECIMAL(5,2)
Group bufferpool column-organized

table data hit ratio. The percentage
of time that the database manager
did not need to load a page from
disk in order to service a
column-organized table data request
pureScale environment environment,
this value is null.
CACHING_TIER_DATA
_HIT_RATIO_PERCENT
DECIMAL(5,2)
CACHING_TIER_INDEX
_HIT_RATIO_PERCENT
DECIMAL(5,2)
CACHING_TIER_XDA
_HIT_RATIO_PERCENT
DECIMAL(5,2)
CACHING_TIER_COL
_HIT_RATIO_PERCENT
DECIMAL(5,2)
AVG_SYNC_READ_TIME
BIGINT

in synchronous reading from
bufferpool.
AVG_ASYNC_READ_TIME
BIGINT

in asynchronous reading from
bufferpool.

view (continued)
Column name
Data type
AVG_SYNC_WRITE_TIME
BIGINT

in synchronous writing to the
bufferpool.
AVG_ASYNC_WRITE_TIME
BIGINT

asynchronous writing to the
bufferpool.
MON_CONNECTION_SUMMARY - Retrieve metrics for all connections:

The MON_CONNECTION_SUMMARY administrative view returns key metrics for
all connections in the currently connected database. It is designed to help monitor
the system in a high-level manner, showing incoming work per connection.
The metrics returned represent the accumulation of all metrics for requests that
were submitted by the identified connection across all members of the database.
Authorization
v SELECT privilege on the MON_CONNECTION_SUMMARY administrative view
v CONTROL privilege on the MON_CONNECTION_SUMMARY administrative
view
v DBADM authority
v SQLADM authority
None
Table 194. Information returned by the MON_CONNECTION_SUMMARY administrative
view
Column name
Data type
APPLICATION_HANDLE
BIGINT
application_handle - Application
handle
APPLICATION_NAME
VARCHAR(128)
APPLICATION_ID
VARCHAR(128)
SESSION_AUTH_ID
VARCHAR(128)
authorization ID
TOTAL_APP_COMMITS
BIGINT

commits monitor elements
TOTAL_APP_ROLLBACKS
BIGINT

rollbacks monitor element
829

view (continued)
830
Column name
Data type
ACT_COMPLETED_TOTAL
BIGINT

APP_RQSTS_COMPLETED
_TOTAL
BIGINT
app_rqsts_completed_total - Total
application requests completed
monitor element
AVG_RQST_CPU_TIME
BIGINT
Average amount of CPU time, in

microseconds, used by all external
requests that completed successfully.
It represents the total of both user and
system CPU time. Formula to
calculate ratio: TOTAL_CPU_TIME /
ROUTINE_TIME_
RQST_PERCENT
DECIMAL(5,2)
The percentage of time the database

server spent working on requests that
was spent executing user routines.
Formula to calculate ratio:
TOTAL_ROUTINE_TIME /
TOTAL_RQST_TIME
RQST_WAIT_
TIME_PERCENT
DECIMAL(5,2)
The percentage of the time spent

working on requests that was spent
waiting within the DB2 database
server. Formula to calculate ratio:
TOTAL_WAIT_TIME / TOTAL_RQST_TIME
ACT_WAIT_TIME_
PERCENT
DECIMAL(5,2)

executing activities that was spent
server. Formula to calculate ratio:
TOTAL_ACT_WAIT_TIME /
TOTAL_ACT_TIME
IO_WAIT_TIME_PERCENT
DECIMAL(5,2)

server that was due to I/O
operations. This includes time spent
performing direct reads or direct
writes, and time spent reading data
and index pages from the table space
to the bufferpool or writing them
back to disk. Formula to calculate
ratio: (POOL_READ_TIME +
POOL_WRITE_TIME + DIRECT_READ_TIME
+ DIRECT_WRITE_TIME) /
TOTAL_WAIT_TIME
LOCK_WAIT_TIME_
PERCENT
DECIMAL(5,2)
The percentage of time spent waiting

within the DB2 database server that
was spent waiting on locks. Formula
to calculate ratio: LOCK_WAIT_TIME /
TOTAL_WAIT_TIME

view (continued)
Column name
Data type
AGENT_WAIT_TIME_
PERCENT
DECIMAL(5,2)

was spent by an application queued
to wait for an agent under
concentrator configurations. Formula
to calculate ratio: AGENT_WAIT_TIME /
TOTAL_WAIT_TIME
NETWORK_WAIT_
TIME_PERCENT
DECIMAL(5,2)

was spent on client-server
communications. This includes time
spent sending and receiving data over
TCP/IP or using the IPC protocol.
(TCPIP_SEND_WAIT_TIME +
TCPIP_RECV_WAIT_TIME +
IPC_SEND_WAIT_TIME +
IPC_RECV_WAIT_TIME) /
TOTAL_WAIT_TIME
SECTION_PROC_
TIME_PERCENT
DECIMAL(5,2)

server spent actively working on
requests that was spent executing
sections. This includes the time spent
performing sorts. Formula to calculate
ratio: TOTAL_SECTION_PROC_TIME /
(TOTAL_RQST_TIME TOTAL_WAIT_TIME)
SECTION_SORT_
PROC_TIME_PERCENT
DECIMAL(5,2)

requests that was spent performing
sorts while executing sections.
TOTAL_SECTION_SORT_PROC_TIME /
COMPILE_PROC_
TIME_PERCENT
DECIMAL(5,2)

requests that was spent compiling an
SQL statement. This includes explicit
and implicit compile times. Formula
to calculate ratio:
(TOTAL_COMPILE_PROC_TIME +
TOTAL_IMPLICIT_COMPILE_PROC_TIME)
/ (TOTAL_RQST_TIME TOTAL_WAIT_TIME)
TRANSACT_END_PROC
_TIME_PERCENT
DECIMAL(5,2)

requests that was spent performing
commit processing or rolling back
transactions. Formula to calculate
ratio: (TOTAL_COMMIT_PROC_TIME +
TOTAL_ROLLBACK_PROC_TIME) /
831

view (continued)
832
Column name
Data type
UTILS_PROC_
TIME_PERCENT
DECIMAL(5,2)

requests that was spent running
utilities. This includes performing
runstats, reorganization, and load
operations. Formula to calculate ratio:
(TOTAL_RUNSTATS_PROC_TIME +
TOTAL_REORG_PROC_TIME +
TOTAL_LOAD_PROC_TIME) /
AVG_LOCK_WAITS
_PER_ACT
BIGINT
The average number of times that

applications or connections waited for
locks per coordinator activities
(successful and aborted). Formula to
calculate ratio: LOCK_WAITS /
(ACT_COMPLETED_TOTAL +
ACT_ABORTED_TOTAL)
AVG_LOCK_TIMEOUTS
_PER_ACT
BIGINT
The average number of times that a

request to lock an object timed out
per coordinator activities (successful
and aborted). Formula to calculate
ratio: LOCK_TIMEOUTS /
(ACT_COMPLETED_TOTAL +
ACT_ABORTED_TOTAL)
AVG_DEADLOCKS_
PER_ACT
BIGINT
The average number of deadlocks per

coordinator activities (successful and
aborted). Formula to calculate ratio:
DEADLOCKS / (ACT_COMPLETED_TOTAL +
ACT_ABORTED_TOTAL)
AVG_LOCK_ESCALS
_PER_ACT
BIGINT

locks have been escalated from
several row locks to a table lock per
coordinator activities (successful and
aborted). Formula to calculate ratio:
LOCK_ESCALS / (ACT_COMPLETED_TOTAL
+ ACT_ABORTED_TOTAL)
ROWS_READ_PER_
ROWS_RETURNED
BIGINT
The average number of rows read

from the table per rows returned to
the application. Formula to calculate
ratio: ROWS_READ / ROWS_RETURNED

view (continued)
Column name
Data type
TOTAL_BP_HIT_
RATIO_PERCENT
DECIMAL(5,2)

load a page from disk to service a
data request, index page request, or a
request to process column-organized
table data, including requests for XML
storage objects (XDAs). In a DB2
pureScale environment, this value
represents the total hit ratio for the
local bufferpool. Formula to calculate
ratio: (POOL_DATA_LBP_PAGES_FOUND +
POOL_INDEX_LBP_PAGES_FOUND +
POOL_XDA_LBP_PAGES_FOUND +
POOL_COL_LBP_PAGES_FOUND) /
(POOL_DATA_L_READS +
POOL_TEMP_DATA_L_READS +
POOL_INDEX_L_READS +
POOL_TEMP_INDEX_L_READS +
POOL_XDA_L_READS +
POOL_TEMP_XDA_L_READS +
POOL_COL_L_READS +
POOL_TEMP_COL_L_READS)
TOTAL_GBP_HIT_
RATIO_PERCENT
DECIMAL(5,2)
On a DB2 pureScale system, the

manager did not need to load a page
from disk into the local bufferpool to
service a data request, index request,
XML storage object (XDA) page
request, or a request to process
column-organized table data, as the
page was located in the group
bufferpool. This value will always be
0 for systems outside of DB2
pureScale.
TOTAL_CACHING_TIER_
HIT_RATIO_PERCENT
DECIMAL(5,2)
CF_WAIT_TIME_
PERCENT
DECIMAL(5,2)

percentage of the total wait time spent
waiting for caching facility
communications. This value will
always be 0 for systems outside of
DB2 pureScale.
RECLAIM_WAIT_TIME_
PERCENT
DECIMAL(5,2)

waiting for page reclaims. This value
will always be 0 for systems outside
of DB2 pureScale.
SPACEMAPPAGE_RECLAIM_ DECIMAL(5,2)
WAIT_TIME_PERCENT

waiting for space map page reclaims.
This value will always be 0 for
systems outside of DB2 pureScale.
833
MON_CURRENT_SQL - Retrieve key metrics for all activities on all members:

The MON_CURRENT_SQL administrative view returns key metrics for all
activities that were submitted on all members of the database and have not yet
been completed, including a point-in-time view of currently executing SQL
statements (both static and dynamic) in the currently connected database.
You can use the MON_CURRENT_SQL administrative view to identify long
running activities and prevent performance problems.
This view returns metrics that are aggregated across all members.
Authorization
v SELECT privilege on the MON_CURRENT_SQL administrative view
v CONTROL privilege on the MON_CURRENT_SQL administrative view
v DBADM authority
v SQLADM authority
None
Table 195. Information returned by the MON_CURRENT_SQL administrative view
834
element
Column name
Data type
COORD_MEMBER
SMALLINT
coord_member Coordinating member
APPLICATION_HANDLE
BIGINT
APPLICATION_NAME
VARCHAR(128)
appl_name - Application
name
SESSION_AUTH_ID
VARCHAR(128)
authorization ID
CLIENT_APPLNAME
VARCHAR(255)
CURRENT
CLIENT_APPLNAME special
register
ELAPSED_TIME_SEC
INTEGER
The time elapsed since this

activity began, in seconds.
The value of this column is
null when an activity has
entered the system but is in
a queue and has not started
running.
ACTIVITY_STATE
VARCHAR(32)
activity_state - Activity state
ACTIVITY_TYPE
VARCHAR(32)
activity_type - Activity type
Table 195. Information returned by the MON_CURRENT_SQL administrative

view (continued)
element
Column name
Data type
TOTAL_CPU_TIME
BIGINT

time
ROWS_READ
BIGINT
ROWS_RETURNED
BIGINT
rows_returned - Rows
returned
QUERY_COST_ESTIMATE
BIGINT
query_cost_estimate - Query
cost estimate
DIRECT_READS
BIGINT
direct_reads - Direct reads

from database
DIRECT_WRITES
BIGINT
direct_writes - Direct writes

to database
APPLICATION_ID
VARCHAR(128)
UOW_ID
INTEGER
ACTIVITY_ID
INTEGER
activity_id - Activity ID
STMT_TEXT
CLOB(2MB)
stmt_text - SQL statement

text
MON_CURRENT_UOW - Retrieve metrics for all units of work:

The MON_CURRENT_UOW administrative view returns key metrics for all units
of work that were submitted on all members of the database. It identifies long
running units of work and can therefore be used to prevent performance problems.
The MON_CURRENT_UOW view represents the coordinator perspective, and not
individual members.
Authorization
v SELECT privilege on the MON_CURRENT_UOW administrative view
v CONTROL privilege on the MON_CURRENT_UOW administrative view
v DBADM authority
v SQLADM authority
None
Example
The following example retrieves the application handle, the unit of work ID, the
elapsed time, and the total number of rows read and rows returned, for all units of
work that have been executed for more than 10 seconds.
835
SELECT APPLICATION_HANDLE AS APPL_HANDLE,

UOW_ID, ELAPSED_TIME_SEC,
TOTAL_ROWS_READ AS TOTAL_READ,
TOTAL_ROWS_MODIFIED AS TOTAL_MODIFIED
FROM SYSIBMADM.MON_CURRENT_UOW
WHERE ELAPSED_TIME_SEC > 10
ORDER BY ELAPSED_TIME_SEC DESC

APPL_HANDLE UOW_ID ELAPSED_TIME_SEC TOTAL_READ TOTAL_MODIFIED
----------- ------ ---------------- ---------- -------------254
1
750
87460
0
61
1
194
108
0
145
4
82
0
34
Table 196. Information returned by the MON_CURRENT_UOW administrative view
836
element
Column name
Data type
COORD_MEMBER
SMALLINT
member
UOW_ID
INTEGER
APPLICATION_HANDLE
BIGINT
APPLICATION_NAME
VARCHAR(128)
appl_name - Application
name
SESSION_AUTH_ID
VARCHAR(128)
authorization ID
CLIENT_APPLNAME
VARCHAR(255)
CURRENT
CLIENT_APPLNAME
special register
ELAPSED_TIME_SEC
INTEGER
The time elapsed since this

unit of work began, in
seconds.
WORKLOAD_OCCURRENCE VARCHAR(32)
_STATE
workload_occurrence_state Workload occurrence state
TOTAL_CPU_TIME
BIGINT

time
TOTAL_ROWS_MODIFIED
BIGINT
The total number of rows

inserted, updated or deleted.
TOTAL_ROWS_READ
BIGINT

read from tables.
TOTAL_ROWS_RETURNED
BIGINT

that have been selected and
returned to the application.
MON_DB_SUMMARY - Retrieve accumulated metrics across all members of the

database:
The MON_DB_SUMMARY administrative view returns key metrics aggregated
over all service classes in the currently connected database. It is designed to help
monitor the system in a high-level manner by providing a concise summary of the
database.
The metrics returned represent the accumulation of metrics across all members of
the database.
Authorization
v SELECT privilege on the MON_DB_SUMMARY administrative view
v CONTROL privilege on the MON_DB_SUMMARY administrative view
v DBADM authority
v SQLADM authority
None
Table 197. Information returned by the MON_DB_SUMMARY administrative view
Column name
Data type
TOTAL_APP_COMMITS
BIGINT
total_app_commits - Total
application commits monitor
elements
TOTAL_APP_ROLLBACKS
BIGINT
total_app_rollbacks - Total
application rollbacks monitor
element
ACT_COMPLETED_TOTAL
BIGINT
completed activities monitor
element
APP_RQSTS_COMPLETED
_TOTAL
BIGINT
app_rqsts_completed_total Total application requests

completed monitor element
AVG_RQST_CPU_TIME
BIGINT

microseconds, used by all
external requests that completed
successfully. It represents the
total of both user and system
CPU time.
ROUTINE_TIME_
RQST_PERCENT
DECIMAL(5,2)
The percentage of time the

database server spent working
on requests that was spent
executing user routines.
837
Table 197. Information returned by the MON_DB_SUMMARY administrative

view (continued)
838
Column name
Data type
RQST_WAIT_
TIME_PERCENT
DECIMAL(5,2)

working on requests that was
spent waiting within the DB2
database server.
ACT_WAIT_TIME_
PERCENT
DECIMAL(5,2)

executing activities that was
database server.
DECIMAL(5,2)

operations. This includes time
spent performing direct reads or
direct writes, and time spent
reading data and index pages
from the table space to the
bufferpool or writing them back
to disk.
LOCK_WAIT_TIME_
PERCENT
DECIMAL(5,2)
The percentage of time spent

server that was spent waiting on
locks.
AGENT_WAIT_TIME_
PERCENT
DECIMAL(5,2)

server that was spent by an
application queued to wait for
an agent under concentrator
configurations.
NETWORK_WAIT_
TIME_PERCENT
DECIMAL(5,2)

server that was spent on
client-server communications.
This includes time spent sending
and receiving data over TCP/IP
or using the IPC protocol.
SECTION_PROC_
TIME_PERCENT
DECIMAL(5,2)

database server spent actively
spent executing sections. This
includes the time spent
performing sorts.
SECTION_SORT_
PROC_TIME_PERCENT
DECIMAL(5,2)

spent performing sorts while
executing sections.
COMPILE_PROC_
TIME_PERCENT
DECIMAL(5,2)

spent compiling an SQL
statement. This includes explicit
and implicit compile times.

view (continued)
Column name
Data type
TRANSACT_END_PROC
_TIME_PERCENT
DECIMAL(5,2)

spent performing commit
processing or rolling back
transactions.
UTILS_PROC_
TIME_PERCENT
DECIMAL(5,2)

spent running utilities. This
includes performing runstats,
reorganization, and load
operations.
AVG_LOCK_WAITS
_PER_ACT
BIGINT
The average number of times

that applications or connections
waited for locks per coordinator
activities (successful and
aborted).
AVG_LOCK_TIMEOUTS
_PER_ACT
BIGINT

that a request to lock an object
timed out per coordinator
aborted).
AVG_DEADLOCKS_
PER_ACT
BIGINT
The average number of

deadlocks per coordinator
aborted).
AVG_LOCK_ESCALS
_PER_ACT
BIGINT

that locks have been escalated
from several row locks to a table
lock per coordinator activities
(successful and aborted).
ROWS_READ_PER_
ROWS_RETURNED
BIGINT
The average number of rows

read from the table per rows
TOTAL_BP_HIT_
RATIO_PERCENT
DECIMAL(5,2)

database manager did not need
to load a page from disk to
service a data request, index
page request, or a request to
process column-organized table
data, including requests for XML
pureScale environment, this
value represents the total hit
ratio for the local bufferpool.
839

view (continued)
Column name
Data type
TOTAL_GBP_HIT_
RATIO_PERCENT
DECIMAL(5,2)
In a DB2 pureScale environment,

the percentage of time that the
to load a page from disk into the
local bufferpool to service a data
request, index request, XML
storage object (XDA) page
column-organized table data, as
the page was located in the
group bufferpool. Outside of a
DB2 pureScale environment, this
value will always be null.
TOTAL_CACHING_TIER_
HIT_RATIO_PERCENT
DECIMAL(5,2)
CF_WAIT_TIME_
PERCENT
DECIMAL(5,2)

the percentage of the total wait
time spent waiting for caching
facility communications. Outside
of a DB2 pureScale environment,
this value will always be null.
RECLAIM_WAIT_TIME_
PERCENT
DECIMAL(5,2)

time spent waiting for page
reclaims. Outside of a DB2
SPACEMAPPAGE_RECLAIM_
WAIT_TIME_PERCENT
DECIMAL(5,2)

time spent waiting for space
map page reclaims. Outside of a
MON_LOCKWAITS administrative view - Retrieve metrics for applications that

are waiting to obtain locks:
The MON_LOCKWAITS administrative view returns information about agents
working on behalf of applications that are waiting to obtain locks in the currently
connected database. It is a useful query for identifying locking problems.
This administrative view replaces the SNAPLOCKWAIT administrative view which
is deprecated in DB2 Version 9.7 Fix Pack 1 and might be discontinued in a future
release.
Authorization
v SELECT privilege on the MON_LOCKWAITS administrative view
v CONTROL privilege on the MON_LOCKWAITS administrative view
840
None
Table 198. Information returned by the MON_LOCKWAITS administrative view
Column name
Data type
LOCK_NAME
VARCHAR(32)
lock_name - Lock nameYou can use the

MON_FORMAT_LOCK_
NAME routine to format
this internal binary
lock name and
obtain more details
regarding the lock,
such as the table and table
space that a table
lock references.
LOCK_OBJECT_TYPE
VARCHAR(32)
lock_object_type - Lock object type waited on
LOCK_WAIT_ELAPSED_TIME
INTEGER
The time elapsed since the agent started waiting to

obtain the lock. This value is given in seconds.
TABSCHEMA
VARCHAR(128)

For locks that do not reference a table, NULL is
returned.
TABNAME
VARCHAR(128)

For locks that do not reference a table, NULL is
returned.
DATA_PARTITION_ID
INTEGER
data_partition_id - Data Partition identifier

This element is only applicable to partitioned tables
and partitioned indexes. When returning lock level
information, a value of -1 represents a lock which
controls access to the whole table.
LOCK_MODE
VARCHAR(10)
LOCK_CURRENT_MODE
VARCHAR(10)
lock_current_mode - Original lock mode before

conversion
If the LOCK_STATUS is not "C" (converting), then a
LOCK_MODE_REQUESTED
VARCHAR(10)
lock_mode_requested - Lock mode requested
REQ_APPLICATION_
HANDLE
BIGINT
req_application_handle - Requesting application

handle
REQ_AGENT_TID
BIGINT
req_agent_tid - Requesting agent TID
REQ_MEMBER
SMALLINT
req_member - Requesting member
REQ_APPLICATION_
NAME
VARCHAR(128)
The name of the application running at the client

that is waiting to acquire this lock.
REQ_USERID
VARCHAR(128)
The current authorization ID for the session being

used by the application that is waiting to acquire
this lock.
841
Table 198. Information returned by the MON_LOCKWAITS administrative view (continued)

Column name
Data type
REQ_STMT_TEXT
CLOB(2MB)
SQL statement section that the application waiting

to acquire the lock is executing.
For non-SQL activities, a 0-length string value is
returned.
HLD_APPLICATION_
HANDLE
BIGINT
hld_application_handle - Holding application handle
HLD_MEMBER
SMALLINT
hld_member - Holding member
HLD_APPLICATION_
NAME
VARCHAR(128)
The name of the application running at the client

that is holding this lock.
If the application holding this lock is unknown or

cannot be found then a value of NULL is returned.
If the application holding this lock is unknown or

cannot be found then a 0-length string value is
returned.
HLD_USERID
VARCHAR(128)
The current authorization ID for the session being

used by the application that is holding this lock.
HLD_CURRENT_
STMT_TEXT
CLOB(2MB)
SQL statement text that is currently associated with

the application that is holding the lock. Note that
this is not necessarily the statement that is causing
the lock.
MON_PKG_CACHE_SUMMARY - Retrieve a high-level summary of the

database package cache:
The MON_PKG_CACHE_SUMMARY administrative view returns key metrics for
both static and dynamic SQL statements in the cache, providing a high-level
summary of the database package cache. The metrics returned are aggregated over
all executions of the statement across all members of the database.
Authorization
v SELECT privilege on the MON_PKG_CACHE_SUMMARY administrative view
v CONTROL privilege on the MON_PKG_CACHE_SUMMARY administrative
view
None
Table 199. Information returned by the MON_PKG_CACHE_SUMMARY administrative view
842
Column name
Data type
SECTION_TYPE
CHAR(1)
section_type - Section type indicator
Table 199. Information returned by the MON_PKG_CACHE_SUMMARY administrative

view (continued)
Column name
Data type
EXECUTABLE_ID
VARCHAR(32)
FOR BIT DATA
NUM_COORD_EXEC
BIGINT
num_coord_exec - Number of
executions by coordinator agent
NUM_COORD_EXEC_
WITH_METRICS
BIGINT
num_coord_exec_with_metrics Number of executions by coordinator

agent with metrics
TOTAL_STMT_EXEC_TIME
BIGINT
The total amount of time, in

milliseconds, spent executing the
statement, including nested activities,
over all executions of the statement
where the metrics have been
collected.
AVG_STMT_EXEC_TIME
BIGINT
The average amount of time, in

milliseconds, spent executing the
statement, including nested activities,
collected.
TOTAL_CPU_TIME
BIGINT
The total amount of CPU time, in

microseconds, used while within the
DB2 database manager. This value
represents the combined total of both
user and system CPU time. It is
calculated as the sum of all
values for the statement.
AVG_CPU_TIME
BIGINT
The average amount of CPU time, in

microseconds, spent within the DB2
database manager over all executions
of the statement where the metrics
have been collected.
TOTAL_LOCK_WAIT_TIME
BIGINT
The total elapsed time, in

milliseconds, spent waiting for locks.
This value is calculated as the sum of
all lock_wait_time - Time waited on
locks values for the statement.
AVG_LOCK_WAIT_TIME
BIGINT
The average elapsed time, in

milliseconds, spent waiting for locks
collected.
TOTAL_IO_WAIT_TIME
BIGINT
The total elapsed time, in

milliseconds, spent on I/O
operations. This value is calculated as
the sum of the elapsed time required
to perform direct reads or direct
writes, plus the elapsed time spent
physically reading or writing data
and index pages from or to the table
space containers.
843
Table 199. Information returned by the MON_PKG_CACHE_SUMMARY administrative

view (continued)
Column name
Data type
AVG_IO_WAIT_TIME
BIGINT
The average elapsed time, in

milliseconds, spent on I/O operations
collected.
PREP_TIME
BIGINT
prep_time - Preparation time
ROWS_READ_PER_
ROWS_RETURNED
BIGINT

per rows returned over all executions
of the statement where the metrics
have been collected.
AVG_ACT_WAIT_TIME
BIGINT
Average time spent waiting for

database activities per statement
execution.
AVG_LOCK_ESCALS
BIGINT
Average number of lock escalations

per statement execution.
AVG_RECLAIM_WAIT_TIME
BIGINT
Average time spent waiting for page

reclaims per statement execution.
environment, this value will always
be null.
AVG_SPACEMAPPAGE_
RECLAIM_WAIT_TIME
BIGINT
Average time spent waiting for

reclaims of spacemap pages per
statement execution. Outside of a
STMT_TEXT
CLOB(2MB)
MON_SERVICE_SUBCLASS_SUMMARY - Retrieve metrics for all service

subclasses:
The MON_SERVICE_SUBCLASS_SUMMARY administrative view returns key
metrics for all service subclasses in the currently connected database. It is designed
to help monitor the system in a high-level manner, showing work executed per
service class.
have executed under the indicated service subclass across all members of the
database.
Authorization
v SELECT privilege on the MON_SERVICE_SUBCLASS_SUMMARY
administrative view
v CONTROL privilege on the MON_SERVICE_SUBCLASS_SUMMARY
administrative view
844

None
Table 200. Information returned by the MON_SERVICE_SUBCLASS_SUMMARY
administrative view
Column name
Data type
SERVICE_SUPERCLASS
_NAME
VARCHAR(128)
superclass name
VARCHAR(128)
service_subclass_name - Service
subclass name
SERVICE_CLASS_ID
INTEGER
TOTAL_APP_COMMITS
BIGINT
elements
TOTAL_APP_ROLLBACKS
BIGINT
element
ACT_COMPLETED_TOTAL
BIGINT
element
APP_RQSTS_COMPLETED
_TOTAL
BIGINT
app_rqsts_completed_total - Total
application requests completed
monitor element
AVG_RQST_CPU_TIME
BIGINT

microseconds, used by all
external requests that completed
successfully. It represents the total
of both user and system CPU
time.
ROUTINE_TIME_
RQST_PERCENT
DECIMAL(5,2)

database server spent working on
requests that was spent executing
user routines.
RQST_WAIT_
TIME_PERCENT
DECIMAL(5,2)

database server.
ACT_WAIT_TIME_
PERCENT
DECIMAL(5,2)

executing activities that was spent
server.
DECIMAL(5,2)

operations. This includes time
spent performing direct reads or
direct writes, and time spent
reading data and index pages
from the table space to the
bufferpool or writing them back
to disk.
845

administrative view (continued)
Column name
846
Data type
LOCK_WAIT_TIME_PERCENT DECIMAL(5,2)

server that was spent waiting on
locks.
AGENT_WAIT_TIME_
PERCENT
DECIMAL(5,2)

server that was spent by an
application queued to wait for an
agent under concentrator
configurations.
NETWORK_WAIT_
TIME_PERCENT
DECIMAL(5,2)

server that was spent on
client-server communications.
This includes time spent sending
and receiving data over TCP/IP
or using the IPC protocol.
SECTION_PROC_
TIME_PERCENT
DECIMAL(5,2)

performing sorts.
SECTION_SORT_
PROC_TIME_PERCENT
DECIMAL(5,2)

executing sections.
COMPILE_PROC_
TIME_PERCENT
DECIMAL(5,2)

statement. This includes explicit
and implicit compile times.
TRANSACT_END_PROC
_TIME_PERCENT
DECIMAL(5,2)

transactions.
UTILS_PROC_
TIME_PERCENT
DECIMAL(5,2)

operations.
AVG_LOCK_WAITS
_PER_ACT
BIGINT

applications or connections
waited for locks per coordinator
activities (successful and aborted).

Column name
Data type
AVG_LOCK_TIMEOUTS
_PER_ACT
BIGINT

a request to lock an object timed
out per coordinator activities
AVG_DEADLOCKS_
PER_ACT
BIGINT
The average number of deadlocks

per coordinator activities
AVG_LOCK_ESCALS
_PER_ACT
BIGINT

locks have been escalated from
several row locks to a table lock
ROWS_READ_PER_
ROWS_RETURNED
BIGINT

from the table per rows returned
to the application.
TOTAL_BP_HIT_
RATIO_PERCENT
DECIMAL(5,2)

load a page from disk to service a
data request, index page request,
or a request to process
column-organized table data,
including requests for XML
represents the total hit ratio for
the local bufferpool.
TOTAL_GBP_HIT_
RATIO_PERCENT
DECIMAL(5,2)

load a page from disk into the
local bufferpool to service a data
column-organized table data, as
the page was located in the group
bufferpool. Outside of a DB2
will always be null.
TOTAL_CACHING_TIER_
HIT_RATIO_PERCENT
DECIMAL(5,2)
CF_WAIT_TIME_
PERCENT
DECIMAL(5,2)

time spent waiting for caching
facility communications. Outside
of a DB2 pureScale environment,
RECLAIM_WAIT_TIME_
PERCENT
DECIMAL(5,2)

time spent waiting for page
847

Column name
Data type
WAIT_TIME_PERCENT
DECIMAL(5,2)

time spent waiting for space map
page reclaims. Outside of a DB2
MON_TBSP_UTILIZATION - Retrieve monitoring metrics for all table spaces

and all database partitions:
The MON_TBSP_UTILIZATION administrative view returns key monitoring
metrics, including hit ratios and utilization percentage, for all table spaces and all
database partitions in the currently connected database. It provides critical
information for monitoring performance as well as space utilization. This
administrative view is a replacement for the TBSP_UTILIZATION administrative
view.
Authorization
v SELECT privilege on the MON_TBSP_UTILIZATION administrative view
v CONTROL privilege on the MON_TBSP_UTILIZATION administrative view
None
Table 201. Information returned by the MON_TBSP_UTILIZATION administrative view
element
Column name
Data type
TBSP_NAME
VARCHAR(128) tablespace_name - Table space

name
MEMBER
SMALLINT
TBSP_TYPE
VARCHAR(10)
tablespace_type - Table space

type. This interface returns a
text identifier based on defines
in sqlutil.h, and is one of:
v DMS
v SMS
848
Table 201. Information returned by the MON_TBSP_UTILIZATION administrative

view (continued)
Column name
Data type
TBSP_CONTENT_TYPE
VARCHAR(10)
element
tablespace_content_type - Table
space content type. This
interface returns a text
identifier based on defines in
sqlmon.h, and is one of:
v ANY
v LARGE
v SYSTEMP
v USRTEMP
TBSP_STATE
VARCHAR(256) tablespace_state - Table space

state
TBSP_PAGE_SIZE
BIGINT
tablespace_page_size - Table
space page size
TBSP_EXTENT_SIZE
BIGINT
tablespace_extent_size - Table
space extent size
TBSP_PREFETCH_SIZE
BIGINT
tablespace_prefetch_size - Table
space prefetch size
TBSP_USING_
AUTO_STORAGE
SMALLINT
tablespace_using_auto _storage
- Table space enabled for
automatic storage
TBSP_AUTO_
RESIZE_ENABLED
SMALLINT
tablespace_auto_resize
_enabled - Table space
automatic resizing enabled
TBSP_TOTAL_SIZE_KB
BIGINT
The total size of the table space

in kilobytes. This is calculated
as (tablespace_total_pages *
tablespace_page_size) / 1024
where tablespace_total_pages and
tablespace_page_size represent
the following monitor
elements:
v
tablespace_total_pages Total pages in table space
v tablespace_page_size - Table
space page size
849

view (continued)
Column name
Data type
TBSP_USABLE_SIZE_KB
BIGINT
element
The total usable size of the
table space, in kilobytes. This
equals the total size of the table
space minus the space used for
overhead pages. This is
calculated as
(tablespace_usable_pages *
tablespace_page_size) / 1024
where tablespace_usable_pages
and tablespace_page_size
elements:
v
tablespace_usable_pages Usable pages in table space
v tablespace_page_size - Table
space page size
TBSP_UTILIZATION
_PERCENT
DECIMAL(5,2)
The utilization of the table

space as a percentage. If
tablespace_usable_pages is greater
than zero, this is calculated as
(tablespace_used_pages /
tablespace_usable_pages) * 100
where tablespace_used_pages and
tablespace_usable_pages represent
elements:
v
tablespace_used_pages Used pages in table space
tablespace_usable_pages Usable pages in table space
NULL is returned if
tablespace_usable_pages is not
greater than zero.
850
TBSP_PAGE_TOP
BIGINT
tablespace_page_top - Table
space high watermark
DATA_PHYSICAL_READS
BIGINT
Indicates the number of data

pages read from the table space
containers (physical) for
temporary as well as regular
calculated as (pool_data_p_reads
+ pool_temp_data_p_reads) where
pool_data_p_reads and
elements:
pool_data_p_reads - Buffer
pool data physical reads
pool_temp_data_p_reads Buffer pool temporary data

physical reads

view (continued)
element
Column name
Data type
DATA_HIT_
RATIO_PERCENT
DECIMAL(5,2)
Data hit ratio, that is, the

percentage of time that the
service a data page request.
BIGINT
Indicates the number of index

pages read from the table space
containers (physical) for
calculated as
(pool_index_p_reads +
pool_temp_index_p_reads) where
pool_index_p_reads and
elements:
v
pool_index_p_reads - Buffer
pool index physical reads

physical reads
INDEX_HIT_RATIO
_PERCENT
DECIMAL(5,2)
Index hit ratio, that is, the

service an index data page
request.
XDA_PHYSICAL_READS
BIGINT
Indicates the number of data

pages for XML storage objects
(XDAs) read from the table
space containers (physical) for
calculated as (pool_xda_p_reads
+ pool_temp_xda_p_reads) where
pool_xda_p_reads and
pool_temp_xda_p_reads represent
elements:
v
pool_xda_p_reads - Buffer
pool XDA data physical
reads
pool_temp_xda_p_reads Buffer pool temporary XDA

data physical reads
851

view (continued)
element
Column name
Data type
DECIMAL(5,2)
Auxiliary storage objects hit

ratio, that is, the percentage of
time that the database manager
did not need to load a page
from disk to service a data
page request for XML storage
objects (XDAs). In a DB2
value is the percentage of time
the database manager used to
locate a data page for an XDA
in the local buffer pool.
COL_PHYSICAL_READS
BIGINT
Indicates the number of

column-organized table data
pages read from the physical
table space containers for
temporary, regular, and large
table spaces. This is calculated
as (pool_col_p_reads +
pool_col_p_reads and
pool_temp_col_p_reads represent
elements:
v pool_col_p_reads - Buffer
pool column-organized
physical reads
v pool_temp_col_p_reads Buffer pool
column-organized temporary
physical reads
852
COL_HIT_RATIO_PERCENT
DECIMAL(5,2)
Column-organized table data

hit ratio. The percentage of
from disk to service a
page request. In DB2 pureScale
database manager located a
data page in the local buffer
pool.
GBP_DATA_HIT_RATIO_PERCENT
DECIMAL(5,2)
Group bufferpool data hit ratio.

to load a page from disk in
order to service a data page
request because the page was
already in the group
value is null.

view (continued)
element
Column name
Data type
GBP_INDEX_HIT_RATIO_PERCENT
DECIMAL(5,2)
Group bufferpool index hit

ratio. The percentage of time
that the database manager did
not need to load a page from
disk in order to service an
index page request because the
page was already in the group
value is null.
GBP_XDA_HIT_RATIO_PERCENT
DECIMAL(5,2)
Group bufferpool auxiliary

storage object hit ratio, that is,
service a data page request for
XML storage object (XDAs)
since the page was in the
DB2 pureScale environment,
GBP_COL_HIT_RATIO_PERCENT
DECIMAL(5,2)
Group bufferpool
hit ratio. The percentage of
from disk in order to service a
request because the page was
already in the group
pureScale environment
environment, this value is null.
CACHING_TIER_DATA
_HIT_RATIO_PERCENT
DECIMAL(5,2)
CACHING_TIER_INDEX
_HIT_RATIO_PERCENT
DECIMAL(5,2)
CACHING_TIER_XDA
_HIT_RATIO_PERCENT
DECIMAL(5,2)
CACHING_TIER_COL
_HIT_RATIO_PERCENT
DECIMAL(5,2)
MON_TRANSACTION_LOG_UTILIZATION administrative view - Retrieve log

utilization information:
The MON_TRANSACTION_LOG_UTILIZATION administrative view returns
information about transaction log utilization for the currently connected database.
A single row is returned for each member.
853
Authorization
v SELECT privilege on the MON_TRANSACTION_LOG_UTILIZATION
administrative view
v CONTROL privilege on the MON_TRANSACTION_LOG_UTILIZATION
administrative view
v DBADM authority
v SQLADM authority
Table 202. Information returned by the MON_TRANSACTION_LOG_UTILIZATION
administrative view
monitor element
Column name
Data type
LOG_UTILIZATION_PERCENT
DECIMAL(5,2)
Indicates the percentage of the

total log space that is in use.
TOTAL_LOG_USED_KB
BIGINT
total_log_used - Total log space

used. This interface returns the
value in KB.
TOTAL_LOG_AVAILABLE_KB
BIGINT
total_log_available - Total log

available. This interface returns the
value in KB.
TOTAL_LOG_USED_TOP_KB
BIGINT
tot_log_used_top - Maximum total

log space used. This interface
returns the value in KB.
MEMBER
SMALLINT

monitor element
Usage notes
For databases that are configured for infinite logging, the values for
LOG_UTILIZATION_PERCENT and TOTAL_LOG_AVAILABLE_KB are NULL.
MON_WORKLOAD_SUMMARY - Retrieves metrics for all workloads:
The MON_WORKLOAD_SUMMARY administrative view returns key metrics for
all workloads in the currently connected database. It is designed to help monitor
the system in a high-level manner, showing incoming work per workload.
were submitted by connections mapped to the identified workload object across all
members of the database.
854
Authorization
v SELECT privilege on the MON_WORKLOAD_SUMMARY administrative view
v CONTROL privilege on the MON_WORKLOAD_SUMMARY administrative
view
None
Table 203. Information returned by the MON_WORKLOAD_SUMMARY administrative view
element
Column name
Data type
WORKLOAD_NAME
VARCHAR(128)
name
WORKLOAD_ID
INTEGER
TOTAL_APP_COMMITS
BIGINT
elements
TOTAL_APP_ROLLBACKS
BIGINT
element
ACT_COMPLETED_TOTAL
BIGINT
element
APP_RQSTS_COMPLETED
_TOTAL
BIGINT
Total number of external

(application) requests that
completed successfully across
all members of the database
for the specified service
subclass
AVG_RQST_CPU_TIME
BIGINT
Average amount of CPU time,

in microseconds, used by all
external requests that
completed successfully. It
represents the total of both
user and system CPU time.
ROUTINE_TIME_
RQST_PERCENT
DECIMAL(5,2)

database server spent working
on requests that was spent
executing user routines.
RQST_WAIT_
TIME_PERCENT
DECIMAL(5,2)
The percentage of the time

spent working on requests that
was spent waiting within the
DB2 database server.
ACT_WAIT_TIME_
PERCENT
DECIMAL(5,2)

spent executing activities that
was spent waiting within the
DB2 database server.
855
Table 203. Information returned by the MON_WORKLOAD_SUMMARY administrative

view (continued)
856
element
Column name
Data type
DECIMAL(5,2)

database server that was due
to I/O operations. This
includes time spent performing
direct reads or direct writes,
and time spent reading data
and index pages from the table
space to the bufferpool or
writing them back to disk.
LOCK_WAIT_TIME_
PERCENT
DECIMAL(5,2)

waiting within the DB2
database server that was spent
waiting on locks.
AGENT_WAIT_TIME_
PERCENT
DECIMAL(5,2)

by an application queued to
wait for an agent under
concentrator configurations.
NETWORK_WAIT_
TIME_PERCENT
DECIMAL(5,2)

on client-server
communications. This includes
time spent sending and
receiving data over TCP/IP or
using the IPC protocol.
SECTION_PROC_
TIME_PERCENT
DECIMAL(5,2)

performing sorts.
SECTION_SORT_
PROC_TIME_PERCENT
DECIMAL(5,2)

executing sections.
COMPILE_PROC_
TIME_PERCENT
DECIMAL(5,2)

statement. This includes
explicit and implicit compile
times.
TRANSACT_END_PROC
_TIME_PERCENT
DECIMAL(5,2)

transactions.

view (continued)
element
Column name
Data type
UTILS_PROC_
TIME_PERCENT
DECIMAL(5,2)

operations.
AVG_LOCK_WAITS
_PER_ACT
BIGINT

that applications or
connections waited for locks
AVG_LOCK_TIMEOUTS
_PER_ACT
BIGINT

that a request to lock an object
timed out per coordinator
aborted).
AVG_DEADLOCKS_
PER_ACT
BIGINT
The average number of

deadlocks per coordinator
aborted).
AVG_LOCK_ESCALS
_PER_ACT
BIGINT

that locks have been escalated
from several row locks to a
table lock per coordinator
aborted).
ROWS_READ_PER_
ROWS_RETURNED
BIGINT
The average number of rows

read from the table per rows
TOTAL_BP_HIT_
RATIO_PERCENT
DECIMAL(5,2)

database manager did not
need to load a page from disk
to service a data request, index
page request, or a request to
process column-organized
table data, including requests
for XML storage objects
(XDAs). In a DB2 pureScale
environment, this value
represents the total hit ratio for
the local bufferpool.
857

view (continued)
element
Column name
Data type
TOTAL_GBP_HIT_
RATIO_PERCENT
DECIMAL(5,2)
In a DB2 pureScale
environment, the percentage of
time that the database
manager did not need to load
a page from disk into the local
bufferpool to service a data
column-organized table data,
as the page was located in the
TOTAL_CACHING_TIER_
HIT_RATIO_PERCENT
DECIMAL(5,2)
CF_WAIT_TIME_
PERCENT
DECIMAL(5,2)
In a DB2 pureScale
the total wait time spent
waiting for caching facility
communications. Outside of a
RECLAIM_WAIT_TIME_
PERCENT
DECIMAL(5,2)
In a DB2 pureScale
waiting for page reclaims.
environment, this value will
always be null.
WAIT_TIME_PERCENT
DECIMAL(5,2)
In a DB2 pureScale
waiting for space map page
MQSeries routines
MQPUBLISH
The MQPUBLISH function publishes data to MQSeries.
For more details, visit http://www.ibm.com/software/mqseries/.
The MQPUBLISH function publishes the data contained in msg-data to the
MQSeries publisher specified in publisher-service, and using the quality of service
policy defined by service-policy. An optional topic for the message can be specified,
and an optional user-defined message correlation identifier can also be specified.
858
The data type of the result is VARCHAR(1). The result of the function is '1' if
successful or '0' if unsuccessful.
Syntax
MQPUBLISH (
msg-data
publisher-service
service-policy

,
topic
(1)
,
correl-id
Notes:
1
The correl-id cannot be specified unless a service and a policy are also specified.
The schema is DB2MQ for non-transactional message queuing functions, and

DB2MQ1C for one-phase commit transactional MQ functions.
Function parameters
publisher-service
A string containing the logical MQSeries destination where the message is to
be sent. If specified, the publisher-service must refer to a publisher Service
Point defined in the DB2MQ.MQPUBSUB table that has a type value of 'P' for
publisher service. If publisher-service is not specified, the
DB2.DEFAULT.PUBLISHER will be used. The maximum size of publisher-service
is 48 bytes.
service-policy
A string containing the MQSeries Service Policy to be used in handling of this
message. If specified, the service-policy must refer to a Policy defined in the
DB2MQ.MQPOLICY table. A Service Policy defines a set of quality of service
options that should be applied to this messaging operation. These options
include message priority and message persistence. If service-policy is not
specified, the default DB2.DEFAULT.POLICY will be used. The maximum size
of service-policy is 48 bytes.
msg-data
A string expression containing the data to be sent via MQSeries. The maximum
size for a VARCHAR string expression is 32 000 bytes and the maximum size
for a CLOB string expression is 1M bytes.
topic
A string expression containing the topic for the message publication. If no topic
is specified, none will be associated with the message. The maximum size of
topic is 40 bytes. Multiple topics can be specified in one string (up to 40
characters long). Each topic must be separated by a colon. For example,
"t1:t2:the third topic" indicates that the message is associated with all three
topics: t1, t2, and "the third topic".
correl-id
An optional string expression containing a correlation identifier to be
associated with this message. The correl-id is often specified in request and
reply scenarios to associate requests with replies. If not specified, no correlation
ID will be added to the message. The maximum size of correl-id is 24 bytes.
859
Authorization
One of the following authorities is required to execute the function:
v DBADM authority
v SQLADM authority

Examples
Example 1: This example publishes the string "Testing 123" to the default publisher
service (DB2.DEFAULT.PUBLISHER) using the default policy
(DB2.DEFAULT.POLICY). No correlation identifier or topic is specified for the
message.
VALUES MQPUBLISH(Testing 123)
Example 2: This example publishes the string "Testing 345" to the publisher service
"MYPUBLISHER" under the topic "TESTS". The default policy is used and no
correlation identifier is specified.
VALUES MQPUBLISH(MYPUBLISHER,Testing 345, TESTS)
"MYPUBLISHER" using the policy "MYPOLICY" with a correlation identifier of
"TEST1". The message is published with topic "TESTS".
VALUES MQPUBLISH(MYPUBLISHER,MYPOLICY,Testing 678,TESTS,TEST1)
"MYPUBLISHER" under the topic "TESTS" using the default policy
(DB2.DEFAULT.POLICY) and no correlation identifier.
VALUES MQPUBLISH(Testing 901,TESTS)
MQREAD
The MQREAD function returns a message from the MQSeries location specified by
receive-service, using the quality of service policy defined in service-policy.
Executing this operation does not remove the message from the queue associated
with receive-service, but instead returns the message at the head of the queue.
The data type of the result is VARCHAR (32000). If no messages are available to be
returned, the result is the null value.
Syntax
MQREAD (
)
receive-service
,
860
service-policy

Function parameters
receive-service
A string containing the logical MQSeries destination from where the message is
to be received. If specified, the receive-service must refer to a Service Point
defined in the DB2MQ.MQSERVICE table. A service point is a logical
end-point from where a message is sent or received. Service points definitions
include the name of the MQSeries Queue Manager and Queue. If receive-service
is not specified, then the DB2.DEFAULT.SERVICE will be used. The maximum
size of receive-service is 48 bytes.
service-policy
A string containing the MQSeries Service Policy used in handling this message.
If specified, the service-policy must refer to a Policy defined in the
specified, then the default DB2.DEFAULT.POLICY will be used. The maximum
size of service-policy is 48 bytes.
Authorization
v DBADM authority
v SQLADM authority

Examples
Example 1: This example reads the message at the head of the queue specified by
the default service (DB2.DEFAULT.SERVICE), using the default policy
(DB2.DEFAULT.POLICY).
VALUES MQREAD()
the service "MYSERVICE" using the default policy (DB2.DEFAULT.POLICY).
VALUES MQREAD(MYSERVICE)
the service "MYSERVICE", and using the policy "MYPOLICY".
VALUES MQREAD(MYSERVICE,MYPOLICY)
MQREADALL
The MQREADALL table function returns a table containing the messages and
message metadata from the MQSeries location specified by receive-service, using the
quality of service policy service-policy.
861
Performing this operation does not remove the messages from the queue
associated with receive-service.
Syntax
MQREADALL (
)
receive-service
num-rows
,
service-policy


receive-service
A string containing the logical MQSeries destination from which the message is
read. If specified, the receive-service must refer to a service point defined in the
DB2MQ.MQSERVICE table. A service point is a logical end-point from which a
message is sent or received. Service point definitions include the name of the
MQSeries Queue Manager and Queue. If receive-service is not specified, then the
DB2.DEFAULT.SERVICE will be used. The maximum size of receive-service is 48
bytes.
service-policy
A string containing the MQSeries Service Policy used in the handling of this
message. If specified, the service-policy refers to a Policy defined in the
DB2MQ.MQPOLICY table. A service policy defines a set of quality of service
num-rows
A positive integer containing the maximum number of messages to be returned
by the function.
If num-rows is specified, then a maximum of num-rows messages will be
returned. If num-rows is not specified, then all available messages will be
returned.
Authorization
v DBADM authority
v SQLADM authority

862
Examples
Example 1: This example receives all the messages from the queue specified by the
default service (DB2.DEFAULT.SERVICE), using the default policy
(DB2.DEFAULT.POLICY). The messages and all the metadata are returned as a
table.
SELECT * FROM table (MQREADALL()) AS T
Example 2: This example receives all the messages from the head of the queue
specified by the service MYSERVICE, using the default policy
(DB2.DEFAULT.POLICY). Only the MSG and CORRELID columns are returned.
SELECT T.MSG, T.CORRELID FROM table (MQREADALL(MYSERVICE)) AS T
Example 3: This example reads the head of the queue specified by the default
service (DB2.DEFAULT.SERVICE), using the default policy
(DB2.DEFAULT.POLICY). Only messages with a CORRELID of '1234' are returned.
All columns are returned.
SELECT * FROM table (MQREADALL()) AS T WHERE T.CORRELID = 1234
Example 4: This example receives the first 10 messages from the head of the queue
specified by the default service (DB2.DEFAULT.SERVICE), using the default policy
(DB2.DEFAULT.POLICY). All columns are returned.
SELECT * FROM table (MQREADALL(10)) AS T
Table 204. Information returned by the MQREADALL table function
Column name
Data type
Description
MSG
VARCHAR(32000)
Contains the contents of the

MQSeries message.
CORRELID
VARCHAR(24)
Contains a correlation ID
that can be used to identify
messages. You can select a
message from the queue
using this identifier. In the
case of a request and
response scenario, the
correlation ID enables you to
associate a response with a
particular request.
TOPIC
VARCHAR(40)
Contains the topic with

which the message was
published, if available.
QNAME
VARCHAR(48)
Contains the name of the

queue where the message
was received.
MSGID
CHAR(24)
Contains the assigned unique

MQSeries identifier for this
message.
MSGFORMAT
VARCHAR(8)
Contains the format of the

message, as defined by
MQSeries. Typical strings
have an MQSTR format.
863
MQREADALLCLOB
The MQREADALLCLOB table function returns a table containing the messages
and message metadata from the MQSeries location specified by receive-service,
using the quality of service policy service-policy.
Performing this operation does not remove the messages from the queue
associated with receive-service.
Syntax
MQREADALLCLOB
(
)
receive-service
num-rows
, service-policy
The schema is DB2MQ.

receive-service
read. If specified, the receive-service must refer to a service point defined in the
message is sent or received. Service point definitions include the name of the
MQSeries Queue Manager and Queue. If receive-service is not specified, then the
DB2.DEFAULT.SERVICE will be used. The maximum size of receive-service is 48
bytes.
service-policy
num-rows
by the function.
returned.
Authorization
v DBADM authority
v SQLADM authority
864

Examples
table.
SELECT * FROM table (MQREADALLCLOB()) AS T
SELECT T.MSG, T.CORRELID FROM table (MQREADALLCLOB(MYSERVICE)) AS T
Example 3: This example reads the head of the queue specified by the default
service (DB2.DEFAULT.SERVICE), using the default policy
(DB2.DEFAULT.POLICY). Only messages with a CORRELID of '1234' are returned.
All columns are returned.
SELECT * FROM table (MQREADALLCLOB()) AS T WHERE T.CORRELID = 1234
SELECT * FROM table (MQREADALLCLOB(10)) AS T
Table 205. Information returned by the MQREADALLCLOB table function
Column name
Data type
Description
MSG
CLOB(1M)

MQSeries message.
CORRELID
VARCHAR(24)
particular request.
TOPIC
VARCHAR(40)

QNAME
VARCHAR(48)

was received.
MSGID
CHAR(24)

message.
865
Table 205. Information returned by the MQREADALLCLOB table function (continued)

Column name
Data type
Description
MSGFORMAT
VARCHAR(8)

MQREADCLOB
The MQREADCLOB function returns a message from the MQSeries location
specified by receive-service, using the quality of service policy defined in
service-policy.
Executing this operation does not remove the message from the queue associated
with receive-service, but instead returns the message at the head of the queue.
The data type of the result is CLOB(1M). If no messages are available to be
Syntax
MQREADCLOB (
receive-service
,
service-policy
Function parameters
receive-service
A string containing the logical MQSeries destination from where the message is
to be received. If specified, the receive-service must refer to a Service Point
defined in the DB2MQ.MQSERVICE table. A service point is a logical
end-point from where a message is sent or received. Service points definitions
include the name of the MQSeries Queue Manager and Queue. If receive-service
is not specified, then the DB2.DEFAULT.SERVICE will be used. The maximum
size of receive-service is 48 bytes.
service-policy
A string containing the MQSeries Service Policy used in handling this message.
Authorization
v
v
v
v
866
EXECUTE privilege on the function

DBADM authority
SQLADM authority

Examples
the default service (DB2.DEFAULT.SERVICE), using the default policy
VALUES MQREADCLOB()
the service "MYSERVICE" using the default policy (DB2.DEFAULT.POLICY).
VALUES MQREADCLOB(MYSERVICE)
the service "MYSERVICE", and using the policy "MYPOLICY".
VALUES MQREADCLOB(MYSERVICE,MYPOLICY)
MQRECEIVE
The MQRECEIVE function returns a message from the MQSeries location specified
by receive-service, using the quality of service policy service-policy.
Performing this operation removes the message from the queue associated with
receive-service. If the correl-id is specified, then the first message with a matching
correlation identifier will be returned. If correl-id is not specified, then the message
at the head of the queue will be returned.
The data type of the result is VARCHAR (32000). If no messages are available to be
Syntax
MQRECEIVE
(
receive-service
,
service-policy
,
correl-id

Function parameters
receive-service
received. If specified, the receive-service must refer to a Service Point defined in
the DB2MQ.MQSERVICE table. A service point is a logical end-point from
which a message is sent or received. Service points definitions include the
name of the MQSeries Queue Manager and Queue. If receive-service is not
specified, the DB2.DEFAULT.SERVICE is used. The maximum size of
receive-service is 48 bytes.
867
service-policy
A string containing the MQSeries Service Policy to be used in the handling of
this message. If specified, service-policy must refer to a policy defined in the
specified, the default DB2.DEFAULT.POLICY is used. The maximum size of
service-policy is 48 bytes.
correl-id
A string containing an optional correlation identifier to be associated with this
message. The correl-id is often specified in request and reply scenarios to
associate requests with replies. If not specified, no correlation id will be
specified. The maximum size of correl-id is 24 bytes.
Authorization
v DBADM authority
v SQLADM authority

Examples
Example 1: This example receives the message at the head of the queue specified
by the default service (DB2.DEFAULT.SERVICE), using the default policy
VALUES MQRECEIVE()
by the service "MYSERVICE" using the default policy (DB2.DEFAULT.POLICY).
VALUES MQRECEIVE(MYSERVICE)
by the service "MYSERVICE" using the policy "MYPOLICY".
VALUES MQRECEIVE(MYSERVICE,MYPOLICY)
Example 4: This example receives the first message with a correlation id that
matches '1234' from the head of the queue specified by the service "MYSERVICE"
using the policy "MYPOLICY".
VALUES MQRECEIVE(MYSERVICE,MYPOLICY,1234)
MQRECEIVEALL
The MQRECEIVEALL table function returns a table containing the messages and
message metadata from the MQSeries location specified by receive-service, using the
quality of service policy service-policy.
Performing this operation removes the messages from the queue associated with
receive-service.
868
Syntax
MQRECEIVEALL (

receive-service
,
service-policy
, correl-id
num-rows
,


receive-service
received. If specified, the receive-service must refer to a service point defined in
which a message is sent or received. Service point definitions include the name
of the MQSeries Queue Manager and Queue. If receive-service is not specified,
then the DB2.DEFAULT.SERVICE will be used. The maximum size of
service-policy
correl-id
An optional string containing a correlation identifier associated with this
associate requests with replies. If not specified, no correlation id is specified.
The maximum size of correl-id is 24 bytes.
If a correl-id is specified, all the messages with a matching correlation identifier
are returned and removed from the queue. If correl-id is not specified, the
message at the head of the queue is returned.
num-rows
by the function.
returned.
Authorization
869
v DBADM authority
v SQLADM authority

Examples
table.
SELECT * FROM table (MQRECEIVEALL()) AS T
SELECT T.MSG, T.CORRELID FROM table (MQRECEIVEALL(MYSERVICE)) AS T
Example 3: This example receives all of the message from the head of the queue
specified by the service "MYSERVICE", using the policy "MYPOLICY". Only
messages with a CORRELID of '1234' are returned. Only the MSG and CORRELID
columns are returned.
SELECT T.MSG, T.CORRELID FROM table
(MQRECEIVEALL(MYSERVICE,MYPOLICY,1234)) AS T
SELECT * FROM table (MQRECEIVEALL(10)) AS T
Table 206. Information returned by the MQRECEIVEALL table function
870
Column name
Data type
Description
MSG
VARCHAR(32000)

MQSeries message.
CORRELID
VARCHAR(24)
particular request.
TOPIC
VARCHAR(40)

Table 206. Information returned by the MQRECEIVEALL table function (continued)

Column name
Data type
Description
QNAME
VARCHAR(48)

was received.
MSGID
CHAR(24)

message.
MSGFORMAT
VARCHAR(8)

MQRECEIVEALLCLOB
The MQRECEIVEALLCLOB table function returns a table containing the messages
and message metadata from the MQSeries location specified by receive-service,
using the quality of service policy service-policy.
Performing this operation removes the messages from the queue associated with
receive-service.
Syntax
MQRECEIVEALLCLOB (

receive-service
,
service-policy
, correl-id
num-rows
,

receive-service
received. If specified, the receive-service must refer to a service point defined in
which a message is sent or received. Service point definitions include the name
of the MQSeries Queue Manager and Queue. If receive-service is not specified,
then the DB2.DEFAULT.SERVICE will be used. The maximum size of
service-policy
DB2MQ.MQPOLICY table A service policy defines a set of quality of service
871
correl-id
associate requests with replies. If not specified, no correlation id is specified.
If a correl-id is specified, then only those messages with a matching correlation
identifier will be returned. If correl-id is not specified, then the message at the
head of the queue will be returned.
num-rows
by the function.
returned. If num-rows is not specified, then all available messages are returned.
Authorization
v DBADM authority
v SQLADM authority

Examples
table.
SELECT * FROM table (MQRECEIVEALLCLOB()) AS T
SELECT T.MSG, T.CORRELID
FROM table (MQRECEIVEALLCLOB(MYSERVICE)) AS T
Example 3: This example receives all of the message from the head of the queue
specified by the service "MYSERVICE", using the policy "MYPOLICY". Only
messages with a CORRELID of '1234' are returned. Only the MSG and CORRELID
columns are returned.
SELECT T.MSG, T.CORRELID
FROM table (MQRECEIVEALLCLOB(MYSERVICE,MYPOLICY,1234)) AS T
SELECT * FROM table (MQRECEIVEALLCLOB(10)) AS T
872
Table 207. Information returned by the MQRECEIVEALLCLOB table function
Column name
Data type
Description
MSG
CLOB(1M)

MQSeries message.
CORRELID
VARCHAR(24)
particular request.
TOPIC
VARCHAR(40)

QNAME
VARCHAR(48)

was received.
MSGID
CHAR(24)

message.
MSGFORMAT
VARCHAR(8)

MQRECEIVECLOB
The MQRECEIVECLOB function returns a message from the MQSeries location
specified by receive-service, using the quality of service policy service-policy.
Performing this operation removes the message from the queue associated with
receive-service. If the correl-id is specified, the first message with a matching
correlation identifier will be returned. If correl-id is not specified, the message at the
head of the queue will be returned.
The data type of the result is CLOB(1M). If no messages are available to be
Syntax
MQRECEIVECLOB
(
receive-service
,
service-policy
,
correl-id
873
Function parameters
receive-service
received. If specified, the receive-service must refer to a Service Point defined in
which a message is sent or received. Service points definitions include the
name of the MQSeries Queue Manager and Queue. If receive-service is not
specified, the DB2.DEFAULT.SERVICE is used. The maximum size of
service-policy
A string containing the MQSeries Service Policy to be used in the handling of
this message. If specified, the service-policy must refer to a policy defined in the
specified, the default DB2.DEFAULT.POLICY is used. The maximum size of
correl-id
A string containing an optional correlation identifier to be associated with this
associate requests with replies. If not specified, no correlation id will be used.
Authorization
v DBADM authority
v SQLADM authority

Examples
by the default service (DB2.DEFAULT.SERVICE), using the default policy
VALUES MQRECEIVECLOB()
by the service "MYSERVICE" using the default policy (DB2.DEFAULT.POLICY).
VALUES MQRECEIVECLOB(MYSERVICE)
by the service "MYSERVICE" using the policy "MYPOLICY".
VALUES MQRECEIVECLOB(MYSERVICE,MYPOLICY)
874
Example 4: This example receives the first message with a correlation ID that
matches '1234' from the head of the queue specified by the service "MYSERVICE"
using the policy "MYPOLICY".
VALUES MQRECEIVECLOB(MYSERVICE,MYPOLICY,1234)
MQSEND
The MQSEND function sends the data contained in msg-data to the MQSeries
location specified by send-service, using the quality of service policy defined by
service-policy.
An optional user-defined message correlation identifier can be specified using
correl-id.
Syntax
MQSEND (
msg-data
send-service
service-policy
(1)
, correl-id
Notes:
1
The correl-id cannot be specified unless a service and a policy are also specified.

Function parameters
msg-data
A string expression containing the data to be sent via MQSeries. The maximum
size for a VARCHAR string expression is 32 000 bytes and the maximum size
for a CLOB string expression is 1M bytes.
send-service
A string containing the logical MQSeries destination where the message is to
be sent. If specified, the send-service refers to a service point defined in the
message may be sent or received. Service point definitions include the name of
the MQSeries Queue Manager and Queue. If send-service is not specified, the
value of DB2.DEFAULT.SERVICE is used. The maximum size of send-service is
48 bytes.
service-policy
A string containing the MQSeries Service Policy used in handling of this
message. If specified, the service-policy must refer to a service policy defined in
the DB2MQ.MQPOLICY table. A Service Policy defines a set of quality of
service options that should be applied to this messaging operation. These
options include message priority and message persistence. If service-policy is
not specified, a default value of DB2.DEFAULT.POLICY will be used. The
maximum size of service-policy is 48 bytes.
875
correl-id
associate requests with replies. If not specified, no correlation ID will be sent.
Authorization
v DBADM authority
v SQLADM authority

Examples
Example 1: This example sends the string "Testing 123" to the default service
(DB2.DEFAULT.SERVICE), using the default policy (DB2.DEFAULT.POLICY), with
no correlation identifier.
VALUES MQSEND(Testing 123)
Example 2: This example sends the string "Testing 345" to the service
"MYSERVICE", using the policy "MYPOLICY", with no correlation identifier.
VALUES MQSEND(MYSERVICE,MYPOLICY,Testing 345)
"MYSERVICE", using the policy "MYPOLICY", with correlation identifier "TEST3".
VALUES MQSEND(MYSERVICE,MYPOLICY,Testing 678,TEST3)
"MYSERVICE", using the default policy (DB2.DEFAULT.POLICY), and no
correlation identifier.
VALUES MQSEND(MYSERVICE,Testing 901)
MQSUBSCRIBE
The MQSUBSCRIBE function is used to register interest in MQSeries messages
published on a specified topic. Successful execution of this function causes the
publish and subscribe server to forward messages matching the topic to the service
point defined by subscriber-service.
The subscriber-service specifies a logical destination for messages that match the
specified topic. Messages that match topic are placed on the queue defined by
subscriber-service, and can be read or received through a subsequent call to
MQREAD, MQRECEIVE, MQREADALL, or MQRECEIVEALL. For more details,
visit http://www.ibm.com/software/mqseries/.
876
Syntax
MQSUBSCRIBE (
topic )
subscriber-service
,
service-policy

Function parameters
subscriber-service
A string containing the logical MQSeries subscription point to where messages
matching topic will be sent. If specified, the subscriber-service must refer to a
Subscribers Service Point defined in the DB2MQ.MQPUBSUB table that has a
type value of 'S' for publisher service. If subscriber-service is not specified, then
the DB2.DEFAULT.SUBSCRIBER will be used instead. The maximum size of
subscriber-service is 48 bytes.
service-policy
A string containing the MQSeries Service Policy to be used in handling the
message. If specified, the service-policy must refer to a Policy defined in the
options to be applied to this messaging operation. These options include
message priority and message persistence. If service-policy is not specified, then
the default DB2.DEFAULT.POLICY will be used instead. The maximum size of
topic
A string defining the types of messages to receive. Only messages published
with the specified topics will be received by this subscription. Multiple
subscriptions can coexist. The maximum size of topic is 40 bytes. Multiple
topics can be specified in one string (up to 40 bytes long). Each topic must be
separated by a colon. For example, "t1:t2:the third topic" indicates that the
message is associated with all three topics: t1, t2, and "the third topic".
Authorization
v
v
v
v
EXECUTE privilege on the function

DBADM authority
SQLADM authority

Examples
Example 1: This example registers an interest in messages containing the topic
"Weather". The default subscriber-service (DB2.DEFAULT.SUBSCRIBER) is
registered as the subscriber and the default service-policy (DB2.DEFAULT.POLICY)
specifies the quality of service.
877
VALUES MQSUBSCRIBE(Weather)
Example 2: This example demonstrates a subscriber registering interest in messages

containing "Stocks". The subscriber registers as "PORTFOLIO-UPDATES" with
policy "BASIC-POLICY".
VALUES MQSUBSCRIBE(PORTFOLIO-UPDATES,BASIC-POLICY,Stocks)
MQUNSUBSCRIBE
The MQUNSUBSCRIBE function is used to unregister an existing message
subscription.
The subscriber-service, service-policy, and topic are used to identify the subscription
that is to be cancelled. Successful execution of this function causes the publish and
subscribe server to remove the specified subscription. Messages with the specified
topic will no longer be sent to the logical destination defined by subscriber-service.
For more details, visit http://www.ibm.com/software/mqseries/.
Syntax
MQUNSUBSCRIBE
(
topic
subscriber-service ,
service-policy

Function parameters
subscriber-service
If specified, the subscriber-service must refer to a Subscribers Service Point
defined in the DB2MQ.MQPUBSUB table that has a type value of 'S' for
publisher service. If subscriber-service is not specified, then the
DB2.DEFAULT.SUBSCRIBER will be used instead. The maximum size of
subscriber-service is 48 bytes.
service-policy
options to be applied to this messaging operation. If service-policy is not
topic
A string specifying the subject of messages that are not to be received. The
maximum size of topic is 40 bytes. Multiple topics can be specified in one
string (up to 40 bytes long). Each topic must be separated by a colon. For
example, "t1:t2:the third topic" indicates that the message is associated with all
three topics: t1, t2, and "the third topic".
878
Authorization
v DBADM authority
v SQLADM authority

Examples
Example 1: This example cancels an interest in messages containing the topic
"Weather". The default subscriber-service (DB2.DEFAULT.SUBSCRIBER) is
registered as the unsubscriber and the default service-policy
(DB2.DEFAULT.POLICY) specifies the quality of service.
VALUES MQUNSUBSCRIBE(Weather)
Example 2: This example demonstrates a subscriber canceling an interest in

messages containing "Stocks". The subscriber is registered as "PORTFOLIOUPDATES" with policy "BASIC-POLICY".
VALUES MQUNSUBSCRIBE(PORTFOLIO-UPDATES,BASIC-POLICY,Stocks)
Security routines and views

AUTH_GET_INSTANCE_AUTHID - Get the instance owner
authorization ID
The AUTH_GET_INSTANCE_AUTHID scalar function returns the authorization ID
of the instance owner
Syntax
AUTH_GET_INSTANCE_AUTHID (
Authorization
EXECUTE privilege on the AUTH_GET_INSTANCE_AUTHID scalar function.

This function returns a value of type VARCHAR(128) that specifies the
authorization ID of the instance owner.
879
Usage notes
Common configurations have the instance owner account as a member of the
SYSADM group, therefore, before DB2 Version 9.7, applications that are run under
the instance owner account had unlimited authority on the database. In DB2
Version 9.7 and later, a user who holds SYSADM authority no longer has implicit
DBADM authority and as a result applications that are run under the instance
owner account might experience authorization errors, such as SQL1092N,
SQL0551N, and SQL0552N, when performing operations that are no longer within
the scope of SYSADM authority.
The UPGRADE DATABASE command and the RESTORE DATABASE command (for a
previous database) grant DBADM authority to the SYSADM group, however this is
not the case for any new Version 9.7 database.
To obtain a list of the authorities held by the instance owner authorization ID,
follow these steps:
1. Use the SYSPROC.AUTH_GET_INSTANCE_AUTHID() scalar function to
determine the instance owner authorization ID. For example:
db2 "VALUES SYSPROC.AUTH_GET_INSTANCE_AUTHID()"
This command returns.

1
-------------------------------------BOB
2. Get a list of the authorities for this authorization ID. For example:
SELECT * FROM
TABLE (SYSPROC.AUTH_LIST_AUTHORITIES_FOR_AUTHID (BOB, U) ) AS T
ORDER BY AUTHORITY
3. If necessary, grant any missing authorities. For example:

GRANT DBADM ON DATABASE TO USER BOB
Example
The following example shows how to use the DB2 command line processor (CLP)
to obtain the authorization ID of the instance owner:
db2 "values SYSPROC.AUTH_GET_INSTANCE_AUTHID()"
The following is an example of output for this command.

1
-------------------------...------------ZURBIE
AUTH_LIST_AUTHORITIES_FOR_AUTHID
The AUTH_LIST_AUTHORITIES_FOR_AUTHID table function returns all
authorities held by the authorization ID, either found in the database configuration
file or granted to an authorization ID directly or indirectly through a group or a
role.
Syntax
880
AUTH_LIST_AUTHORITIES_FOR_AUTHID (
authid
authidtype

authid
being queried. The authorization ID can be a user, group or a role. If authid is
NULL or an empty string, an empty result table is returned.
authidtype
type being queried. If authidtype does not exist, is NULL or an empty string, an
empty result table is returned. Possible values for authidtype are:
v G: Group
v R: Role
v U: User
Authorization
v DBADM authority
v SQLADM authority

Table 208. The information returned for AUTH_LIST_AUTHORITIES_FOR_AUTHID
Column Name
Data Type
Description
AUTHORITY
VARCHAR(128)
Authority held by the authorization ID
D_USER
CHAR(1)
Authority granted directly to the authid, when the authidtype is a

user (U). If the authidtype is a group (G) or a role (R), then the value
is not applicable ('*').
v N = Not held
v Y= Held
v * = Not applicable
D_GROUP
CHAR(1)
Authority granted directly to the authid when the authidtype is a

group (G), or to the group to which the authid belongs when the
authidtype is a user (U). If the authidtype is a role (R), then the value
is not applicable ('*').
v N = Not held
v Y= Held
881
Table 208. The information returned for AUTH_LIST_AUTHORITIES_FOR_AUTHID (continued)

Column Name
Data Type
Description
D_PUBLIC
CHAR(1)
Authority granted directly to the authid called PUBLIC when the

authidtype is a user (U) or a group (G). If the authidtype is a role (R),
then the value is not applicable ('*').
v N = Not held
v Y= Held
ROLE_USER
CHAR(1)
Authority granted directly to a role granted to the authid, when the

authidtype is a user (U). If the authidtype is a group (G) or a role (R),
then the value is not applicable ('*'). The role could be part of a role
hierarchy.
v N = Not held
v Y= Held
ROLE_GROUP
CHAR(1)
Authority granted directly to a role granted to the authid when the

authidtype is a group (G). If the authidtype is a user (U) or a role (R),
then the value is not applicable ('*'). The role could be part of a role
hierarchy.
v N = Not held
v Y= Held
ROLE_PUBLIC
CHAR(1)
Authority granted directly to a role granted to the authid called

PUBLIC when the authidtype is a user (U) or a group (G). If the
authidtype is a role (R), then the value is not applicable ('*'). The role
could be part of a role hierarchy.
v N = Not held
v Y= Held
D_ROLE
CHAR(1)
Authority granted to a role or to a role granted to the role. If the

authidtype is a user (U) or a group (G), then the value is not
applicable ('*'). The role could be part of a role hierarchy.
v N = Not held
v Y= Held
Example
Consider user ALICE who by default holds BIND, CONNECT, CREATETAB and
IMPLICIT_SCHEMA privileges through special group PUBLIC. ALICE is a member
of a group ADMIN1 who has the following system authorities: SYSADM,
SYSCTRL and SYSMAINT. She is also a member of group ADMIN2 who has
DBADM authority. Also, ALICE has been granted DBADM and SECADM database
authorities. Role R1 was granted to ALICE. LOAD authority was granted to role
R1. Role R2 was granted to group ADMIN1. CREATE_NOT_FENCED_ROUTINE
authority was granted to role R2.
Example 1: Retrieve all authorities user ALICE has granted either directly to her or
indirectly through a group, PUBLIC or a role.
SELECT AUTHORITY, D_USER, D_GROUP, D_PUBLIC, ROLE_USER, ROLE_GROUP, ROLE_PUBLIC, D_ROLE
FROM TABLE (SYSPROC.AUTH_LIST_AUTHORITIES_FOR_AUTHID (ALICE, U) ) AS T
ORDER BY AUTHORITY
882
AUTHORITY
------------------------ACCESSCTRL
BINDADD
CONNECT
CREATE_EXTERNAL_ROUTINE
CREATE_NOT_FENCED_ROUTINE
CREATETAB
DATAACCESS
DBADM
EXPLAIN
IMPLICIT_SCHEMA
LOAD
QUIESCE_CONNECT
SECADM
SQLADM
SYSADM
SYSCTRL
SYSMAINT
SYSMON
WLMADM
D_USER
-----N
N
N
N
N
N
N
Y
N
N
N
N
Y
N
*
*
*
*
N
D_GROUP
------N
N
N
N
N
N
N
Y
N
N
N
N
N
N
Y
Y
Y
N
N
D_PUBLIC
-------N
Y
Y
N
N
Y
N
N
N
Y
N
N
N
N
*
*
*
*
N
ROLE_USER
--------N
N
N
N
N
N
N
N
N
N
Y
N
N
N
*
*
*
*
N
ROLE_GROUP
---------N
N
N
N
Y
N
N
N
N
N
N
N
N
N
*
*
*
*
N
ROLE_PUBLIC
----------N
N
N
N
N
N
N
N
N
N
N
N
N
N
*
*
*
*
N
D_ROLE
-----*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
Example 2: Retrieve all authorities group ADMIN1 has granted either directly to it
or indirectly through PUBLIC or a role.
FROM TABLE (SYSPROC.AUTH_LIST_AUTHORITIES_FOR_AUTHID (ADMIN1, G) ) AS T
ORDER BY AUTHORITY
AUTHORITY
------------------------ACCESSCTRL
BINDADD
CONNECT
CREATETAB
DATAACCESS
DBADM
EXPLAIN
IMPLICIT_SCHEMA
LOAD
QUIESCE_CONNECT
SECADM
SQLADM
SYSADM
SYSCTRL
SYSMAINT
SYSMON
WLMADM
D_USER
-----*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
D_GROUP
------N
N
N
N
N
N
N
N
N
N
N
N
N
N
Y
Y
Y
N
N
D_PUBLIC
-------*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
ROLE_USER
--------*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
ROLE_GROUP
---------N
N
N
N
Y
N
N
N
N
N
N
N
N
N
*
*
*
*
N
ROLE_PUBLIC
----------*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
D_ROLE
-----*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
Example 3: Retrieve all authorities special group PUBLIC has granted either
directly to it or indirectly through a role
FROM TABLE (SYSPROC.AUTH_LIST_AUTHORITIES_FOR_AUTHID (PUBLIC, G) ) AS T
ORDER BY AUTHORITY
1
------------------------ACCESSCTRL
BINDADD
CONNECT
CREATETAB
DATAACCESS
DBADM
EXPLAIN
IMPLICIT_SCHEMA
LOAD
QUIESCE_CONNECT
SECADM
SQLADM
SYSADM
SYSCTRL
D_USER
-----*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
D_GROUP
------*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
D_PUBLIC
-------N
Y
Y
N
N
Y
N
N
N
Y
N
N
N
N
*
*
ROLE_USER
--------*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
ROLE_GROUP
---------*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
ROLE_PUBLIC
----------N
N
N
N
N
N
N
N
N
N
N
N
N
N
*
*
D_ROLE
-----*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
883
SYSMAINT
SYSMON
WLMADM
*
*
*
*
*
*
*
*
N
*
*
*
*
*
*
*
*
N
*
*
*
Example 4: Retrieve all authorities role R1 has granted either directly to it or

indirectly through a role. Consider in this case that role R2 was also granted to role
R1.
FROM TABLE (SYSPROC.AUTH_LIST_AUTHORITIES_FOR_AUTHID (R1, R) ) AS T
ORDER BY AUTHORITY
AUTHORITY
------------------------ACCESSCTRL
BINDADD
CONNECT
CREATETAB
DATAACCESS
DBADM
EXPLAIN
IMPLICIT_SCHEMA
LOAD
QUIESCE_CONNECT
SECADM
SYSADM
SQLADM
SYSCTRL
SYSMAINT
SYSMON
WLMADM
D_USER
-----*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
D_GROUP
------*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
D_PUBLIC
-------*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
ROLE_USER
--------*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
ROLE_GROUP
---------*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
ROLE_PUBLIC
----------*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
D_ROLE
-----N
N
N
N
Y
N
N
N
N
N
Y
N
N
*
N
*
*
*
N
Usage notes
The output of AUTH_LIST_AUTHORITIES_FOR_AUTHID table function depends
on the authidtype. For example, for an authidtype of USER, it returns all authorities
that authid holds through any means:
v granted directly to the authid
v granted to any group (or roles granted to the group) to which authid belongs
v granted to any role (or roles granted to the role) granted to authid
v granted to PUBLIC (or roles granted to PUBLIC)
AUTH_LIST_GROUPS_FOR_AUTHID table function - Retrieve

group membership list for a given authorization ID
The AUTH_LIST_GROUPS_FOR_AUTHID table function returns the list of groups
of which the given authorization ID is a member.
Syntax
AUTH_LIST_GROUPS_FOR_AUTHID (
authid

authid
being queried. The authorization ID can only represent a user. If authid does
not exist, is NULL or empty string, an empty result table is returned.
884
Authorization
v DBADM authority
v SQLADM authority

Example
Retrieve all groups that AMY belongs to.
SELECT * FROM TABLE (SYSPROC.AUTH_LIST_GROUPS_FOR_AUTHID(AMY)) AS T

GROUP
-------------------------...------------BUILD
PDXDB2
Usage notes
Group information returned might be different than expected for the following
reasons:
v In a Windows Active Directory environment, the database manager:
supports one level of group nesting within a local group, except the nesting
of a domain local group within a local group. For example, if authid belongs
to the global group G1, and G1 belongs to the local group L1, the local group
L1 is returned as the group for authid. However, if authid belongs to the
domain local group DL1, and DL1 belongs to the local group L1, no group
information is returned for authid.
does not support any nesting of global groups. For example, if authid belongs
to the global G2, and G2 belongs to the global G3, only G2 is returned as the
group for authid.
v The registry variable DB2_GRP_LOOKUP specifies which Windows security
mechanism is used to enumerate the groups to which a user belongs.
v For an authorization ID that belongs to a particular domain, if the domain is not
specified as part of the authid, and both a local and domain authid exist with the
same name, the groups for the local authorization ID is returned.
v If the call to AUTH_LIST_GROUPS_FOR_AUTHID is for the same authid as the
connected user, then it will return the groups for the connected user. For
example, If AMY exists as a local user and as a domain user and the domain
user AMY has connected to the database, then
AUTH_LIST_GROUPS_FOR_AUTHID will return the groups to which the
domain AMY belongs to.
885
Table 209. Information returned by the AUTH_LIST_GROUPS_FOR_AUTHID table function
Column name
Data type
Description
GROUP
VARCHAR(128)
The group to which the

authorization ID belongs.
AUTH_LIST_ROLES_FOR_AUTHID function - Returns the list of

roles
The AUTH_LIST_ROLES_FOR_AUTHID function returns the list of roles in which
the given authorization ID is a member.
Syntax
AUTH_LIST_ROLES_FOR_AUTHID (
authid
authidtype

authid
being queried. The authorization ID can be a user, group or a role. If authid is
NULL or an empty string, an empty result table is returned.
authidtype
type being queried. If authidtype does not exist, is NULL or an empty string, an
empty result table is returned. Possible values for authidtype are:
v G: Group
v R: Role
v U: User
Authorization
v DBADM authority
v SQLADM authority

Table 210. The result sets for AUTH_LIST_ROLES_FOR_AUTHID
Column Name
Data Type
Description
GRANTOR
VARCHAR(128)
Grantor of the role.
886
Table 210. The result sets for AUTH_LIST_ROLES_FOR_AUTHID (continued)

Column Name
Data Type
Description
GRANTORTYPE
CHAR(1)
Type of grantor:
v U = Grantor is an individual user
GRANTEE
VARCHAR(128)
User granted the role.
GRANTEETYPE
CHAR(1)
Type of grantee:
v G = Grantee is a group
v R= Grantee is a role
v U= Grantee is a user
ROLENAME
VARCHAR(128)
Name of the role granted to the authorization ID directly or

indirectly through a group or another role.
CREATE_TIME
TIMESTAMP
Time when role was created.
ADMIN
CHAR(1)
Privilege to grant the role to, revoke the role from, or to

comment on a role:
v N = Not held
v Y= Held
Example
Consider granting role INTERN to role DOCTOR and role DOCTOR to role
SPECIALIST, then grant role SPECIALIST to user ALICE. ALICE belongs to group
HOSPITAL and role EMPLOYEE is granted to group HOSPITAL. ALICE also
belongs to special group PUBLIC and role PATIENTS is granted to PUBLIC.
Example 1: Retrieve all roles granted to user ALICE.
SELECT GRANTOR, GRANTORTYPE, GRANTEE, GRANTEETYPE, ROLENAME,
CREATE_TIME, ADMIN
FROM TABLE (SYSPROC.AUTH_LIST_ROLES_FOR_AUTHID (ALICE, U) ) AS T

GRANTOR
------ZURBIE
ZURBIE
ZURBIE
ZURBIE
ZURBIE
GRANTORTYPE
----------U
U
U
U
U
GRANTEE
------DOCTOR
SPECIALIST
ALICE
HOSPITAL
PUBLIC
GRANTEETYPE
----------R
R
U
G
G
ROLENAME
-------INTERN
DOCTOR
SPECIALIST
EMPLOYEE
PATIENTS
CREATE_TIME
-------------------------2006-08-01-15.09.58.537399
2006-08-01-15.10.04.540660
2006-08-01-15.10.08.776218
2006-08-01-15.10.14.277576
2006-08-01-15.10.18.878609
ADMIN
----N
N
N
N
N
Example 2: Retrieve all roles granted to group HOSPITAL.

CREATE_TIME, ADMIN
FROM TABLE (SYSPROC.AUTH_LIST_ROLES_FOR_AUTHID (HOSPITAL, G) ) AS T

GRANTOR GRANTORTYPE GRANTEE
------- ----------- ------ZURBIE U
HOSPITAL
GRANTEETYPE ROLENAME
----------- -------G
EMPLOYEE
CREATE_TIME
ADMIN
-------------------------- ----2006-08-01-15.10.14.277576 N
Example 3: Retrieve all roles granted to role SPECIALIST.

CREATE_TIME, ADMIN
FROM TABLE (SYSPROC.AUTH_LIST_ROLES_FOR_AUTHID (SPECIALIST, R) ) AS T
887

GRANTOR
------ZURBIE
ZURBIE
2
GRANTORTYPE
----------U
U
GRANTEE
------DOCTOR
SPECIALIST
GRANTEETYPE
----------R
R
ROLENAME
-------INTERN
DOCTOR
CREATE_TIME
-------------------------2006-08-01-15.09.58.537399
2006-08-01-15.10.04.540660
ADMIN
----N
N
record(s) selected.
Example 4: Retrieve all roles granted to group PUBLIC

CREATE_TIME, ADMIN
FROM TABLE (SYSPROC.AUTH_LIST_ROLES_FOR_AUTHID (PUBLIC, G) ) AS T

GRANTOR GRANTORTYPE GRANTEE
------- ----------- ------ZURBIE U
PUBLIC
GRANTEETYPE ROLENAME
----------- -------G
PATIENTS
CREATE_TIME
ADMIN
-------------------------- ----2006-08-01-15.10.18.878609 N
Usage notes
The output of AUTH_LIST_ROLES_FOR_AUTHID table function depends on the
AUTHIDTYPE:
v For a user it returns the roles granted to the user directly or indirectly through
another roles, groups that the user belongs to (or PUBLIC).
v For a group it returns the roles granted to the group, directly or indirectly
through another roles.
v For a role it returns the roles granted to the role, directly or indirectly through
another roles.
AUTHORIZATIONIDS administrative view - Retrieve authorization

IDs and types
The AUTHORIZATIONIDS administrative view returns a list of all the users, roles,
and groups that exist in the database catalog of the currently connected server as a
result of GRANT statements.
Each authorization ID and associated type that is returned by the view has at least
one privilege, authority, or role membership. The users that are currently members
of any of the groups are not included in the result.
Authorization
v SELECT privilege on the AUTHORIZATIONIDS administrative view
v CONTROL privilege on the AUTHORIZATIONIDS administrative view
v DBADM authority
v SQLADM authority

888
Example
Retrieve all authorization IDs that have been granted privileges or authorities,
along with their types.
SELECT * FROM SYSIBMADM.AUTHORIZATIONIDS

AUTHID
-------------------------...------PUBLIC
JESSICAE
DOCTOR
AUTHIDTYPE
---------G
U
R
Table 211. Information returned by the AUTHORIZATIONIDS administrative view
Column name
Data type
Description
AUTHID
VARCHAR(128)
Authorization ID that has

been explicitly granted
privileges or authorities.
AUTHIDTYPE
CHAR(1)
Authorization ID type:
v U: user
v R: role
v G: group
OBJECTOWNERS administrative view - Retrieve object

ownership information
The OBJECTOWNERS administrative view returns all object ownership
information for every authorization ID of type USER that owns an object and that
is defined in the system catalogs from the currently connected database.
Authorization
v SELECT privilege on the OBJECTOWNERS administrative view
v CONTROL privilege on the OBJECTOWNERS administrative view
v DBADM authority
v SQLADM authority

Example
Retrieve all object ownership information for object schema 'THERESAX'.
889
SELECT SUBSTR(OWNER,1,10) AS OWNER, OWNERTYPE,

SUBSTR(OBJECTNAME,1,30) AS OBJECTNAME,
SUBSTR(OBJECTSCHEMA,1,10) AS OBJECTSCHEMA, OBJECTTYPE
FROM SYSIBMADM.OBJECTOWNERS WHERE OBJECTSCHEMA=THERESAX

OWNER
---------THERESAX
THERESAX
THERESAX
THERESAX
THERESAX
THERESAX
...
THERESAX
OWNERTYPE
--------U
U
U
U
U
U
OBJECTNAME
-----------------...
MIN_SALARY
POLICY_IR
CUSTOMER
DB2DETAILDEADLOCK
SAMPSEQUENCE
SQLE0F00
OBJECTSCHEMA
-----------THERESAX
SYSTOOLS
THERESAX
THERESAX
NULLID
OBJECTTYPE
---------------TRIGGER
TRIGGER
XML SCHEMA
EVENTMONITORS
SEQUENCE
PACKAGE
HI_OBJ_UNIQ
SYSTOOLS
TABLE CONSTRAINT
Table 212. Information returned by the OBJECTOWNERS administrative view
Column name
Data type
Description
OWNER
VARCHAR(128)
Authorization ID that owns

this object.
OWNERTYPE
VARCHAR(1)
v U: user
v S: system
OBJECTNAME
VARCHAR(128)

monitor element
OBJECTSCHEMA
VARCHAR(128)
OBJECTTYPE
VARCHAR(24)
Database object type.
PRIVILEGES administrative view - Retrieve privilege information

The PRIVILEGES administrative view returns all explicit privileges for all
authorization IDs defined in the system catalogs from the currently connected
database.
Authorization
v
v
v
v
v
SELECT privilege on the PRIVILEGES administrative view

CONTROL privilege on the PRIVILEGES administrative view
DBADM authority
SQLADM authority

890
Example
Retrieve the privilege granted along with the object name, schema and type, for all
authorization IDs.
SELECT AUTHID, PRIVILEGE, OBJECTNAME, OBJECTSCHEMA, OBJECTTYPE
FROM SYSIBMADM.PRIVILEGES

AUTHID
--------...JESSICAE
PUBLIC
JESSICAE
PUBLIC
DOCTOR
...
PUBLIC
JESSICAE
PUBLIC
JESSICAE
PUBLIC
...
PUBLIC
PUBLIC
PUBLIC
PUBLIC
...
SYSTEM
PUBLIC
PUBLIC
PUBLIC
...
PRIVILEGE
----------EXECUTE
EXECUTE
EXECUTE
EXECUTE
EXECUTE
OBJECTNAME
-------------------...SQLE0F00
SYSSH201
SYSSH202
SYSSH202
PKG0123
OBJECTSCHEMA
------------...NULLID
NULLID
NULLID
NULLID
NULLID
OBJECTTYPE
----------...PACKAGE
PACKAGE
PACKAGE
PACKAGE
PACKAGE
EXECUTE
EXECUTE
EXECUTE
EXECUTE
EXECUTE
SQL051109185227800
SQL051109185227801
SQL051109185227801
SQL051109185227838
SQL051109185227838
SYSPROC
SYSPROC
SYSPROC
SYSPROC
SYSPROC
FUNCTION
FUNCTION
FUNCTION
FUNCTION
FUNCTION
EXECUTE
EXECUTE
EXECUTE
EXECUTE
LIST_SRVR_TYPES
LIST_SRVR_VERSIONS
LIST_WRAP_OPTIONS
LIST_SRVR_OPTIONS
SYSPROC
SYSPROC
SYSPROC
SYSPROC
PROCEDURE
PROCEDURE
PROCEDURE
PROCEDURE
POLICY_UNQ
SYSTOOLS
NULLID
SYSSTAT
SYSSTAT
INDEX
SCHEMA
VIEW
VIEW
CREATEIN
UPDATE
UPDATE
COLUMNS
COLGROUPS
Table 213. Information returned by the PRIVILEGES administrative view
Column name
Data type
Description
AUTHID
VARCHAR(128)
Authorization ID that has

been explicitly granted this
privilege.
AUTHIDTYPE
CHAR(1)
v U: user
v R: role
v G: group
PRIVILEGE
VARCHAR(11)
Privilege that has been

explicitly granted to this
authorization ID.
GRANTABLE
VARCHAR(1)
Indicates if the privilege is

grantable:
v Y: Grantable
v N: Not grantable
OBJECTNAME
VARCHAR(128)

monitor element
OBJECTSCHEMA
VARCHAR(128)
OBJECTTYPE
VARCHAR(24)
Database object type.
891
Snapshot routines and views

QUERY_PREP_COST administrative view - Retrieve statement
prepare time information
The QUERY_PREP_COST administrative view returns a list of statements with
information about the time required to prepare the statement.
Authorization
v SELECT privilege on the QUERY_PREP_COST administrative view
v CONTROL privilege on the QUERY_PREP_COST administrative view
v DBADM authority
v SQLADM authority

Example
Retrieve a report on the queries with the highest percentage of time spent on
preparing.
SELECT NUM_EXECUTIONS, AVERAGE_EXECUTION_TIME_S, PREP_TIME_PERCENT,
SUBSTR(STMT_TEXT, 1, 30) AS STMT_TEXT, DBPARTITIONNUM
FROM SYSIBMADM.QUERY_PREP_COST ORDER BY PREP_TIME_PERCENT

NUM_EXECUTIONS
AVERAGE_EXECUTION_TIME_S ...
--------------...- ------------------------ ...
1
25 ...

... PREP_TIME_PERCENT STMT_TEXT
DBPARTITIONNUM
... ----------------- ------------------------------ -------------...
0.0 select * from dbuser.employee
0
Usage notes
When selecting from the view, an order by clause can be used to identify queries
with the highest prep cost. You can examine this view to see how frequently a
query is run as well as the average execution time for each of these queries. If the
time it takes to compile and optimize a query is almost as long as it takes for the
query to execute, you might want to look at the optimization class that you are
using. Lowering the optimization class might make the query complete
optimization more rapidly and therefore return a result sooner. However, if a
query takes a significant amount of time to prepare yet is executed thousands of
times (without being prepared again) then the optimization class might not be an
issue.
892
Table 214. Information returned by the QUERY_PREP_COST administrative view
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
The date and time the report was

generated.
NUM_EXECUTIONS
BIGINT
num_executions - Statement
executions
AVERAGE_EXECUTION_TIME_S
BIGINT
Average execution time (in seconds).
AVERAGE_EXECUTION_TIME
_MS
BIGINT
Average execution time (fractional,

in microseconds).
PREP_TIME_MS
BIGINT
prep_time_worst - Statement worst

preparation time (in milliseconds).
PREP_TIME_PERCENT
DECIMAL(8,2)
Percent of execution time spent on

preparation. Calculated as prep time
divided by total execution time.
STMT_TEXT
CLOB(2 M)
DBPARTITIONNUM
SMALLINT

MEMBER
SMALLINT

monitor element
SNAPDYN_SQL administrative view and SNAP_GET_DYN_SQL

table function - Retrieve dynsql logical group snapshot
information
The SNAPDYN_SQL administrative view and the SNAP_GET_DYN_SQL table
function return snapshot information from the dynsql logical data group.
The MON_GET_PKG_CACHE_STMT table function - Get SQL statement activity
metrics in the package cache on page 632 returns a point-in-time view of both
static and dynamic SQL statements in the database package cache. If you use this
table function, you can take advantage of the monitoring infrastructure introduced
in Version 9.7.
v SNAPDYN_SQL administrative view
v SNAP_GET_DYN_SQL table function on page 895
SNAPDYN_SQL administrative view

This administrative view allows you to retrieve dynsql logical group snapshot
information for the currently connected database.
This view returns information equivalent to the GET SNAPSHOT FOR DYNAMIC SQL ON
database-alias CLP command.
returned.
893
Authorization
One of the following authorizations is required to use the view:
v SELECT privilege on the SNAPDYN_SQL administrative view
v CONTROL privilege on the SNAPDYN_SQL administrative view
v DBADM authority
v SQLADM authority
One of the following authorizations is required to use the table function:
v EXECUTE privilege on the SNAP_GET_DYN_SQL table function
v DBADM authority
v SQLADM authority
In addition, to access snapshot monitor data, one of the following authorities is
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a list of dynamic SQL run on the currently connected database, ordered
by the number of rows read.
SELECT PREP_TIME_WORST, NUM_COMPILATIONS, SUBSTR(STMT_TEXT, 1, 60)
AS STMT_TEXT, DBPARTITIONNUM
FROM SYSIBMADM.SNAPDYN_SQL ORDER BY ROWS_READ

PREP_TIME_WORST
NUM_COMPILATIONS
-------------------- -------------------98
1
9
1
0
0
0
1
0
1
0
1
0
1
0
1
40
1
...
...
...
...
...
...
...
...
...
...
...

...
...
...
...
894
STMT_TEXT
-----------------------------------------------------------select prep_time_worst, num_compilations, substr(stmt_text,
select * from dbuser.employee
...
...
...
...
...
...
...
...
...
...
...
SET CURRENT LOCALE LC_CTYPE = en_US

select prep_time_worst, num_compilations, substr(stmt_text,
insert into dbuser.employee values(1)
...
...
...
...
...
...
...

... DBPARTITIONNUM
... -------------...
0
...
0
...
0
...
2
...
1
...
2
...
2
...
1
...
0

The SNAP_GET_DYN_SQL table function returns the same information as the
SNAPDYN_SQL administrative view, but allows you to retrieve the information for
a specific database on a specific database member, aggregate of all database
members or all database members.
This table function returns information equivalent to the GET SNAPSHOT FOR
DYNAMIC SQL ON database-alias CLP command.
returned.
Syntax
SNAP_GET_DYN_SQL (
dbname
, member

dbname
name in the same instance as the currently connected database. Specify a
database name that has a directory entry type of either "Indirect" or "Home", as
returned by the LIST DATABASE DIRECTORY command. Specify NULL or empty
string to take the snapshot from the currently connected database.
member
member number. Specify -1 for the current member, or -2 for an aggregate of
all active members. If dbname is not set to NULL and member is set to NULL, -1 is
set implicitly for member. If this input option is not used, that is, only dbname is
provided, data is returned from members where the database is active.
If both dbname and member are set to NULL, an attempt is made to read data from
the file created by SNAP_WRITE_FILE procedure. Note that this file could have
895
been created at any time, which means that the data might not be current. If a file
with the corresponding snapshot API request type does not exist, then the
SNAP_GET_DYN_SQL table function takes a snapshot for the currently connected
database and database member number.
Important: The SYSPROC.SNAP_WRITE_FILE procedure is deprecated in Version
10.5 and might be removed in a future release. For more information, see
SNAP_WRITE_FILE procedure in Administrative Routines and Views.
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
AS STMT_TEXT FROM TABLE(SNAP_GET_DYN_SQL(,-1)) as T
ORDER BY ROWS_READ

PREP_TIME_WORST
NUM_COMPILATIONS
...
-------------------- ---------------------...
0
0 ...
49
1 ...
0
0 ...
46
1 ...
0
0 ...
0
0 ...
0
0 ...
29
1 ...
0
0 ...
0
0 ...
10
1 ...
0
0 ...
4
0 ...
53
0 ...
0
0 ...
6
1 ...
334
0 ...
0
0 ...
5
0 ...
10
0 ...
896
599
15
7
0 ...
1 ...
0 ...

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
STMT_TEXT
----------------------------------------------------------SET :HV00017 :HI00017 = RPAD(VARCHAR(:HV00035 :HI00035 ),
SELECT COLNAME, TYPENAME FROM SYSCAT.COLUMNS WHERE TABNAME=
DECLARE RES CURSOR WITH RETURN TO CALLER FOR SELECT R.TEXT F
SELECT PREP_TIME_WORST, NUM_COMPILATIONS, SUBSTR(STMT_TEXT,
VALUES (:HV00026 :HI00026 + 1, :HV00024 :HI00024 + 1) IN
VALUES (1) INTO :HV00035 :HI00035
SELECT TRIGNAME FROM SYSCAT.TRIGGERS WHERE TABNAME=POLICY
VALUES (:HV00024 :HI00024 +1, :HV00022 :HI00022 +1) INTO :
VALUES (1, CARDINALITY(CAST(:HV00040 :HI00040 AS "SYSIBMAD
CALL SYSPROC.SYSINSTALLOBJECTS(POLICY,V,,)
SET :HV00017 :HI00017 = RPAD(VARCHAR(:HV00035 :HI00035 ),
drop event monitor act
SELECT TABSCHEMA, TABNAME, TYPE, STATUS, TBSPACEID, PROPERTY
CALL SAVE_EXEC_INFO (CAST(:HV00040 :HI00040 AS "SYSIBMADM"
SET CURRENT LOCK TIMEOUT 5
SELECT TABNAME FROM SYSCAT.PERIODS WHERE PERIODNAME = SYSTE
SELECT ARRAY_AGG(P.EXECUTABLE_ID ORDER BY M.IO_WAIT_TIME DES
SET CURRENT ISOLATION RESET
CALL monreport.pkgcache()
SELECT A.SPECIFICNAME FROM SYSCAT.ROUTINES A WHERE (A.FENCED
SELECT POLICY FROM SYSTOOLS.POLICY WHERE MED=DB2CommonMED
VALUES 0
After running a workload, user can use the following query with the table
function.
SELECT STATS_FABRICATE_TIME,SYNC_RUNSTATS_TIME
FROM TABLE (SNAP_GET_DYN_SQL(mytestdb, -1))
AS SNAPDB
STATS_FABRICATE_TIME
SYNC_RUNSTATS_TIME
---------------------- -----------------2
12
1
30
For the view based on this table function:

FROM SYSIBMADM.SNAPDYN_SQL
SYNC_RUNSTATS_TIME
---------------------- -----------------5
10
3
20
897
Table 215. Information returned by the SNAPDYN_SQL administrative view and the SNAP_GET_DYN_SQL table
function
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
The date and time that the snapshot was

taken.
NUM_EXECUTIONS
BIGINT
NUM_COMPILATIONS
BIGINT
num_compilations - Statement compilations
PREP_TIME_WORST
BIGINT

preparation time
PREP_TIME_BEST
BIGINT
prep_time_best - Statement best preparation

time
INT_ROWS_DELETED
BIGINT
int_rows_deleted - Internal rows deleted
INT_ROWS_INSERTED
BIGINT
int_rows_inserted - Internal rows inserted
INT_ROWS_UPDATED
BIGINT
int_rows_updated - Internal rows updated
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
rows_written - Rows written
STMT_SORTS
BIGINT
stmt_sorts - Statement sorts
SORT_OVERFLOWS
BIGINT
TOTAL_SORT_TIME
BIGINT
total_sort_time - Total sort time
POOL_DATA_L_READS
BIGINT

reads
POOL_DATA_P_READS
BIGINT

physical reads
BIGINT

BIGINT

POOL_INDEX_L_READS
BIGINT

logical reads
POOL_INDEX_P_READS
BIGINT

physical reads
BIGINT

BIGINT

POOL_XDA_L_READS
BIGINT

Logical Reads
POOL_XDA_P_READS
BIGINT
pool_xda_p_reads - Buffer Pool XDA Data

Physical Reads
BIGINT
pool_temp_xda_l_reads - Buffer Pool

Temporary XDA Data Logical Reads
BIGINT
pool_temp_xda_p_reads - Buffer Pool

Temporary XDA Data Physical Reads
monitor element
898
element
Column name
Data type
TOTAL_EXEC_TIME
BIGINT
total_exec_time - Elapsed statement

execution time (in seconds)*
TOTAL_EXEC_TIME_MS
BIGINT

execution time (fractional, in microseconds)*
TOTAL_USR_CPU_TIME
BIGINT
total_usr_cpu_time - Total user CPU for a

statement (in seconds)*
TOTAL_USR_CPU_TIME_MS
BIGINT

statement (fractional, in microseconds)*
TOTAL_SYS_CPU_TIME
BIGINT
total_sys_cpu_time - Total system CPU for a

TOTAL_SYS_CPU_TIME_MS
BIGINT

STMT_TEXT
CLOB(2 M)
DBPARTITIONNUM
SMALLINT

monitor element
BIGINT
The total time (in milliseconds) spent by

system to create needed statistics without
table or index scan during query compilation
for a dynamic statement.
SYNC_RUNSTATS_TIME
BIGINT
The total time (in milliseconds) spent on

synchronous statistics-collect activities during
query compilation for a dynamic statement.
MEMBER
SMALLINT
* To calculate the total time spent for the monitor element that this column is based on, you must add the full
seconds reported in the column for this monitor element that ends with _S to the fractional seconds reported in the
column for this monitor element that ends with _MS, using the following formula: (monitor-element-name_S
1,000,000 + monitor-element-name_MS) 1,000,000. For example, (ELAPSED_EXEC_TIME_S 1,000,000 +
ELAPSED_EXEC_TIME_MS) 1,000,000.

SNAP_GET_SUBSECTION table function - Retrieve subsection
logical monitor group snapshot information
The SNAPSUBSECTION administrative view and the SNAP_GET_SUBSECTION
table function return information about application subsections, namely the
subsection logical monitor grouping.
v SNAPSUBSECTION administrative view
v SNAP_GET_SUBSECTION table function on page 901
SNAPSUBSECTION administrative view

This administrative view allows you to retrieve subsection logical monitor group
snapshot information for the currently connected database.
Used with the MON_CURRENT_SQL administrative view and the
MON_GET_AGENT, MON_GET_CONNECTION, MON_GET_MEMORY_POOL,
899
and MON_GET_MEMORY_SET table functions, the SNAPSUBSECTION

administrative view provides information equivalent to the GET SNAPSHOT FOR
APPLICATIONS on database-alias CLP command, but retrieves data from all
database members.
returned.
Authorization
v SELECT privilege on the SNAPSUBSECTION administrative view
v CONTROL privilege on the SNAPSUBSECTION administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_SUBSECTION table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Get status for subsections executing on all database members.
SELECT DB_NAME, STMT_TEXT, SS_STATUS, DBPARTITIONNUM
FROM SYSIBMADM.SNAPSUBSECTION
ORDER BY DB_NAME, SS_STATUS, DBPARTITIONNUM

DB_NAME
-------...SAMPLE
SAMPLE
900
STMT_TEXT
----------------------...select * from EMPLOYEE
select * from EMPLOYEE
SS_STATUS
DBPARTITIONNUM
---------...- -------------EXEC
0
EXEC
1

The SNAP_GET_SUBSECTION table function returns the same information as the
SNAPSUBSECTION administrative view, but allows you to retrieve the
information for a specific database on a specific database member, aggregate of all
database members or all database members.
returned.
Used with the SNAP_GET_AGENT, SNAP_GET_AGENT_MEMORY_POOL,
SNAP_GET_APPL, SNAP_GET_APPL_INFO and SNAP_GET_STMT table
functions, the SNAP_GET_SUBSECTION table function provides information
equivalent to the GET SNAPSHOT FOR ALL APPLICATIONS CLP command, but retrieves
data from all database members.
Syntax
SNAP_GET_SUBSECTION (
dbname
, member

dbname
returned by the LIST DATABASE DIRECTORY command. Specify an empty string
to take the snapshot from the currently connected database. Specify a NULL
value to take the snapshot from all databases within the same instance as the
member
member number. Specify -1 for the current database member, or -2 for an
aggregate of all active database members. If dbname is not set to NULL and
member is set to NULL, -1 is set implicitly for member. If this input option is not
used, that is, only dbname is provided, data is returned from all active database
members. An active database member is a member where the database is
available for connection and use by applications.
SNAP_GET_SUBSECTION table function takes a snapshot for the currently
connected database and database member number.
Authorization
901

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
FROM TABLE(SYSPROC.SNAP_GET_SUBSECTION( , 0 )) as T

DB_NAME
-------...SAMPLE
SAMPLE
STMT_TEXT
SS_STATUS
DBPARTITIONNUM
---------...- -------------EXEC
0
EXEC
1
Table 216. Information returned by the SNAPSUBSECTION administrative view and the
902
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
The date and time that the

snapshot was taken.
DB_NAME
VARCHAR(128)
STMT_TEXT
CLOB(16 M)
SS_EXEC_TIME
BIGINT
ss_exec_time - Subsection
execution elapsed time
TQ_TOT_SEND_SPILLS
BIGINT
tq_tot_send_spills - Total number

of table queue buffers overflowed
TQ_CUR_SEND_SPILLS
BIGINT
tq_cur_send_spills Currentnumber of table queue

buffers overflowed
TQ_MAX_SEND_SPILLS
BIGINT
tq_max_send_spills - Maximum
number of table queue buffers
overflows
TQ_ROWS_READ
BIGINT
tq_rows_read - Number of rows

read from table queues
TQ_ROWS_WRITTEN
BIGINT
tq_rows_written - Number of rows

written to table queues
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
SNAP_GET_SUBSECTION table function (continued)
monitor element
Column name
Data type
SS_USR_CPU_TIME_S
BIGINT
ss_usr_cpu_time - User CPU time

used by subsection (in seconds)*
SS_USR_CPU_TIME_MS
BIGINT

used by subsection (fractional, in
microseconds)*
SS_SYS_CPU_TIME_S
BIGINT
ss_sys_cpu_time - System CPU

time used by subsection (in
seconds)*
SS_SYS_CPU_TIME_MS
BIGINT

time used by subsection (fractional,
in microseconds)*
SS_NUMBER
INTEGER
ss_number - Subsection number
SS_STATUS
VARCHAR(20)
ss_status - Subsection status. This

interface returns a text identifier
based on defines in sqlmon.h and
is one of:
v EXEC
v TQ_WAIT_TO_RCV
v TQ_WAIT_TO_SEND
v COMPLETED
SS_NODE_NUMBER
SMALLINT
ss_node_number - Subsection node

number
TQ_NODE_WAITED_FOR
SMALLINT
tq_node_waited_for - Waited for

node on a table queue
TQ_WAIT_FOR_ANY
INTEGER
tq_wait_for_any - Waiting for any

node to send on a table queue
TQ_ID_WAITING_ON
INTEGER
tq_id_waiting_on - Waited on node

on a table queue
DBPARTITIONNUM
SMALLINT
partition number monitor element
MEMBER
SMALLINT

monitor element
* To calculate the total time spent for the monitor element that this column is based on,
you must add the full seconds reported in the column for this monitor element that ends
with _S to the fractional seconds reported in the column for this monitor element that ends
with _MS, using the following formula: (monitor-element-name_S 1,000,000 +
monitor-element-name_MS) 1,000,000. For example, (ELAPSED_EXEC_TIME_S 1,000,000
+ ELAPSED_EXEC_TIME_MS) 1,000,000.
SNAPSWITCHES administrative view and SNAP_GET_SWITCHES

table function - Retrieve database snapshot switch state
information
The SNAPSWITCHES administrative view and the SNAP_GET_SWITCHES table
function return information about the database snapshot switch state.
903
v SNAPSWITCHES administrative view

v SNAP_GET_SWITCHES table function on page 905
SNAPSWITCHES administrative view

This view provides the data equivalent to the GET DBM MONITOR SWITCHES CLP
command.
returned.
Authorization
v SELECT privilege on the SNAPSWITCHES administrative view
v CONTROL privilege on the SNAPSWITCHES administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_SWITCHES table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve DBM monitor switches state information for all database members.
SELECT UOW_SW_STATE, STATEMENT_SW_STATE, TABLE_SW_STATE, BUFFPOOL_SW_STATE,
LOCK_SW_STATE, SORT_SW_STATE, TIMESTAMP_SW_STATE,
DBPARTITIONNUM FROM SYSIBMADM.SNAPSWITCHES

UOW_SW_STATE STATEMENT_SW_STATE TABLE_SW_STATE BUFFPOOL_SW_STATE ...
------------ ------------------ -------------- ----------------- ...
0
0
0
0 ...
904
0
0
0
0
0
0
0 ...
0 ...
...
3 record selected.

... LOCK_SW_STATE SORT_SW_STATE TIMESTAMP_SW_STATE DBPARTITIONNUM
... ------------- ------------- ------------------ -------------...
1
0
1
0
...
1
0
1
1
...
1
0
1
2

The SNAP_GET_SWITCHES table function returns the same information as the
SNAPSWITCHES administrative view, but allows you to retrieve the information
for a specific database member, aggregate of all database members or all database
members.
This table function provides the data equivalent to the GET DBM MONITOR SWITCHES
CLP command.
returned.
Syntax
SNAP_GET_SWITCHES (
member

member
aggregate of all active database members. If this input option is not used, data
will be returned from all active database members. An active database member
is a member where the database is available for connection and use by
applications.
If member is set to NULL, an attempt is made to read data from the file created by
SNAP_WRITE_FILE procedure. Note that this file could have been created at any
time, which means that the data might not be current. If a file with the
corresponding snapshot API request type does not exist, then the
SNAP_GET_SWITCHES table function takes a snapshot for the currently connected
Authorization
905

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Examples
Retrieve DBM monitor switches state information for the current database member.
SELECT UOW_SW_STATE, STATEMENT_SW_STATE, TABLE_SW_STATE,
BUFFPOOL_SW_STATE,LOCK_SW_STATE, SORT_SW_STATE, TIMESTAMP_SW_STATE
FROM TABLE(SNAP_GET_SWITCHES(-1)) AS T

UOW_SW_STATE STATEMENT_SW_STATE TABLE_SW_STATE...
------------ ------------------ --------------...
1
1
1...
...
...

... BUFFPOOL_SW_STATE LOCK_SW_STATE SORT_SW_STATE TIMESTAMP_SW_STATE
... ----------------- ------------- ------------- -----------------...
1
1
0
1
Table 217. Information returned by the SNAPSWITCHES administrative view and the
906
Column name
Data type
Description
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
UOW_SW_STATE
SMALLINT
State of the unit of work monitor

recording switch (0 or 1).
UOW_SW_TIME
TIMESTAMP
If the unit of work monitor

recording switch is on, the date
and time that this switch was
turned on.
STATEMENT_SW_STATE
SMALLINT
State of the SQL statement monitor

STATEMENT_SW_TIME
TIMESTAMP
If the SQL statement monitor

turned on.
TABLE_SW_STATE
SMALLINT
State of the table activity monitor

SNAP_GET_SWITCHES table function (continued)
Column name
Data type
Description
TABLE_SW_TIME
TIMESTAMP
If the table activity monitor

turned on.
BUFFPOOL_SW_STATE
SMALLINT
State of the buffer pool activity

monitor recording switch (0 or 1).
BUFFPOOL_SW_TIME
TIMESTAMP
If the buffer pool activity monitor

turned on.
LOCK_SW_STATE
SMALLINT
State of the lock monitor recording

switch (0 or 1).
LOCK_SW_TIME
TIMESTAMP
If the lock monitor recording

switch is on, the date and time that
this switch was turned on.
SORT_SW_STATE
SMALLINT
State of the sorting monitor

SORT_SW_TIME
TIMESTAMP
If the sorting monitor recording

TIMESTAMP_SW_STATE
SMALLINT
State of the timestamp monitor

recording switch (0 or 1)
TIMESTAMP_SW_TIME
TIMESTAMP
If the timestamp monitor recording

DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

SNAP_GET_TAB_REORG table function - Retrieve table
reorganization snapshot information
The SNAPTAB_REORG administrative view and the SNAP_GET_TAB_REORG
table function return table reorganization information.
If no tables have been reorganized, 0 rows are returned. When a data partitioned
table is reorganized, one record for each data partition is returned. If only a
specific data partition of a data partitioned table is reorganized, only a record for
the partition is returned.
v SNAPTAB_REORG administrative view on page 908
v SNAP_GET_TAB_REORG table function on page 909
907
SNAPTAB_REORG administrative view

This administrative view allows you to retrieve table reorganization snapshot
Used with the SNAPTAB administrative view, the SNAPTAB_REORG
administrative view provides the data equivalent to the GET SNAPSHOT FOR TABLES
ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPTAB_REORG administrative view
v CONTROL privilege on the SNAPTAB_REORG administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_TAB_REORG table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Select details on reorganization operations for all database members on the
SELECT SUBSTR(TABNAME, 1, 15) AS TAB_NAME, SUBSTR(TABSCHEMA, 1, 15)
AS TAB_SCHEMA, REORG_PHASE, SUBSTR(REORG_TYPE, 1, 20) AS REORG_TYPE,
REORG_STATUS, REORG_COMPLETION, DBPARTITIONNUM
FROM SYSIBMADM.SNAPTAB_REORG ORDER BY DBPARTITIONNUM
908
TAB_NAME
--------...EMPLOYEE
EMPLOYEE
EMPLOYEE
TAB_SCHEMA
----------...DBUSER
DBUSER
DBUSER
REORG_PHASE
---------------REPLACE
REPLACE
REPLACE
...
...
...
...
...
...

...
...
...
...
...
REORG_TYPE
-------------------RECLAIM+OFFLINE+ALLO
RECLAIM+OFFLINE+ALLO
REORG_STATUS
-----------COMPLETED
COMPLETED
COMPLETED
REORG_COMPLETION DBPARTITIONNUM
---------------- -------------SUCCESS
0
SUCCESS
1
SUCCESS
2
Select all information about a reorganization operation to reclaim extents from a

multidimensional clustering (MDC) or insert time clustering (ITC) table from the
SNAPTAB_REORG administrative view.
db2 -v "select * from sysibmadm.snaptab_reorg"
TABNAME REORG_PHASE
REORG_MAX_PHASE REORG_TYPE
-------- ----------------- ----------------- --------------------------T1
RELEASE
3
RECLAIM_EXTENTS+ALLOW_WRITE
REORG_STATUS REORG_COMPLETION REORG_START
REORG_END
------------ ---------------- -------------------------- -------------------------COMPLETED
SUCCESS
2008-09-24-14.35.30.734741 2008-09-24-14.35.31.460674

The SNAP_GET_TAB_REORG table function returns the same information as the
SNAPTAB_REORG administrative view, but allows you to retrieve the information
for a specific database on a specific database member, aggregate of all database
Used with the SNAP_GET_TAB table function, the SNAP_GET_TAB_REORG table
function provides the data equivalent to the GET SNAPSHOT FOR TABLES ON
returned.
Syntax
SNAP_GET_TAB_REORG (
dbname
, member

dbname
909
member
SNAP_GET_TAB_REORG table function takes a snapshot for the currently
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Select details on reorganization operations for database member 1 on the currently
connected database.
FROM TABLE( SNAP_GET_TAB_REORG(, 1)) AS T

TAB_NAME
TAB_SCHEMA
REORG_PHASE
REORG_TYPE
...
--------...- ----------...- -----------...- -------------------- ...
EMPLOYEE
DBUSER
REPLACE
RECLAIM+OFFLINE+ALLO ...
...
...

... REORG_STATUS REORG_COMPLETION DBPARTITIONNUM
... ------------ ---------------- -------------... COMPLETED
SUCCESS
1
...
910

multidimensional clustering (MDC) or insert time clustering (ITC) table using the
SNAP_GET_TAB_REORG table function.
db2 -v "select * from table(snap_get_tab_reorg())"
TABNAME REORG_PHASE
-------- ----------------- ----------------- --------------------------T1
RELEASE
3
REORG_END
------------ ---------------- -------------------------- -------------------------COMPLETED
SUCCESS
2008-09-24-14.35.30.734741 2008-09-24-14.35.31.460674
Table 218. Information returned by the SNAPTAB_REORG administrative view and the
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
TABNAME
VARCHAR
(128)
TABSCHEMA
VARCHAR
(128)
PAGE_REORGS
BIGINT
REORG_PHASE
VARCHAR
(16)
reorg_phase - Table reorganize phase. This

interface returns a text identifier based on
defines in sqlmon.h and is one of:
v BUILD
v DICT_SAMPLE
v INDEX_RECREATE
v REPLACE
v SORT
v SCAN
v DRAIN
v RELEASE
or SORT+DICT_SAMPLE.
REORG_MAX_PHASE
INTEGER
reorg_max_phase - Maximum table

reorganize phase
REORG_CURRENT_
COUNTER
BIGINT
reorg_current_counter - Table reorganize

progress
REORG_MAX_COUNTER
BIGINT
reorg_max_counter - Total amount of table

reorganization
911
SNAP_GET_TAB_REORG table function (continued)
Column name
Data type
REORG_TYPE
VARCHAR
(128)

element
reorg_type - Table reorganize attributes.
This interface returns a text identifier using
a combination of the following identifiers
separated by '+':
Either:
v RECLAIM
v RECLUSTER
v RECLAIM_EXTS
and either:
v +OFFLINE
v +ONLINE
If access mode is specified, it is one of:
v +ALLOW_NONE
v +ALLOW_READ
v +ALLOW_WRITE
If offline and RECLUSTER option, one of:
v +INDEXSCAN
v +TABLESCAN
If offline, one of:
v +LONGLOB
v +DATAONLY
If offline, and option is specified, any of:
v +CHOOSE_TEMP
v +KEEPDICTIONARY
v +RESETDICTIONARY
If online, and option is specified:
v +NOTRUNCATE
Example 1: If a REORG TABLE
TEST.EMPLOYEE was run, the following
would be displayed:
RECLAIM+OFFLINE+ALLOW_READ+DATAONLY
+KEEPDICTIONARY
TEST.EMPLOYEE INDEX EMPIDX
INDEXSCAN was run, then the following
would be displayed:
RECLUSTER+OFFLINE+ALLOW_READ+INDEXSCAN
+DATAONLY+KEEPDICTIONARY
912
Column name
Data type
REORG_STATUS
VARCHAR
(10)

element
reorg_status - Table reorganize status. This
v COMPLETED
v PAUSED
v STARTED
v STOPPED
v TRUNCATE
REORG_COMPLETION
VARCHAR
(10)
reorg_completion - Table reorganization

completion flag. This interface returns a text
identifier, based on defines in sqlmon.h and
is one of:
v FAIL
v SUCCESS
REORG_START
TIMESTAMP
reorg_start - Table reorganize start time
REORG_END
TIMESTAMP
reorg_end - Table reorganize end time
REORG_PHASE_START
TIMESTAMP
reorg_phase_start - Table reorganize phase

start time
REORG_INDEX_ID
BIGINT
reorg_index_id - Index used to reorganize

the table
REORG_TBSPC_ID
BIGINT
reorg_tbspc_id - Table space where table is

reorganized
DBPARTITIONNUM
SMALLINT

DATA_PARTITION_ID
INTEGER
data_partition_id - Data Partition identifier.

For a non-partitioned table, this element
will be NULL.
REORG_
ROWSCOMPRESSED
BIGINT
reorg_rows_compressed - Rows compressed
REORG_ROWSREJECTED
BIGINT
reorg_rows_rejected_for_compression Rows rejected for compression
REORG_LONG_TBSPC_ID
BIGINT
reorg_long_tbspc_id - Table space where

long objects are reorganized
MEMBER
SMALLINT

element
SNAPTBSP_QUIESCER administrative view and

SNAP_GET_TBSP_QUIESCER table function - Retrieve quiescer
table space snapshot information
The SNAPTBSP_QUIESCER administrative view and the
SNAP_GET_TBSP_QUIESCER table function return information about quiescers
from a table space snapshot.
v SNAPTBSP_QUIESCER administrative view on page 914
913
v SNAP_GET_TBSP_QUIESCER table function on page 916

This administrative view allows you to retrieve quiescer table space snapshot
Used with the SNAPTBSP_RANGE administrative view and the
MON_GET_TABLESPACE and MON_GET_CONTAINER table functions, the
SNAPTBSP_QUIESCER administrative view provides information equivalent to the
GET SNAPSHOT FOR TABLESPACES ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPTBSP_QUIESCER administrative view
v
v
v
v
CONTROL privilege on the SNAPTBSP_QUIESCER administrative view

DBADM authority
SQLADM authority

v
v
v
v
EXECUTE privilege on the SNAP_GET_TBSP_QUIESCER table function

DBADM authority
SQLADM authority

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve information about the quiesced table spaces for all database members for
SELECT SUBSTR(TBSP_NAME, 1, 10) AS TBSP_NAME, QUIESCER_TS_ID,
QUIESCER_OBJ_ID, QUIESCER_AUTH_ID, QUIESCER_AGENT_ID,
QUIESCER_STATE, DBPARTITIONNUM
FROM SYSIBMADM.SNAPTBSP_QUIESCER ORDER BY DBPARTITIONNUM
914

TBSP_NAME QUIESCER_TS_ID
QUIESCER_OBJ_ID
---------- --------------...- ---------------...USERSPACE1
2
5
USERSPACE1
2
5
QUIESCER_AUTH_ID
----------------...SWALKTY
SWALKTY
..
..
..
..

... QUIESCER_AGENT_ID
QUIESCER_STATE DBPARTITIONNUM
... -------------------- -------------- -------------...
0 EXCLUSIVE
0
...
65983 EXCLUSIVE
1
Example: Determine the partitioned table names

If the table is partitioned and kept in quiesced state, the different values for table
space ID and table ID are represented than in SYSCAT.TABLES. These IDs will
appear as the unsigned short representation. In order to find the quiesced table
name, you need to find the signed short representation first by calculating the table
space ID that is subtracting 65536 (the maximum value) from QEUIESCER_TS_ID
and then use this table space ID to locate the quiesced tables. (The actual table
space ID can be found in SYSCAT.DATAPARTITIONS for each data partition in
the table.)
SELECT SUBSTR(TBSP_NAME, 1, 10) AS TBSP_NAME,
CASE WHEN QUIESCER_TS_ID = 65530
THEN QUIESCER_TS_ID - 65536
ELSE QUIESCER_TS_ID END as tbspaceid,
THEN QUIESCER_OBJ_ID - 65536
ELSE QUIESCER_OBJ_ID END as tableid
FROM SYSIBMADM.SNAPTBSP_QUIESCER
ORDER BY DBPARTITIONNUM

TBSP_NAME
------------TABDATA
DATAMART
SMALL
TBSPACEID
------------6
-6
5
TABLEID
--------32768
-32765
17
Use the given TBSPACEID and TABLEID provided from this query to find the
table schema and name from SYSCAT.TABLES.
SELECT CHAR(tabschema, 10)tabschema, CHAR(tabname,15)tabname
FROM SYSCAT.TABLES
WHERE tbspaceid = -6 AND tableid in (-32768,-32765)

TABSCHEMA
-----------SAMP
SAMP
TABNAME
-------ORDERS_RP
ORDERS_DMART
FROM SYSCAT.TABLES
WHERE tbspaceid = 5 AND tableid = 17
915

TABSCHEMA
TABNAME
------------ -------SAMP
NATION
SNAP_GET_TBSP_QUIESCER table function

The SNAP_GET_TBSP_QUIESCER table function returns the same information as
the SNAPTBSP_QUIESCER administrative view, but allows you to retrieve the
Used with the SNAP_GET_TBSP, SNAP_GET_TBSP_PART,
SNAP_GET_TBSP_RANGE, SNAP_GET_CONTAINER table functions, the
SNAP_GET_TBSP_QUIESCER table function provides information equivalent to
the GET SNAPSHOT FOR TABLESPACES ON database-alias CLP command.
returned.
Syntax
SNAP_GET_TBSP_QUIESCER (
dbname
, member

dbname
member
SNAP_GET_TBSP_QUIESCER table function takes a snapshot for the currently
916
Authorization
v EXECUTE privilege on the SNAP_GET_TBSP_QUIESCER table function
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve information about the quiesced table spaces for database member 1 for the
FROM TABLE( SYSPROC.SNAP_GET_TBSP_QUIESCER( , 1)) AS T

QUIESCER_OBJ_ID
QUIESCER_AUTH_ID
...
---------- --------------...- ---------------...- ----------------...- ...
USERSPACE1
2
5 SWALKTY
...

... -------------------- -------------- -------------...
65983 EXCLUSIVE
1
Table 219. Information returned by the SNAPTBSP_QUIESCER administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TBSP_NAME
VARCHAR(128)
tablespace_name - Table space

name
QUIESCER_TS_ID
BIGINT
quiescer_ts_id - Quiescer table

space identification
QUIESCER_OBJ_ID
BIGINT
quiescer_obj_id - Quiescer object

identification
917
SNAP_GET_TBSP_QUIESCER table function (continued)
monitor element
Column name
Data type
QUIESCER_AUTH_ID
VARCHAR(128)
quiescer_auth_id - Quiescer user

authorization identification
QUIESCER_AGENT_ID
BIGINT
quiescer_agent_id - Quiescer agent

identification
QUIESCER_STATE
VARCHAR(14)
quiescer_state - Quiescer state. This

based on defines in sqlutil.h and
is one of:
v EXCLUSIVE
v UPDATE
v SHARE
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

SNAP_GET_TBSP_RANGE table function - Retrieve range
snapshot information
The SNAPTBSP_RANGE administrative view and the SNAP_GET_TBSP_RANGE
table function return information from a range snapshot.
v SNAPTBSP_RANGE administrative view
v SNAP_GET_TBSP_RANGE table function on page 920
SNAPTBSP_RANGE administrative view

This administrative view allows you to retrieve range snapshot information for the
Used with the SNAPTBSP_QUIESCER administrative view and the
MON_GET_TABLESPACE and the MON_GET_CONTAINER table functions, the
SNAPTBSP_RANGE administrative view provides information equivalent to the
returned.
Authorization
v SELECT privilege on the SNAPTBSP_RANGE administrative view
v CONTROL privilege on the SNAPTBSP_RANGE administrative view
918
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_TBSP_RANGE table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Select information about table space ranges for all database members for the
SELECT TBSP_ID, SUBSTR(TBSP_NAME, 1, 15) AS TBSP_NAME, RANGE_NUMBER,
RANGE_STRIPE_SET_NUMBER, RANGE_OFFSET, RANGE_MAX_PAGE,
RANGE_MAX_EXTENT, RANGE_START_STRIPE, RANGE_END_STRIPE,
RANGE_ADJUSTMENT, RANGE_NUM_CONTAINER, RANGE_CONTAINER_ID,
DBPARTITIONNUM FROM SYSIBMADM.SNAPTBSP_RANGE

TBSP_ID
-------...0
2
3
2
2
TBSP_NAME
RANGE_NUMBER
RANGE_STRIPE_SET_NUMBER ...
--------------- ------------...- ----------------------- ...
SYSCATSPACE
0
0 ...
USERSPACE1
0
0 ...
SYSTOOLSPACE
0
0 ...
USERSPACE1
0
0 ...
USERSPACE1
0
0 ...

... RANGE_OFFSET
RANGE_MAX_PAGE
RANGE_MAX_EXTENT
...
... ------------...- -------------------- -------------------- ...
...
0
11515
2878 ...
...
0
479
14 ...
...
0
251
62 ...
...
0
479
14 ...
...
0
479
14 ...

... RANGE_START_STRIPE
RANGE_END_STRIPE
RANGE_ADJUSTMENT
... -------------------- -------------------- -------------------...
0
2878
0
...
0
14
0
...
...
...
...
919
...
...
...
0
0
0
62
14
14
0 ...
0 ...
0 ...

... RANGE_NUM_CONTAINER RANGE_CONTAINER_ID
DBPARTITIONNUM
... -------------------- -------------------- -------------...
1
0
0
...
1
0
0
...
1
0
0
...
1
0
1
...
1
0
2

The SNAP_GET_TBSP_RANGE table function returns the same information as the
SNAPTBSP_RANGE administrative view, but allows you to retrieve the
SNAP_GET_TBSP_QUIESCER and SNAP_GET_CONTAINER table functions, the
SNAP_GET_TBSP_RANGE table function provides information equivalent to the
returned.
Syntax
SNAP_GET_TBSP_RANGE (
dbname
, member

dbname
member
920
SNAP_GET_TBSP_RANGE table function takes a snapshot for the currently

Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Examples
Select information about the table space range for the table space with tbsp_id = 2
on the currently connected database member.
RANGE_STRIPE_SET_NUMBER, RANGE_OFFSET, RANGE_MAX_PAGE, RANGE_MAX_EXTENT,
RANGE_START_STRIPE, RANGE_END_STRIPE, RANGE_ADJUSTMENT,
RANGE_NUM_CONTAINER, RANGE_CONTAINER_ID
FROM TABLE(SNAP_GET_TBSP_RANGE(,-1)) AS T WHERE TBSP_ID = 2

TBSP_ID
TBSP_NAME
RANGE_NUMBER
...
-------...- --------------- ------------...- ...
2 USERSPACE1
0 ...

... RANGE_STRIPE_SET_NUMBER RANGE_OFFSET
RANGE_MAX_PAGE
...
... ----------------------- ------------...- --------------...---- ...
...
0
0
3967 ...

... RANGE_MAX_EXTENT
RANGE_START_STRIPE
RANGE_END_STRIPE
...
... -------------------- -------------------- -------------------- ...
...
123
0
123 ...

... RANGE_ADJUSTMENT
RANGE_NUM_CONTAINER RANGE_CONTAINER_ID
... -------------------- -------------------- -------------------...
0
1
0
921
Table 220. Information returned by the SNAPTBSP_RANGE administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TBSP_ID
BIGINT

identification
TBSP_NAME
VARCHAR(128)

name
RANGE_NUMBER
BIGINT
range_number - Range number
RANGE_STRIPE_SET_NUMBER
BIGINT
range_stripe_set_number - Stripe
set number
RANGE_OFFSET
BIGINT
range_offset - Range offset
RANGE_MAX_PAGE
BIGINT
range_max_page_number Maximum page in range
RANGE_MAX_EXTENT
BIGINT
range_max_extent - Maximum
extent in range
RANGE_START_STRIPE
BIGINT
range_start_stripe - Start stripe
RANGE_END_STRIPE
BIGINT
range_end_stripe - End stripe
RANGE_ADJUSTMENT
BIGINT
range_adjustment - Range
adjustment
RANGE_NUM_CONTAINER
BIGINT
range_num_containers - Number
of containers in range
RANGE_CONTAINER_ID
BIGINT
range_container_id - Range
container
DBPARTITIONNUM
SMALLINT
SNAPUTIL_PROGRESS administrative view and

SNAP_GET_UTIL_PROGRESS table function - Retrieve progress
logical data group snapshot information
The SNAPUTIL_PROGRESS administrative view and the
SNAP_GET_UTIL_PROGRESS table function return snapshot information about
utility progress, in particular, the progress logical data group.
v SNAPUTIL_PROGRESS administrative view
v SNAP_GET_UTIL_PROGRESS table function on page 923

Used in conjunction with the SNAPUTIL administrative view, the
SNAPUTIL_PROGRESS administrative view provides the same information as the
LIST UTILITIES SHOW DETAIL CLP command.
922
returned.
Authorization
v SELECT privilege on the SNAPUTIL_PROGRESS administrative view
v CONTROL privilege on the SNAPUTIL_PROGRESS administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_UTIL_PROGRESS table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve details on total and completed units of progress by utility ID.
SELECT UTILITY_ID, PROGRESS_TOTAL_UNITS, PROGRESS_COMPLETED_UNITS,
DBPARTITIONNUM FROM SYSIBMADM.SNAPUTIL_PROGRESS

UTILITY_ID PROGRESS_TOTAL_UNITS PROGRESS_COMPLETED_UNITS DBPARTITIONNU
---------- -------------------- ------------------------ ------------7
10
5
0
9
10
5
1
SNAP_GET_UTIL_PROGRESS table function

The SNAP_GET_UTIL_PROGRESS table function returns the same information as
the SNAPUTIL_PROGRESS administrative view, but allows you to retrieve the
923
Used in conjunction with the SNAP_GET_UTIL table function, the

SNAP_GET_UTIL_PROGRESS table function provides the same information as the
returned.
Syntax
SNAP_GET_UTIL_PROGRESS (
member

member
applications.
SNAP_GET_UTIL_PROGRESS table function takes a snapshot for the currently
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve details on the progress of utilities on the currently connect member.
DBPARTITIONNUM FROM TABLE(SNAP_GET_UTIL_PROGRESS(-1)) as T
924

UTILITY_ID PROGRESS_TOTAL_UNITS PROGRESS_COMPLETED_UNITS DBPARTITIONNUM
---------- -------------------- ------------------------ -------------7
10
5
0
Table 221. Information returned by the SNAPUTIL_PROGRESS administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
UTILITY_ID
INTEGER
utility_id - Utility ID. Unique to a

database partition.
PROGRESS_SEQ_NUM
INTEGER
progress_seq_num - Progress
sequence number. If serial, the
number of the phase. If concurrent,
then could be NULL.
UTILITY_STATE
VARCHAR(16)
utility_state - Utility state. This

based on the defines in sqlmon.h
and is one of:
v ERROR
v EXECUTE
v WAIT
PROGRESS_DESCRIPTION
VARCHAR(2048) progress_description - Progress

description
PROGRESS_START_TIME
TIMESTAMP
progress_start_time - Progress start

time. Start time if the phase has
started, otherwise NULL.
PROGRESS_WORK_METRIC
VARCHAR(16)
progress_work_metric - Progress
work metric. This interface returns
a text identifier based on the
v NOT_SUPPORT
v BYTES
v EXTENTS
v INDEXES
v PAGES
v ROWS
v TABLES
PROGRESS_TOTAL_UNITS
BIGINT
progress_total_units - Total
progress work units
PROGRESS_COMPLETED_UNITS
BIGINT
progress_completed_units Completed progress work units
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
925
SNAPDYN_SQL administrative view and SNAP_GET_DYN_SQL

table function - Retrieve dynsql logical group snapshot
information
The SNAPDYN_SQL administrative view and the SNAP_GET_DYN_SQL table
function return snapshot information from the dynsql logical data group.
The MON_GET_PKG_CACHE_STMT table function - Get SQL statement activity
metrics in the package cache on page 632 returns a point-in-time view of both
static and dynamic SQL statements in the database package cache. If you use this
table function, you can take advantage of the monitoring infrastructure introduced
in Version 9.7.
v SNAPDYN_SQL administrative view on page 893
v SNAP_GET_DYN_SQL table function on page 895
SNAPDYN_SQL administrative view

This administrative view allows you to retrieve dynsql logical group snapshot
This view returns information equivalent to the GET SNAPSHOT FOR DYNAMIC SQL ON
returned.
Authorization
v SELECT privilege on the SNAPDYN_SQL administrative view
v
v
v
v
CONTROL privilege on the SNAPDYN_SQL administrative view

DBADM authority
SQLADM authority

v
v
v
v
EXECUTE privilege on the SNAP_GET_DYN_SQL table function

DBADM authority
SQLADM authority

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM
926

Example
AS STMT_TEXT, DBPARTITIONNUM
FROM SYSIBMADM.SNAPDYN_SQL ORDER BY ROWS_READ

PREP_TIME_WORST
NUM_COMPILATIONS
-------------------- -------------------98
1
9
1
0
0
0
1
0
1
0
1
0
1
0
1
40
1
...
...
...
...
...
...
...
...
...
...
...

...
...
...
...
...
...
...
...
...
...
...
STMT_TEXT
-----------------------------------------------------------select prep_time_worst, num_compilations, substr(stmt_text,
SET CURRENT LOCALE LC_CTYPE = en_US
...
...
...
...
...
...
...
...
...
...
...

... DBPARTITIONNUM
... -------------...
0
...
0
...
0
...
2
...
1
...
2
...
2
...
1
...
0

The SNAP_GET_DYN_SQL table function returns the same information as the
SNAPDYN_SQL administrative view, but allows you to retrieve the information for
927
This table function returns information equivalent to the GET SNAPSHOT FOR
DYNAMIC SQL ON database-alias CLP command.
returned.
Syntax
SNAP_GET_DYN_SQL (
dbname
, member

dbname
member
provided, data is returned from members where the database is active.
SNAP_GET_DYN_SQL table function takes a snapshot for the currently connected
Important: The SYSPROC.SNAP_WRITE_FILE procedure is deprecated in Version
10.5 and might be removed in a future release. For more information, see
SNAP_WRITE_FILE procedure in Administrative Routines and Views.
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM
928

Example
AS STMT_TEXT FROM TABLE(SNAP_GET_DYN_SQL(,-1)) as T
ORDER BY ROWS_READ

PREP_TIME_WORST
NUM_COMPILATIONS
...
-------------------- ---------------------...
0
0 ...
49
1 ...
0
0 ...
46
1 ...
0
0 ...
0
0 ...
0
0 ...
29
1 ...
0
0 ...
0
0 ...
10
1 ...
0
0 ...
4
0 ...
53
0 ...
0
0 ...
6
1 ...
334
0 ...
0
0 ...
5
0 ...
10
0 ...
599
0 ...
15
1 ...
7
0 ...

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
STMT_TEXT
----------------------------------------------------------SET :HV00017 :HI00017 = RPAD(VARCHAR(:HV00035 :HI00035 ),
SELECT COLNAME, TYPENAME FROM SYSCAT.COLUMNS WHERE TABNAME=
DECLARE RES CURSOR WITH RETURN TO CALLER FOR SELECT R.TEXT F
SELECT PREP_TIME_WORST, NUM_COMPILATIONS, SUBSTR(STMT_TEXT,
VALUES (1) INTO :HV00035 :HI00035
SELECT TRIGNAME FROM SYSCAT.TRIGGERS WHERE TABNAME=POLICY
VALUES (:HV00024 :HI00024 +1, :HV00022 :HI00022 +1) INTO :
VALUES (1, CARDINALITY(CAST(:HV00040 :HI00040 AS "SYSIBMAD
CALL SYSPROC.SYSINSTALLOBJECTS(POLICY,V,,)
SET :HV00017 :HI00017 = RPAD(VARCHAR(:HV00035 :HI00035 ),
drop event monitor act
SELECT TABSCHEMA, TABNAME, TYPE, STATUS, TBSPACEID, PROPERTY
CALL SAVE_EXEC_INFO (CAST(:HV00040 :HI00040 AS "SYSIBMADM"
SET CURRENT LOCK TIMEOUT 5
SELECT TABNAME FROM SYSCAT.PERIODS WHERE PERIODNAME = SYSTE
SELECT ARRAY_AGG(P.EXECUTABLE_ID ORDER BY M.IO_WAIT_TIME DES
929
...
...
...
...
...
SET CURRENT ISOLATION RESET

CALL monreport.pkgcache()
SELECT A.SPECIFICNAME FROM SYSCAT.ROUTINES A WHERE (A.FENCED
SELECT POLICY FROM SYSTOOLS.POLICY WHERE MED=DB2CommonMED
VALUES 0
function.
FROM TABLE (SNAP_GET_DYN_SQL(mytestdb, -1))
AS SNAPDB
STATS_FABRICATE_TIME SYNC_RUNSTATS_TIME
---------------------- -----------------2
12
1
30

STATS_FABRICATE_TIME SYNC_RUNSTATS_TIME
---------------------- -----------------5
10
3
20
function
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
NUM_EXECUTIONS
BIGINT
NUM_COMPILATIONS
BIGINT
PREP_TIME_WORST
BIGINT

preparation time
PREP_TIME_BEST
BIGINT

time
INT_ROWS_DELETED
BIGINT
INT_ROWS_INSERTED
BIGINT
INT_ROWS_UPDATED
BIGINT
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
STMT_SORTS
BIGINT
SORT_OVERFLOWS
BIGINT
TOTAL_SORT_TIME
BIGINT
POOL_DATA_L_READS
BIGINT

reads
930
element
Column name
Data type
POOL_DATA_P_READS
BIGINT

physical reads
BIGINT

BIGINT

POOL_INDEX_L_READS
BIGINT

logical reads
POOL_INDEX_P_READS
BIGINT

physical reads
BIGINT

BIGINT

POOL_XDA_L_READS
BIGINT

Logical Reads
POOL_XDA_P_READS
BIGINT

Physical Reads
BIGINT

BIGINT

monitor element
TOTAL_EXEC_TIME
BIGINT

TOTAL_EXEC_TIME_MS
BIGINT

TOTAL_USR_CPU_TIME
BIGINT

BIGINT

TOTAL_SYS_CPU_TIME
BIGINT

BIGINT

STMT_TEXT
CLOB(2 M)
DBPARTITIONNUM
SMALLINT

monitor element
BIGINT

SYNC_RUNSTATS_TIME
BIGINT

MEMBER
SMALLINT

931
Column name
Data type

element

SNAP_GET_SUBSECTION table function - Retrieve subsection
logical monitor group snapshot information
The SNAPSUBSECTION administrative view and the SNAP_GET_SUBSECTION
table function return information about application subsections, namely the
subsection logical monitor grouping.
v SNAPSUBSECTION administrative view on page 899
v SNAP_GET_SUBSECTION table function on page 901
SNAPSUBSECTION administrative view

This administrative view allows you to retrieve subsection logical monitor group
Used with the MON_CURRENT_SQL administrative view and the
MON_GET_AGENT, MON_GET_CONNECTION, MON_GET_MEMORY_POOL,
and MON_GET_MEMORY_SET table functions, the SNAPSUBSECTION
APPLICATIONS on database-alias CLP command, but retrieves data from all
database members.
returned.
Authorization
v SELECT privilege on the SNAPSUBSECTION administrative view
v CONTROL privilege on the SNAPSUBSECTION administrative view
v DBADM authority
v SQLADM authority
v DBADM authority
932
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
FROM SYSIBMADM.SNAPSUBSECTION

DB_NAME
-------...SAMPLE
SAMPLE
STMT_TEXT
SS_STATUS
DBPARTITIONNUM
---------...- -------------EXEC
0
EXEC
1

The SNAP_GET_SUBSECTION table function returns the same information as the
SNAPSUBSECTION administrative view, but allows you to retrieve the
returned.
SNAP_GET_APPL, SNAP_GET_APPL_INFO and SNAP_GET_STMT table
functions, the SNAP_GET_SUBSECTION table function provides information
Syntax
SNAP_GET_SUBSECTION (
dbname
, member

dbname
933
member
SNAP_GET_SUBSECTION table function takes a snapshot for the currently
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
FROM TABLE(SYSPROC.SNAP_GET_SUBSECTION( , 0 )) as T

DB_NAME
-------...SAMPLE
SAMPLE
934
STMT_TEXT
SS_STATUS
DBPARTITIONNUM
---------...- -------------EXEC
0
EXEC
1
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
STMT_TEXT
CLOB(16 M)
SS_EXEC_TIME
BIGINT
ss_exec_time - Subsection
execution elapsed time
TQ_TOT_SEND_SPILLS
BIGINT
tq_tot_send_spills - Total number

of table queue buffers overflowed
TQ_CUR_SEND_SPILLS
BIGINT
tq_cur_send_spills Currentnumber of table queue

buffers overflowed
TQ_MAX_SEND_SPILLS
BIGINT
tq_max_send_spills - Maximum
number of table queue buffers
overflows
TQ_ROWS_READ
BIGINT
tq_rows_read - Number of rows

read from table queues
TQ_ROWS_WRITTEN
BIGINT
tq_rows_written - Number of rows

written to table queues
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
SS_USR_CPU_TIME_S
BIGINT

used by subsection (in seconds)*
SS_USR_CPU_TIME_MS
BIGINT

used by subsection (fractional, in
microseconds)*
SS_SYS_CPU_TIME_S
BIGINT

time used by subsection (in
seconds)*
SS_SYS_CPU_TIME_MS
BIGINT

time used by subsection (fractional,
in microseconds)*
SS_NUMBER
INTEGER
SS_STATUS
VARCHAR(20)
ss_status - Subsection status. This

is one of:
v EXEC
v TQ_WAIT_TO_RCV
v TQ_WAIT_TO_SEND
v COMPLETED
SS_NODE_NUMBER
SMALLINT
ss_node_number - Subsection node

number
TQ_NODE_WAITED_FOR
SMALLINT
tq_node_waited_for - Waited for

node on a table queue
935
SNAP_GET_SUBSECTION table function (continued)
monitor element
Column name
Data type
TQ_WAIT_FOR_ANY
INTEGER
tq_wait_for_any - Waiting for any

node to send on a table queue
TQ_ID_WAITING_ON
INTEGER
tq_id_waiting_on - Waited on node

on a table queue
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAPSWITCHES administrative view and SNAP_GET_SWITCHES

table function - Retrieve database snapshot switch state
information
The SNAPSWITCHES administrative view and the SNAP_GET_SWITCHES table
function return information about the database snapshot switch state.
v SNAPSWITCHES administrative view on page 904
v SNAP_GET_SWITCHES table function on page 905
SNAPSWITCHES administrative view

This view provides the data equivalent to the GET DBM MONITOR SWITCHES CLP
command.
returned.
Authorization
v SELECT privilege on the SNAPSWITCHES administrative view
v CONTROL privilege on the SNAPSWITCHES administrative view
v DBADM authority
v SQLADM authority
936
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve DBM monitor switches state information for all database members.
SELECT UOW_SW_STATE, STATEMENT_SW_STATE, TABLE_SW_STATE, BUFFPOOL_SW_STATE,
LOCK_SW_STATE, SORT_SW_STATE, TIMESTAMP_SW_STATE,
DBPARTITIONNUM FROM SYSIBMADM.SNAPSWITCHES

UOW_SW_STATE STATEMENT_SW_STATE TABLE_SW_STATE BUFFPOOL_SW_STATE ...
------------ ------------------ -------------- ----------------- ...
0
0
0
0 ...
0
0
0
0 ...
0
0
0
0 ...
...
3 record selected.

... LOCK_SW_STATE SORT_SW_STATE TIMESTAMP_SW_STATE DBPARTITIONNUM
... ------------- ------------- ------------------ -------------...
1
0
1
0
...
1
0
1
1
...
1
0
1
2

The SNAP_GET_SWITCHES table function returns the same information as the
SNAPSWITCHES administrative view, but allows you to retrieve the information
members.
This table function provides the data equivalent to the GET DBM MONITOR SWITCHES
CLP command.
returned.
Syntax
SNAP_GET_SWITCHES (
member
937

member
applications.
SNAP_GET_SWITCHES table function takes a snapshot for the currently connected
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Examples
Retrieve DBM monitor switches state information for the current database member.
SELECT UOW_SW_STATE, STATEMENT_SW_STATE, TABLE_SW_STATE,
BUFFPOOL_SW_STATE,LOCK_SW_STATE, SORT_SW_STATE, TIMESTAMP_SW_STATE
FROM TABLE(SNAP_GET_SWITCHES(-1)) AS T

UOW_SW_STATE STATEMENT_SW_STATE TABLE_SW_STATE...
------------ ------------------ --------------...
1
1
1...
...
...

... BUFFPOOL_SW_STATE LOCK_SW_STATE SORT_SW_STATE TIMESTAMP_SW_STATE
... ----------------- ------------- ------------- -----------------...
1
1
0
1
938
Column name
Data type
Description
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
UOW_SW_STATE
SMALLINT
State of the unit of work monitor

UOW_SW_TIME
TIMESTAMP
If the unit of work monitor

turned on.
STATEMENT_SW_STATE
SMALLINT
State of the SQL statement monitor

STATEMENT_SW_TIME
TIMESTAMP
If the SQL statement monitor

turned on.
TABLE_SW_STATE
SMALLINT
State of the table activity monitor

TABLE_SW_TIME
TIMESTAMP
If the table activity monitor

turned on.
BUFFPOOL_SW_STATE
SMALLINT
State of the buffer pool activity

monitor recording switch (0 or 1).
BUFFPOOL_SW_TIME
TIMESTAMP
If the buffer pool activity monitor

turned on.
LOCK_SW_STATE
SMALLINT
State of the lock monitor recording

switch (0 or 1).
LOCK_SW_TIME
TIMESTAMP
If the lock monitor recording

SORT_SW_STATE
SMALLINT
State of the sorting monitor

SORT_SW_TIME
TIMESTAMP
If the sorting monitor recording

TIMESTAMP_SW_STATE
SMALLINT
State of the timestamp monitor

recording switch (0 or 1)
TIMESTAMP_SW_TIME
TIMESTAMP
If the timestamp monitor recording

DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
939

SNAP_GET_TAB_REORG table function - Retrieve table
reorganization snapshot information
The SNAPTAB_REORG administrative view and the SNAP_GET_TAB_REORG
table function return table reorganization information.
If no tables have been reorganized, 0 rows are returned. When a data partitioned
table is reorganized, one record for each data partition is returned. If only a
specific data partition of a data partitioned table is reorganized, only a record for
the partition is returned.
v SNAPTAB_REORG administrative view on page 908
v SNAP_GET_TAB_REORG table function on page 909
SNAPTAB_REORG administrative view

This administrative view allows you to retrieve table reorganization snapshot
Used with the SNAPTAB administrative view, the SNAPTAB_REORG
administrative view provides the data equivalent to the GET SNAPSHOT FOR TABLES
ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPTAB_REORG administrative view
v
v
v
v
CONTROL privilege on the SNAPTAB_REORG administrative view

DBADM authority
SQLADM authority

v
v
v
v
EXECUTE privilege on the SNAP_GET_TAB_REORG table function

DBADM authority
SQLADM authority

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM
940

Example
Select details on reorganization operations for all database members on the
FROM SYSIBMADM.SNAPTAB_REORG ORDER BY DBPARTITIONNUM

TAB_NAME
--------...EMPLOYEE
EMPLOYEE
EMPLOYEE
TAB_SCHEMA
----------...DBUSER
DBUSER
DBUSER
REORG_PHASE
---------------REPLACE
REPLACE
REPLACE
...
...
...
...
...
...

...
...
...
...
...
REORG_TYPE
-------------------RECLAIM+OFFLINE+ALLO
REORG_STATUS
-----------COMPLETED
COMPLETED
COMPLETED
REORG_COMPLETION DBPARTITIONNUM
---------------- -------------SUCCESS
0
SUCCESS
1
SUCCESS
2

multidimensional clustering (MDC) or insert time clustering (ITC) table from the
SNAPTAB_REORG administrative view.
db2 -v "select * from sysibmadm.snaptab_reorg"
TABNAME REORG_PHASE
-------- ----------------- ----------------- --------------------------T1
RELEASE
3
REORG_END
------------ ---------------- -------------------------- -------------------------COMPLETED
SUCCESS
2008-09-24-14.35.30.734741 2008-09-24-14.35.31.460674

The SNAP_GET_TAB_REORG table function returns the same information as the
SNAPTAB_REORG administrative view, but allows you to retrieve the information
Used with the SNAP_GET_TAB table function, the SNAP_GET_TAB_REORG table
function provides the data equivalent to the GET SNAPSHOT FOR TABLES ON
returned.
941
Syntax
SNAP_GET_TAB_REORG (
dbname
, member

dbname
member
SNAP_GET_TAB_REORG table function takes a snapshot for the currently
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Select details on reorganization operations for database member 1 on the currently
connected database.
942

FROM TABLE( SNAP_GET_TAB_REORG(, 1)) AS T

TAB_NAME
TAB_SCHEMA
REORG_PHASE
REORG_TYPE
...
--------...- ----------...- -----------...- -------------------- ...
EMPLOYEE
DBUSER
REPLACE
RECLAIM+OFFLINE+ALLO ...
...
...

... REORG_STATUS REORG_COMPLETION DBPARTITIONNUM
... ------------ ---------------- -------------... COMPLETED
SUCCESS
1
...

multidimensional clustering (MDC) or insert time clustering (ITC) table using the
SNAP_GET_TAB_REORG table function.
db2 -v "select * from table(snap_get_tab_reorg())"
TABNAME REORG_PHASE
-------- ----------------- ----------------- --------------------------T1
RELEASE
3
REORG_END
------------ ---------------- -------------------------- -------------------------COMPLETED
SUCCESS
2008-09-24-14.35.30.734741 2008-09-24-14.35.31.460674
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
TABNAME
VARCHAR
(128)
TABSCHEMA
VARCHAR
(128)
PAGE_REORGS
BIGINT
REORG_PHASE
VARCHAR
(16)
reorg_phase - Table reorganize phase. This

v BUILD
v DICT_SAMPLE
v INDEX_RECREATE
v REPLACE
v SORT
v SCAN
v DRAIN
v RELEASE
or SORT+DICT_SAMPLE.
943
element
Column name
Data type
REORG_MAX_PHASE
INTEGER
reorg_max_phase - Maximum table

reorganize phase
REORG_CURRENT_
COUNTER
BIGINT
reorg_current_counter - Table reorganize

progress
REORG_MAX_COUNTER
BIGINT
reorg_max_counter - Total amount of table

reorganization
REORG_TYPE
VARCHAR
(128)
reorg_type - Table reorganize attributes.

This interface returns a text identifier using
a combination of the following identifiers
separated by '+':
Either:
v RECLAIM
v RECLUSTER
v RECLAIM_EXTS
and either:
v +OFFLINE
v +ONLINE
If access mode is specified, it is one of:
v +ALLOW_NONE
v +ALLOW_READ
v +ALLOW_WRITE
If offline and RECLUSTER option, one of:
v +INDEXSCAN
v +TABLESCAN
If offline, one of:
v +LONGLOB
v +DATAONLY
If offline, and option is specified, any of:
v +CHOOSE_TEMP
v +KEEPDICTIONARY
v +RESETDICTIONARY
If online, and option is specified:
v +NOTRUNCATE
TEST.EMPLOYEE was run, the following
would be displayed:
RECLAIM+OFFLINE+ALLOW_READ+DATAONLY
+KEEPDICTIONARY
TEST.EMPLOYEE INDEX EMPIDX
INDEXSCAN was run, then the following
would be displayed:
RECLUSTER+OFFLINE+ALLOW_READ+INDEXSCAN
+DATAONLY+KEEPDICTIONARY
944
Column name
Data type
REORG_STATUS
VARCHAR
(10)

element
reorg_status - Table reorganize status. This
v COMPLETED
v PAUSED
v STARTED
v STOPPED
v TRUNCATE
REORG_COMPLETION
VARCHAR
(10)
reorg_completion - Table reorganization

completion flag. This interface returns a text
identifier, based on defines in sqlmon.h and
is one of:
v FAIL
v SUCCESS
REORG_START
TIMESTAMP
reorg_start - Table reorganize start time
REORG_END
TIMESTAMP
reorg_end - Table reorganize end time
REORG_PHASE_START
TIMESTAMP
reorg_phase_start - Table reorganize phase

start time
REORG_INDEX_ID
BIGINT
reorg_index_id - Index used to reorganize

the table
REORG_TBSPC_ID
BIGINT
reorg_tbspc_id - Table space where table is

reorganized
DBPARTITIONNUM
SMALLINT

DATA_PARTITION_ID
INTEGER
data_partition_id - Data Partition identifier.

For a non-partitioned table, this element
will be NULL.
REORG_
ROWSCOMPRESSED
BIGINT
reorg_rows_compressed - Rows compressed
REORG_ROWSREJECTED
BIGINT
reorg_rows_rejected_for_compression Rows rejected for compression
REORG_LONG_TBSPC_ID
BIGINT
reorg_long_tbspc_id - Table space where

long objects are reorganized
MEMBER
SMALLINT

element
SNAPTBSP_QUIESCER administrative view and

SNAP_GET_TBSP_QUIESCER table function - Retrieve quiescer
table space snapshot information
The SNAPTBSP_QUIESCER administrative view and the
SNAP_GET_TBSP_QUIESCER table function return information about quiescers
from a table space snapshot.
v SNAPTBSP_QUIESCER administrative view on page 914
945
v SNAP_GET_TBSP_QUIESCER table function on page 916

This administrative view allows you to retrieve quiescer table space snapshot
Used with the SNAPTBSP_RANGE administrative view and the
MON_GET_TABLESPACE and MON_GET_CONTAINER table functions, the
SNAPTBSP_QUIESCER administrative view provides information equivalent to the
returned.
Authorization
v SELECT privilege on the SNAPTBSP_QUIESCER administrative view
v
v
v
v
CONTROL privilege on the SNAPTBSP_QUIESCER administrative view

DBADM authority
SQLADM authority

v
v
v
v
EXECUTE privilege on the SNAP_GET_TBSP_QUIESCER table function

DBADM authority
SQLADM authority

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve information about the quiesced table spaces for all database members for
FROM SYSIBMADM.SNAPTBSP_QUIESCER ORDER BY DBPARTITIONNUM
946

QUIESCER_OBJ_ID
---------- --------------...- ---------------...USERSPACE1
2
5
USERSPACE1
2
5
QUIESCER_AUTH_ID
----------------...SWALKTY
SWALKTY
..
..
..
..

... -------------------- -------------- -------------...
0 EXCLUSIVE
0
...
65983 EXCLUSIVE
1
Example: Determine the partitioned table names

If the table is partitioned and kept in quiesced state, the different values for table
space ID and table ID are represented than in SYSCAT.TABLES. These IDs will
appear as the unsigned short representation. In order to find the quiesced table
name, you need to find the signed short representation first by calculating the table
space ID that is subtracting 65536 (the maximum value) from QEUIESCER_TS_ID
and then use this table space ID to locate the quiesced tables. (The actual table
space ID can be found in SYSCAT.DATAPARTITIONS for each data partition in
the table.)
SELECT SUBSTR(TBSP_NAME, 1, 10) AS TBSP_NAME,
THEN QUIESCER_TS_ID - 65536
ELSE QUIESCER_TS_ID END as tbspaceid,
THEN QUIESCER_OBJ_ID - 65536
ELSE QUIESCER_OBJ_ID END as tableid
FROM SYSIBMADM.SNAPTBSP_QUIESCER

TBSP_NAME
------------TABDATA
DATAMART
SMALL
TBSPACEID
------------6
-6
5
TABLEID
--------32768
-32765
17
Use the given TBSPACEID and TABLEID provided from this query to find the
table schema and name from SYSCAT.TABLES.
FROM SYSCAT.TABLES
WHERE tbspaceid = -6 AND tableid in (-32768,-32765)

TABSCHEMA
-----------SAMP
SAMP
TABNAME
-------ORDERS_RP
ORDERS_DMART
FROM SYSCAT.TABLES
WHERE tbspaceid = 5 AND tableid = 17
947

TABSCHEMA
TABNAME
------------ -------SAMP
NATION

The SNAP_GET_TBSP_QUIESCER table function returns the same information as
the SNAPTBSP_QUIESCER administrative view, but allows you to retrieve the
SNAP_GET_TBSP_QUIESCER table function provides information equivalent to
the GET SNAPSHOT FOR TABLESPACES ON database-alias CLP command.
returned.
Syntax
SNAP_GET_TBSP_QUIESCER (
dbname
, member

dbname
member
SNAP_GET_TBSP_QUIESCER table function takes a snapshot for the currently
948
Authorization
v EXECUTE privilege on the SNAP_GET_TBSP_QUIESCER table function
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve information about the quiesced table spaces for database member 1 for the
FROM TABLE( SYSPROC.SNAP_GET_TBSP_QUIESCER( , 1)) AS T

QUIESCER_OBJ_ID
QUIESCER_AUTH_ID
...
---------- --------------...- ---------------...- ----------------...- ...
USERSPACE1
2
5 SWALKTY
...

... -------------------- -------------- -------------...
65983 EXCLUSIVE
1
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TBSP_NAME
VARCHAR(128)

name
QUIESCER_TS_ID
BIGINT
quiescer_ts_id - Quiescer table

space identification
QUIESCER_OBJ_ID
BIGINT
quiescer_obj_id - Quiescer object

identification
949
SNAP_GET_TBSP_QUIESCER table function (continued)
monitor element
Column name
Data type
QUIESCER_AUTH_ID
VARCHAR(128)
quiescer_auth_id - Quiescer user

authorization identification
QUIESCER_AGENT_ID
BIGINT
quiescer_agent_id - Quiescer agent

identification
QUIESCER_STATE
VARCHAR(14)
quiescer_state - Quiescer state. This

based on defines in sqlutil.h and
is one of:
v EXCLUSIVE
v UPDATE
v SHARE
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

SNAP_GET_TBSP_RANGE table function - Retrieve range
The SNAPTBSP_RANGE administrative view and the SNAP_GET_TBSP_RANGE
table function return information from a range snapshot.
v SNAPTBSP_RANGE administrative view on page 918
v SNAP_GET_TBSP_RANGE table function on page 920
SNAPTBSP_RANGE administrative view

This administrative view allows you to retrieve range snapshot information for the
Used with the SNAPTBSP_QUIESCER administrative view and the
MON_GET_TABLESPACE and the MON_GET_CONTAINER table functions, the
SNAPTBSP_RANGE administrative view provides information equivalent to the
returned.
Authorization
950
v DBADM authority
v SQLADM authority
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Select information about table space ranges for all database members for the
RANGE_STRIPE_SET_NUMBER, RANGE_OFFSET, RANGE_MAX_PAGE,
RANGE_MAX_EXTENT, RANGE_START_STRIPE, RANGE_END_STRIPE,
RANGE_ADJUSTMENT, RANGE_NUM_CONTAINER, RANGE_CONTAINER_ID,
DBPARTITIONNUM FROM SYSIBMADM.SNAPTBSP_RANGE

TBSP_ID
-------...0
2
3
2
2
TBSP_NAME
RANGE_NUMBER
RANGE_STRIPE_SET_NUMBER ...
--------------- ------------...- ----------------------- ...
SYSCATSPACE
0
0 ...
USERSPACE1
0
0 ...
SYSTOOLSPACE
0
0 ...
USERSPACE1
0
0 ...
USERSPACE1
0
0 ...

... RANGE_OFFSET
RANGE_MAX_PAGE
RANGE_MAX_EXTENT
...
... ------------...- -------------------- -------------------- ...
...
0
11515
2878 ...
...
0
479
14 ...
...
0
251
62 ...
...
0
479
14 ...
...
0
479
14 ...

... RANGE_START_STRIPE
RANGE_END_STRIPE
RANGE_ADJUSTMENT
... -------------------- -------------------- -------------------...
0
2878
0
...
0
14
0
...
...
...
...
951
...
...
...
0
0
0
62
14
14
0 ...
0 ...
0 ...

... RANGE_NUM_CONTAINER RANGE_CONTAINER_ID
DBPARTITIONNUM
... -------------------- -------------------- -------------...
1
0
0
...
1
0
0
...
1
0
0
...
1
0
1
...
1
0
2

The SNAP_GET_TBSP_RANGE table function returns the same information as the
SNAPTBSP_RANGE administrative view, but allows you to retrieve the
SNAP_GET_TBSP_QUIESCER and SNAP_GET_CONTAINER table functions, the
SNAP_GET_TBSP_RANGE table function provides information equivalent to the
returned.
Syntax
SNAP_GET_TBSP_RANGE (
dbname
, member

dbname
member
952
SNAP_GET_TBSP_RANGE table function takes a snapshot for the currently

Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Examples
Select information about the table space range for the table space with tbsp_id = 2
RANGE_STRIPE_SET_NUMBER, RANGE_OFFSET, RANGE_MAX_PAGE, RANGE_MAX_EXTENT,
RANGE_START_STRIPE, RANGE_END_STRIPE, RANGE_ADJUSTMENT,
RANGE_NUM_CONTAINER, RANGE_CONTAINER_ID
FROM TABLE(SNAP_GET_TBSP_RANGE(,-1)) AS T WHERE TBSP_ID = 2

TBSP_ID
TBSP_NAME
RANGE_NUMBER
...
-------...- --------------- ------------...- ...
2 USERSPACE1
0 ...

... RANGE_STRIPE_SET_NUMBER RANGE_OFFSET
RANGE_MAX_PAGE
...
... ----------------------- ------------...- --------------...---- ...
...
0
0
3967 ...

... RANGE_MAX_EXTENT
RANGE_START_STRIPE
RANGE_END_STRIPE
...
... -------------------- -------------------- -------------------- ...
...
123
0
123 ...

... RANGE_ADJUSTMENT
RANGE_NUM_CONTAINER RANGE_CONTAINER_ID
... -------------------- -------------------- -------------------...
0
1
0
953
Table 227. Information returned by the SNAPTBSP_RANGE administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TBSP_ID
BIGINT

identification
TBSP_NAME
VARCHAR(128)

name
RANGE_NUMBER
BIGINT
range_number - Range number
RANGE_STRIPE_SET_NUMBER
BIGINT
range_stripe_set_number - Stripe
set number
RANGE_OFFSET
BIGINT
range_offset - Range offset
RANGE_MAX_PAGE
BIGINT
range_max_page_number Maximum page in range
RANGE_MAX_EXTENT
BIGINT
range_max_extent - Maximum
extent in range
RANGE_START_STRIPE
BIGINT
range_start_stripe - Start stripe
RANGE_END_STRIPE
BIGINT
range_end_stripe - End stripe
RANGE_ADJUSTMENT
BIGINT
range_adjustment - Range
adjustment
RANGE_NUM_CONTAINER
BIGINT
range_num_containers - Number
of containers in range
RANGE_CONTAINER_ID
BIGINT
range_container_id - Range
container
DBPARTITIONNUM
SMALLINT
SNAPUTIL_PROGRESS administrative view and

SNAP_GET_UTIL_PROGRESS table function - Retrieve progress
The SNAPUTIL_PROGRESS administrative view and the
SNAP_GET_UTIL_PROGRESS table function return snapshot information about
utility progress, in particular, the progress logical data group.
v SNAPUTIL_PROGRESS administrative view on page 922
v SNAP_GET_UTIL_PROGRESS table function on page 923

Used in conjunction with the SNAPUTIL administrative view, the
SNAPUTIL_PROGRESS administrative view provides the same information as the
954
returned.
Authorization
v SELECT privilege on the SNAPUTIL_PROGRESS administrative view
v CONTROL privilege on the SNAPUTIL_PROGRESS administrative view
v DBADM authority
v SQLADM authority
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve details on total and completed units of progress by utility ID.
DBPARTITIONNUM FROM SYSIBMADM.SNAPUTIL_PROGRESS

UTILITY_ID PROGRESS_TOTAL_UNITS PROGRESS_COMPLETED_UNITS DBPARTITIONNU
---------- -------------------- ------------------------ ------------7
10
5
0
9
10
5
1

The SNAP_GET_UTIL_PROGRESS table function returns the same information as
the SNAPUTIL_PROGRESS administrative view, but allows you to retrieve the
955
Used in conjunction with the SNAP_GET_UTIL table function, the

SNAP_GET_UTIL_PROGRESS table function provides the same information as the
returned.
Syntax
SNAP_GET_UTIL_PROGRESS (
member

member
applications.
SNAP_GET_UTIL_PROGRESS table function takes a snapshot for the currently
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve details on the progress of utilities on the currently connect member.
DBPARTITIONNUM FROM TABLE(SNAP_GET_UTIL_PROGRESS(-1)) as T
956

UTILITY_ID PROGRESS_TOTAL_UNITS PROGRESS_COMPLETED_UNITS DBPARTITIONNUM
---------- -------------------- ------------------------ -------------7
10
5
0
Table 228. Information returned by the SNAPUTIL_PROGRESS administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
UTILITY_ID
INTEGER

database partition.
PROGRESS_SEQ_NUM
INTEGER
progress_seq_num - Progress
sequence number. If serial, the
number of the phase. If concurrent,
then could be NULL.
UTILITY_STATE
VARCHAR(16)

and is one of:
v ERROR
v EXECUTE
v WAIT
PROGRESS_DESCRIPTION
VARCHAR(2048) progress_description - Progress

description
PROGRESS_START_TIME
TIMESTAMP
progress_start_time - Progress start

time. Start time if the phase has
started, otherwise NULL.
PROGRESS_WORK_METRIC
VARCHAR(16)
progress_work_metric - Progress
work metric. This interface returns
v NOT_SUPPORT
v BYTES
v EXTENTS
v INDEXES
v PAGES
v ROWS
v TABLES
PROGRESS_TOTAL_UNITS
BIGINT
progress_total_units - Total
progress work units
PROGRESS_COMPLETED_UNITS
BIGINT
progress_completed_units Completed progress work units
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
957
TOP_DYNAMIC_SQL administrative view - Retrieve information

about the top dynamic SQL statements
The TOP_DYNAMIC_SQL administrative view returns the top dynamic SQL
statements sortable by number of executions, average execution time, number of
sorts, or sorts per statement. These are the queries that should get focus to ensure
they are well tuned.
Authorization
v SELECT privilege on the TOP_DYNAMIC_SQL administrative view
v CONTROL privilege on the TOP_DYNAMIC_SQL administrative view
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Table 229. Information returned by the TOP_DYNAMIC_SQL administrative view
958
Column name
Data type
monitor element
SNAPSHOT_TIMESTAMP
TIMESTAMP
Timestamp for the report.
NUM_EXECUTIONS
BIGINT
num_executions - Statement
executions
AVERAGE_EXECUTION_TIME_S
BIGINT
Average execution time, in

seconds.
STMT_SORTS
BIGINT
SORTS_PER_EXECUTION
BIGINT
Number of sorts per statement

execution.
STMT_TEXT
CLOB(2 M)
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
Example
Identify the top 5 most frequently run SQL.
SELECT NUM_EXECUTIONS, AVERAGE_EXECUTION_TIME_S, STMT_SORTS,
SORTS_PER_EXECUTION, SUBSTR(STMT_TEXT,1,60) AS STMT_TEXT
FROM SYSIBMADM.TOP_DYNAMIC_SQL
ORDER BY NUM_EXECUTIONS DESC FETCH FIRST 5 ROWS ONLY

NUM_EXECUTIONS
AVERAGE_EXECUTION_TIME_S STMT_SORTS
...
-------------------- ------------------------ -------------------- ...
148
0
0 ...
123
0
0 ...
2
0
0 ...
1
0
0 ...
1
0
0 ...

... SORTS_PER_EXECUTION ...
... -------------------- ...
...
0 ...
...
0 ...
...
0 ...
...
0 ...
...
0 ...

...
...
...
...
...
...
...
STMT_TEXT
-----------------------------------------------------------SELECT A.ID, B.EMPNO, B.FIRSTNME, B.LASTNAME, A.DEPT FROM E
SELECT A.EMPNO, A.FIRSTNME, A.LASTNAME, B.LOCATION, B.MGRNO
SELECT A.EMPNO, A.FIRSTNME, A.LASTNAME, B.DEPTNAME FROM EMP
SELECT ATM.SCHEMA, ATM.NAME, ATM.CREATE_TIME, ATM.LAST_WAIT,
SELECT * FROM JESSICAE.EMP_RESUME
SQL procedure routines

ALTER_ROUTINE_PACKAGE procedure
This procedure alters values for the package associated with a compiled SQL
routine or a compiled trigger, without the need for rebinding.
It is functionally equivalent to the ALTER PACKAGE statement, except that it takes
an object name instead of a package name as an argument. The
ALTER_ROUTINE_PACKAGE procedure can be invoked from the command line
or called from an application.
ALTER_ROUTINE_PACKAGE (
type
schema
module
name
options
type
An input argument of type CHAR(2) that specifies the type of routine or
compiled trigger, using one of the following values:
v 'P ' for a procedure
959
v
v
v
v
'SP' for the specific name of a procedure

'F' for a compiled function
'SF' for a specific name of a compiled function
'T' for a compiled trigger
schema
An optional input argument of type VARCHAR(128), which specifies the
schema of the routine or trigger. If a schema is not specified, the value will
default to the value of the CURRENT SCHEMA special register. This parameter
is case sensitive.
module
An optional input argument of type VARCHAR(128), which specifies the name
of the module where the routine resides. This parameter cannot be specified
for triggers. If this parameter is not specified, then module routines are
ignored. This parameter is case sensitive.
name
An input argument of type VARCHAR(128), which specifies the name of the
routine or trigger. This parameter is case sensitive.
options
An input argument of type VARCHAR(1024), which specifies a list of any
options supported by the ALTER PACKAGE statement. At least one ALTER
PACKAGE clause must be supplied within the options parameter.
Authorization
One of the following authorities is required to execute the procedure:
v EXECUTE privilege on the procedure
v DBADM authority
v SQLADM authority

Examples
Alter the underlying package for an existing stored procedure by the name of
UPDATE_EMPLOYEE.
CALL SYSPROC.ALTER_ROUTINE_PACKAGE (P,,,UPDATE_EMPLOYEE,
ACCESS PLAN REUSE YES OPTIMIZATION PROFILE AYYANG.INDEXHINTS)
Alter the package for a compiled trigger called MIN_SALARY, in the DRICARD
schema.
CALL SYSPROC.ALTER_ROUTINE_PACKAGE (T,DRICARD,,MIN_SALARY,
OPTIMIZATION PROFILE AYYANG.INDEXHINTS)
Alter the package for a compiled function, using a three part name.
CALL SYSPROC.ALTER_ROUTINE_PACKAGE (F,DRICARD,MODULE,FUNCTION,APREUSE YES)
960
GET_ROUTINE_NAME procedure - get SQL PL object name

The GET_ROUTINE_NAME procedure returns the name of an SQL PL object given
the object's LIB_ID.
Authorization
v SQLADM authority
v DBADM authority

Syntax
GET_ROUTINE_NAME (
module ,
name ,
lib_id
specific_name
type
schema
Routine parameters
lib_id
An input argument of type INTEGER that specifies the LIB_ID corresponding
to a compiled SQL PL routine or trigger. This is the value of the SQLERRD(4)
field in the SQLCA for a runtime SQL PL error.
type
An output argument of type CHAR(1) that specifies the type of object that
raised the error, using one of the following values:
v 'P' for a procedure
v 'F' for a function
v 'T' for a trigger
schema
An output argument of type VARCHAR(128) that specifies the schema to
which the object belongs.
module
An output argument of type VARCHAR(128) that specifies the module to
which the object belongs. NULL if the object is a trigger or is not part of a
module.
name
An output argument of type VARCHAR(128) that specifies the name of the
object.
specific_name
An output argument of type VARCHAR(128) that specifies the specific name of
the object. NULL if the object is a trigger.
961
Usage notes
v When the SQLCA structure contains an error raised during the execution of an
SQL PL routine or trigger, the SQLCAID field has the value 'SQLCAM' and
SQLERRM(4) has a numeric value that uniquely identifies the object that raised
the error. This unique identifier corresponds to the LIB_ID column in the
SYSCAT.ROUTINES and SYSCAT.TRIGGERS catalog views. The
GET_ROUTINE_NAME routine maps a given LIB_ID value to the corresponding
object name.
v If the value provided in the first argument to SYSPROC.GET_ROUTINE_NAME
does not correspond to an SQL PL routine or trigger, the procedure returns
NULL in all the output parameters, indicating that the routine or trigger could
not be found.
Example
Assume the execution of an application finishes with an error described in the
following SQLCA structure:
SQLCA Information
sqlcaid : SQLCAM
sqlcabc: 136
...
sqlerrd : (1) 0
(2) 0
(4) 13152254 (5) 0
sqlcode: -801
(3) 3
(6) 0
...
sqlstate: 22012
The presence of SQLCAM in the SQLCAID field indicates that the error occurred
during the execution of an SQL PL object. The values of 3 and 13152254 in the
SQLERRD(3) and SQLERRD(4) fields indicate that the error originated in the
statement at line number 3 of the SQL PL object identified by the value 13152254.
To determine what the SQL PL object is, call the SYSPROC.GET_ROUTINE_NAME
in the following manner:
db2 call "GET_ROUTINE_NAME(13152254, ?, ?, ?, ?, ?)"
-------------------------Parameter Name : OBJTYPE
Parameter Value : P
Parameter Name : OBJSCHEMA
Parameter Value : APPDEV
Parameter Name : OBJMODULE
Parameter Value : Parameter Name : OBJNAME
Parameter Value : PROC2
Parameter Name : OBJSPECIFIC
Parameter Value : APPDEV_PROC2
Return Status = 0
The values of the OUT parameters from the call to

SYSPROC.GET_ROUTINE_NAME indicate that the error was raised from the
stored procedure APPDEV.PROC2.
962
GET_ROUTINE_OPTS
The GET_ROUTINE_OPTS function returns a character string value of the options
that are to be used for the creation of SQL procedures in the current session.
GET_ROUTINE_OPTS (
Authorization
v DBADM authority
v SQLADM authority

The result of the function is a varying-length character string (VARCHAR) value
with a length attribute of 1024.
Example
Return the options to be used for the creation of SQL procedures as the result of a
query.
SELECT GET_ROUTINE_OPTS()
FROM SYSIBM.SYSDUMMY1
GET_ROUTINE_SAR
The GET_ROUTINE_SAR procedure retrieves the necessary information to install
the same routine in another database server running the same level on the same
operating system. The information is retrieved into a single BLOB string
representing an SQL archive file.
GET_ROUTINE_SAR
(
sarblob , type

,
routine-name-string
)
,
hide-body-flag
The schema is SYSFUN.
Authorization
v DBADM authority
963
v SQLADM authority

sarblob
An output argument of type BLOB(3M) that contains the routine SAR file
contents.
type
An input argument of type CHAR(2) that specifies the type of routine, using
one of the following values:
v 'SP' for the specific name of a procedure
routine-name-string
An input argument of type VARCHAR(257) that specifies a qualified name of
the routine. If no schema name is specified, the default is the CURRENT
SCHEMA when the routine is processed. The routine-name-string cannot include
double quotation marks (").
hide-body-flag
An input argument of type INTEGER that specifies (using one of the following
values) whether or not the routine body should be hidden when the routine
text is extracted from the catalogs. Valid values are:
0
Leave the routine text intact. This is the default value.
Replace the routine body with an empty body when the routine text is
extracted from the catalogs.
The qualified name of the routine is used to determine which routine to retrieve.
The routine that is found must be an SQL routine. Not using a specific name may
result in more than one routine, and an error is raised (SQLSTATE 42725). If this
occurs, the specific name of the required routine must be used.
The SAR file must include a bind file, which may not be available at the server. If
the bind file cannot be found and stored in the SAR file, an error is raised
(SQLSTATE 55045).
PUT_ROUTINE_SAR
The PUT_ROUTINE_SAR procedure passes the necessary file to create an SQL
routine at the server and then defines the routine.
Authorization
One of the following authorizations is required to execute the procedure:
v DBADM authority
v SQLADM authority
964

PUT_ROUTINE_SAR (
sarblob
)
,
new-owner
use-register-flag
sarblob
An input argument of type BLOB(3M) that contains the routine SAR file
contents.
new-owner
An input argument of type VARCHAR(128) that contains an
authorization-name used for authorization checking of the routine. The
new-owner must have the necessary privileges for the routine to be defined. If
new-owner is not specified, the authorization-name of the original routine
definer is used.
use-register-flag
An input argument of type INTEGER that indicates whether or not the
CURRENT SCHEMA and CURRENT PATH special registers are used to define
the routine. If the special registers are not used, the settings for the default
schema and SQL path are the settings used when the routine was originally
defined. Possible values for use-register-flag:
0
Do not use the special registers of the current environment
Use the CURRENT SCHEMA and CURRENT PATH special registers.
If the value is 1, CURRENT SCHEMA is used for unqualified object names in

the routine definition (including the name of the routine) and CURRENT
PATH is used to resolve unqualified routines and data types in the routine
definition. If the use-registers-flag is not specified, the behavior is the same as if
a value of 0 was specified.
The identification information contained in sarblob is checked to confirm that the
inputs are appropriate for the environment, otherwise an error is raised
(SQLSTATE 55046). The PUT_ROUTINE_SAR procedure then uses the contents of
the sarblob to define the routine at the server.
The contents of the sarblob argument are extracted into the separate files that make
up the SQL archive file. The shared library and bind files are written to files in a
temporary directory. The environment is set so that the routine definition statement
processing is aware that compiling and linking are not required, and that the
location of the shared library and bind files is available. The contents of the DDL
file are then used to dynamically execute the routine definition statement.
No more than one procedure can be concurrently installed under a given schema.
Processing of this statement might result in the same errors as executing the
routine definition statement using other interfaces. During routine definition
processing, the presence of the shared library and bind files is noted and the
965
precompile, compile and link steps are skipped. The bind file is used during bind
processing and the contents of both files are copied to the usual directory for an
SQL routine.
If a GET ROUTINE or a PUT ROUTINE operation (or their corresponding
procedure) fails to execute successfully, it will always return an error (SQLSTATE
38000), along with diagnostic text providing information about the cause of the
failure. For example, if the procedure name provided to GET ROUTINE does not
identify an SQL procedure, diagnostic "-204, 42704" text will be returned, where
"-204" is the SQLCODE and "42704" is the SQLSTATE, that identify the cause of the
problem. The SQLCODE and SQLSTATE in this example indicate that the
procedure name provided in the GET ROUTINE command is undefined.
REBIND_ROUTINE_PACKAGE procedure - rebind a package

The REBIND_ROUTINE_PACKAGE procedure rebinds the package associated with
an SQL procedure, routine, compiled function, or trigger. It is functionally
equivalent to the REBIND command, except that it takes a procedure name,
instead of a package name, as an argument.
The REBIND_ROUTINE_PACKAGE procedure can be invoked from the command
line or called from an application.
Syntax
There are two equally valid methods to invoke REBIND_ROUTINE_PACKAGE.
The only difference between the two invocations is the method of specifying the
routine name. In the first instance, the routine-name-string variable consists of
identifier names separated by periods. In the second method, the routine is
identified by separate values for each of the schema, module and name values.
Method 1:
REBIND_ROUTINE_PACKAGE (
type
, routine-name-string
type
options
Method 2:
REBIND_ROUTINE_PACKAGE (
schema ,
module ,
name
options

)
type
An input argument of type CHAR(2) that specifies the type of routine or
compiled trigger, using one of the following values:
v 'SP' for the specific name of a procedure
v 'F' for a compiled function
v 'SF' for a specific name of a compiled function
v 'T' for a compiled trigger
966
routine-name-string (method 1 only)

An input argument of type VARCHAR(386) which specifies the name of the
routine or trigger. Trigger names consist of two parts separated by a period
and are in the format schema.trigger where the schema is optional. Routine
names consist of three part names separated by periods and are in the format
schema.module.routine where schema and module are optional. If schema is
not specified, the value defaults to the value of the CURRENT SCHEMA
special register. If a two-part name is specified, the first part is initially
interpreted as a schema name; if the routine is not found under that schema,
the first part is interpreted as a module name, and an attempt is made to find
the routine in a module of that name under the CURRENT SCHEMA. The
schema, module or object names cannot include double quotation marks (") or
periods(.).
schema (method 2 only)
An optional input argument of type VARCHAR(128) that specifies the schema
of the routine or trigger. If a schema is not specified, the value will default to
the value of the CURRENT SCHEMA special register. This parameter is case
sensitive.
module (method 2 only)
An optional input argument of type VARCHAR(128) that specifies the name of
the module where the routine resides. Do not specify this parameter for
triggers. Module routines are ignored if this parameter is not specified. This
name (method 2 only)
routine or trigger. This parameter is case sensitive.
options
An optional input argument of type VARCHAR(1024) which specifies any list
of rebind options following the REBIND command syntax. A single value of
ANY or CONSERVATIVE is also supported for backward compatibility
and is interpreted as the value for the RESOLVE rebind option.
The qualified name of the routine is used to determine which routine to retrieve.
The routine that is found must be an SQL routine; otherwise, an error is returned
(SQLSTATE 428F7). If a specific name is not used, more than one routine may be
found, and an error is returned (SQLSTATE 42725). If this occurs, the specific name
of the required routine must be used.
Authorization
v DBADM authority
v SQLADM authority

967
Examples
Example 1: Rebind the package of routine UPDATE_EMPLOYEE using the
RESOLVE, REOPT and APREUSE options.
Method 1:
CALL SYSPROC.REBIND_ROUTINE_PACKAGE (
P,UPDATE_EMPLOYEE,RESOLVE ANY REOPT ONCE APREUSE YES)
Method 2:
P,,,UPDATE_EMPLOYEE,RESOLVE ANY REOPT ONCE APREUSE YES)
Example 2: Rebind the package of routine UPDATE_EMPLOYEE with no options.

Method 1:
P,UPDATE_EMPLOYEE,)
Method 2:
P,,,UPDATE_EMPLOYEE,)
Example 3: Rebind the package of a compiled trigger.

Method 1:
T,DRICARD.MIN_SALARY,REOPT ALWAYS)
Method 2:
T,DRICARD,,MIN_SALARY,REOPT ALWAYS)
Example 4: Rebind the package of a compiled function using a three part name.
Method 1
F,DRICARD.MODULE.FUNCTION,REOPT ALWAYS)
Method 2
F,DRICARD,MODULE,FUNCTION,REOPT ALWAYS)
SET_ROUTINE_OPTS
The SET_ROUTINE_OPTS procedure sets the options that are to be used for the
creation of SQL procedures in the current session. This setting overrides the
instance-wide setting specified in the DB2_SQLROUTINE_PREPOPTS registry variable.
SET_ROUTINE_OPTS (
character-expression
Procedure parameter
character-expression
An input argument of type VARCHAR(1024) that specifies the options setting
for the current session.
Specified options are valid for the duration of the session. If the null value is
specified as the argument, the value of the DB2_SQLROUTINE_PREPOPTS registry
variable is restored as the default options setting for the current session. For a list
of the allowed options, see the description of the DB2_SQLROUTINE_PREPOPTS registry
variable under Query compiler variables.
968
Authorization
v DBADM authority
v SQLADM authority

Example 1: Set the options setting for the current session to NULL.
CALL SYSPROC.SET_ROUTINE_OPTS(CAST (NULL AS VARCHAR(1)))
Example 2: Set the options setting for the current session to EXPLAIN YES.
CALL SET_ROUTINE_OPTS(EXPLAIN YES)
Example 3: Set the options setting for the current session to EXPLAIN YES and
BLOCKING NO.
CALL SET_ROUTINE_OPTS(EXPLAIN YES BLOCKING NO)
Stepwise redistribute routines

ANALYZE_LOG_SPACE procedure - Retrieve log space analysis
information
The ANALYZE_LOG_SPACE procedure returns the log space analysis results for
each of the database partitions of the given database partition group.
Syntax
ANALYZE_LOG_SPACE (
inDBPGroup
analysisType , inStmgTime
, inMainTbSchema
, addDropOption
, inMainTable
, addDropList
, pNumber

,
pWeight )
inDBPGroup
An input argument of type VARCHAR (128) that specifies the database
partition group name.
inMainTbSchema
An input argument of type VARCHAR (128) that specifies the schema of the
main table
inMainTable
An input argument of type VARCHAR (128) that specifies the main table
within the database partition group, usually the largest table in the database
partition group.
969
analysisType
An input argument of type SMALLINT that specifies an indicator for analysis
type:
v SWRD_USE_STMG_TABLE (1): indicates that the information in the storage
management tables is used to find the table row count per database
partition. This type should only be used if the storage management tables
are setup, and at least one storage snapshot has been taken for the database
partition group that is to be redistributed.
v SWRD_USE_REALTIME_ANALYSIS (2): indicates that a SELECT query is
used to find the table row count per database partition.
inStmgTime
An input argument of type VARCHAR (26) that specifies the timestamp for the
storage management record. This parameter is ignored when analysisType is set
to SWRD_USE_REALTIME_ANALYSIS.
addDropOption
An input argument of type CHAR (1) that specifies database partitions are
being added or dropped:
v 'A': Adding database partitions.
v 'D': Dropping database partitions.
v 'N': No adding or dropping.
addDropList
An input argument of type VARCHAR (6000) that specifies the database
partitions to be added or dropped. This database partition numbers are
specified in a comma-separated string format and no spaces are allowed in the
string.
pNumber
An input argument of type VARCHAR (6000) that specifies all the database
partition numbers corresponding to the database partition weight. Each
database partition number is between 0 and 999, and the database partition
numbers are specified in a comma-separated string with no spaces in the
string.
pWeight
An input argument of type VARCHAR (6000) that specifies all the database
partition weights that the user has specified corresponding to the database
partition numbers in the pNumber string. Each database partition weight is a
number between 0 and 32767, and database partition weights are specified in a
comma-separated string with no spaces in the string.
Authorization
v SYSADM, SYSMON, SYSCTRL, or SYSMAINT
v EXECUTE privilege on the ANALYZE_LOG_SPACE procedure

Example
Analyze the effect of adding a database partition without applying the changes. In
the following case, the hypothesis is adding database partition 40, 50 and 60 to the
database partition group, and for database partitions 10,20,30,40,50,60, using a
970
target ratio of 1:2:1:2:1:2. Note that in this example, only partitions 10, 20 and 30
actually exist in the database partition group
CALL SYSPROC.ANALYZE_LOG_SPACE(IBMDEFAULTGROUP, TEST,
EMP, 2, , A, 40,50,60, 10,20,30,40,50,60,
1,2,1,2,1,2)
Analyze the effect of dropping a database partition without applying the changes.
In the following case, the hypothesis is dropping database partition 30 from the
database partition group, and redistributing the data in database partitions 10 and
20 using a target ratio of 1 : 1. Note that in this example, all database partitions 10,
20 and 30 should exist in the database partition group
CALL SYSPROC.ANALYZE_LOG_SPACE(IBMDEFAULTGROUP, TEST,
EMP, 2, , D, 30, 10,20,1,1)
Usage notes
-1 is used as an output value for parameters when their values cannot be
obtained.
The redistribute stored procedures and functions work only in partitioned database
environments, where a distribution key has been defined for each table.
The ANALYZE_LOG_SPACE procedure returns a result set (an open cursor) of the
log space analysis results, containing the following fields for each of the database
partitions of the given database partition group.
Table 230. Information returned by the ANALYZE_LOG_SPACE procedure
Column name
Column type
Description
PARTITION_NUM
SMALLINT
The database partition number of the log

space analysis.
TOTAL_LOG_SIZE
BIGINT
Total log space allocated in bytes, -1

indicates unlimited size.
AVAIL_LOG_SPACE
BIGINT
The amount of log space in bytes that is

free and can be used by the redistribute
process.
DATA_SKEW
BIGINT
The absolute value in bytes of the size of

data which is deviated from the target level.
REQ_LOG_SPACE
BIGINT
The amount of space in bytes required to

reach the wanted data distribution.
NUM_OF_STEPS
SMALLINT
The number of steps needed to reduce the

data skew to zero.
MAX_STEP_SIZE
BIGINT
The maximum amount of data in bytes that

can be moved at a time, without causing a
log full error.
GENERATE_DISTFILE procedure - Generate a data distribution

file
The GENERATE_DISTFILE procedure generates a data distribution file for the
given table and saves it under the given fileName.
971
Syntax
GENERATE_DISTFILE (
inTbSchema
, inTbName
, fileName
inTbSchema
An input argument of type VARCHAR (128) that specifies the table schema
name.
inTbName
An input argument of type VARCHAR (128) that specifies the table name.
fileName
An input or output argument of type VARCHAR (255) that specifies data
distribution file name. If the given file name is just a file name, the file will be
saved in the tmp sub-directory under the instance directory, and the full file
path name will be returned in the parameter.
Authorization
v EXECUTE privilege on the GENERATE_DISTFILE procedure.
v SELECT privilege on SYSCAT.TABLES, SYSCAT.COLUMNS, and the specified
table.
In addition, the fenced user ID must be able to create files in the tmp sub-directory
under the instance directory.

Example
Generate a data distribution file to be used by the redistribute process.
CALL SYSPROC.GENERATE_DISTFILE(TEST, EMP,
$HOME/sqllib/function/SAMPLE.IBMDEFAULTGROUP_swrdData.dst)"
Usage notes
GET_SWRD_SETTINGS procedure - Retrieve redistribute

information
The GET_SWRD_SETTINGS procedure reads the existing redistribute registry
records for the given database partition group.
Syntax
GET_SWRD_SETTINGS (
972
dbpgName
, matchingSpec
, redistMethod
pMapFile , distFile
, stepSize
nextStep , processState
, totalSteps
, pNumber
, pWeight
, stageSize
dbpgName
An input argument of type VARCHAR(128) that specifies the database
partition group name against which the redistribute process is to run.
matchingSpec
An input argument of type SMALLINT that specifies the bitwise field
identifier(s) from Table 231, indicating the target fields to be returned by the
output parameters. Those output parameters that are not required can be set to
null.
For example, if matchingSpec is set to 96, which is the integer value of
(REDIST_STAGE_SIZE | REDIST_NEXT_STEP), the caller of this function only
needs to provide stageSize and nextStep to receive the values, and the
remainder of the output parameters can be null.
Table 231. Bitwise field identifiers
Field Name
Hexadecimal value
Decimal value
REDIST_METHOD
0x0001<<0
REDIST_PMAP_FILE
0x0001<<1
REDIST_DIST_FILE
0x0001<<2
REDIST_STEP_SIZE
0x0001<<3
REDIST_NUM_STEPS
0x0001<<4
16
REDIST_STAGE_SIZE
0x0001<<5
32
REDIST_NEXT_STEP
0x0001<<6
64
REDIST_PROCESS_STATE
0x0001<<7
128
REDIST_PWEIGHT_START_NODE
0x0001<<8
256
REDIST_PWEIGHT
0x0001<<9
512
redistMethod
An output argument of type SMALLINT that specifies whether the redistribute
is to run using the data distribution file or the target distribution map. There
are two possible return values:
v 2: indicates that the redistribute process will work with a data distribution
file as input.
v 3: indicates that the redistribute process will work with a target distribution
map as input.
pMapFile
An output argument of type VARCHAR (255) that specifies the full path file
name of the target distribution map on the database server.
distFile
An output argument of type VARCHAR (255) that specifies the full path file
name of the data distribution file on the database server.
973
stepSize
An output argument of type BIGINT that specifies the maximum number of
rows that can be moved before a commit must be called to prevent a log full
situation. The number can be changed in each redistribution step.
totalSteps
An output argument of type SMALLINT that specifies the number of steps it
takes to completely redistribute the given database partition group.
stageSize
An output argument of type SMALLINT that specifies the number of steps to
be run consecutively.
nextStep
An output argument of type SMALLINT that specifies the index separating
which steps have been completed, and what still needs to be run.
processState
An output argument of type SMALLINT that indicates whether or not the
redistribute process will be stopped at the next check point. A check point is
placed at beginning of each redistribute step. If this argument is set to 1, the
step will not start; if the value is 0, the step will proceed.
pNumber
An output argument of type VARCHAR (6000) that might return a list of
comma-separated database partition numbers in a string format. These
partition numbers can be either the database partitions that are currently used
by the database partition group, or the ones to be added or dropped. The
sequence and the count of these partition numbers correspond to the target
partition weight returned by the pWeight variable.
pWeight
An output argument of type VARCHAR (6000) that might return a list of
comma-separated target database partition weight numbers. The sequence and
the count of these partition weights correspond to the partition numbers
returned by the pNumber variable.
Authorization
v
v
v
v

DBADM authority
SQLADM authority

Example
Report the content of the step wise redistribution plan for the given database
partition group.
CALL SYSPROC.GET_SWRD_SETTINGS
(IBMDEFAULTGROUP, 255, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
974
Usage note
SET_SWRD_SETTINGS procedure - Create or change redistribute

registry
The SET_SWRD_SETTINGS procedure creates or make changes to the redistribute
registry.
If the registry does not exist, it creates it and add records into it. If the registry
already exists, it uses overwriteSpec to identify which of the field values need to be
overwritten. The overwriteSpec field enables this function to take NULL inputs for
the fields that do not need to be updated.
Syntax
SET_SWRD_SETTINGS (
dbpgName
, overwriteSpec
pMapFile , distFile
, stepSize
, totalSteps
nextStep , processState
, pNumber
, pWeight
, redistMethod
, stageSize

dbpgName
An input argument of type VARCHAR(128) that specifies the database
partition group name against which the redistribute process is to run.
overwriteSpec
Bitwise field identifier(s) from Table 232 indicating the target fields to be
written or overwritten into the redistribute settings registry.
Table 232. Bitwise field identifiers
Field Name
Hexadecimal value
Decimal value
REDIST_METHOD
0x0001<<0
REDIST_PMAP_FILE
0x0001<<1
REDIST_DIST_FILE
0x0001<<2
REDIST_STEP_SIZE
0x0001<<3
REDIST_NUM_STEPS
0x0001<<4
16
REDIST_STAGE_SIZE
0x0001<<5
32
REDIST_NEXT_STEP
0x0001<<6
64
REDIST_PROCESS_STATE
0x0001<<7
128
REDIST_PWEIGHT_START_NODE
0x0001<<8
256
REDIST_PWEIGHT
0x0001<<9
512
redistMethod
An input argument of type SMALLINT that specifies whether the redistribute
is to run using the data distribution file or the target distribution map. The two
valid input values are:
975
v 2: indicate that the redistribute process will work with a data distribution
file as input.
v 3: indicate that the redistribute process will work with a target distribution
map as input.
pMapFile
An input argument of type VARCHAR (255) that specifies the full path file
name of the target distribution map on the database server.
distFile
An input argument of type VARCHAR (255) that specifies the full path file
name of the data distribution file on the database server..
stepSize
An input argument of type BIGINT that specifies the maximum number of
rows that can be moved before a commit must be called to prevent a log full
situation. The number can be changed in each redistribution step. The value
-2 can be used for stepSize to indicate that the number is unlimited.
totalSteps
An input argument of type SMALLINT that specifies the number of steps it
takes to completely redistribute the given database partition group. The value
-2 can be used totalSteps to indicate that the number is unlimited.
stageSize
An input argument of type SMALLINT that specifies the number of steps to be
run consecutively.
nextStep
An input argument of type SMALLINT that specifies the index separating
which steps have been completed, and what still needs to be run.
processState
An input argument of type SMALLINT that indicates whether or not the
redistribute process will be stopped at the next check point. A check point is
placed at beginning of each redistribute step. If this argument is set to 1, the
step will not start; if the value is 0, the step will proceed.
pNumber
An input argument of type VARCHAR (6000) that can contain a list of
comma-separated database partition numbers in a string format. These
partition numbers can be either the database partitions that are currently used
by the database partition group, or the ones to be added or dropped. The
sequence and the count of these partition numbers correspond to the target
partition weight returned by the pWeight variable. Each database partition
number is between 0 and 999, and there are no spaces are allowed in the
string.
pWeight
An input argument of type VARCHAR (6000) that can contain a
comma-separated string of all the database partition weights the user has
specified, corresponding to the database partition numbers in the pNumber
string. Each database partition weight is a number between 0 and 32767, and
no spaces are allowed in the string.
Authorization
976
v DBADM authority
v SQLADM authority

Example
Write a step wise redistribution plan into a registry. Setting processState to 1, might
cause a currently running step wise redistribute stored procedure to complete the
current step and stop, until this parameter is reset to 0, and the redistribute stored
procedure is called again.
CALL SYSPROC.SET_SWRD_SETTINGS(IBMDEFAULTGROUP, 255, 0, ,
$HOME/sqllib/function/TEST.IBMDEFAULTGROUP_swrdData.dst, 1000,
12, 2, 1, 0, 10,20,30, 50,50,50)
Usage notes
STEPWISE_REDISTRIBUTE_DBPG procedure - Redistribute part

of database partition group
The STEPWISE_REDISTRIBUTE_DBPG procedure redistributes part of the database
partition group according to the input specified for the procedure, and the setting
file created or updated by the SET_SWRD_SETTINGS procedure.
Syntax
STEPWISE_REDISTRIBUTE_DBPG (
inDBPGroup
, inStartingPoint
inNumSteps )

inDBPGroup
An input argument of type VARCHAR (128) that specifies the name of the
target database partition group.
inStartingPoint
An input argument of type SMALLINT that specifies the starting point to use.
If the parameter is set to a positive integer and is not NULL, the
STEPWISE_REDISTRIBUTE_DBPG procedure uses this value instead of using
the nextStep value specified in the setting file. This is a useful option when you
want to rerun the STEPWISE_REDISTRIBUTE_DBPG procedure from a
particular step. If the parameter is set to NULL, the nextStep value is used.
inNumSteps
An input argument of type SMALLINT that specifies the number of steps to
run. If the parameter is set to a positive integer and is not NULL, the
STEPWISE_REDISTRIBUTE_DBPG procedure uses this value instead of using
the stageSize value specified in the setting file. This is a useful option when you
want to rerun the STEPWISE_REDISTRIBUTE_DBPG procedure with a
977
different number of steps than what is specified in the settings. For example, if
there are five steps in a scheduled stage, and the redistribution process failed
at step 3, the STEPWISE_REDISTRIBUTE_DBPG procedure can be called to run
the remaining three steps once the error condition has been corrected. If the
parameter is set to NULL, the stageSize value is used. The value -2 can be used
in this procedure to indicate that the number is unlimited.
Note: There is no parameter for specifying the equivalent of the NOT ROLLFORWARD
RECOVERABLE option on the REDISTRIBUTE DATABASE PARTITION GROUP command.
Logging is always performed for row data redistribution performed when the
STEPWISE_REDISTRIBUTE_DBPG procedure is used.
Authorization
v EXECUTE privilege on the STEPWISE_REDISTRIBUTE_DBPG procedure
v SYSADM, SYSCTRL or DBADM

Example
Redistribute the database partition group "IBMDEFAULTGROUP" according to the
redistribution plan stored in the registry by the SET_SWRD_SETTINGS procedure.
It is starting with step 3 and redistributes the data until 2 steps in the
redistribution plan are completed.
CALL SYSPROC.STEPWISE_REDISTRIBUTE_DBPG(IBMDEFAULTGROUP, 3, 2)
For a full usage example of the stepwise redistribute procedures, refer to

Redistributing database partition groups using the
STEPWISE_REDISTRIBUTE_DBPG procedure in the Partitioning and Clustering
Guide.
Usage notes
If the registry value for processState is updated to 1 using the
SET_SWRD_SETTINGS procedure after the STEPWISE_REDISTRIBUTE_DBPG
procedure execution is started, the process stops at the beginning to the next step
and a warning message is returned.
As the SQL COMMIT statement is called by the redistribute process, running the
redistribute process under a Type-2 connection is not supported.
Storage management tool routines

CAPTURE_STORAGEMGMT_INFO procedure - Retrieve
storage-related information for a given root object
The CAPTURE_STORAGEMGMT_INFO procedure attempts to collect the
storage-related information for the given root object, as well as the storage objects
defined within its scope. All the storage objects are specified in the
SYSTOOLS.STMG_OBJECT_TYPE table.
978
Table 233. STMG_OBJECT_TYPE table

Column name
Data type
Nullable
Description
OBJ_TYPE
INTEGER
Integer value corresponds to a

type of storage object
v 0 - Database
v 1 - Database Partition Group
v 2 - Table Space
v 3 - Table Space Container
v 4 - Table
v 5 - Index
TYPE_NAME
VARCHAR
Descriptive name of the storage

object type
v STMG_DATABASE
v STMG_DBPGROUP
v STMG_TABLESPACE
v STMG_CONTAINER
v STMG_TABLE
v STMG_INDEX
Authorization
v EXECUTE privilege on the CAPTURE_STORAGEMGMT_INFO procedure.
v EXECUTE privilege on the SYSPROC.DB_PARTITIONS,
SYSPROC.MON_GET_TABLESPACE, SYSPROC.MON_GET_CONTAINER, and
SYSPROC.WLM_SET_CONN_ENV routines.
v SELECT privilege on SYSCAT.TABLES, SYSCAT.TABLESPACES,
SYSCAT.NODEGROUPDEF, SYSCAT.DATABASEPARTITIONS,
SYSCAT.DATAPARTITIONEXPRESSION, SYSCAT.INDEXES, and
SYSCAT.COLUMNS.

Syntax
CAPTURE_STORAGEMGMT_INFO (
in_rootType
, in_rootSchema
in_rootName )

in_rootType
An input argument of type SMALLINT. The valid option types are:
v 0 - Database
v 1 - Database Partition Group
v 2 - Table Space
v 4 - Table
v 5 - Index
979
The input argument cannot be null. If a null value is specified, an SQL0443

error with SQLSTATE 38553, and token DBA7617 is returned.
in_rootSchema
An input argument of type VARCHAR (128) that specifies the schema name of
the storage snapshot root object. A NULL value can be specified if the
in_rootType is a database, a database partition group, or a table space.
in_rootName
An input argument of type VARCHAR (128) that specifies the name of the root
object. The input argument cannot be null. If a null value is specified, an
SQL0443 error with SQLSTATE 38553, and token DBA7617 is returned.
Usage notes:
1. The following stored procedure should be used to create storage management
tables:
create_storagemgmt_tables(TABLESPACE_NAME) where 'TABLESPACE' is the
name of the table space, on which storage management tables would be
created.
(In case of a problem with the existing storage management tables, it can be
dropped using the following stored procedure and can be re-created using the
preceding stored procedure.
drop_storagemgmt_tables(0 or 1) where '0' indicates 'stop' and '1' indicates
'proceed' on encountering an error.)
2. The following command should be used to run statistics for the storage object
for which details have to be obtained:
RUNSTATS ON TABLE (TABLESCHEMA.TABLENAME) ON KEY COLUMNS AND INDEXES ALL
3. The following command should be used to populate the storage management
tables:
Run 'capture_storagemgmt_info()' stored procedure to populate the storage
management tables. Sometimes it might be necessary to run the
CAPTURE_STORAGEMGMT_INFO procedure twice. The first time you run it,
use the CAPTURE_STORAGEMGMT_INFO procedure to populate the storage
tables with table space details. For example:
db2 "call capture_storagemgmt_info(0,<SCHEMA_NAME>,<DATABASE_NAME>)"
The second time, use the CAPTURE_STORAGEMGMT_INFO procedure to add
details about the storage of the actual object to the storage table. For example,
the following example adds details for an object of type index (the in_rootType
argument is set to 5):
db2 "call
capture_storagemgmt_info(5,<SCHEMA_NAME>,<SCHEMA_NAME.INDEX_NAME>)"
4. Run the select query on the required storage management table to see the
details of the storage object, for example: as follows in case of INDEX object :
db2 "SELECT * FROM SYSTOOLS.STMG_INDEX"
CREATE_STORAGEMGMT_TABLES procedure - Create storage

management tables
The CREATE_STORAGEMGMT_TABLES procedure creates all storage
management tables under a fixed "DB2TOOLS" schema, in the table space specified
by input.
980
Syntax
CREATE_STORAGEMGMT_TABLES (
in_tbspace
in_tbspace
An input argument of type VARCHAR(128) that specifies the table space name.
The input argument cannot be null. If a null value is specified, an SQL0443
error with SQLSTATE 38553, and token DBA7617 is returned.
Authorization
EXECUTE privilege on the CREATE_STORAGEMGMT_TABLES procedure.
You must also have CREATETAB privilege on the database and USE privilege on
the table space, and one of:
v IMPLICIT_SCHEMA authority on the database, if the implicit or explicit schema
name DB2TOOLS does not exist.
v CREATEIN privilege on the schema, if the schema name of the table exists.
v DBADM authority

Usage notes
The following tables are created in the DB2TOOLS schema:
v STMG_CONTAINER
v STMG_CURR_THRESHOLD
v STMG_DATABASE
v STMG_DBPARTITION
v STMG_DBPGROUP
v
v
v
v
v
STMG_HIST_THRESHOLD
STMG_INDEX
STMG_OBJECT
STMG_OBJECT_TYPE
STMG_ROOT_OBJECT
v STMG_TABLE
v STMG_TABLESPACE
v STMG_TBPARTITION
v STMG_THRESHOLD_REGISTRY
DROP_STORAGEMGMT_TABLES procedure - Drop all storage

management tables
The DROP_STORAGEMGMT_TABLES procedure attempts to drop all storage
management tables.
981
Syntax
DROP_STORAGEMGMT_TABLES (
dropSpec
dropSpec
An input argument of type SMALLINT. When dropSpec is set to 0, the process
stops when any error is encountered; when dropSpec is set to 1, the process
continues, ignoring any error it encounters. The input argument cannot be null.
If a null value is specified, an SQL0443 error with SQLSTATE 38553, and token
DBA7617 is returned.
Authorization
EXECUTE privilege on the DROP_STORAGEMGMT_TABLES procedure.
The user ID that establishes the database connection must either be the definer of
the storage management tables as recorded in the DEFINER column of
SYSCAT.TABLES, or have at least one of the following privileges:
v DBADM authority
v DROPIN privilege on the schema for these tables
v CONTROL privilege on these tables

Text Search routines

SYSTS_ADMIN_CMD procedure - Run text search administration
commands
The SYSTS_ADMIN_CMD procedure is used by applications to run text search
administrative commands using the SQL CALL statement.
Authorization
EXECUTE privilege on the SYSTS_ADMIN_CMD procedure and the required
authorization as listed for the requested operation.

Syntax
SYSTS_ADMIN_CMD (
command-string
982
message-locale
message
command-string
An input argument of type VARCHAR (32 K) that specifies a single DB2 Text
Search index administration command to be executed. The command syntax is
the same as the DB2 Text Search command except for the connection options,
which are not supported through this procedure. Commands that you issue
through this procedure use the current connection.
The procedure supports the following DB2 Text Search commands:
v ALTER INDEX
v CLEAR COMMAND LOCKS
v
v
v
v
v
v
v
CLEAR EVENTS
CREATE INDEX
DISABLE DATABASE
DROP INDEX
ENABLE DATABASE
RESET PENDING
UPDATE INDEX
message-locale
An input argument of type VARCHAR(33) that specifies the language for any
error message text that is returned. If the argument is null or an empty string
or the message files for the specified locale are not available on the server,
'en_US' is used.
message
An output argument of type VARCHAR(32K) that specifies a warning or
informational message for an operation that is considered successful.
Example
The following example updates the MYTEXTINDEX text search index in schema
DB2TS and returns any error messages in English:
CALL SYSPROC.SYSTS_ADMIN_CMD
(UPDATE INDEX DB2TS.MYTEXTINDEX FOR TEXT,en_US, ?)";

-------------------------Parameter Name : MESSAGE
Parameter Value : CIE00001 Operation completed successfully.
Return Status = 0
Usage notes
If the command does not run successfully, SQLCODE -20427 and SQLSTATE 38H14
are returned with the text-search-specific error message. For example, if index
MYTEXTINDEX exists and the following statement is issued:
CALL SYSPROC.SYSTS_ADMIN_CMD (CREATE INDEX MYTEXTINDEX FOR TEXT
ON DB2TS.TEXTBOOKS (STORY), en_US, ?)
Index creation fails with the following error message:

SQL20427N An error occurred during a text search administration
procedure or command. The error message is "CIE00201 Text search
index "DB2TS "."MYTEXTINDEX" already exists. ". SQLSTATE=38H14
983
If an SQLCODE is returned by the procedure, the message might be truncated. Full

message information is in the db2diag log files.
SYSTS_ALTER procedure - Change the update characteristics of

an index
This procedure is used to change the update characteristics of an index.
The procedure issues an ALTER INDEX text search administration command on the
database server.
Authorization
the SYSTS_MGR role and at least one of the following authorities:
v DBADM authority
v ALTERIN privilege on base schema
v CONTROL or ALTER privilege on the base table on which the text search index
is defined
To change an existing schedule, the authorization ID must be the same as the index
creator, or must have DBADM authority.

None
Syntax
SYSTS_ALTER (
options
index_schema
, index_name
message_locale
, message
update characteristics

update characteristics:

UPDATE FREQUENCY
NONE
update frequency

UPDATE MINIMUM minchanges
update frequency:
,
D (
) H (
,
integer1
984
) M ( integer3
*
,
integer2
options:
index configuration options

activation options
index configuration options:
INDEX CONFIGURATION (
option-value
option-value:
UPDATEAUTOCOMMIT
commitcount_number
commitsize
COMMITTYPE committype
COMMITCYCLES commitcycles
activation options:
SET
ACTIVE
INACTIVE
UNILATERAL
index_schema
text search index. The index_schema must follow the naming restriction for DB2
schema names. If the argument is null or an empty string, the value of the
current schema is used. The index_schema is case-sensitive.
index_name
index. Together with index_schema, it uniquely identifies a text search index in
a database. The index_name is case-sensitive.
An input argument of type VARCHAR(32K) that specifies the alter options.
The following alter options are allowed:
UPDATE FREQUENCY
Specifies the frequency with which index updates are made. The indexes
are updated if the number of changes is at least the value that is set for
UPDATE MINIMUM. The update frequency NONE indicates that no further index
updates are made. This can be useful for a text column in a table with data
that does not change. It is also useful if you intend to manually update the
index by using the UPDATE INDEX command. You can do automatic updates
if the DB2_ATS_ENABLE registry variable is set and you issue the START
FOR TEXT command.
985
The default frequency value is taken from the view

SYSIBMTS.TSDEFAULTS, where
DEFAULTNAME='UPDATEFREQUENCY'.
NONE
No automatic updates are applied to the text index. You must start any
further index updates manually.
D
The days of the week when the index is updated.

*
Every day of the week.
integer1
Specific days of the week, from Sunday to Saturday: 0 - 6
H
The hours of the specified days when the index is updated.

*
Every hour of the day.
integer2
Specific hours of the day, from midnight to 11 pm: 0 - 23
M
The minutes of the specified hours when the index is updated.

integer3
If you do not specify the UPDATE FREQUENCY option, the frequency settings
are unchanged.
Specifies the minimum number of changes to text documents that must
occur before the index is incrementally updated. Multiple changes to the
same text document are treated as separate changes. If you do not specify
the UPDATE MINIMUM option, the setting is unchanged.
INDEX CONFIGURATION (option-value)
This is an optional input argument of type VARCHAR(32K) that allows
altering text index configuration settings. The following options are supported:
Table 234. Specifications for option-value
Option
Value
Data type
Description
SERIALUPDATE
updatemode
Integer
Specifies whether the update processing

for a partitioned text search index must
be run in parallel or in serial mode. In
parallel mode the execution is distributed
to the database partitions and issues
independently on each node. In serial
mode the execution is run without
distribution and stops when a failure is
encountered. Serial mode execution
usually takes longer but requires less
resources.
v 0 = parallel mode
v 1 = serial mode
986
Table 234. Specifications for option-value (continued)

Option
Value
Data type
Description
UPDATEAUTOCOMMIT
commitsize
String
Specifies the number of rows or number

of hours after which a commit is run to
automatically preserve the previous work
for either initial or incremental updates.
If you specify the number of rows:
v After the number of documents that
are updated reaches the
COMMITCOUNT number, the server
applies a commit. COMMITCOUNT
counts the number of documents that
are updated by using the primary key,
not the number of staging table entries.
If you specify the number of hours:
v The text index is committed after the
specified number of hours is reached.
The maximum number of hours is 24.
For initial updates, the index update
processes batches of documents from the
base table. After the commitsize value is
reached, update processing completes a
COMMIT operation and the last
processed key is saved in the staging
table with operational identifier '4'. This
key is used to restart update processing
either after a failure or after the number
of specified commitcycles are completed. If
a commitcycles is specified, the update
mode is modified to incremental to
initiate capturing changes by using the
LOGTYPE BASIC option to create triggers on
the text table. However, until the initial
update is complete, log entries that are
generated by documents that have not
been processed in a previous cycle are
removed from the staging table.
Using the UPDATEAUTOCOMMIT option for an
initial text index update leads to a
significant increase of execution time.
For incremental updates, log entries that
are processed are removed
correspondingly from the staging table
with each interim commit.
COMMITTYPE
committype
String
Specifies rows or hours for the

UPDATEAUTOCOMMIT index configuration
option. The default is rows.
987
Table 234. Specifications for option-value (continued)

Option
Value
Data type
Description
COMMITCYCLES
commitcycles
Integer
Specifies the number of commit cycles.

The default is 0 for unlimited cycles.
If you do not explicitly specify cycles, the
update operation uses as many cycles as
required based on the batch size that you
specified with the UPDATEAUTOCOMMIT
option to finish the update processing.
You can use this option with the
UPDATEAUTOCOMMIT setting with a
committype.
activation options
Specifies an input argument of type integer that sets the status of a text index.
ACTIVE
Sets the text index status to active.
INACTIVE
Sets the text index status to inactive.
UNILATERAL
Specifies a unilateral change that affects the status of DB2 Text Search
indexes. If you specify this argument, only the status of a DB2 Text Search
index is changed to active or inactive. Without the UNILATERAL argument,
the activation status of the DB2 Text Search and DB2 Net Search Extender
indexes is jointly switched so that only one of the text indexes is active.
message_locale
An input argument of type VARCHAR(33) that specifies the locale to be used
for any error message returned. If the argument is null or an empty string, or
the message files for the specified locale are not available on the server, 'en_US'
is used.
message
informational message for a successfully completed operation.
Examples
Example 1: In the following example, the update characteristics of a text search
index are being altered. This index was originally created with index_schema
db2ts and index_name myTextIndex. By using 'UPDATE FREQUENCY NONE',
the intention is to make no further updates to the text search index as possibly no
changes are expected for the associated table column. Any error messages are
requested to be returned in English. When the procedure is complete, a success
message is returned to the caller.
CALL SYSPROC.SYSTS_ALTER(db2ts, myTextIndex,
UPDATE FREQUENCY NONE, en_US, ?)
The following example is of output from this query.
988

Parameter Value : Operation completed successfully.
Return Status = 0
Example 2: In the following example, the SYSTS_ALTER stored procedure is called

to alter the update-characteristics for a text search index with index_schema db2ts
and index_name myTextIndex2. The intention is to ensure that updates to the
index occur every hour on the hour. However, in this example the index does not
exist and results in an error.
CALL SYSPROC.SYSTS_ALTER(db2ts, myTextIndex2,
update frequency D(*) H(*) M(0), en_US, ?)
The following example is of output from this query.

index "db2ts"."myTextIndex2" does not exist. ". SQLSTATE 38H14
Usage notes
v Text search administration procedures use an existing connection to the
database. You should commit all transaction changes before issuing a text search
administration procedure to avoid any unexpected impact from a commit or
rollback. One way to achieve this is to turn on AUTOCOMMIT.
v You cannot run multiple procedures or commands concurrently on a text search
index if they might conflict. Some of the conflicting procedures and commands
are:
SYSTS_ALTER procedure or ALTER INDEX db2ts command
SYSTS_CLEAR_EVENTS procedure or CLEAR EVENTS FOR INDEX db2ts
command
SYSTS_DISABLE procedure or DISABLE DATABASE FOR TEXT db2ts
command
SYSTS_DROP procedure or DROP INDEX db2ts command
SYSTS_UPDATE procedure or UPDATE INDEX db2ts command
If there is a conflict, the procedure returns an SQLCODE -20426 and SQLSTATE
38H13.
v When you run this procedure to change the frequency, a schedule task is
created, updated or dropped for the text index.
v The result of activating indexes depends on the original index status. The
following table describes the results.
Table 235. Status changes without invalid index:
Initial DB2 Text
Search or Net
Search Extender
Status
Request
Active
Request Active
Unilateral
Request
Inactive
Request Inactive
Unilateral
Active / Inactive
No change
No change
Inactive /
Active
Inactive /
Inactive
Inactive / Active
Active /
Inactive
Error
No change
No change
989
Table 235. Status changes without invalid index: (continued)

Initial DB2 Text
Search or Net
Search Extender
Status
Inactive / Inactive
Request
Active
Request Active
Unilateral
Request
Inactive
Request Inactive
Unilateral
Active /
Inactive
Active / Inactive
Inactive /
Active
No change
SQL20427N and CIE0379E error messages are returned for active index conflicts.
You can specify the UPDATEAUTOCOMMIT index configuration option without type and
cycles for compatibility with an earlier version. This index configuration option is
associated by default with the COMMITTYPE rows option and unrestricted cycles.
The UPDATEAUTOCOMMIT, COMMITTYPE, and COMMITSIZE index configuration options are
also specified for an UPDATE INDEX operation to override the configured values.
Values that you submit for a specific update operation are applied only once and
not persisted.
SYSTS_CLEANUP procedure - Remove invalid text search

indexes
This procedure removes invalid text search indexes and their associated collections
from the database. An index can become invalid when database operations are
executed that affect all of the table content, for example, truncate.
The procedure serves as an alternative to the db2ts CLEANUP FOR TEXT command
for the database scope. To remove obsolete collections on the instance level, the
command must be used.
Authorization
The privileges held by the authorization ID of the statement must include the
SYSTS_ADM role with DBADM and DATAACCESS authority.

None
Syntax
SYSTS_CLEANUP (
options
, message_locale
, message
options
An input argument of type VARCHAR(32K). Only a NULL or an empty
parameter is accepted. Reserved for internal IBM use.
message_locale
is used.
990
message
Example
Example 1: In the following example, all invalid text search indexes in the current
database are dropped. The message language is set to English, and when the
procedure succeeds, the output parameter message indicative of the successful
operation is returned to the caller.
CALL SYSPROC.SYSTS_CLEANUP(, en_US, ?)
Return Status = 0
Example 2: Output where an error is returned:

SQL0462W Command or routine "SYSTS_CLEANUP" (specific name "*N") has returned a
warning SQLSTATE, with diagnostic text "CIE00212W 2 of 20 collections could not be
deleted. Check db2diag.log for details.". SQLSTATE=01H14
SYSTS_CLEAR_COMMANDLOCKS procedure - Remove

command locks for text search indexes
This procedure removes all command locks for a specific text search index or for
all text search indexes in the database.
Authorization
The privileges held by the authorization ID of the statement used to clear locks on
the index must include both of the following authorities:
v SYSTS_MGR role
v DBADM authority or CONTROL privilege on the base table on which the index
is defined
The privileges held by the authorization ID of the statement used to clear locks on
the database connection must include the SYSTS_ADM role.

None
A command lock is created at the beginning of a text search index command, and
is destroyed when the command has completed. It prevents undesirable conflict
between different commands. Use of this procedure is required in the rare case that
locks remain in place due to an unexpected system behavior, and need to be
cleaned up explicitly.
This procedure issues the CLEAR COMMAND LOCKS text search administration
command on the database server.
Syntax
SYSTS_CLEAR_COMMANDLOCKS (
index_schema
index_name
991
message_locale , message
index_schema
text index. The index_schema must follow the naming restriction for DB2
schema names. If the argument is null or an empty string, the value of
CURRENT SCHEMA is used. The index_schema is case-sensitive.
index_name
a database. If the argument is null or an empty string, the procedure deletes
command locks for all text search indexes in the database. The index_name is
case-sensitive.
message_locale
is used.
message
Examples
Example 1: In the following example, SYSTS_CLEAR_COMMANDLOCKS is issued
for a text search index with index_schema db2ts and index_name myTextIndex.
Error messages are requested to be returned in English. When the procedure
succeeds, the output parameter message indicative of the successful operation is
returned to the caller.
CALL SYSPROC.SYSTS_CLEAR_COMMANDLOCKS(db2ts, myTextIndex, en_US, ?)

Return Status = 0
Example 2: In the following example, SYSTS_CLEAR_COMMANDLOCKS is called

to clear the command locks for a text search index with index_schema db2ts and
index_name myTextIndex2. This index does not exist and the procedure returns an
error message.
CALL SYSPROC.SYSTS_CLEAR_COMMANDLOCKS(db2ts, myTextIndex2, en_US, ?)

992
Usage notes
database. It is recommended to commit all transaction changes before executing
a text search administration procedure to avoid any unexpected impact from a
commit or rollback in the procedure. One way to achieve this is to turn on
AUTOCOMMIT.
v You would invoke this procedure because the process owning the command lock
is dead. In this case, the command (represented by the lock) may not have
completed, and the index may not be operational. You need to take appropriate
action. For example, the process executing the DROP INDEX command dies
suddenly. It has deleted some index data, but not all the catalog and collection
information. The command lock is left intact. After clearing the DROP INDEX
command lock, you may want to re-execute the SYSTS_DROP procedure. In
another example, the process executing the UPDATE INDEX command is
interrupted. It has processed some documents, but not all, and the command
lock is still in place. After reviewing the text search index status and clearing the
UPDATE INDEX command lock, you can re-execute the UPDATE INDEX
command.
v When this procedure is run, the content of the DB2 Text Search view
SYSIBMTS.TSLOCKS is updated.
SYSTS_CLEAR_EVENTS procedure - Delete indexing events

from an index's event table
This procedure deletes indexing events from an index's event table used for
administration.
The name of the event table can be found in the view SYSIBMTS.TSINDEXES in
column EVENTVIEWNAME. Every index update operation that processes at least
one document produces informational and, in some cases, error entries in the event
table. For automatic updates, the event table has to be regularly inspected.
Document specific errors must be corrected by changing the document content.
After correcting the errors, the events can be cleared (and should be, in order not
to consume too much space).
The procedure issues a CLEAR EVENTS FOR INDEX text search administration
Authorization
The privileges held by the authorization ID of the statement must include both of
the following authorities:
v SYSTS_MGR role
v DBADM with DATAACCESS authority or CONTROL privilege on the table on
which the index is defined

None
Syntax
SYSTS_CLEAR_EVENTS (
index_schema
index_name
993
index_schema
index_name
message_locale
is used.
message
Examples
Example 1: In the following example, SYSTS_CLEAR_EVENTS is being called for a
text search index that was created with index_schema db2ts and index_name
myTextIndex. Any error messages are requested to be returned in English. When
the procedure succeeds, the output parameter message indicative of the successful
operation is returned to the caller.
CALL SYSPROC.SYSTS_CLEAR_EVENTS(db2ts, myTextIndex, en_US, ?)

Return Status = 0
Example 2: In the following example, SYSTS_CLEAR_EVENTS is called to clear the

event table entries for a text search index with index_schema db2ts and
index_name myTextIndex2. This index does not exist and results in an error.
CALL SYSPROC.SYSTS_CLEAR_EVENTS(db2ts, myTextIndex2, en_US, ?)

Usage notes
database. The current transaction might be committed or rolled back depending
994
on the completion of the procedures. As such, you might want to commit all
transaction changes to avoid any unexpected impact from such a commit or
v Multiple procedures or commands cannot be run concurrently on a text search
index if they might conflict. Some of the conflicting procedures and commands
are:
SYSTS_ALTER procedure or ALTER INDEX db2ts command
SYSTS_DISABLE procedure or DISABLE DATABASE FOR TEXT db2ts
command
SYSTS_DROP procedure or DROP INDEX db2ts command
SYSTS_UPDATE procedure or UPDATE INDEX db2ts command
38H13.
v When regular updates are scheduled (see UPDATE FREQUENCY options in
SYSTS_CREATE or SYSTS_ALTER procedures), the event table should be
checked regularly.
v To clean up the DB2 Text Search event table for a text search index, use the
SYSTS_CLEAR_EVENTS procedure or CLEAR EVENTS FOR INDEX db2ts command
after you have checked the reason for the event and removed the source of the
error.
v Ensure that changes have been made to all rows referenced in the event table.
By changing the rows in the user table, you ensure that when you run the
SYSTS_UPDATE procedure or UPDATE INDEX db2ts command again, an attempt is
made to index the erroneous documents again.
v When this command is issued, the event table is cleared.
SYSTS_CONFIGURE procedure - Configure current database for

text search
The SYSTS_CONFIGURE procedure applies text search server connection information
to the text search catalog.
Certain text search server properties have to be reflected in the text search
administration tables (text search catalog). These properties are associated with a
text index when the index is created. When parameters such as the token are
updated periodically, the change has to be reflected in the database and the
properties for all the indexes have to be updated as well.
This procedure is required initially for:
v
v
v
v
Incomplete enablement
Stand-alone text search server setups
Partitioned databases
and further on, following any updates to text search server connection
information
For subsequent updates, ensure that no text search administrative operation is

active and shut down the currently configured text search server.
During database enablement the SYSIBMTS.TSSERVER administrative view is
updated with connection information for the integrated text search server. Review
and update the text server information in the SYSIBMTS.TSSERVER view with the
relevant text search server data and run the SYSTS_CONFIGURE procedure to
995
apply the updated information. For multiple databases in the instance, configure
each database with the information for the same text search server.
Generally the sequence of operations is as follows:
1. Configure a text search server. Integrated text search servers can be configured
during installation or when a DB2 instance is created. A stand-alone text search
server is configured separately.
2. Enable a database for text search by using the db2ts ENABLE command, or the
SYSTS_ENABLE or SYSTS_ADMIN_CMD procedures with the ENABLE option.
3. Determine parameters for the text search server as needed for the
SYSIBMTS.TSSERVERS view.
4. Update the SYSIBMTS.TSSERVERS administrative view with the parameters for
the text search server.
v If the view is empty then use an INSERT statement. For example:
INSERT INTO SYSIBMTS.TSSERVERS (HOST, PORT, TOKEN, SERVERSTATUS)
VALUES (localhost, 55000, 9kfsjg48=, 0);
v If the view already contains a row then use a SQL UPDATE statement. For
example:
UPDATE SYSIBMTS.TSSERVERS SET (HOST, PORT, TOKEN) =
(tsmach1.ibm.com, 55002, k3j4fjk9u=)
5. Execute the SYSTS_CONFIGURE procedure.
Authorization
SYSTS_ADM role.

None
Syntax
SYSTS_CONFIGURE (
options ,
message-locale
message
Procedure parameter
options
An input argument of type VARCHAR(32K) that specifies the options to be
used. If no options are needed, the argument can be null or an empty string.
message-locale
for any returned error message. If the argument is null, an empty string or the
message files for the specified locale are not available on the server, en_US is
used.
message
informational message for an operation that is considered successful.
996
Example
Example 1: Prepare a database for text search services and return any messages in
English.
CALL SYSTS_ENABLE(, en_US, ?)"
INSERT INTO SYSIBMTS.TSSERVERS
(HOST,PORT,TOKEN,KEY,LOCALE,SERVERTYPE,SERVERSTATUS)
VALUES (tsmach1.ibm.com, 55000, 9kfsjg48=, en_US, 0);
CALL SYSPROC.SYSTS_CONFIGURE(, en_US, ?)
An example of output from this query:

Return Status = 0
Usage notes
v A SYSIBMTS.TSSERVERS view is created when a database is enabled for text
search. This view is updated with information about the integrated text search
server during database enablement. If the text search server configuration cannot
be obtained, the enable operation will end with an 'incomplete enablement'
warning.
v The SYSTS_CONFIGURE procedure must be issued anytime a row is inserted or
updated into SYSIBMTS.TSSERVERS. Make sure that no text search
administration operation is active and shut down the text search server before
updating SYSIBMTS.TSSERVERS.
v When updating SYSIBMTS.TSSERVERS in a database, all text search enabled
databases should be updated with the same parameters. Only a single text
search server is supported with a given DB2 instance.
v Running the SYSTS_CONFIGURE procedure for a database registers the use of the
configured text search server for the instance. Not running the procedure does
not result in a severe error but the response to some commands can be
unexpected.
v Multiple procedures or commands cannot be executed concurrently on a text
search index if they might conflict. Some of the conflicting procedures and
commands are:
38H13.
v Certain aspects relating to the text search installation and DB2 instance
configuration for text search have to be updated. They include:
An indication whether the search server utilized by the DB2 instance is
integrated (configured by DB2 as part of the DB2 instance), or if it is a
separate stand-alone installation of the ECMTS server.
An indication if the text search setup is enabled for rich text support.
997
SYSTS_CREATE procedure - Create a text search index on a

column
The SYSTS_CREATE procedure creates a text search index for a text column by
issuing the DB2 Text Search CREATE INDEX command on the database server. After
you create and update a text search index, you can search the column data by
using text search functions.
The index does not contain any data until an index update operation is processed.
You can start the update operation by using the stored procedure interface or the
command-line interface. For the latter, you can explicitly issue the DB2 Text Search
UPDATE INDEX command, or the command is implicitly issued by the DB2
Administrative Task Scheduler, according to the update frequency defined for the
index
Authorization
The authorization ID of the statement must include the SYSTS_MGR role and
CREATETAB authority on the database and one of the following privileges or
authority:
v CONTROL privilege on the table on which the index will be defined
v INDEX privilege on the table on which the index will be defined and one of the
IMPLICIT_SCHEMA authority on the database, if the implicit or explicit
schema name of the index does not exist
CREATEIN privilege on the schema, if the schema name of the index exists
v DBADM authority

None
Syntax
SYSTS_CREATE (
options
index_schema
message_locale
, index_name
,
message
text source
table-name
text column name:

column-name
function-name (column-name)
options:
998
text column name

text source:
table-schema
text default information

storage options
index configuration options
partition options
text default information:
CODEPAGE code-page
LANGUAGE
language
FORMAT
format
update characteristics:

UPDATE FREQUENCY
NONE
update frequency
incremental update characteristics
update frequency:
,
D (
) H (
) M ( integer3
integer1
integer2
incremental update characteristics:
storage options:

COLLECTION DIRECTORY directory

ADMINISTRATION TABLES IN tablespace-name
index configuration options:
,
INDEX CONFIGURATION (
option-value
999
option-value:
COMMENT text
UPDATEAUTOCOMMIT
commitcount_number
commitsize
COMMITTYPE committype
COMMITCYCLES commitcycles
INITIALMODE initialmode
LOGTYPE ltype
AUXLOG auxlog_value
CJKSEGMENTATION cjksegmentation_method
index_schema
text search index. The index_schema must comply with the naming restrictions
for DB2 schema names. If the argument is null or an empty string, the default
value of schema is used. The index_schema is case-sensitive.
index_name
index. Together with index_schema, index_name uniquely identifies a text search
index in a database. The index_name is case-sensitive.
text source
column to be indexed. The options are as follows:
table-schema
The schema of the table for which the text search index is to be created.
table-name
Specifies the name of the table that contains the text column. You cannot
create text search indexes on federated tables, materialized query tables, or
views. The table-name is case-sensitive.
text column name
Specifies the name of the column to be indexed.
column-name
Specifies the name of the column to be indexed. The column must be
of one of the following data types: CHAR, VARCHAR, CLOB,
DBCLOB, BLOB, GRAPHIC, VARGRAPHIC, or XML. If the data type
of the column is not one of these data types, you can use a
transformation function with the name function-schema.function-name to
convert the column type to one of the valid types. (For details, see the
function-name (column-name) parameter.) Alternatively, you can specify a
user-defined external function that accesses the text documents to be
indexed. You can create only a single text search index for a column.
The column-name is case-sensitive.
function-name(column-name)
Specifies the schema-qualified name of an external scalar function that
converts a column data type that is unsupported for text searching into
1000
a data type that is supported for text searching. This function must
take only one parameter and return only one value. The name of the
function must conform to DB2 naming conventions. The
function-name(column-name) parameter is case-sensitive.
options
An input argument of type VARCHAR(32) that specifies the options to be
used. If you do not require any options, the parameter can be null or an empty
string. The options are as follows:
CODEPAGE code-page
Specifies the DB2 code page to be used when indexing text documents.
The default code page value is taken from the SYSIBMTS.TSDEFAULTS
view, from the row with the DEFAULTNAME column value of
CODEPAGE. The initial default code page for new indexes is the database
code page. This parameter applies only to binary data types that is, the
column type or return type from a transformation function must be BLOB
or character-type FOR BIT DATA.
LANGUAGE language
Specifies the language to be used by DB2 Text Search for language-specific
processing of a document during indexing. If you do not specify a locale,
the database territory is used to determine the default setting for the
LANGUAGE parameter. To have your documents that are scanned to
determine the locale, specify locale as AUTO.
FORMAT format
Specifies the format of the text documents in the column. The supported
formats are TEXT, XML, HTML, and INSO. If the column data type is not
XML, the default format is taken from the SYSIBMTS.TSDEFAULTS view,
from the row with the DEFAULTNAME column value of FORMAT. If the
column data type is XML, the default format is always XML. If you want
to use the INSO format, rich text support must be installed.
UPDATE FREQUENCY
Specifies the frequency of index updates. The index is updated if the
number of changes is at least the value set for the UPDATE MINIMUM
parameter. Automatic updates can only be done if the DB2_ATS_ENABLE
registry variable is set and the START FOR TEXT command is issued.
The default format is taken from the SYSIBMTS.TSDEFAULTS view, from
the row with the DEFAULTNAME column value of UPDATEFREQUENCY.
NONE
No further index updates are made. This value can be useful for a text
column in a table with data that does not change. It is also useful if
you intend to manually update the index by using the UPDATE INDEX
command.
D
The days of the week when the index is updated.

*
Every day of the week.
integer1
Specific days of the week, from Sunday - Saturday: 0 - 6.
H
The hours of the specified days when the index is updated.

*
Every hour of the day.
integer2
Specific hours of the day, from midnight to 11 p.m.: 0 - 23.
1001
The minutes of the specified hours when the index is updated.
integer3
Specifies the minimum number of changes to text documents before the
index is updated incrementally at the time that is specified by the UPDATE
FREQUENCY parameter. Only positive integer values are allowed. The default
value is taken from the SYSIBMTS.TSDEFAULTS view, from the row with
the DEFAULTNAME column value of UPDATEMINIMUM. A small value
increases consistency between the table column and the text search index
but also causes additional load on the system. The UPDATE INDEX command
ignores the value of this parameter unless you specify the USING UPDATE
MINIMUM parameter for that command.
COLLECTION DIRECTORY directory
Specifies the directory in which the text search index collection is stored.
You must specify the absolute path, where the maximum length of the
absolute path name is 215 characters. The process owner of the Text Search
server instance service must have read and write access on this directory.
The COLLECTION DIRECTORY parameter is only supported for an
integrated text search server setup. Review the usage notes for additional
information about collection locations.
ADMINISTRATION TABLES IN table-space-name
Specifies the name of an existing non-temporary table space for the
administration tables that are created for the index. By default the table
space of the base table for which you are creating the index is used.
This argument is required when a text index is created for a partitioned
table or for tables in partitioned databases. For partitioned databases, the
table space must be in the same partition group as the table space of the
base table. The text index administration tables are distributed in the same
manner as the corresponding base table.
INDEX CONFIGURATION (option-value)
Specifies additional index-related options as option-value pairs. The
following options are supported.
Table 236. Option-value pairs for the INDEX CONFIGURATION parameter
Option
Value
Data type
Description
COMMENT
text
String value
of fewer
than 512
bytes
Adds a string comment to the REMARKS column

in the DB2 Text Search SYSIBMTS.TSINDEXES
catalog view. The comment is also used as the
description of the collection.
1002
Table 236. Option-value pairs for the INDEX CONFIGURATION parameter (continued)
Option
Value
Data type
Description
UPDATEAUTOCOMMIT
commitsize
String
Specifies the number of rows or number of hours

after which a commit is run to automatically
preserve the previous work for either initial or
incremental updates.
v After the number of documents that are updated
reaches the COMMITCOUNT number, the
server applies a commit. COMMITCOUNT
counts the number of documents that are
updated by using the primary key, not the
number of staging table entries.
v The text index is committed after the specified
number of hours is reached. The maximum
number of hours is 24.
For initial updates, the index update processes
batches of documents from the base table. After
the commitsize value is reached, update processing
completes a COMMIT operation and the last
processed key is saved in the staging table with
operational identifier '4'. This key is used to restart
update processing either after a failure or after the
number of specified commitcycles are completed. If
a commitcycles is specified, the update mode is
modified to incremental to initiate capturing
changes by using the LOGTYPE BASIC option to
create triggers on the text table. However, until the
initial update is complete, log entries that are
generated by documents that are not been
processed in a previous cycle are removed from
the staging table.
Using the UPDATEAUTOCOMMIT option for an initial
text index update leads to a significant increase of
execution time.
For incremental updates, log entries that are
processed are removed correspondingly from the
staging table with each interim commit.
COMMITTYPE
committype
String
Specifies rows or hours for the UPDATEAUTOCOMMIT

index configuration option. The default is rows.
COMMITCYCLES
commitcycles
Integer
Specifies the number of commit cycles. The default

is 0 for unlimited cycles.
If you do not explicitly specify cycles, the update
operation uses as many cycles as required based
on the batch size that is specified with the
UPDATEAUTOCOMMIT option to finish the update
processing.
You can use this option with the UPDATEAUTOCOMMIT
setting with a committype.
1003
Table 236. Option-value pairs for the INDEX CONFIGURATION parameter (continued)
Option
Value
Data type
Description
INITIALMODE
initialmode
String
Specifies how the updates are processed. The

INITIALMODE index configuration option has three
possible values:
v FIRST, where the primary update is the initial
update. This is the default value of the
INITIALMODE option.
v SKIP, where the update mode is immediately set
to incremental, triggers are added for the
LOGTYPE BASIC option, but no initial update is
performed.
v NOW, where the update is started after the
index was created as final part of the CREATE
INDEX operation. This option is only supported
for single-node setups.
LOGTYPE
ltype
String
Specifies whether triggers are added to populate

the primary log table. It has two values:
v BASIC, where the primary staging table is
created and triggers added on the text table to
recognize any changes. This is the default value.
v CUSTOM, where the primary staging table is
created, but no triggers on the text table. Ensure
a mechanism to identify changes for incremental
updates, especially if you do not plan to use the
ALLROWS option for updates.
auxlog
_value
AUXLOG
String
Controls the creation of the additional log

infrastructure to capture changes that are not
recognized by a trigger. The default setting for
range-partitioned tables is ON. You can change the
default value in the default table by setting
AuxLogNorm for non-range-partitioned tables and
AuxLogPart for range-partitioned tables.
You cannot change the auxiliary log infrastructure
property for a text index after it is created.
CJKSEGMENTATION
CJKSEGMENTATION
_method
String
The segmentation method is applicable for

documents in Chinese, Japanese, and Korean
languages (zh_CN, zh_TW, ja_JP, ko_KR locale
sets), including such documents when automatic
language detection is enabled (LANGUAGE
AUTO). If no option is specified, the value for
CJKSEGMENTATION in the defaults table is
applied. Supported values are:
v MORPHOLOGICAL
v NGRAM
The specified segmentation method is added to the
SYSIBMTS. TSCONFIGURATION administrative
view and cannot be changed after the text index is
created.
Remember: Non-numeric values, such as comments, must be enclosed in

single quotation marks. A single quotation mark character within a string
value must be represented by two consecutive single quotation marks.
1004
Example:
INDEX CONFIGURATION (COMMENT Index on Users Guide column)
message_locale
for any error message returned. If the argument is null or an empty string or
is used.
message
An output argument of type VARCHAR(32) that specifies a warning or
Examples
Example 1: In the following example, the SYSTS_CREATE procedure is called to
create a text search index called myTextIndex. The UPDATE MINIMUM 10 parameter
specifies that 10 changes must be made to the text documents that are associated
with the index before an incremental update of the index is performed. Any error
messages are returned in English. When the underlying text search command runs
successfully, the message output parameter is set to indicate the status of the
command execution.
CALL SYSPROC.SYSTS_CREATE(db2ts, myTextIndex,
myUserSchema.myBaseTable (myTextColumn), UPDATE MINIMUM 10,
en_US, ?)

Return Status = 0
Example 2: In the following example, the SYSTS_CREATE procedure is called to

create a text search index called myTextIndex2. No options are specified. In this
example, the index exists, which results in an error message being returned to the
caller.
CALL SYSPROC.SYSTS_CREATE(db2ts, myTextIndex2,
myUserSchema.myBaseTable (myTextColumn), , en_US, ?)

index "db2ts"."myTextIndex2" already exists. ".
Usage notes
database. If a previous transaction is not committed before issuing a text search
administration operation, you might run into a deadlock, as the same database
objects might be affected and the operation waits for the previous step to
commit. This might occur, for example, when AUTOCOMMIT is turned off and
a table is created followed by creating a text index without an explicit commit
between the two transactions.
v Without the COLLECTION DIRECTORY clause the collection is placed in a
subdirectory that is named after the system-generated index identifier in the
path that is defined via the defaultDataDirectory parameter in the Text Server
configuration. You can use the configTool utility to explicitly configure this
1005
parameter. If the defaultDataDirectory parameter is not explicitly configured, then

the collection subdirectory is in <configPath>/config/collections directory.
You should use a location other than the home directory or the database instance
path as defaultDataDirectory or COLLECTION DIRECTORY. Make sure that the
location has adequate storage space and is local (not NFS mounted).
v Configure a value for the COLLECTION DIRECTORY parameter which enables use of
a striped RAID device.
The following key-related rules apply:
v You must define a primary key for the table.
v The number of primary key columns is limited to two columns fewer than the
number of primary key columns that are allowed in other DB2 environments.
v The total length of all primary key columns for a table with DB2 Text Search
indexes is limited to 15 bytes fewer than the maximum total primary key length
that is allowed in other DB2 environments. See the restrictions for the DB2
CREATE INDEX statement.
Creating an index with the LANGUAGE parameter set to the AUTO option allows
CJKSEGMENTATION specification as an option. The specified segmentation
method applies to Chinese, Japanese, and Korean language documents. You cannot
change the value that is set for the CJKSEGMENTATION_method value after index
creation is complete.
You cannot issue certain procedures or commands concurrently on a text search
index because they might result in an error message based on the timing of the
conflicting operation.
v SYSTS_DISABLE procedure or db2ts DISABLE DATABASE FOR TEXT command
v SYSTS_CONFIGURE procedure
Successful execution of the CREATE INDEX command has the following effects:
v DB2 Text Search server data is updated. A collection with the name
instance_database-name_index-identifier_number is created, as in the following
example:
tigertail_MYTSDB_TS250517_0000
1006
For partitioned databases, a collection is created for each partition. You can
retrieve the collection name(s) from the SYSIBMTS.TSCOLLECTIONNAMES
view COLLECTIONNAME column.
An index event table is created in the specified table space. Also, an index
staging table is created in the specified table space with appropriate DB2
indexes. If the AUXLOG ON option was set for the INDEX CONFIGURATION parameter,
a second staging table is created to capture changes through integrity processing.
DB2 Text Search catalog information is updated. However, the newly created
text search index is not automatically populated. To populate the text search
index, the SYSTS_UPDATE procedure or UPDATE INDEX command must be issued
either manually or automatically (as a result of defining an update schedule for
the index by using the UPDATE FREQUENCY parameter).
If DB2 Text Search coexists with DB2 Net Search Extender and an active Net
Search Extender index exists for the table column, the new DB2 Text Search
index is set to inactive.
If a text search index is created with parameters LANGUAGE set to AUTO and
CJKSEGMENTATION set to MORPHOLOGICAL, then searches for valid strings on a
morphological index returns zero rows. To obtain the results, add the
QUERYLANGUAGE option to the CONTAINS function, as seen in the following query:
select bookname from morphobooks
where contains (story, ,QUERYLANGUAGE=zh_CN) = 1
The AUXLOG option is supported for nicknames for data columns that support a
multiple query table (MQT) with deferred refresh. It is not supported for views.
You can specify the UPDATEAUTOCOMMIT index configuration option without type and
cycles for compatibility with an earlier version. This index configuration option is
associated by default with the COMMITTYPE rows option and unrestricted cycles.
You can also specify the UPDATEAUTOCOMMIT, COMMITTYPE, and COMMITSIZE index
configuration options for an UPDATE INDEX operation to override the configured
values. Values that are submitted for a specific update operation are only applied
once and not persisted.
With theINITIALMODE SKIP option, the text search index manager is responsible to
populate the index appropriately. Use this option to control the sequence in which
data from the text table is initially processed.
If you use the LOGTYPE index configuration option, the following rules apply:
v When you use the LOGTYPE CUSTOM setting, use the SYSIBMTS.TSSTAGING
administrative view to insert log entries for new, changed, and deleted
documents.
v Check the value of the LOGTYPE option in the SYSIBMTS.TSCONFIGURATION
administrative view to view the settings for an index.
v Check the value of the LOGTYPE option in the SYSIBMTS.TSDEFAULTS
administrative view to view the default log type that is applied to newly created
text indexes.
v
Note: The LOGTYPE option is not valid with the ALLROWS option in the CREATE
INDEX operation, as ALLROWS forces an initial update and no log tables are created
in this case.
SYSTS_DISABLE procedure - Disable current database for text

search
The procedure disables DB2 Text Search for the current database.
Once the Text Search feature has been disabled, text search indexes and commands
are no longer available for use with the database.
The procedure issues a DISABLE DATABASE FOR TEXT text search administration
Authorization
v DBADM with DATAACCESS authority.
v SYSTS_ADM role
1007

None
Syntax
SYSTS_DISABLE (
options
message_locale
message
options
used when disabling the database. The argument can be set to FORCE. When
this value is specified, all indexes are dropped and the Text Search feature is
disabled by force. No text search indexes are preserved and no error message
or warning is returned. If the argument is null or an empty string, an attempt
is made to disable the Text Search feature for the database.
message_locale
is used.
message
Examples
Example 1: In the following example, Text Search is disabled for a database using
the SYSTS_DISABLE procedure. The FORCE option is specified to ensure that the
feature is disabled even if text search indexes still exist on tables in the database.
Error messages are specified to be returned in English. The message output
parameter is set to an informational message string.
CALL SYSPROC.SYSTS_DISABLE(FORCE, en_US, ?)

Return Status = 0
Example 2: In the following example, Text Search is disabled for a database with
existing text search indexes using the SYSTS_DISABLE procedure without
specifying the FORCE option. This results in an error message to the caller. It is
preferable to drop all existing text search indexes before disabling the Text Search
feature or alternatively to specify the FORCE option for the options input parameter
value.
CALL SYSPROC.SYSTS_DISABLE(, en_US, ?)
1008

index active in specified or default database. ". SQLSTATE 38H14
Usage notes
AUTOCOMMIT.
search index if they might conflict. Some of the conflicting procedures are:
38H13.
Note: The lock is set at the database level for the SYSTS_DISABLE procedure.
v When this procedure is run,
the DB2 Text Search catalog information is updated. The index log and event
tables are dropped. Triggers on the user text table are deleted.
if the FORCE option is specified, all text index information is removed from the
database and all associated collections are deleted. See the "db2ts DROP
INDEX command" or "SYSTS_DROP procedure" for reference.
v This procedure does not influence the DB2 Net Search Extender enablement
status of the database. It deletes the DB2 Text Search catalog tables and views
that are created by the SYSTS_ENABLE procedure or the ENABLE FOR TEXT
command.
v Before dropping a DB2 database that has text search index definitions, run this
procedure and make sure that the text indexes and collections have been
removed successfully.
v If some indexes could not be deleted using the FORCE option, the collection
names are written to the db2diag log files.
Note: The user is discouraged from usage that results in orphaned collections,
that is, collections that remain defined on the text search server but are not used
by DB2. Here are some cases that may cause orphaned collections:
When a DROP DATABASE CLP command is executed without running a
DISABLE DATABASE FOR TEXT command
When the SYSTS_DISABLE procedure is run or a DISABLE DATABASE FOR TEXT
command is executed using the FORCE option.
SYSTS_DROP procedure - Drop text search index

The SYSTS_DROP procedure drops an existing text search index associated with
any table column.
After this procedure runs successfully, text search queries cannot be run on the
column for which the text search index was dropped.
1009
The procedure issues a DROP INDEX text search administration command on the
database server.
Authorization
SYSTS_MGR role and at least one of the following privileges or authorities:
v CONTROL privilege on the table on which the index is defined
v DROPIN privilege on the schema on which the index is defined
v If the text search index has an existing schedule, the authorization ID must be
the same as the index creator, or must have DBADM authority

None
Syntax
SYSTS_DROP (
index_schema
index_name
, options

index_schema
index_name
options
message_locale
is used.
message
Examples
Example 1: In the following example, the text search index that was created with
index_schema db2ts and index_name myTextIndex is being dropped. Any error
1010
messages are requested to be returned in English. When the procedure succeeds,

the output parameter message indicative of the successful operation is returned to
the caller.
CALL SYSPROC.SYSTS_DROP(db2ts, myTextIndex, , en_US, ?)
As in previous releases, the SYSTS_DROP procedure is supported without the

options argument, for example :
CALL SYSPROC.SYSTS_DROP(db2ts, myTextIndex, en_US, ?)

Return Status = 0
Example 2: In the following example, SYSTS_DROP is called to drop a text search

index with index_schema db2ts and index_name myTextIndex2. This index does
not exist and results in an error.
CALL SYSPROC.SYSTS_DROP(db2ts, myTextIndex2, en_US, ?)

Usage notes
search index if they might conflict. Some of the conflicting procedures are:
SYSTS_DROP procedure
A STOP FOR TEXT command that runs in parallel with the DROP operation will
not cause a conflicting command message, instead, if the text search server is
shut down before DROP has removed the collection, an error will be returned
that the text search server is not available.
v After a text search index is dropped, text search is no longer possible on the
corresponding text column. If you plan to create a new text search on the same
text column, you must first disconnect from the database and then reconnect
before creating the new text search index.
v The db2ts DROP INDEX command makes the following changes to the database:
Updates the DB2 Text Search catalog information.
Drops the index staging and event tables.
Deletes triggers on the user text table.
Destroys the collection associated with the DB2 Text Search index definition.
SYSTS_ENABLE procedure - Enable current database for text

search
The SYSTS_ENABLE procedure enables DB2 Text Search for the current database.
1011
This procedure must be issued successfully before text search indexes on columns
within the database can be created.
This procedure issues the ENABLE DATABASE FOR TEXT text search administration
Authorization
The privileges held by the authorization ID of the procedure must include the
SYSTS_ADM role and the DBADM authority.

None
Syntax
SYSTS_ENABLE (
options ,
message_locale
, message
options:

ADMINISTRATION TABLES IN
tablespace-name
options
An input argument of type VARCHAR(32K) that specifies the options to be
Supported values are:
ADMINISTRATION TABLES IN table-space-name
Specifies the name of an existing regular table space for administration
tables created while enabling the database for DB2 Text Search. If this
clause is not specified, SYSTOOLSPACE is used as the table space.
Regardless of whether SYSTOOLSPACE or an explicitly specified table
space name is used, the table space has to meet certain requirements. It has
to be:
v A regular table space
v For partitioned databases it would be recommended to define a
bufferpool and table space with 32KB page size
To use a case-sensitive tablespace-name use a delimited identifier by
enclosing the name in double quotation marks. By default it is treated as
an ordinary identifier and converted to uppercase.
message_locale
is used.
1012
message
Examples
Example 1: Enable the database for text search by creating administration tables in a
table space with any output messages in English.
CALL SYSPROC.SYSTS_ENABLE (ADMINISTRATION TABLES IN TSSPACE, en_US, ?)
Enable the database for text search by creating administration tables in a table
space with any output messages in French.
CALL SYSPROC.SYSTS_ENABLE (ADMINISTRATION TABLES IN "tbs32k" , fr_FR, ?)
As in previous releases, the SYSTS_ENABLE procedure is supported without the

options argument, for example:
CALL SYSPROC.SYSTS_ENABLE (en_US, ?)
An example of output for this query:

Return Status = 0
Example 2: In the following example, SYSTS_ENABLE is called on a database that

is already enabled for text search. This results in an error message to the caller.
CALL SYSPROC.SYSTS_ENABLE(en_US, ?)
An example of output for this query:

procedure or command. The error message from the text search
product is "CIE00322 Specified or default database already
enabled for text. ". SQLSTATE 38H14
Usage notes
AUTOCOMMIT.
v When this procedure is run, the following events occur:
This procedure creates database objects, such as text search administration
catalog tables and views, in the schema SYSIBMTS.
The established database defaults for text search index are available in view
SYSIBMTS.TSDEFAULTS.
When the command has successfully completed, the text search catalog tables
and views are created and are available.
v When executing this procedure, if you do not have sufficient execution and file
access privileges to retrieve the Text Search server configuration, the procedure
will create the text search catalog with an 'Incomplete enablement' warning. In
this case, the Text Search server connection information will need to be updated
manually.
1013
SYSTS_UPDATE procedure - Update the text search index

The SYSTS_UPDATE procedure updates the text search index to reflect the current
contents of the text column with which the index is associated.
While the update is being done, a search is possible. Until completion of the
update, the search operates on a partially updated index.
The procedure issues an UPDATE INDEX text search administration command on the
database server.
Authorization
the SYSTS_MGR role and at least one of the following authorities:
v CONTROL privilege on the table on which the text index is defined
v INDEX with SELECT privilege on the base table on which the text index is
defined
In addition, for an initial update the authorization requirements apply as outlined
in the CREATE TRIGGER statement.

None
Syntax
SYSTS_UPDATE (
index_schema
, index_name
update_options , message_locale
message
,
)

index_schema
schema names. If the argument is null or an empty string, the value of the
current schema is used. The index_schema is case-sensitive.
index_name
update_options
An input argument of type VARCHAR(32K) that specifies update options. If no
options are required the argument can be null or an empty string. The possible
values are:
1014
UPDATE OPTIONS value
Description
USING UPDATE MINIMUM
This option enforces the use of the UPDATE

MINIMUM value that is defined for the text
search index and processes updates if the
specified minimum number of changes
occurred.
FOR DATA REDISTRIBUTION
This option specifies that a text search

index in a partitioned database must be
refreshed after data partitions are added
or removed and a subsequent data
redistribution operation must be
completed. Search results might be
inconsistent until the text search index is
updated with the FOR DATA
REDISTRIBUTION option.
ALLROWS
This option specifies that an initial update

must be attempted unconditionally.
1015
Description
UPDATEAUTOCOMMIT commitsize
Specifies the number of rows or number

of hours after which a commit is run to
automatically preserve the previous work
for either initial or incremental updates.
v After the number of documents that are
updated reaches the COMMITCOUNT
number, the server applies a commit.
COMMITCOUNT counts the number of
documents that are updated by using
the primary key, not the number of
staging table entries.
v The text index is committed after the
specified number of hours is reached.
The maximum number of hours is 24.
For initial updates, the index update
processes batches of documents from the
base table. After the commitsize value is
reached, update processing completes a
COMMIT operation and the last processed
key is saved in the staging table with
operational identifier '4'. This key is used
to restart update processing either after a
failure or after the number of specified
commitcycles are completed. If a
commitcycles is specified, the update mode
is modified to incremental to initiate
capturing changes by using the LOGTYPE
BASIC option to create triggers on the text
table. However, until the initial update is
complete, log entries that are generated by
documents that have not been processed
in a previous cycle are removed from the
staging table.
Using the UPDATEAUTOCOMMIT option for an
initial text index update leads to a
significant increase of execution time.
For incremental updates, log entries that
are processed are removed
correspondingly from the staging table
with each interim commit.
COMMITTYPE
1016
Specifies rows or hours for the

UPDATEAUTOCOMMIT index configuration
option. The default is rows.
Description
COMMITCYCLES
Specifies the number of commit cycles.

The default is 0 for unlimited cycles.
If cycles are not explicitly specified, the
update operation uses as many cycles as
required based on the batch size that is
specified with the UPDATEAUTOCOMMIT
option to finish the update processing.
You can use this option with the
UPDATEAUTOCOMMIT setting with a
committype.
message_locale
is used.
message
Examples
Example 1: In the following example, the text search index that was created with
index_schema db2ts and index_name myTextIndex is being updated. A NULL
value in the place of the update_options means that an update is unconditionally
started when the stored procedure is called. Any error messages are requested to
be returned in English. For successfull procedures, the caller receives a success
message.
CALL SYSPROC.SYSTS_UPDATE
(db2ts, myTextIndex, , en_US, ?)
An example of output from this query:

Example 2: Update a text index after an operation finishes on the partition group
that is associated with the base table, and return any error messages in English.
CALL SYSPROC.SYSTS_UPDATE
(db2ts, myTextIndex2, FOR DATA REDISTRIBUTION, en_US, ?)
Return Status = 0
Example 3: In the following example, SYSTS_UPDATE is called to update a text

search index with index_schema db2ts and index_name myTextIndex3. In this
example, the index does not exist and results in an error.
CALL SYSPROC.SYSTS_UPDATE(db2ts, myTextIndex3, USING UPDATE MINIMUM,
en_US, ?)
1017

Usage notes
on the completion of the procedures. To avoid any unexpected impact from such
a commit or rollback, you might want to commit all transaction changes.
Turning on AUTOCOMMIT is one way to commit all transaction changes.
v Certain procedures or commands cannot be executed concurrently on a text
search index because the timing of the conflicting operation might cause an
error. Some of the conflicting procedures and commands are:
SYSTS_ALTER procedure or db2ts ALTER INDEX command
SYSTS_CLEAR_EVENTS procedure or db2ts CLEAR EVENTS FOR INDEX
command
SYSTS_DISABLE procedure or db2ts DISABLE DATABASE FOR TEXT command
SYSTS_UPDATE procedure or db2ts UPDATE INDEX command
38H13.
v This procedure does not return until all index update processing is completed.
The duration depends on the number of documents to be indexed and the
number of documents already indexed. The collection name for the index can be
retrieved from the SYSIBMTS.TSCOLLECTIONNAMES view
COLLECTIONNAME column.
v When there are individual document errors, the documents must be corrected.
The primary keys of the erroneous documents can be looked up in the event
table for the index. By changing the corresponding rows in the user table, the
next call to SYSTS_UPDATE reprocesses these documents.
v When the SYSTS_UPDATE procedure is run, the following events occur:
Rows are inserted into the event table, including parser error information.
Information is deleted from the index staging table in case of incremental
updates. Before the first update, the SYSTS_UPDATE procedure creates
triggers on the user table.
The collection is updated:
- New or changed documents are parsed and indexed.
- Deleted documents are discarded from the index.
v If a synonym dictionary is associated with a text index, issuing the update with
the ALLROWS or FOR DATA REDISTRIBUTION options removes the association by
dropping and re-creating the collections for the text index. The synonym
dictionary must be associated with the new text index collections.
v The UPDATEAUTOCOMMIT index configuration option can be specified without type
and cycles for compatibility with an earlier version. It is associated by default
with the COMMITTYPE rows option and unrestricted cycles.
v When UPDATEAUTOCOMMIT, COMMITTYPE or COMMITSIZE values are specified for the
update operation, they override existing configured values only for the specific
update and are not persisted. update.
SYSTS_UPGRADE_CATALOG procedure - Upgrade the text

search catalog
This procedure upgrades the DB2 Text Search catalog, including the administrative
tables and administrative views, to the latest product version.
1018
This procedure creates new catalog tables and views which are used in the latest
version of the product and also updates the existing catalog tables and views. It
removes obsolete catalog tables and views.
Authorization

None
Syntax
SYSTS_UPGRADE_CATALOG (
message_locale
message
message_locale
is used.
message
Example
Example 1: In the following example, the database was enabled for text search in an
older release. Calling the SYSTS_UPGRADE_CATALOG procedure upgrades the text
search catalog tables, and if the procedure succeeds, the output parameter message
indicating successful operation is returned to the caller.
CALL SYSPROC.SYSTS_UPGRADE_CATALOG(en_US,?)
Parameter Value : CIE0213W The DB2 Text Search Catalog has been upgraded to
the current version. You will now need to update the text search index using
the SYSPROC.SYSTS_UPGRADE_INDEX stored procedure.
index also needs to be updated by calling "SYSPROC.SYSTS_UPGRADE_INDEX".
Return Status = 0
Example 2: In the following example, the database was not enabled for DB2 Text
Search in an older release before calling the procedure. A NULL value in the place
message_locale means the a default locale of 'en_US' will be used. All error messages
are returned in English.
CALL SYSPROC.SYSTS_UPGRADE_CATALOG(,?)
SQL20427N An error occurred during a text search administration procedure
or command. The error message is "CIE0323E Specified or default database
not enabled for text. ".
SQLSTATE=38H14
1019
Example 3: In the following example, the text search catalog and the text search
indexes are already upgraded to the current version.
CALL SYSPROC.SYSTS_UPGRADE_CATALOG(en_US,?)
Parameter Value : CIE0002I The DB2 Text Search release level is current
for the database. The system has not been upgraded.
Return Status = 0
Usage notes
The SYSTS_UPGRADE_CATALOG procedure is integrated into the DB2 UPGRADE DATABASE
command to perform the text search specific catalog upgrade. If the database
upgrade fails to upgrade the text search catalog, the SYSTS_UPGRADE_CATALOG
procedure must be executed separately by the user to complete the database
upgrade.
To upgrade the text search index catalog, proceed as follows:
1. Make sure that the DB2 Text Search instance service is stopped.
2. Execute the SYSTS_UPGRADE_CATALOG procedure.
Note: DB2 Text Search administrative procedures use an existing connection to
the database. The current transaction might be committed or rolled back
depending on the completion of the procedures. As such, you might want to
commit all transaction changes to avoid any unexpected impact from such a
commit or rollback. One way to achieve this is to turn on AUTOCOMMIT.
3. The SYSTS_UPGRADE_CATALOG procedure attempts to populate the Text Search
server information in the catalog. Review the SYSIBMTS.TSSERVER content
and update the Text Search server information as necessary.
4. Upgrade the text search indexes by following the procedure outlined for the
SYSTS_UPGRADE_INDEX procedure. The version value in the
SYSIBMTS.TSDEFAULTS administrative view will not be updated until the
SYSTS_UPGRADE_INDEX procedure is executed successfully.
SYSTS_UPGRADE_INDEX - Upgrade text search indexes

This procedure updates DB2 Text Search index information in DB2 catalog tables
and text search catalog tables.
Text search index collections are managed by the Text Search server. See Upgrading
DB2 Text Search for more information.
Authorization

None
Syntax
1020
SYSTS_UPGRADE_INDEX (
message_locale
, message
message_locale
is used.
message
Example
Example 1: In the following example, the database was enabled for text search in
an older release and the procedure SYSTS_UPGRADE_CATALOG has already been
completed successfully. The procedure SYSTS_UPGRADE_INDEX will complete the
upgrade for the text index metadata in the database catalog. When the procedure
succeeds, the output parameter message indicative of the successful operation is
returned to the caller.
CALL SYSPROC.SYSTS_UPGRADE_INDEX(en_US, ?)
Parameter Name : MESSAGE
Parameter Value : CIE00001 Operation completed successfully.
Return Status = 0
Example 2: In the following example, the database was not enabled for text search
in the older release of the product. If a NULL value is set for message_locale, it
means the system locale will be used. If the system locale is not available then the
default locale 'en_US' will be used.
CALL SYSPROC.SYSTS_UPGRADE_INDEX(, ?)
SQL20427N An error occurred during a text search administration procedure
or command. The error message is "CIE0323E Specified or default database
not enabled for text. ".
SQLSTATE=38H14
Example 3: In the following example, the DB2 Text Search catalog and the text
search indexes were already upgraded to the current version.
Parameter Value : CIE0002I The DB2 Text Search release level is current for
the database. The system has not been upgraded.
Return Status = 0
Example 4: In the following example, the DB2 Text Search catalog was not
upgraded.
CIE0409E The DB2 Text Search catalog has not been upgraded to the current version.
1021
Usage notes
v The SYSTS_UPGRADE_INDEX procedure is integrated into the DB2 UPGRADE DATABASE
command to perform upgrades for text search indexes. When issuing the DB2
UPGRADE DATABASE command , this procedure will be executed as well. If the
upgrade of text search indexes fails, the procedure must be run manually.
v The SYSTS_UPGRADE_CATALOG procedure should be executed before
SYSTS_UPGRADE_INDEX procedure. The version value in the SYSIBMTS.TSDEFAULTS
administrative view will not be updated until the SYSTS_UPGRADE_INDEX
procedure is executed successfully.
v DB2 Text search administrative procedures use an existing connection to the
on the completion of the procedures. As such, you might want to commit all
transaction changes to avoid any unexpected impact from such a commit or
Workload Management routines

WLM_CANCEL_ACTIVITY - Cancel an activity
This procedure cancels a given activity. If the cancel takes place, an error message
will be returned to the application that submitted the activity that was cancelled.
Syntax
WLM_CANCEL_ACTIVITY ( application_handle , uow_id , activity_id )
application_handle
An input argument of type BIGINT that specifies the application handle whose
activity is to be cancelled. If the argument is null, no activity will be found and
an SQL4702N with SQLSTATE 5U035 is returned.
uow_id
An input argument of type INTEGER that specifies the unit of work ID of the
activity that is to be cancelled. If the argument is null, no activity will be found
and an SQL4702N with SQLSTATE 5U035 is returned.
activity_id
An input argument of type INTEGER that specifies the activity ID which
uniquely identifies the activity within the unit of work that is to be cancelled.
If the argument is null, no activity will be found and an SQL4702N with
SQLSTATE 5U035 is returned.
Authorization
v
v
v
v
1022
DBADM authority
SQLADM authority
WLMADM authority

None
Example
An administrator can use the
WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES table function to find the
application handle, unit of work ID and activity ID of an activity. To cancel an
activity with application handle 1, unit of work ID 2 and activity ID 3:
CALL WLM_CANCEL_ACTIVITY(1, 2, 3)
Usage notes
v If no activity can be found, an SQL4702N with SQLSTATE 5U035 is returned.
v If the activity cannot be cancelled because it not in the correct state (not
initialized), an SQL4703N (reason code 1) with SQLSTATE 5U016 is returned.
v If the activity is successfully cancelled, an SQL4725N with SQLSTATE 57014 is
returned to the cancelled application.
v If, at the time of the cancel, the coordinator is processing a request for a different
activity or is idle, the activity is placed into CANCEL_PENDING state and will
be cancelled when the coordinator processes the next request.
WLM_CAPTURE_ACTIVITY_IN_PROGRESS - Collect activity

information for activities event monitor
The WLM_CAPTURE_ACTIVITY_IN_PROGRESS procedure gathers information
about a specified activity and writes the information to the active activities event
monitor.
The functionality of WLM_CAPTURE_ACTIVITY_IN_PROGRESS is identical to the
functionality of MON_CAPTURE_ACTIVITY_IN_PROGRESS. Although the
functionality for these two routines is the same, the authorization is not necessarily
the same. See MON_CAPTURE_ACTIVITY_IN_PROGRESS for syntax, parameters,
usage notes, and examples.
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
WLM_COLLECT_STATS - Collect and reset workload

management statistics
The WLM_COLLECT_STATS procedure gathers statistics for service classes,
workloads, work classes, and threshold queues and writes them to the statistics
event monitor. The procedure also resets the statistics for service classes,
workloads, work classes, and threshold queues.
1023
If there is no active statistics event monitor, the procedure only resets the statistics.
The functionality of WLM_COLLECT_STATS is identical to the functionality of
MON_COLLECT_STATS. Although the functionality for these two routines is the
same, the authorization is not necessarily the same. See MON_COLLECT_STATS
for syntax, parameters, usage notes, and examples.
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
WLM_ALTER_MEMBER_SUBSET procedure - Alter a member

subset object
The WLM_ALTER_MEMBER_SUBSET procedure alters an existing member subset
database object.
Authorization
v DBADM authority
v WLMADM authority

None
Syntax
WLM_ALTER_MEMBER_SUBSET (
subset_name ,
subset_attributes ,
member_list )
Routine parameters
subset_name
member subset object to be altered. This is a one-part name. It is an SQL
identifier (ordinary or delimited). The name must identify a member subset
which already exists in the current database (SQLSTATE 42704). This argument
cannot be NULL (SQLSTATE 42815).
subset_attributes
An input argument of type CLOB(8K) that enables you to alter one or more
member subset attributes. This parameter defaults to NULL. Subset attributes
are specified as name value pairs using the format:
1024
<subset attribute name tag>value</subset attribute name tag>
Each subset attribute can be specified a maximum of one time (SQLSTATE

42613). Subset attribute names are case sensitive. The subset attribute values
are case insensitive unless otherwise noted. The available subset attribute name
tags are as follows:
'<enabled>value</enabled>'
Specifies whether this member subset will be considered when a
connection request is assigned to a member subset. This value can be
either "yes" or "no". If not specified the current value is not altered.
'<databaseAlias>value</databaseAlias>'
Replace the database alias that a client must connect to in order to be
assigned to this member subset. The name must conform to the
naming conventions for local database aliases (SQLSTATE 2E000).
If the existing database alias was cataloged by a member subset
operation it is uncataloged by this command.
'<catalogDatabaseAlias>value</catalogDatabaseAlias>'
Specifies whether the procedure should catalog the new database alias
specified in the databaseAlias attribute. This value can be either "yes"
or "no". When this attribute is specified a new database alias attribute
must also be provided (SQLSTATE 530AA).
If the value of this attribute is "yes" the new database alias specified in
the databaseAlias attribute must not already be cataloged (SQL1005N).
If the value of this attribute is "no" the new database alias specified in
the databaseAlias attribute must already be cataloged (SQLSTATE
42705).
'<memberPriorityBasis>value</memberPriorityBasis>'
Specifies what information should be used when calculating the
relative member priorities in the member subsets server list. This value
can be either "load" or "equalPriority". If not specified, the current
value is not altered.
The value "load" indicates that the member priorities in the member
subsets server list will be based on the relative load of each member.
The relative load is calculated based on the average CPU load and
average page swap rate. This value can be specified only in a DB2
pureScale instance (SQLSTATE 530AA).
The value "equalPriority" indicates that the member priority in the
member subsets server list for each active member will be 101.
'<inclusiveSubset>value</inclusiveSubset>'
Specifies whether all members in the instance will be included in the
member subset's server list for high availability (HA) purposes when
no other member of the subset is online.
This attribute can be specified only in a DB2 pureScale instance
(SQLSTATE 530AA). When specified the value can be either "yes" or
"no". If not specified, the current value is not altered.
'<alternateServer>value</alternateServer>'
Specifies whether the host name and port cataloged by the UPDATE
ALTERNATE SERVER statement will be included in the member
subset's server list for HA purposes when no other member of the
subset is online. This value can be either "yes" or "no". If not specified,
it defaults to "no".
1025
'<comment>value</comment>'
Specifies a comment on the member subset. The comment specified
replaces the value in the REMARKS column of the
SYSCAT.MEMBERSUBSETS catalog view for the row that describes the
member subset. The comment value can be any character string
constant of up to 254 bytes.
member_list
An input argument of type VARCHAR(32000) that enables you to specify a list
of members to add to, or drop from, the member subset. This parameter
defaults to NULL. The list of members are specified as comma separated
numerical values using the following syntax:
,
(
ADD
DROP
member-number
Each member number can be specified a maximum of one time (SQLSTATE

42613). If the ADD token is specified, the member must not already be
included in the member subset (SQLSTATE 42613). If the DROP token is
specified, the member must already be included in the member subset. The
member number must be defined in the instance (SQLSTATE 42729). The last
member in a member subset cannot be dropped (SQLSTATE 530AB).
Usage notes
v As an autonomous procedure, WLM_ALTER_MEMBER_SUBSET executes in its
v When WLM_ALTER_MEMBER_SUBSET successfully completes, it will commit
the work performed within the procedure, but if it is unsuccessful, the
procedure rolls back any work performed.
Examples
1. Add member 3 to the member subset MY_SUBSET.
CALL SYSPROC.WLM_ALTER_MEMBER_SUBSET(MY_SUBSET, NULL, (ADD 3))
2. Drop member 2 from the member subset MY_SUBSET.

CALL SYSPROC.WLM_ALTER_MEMBER_SUBSET(MY_SUBSET, NULL,
(DROP 2))
3. Change the member priority basis to equal priorities.

CALL SYSPROC.WLM_ALTER_MEMBER_SUBSET(MY_SUBSET,
<memberPriorityBasis>equalPriority</memberPriorityBasis>, NULL)
4. Change the member subset to an exclusive subset.

<inclusiveSubset>no</inclusiveSubset>, NULL)
5.
Replace the current database alias subset attribute from MY_SUBSET with
NEWALIAS.
<databaseAlias>NEWALIAS</databaseAlias>, NULL)
WLM_CREATE_MEMBER_SUBSET procedure - Create a member

subset object
The WLM_CREATE_MEMBER_SUBSET procedure creates a member subset
database object.
1026
Authorization
v DBADM authority
v WLMADM authority

None
Syntax
WLM_CREATE_MEMBER_SUBSET (
subset_name , subset_attributes ,
member_list )
Routine parameters
subset_name
member subset object to be created. This is a one-part name. It is an SQL
identifier (ordinary or delimited). The name must not identify a member subset
which already exists in the current database (SQLSTATE 42710). The name
must not begin with the characters 'SYS' (SQLSTATE 42939). This argument
subset_attributes
member subset attributes. This parameter cannot be NULL (SQLSTATE 42815).
Subset attributes are specified as name value pairs using the format:
<subset attribute name tag>value</subset attribute name tag>
Each subset attribute can be specified a maximum of one time (SQLSTATE

42613). Subset attribute names are case sensitive. The subset attribute values
are case insensitive unless otherwise noted. The available subset attribute name
tags are as follows:
'<enabled>value</enabled>'
Specifies whether this member subset will be considered when a
connection request is assigned to a member subset. This value can be
either "yes" or "no". If not specified it defaults to "yes".
'<databaseAlias>value</databaseAlias>'
Specifies a database alias name that a client connection must connect to
in order to be assigned to this member subset. The name must conform
to naming conventions for local database aliases (SQLSTATE 2E000).
This attribute is required (SQLSTATE 42815).
'<catalogDatabaseAlias>value</catalogDatabaseAlias>'
Specifies whether the procedure should catalog a database alias if that
is one of the specified subset attributes. This value can be either "yes"
or "no". If not specified it defaults to "yes".
If the value of this attribute is "yes" the database alias specified in the
databaseAlias attribute must not already be cataloged (SQL1005N). If
the value of this attribute is "no" the database alias specified in the
databaseAlias attribute must already be cataloged (SQLSTATE 42705).
1027
'<memberPriorityBasis>value</memberPriorityBasis>'
Specifies what information should be used when calculating the
relative member priorities in the member subsets server list. This value
can be either "load" or "equalPriority". If not specified, it defaults to
"load" in a DB2 pureScaleinstance and "equalPriority" in a partitioned
database or single member environment.
The value "load" indicates that the member priorities in the member
subsets server list will be based on the relative load of each member.
The relative load is calculated based on the average CPU load and
average page swap rate. This value can be specified only in a DB2
pureScale instance (SQLSTATE 530AA).
The value "equalPriority" indicates that the member priority in the
member subsets server list for each active member will be 100.
'<inclusiveSubset>value</inclusiveSubset>'
Specifies whether all members in the instance will be included in the
member subset's server list for high availability (HA) purposes when
no other member of the subset is online. When specified the value can
be either "yes" or "no". If not specified, it defaults to "yes" in a DB2
pureScale instance and "no" in a partitioned database or single member
environment. This value can be specified only in a DB2 pureScale
instance (SQLSTATE 530AA).
'<alternateServer>value</alternateServer>'
Specifies whether the host name and port cataloged by the UPDATE
ALTERNATE SERVER statement will be included in the member
subset's server list for HA purposes when no other member of the
subset is online. This value can be either "yes" or "no". If not specified,
it defaults to "no".
member_list
An input argument of type VARCHAR(32000) that enables you to specify a list
of members to include in the member subset. This parameter cannot be NULL
(SQLSTATE 42815). The list of members are specified as comma separated
numerical values using the following syntax:
,
(
member-number
Each member number can be specified a maximum of one time (SQLSTATE

42613). The member number must be defined in the instance (SQLSTATE
42729).
Usage notes
v As an autonomous procedure, WLM_CREATE_MEMBER_SUBSET executes in its
v When WLM_CREATE_MEMBER_SUBSET successfully completes, it will commit
v When a database connection is established, the database manager looks for a
matching member subset based on the database alias subset attribute. If a
matching member subset is found, the connection is associated with the member
subset.
1028
Examples
1. Create a member subset in a DB2 pureScale instance for connections to the
database alias PSALIAS. The PSALIAS database alias does not exist and will be
cataloged by the WLM_CREATE_MEMBER_SUBSET procedure.
CALL SYSPROC.WLM_CREATE_MEMBER_SUBSET(
PURESCALE_SUBSET,
<databaseAlias>PSALIAS</databaseAlias>,
(0, 1) )
2. Create a member subset in a partitioned database environment for connections

to the database alias DPFALIAS. The DPFALIAS database alias does not exist
and will be cataloged by the WLM_CREATE_MEMBER_SUBSET procedure.
The server list for the member subset is to include members 100 and 200 only.
DPF_SUBSET,
<databaseAlias>DPFALIAS</databaseAlias>,
(100, 200) )

database alias OLTPDB. The OLTPDB database alias exists prior to executing
the WLM_CREATE_MEMBER_SUBSET procedure.
The server list for the member subset is to include members 1 and 2 for
workload balancing usage and all other members for automatic client rerouting
purposes.
OLTP_SUBSET,
<catalogDatabaseAlias>no</catalogDatabaseAlias>
<databaseAlias>OLTPDB</databaseAlias>,
(1, 2) )

database alias EQUALDB. The EQUALDB database alias does not exist and
will be cataloged by the WLM_CREATE_MEMBER_SUBSET procedure.
The server list for the member subset is to include members 0 and 1 only. The
member priority in the server list are to be equivalent for all active members.
EQUAL_SUBSET,
<memberPriorityBasis>equalPriority</memberPriorityBasis>
<inclusiveSubset>no</inclusiveSubset>
<databaseAlias>EQUALDB</databaseAlias>,
(0, 1) )
WLM_DROP_MEMBER_SUBSET procedure - Drop a member

subset object
The WLM_DROP_MEMBER_SUBSET procedure drops an existing member subset
database object.
Authorization
v DBADM authority
v WLMADM authority

None
1029
Syntax
WLM_DROP_MEMBER_SUBSET (
subset_name
Routine parameters
subset_name
member subset object to be dropped. This is a one-part name. It is an SQL
identifier (ordinary or delimited). The name must identify a member subset
which already exists in the current database (SQLSTATE 42704). This argument
Usage notes
v As an autonomous procedure, WLM_DROP_MEMBER_SUBSET executes in its
v When WLM_DROP_MEMBER_SUBSET successfully completes, it will commit
Example
Drop the member subset MY_SUBSET.
CALL SYSPROC.WLM_DROP_MEMBER_SUBSET( MY_SUBSET )
WLM_GET_CONN_ENV - get settings for activity data collection

for a connection
The WLM_GET_CONN_ENV table function returns for a particular connection the
values of settings that control collection of activity data and section actuals. You
can use this table function to check the current values of the settings applied by
the WLM_SET_CONN_ENV stored procedure.
Syntax
WLM_GET_CONN_ENV (
application_handle
Parameters
application_handle
An input argument of type BIGINT that specifies the application handle for the
connection for which information is to be returned. You can use a value of
NULL to indicate the connection on which the procedure was invoked.
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority
1030

None
Example
The following query checks whether activities are being collected for the current
connection.
xmlparse(document details preserve whitespace)
FROM TABLE (
WLM_GET_CONN_ENV(
cast(NULL as bigint))
) connenv

APPLICATION_HANDLE
DETAILS
-------------------- -----------------------------------------------------7 <wlm_conn_env
xmlns=http://www.ibm.com/xmlns/prod/db2/mon
release="9070100">
<collectactdata>NONE</collectactdata>
<collectactpartition>COORDINATOR</collectactpartition>
<collectsectionactuals>NONE</collectsectionactuals>
</wlm_conn_env>
Usage notes
The WLM_GET_CONN_ENV table function provides maximum flexibility for
formatting output because it returns WLM environment information for a
connection as an XML document. The output can be parsed directly by an XML
parser, or it can be converted to relational format by the XMLTABLE function.
Table 237. Information returned for WLM_GET_CONN_ENV
Column name
Data type
Description
APPLICATION_HANDLE
BIGINT
DETAILS
BLOB(8M)
XML document that contains connection environment

details. See Table 238 on page 1032 for a description of the
1031
Detailed settings returned

Table 238. Detailed metrics returned for WLM_GET_CONN_ENV
Element name
Data type
collectactdata
xs:string(255)
Specifies what kind of activity data is being collected, if

any. Possible values are:
v NONE
v WITHOUT DETAILS
v WITH DETAILS
v WITH DETAILS, SECTION
v WITH DETAILS, SECTION AND VALUES
v WITH DETAILS AND VALUES
See information about the WLM_SET_CONN_ENV
procedure for details about these options.
collectactpartition
xs:string(255)
Specifies where activity data is being collected. Possible

values are:
v COORDINATOR
v ALL
collectsectionactuals
xs:string(255)
Specifies whether section actuals are being collected.

Possible values include:
v NONE
v BASE
WLM_GET_QUEUE_STATS table function - Return threshold

queue statistics
The WLM_GET_QUEUE_STATS function returns basic statistics for one or more
threshold queues on all active members. This function returns one row of statistics
The functionality of WLM_GET_QUEUE_STATS is identical to the functionality of
MON_GET_QUEUE_STATS. Although the functionality for these two routines is
the same, the authorization is not necessarily the same. See
MON_GET_QUEUE_STATS for syntax, parameters, information returned, usage
notes, and examples.
Authorization
v
v
v
v
v
1032

DBADM authority
SQLADM authority
WLMADM authority

None
WLM_GET_SERVICE_CLASS_AGENTS table function - list

agents running in a service class
The WLM_GET_SERVICE_CLASS_AGENTS function returns the list of agents,
fenced mode processes (db2fmp processes), and system entities on a specified
member that are running in a specified service class or on behalf of a specified
application. The system entities are non-agent threads and processes, such as page
cleaners and prefetchers.
The functionality of WLM_GET_SERVICE_CLASS_AGENTS is identical to the
functionality of MON_GET_AGENT. Although the functionality for these two
routines is the same, the authorization is not necessarily the same. See
MON_GET_AGENT for syntax, parameters, information returned, usage notes, and
examples.
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
_WORKLOAD_OCCURRENCES - list workload occurrences
The WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES function returns
the list of all workload occurrences running in a specified service class on a
particular member. A workload occurrence is a specific database connection whose
attributes match the definition of a workload and hence is associated with or
assigned to the workload.
returned.
Syntax
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES (
member


1033
empty string, the data is retrieved for all the superclasses in the database that
match the values of the other parameters.
Target service subclass for the workload occurrence. Any work submitted by
this workload occurrence will run in this service subclass under the target
service superclass with the exception of activities that are mapped, or
remapped, to a different subclass.
member
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
Example
If an administrator wants to see what workload occurrences are running on the
system as a whole, the administrator can call the
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES function by
specifying a null value or an empty string for service_superclass_name and
service_subclass_name and -2 for member:
SUBSTR(CHAR(COORD_MEMBER),1,4) AS COORDMEMB,
SUBSTR(CHAR(APPLICATION_HANDLE),1,7) AS APPHNDL,
SUBSTR(WORKLOAD_NAME,1,22) AS WORKLOAD_NAME,
SUBSTR(CHAR(WORKLOAD_OCCURRENCE_ID),1,6) AS WLO_ID
FROM TABLE(WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES
(CAST(NULL AS VARCHAR(128)), CAST(NULL AS VARCHAR(128)), -2))
AS SCINFO
ORDER BY SUPERCLASS_NAME, SUBCLASS_NAME, MEMB, APPHNDL,
WORKLOAD_NAME, WLO_ID
If the system has four database members and is currently running two workloads,
the previous query produces results such as the following ones:
SUPERCLASS_NAME
------------------SYSDEFAULTMAINTENAN
SYSDEFAULTSYSTEMCLA
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
1034
SUBCLASS_NAME
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
MEMB
---0
0
0
0
1
1
2
COORDMEMB
--------0
0
0
0
0
0
0
...
...
...
...
...
...
...
...
...
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 2
...
...
...
...
...
...
...
...
...
...
...
...
APPHNDL
------1
2
1
2
1
2
1
2
WORKLOAD_NAME
---------------------SYSDEFAULTUSERWORKLOAD
0
0
0
...
...
...
WLO_ID
-----1
2
1
2
1
2
1
2
Usage note
Note: Statistics reported for the workload occurrence (for example,
coord_act_completed_total) are reset at the beginning of each unit of work when
they are combined with the corresponding workload statistics.
Table 239. Information returned for WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES
Column name
Data type
Description
VARCHAR(128)

VARCHAR(128)

monitor element
DBPARTITIONNUM
SMALLINT

monitor element
COORD_PARTITION_NUM
SMALLINT

APPLICATION_HANDLE
BIGINT

element
WORKLOAD_NAME
VARCHAR(128)
workload_name - Workload name monitor

element
INTEGER

UOW_ID
INTEGER
VARCHAR(32)
workload_occurrence_state - Workload
occurrence state monitor element
SYSTEM_AUTH_ID
VARCHAR(128)

monitor element
SESSION_AUTH_ID
VARCHAR(128)

monitor element
APPLICATION_NAME
VARCHAR(128)
CLIENT_WRKSTNNAME
VARCHAR(255)

monitor element
1035
Table 239. Information returned for WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES (continued)

Column name
Data type
Description
CLIENT_ACCTNG
VARCHAR(255)

element
CLIENT_USER
VARCHAR(255)
Current value of the CLIENT_USERID special

register for this workload occurrence.
CLIENT_APPLNAME
VARCHAR(255)

monitor element
INTEGER
INTEGER

INTEGER

CONCURRENT_ACT_TOP
INTEGER
concurrent_act_top - Concurrent activity top

monitor element
ADDRESS
VARCHAR(255)
address - IP address from which the connection

was initiated
APPL_ID
VARCHAR(128)
MEMBER
SMALLINT
COORD_MEMBER
SMALLINT
coord_member - Coordinator member monitor

element
WLM_GET_SERVICE_SUBCLASS_STATS table function - Return

statistics of service subclasses
The WLM_GET_SERVICE_SUBCLASS_STATS function returns basic statistics for
The functionality of WLM_GET_SERVICE_SUBCLASS_STATS is identical to the
functionality of MON_GET_SERVICE_SUBCLASS_STATS. Although the
the same. See MON_GET_SERVICE_SUBCLASS_STATS for syntax, parameters,
information returned, usage notes, and examples.
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
WLM_GET_SERVICE_SUPERCLASS_STATS - Return statistics of

service superclasses
The WLM_GET_SERVICE_SUPERCLASS_STATS function returns basic statistics for
1036
The functionality of WLM_GET_SERVICE_SUPERCLASS_STATS is identical to the

functionality of MON_GET_SERVICE_SUPERCLASS_STATS. Although the
the same. See MON_GET_SERVICE_SUPERCLASS_STATS for syntax, parameters,
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
WLM_GET_WORK_ACTION_SET_STATS - Return work action set

statistics
The WLM_GET_WORK_ACTION_SET_STATS function returns the statistics for a
work action set.
The functionality of WLM_GET_WORK_ACTION_SET_STATS is identical to the
functionality of MON_GET_WORK_ACTION_SET_STATS. Although the
the same. See MON_GET_WORK_ACTION_SET_STATS for syntax, parameters,
Authorization
v
v
v
v
v

DBADM authority
SQLADM authority
WLMADM authority

None
WLM_GET_WORKLOAD
_OCCURRENCE _ACTIVITIES - Return a list of activities
The WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES function returns the
list of all activities that were submitted by the specified application on the
specified member and have not yet been completed.
The functionality of WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES is
identical to the functionality of MON_GET_ACTIVITY. Although the functionality
for these two routines is the same, the authorization is not necessarily the same.
See MON_GET_ACTIVITY for syntax, parameters, information returned, usage
notes, and examples.
1037
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
WLM_GET_WORKLOAD_STATS table function - Return workload

statistics
The WLM_GET_WORKLOAD_STATS function returns one row of workload
The functionality of WLM_GET_WORKLOAD_STATS is identical to the
functionality of MON_GET_WORKLOAD_STATS. Although the functionality for
these two routines is the same, the authorization is not necessarily the same. See
MON_GET_WORKLOAD_STATS for syntax, parameters, information returned,
usage notes, and examples.
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
WLM_SET_CLIENT_INFO procedure - Set client information

The WLM_SET_CLIENT_INFO procedure sets client information associated with
the current connection at the DB2 server.
By using this procedure, you can set the client's user ID, application name,
workstation name, accounting information, or workload information at the DB2
server. Calling this procedure changes the stored values of the relevant transaction
processor (TP) monitor client information fields and special register settings for
this connection.
The client information fields are used at the DB2 server for determining the
identity of the application or user currently using the connection. The client
information fields for a connection are considered during DB2 workload evaluation
and also displayed in any DB2 audit records or application snapshots generated for
this connection.
1038
Unlike the sqleseti API, this procedure does not set client information at the client
but instead sets the corresponding client attributes on the DB2 server. Therefore,
you cannot use the sqleqry API to query the client information that is set at the
DB2 server using this procedure. If an application uses the sqleseti API to change
the client information, the new values will change the setting at the DB2 server. If
the sqleseti API is used to change either the user ID or the application name
without changing the accounting information, the accounting information at the
DB2 server will also be reset to the value of the accounting information at the
client.
The data values provided with the procedure are converted to the appropriate
database code page before being stored in the related TP monitor fields or special
registers. Any data value which exceeds the maximum supported size after
conversion to the database code page is truncated before being stored at the server.
The truncated values are returned by both the TP monitor fields and the special
registers when those stored values are queried.
The WLM_SET_CLIENT_INFO procedure is not under transaction control, and
client information changes made by the procedure are independent of committing
or rolling back units of work. However, because workload reevaluation occurs at
the beginning of the next unit of work for each application, you must issue either a
COMMIT or a ROLLBACK statement to make client information changes effective.
Syntax
WLM_SET_CLIENT_INFO (
client_applname ,
client_userid
client_acctstr
, client_wrkstnname
client_workload
client_userid
An input argument of type VARCHAR(255) that specifies the user ID for the
client. If you specify NULL, the value remains unchanged. If you specify an
empty string, which is the default value, the user ID for the client is reset to
the default value, which is blank.
client_wrkstnname
An input argument of type VARCHAR(255) that specifies the workstation
name for the client. If you specify NULL, the value remains unchanged. If you
specify an empty string, which is the default value, the workstation name for
the client is reset to the default value, which is blank.
client_applname
An input argument of type VARCHAR(255) that specifies the application name
for the client. If you specify NULL, the value remains unchanged. If you
specify an empty string, which is the default value, the application name for
client_acctstr
An input argument of type VARCHAR(255) that specifies the accounting string
for the client. If you specify NULL, the value remains unchanged. If you
specify an empty string, which is the default value, the accounting string for
1039
client_workload
An input argument of type VARCHAR(255) that specifies the workload
assignment mode for the client. If you specify NULL, the value remains
unchanged. The values are as follows:
Specifies that the database connection will be assigned to
SYSDEFAULTADMWORKLOAD, enabling users with ACCESSCTRL,
DATAACCESS, DBADM, SECADM, or WLMADM authority to bypass
the normal workload evaluation.
AUTOMATIC
Specifies that the database connection will be assigned to a workload
chosen by the workload evaluation that is performed automatically by
the server.
Note: The client_workload argument is case sensitive.
Authorization
v
v
v
v
DBADM authority
SQLADM authority
WLMADM authority

None
Examples
The following procedure call sets the user ID, workstation name, application name,
accounting string, and workload assignment mode for the client:
CALL SYSPROC.WLM_SET_CLIENT_INFO(db2user, machine.torolab.ibm.com,
auditor, Accounting department, AUTOMATIC)
The following procedure call sets the user ID to db2user2 for the client without
setting the other client attributes:
CALL SYSPROC.WLM_SET_CLIENT_INFO(db2user2, NULL, NULL, NULL, NULL)
The following procedure call resets the user ID for the client to blank without
modifying the values of the other client attributes:
CALL SYSPROC.WLM_SET_CLIENT_INFO(, NULL, NULL, NULL, NULL)
Usage notes
If the input that you specify for any procedure parameter exceeds its specified field
length, the input field is truncated and the procedure runs using the truncated
inputs.
Input fields containing single quotations are not supported and result in an error.
1040
WLM_SET_CONN_ENV - enable collection of activity data and

measurement of section actuals
The WLM_SET_CONN_ENV procedure enables for a particular connection the
collection of activity data and measurement of section actuals (runtime statistics
measured during section execution).
Once applied, the settings made by the WLM_SET_CONN_ENV procedure
continue to apply until explicitly overwritten by another call to the
WLM_SET_CONN_ENV procedure, or until the connection is closed. After the
connection is closed, any new connection that reuses the same application handle
does not inherit the settings of the previous connection to use that application
handle.
WLM_SET_CONN_ENV (
application_handle
, settings
Authorization
v
v
v
v
DBADM authority
SQLADM authority
WLMADM authority

None
Parameters
application_handle
An input argument of type BIGINT that specifies the application handle whose
connection environment is to be modified. The application handle specified
must refer to an existing application (otherwise, SQLSTATE 5U002 is returned).
You can use a value of NULL to indicate that the connection whose
environment is to be changed is the connection on which the procedure was
invoked.
settings
monitor settings. Settings are specified as name value pairs using the format:
<setting name tag>value</setting name tag>
Each setting can be specified a maximum of one time. Setting names are case
sensitive. A change to a setting takes effect on the next statement executed; it
has no effect on statements already in progress.
The available setting name tags are as follows.
v '<collectactdata>value</collectactdata>'
Specifies what activity data should be collected by the activity event
monitor. The possible values are (variations in spaces between words are
supported):
1041
Value
Description
NONE
Activity data should not be collected
WITHOUT DETAILS
Data about each activity is sent to any active

activities event monitor when the activity
completes execution. Details about
statement, compilation environment, and
section environment data are not sent.
WITH DETAILS
Statement and compilation environment data

is sent to any active activities event monitor,
for those activities that have them. Section
environment data is not sent.
WITH DETAILS, SECTION
Statement, compilation environment, section

environment data, and section actuals are
sent to any active activities event monitor,
for those activities that have them.
For section actuals to be collected, either
collectsectionactuals must be set to BASE or
the section_actuals database configuration
parameter must be set to BASE. Section
actuals are collected on any partition where
the activity data is collected.
WITH DETAILS, SECTION AND VALUES
Statement, compilation environment, section

environment data, section actuals, and input
data values are sent to any active activities
event monitor, for those activities that have
them.
For section actuals to be collected, either
collectsectionactuals must be set to BASE or
the section_actuals database configuration
parameter must be set to BASE. Section
actuals are collected on any partition where
the activity data is collected.
WITH DETAILS AND VALUES
Statement, compilation environment, and

input data values are sent to any active
activities event monitor, for those activities
that have them. Section environment data is
not sent.
v '<collectactpartition>COORDINATOR</collectactpartition>' or
'<collectactpartition>ALL</collectactpartition>'
Specifies where activity data is collected, either just at the coordinator
partition or at all partitions. If collectactpartition is not specified, the
connection maintains its previous value for collectactpartition which by
default is COORDINATOR.
v '<collectsectionactuals>NONE</collectsectionactuals>' or
'<collectsectionactuals>BASE</collectsectionactuals>'
Section actuals are collected if collectsectionactuals is set to BASE.
Example
The following examples both enable activity collection, without details, on the
coordinator partition for the current connection:
CALL WLM_SET_CONN_ENV(NULL,<collectactdata>WITHOUT DETAILS</collectactdata>)
1042
CALL WLM_SET_CONN_ENV(NULL,<collectactdata>WITHOUT
DETAILS</collectactdata><collectactpartition>COORDINATOR
</collectactpartition>)
The next example enables collection of activity data with section environment data
and section actuals , but no data values, on all partitions for the current
connection:
CALL WLM_SET_CONN_ENV(NULL, <collectactdata>WITH DETAILS, SECTION
</collectactdata><collectactpartition>ALL</collectactpartition>)
The following example disables collection of activity data for the current
connection.
CALL WLM_SET_CONN_ENV(NULL, <collectactdata>NONE</collectactdata>)
Usage notes
The collectactdata setting only controls activity data collection at the connection
level . An activity might have multiple activity data collection controls applied to
it, for example, the connection might be mapped to a service class where the
COLLECT ACTIVITY DATA clause has been applied. In a situation where multiple
activity data collection controls are applied, the effective setting is the combination
of all the settings. For example:
1. The connection level control is activity data without details.
2. The workload control is none.
3. The service class control is activity data with details and values.
4. When the activity completes execution, detailed information about the activity
plus data values is sent to any active event monitors.
If a setting is not specified in the input of the WLM_SET_CONN_ENV procedure,
it is not altered in the connection environment.
The effective setting for the collection of section actuals is the combination of the
collectsectionactuals setting and the section_actuals database configuration
parameter. For example, if collectsectionactuals is set to BASE and the
section_actuals database configuration parameter value is NONE, the effective
setting for the collection of section actuals is BASE (and vice versa).
Automatic client rerouting cannot be performed for a connection when activity
data and section actuals are being collected (when collectactdata is set to any value
other than NONE).
Miscellaneous routines and views

ALTOBJ
The ALTOBJ procedure parses an input CREATE TABLE statement that serves as
the target data definition language (DDL) for an existing table that is to be altered.
The procedure backs up the data of the table being altered, then drops the original
table and creates a new version using the DDL statement; the final step loads the
stored data back into the new table.
This procedure supports the following alter table operations and maintains
recoverable dependencies:
v Renaming a column
1043
v Increasing or decreasing the size of a column

v Altering a column type and transforming existing data using DB2 scalar
functions
v Changing the precision or the scale of decimal values
v Changing the default value of a column
v Changing the nullability attribute of a column to nullable
v Dropping a column
Syntax
ALTOBJ (
exec-mode , sql-stmt
, alter-id
, msg
exec-mode
An input argument of type VARCHAR(30) that specifies one of the following
execution modes:
'GENERATE'
Specifies that all the scripts required by the VALIDATE, APPLY, and
UNDO modes are to be generated.
'VALIDATE'
Specifies that the statement syntax is to be validated. This option also
generates a script to manage the processing of related objects and
relationships for the table that is to be altered.
'APPLY_CONTINUE_ON_ERROR' or 'APPLY_STOP_ON_ERROR'
Specifies that a script to manage the processing of related objects and
relationships for the table that is to be altered is to be generated. Data from
the original table is to be exported, transformed, and used to populate the
new table.
'UNDO'
Specifies that any changes made by the alter table operation are to be
undone, in case a rollback operation cannot recover errors that might have
occurred. This mode is only possible if the original table and any
generated scripts have not been deleted.
'FINISH'
Specifies that the renamed original table is to be dropped.
sql-stmt
An input argument of type VARCHAR(2048) that specifies a CREATE TABLE
statement that will be used as a template for altering an existing table. When
exec-mode is 'GENERATE', sql-stmt must not be the null value. Otherwise, sql-stmt
can be the null value, but only if alter-id is not -1.
alter-id
An input and output argument of type INTEGER that identifies all of the
statements that are generated by this call. If -1 is specified, a new identifier
will be generated and returned to the caller. Any existing statements identified
by the specified integer are overwritten.
msg
An output argument of type VARCHAR(2048) containing an SQL query that
1044
you can execute to display all of the SQL statements generated for or used by
the alter table process under the specified execution mode.
Authorization
DBADM authority and authorization to execute the LOAD command are required
to execute this function.

Examples
Example 1: Run the ALTOBJ procedure to alter column CL2 in table T1 from type
INTEGER to BIGINT. The original data definition language for table T1 is:
CREATE TABLE T1 (CL1 VARCHAR(5), CL2 INTEGER)
The ALTOBJ procedure call to alter the column data type is:
CALL SYSPROC.ALTOBJ(APPLY_CONTINUE_ON_ERROR,
CREATE TABLE T1 (CL1 VARCHAR(5), CL2 BIGINT), -1, ?)
Note: If you see the following error, try to increase the applheapsz parameter
value:
SQL0443N Routine "SYSPROC.ALTOBJ" (specific name "ALTOBJ") has returned an
error SQLSTATE with diagnostic text "SQL0954 ". SQLSTATE=38553
Example 2: Run the ALTOBJ procedure in VALIDATE mode with alter-id input.
CALL SYSPROC.ALTOBJ(VALIDATE, CAST (NULL AS VARCHAR(2048)), 123, ?)
Usage notes
Although the procedure drops and re-creates the table, the user who created the
original table will remain as the table definer. However, an audit will show that
the table has been dropped and re-created by the user running the procedure.
This procedure does not support the following alter table operations:
v Altering materialized query tables (MQTs) is not supported. Altering a table
which contains an MQT is supported.
v
v
v
v
Altering typed tables is not supported.

Altering a remote table using a nickname is not supported.
Column sequence cannot be reordered.
Adding and removing, or renaming and removing columns in one call to the
procedure is not supported, but adding and renaming columns is supported.
This is because the only way to indicate how the table is to be altered is by the
use of the target DDL, rather than column matching information. The following
rules are followed by the ALTOBJ procedure when transforming data from the
existing table to the altered table:
1. If the number of columns in the existing table is the same as the altered
table, it is assumed that no columns are being added or removed. The
columns in this case can only be renamed, and are matched by column
index.
1045
2. If the number of columns in the existing table is less than in the altered table,
it is assumed that columns are being added. The columns can be renamed,
and the new columns are added at the end. The existing columns are
matched by index.
3. If the number of columns in the existing table is greater than in the altered
table, it is assumed that columns are being removed. The columns cannot be
renamed and matched by name. The column that is being dropped can be
any existing column in the table.
v Structured type UDTs and Reference type UDTs are not supported.
v MQTs defined on a base table which is altered are not populated during the
alter table process.
If a table is altered using the ALTOBJ procedure, and the table has an MQT
defined, the MQT will be created, but it will not be populated with data.
If a table is altered using the ALTOBJ procedure, and the table has an MQT
defined, any columns that are not part of the select result from the table being
altered are lost because the MQT content is rebuilt from the new base table.
The definition of the objects might change between ALTOBJ procedure calls
because there are no object locks that persist through different sessions.
The table profiles (such as RUNSTATS profile) that are associated with the table are
lost after going through this extensive alter process.
The SYSTOOLSPACE is used for the routine's operation tables to store metadata;
that is, data used to describe database objects and their operation.
If the table has row or column access control activated, ALTOBJ on that table will
result in an error (DBA7903).
COMPILATION_ENV table function - Retrieve compilation

environment elements
The COMPILATION_ENV table function returns the elements of a compilation
environment.
Syntax
COMPILATION_ENV (
compilation-env

compilation-env
An input argument of type BLOB(2M) that contains a compilation environment
obtained from the comp_env_desc (compilation environment) monitor element.
Authorization
v DBADM authority
1046
v SQLADM authority

The function returns a table of two columns (see Table 240 on page 1048): NAME
VARCHAR(256) and VALUE VARCHAR(1024). The possible values for the
compilation environment element names are described in Table 241 on page 1048.
The origin of the element values depends primarily on whether the SQL statement
is issued dynamically or bound as part of a package.
The number and types of entries in a compilation environment can change over
time as capabilities are added to the DB2 database manager. If the compilation
environment is from a different DB2 database manager level than the level on
which this function is executing, only those elements that are recognized by the
level of the function are returned. The descriptions of the elements might also vary
from release to release.
Examples
Example 1: Request all the elements of a specific compilation environment that was
previously captured by a deadlock event monitor. A deadlock event monitor that is
created specifying the WITH DETAILS HISTORY option will capture the
compilation environment for dynamic SQL statements. This captured environment
is what is accepted as input to the table function.
SELECT NAME, VALUE
FROM TABLE(SYSPROC.COMPILATION_ENV(:hv1)) AS t
Example 2: Request a specific element (the default schema) of a compilation

environment.
SELECT NAME, VALUE
FROM TABLE(SYSPROC.COMPILATION_ENV(:hv1)) AS t
WHERE NAME = SCHEMA
Example 3: Display the compilation environment for a specific statement in the

package cache.
1. Obtain the executable ID, which is used to identify the statement of interest,
using the following statement:
SELECT EXECUTABLE_ID, VARCHAR{STMT_TEXT, 100)
FROM TABLE(MON_GET_PKG_CACHE_STMT(NULL,NULL,NULL,-1)) AS t
The following is an example output after executing the preceding statement:

EXECUTABLE_ID
2
------------------------------------------------------------------- -------------------------------------------------x0100000000000000010000000000000000000000020020090914151405241700 select count(*) from syscat.tables
...
2. Investigate the compilation environment for the statement (identified using the
executable ID) and format the compilation environment using the
COMPILATION_ENV table function. The following statement is an example of
how this can be done:
SELECT VARCHAR(NAME, 30), VARCHAR(VALUE, 50)
FROM TABLE(COMPILATION_ENV((SELECT COMP_ENV_DESC FROM TABLE
(MON_GET_PKG_CACHE_STMT(NULL,
x0100000000000000010000000000000000000000020020090914151405241700,
NULL, -1)) AS t))) AS s
1047
The following is an example output after executing the preceding statement:

1
-----------------------------ISOLATION
QUERY_OPTIMIZATION
MIN_DEC_DIV_3
DEGREE
SQLRULES
REFRESH_AGE
RESOLUTION_TIMESTAMP
FEDERATED_ASYNCHRONY
PATH
MAINTAINED_TABLE_TYPE
2
-------------------------------------------------CS
5
NO
1
DB2
+00000000000000.000000
2009-09-14-15.14.05.000000
0
"SYSIBM","SYSFUN","SYSPROC","SYSIBMADM","SWALKTY"
SYSTEM
Table 240. Information returned by the COMPILATION_ENV table function
Column name
Data type
Description
NAME
VARCHAR(256)
Element of compilation
environment. See Table 241
for more details.
VALUE
VARCHAR(1024)
Value of the element.
Table 241. Elements of a compilation environment returned by the COMPILATION_ENV

table function
1048
Element name
Description
ISOLATION
The isolation level passed to the SQL compiler. The value is

obtained from either the CURRENT ISOLATION special
register or the ISOLATION bind option of the current
package.
QUERY_OPTIMIZATION
The query optimization level passed to the SQL compiler.

The value is obtained from either the CURRENT QUERY
OPTIMIZATION special register or the QUERYOPT bind
option of the current package.
MIN_DEC_DIV_3
The requested decimal computational scale passed to the

SQL compiler. The value is obtained from the
min_dec_div_3 database configuration parameter.
DEGREE
The requested degree of intra-parallelism passed to the SQL

compiler. The value is obtained from either the CURRENT
DEGREE special register or the DEGREE bind option of the
current package.
SQLRULES
The requested SQL statement behaviors passed to the SQL

compiler. The value is derived from the setting of the
LANGLVL bind option of the current package. The possible
values are 'DB2' or 'SQL92'.
REFRESH_AGE
The allowable data latency passed to the SQL compiler. The

value is obtained from either the CURRENT REFRESH
AGE special register or the REFRESHAGE bind option of the
current package.
SCHEMA
The default schema passed to the SQL compiler. The value

is obtained from either the CURRENT SCHEMA special
register or the QUALIFIER bind option of the current
package.
Table 241. Elements of a compilation environment returned by the COMPILATION_ENV

table function (continued)
Element name
Description
PATH
The function path passed to the SQL compiler. The value is

obtained from either the CURRENT PATH special register
or the FUNC_PATH bind option of the current package.
TRANSFORM_GROUP
The transform group information passed to the SQL

compiler. The value is obtained from either the CURRENT
DEFAULT TRANSFORM GROUP special register or the
TRANSFORMGROUP package bind option.
MAINTAINED_TABLE
_TYPE
An indicator of what table types can be considered for

optimization, passed to the SQL compiler. The value is
obtained from the CURRENT MAINTAINED TABLE
TYPES FOR OPTIMIZATION special register.
RESOLUTION
_TIMESTAMP
The timestamp that is to be used by the SQL compiler for

resolving items such as function and data type references in
an SQL statement. This timestamp is either the current
timestamp or the timestamp of the last explicit bind
operation for the current package.
FEDERATED
_ASYNCHRONY
The requested degree of federated asynchrony parallelism

passed to the SQL compiler. The value is obtained from
either the CURRENT FEDERATED ASYNCHRONY special
register or the FEDERATED_ASYNCHRONY bind option of the
current package.
CONTACTGROUPS administrative view - Retrieve the list of

contact groups
The CONTACTGROUPS administrative view returns the list of contact groups,
which can be defined locally on the system or in a global list.
Authorization
v
v
v
v
v
SELECT privilege on the CONTACTGROUPS administrative view

CONTROL privilege on the CONTACTGROUPS administrative view
DBADM authority
SQLADM authority

Example
Retrieve all contact group lists.
SELECT * FROM SYSIBMADM.CONTACTGROUPS
1049

NAME
-------...--group1
group1
group2
group3
group5
group6
group7
DESCRIPTION
------------------------...--DBA Group1 Contact List
DBA Group1 Contact List
DBA Group2 List
DBA Group5
DBA Group6
MEMBERNAME
-----------...--name1
name9
name2
group2
group2
group3
name1
MEMBERTYPE
---------CONTACT
CONTACT
CONTACT
GROUP
GROUP
GROUP
CONTACT
Usage note
Table 242. Information returned by the CONTACTGROUPS administrative view
Column name
Data type
Description
NAME
VARCHAR(128)
Name of the contact group.
DESCRIPTION
VARCHAR(128)
Description of the contact

group.
MEMBERNAME
VARCHAR(128)
Name of the member in the

contact group. This name can
refer to a contact or another
contact group.
MEMBERTYPE
VARCHAR(7)
Type of member in the

contact group. The type is
either CONTACT or GROUP.
CONTACTS administrative view - Retrieve list of contacts

The CONTACTS administrative view returns the list of contacts defined on the
database server.
Authorization
v SELECT privilege on the CONTACTS administrative view
v CONTROL privilege on the CONTACTS administrative view
v DBADM authority
v SQLADM authority

1050
Example
Retrieve all contacts.
SELECT * FROM SYSIBMADM.CONTACTS

NAME
-----...user1
user2
user3
user5
TYPE
----EMAIL
EMAIL
PAGE
EMAIL
ADDRESS
MAX_PAGE_LENGTH DESCRIPTION
----------------...- --------------- ------------------...user3@ca.ibm.com
- DBA Extraordinaire
user2@ca.ibm.com
- DBA on Email
user3@ca.ibm.com
128 DBA on Page
user2@ca.ibm.com
- DBA Extraordinaire
Usage note
Table 243. Information returned by the CONTACTS administrative view
Column name
Data type
Description
NAME
VARCHAR(128)
Name of contact.
TYPE
VARCHAR(5)
Type of contact:
v 'EMAIL'
v 'PAGE'
ADDRESS
VARCHAR(128)
address - IP address from

which the connection was
initiated
MAX_PAGE_LENGTH
INTEGER
Maximum message length.

Used for example, if the
paging service has a
message-length restriction.
DESCRIPTION
VARCHAR(128)
Description of contact.
DB_HISTORY administrative view - Retrieve history file

information
The DB_HISTORY administrative view returns information from the history files
from all database partitions.
Authorization
v SELECT privilege on the DB_HISTORY administrative view
v CONTROL privilege on the DB_HISTORY administrative view
v DBADM authority
v SQLADM authority
1051

Usage note
When a data partitioned table is reorganized, one record for each reorganized data
partition is returned. If only a specific data partition of a data partitioned table is
reorganized, only a record the for the partition is returned.
Example
Select the database partition number, entry ID, operation, start time, and status
information from the database history files for all the database partitions of the
database to which the client is currently connected.
SELECT DBPARTITIONNUM, EID, OPERATION, START_TIME, ENTRY_STATUS
FROM SYSIBMADM.DB_HISTORY

DBPARTITIONNUM EID
OPERATION START_TIME
ENTRY_STATUS
-------------- -------------------- --------- -------------- -----------0
1 A
20051109185510 A
Table 244. Information returned by the DB_HISTORY administrative view
1052
Column name
Data type
Description
DBPARTITIONNUM
SMALLINT
element
EID
BIGINT
Number that uniquely

identifies an entry in the
history file.
START_TIME
VARCHAR(14)
start_time - Event Start Time

monitor element
SEQNUM
SMALLINT
Sequence number.
END_TIME
VARCHAR(14)
Timestamp marking the end

of a logged event.
NUM_LOG_ELEMS
INTEGER
Number of log streams that

will be returned in the lists
of log stream data in the
FIRSTLOG and LASTLOG
columns.
FIRSTLOG
VARCHAR(4000)
Name of the earliest

transaction log associated
with an event.
LASTLOG
VARCHAR(4000)
Name of the latest

transaction log associated
with an event.
BACKUP_ID
VARCHAR(24)
Backup identifier or unique

table identifier.
Table 244. Information returned by the DB_HISTORY administrative view (continued)

Column name
Data type
Description
TABSCHEMA
VARCHAR(128)

TABNAME
VARCHAR(128)

monitor element
COMMENT
VARCHAR(254)
System-generated comment
text associated with a logged
event.
CMD_TEXT
CLOB(2 M)
Data definition language

associated with a logged
event.
NUM_TBSPS
INTEGER
num_tbsps - Number of table

spaces monitor element
TBSPNAMES
CLOB(5 M)
Names of the table spaces

event.
OPERATION
CHAR(1)
Operation identifier. See

Table 245 on page 1055 for
possible values.
OPERATIONTYPE
CHAR(1)
Action identifier for an

operation. See Table 245 on
page 1055 for possible
values.
OBJECTTYPE
CHAR(1)
Identifier for the target object

of an operation. The possible
values are: D for full
database, I for index, P for
table space, R for partitioned
table, and T for table.
LOCATION
VARCHAR(255)
Full path name for files, such

as backup images or load
input files, that are
associated with logged
events. In the case of CLI
LOAD or LOAD from
CURSOR, the location is an
SQL statement.
DEVICETYPE
CHAR(1)
Identifier for the device type

event. This field determines
how the LOCATION field is
interpreted. The possible
values are: A for TSM, C for
client, D for disk, F for
snapshot backup, K for
diskette, L for local, N
(generated internally by
DB2), O for other (for other
vendor device support), P for
pipe, Q for cursor, R for
remote fetch data, S for
server, T for tape, U for user
exit, and X for X/Open
XBSA interface.
1053
1054
Column name
Data type
Description
ENTRY_STATUS
CHAR(1)
Identifier for the status of an

entry in the history file. The
possible values are: A for
active, D for deleted (future
use), E for expired, I for
inactive, N for not yet
committed, Y for committed
or active.
SQLCAID
VARCHAR(8)
An "eye catcher" for storage

dumps containing 'SQLCA',
as it appears in the
SQLCAID field of the SQL
communications area
(SQLCA).
SQLCABC
INTEGER
Length of the SQLCA, as it

appears in the SQLCABC
field of the SQLCA.
SQLCODE
INTEGER
SQL return code, as it

appears in the SQLCODE
field of the SQLCA.
SQLERRML
SMALLINT
Length indicator for

SQLERRMC, as it appears in
the SQLERRML field of the
SQLCA.
SQLERRMC
VARCHAR(70)
Contains one or more tokens,

separated by X'FF', as they
appear in the SQLERRMC
field of the SQLCA. These
tokens are substituted for
variables in the descriptions
of error conditions.
SQLERRP
VARCHAR(8)
A three-letter identifier
indicating the product,
followed by five
alphanumeric characters
indicating the version,
release, and modification
level of the product, as they
appear in the SQLERRP field
of the SQLCA.
SQLERRD1
INTEGER
See SQLCA (SQL

communications area) in
SQL Reference Volume 1.
SQLERRD2
INTEGER
See SQLCA (SQL

SQLERRD3
INTEGER
See SQLCA (SQL

SQLERRD4
INTEGER
See SQLCA (SQL


Column name
Data type
Description
SQLERRD5
INTEGER
See SQLCA (SQL

SQLERRD6
INTEGER
See SQLCA (SQL

SQLWARN
VARCHAR(11)
A set of warning indicators,

each containing a blank or
'W'. See SQLCA (SQL
SQLSTATE
VARCHAR(5)
A return code that indicates

the outcome of the most
recently executed SQL
statement, as it appears in
the SQLSTATE field of the
SQLCA.
Table 245. OPERATION and OPERATIONTYPE values

Operation value
Operation value description
Operation type
Add table space
None
Backup
Operation types are:

v D = delta offline
v E = delta online
v F = offline
v I = incremental offline
v N = online
v O = incremental online
Load copy
None
Dropped table
None
Rollforward

v E = end of logs
v P = point in time
Reorganize table

v F = offline
v N = online
Load

v I = insert
v R = replace
Rename table space
None
Drop table space
None
Quiesce

v S = quiesce share
v U = quiesce update
v X = quiesce exclusive
v Z = quiesce reset
1055
Table 245. OPERATION and OPERATIONTYPE values (continued)

Operation value
Operation value description
Operation type
Restore

v F = offline
v I = incremental offline
v N = online
v O = incremental online
v R = rebuild
Alter table space

v C = add containers
v R = rebalance
Unload
None
Archive logs

v F = fail archive path
v M = mirror log path
v N = forced truncation via
ARCHIVE LOG command
v P = primary log path
v 1 = first log archive method
v 2 = second log archive method
DBPATHS administrative view and ADMIN_LIST_DB_PATHS table

function - Retrieve database paths
The DBPATHS administrative view and the ADMIN_LIST_DB_PATHS table
function return the values for database paths that are required for tasks such as
creating split mirror backups.
v DBPATHS administrative view
v ADMIN_LIST_DB_PATHS table function on page 1057
DBPATHS administrative view

Authorization
v SELECT privilege on the DBPATHS administrative view
v CONTROL privilege on the DBPATHS administrative view
v DBADM authority
v SQLADM authority
v SYSMON
v SYSCTRL
v SYSMAINT
1056
v SYSADM

Example
The following statement retrieves all database paths:
select dbpartitionnum, substr(type,1,20) as type, path from sysibmadm.dbpaths

DBPARTITIONNUM
-------------0
0
0
0
0
TYPE
-------------------LOGPATH
DB_STORAGE_PATH
LOCAL_DB_DIRECTORY
DBPATH
DBPATH
PATH
-----------------------------------------------/home/sun/sun/NODE0000/SQL00001/LOGSTREAM0000/
/home/sun/
/home/sun/sun/NODE0000/sqldbdir/
/home/sun/sun/NODE0000/SQL00001/
/home/sun/sun/NODE0000/SQL00001/MEMBER0000/
ADMIN_LIST_DB_PATHS table function

The ADMIN_LIST_DB_PATHS table function returns the list of files required for
backup mechanisms such as split mirror backup.
Syntax
ADMIN_LIST_DB_PATHS (
Authorization
v EXECUTE privilege on the ADMIN_LIST_DB_PATHS table function
In addition, one of the following authorities is also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1057
Example
The ADMIN_LIST_DB_PATHS table function can be invoked as follows:
SELECT DBPARTITIONNUM, TYPE, PATH FROM TABLE(ADMIN_LIST_DB_PATHS()) AS FILES

DBPARTITIONNUM
-------------2
2
2
2
2
2
2
0
0
0
0
0
0
0
1
1
1
1
1
1
1
TYPE
---------------------LOGPATH
DB_STORAGE_PATH
TBSP_DIRECTORY
TBSP_CONTAINER
LOCAL_DB_DIRECTORY
DBPATH
DBPATH
LOGPATH
DB_STORAGE_PATH
TBSP_DIRECTORY
TBSP_CONTAINER
LOCAL_DB_DIRECTORY
DBPATH
DBPATH
LOGPATH
DB_STORAGE_PATH
TBSP_DIRECTORY
TBSP_CONTAINER
LOCAL_DB_DIRECTORY
DBPATH
DBPATH
PATH
-------------------------------------------------/home/sun/sun/NODE0002/SQL00001/LOGSTREAM0002/
/home/sun/
/home/sun/tablespace/sms/sms2/
/home/sun/tablespace/dms/dms2
/home/sun/sun/NODE0000/SQL00001/LOGSTREAM0000/
/home/sun/
/home/sun/sun/NODE0001/SQL00001/LOGSTREAM0001/
/home/sun/
If the storage library performing the split mirror operation treats files and
directories on raw devices differently than those on regular file systems, you can
use the following query to obtain the list for all locations on raw devices:
SELECT DBPARTITIONNUM, TYPE, PATH
FROM TABLE(ADMIN_LIST_DB_PATHS()) AS FILES
WHERE TYPE LIKE %_DEVICE%
1058
Second, the list of files and directories on regular file systems:

SELECT DBPARTITIONNUM, TYPE, PATH
FROM TABLE(ADMIN_LIST_DB_PATHS()) AS FILES
WHERE TYPE NOT LIKE %_DEVICE%
Table 246. Information returned by the DBPATHS administrative view and the
ADMIN_LIST_DB_PATHS table function
Column name
Data type
Description
DBPARTITIONNUM
SMALLINT
element
TYPE
VARCHAR(64)
Describes the type of

database object that the path
belongs to. For example the
path to the log directory
indicated by the LOGPATH
parameter would be shown
in this column as LOGPATH.
See Table 247 for a list of
possible return values.
PATH
VARCHAR(5000)
Path to location where the

database manager has a file
or directory located. If the
path ends with the file
system delimiter ('/' on
UNIX environments, '\' on
Windows environments), the
path points to a directory.
Table 247. TYPE column values

Type value
Description
TBSP_DEVICE
Raw device for a database managed space

(DMS) table space.
TBSP_CONTAINER
File container for a DMS table space.
TBSP_DIRECTORY
Directory for a system managed space (SMS)

table space.
LOGPATH
Primary log path.
LOGPATH_DEVICE
Raw device for primary log path.
MIRRORLOGPATH
Database configuration mirror log path.
DB_STORAGE_PATH
Automatic storage path.
DBPATH
Database directory path.
LOCAL_DB_DIRECTORY
Path to the local database directory.
v For table spaces using automatic storage, both used and unused storage paths
are returned. You require the unused automatic storage paths if you restore by
using a split mirror backup.
Consider the following example. A split mirror backup is taken on a production
system. After the backup is completed, the automatic storage paths that were not
in use before the backup are now in use in production. Assume that there is
now a need to restore the database by using the split mirror backup. At this
1059
point, it is necessary to roll forward the logs from the production database. To
roll forward the logs, all of the automatic storage paths are required, because all
automatic storage paths are now in use.
v Table space containers that are managed by automatic storage are not returned
individually. Instead, they are reflected in the automatic storage path column.
v The automatic storage paths are returned once per database partition.
v The values returned for the logpath and mirrorlogpath configuration parameters
are the values stored in memory. Changed values that are stored on disk, which
are applicable only after a database restart, are not returned.
v If you use output from the SELECT * FROM SYSIBMADM.DBPATHS query to create a
db2relocatedb command configuration file (a file containing the configuration
information that is necessary for relocating a database), you must modify the
DBPATH output appropriately before you can use it in the configuration file.
For example, consider the following DBPATH output:
/storage/svtdbm3/svtdbm3/NODE0000/SQL00001/
You can use this output to specify the value of the DB_PATH parameter in a
db2relocatedb command configuration file, as follows:
DB_PATH=/storage/svtdbm3,/storage_copy2/svtdbm3
v The LOCAL_DB_DIRECTORY path might contain information belonging to

multiple databases. Because each database that you create in the same directory
does not have its own sqldbdir file, ensure that the target system to which you
copy files does not have any databases already in that path.
v If two or more databases share at least one automatic storage path, the split
mirror operation for one of these databases might affect more than one database,
causing I/O problems for the databases that you did not intend to split.
v The DB_STORAGE_PATH type includes all storage paths from all defined
storage groups. If a storage path is used by multiple storage groups or is
specified multiple times in the same storage group, one record is returned for
each occurrence of the path in a storage group.
Restriction
You cannot call the administrative view when the database is in WRITE SUSPEND
mode. Also, you must ensure that the physical layout of the database does not
change between the invocation of the view and the activation of WRITE SUSPEND
mode, which is needed to perform a split mirror operation. You might not be able
to restore from the split mirror backup image if, for example, the table space layout
changed in that time.
GET_DBSIZE_INFO
The GET_DBSIZE_INFO procedure calculates the database size and maximum
capacity.
Authorization
v EXECUTE privilege on the GET_DBSIZE_INFO, WLM_SET_CONN_ENV,
MON_GET_CONTAINER, and MON_GET_TABLESPACE routines
1060

Syntax
GET_DBSIZE_INFO (
snapshot-timestamp
, dbsize
, dbcapacity
refresh-window )
snapshot-timestamp
An output parameter of type TIMESTAMP that returns the time at which dbsize
and dbcapacity were calculated. This timestamp, along with the value of
refresh-window, is used to determine when the cached values in the
SYSTOOLS.STMG_DBSIZE_INFO table need to be refreshed.
dbsize
An output parameter of type BIGINT that returns the size of the database (in
bytes). The database size is calculated as follows: dbsize = sum (used_pages *
page_size) for each table space (SMS & DMS).
dbcapacity
An output parameter of type BIGINT that returns the database capacity (in
bytes). This value is not available on partitioned database systems. The
database capacity is calculated as follows: dbcapacity = SUM (DMS
usable_pages * page size) + SUM (SMS container size + file system free size
per container). If multiple SMS containers are defined on the same file system,
the file system free size is included only once in the calculation of capacity.
refresh-window
An input argument of type INTEGER that specifies the number of minutes
until the cached values for database size and capacity are to be refreshed.
Specify -1 for the default refresh window of 30 minutes. A refresh window of 0
forces an immediate refreshing of the cached values.
Usage notes
The calculated values are returned as procedure output parameters and are cached
in the SYSTOOLS.STMG_DBSIZE_INFO table. The procedure caches these values
because the calculations are costly. The SYSTOOLS.STMG_DBSIZE_INFO table is
created automatically the first time the procedure executes. If there are values
cached in the SYSTOOLS.STMG_DBSIZE_INFO table and they are current enough,
as determined by the snapshot-timestamp and refresh-window values, these cached
values are returned. If the cached values are not current enough, new cached
values are calculated, inserted into the SYSTOOLS.STMG_DBSIZE_INFO table and
returned, and the snapshot-timestamp value is updated.
To ensure that the data is returned by all partitions for a global table space
snapshot, the database must be activated.
The SYSTOOLSPACE is used for the routine's operation tables to store metadata;
that is, data used to describe database objects and their operation.
1061
Examples
Example 1: Get the database size and capacity using a default refresh window of 30
minutes. The database size and capacity will be recalculated when the cached data
is older than 30 minutes.
CALL GET_DBSIZE_INFO(?, ?, ?, -1)
The procedure returns:

-------------------------Parameter Name : SNAPSHOTTIMESTAMP
Parameter Value : 2004-02-29-18.31.55.178000
Parameter Name : DATABASESIZE
Parameter Value : 22302720
Parameter Name : DATABASECAPACITY
Return Status = 0
Example 2: Get the database size and capacity using a refresh window of 0 minutes.
The database size and capacity will be recalculated immediately.
CALL GET_DBSIZE_INFO(?, ?, ?, 0)

Parameter Value : 2004-02-29-18.33.34.561000
Return Status = 0
Example 3: Get the database size and capacity using a refresh window of 24 hours.
The database size and capacity will be recalculated when the cached data is older
than 1440 minutes.
CALL GET_DBSIZE_INFO(?, ?, ?, 1440)

Parameter Value : 2004-02-29-18.33.34.561000
Return Status = 0
1062
NOTIFICATIONLIST administrative view - Retrieve contact list for

health notification
The NOTIFICATIONLIST administrative view returns the list of contacts and
contact groups that are notified about the health of an instance.
Authorization
v SELECT privilege on the NOTIFICATIONLIST administrative view
v CONTROL privilege on the NOTIFICATIONLIST administrative view
v DBADM authority
v SQLADM authority

Example
The NOTIFICATIONLIST administrative view returns the list of contacts and
contact groups that are notified about the health of an instance.
NAME
------------...------group3
user4
group3
TYPE
------GROUP
CONTACT
GROUP
Table 248. Information returned by the NOTIFICATIONLIST administrative view
Column name
Data type
Description
NAME
VARCHAR(128)
Name of contact.
TYPE
VARCHAR(7)
Type of contact:
v 'CONTACT'
v 'GROUP'
PD_GET_DIAG_HIST - Return records from a given facility

The PD_GET_DIAG_HIST table function returns log records, event records and
notification records from a given facility. Options are also supported to filter based
on the type of record, customer impact value of the record and from-until
timestamps.
Syntax
1063
PD_GET_DIAG_HIST ( facility , rectype , impact , start_time , end_time , member )

facility
An optional input argument of type VARCHAR(20) that specifies the facility
from which records are to be returned. A facility is a logical grouping that
records relate to. The possible values are:
v ALL: Returns records from all facilities
v MAIN: Returns records from the DB2 general diagnostic logs. This currently
means the db2diag log files, the admin notification log, and the rotating
event logs.
v OPTSTATS: Return records related to optimizer statistics
If this parameter is null or an empty string (''), 'ALL' is the default.
rectype
An optional input argument of type VARCHAR(30) that specifies which record
type to return. A combination of types separated by '+' are supported, for
example: 'D + EI'. The possible values are:
v 'ALL': Return all record types.
v 'D': Return all diagnostic records.
v 'E': Return all event records.
v 'DI': Internal diagnostic records. These are non-translated diagnostic record
that are used by IBM support in a diagnostic situation.
v 'DX': External diagnostic records. These are translated diagnostic that are of
use to the user. These records are the notification records.
v 'EI': Internal event record. These are event record that are used by IBM
support in a diagnostic situation.
v 'EX': External event record. These are diagnostic record that are of use to the
user.
If this parameter is null or an empty string (''), all records are returned.
impact
An optional input argument of type VARCHAR(18) that specifies the minimum
customer impact level of the record returned. The possible values are:
v 'NONE'
v
v
v
v
'UNLIKELY'
'POTENTIAL'
'IMMEDIATE'
'CRITICAL'
If this parameter is null or an empty string (''), all records are returned.
start_time
An optional input argument of type TIMESTAMP that specifies a valid
timestamp. Entries are returned if their timestamp is more recent than this
value. If this parameter is null, records are returned regardless of how old they
are.
end_time
An optional input argument of type TIMESTAMP that specifies a valid
1064
timestamp. Entries are returned if their timestamp is older than this value. If
this parameter is null, records are returned regardless of how recent they are.
member
member from which the records should be fetched. Specify -1 or null for the
current member, or -2 for information from all active database members. An
active database member is where the database is available for connection and
use by applications. If the parameter is not specified, the default value is all
active database members.
Authorization
v DBADM authority
v SQLADM authority

Examples
Example 1: Retrieve records from a given facility.
SELECT FACILITY, RECTYPE, TIMESTAMP, IMPACT, SUBSTR(MSG,1, 50) AS MSG
FROM TABLE (PD_GET_DIAG_HIST( MAIN, E, , NULL,
NULL ) ) AS T
WHERE T.PROCESS_NAME = db2star2 OR T.PROCESS_NAME = db2stop2

FACILITY
-------------------MAIN
MAIN
RECTYPE
------EX
EX
TIMESTAMP
-------------------------2007-06-25-11.34.05.756171
2007-06-25-11.34.25.946646
...
...
...
...

...
...
...
...
IMPACT
------------------
MSG
-------------------------------------------------ADM7514W Database manager has stopped.
ADM7513W Database manager has started.
Example 2: Retrieve records for a specific member.

SELECT MEMBER,DBPARTITIONNUM, FACILITY, RECTYPE, TIMESTAMP, IMPACT,
SUBSTR(MSG,1, 50) AS MSG FROM TABLE (PD_GET_DIAG_HIST(MAIN, E, ,
CAST (NULL AS TIMESTAMP), CAST (NULL AS TIMESTAMP), NULL ) ) AS T
WHERE T.PROCESS_NAME = db2star2 OR T.PROCESS_NAME = db2stop2 ORDER BY MEMBER

MEMBER
--------0
0
0
DBPARTITIONNUM
----------------0
0
0
FACILITY
------------MAIN
MAIN
MAIN
RECTYPE
------EI
EI
EI
TIMESTAMP
-------------------------2011-04-28-09.44.57.720041
2011-04-28-09.44.57.723015
2011-04-28-09.44.57.723736
...
...
...
...
...
1065
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
MAIN
MAIN
MAIN
MAIN
MAIN
MAIN
MAIN
MAIN
MAIN
EI
EX
EI
EI
EI
EI
EI
EI
EI
2011-04-28-09.44.59.409586
2011-04-28-09.45.01.554096
2011-04-28-09.45.01.605231
2011-04-28-12.34.20.571551
2011-04-28-12.34.20.574612
2011-04-28-12.34.20.575323
2011-04-28-12.34.20.602452
2011-04-28-12.34.20.665227
2011-04-28-09.44.57.715392
...
...
...
...
...
...
...
...
...

... IMPACT
... -----------------... ... ... ... ... ... ... ... ... ... ... ... -
MSG
-------------------------------------------------Obtained exclusive mode lock on the file:
ADM7513W Database manager has started.
Released lock on the file:
Obtained exclusive mode lock on the file:
ZRC=0xFFFFFBFE=-1026
Released lock on the file:
-
Usage note
The PD_GET_DIAG_HIST table function requires that the associated database has
a temporary table space with minimum page size of 8K. If the page size is less
than 8K, the function will return an SQL1585N error message.
Table 249. Information returned by the PD_GET_DIAG_HIST table function
Column Name
Data Type
Description
FACILITY
VARCHAR(20)
A facility is a logical grouping which records relate to.

The possible values are:
v ALL: Returns records from all facilities
v MAIN: Returns records from the DB2 general
diagnostic logs. This currently means the db2diag log
files, the admin notification log, and the rotating event
logs.
v OPTSTATS: Return records related to optimizer
statistics
RECTYPE
VARCHAR(3)
The type of record. The possible values are:

v 'DI': Internal diagnostic record
v 'DX': External diagnostic record
v 'EI': Internal event record
v 'EX': External event record
TIMESTAMP
TIMESTAMP
The time that the message was created.
TIMEZONE
INTEGER
The time difference (in minutes) from the Universal

Coordinated Time (UCT). For example, -300 is EST.
INSTANCENAME
VARCHAR(128)
The name of the instance where the message was

created.
1066
Table 249. Information returned by the PD_GET_DIAG_HIST table function (continued)

Column Name
Data Type
Description
DBPARTITIONNUM
SMALLINT

element
LEVEL
CHAR(1)
The severity level of the record. The possible values are:

v 'C': Critical
v 'E': Error
v ' I': Informational
v 'S': Severe
v 'W': Warning
IMPACT
VARCHAR(18)
Qualifies the impact of this message from a user's

perspective. This clarifies the impact of the message on
the business process DB2 is part of. The possible values
are:
v 'CRITICAL'
v 'IMMEDIATE'
v 'NONE'
v 'POTENTIAL'
v 'UNLIKELY'
DBNAME
VARCHAR(128)
The name of the database being accessed while this

message was created.
EDU_ID
BIGINT
edu_ID - Engine dispatchable unit ID monitor element
EDUNAME
VARCHAR(64)
The name of the engine Dispatched Unit that created this

message.
PID
BIGINT
The operating system process identifier that created this

message.
PROCESS_NAME
VARCHAR(255)
The operating system process name that created this

message.
TID
BIGINT
The thread numeric identifier that created this message.
APPLNAME
VARCHAR(255)
The name of the client application that initiated the

connection, if it is available.
APPL_ID
VARCHAR(64)
appl_id - Application ID monitor element
APPLHANDLE
VARCHAR(9)
A system-wide unique identifier for the application that

initiated the connection when available. This is
synonymous to agent ID. The identifier consists of the
coordinating member number and a 16-bit counter
separated by a '-'. The format is as follows: 'nnn-xxxxx'
AUTH_ID
VARCHAR(30)
auth_id - Authorization ID monitor element
PRODUCT
VARCHAR(50)
The name of the product that created the message. For

example 'DB2 Common'.
COMPONENT
VARCHAR(255)
The name of the component that created the message.
FUNCTION
VARCHAR(255)
The name of the function that generated the message.
PROBE
INTEGER
Probe point number used to identify where the message

was generated in the function.
CALLEDPRODUCT
VARCHAR(50)
The name of the product at the source of the error. This

is used when the source of an error is not where the
1067

Column Name
Data Type
Description
CALLEDCOMPONENT
VARCHAR(255)
The name of the component at the source of the error.

This is used when the source of an error is not where the
CALLEDFUNCTION
VARCHAR(255)
The name of the function at the source of the error. This

is used when the source of an error is not where the
OSERR
INTEGER
The operating system error number.
RETCODE
INTEGER
The product specific return code.
MSGNUM
INTEGER
The numeric message number for the associated

message, if it is available. For example, this is the
numeric portion of ADM7513W.
MSGTYPE
CHAR(3)
The type related to the message identifier, if it is

available. For example, ADM is used for administration
notification log messages.
MSG
CLOB(16K)
The short description text for this record. This is the

translated message text corresponding to the MSGNUM,
and MSGTYPE for translated messages. For
non-translated messages, this is the short description. For
example : 'Bringing down all db2fmp processes as part
of db2stop'.
OBJTYPE
VARCHAR(64)
OBJNAME
VARCHAR(255)
The name of the object the event relates to, if it is

available.
OBJNAME_QUALIFIER
VARCHAR(255)
Additional information about the object, if it is available.
1068

Column Name
Data Type
Description
EVENTTYPE
VARCHAR(24)
The event type is the action or verb associated with this

event. The possible values are:
v 'ACCEPT'
v 'ACCESS'
v 'ADD'
v 'ALTER'
v 'ASSOCIATE'
v 'AVAILABLE'
v 'BRINGDOWN'
v 'CHANGE'
v 'CHANGECFG'
v 'CLOSE'
v 'COLLECT'
v 'CONNECT'
v 'CREATE'
v 'DEPENDENCY'
v 'DESTROY'
v 'DISASSOCIATE'
v 'DISCONNECT'
v 'DISPATCH'
v 'DROP'
v 'FINI'
v 'FREE'
v 'GET'
v 'INIT'
v 'INTERRUPT'
v 'OPEN','READ'
v 'RECV'
v 'REPLY'
v 'REPORT'
v 'REQUEST'
v 'RESET'
v 'SEND'
v 'START'
v 'STARTUP'
v 'STOP'
v 'SWITCH'
v 'TERMINATE'
v 'TRANSFER'
v 'WAIT'
v 'WORK'
v 'WRITE'
EVENTDESC
VARCHAR(256)
A short representation of the key fields for this event.
1069

Column Name
Data Type
Description
FIRST_EVENTQUALIFIERTYPE
VARCHAR(64)
The type of the first event qualifier. Event qualifiers are

used to describe what was affected by the event. The
v 'AT'
v 'BY'
v 'CONTEXT'
v 'DUE TO'
v 'FOR'
v 'FROM'
v 'ON'
v 'TO'
If facility is OPTSTATS, the only value is 'AT'.
FIRST_EVENTQUALIFIER
CLOB(16K)
The first qualifier for the event. If facility is OPTSTATS,

this will be a timestamp indicating when the statistics
collection occurred.
SECOND_EVENTQUALIFIERTYPE VARCHAR(64)
The type of the second event qualifier. If facility is

OPTSTATS, the value is 'BY'.
SECOND_EVENTQUALIFIER
The second qualifier for the event. If facility is

OPTSTATS, the possible values are:
CLOB(16K)
v Asynchronous
v FABRICATE
v FABRICATE PARTIAL
v SYNCHRONOUS
v SYNCHRONOUS SAMPLED
v USER
THIRD_EVENTQUALIFIERTYPE
VARCHAR(64)
The type of the third event qualifier. If facility is

OPTSTATS, the value is 'DUE TO'.
THIRD_EVENTQUALIFIER
CLOB(16K)
The third qualifier for the event. If facility is OPTSTATS,

the possible values are:
v Conflict
v Error
v Object unavailable
v RUNSTATS error
v Timeout
EVENTSTATE
1070
VARCHAR(255)
State of the object or action as a result of the event. This

can also contain a percentage indicating the progression
of the event.

Column Name
Data Type
Description
EVENTATTRIBUTE
VARCHAR(255)
The event attributes. This is a list of attributes associated

with the event. when more than one attribute is used,
the list is separated by '+' characters. For example
'CACHED + LOGICAL + AUTO'. The possible values
are:
v 'ASYNC'
v 'AUTO'
v 'CACHED'
v 'DIRECT'
v 'EXTERNAL'
v 'INDIRECT'
v 'INTERNAL'
v 'LOGICAL'
v 'PERMANENT'
v 'PHYSICAL'
v 'SYNC'
v 'TEMPORARY'
EVENTSTACK
CLOB(16K)
The logical event stack at the point the record was

logged when applicable.
CALLSTACK
CLOB(16K)
The operating system stack dump for the thread that

generated this record when applicable.
DUMPFILE
CLOB(5000)
The name of the secondary dump file associated with the

log record when applicable. This is a fully qualified path
to a file or directory where additional information
related to the message can be retrieved.
FULLREC
CLOB(16K)
Formatted text version of the entire record. This section

also contains additional DATA fields.
MEMBER
SMALLINT
HOSTNAME
VARCHAR(255)
PDLOGMSGS_LAST24HOURS administrative view and

PD_GET_LOG_MSGS table function - Retrieve problem
determination messages
The PDLOGMSGS_LAST24HOURS administrative view and the
PD_GET_LOG_MSGS table function return problem determination log messages
that were logged in the DB2 notification log. The information is intended for use
by database and system administrators.
v PDLOGMSGS_LAST24HOURS administrative view
v PD_GET_LOG_MSGS table function on page 1074
PDLOGMSGS_LAST24HOURS administrative view

The PDLOGMSGS_LAST24HOURS administrative view returns problem
determination log messages that were logged in the DB2 notification log in the last
24 hours.
1071

returned.
Authorization
v SELECT privilege on the PDLOGMSGS_LAST24HOURS administrative view
v CONTROL privilege on the PDLOGMSGS_LAST24HOURS administrative view
v DBADM authority
v SQLADM authority

Example
Get all critical log messages logged in the last 24 hours, ordered by most recent.
SELECT * FROM SYSIBMADM.PDLOGMSGS_LAST24HOURS
WHERE MSGSEVERITY = C ORDER BY TIMESTAMP DESC

TIMESTAMP
TIMEZONE
INSTANCENAME
MEMBER ...
-------------------------- ----------- ----------------- ------- ...
2005-11-23-21.56.41.240066
-300 svtdbm4
0 ...
...
...
...
...
...
...
2005-11-23-21.56.39.150597
-300 svtdbm4
0 ...
2005-11-23-21.56.37.363384
-300 svtdbm4
0 ...
...
...
...
2005-11-23-21.56.35.880314
-300 svtdbm4
0 ...
...

...
...
...
...
...
...
...
...
...
...
...
...
1072
DBPARTITIONNUM DBNAME
PID
PROCESSNAME
...
-------------- ------------- ----------- -------------------- ...
0 CAPTAIN
4239374 db2agent (CAPTAIN) 0 ...
...
...
...
...
...
...
0 CAPTAIN
0 CAPTAIN
...
...
...
...
...
...
0 CAPTAIN
...
...
...
...

...TID
...--... 1
...
...
...
...
...
...
... 1
... 1
...
...
...
... 1
...
...
APPL_ID
COMPONENT
...
------------------------------- --------------------- ...
9.26.15.148.36942.051124025612 oper system services ...
...
...
...
...
...
...
9.26.15.148.36942.051124025612 base sys utilities
...
9.26.15.148.36942.051124025612 relation data serv
...
...
...
...
9.26.15.148.36942.051124025612 relation data serv
...
...
...

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
FUNCTION
PROBE MSGNUM
MSGTYPE ...
------------------ ------ ----------- ------- ...
sqloSleepInstance
38
504 ADM
...
...
...
...
...
...
...
sqleMarkDBad
10
7518 ADM
...
sqlrr_dump_ffdc
10
1 ADM
...
...
...
...
sqlrr_dump_ffdc
10
1 ADM
...
...

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
MSGSEVERITY MSG
----------- ------------------------------------C
ADM0504C An unexpected internal
processing error has occurred. ALL
DB2 PROCESSES ASSOCIATED WITH THIS
INSTANCE HAVE BEEN SUSPENDED.
Diagnostic information has been
recorded. Contact IBM Support
for further assistance.
C
ADM7518C "CAPTAIN " marked bad.
C
ADM0001C A severe error has occurred.
Examine the administration notification
log and contact IBM Support if
necessary.
C
ADM0001C A severe error has occurred.
Examine the administration notification
log and contact IBM Support if necessary.
1073
PD_GET_LOG_MSGS table function

The PD_GET_LOG_MSGS table function returns the same information as the
PDLOGMSGS_LAST24HOURS administrative view, but allows you to specify a
specific time period that is not limited to the last 24 hours.
returned.
Syntax
PD_GET_LOG_MSGS (
oldest_timestamp
, member

oldest_timestamp
An input argument of type TIMESTAMP that specifies a valid timestamp.
Entries are returned starting with the most current timestamp and ending with
the log entry with the timestamp specified by this input argument. If a null
value is specified, all log entries are returned.
member
member from which the records should be fetched from. Specify -1 or null for
the current member, or -2 for information from all active database members.
An active database member is where the database is available for connection
and use by applications. If a cluster caching facility (CF) is specified, an active
member will be used to request this data. If the notification log is not
accessible, an error will be returned.
If the parameter is not specified, the default value is all active database
members.
Authorization
v EXECUTE privilege on the PD_GET_LOG_MSGS table function
v DBADM authority
v SQLADM authority

Examples
Example 1: Retrieve all notification messages logged for database SAMPLE on
instance DB2 in the last week for all database partitions. Report messages in
chronological order.
1074
SELECT TIMESTAMP, APPL_ID, DBPARTITIONNUM, MSG

FROM TABLE ( PD_GET_LOG_MSGS( CURRENT_TIMESTAMP - 7 DAYS)) AS T
WHERE INSTANCENAME = DB2 AND DBNAME = SAMPLE
ORDER BY TIMESTAMP ASC

TIMESTAMP
APPL_ID
DBPARTITIONNUM ...
-------------------------- -------------------------- -------------- ...
2005-11-13-12.51.37.772000 *LOCAL.DB2.050324175005
0 ...
...
2005-11-13-12.51.37.772001 *LOCAL.DB2.050324175005
0 ...
...
2005-11-13-12.51.37.781000 *LOCAL.DB2.050324175005
0 ...
...
2005-11-13-12.51.37.781001 *LOCAL.DB2.050324175005
0 ...
...
...
2005-11-17-14.12.39.036001 *LOCAL.DB2.041117191249
0 ...
2005-11-17-14.12.39.056000 *LOCAL.DB2.041117191249
0 ...
2005-11-17-14.13.04.450000 *LOCAL.DB2.041117191307
0 ...
2005-11-17-14.13.04.460000 *LOCAL.DB2.041117191307
0 ...
2005-11-17-14.18.29.042000 *LOCAL.DB2.041117190824
0 ...
...
...
...

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
MSG
----------------------------------------------------------...-ADM5502W The escalation of "143" locks on table
"SYSIBM .SYSINDEXAUTH" to lock intent "X" was successful.
ADM5502W The escalation of "144" locks on table
"SYSIBM .SYSINDEXES" to lock intent "X" was successful.
ADM5502W The escalation of "416" locks on table
"SYSIBM .SYSINDEXCOLUSE" tolock intent "X" was successful.
ADM5500W DB2 is performing lock escalation. The total
number of locks currently held is "1129", and the target
number of locks to hold is "564".
ADM7506W Database quiesce has been requested.
ADM7507W Database quiesce request has completed successfully.
ADM7510W Database unquiesce has been requested.
ADM7509W Database unquiesce request has completed successfully.
ADM4500W A package cache overflow condition has occurred. There
is no error but this indicates that the package cache has
exceeded the configured maximum size. If this condition persists,
you may want to adjust the PCKCACHESZ DB configuration parameter.
Example 2: Retrieve all critical errors logged on instance DB2 for database partition
0 in the last day, sorted by most recent.
SELECT TIMESTAMP, DBNAME, MSG
FROM TABLE (PD_GET_LOG_MSGS(CURRENT_TIMESTAMP - 1 DAYS)) AS T
WHERE MSGSEVERITY = C AND INSTANCENAME = DB2 AND
DBPARTITIONNUM = 0
ORDER BY TIMESTAMP DESC

TIMESTAMP
DBNAME
MSG
-------------------------- ----------- ------------------------2004-11-04-13.49.17.022000 TESTSBCS
ADM0503C An unexpected
internal processing error
has occurred. ALL DB2
PROCESSES ASSOCIATED WITH
THIS INSTANCE HAVE BEEN
SHUTDOWN. Diagnostic
1075
2004-11-04-11.32.26.760000 SAMPLE
information has been

recorded. Contact IBM
Support for further
assistance.
ADM0503C An unexpected
SHUTDOWN. Diagnostic
Support for further
assistance.
Example 3: Retrieve messages written by DB2 processes servicing application with

application ID of *LOCAL.DB2.050927195337, over the last day.
SELECT TIMESTAMP, MSG
FROM TABLE (PD_GET_LOG_MSGS(CURRENT_TIMESTAMP - 1 DAYS)) AS T
WHERE APPL_ID = *LOCAL.DB2.050927195337

TIMESTAMP
MSG
-------------------------- -----------------------------------------2005-06-27-21.17.12.389000 ADM4500W A package cache overflow
condition has occurred. There is no error
but this indicates that the package cache
has exceeded the configured maximum
size. If this condition persists, you
may want to adjust the PCKCACHESZ DB
2005-06-27-18.41.22.248000 ADM4500W A package cache overflow
condition has occurred. There is no error
but this indicates that the package cache
has exceeded the configured maximum
size. If this condition persists, you
may want to adjust the PCKCACHESZ DB
2005-06-27-12.51.37.772001 ADM5502W The escalation of "143" locks
on table "SYSIBM .SYSINDEXAUTH" to
lock intent "X" was successful.
on table "SYSIBM .SYSINDEXES" to lock
intent "X" was successful.
on table "SYSIBM .SYSINDEXCOLUSE" to
lock intent "X" was successful.
...
Example 4: Find all instances of message ADM0504C in the notification log. Note
that the messages considered are not limited by a timestamp. This could be an
expensive operation if the notification logfile is very large.
SELECT TIMESTAMP, DBPARTITIONNUM, DBNAME, MSG
FROM TABLE (PD_GET_LOG_MSGS(CAST(NULL AS TIMESTAMP))) AS T
WHERE MSGNUM = 504 AND MSGTYPE = ADM AND MSGSEVERITY = C
1076
TIMESTAMP
-------------------------2005-11-23-21.56.41.240066
...
...
...
...
...
...
...
...
...
DBPARTITIONNUM DBNAME
...
-------------- -------------...
0 CAPTAIN
...

... APPL_ID
... --------------------------------... 9.26.15.148.36942.051124025612
...
...
...
...
...
...
...
...
...
MSG
------------------------ADM0504C An unexpected
SUSPENDED. Diagnostic
Support for further
assistance.
Example 5: Retrieve all notification messages for a specific member.

SELECT MEMBER,DBPARTITIONNUM, TIMESTAMP, SUBSTR(MSG,1, 50)
FROM TABLE (PD_GET_LOG_MSGS(NULL,-2))

MEMBER DBPARTITIONNUM TIMESTAMP
...
------ -------------- -------------------------- ...
0
0 2011-04-27-09.51.17.725916 ...
...
2
2 2011-04-27-09.51.16.801966 ...
...
1
1 2011-04-27-09.51.16.747745 ...
...
3
3 2011-04-27-09.51.15.655162 ...

...
...
...
...
...
...
...
...
...
4
------------------------------- ------------------ADM7513W Database manager has started.
ADM7513W
Database manager has started.
ADM7513W
ADM7513W
Note: In a multi-member environment, the order in which log messages are
returned cannot be guaranteed. If the order of log records is important, the results
should be sorted by timestamp.
1077
Table 250. Information returned by the PDLOGMSGS_LAST24HOURS administrative view

and the PD_GET_LOG_MSGS table function
1078
Column name
Data type
Description
TIMESTAMP
TIMESTAMP
The time when the entry was

logged.
TIMEZONE
INTEGER
Time difference (in minutes)

from Universal Coordinated
Time (UCT). For example,
-300 is EST.
INSTANCENAME
VARCHAR(128)
Name of the instance that

generated the message.
DBPARTITIONNUM
SMALLINT
element
DBNAME
VARCHAR(128)
The database on which the

error or event occurred.
PID
BIGINT
Process ID of the process that

PROCESSNAME
VARCHAR(255)
Name of process that

TID
BIGINT
ID of the thread within the

process that generated the
message.
APPL_ID
VARCHAR(64)
monitor element
COMPONENT
VARCHAR(255)
The name of the DB2

component that is providing
the message. For messages
written by user applications
using the
db2AdminMsgWrite API,
"User Application" is
returned.
FUNCTION
VARCHAR(255)
The name of the DB2

function that is providing the
message. For messages
written by user applications
using the
db2AdminMsgWrite API,
"User Function" is returned.
PROBE
INTEGER
Unique internal identifier

that allows DB2 Customer
Support and Development to
locate the point in the DB2
source code that generated
the message.
MSGNUM
INTEGER
The numeric message

number for the error or
event.
Table 250. Information returned by the PDLOGMSGS_LAST24HOURS administrative view

and the PD_GET_LOG_MSGS table function (continued)
Column name
Data type
Description
MSGTYPE
CHAR(3)
Indicates the message type:

ADM (for messages written to
the administration
notification log) or NULL if
the message type cannot be
determined.
MSGSEVERITY
CHAR(1)
Message severity: C (critical),

E (error), W (warning), I
(informational) or NULL (if the
message severity could not
be determined).
MSG
CLOB(16K)
Notification log message text.
MEMBER
SMALLINT

monitor element
REORGCHK_IX_STATS procedure - Retrieve index statistics for

reorganization evaluation
The REORGCHK_IX_STATS procedure returns a result set containing index
statistics that indicate whether or not there is a need for reorganization.
Syntax
REORGCHK_IX_STATS (
scope
criteria
scope
An input argument of type CHAR(1) that specifies the scope of the tables that
are to be evaluated, using one of the following values:
'T'
Table
'S'
Schema
criteria
An input argument of type VARCHAR(259). If scope has a value of 'T', specifies
a fully qualified table name, or accepts one of the following values: ALL, USER,
or SYSTEM. If scope has a value of 'S', specifies a schema name.
Authorization
v SELECT privilege on catalog tables.
v EXECUTE privilege on the REORGCHK_IX_STATS procedure.

1079
Example
CALL SYSPROC.REORGCHK_IX_STATS(T,JESCOTT.EMPLOYEE)
Usage note
The procedure uses the SYSTOOLSTMPSPACE table space. If
SYSTOOLSTMPSPACE does not already exist, the procedure will create this table
space.
Table 251. Information returned by the REORGCHK_IX_STATS procedure
1080
Column name
Data type
Description
TABLE_SCHEMA
VARCHAR(128)

monitor element
TABLE_NAME
VARCHAR(128)

element
INDEX_SCHEMA
VARCHAR(128)
index_schema - Index schema

monitor element
INDEX_NAME
VARCHAR(128)
index_name - Index name monitor

element
DATAPARTITIONNAME
VARCHAR(128)
Name of the data partition. NULL

for nonpartitioned tables.
INDCARD
BIGINT
Number of index entries in the

index. This can be different than
table cardinality for some indexes.
For example, the index cardinality
on XML columns might be greater
than the table cardinality.
NLEAF
BIGINT
nleaf - Number of leaf pages

monitor element
NUM_EMPTY_LEAFS
BIGINT
Number of pseudo-empty index

leaf pages.
NLEVELS
INTEGER
nlevels - Number of index levels

monitor element
NUMRIDS_DELETED
BIGINT
Number of pseudo-deleted RIDs.
FULLKEYCARD
BIGINT
Number of unique index entries

that are not marked deleted.
LEAF_RECSIZE
BIGINT
Record size of the index entry on a

leaf page. This is the average size
of the index entry excluding any
overhead and is calculated from
the average column length of all
columns participating in the index.
NONLEAF_RECSIZE
BIGINT
Record size of the index entry on a

non-leaf page. This is the average
size of the index entry excluding
any overhead and is calculated
from the average column length of
all columns participating in the
index except any INCLUDE
columns.
Table 251. Information returned by the REORGCHK_IX_STATS procedure (continued)

Column name
Data type
Description
LEAF_PAGE_OVERHEAD
BIGINT
Reserved space on the index leaf

page for internal use.
NONLEAF_PAGE_OVERHEAD
BIGINT
Reserved space on the index

non-leaf page for internal use
PCT_PAGES_SAVED
SMALLINT
Percent of pages saved using Index

Compression. A non-zero number
indicates the index is compressed.
F4
INTEGER
F4 formula value.
F5
INTEGER
F5 formula value.
F6
INTEGER
F6 formula value.
F7
INTEGER
F7 formula value.
F8
INTEGER
F8 formula value.
REORG
CHAR(5)
A 5-character field, each character

mapping to one of the five
formulas: F4, F5, F6, F7, and F8; a
dash means that the formula value
is in the recommended range; an
asterisk means that the formula
value is out of the recommended
range, indicating a need for
reorganization.
REORGCHK_TB_STATS procedure - Retrieve table statistics for

reorganization evaluation
The REORGCHK_TB_STATS procedure returns a result set containing table
statistics that indicate whether or not there is a need for reorganization.
Syntax
REORGCHK_TB_STATS (
scope
criteria
scope
An input argument of type CHAR(1) that specifies the scope of the tables that
are to be evaluated, using one of the following values:
'T'
Table
'S'
Schema
criteria
An input argument of type VARCHAR(259). If scope has a value of 'T', specifies
a fully qualified table name, or accepts one of the following values: ALL, USER,
or SYSTEM. If scope has a value of 'S', specifies a schema name.
1081
Authorization
v SELECT privilege on catalog tables.
v EXECUTE privilege on the REORGCHK_TB_STATS procedure.

Example
CALL SYSPROC.REORGCHK_TB_STATS(T,JESCOTT.EMPLOYEE)
Usage note
The procedure uses the SYSTOOLSTMPSPACE table space. If
SYSTOOLSTMPSPACE does not already exist, the procedure will create this table
space.
Table 252. Information returned by the REORGCHK_TB_STATS procedure
1082
Column name
Data type
Description
TABLE_SCHEMA
VARCHAR(128)

monitor element
TABLE_NAME
VARCHAR(128)

element
DATAPARTITIONNAME
VARCHAR(128)
Name of the data partition. NULL

for nonpartitioned tables.
CARD
BIGINT
Cardinality (number of rows in the

table).
OVERFLOW
BIGINT
Number of overflow rows.
NPAGES
BIGINT
Total number of pages on which

the rows of the table exist; -1 for a
view or alias, or if statistics are not
collected; -2 for a subtable or
hierarchy table.
FPAGES
BIGINT
Total number of pages; -1 for a

view or alias, or if statistics are not
collected; -2 for a subtable or
hierarchy table.
ACTIVE_BLOCKS
BIGINT
Total number of active blocks for a

multidimensional clustering (MDC)
or insert time clustering (ITC)
table. This field is only applicable
to tables defined using the
ORGANIZE BY clause. It indicates
the number of blocks of the table
that contains data.
TSIZE
BIGINT
Size of the table.
F1
INTEGER
F1 formula value.
F2
INTEGER
F2 formula value.
F3
INTEGER
F3 formula value.
Table 252. Information returned by the REORGCHK_TB_STATS procedure (continued)

Column name
Data type
Description
REORG
CHAR(3)
A 3-character field, each character

mapping to one of the three
formulas: F1, F2, and F3; a dash
means that the formula value is in
the recommended range; an
asterisk means that the formula
value is out of the recommended
range, indicating a need for
reorganization
SET_MAINT_MODE_RECORD_NO_TEMPORALHISTORY
procedure - disable recording of temporal history
The SET_MAINT_MODE_RECORD_NO_TEMPORALHISTORY procedure sets the
internal option to disable recording of temporal history for a system-period
temporal table and allows values to be specified for the special temporal columns.
Authorization
SECADM authority is required to grant EXECUTE privilege on the
SET_MAINT_MODE_RECORD_NO_TEMPORALHISTORY procedure. EXECUTE
privilege WITH GRANT OPTION cannot be granted for this routine (SQLSTATE
42501).

None
Syntax
SET_MAINT_MODE_RECORD_NO_TEMPORALHISTORY (
Usage notes
v Disabling the recording of temporal history for a system-period temporal table
with the SET_MAINT_MODE_RECORD_NO_TEMPORALHISTORY procedure
lasts for the duration of the current session.
Example
Set the internal option to disable recording of temporal history for a system-period
temporal table and allow values to be specified for the special temporal columns.
call SYSPROC.SET_MAINT_MODE_RECORD_NO_TEMPORALHISTORY()
1083
SQLERRM scalar functions - Retrieves error message

information
There are two versions of the SQLERRM scalar function. The first allows for full
flexibility of message retrieval including using message tokens and language
selection. The second takes only an SQLCODE as an input parameter and returns
the short message in English.

This SQLERRM scalar function takes a message identifier, locale and token input
and returns the short or long message in the specified locale. If the input locale is
not supported by the server, the message is returned in English.
Syntax
SQLERRM (
msgid , tokens
, token_delimiter
, locale
, shortmsg
)

Scalar function parameters

msgid
An input argument of type VARCHAR(9) that represents the message number
for which the information should be retrieved. The message number is the
application return code prefixed with 'SQL', 'DBA' or 'CLI'. For example,
'SQL551', 'CLI0001'. The message number can also be an SQLSTATE, for
example, '42829'.
tokens
An input argument of type VARCHAR(70) that represents the error message
token list. Some messages might not have tokens. If this parameter is null, then
no token replacement occurs in the returned message. Token replacement only
occurs when returning the default short messages. If the long message option
is selected, no token replacement occurs.
token_delimiter
An input argument of type VARCHAR(1) that represents the token delimiter.
This delimiter must be unique and not contained in any tokens passed to the
scalar function. If no delimiter is supplied, the default delimiter used is the
semicolon.
locale
An input argument of type VARCHAR(33) that represents the locale to pass to
the server in order to have the error message retrieved in that language. If no
locale is specified, or the server does not support the locale, the message is
returned in English and a warning is returned.
shortmsg
An input argument of type INTEGER that is used to indicate if the long
message should be returned instead of the default short message. To return
long messages, this value must be set to 0 or CAST(NULL as INTEGER).
1084
Authorization
v DBADM authority
v SQLADM authority

Examples
Example 1: Retrieve the English short message for SQL0551N with tokens
"AYYANG", "UPDATE" and "SYSCAT.TABLES".
VALUES (SYSPROC.SQLERRM
(SQL551, AYYANG;UPDATE;SYSCAT.TABLES, ;, en_US, 1))
The following is an example of output returned.

1
--------------------------------------------------------------...-SQL0551N "AYYANG" does not have the privilege to perform operation
"UPDATE" on object "SYSCAT.TABLES"
Example 2: Retrieve the English error message associated with SQLSTATE 42501.
VALUES (SYSPROC.SQLERRM (42501, , , en_US, 1))

1
---------------------------------------------------------------...-SQLSTATE 42501: The authorization ID does not have the privilege to
perform the specified operation on the identified object.
Example 3: Retrieve the English long error message for SQL1001N.

VALUES (SYSPROC.SQLERRM (SQL1001, , , en_US, 0))

1
------------------------------------------------------------...-SQL1001N "<name>" is not a valid database name.
Explanation:
The syntax of the database name specified in the command is not
valid. The database name must contain 1 to 8 characters and all
the characters must be from the database manager base character
set.
The command cannot be processed.
User Response:
1085
Resubmit the command with the correct database name.

sqlcode :
sqlstate :
-1001
2E000

This SQLERRM scalar function takes an SQLCODE as the only input and returns
the short message for the specified SQLCODE in English.
Syntax
SQLERRM (
sqlcode )
Scalar function parameter

sqlcode
An input argument of type INTEGER that represents an SQLCODE.
Authorization
v DBADM authority
v SQLADM authority

Example
Retrieve the short message for SQLCODE SQL0551N.
VALUES (SYSPROC.SQLERRM (551))

1
--------------------------------------------------------------...-SQL0551N "" does not have the privilege to perform operation
"" on object "".
SYSINSTALLOBJECTS
The SYSINSTALLOBJECTS procedure creates or drops the database objects that are
required for a specific tool.
1086
Syntax
SYSINSTALLOBJECTS (
tool-name
, action
, tablespace-name
schema-name )

tool-name
An input argument of type VARCHAR(128) that specifies the name of the tool
that is to be loaded, using one of the following values:
v
v
v
v
v
v
'DB2AC' for autonomous computing (health monitor)

'STMG_DBSIZE_INFO' for storage management
'OPT_PROFILES' for creating the optimization profile table
'POLICY' for policy (tables and triggers)
'EXPLAIN' for creating or migrating explain tables
'INGEST' for creating the restart table used by the ingest utility
action
An input argument of type CHAR(1) that specifies the action that is to be
taken. Valid values are:
C
Create objects.
Drop objects.
Verify objects.
Migrate objects. The M option is only valid when used with the tool
name EXPLAIN. This option migrates explain tables that were created
in Version 7 or later to be compatible with the current version.
tablespace-name
An input argument of type VARCHAR(128) that specifies the name of the table
space in which the objects are to be created. If a value is not specified, or the
value is an empty or blank string, the default user space is used if the tool
name is AM. If the tool name is EXPLAIN and the action is M, the input table
space name is ignored and the table space is used where the explain tables that
are being migrated were created. Otherwise, the SYSTOOLSPACE table space is
used. If SYSTOOLSPACE does not already exist, it will be created.
schema-name
Except for 'EXPLAIN' tool-name option, SYSTOOLS is always used as the
schema regardless of the schema-name passed as the input parameter.
For 'EXPLAIN' tool-name option, an input schema-name can be passed and the
tables are created under the specified schema-name. If no schema-name is
passed as the input parameter, SYSTOOLS schema is used.
Authorization
v DBADM authority
1087
v SQLADM authority

Example
Migrate all explain tables.
CALL SYSPROC.SYSINSTALLOBJECTS(EXPLAIN, M, CAST (NULL AS VARCHAR(128)),
CAST (NULL AS VARCHAR(128)))
Deprecated SQL administrative routines and views

Expanded support is provided for the existing administrative routines and views
by replacing them with new, more comprehensive routines or views.
Starting with Version 10.1, routines with version-suffixed names are deprecated.
The names of the routines do not have a version suffix so that the names remain
consistent across releases. The replacement routines without a version-suffix might
include modifications such as: columns added or removed, new data types for
existing columns, or new values for existing columns. Use good practices when
issuing queries on SQL administrative routines to minimize the impact from
changes to these routines.
The following table provides a list of all the SQL administrative routines or views
that are currently deprecated:
Table 253. Deprecated SQL administrative routines or views and their replacement routines or views for DB2 Version
10.1
Deprecated routine or view
Deprecated
since
APPL_PERFORMANCE administrative view - Version 10.5

Retrieve percentage of rows selected for an
application on page 1135
New routine or view

MON_CONNECTION_SUMMARY - Retrieve
metrics for all connections on page 829
APPLICATIONS administrative view Retrieve connected database application

information on page 1137
Version 10.5
MON_GET_CONNECTION table function Get connection metrics on page 540
BP_HITRATIO administrative view - Retrieve

bufferpool hit ratio information on page 1142
Version 10.5

- Retrieve metrics for bufferpools on page 820
BP_READ_IO administrative view - Retrieve

bufferpool read performance information on
page 1144
Version 10.5

BP_WRITE_IO administrative view - Retrieve

bufferpool write performance information on
page 1146
Version 10.5

CONTAINER_UTILIZATION administrative
view - Retrieve table space container and
utilization information on page 1148
Version 10.5
MON_GET_CONTAINER table function - Get

table space container metrics on page 567
LOG_UTILIZATION administrative view Retrieve log utilization information on page

1212
Version 10.5
administrative view - Retrieve log utilization
LONG_RUNNING_SQL administrative view Version 10.5

on page 1214
MON_CURRENT_SQL - Retrieve key metrics

for all activities on all members on page 834
SNAP_WRITE_FILE procedure on page 1389 Version 10.5
Not available
1088
Replacement
available since
Version 10.5
10.1 (continued)
Deprecated
since
Replacement
available since
New routine or view

MON_GET_CONNECTION table function Get connection metrics on page 540 and
MON_GET_AGENT table function - List
agents running in a service class on page 505

appl logical data group snapshot information
on page 1242
Version 10.5

Version 10.5
Version 10.5
bufferpool logical group snapshot information
on page 1257
MON_GET_BUFFERPOOL table function Get buffer pool metrics on page 522
Version 10.5
snapshot information on page 1263

group snapshot information on page 1270
Version 10.5
MON_GET_CONTAINER table function - Get


group on page 1278
Version 10.5
MON_GET_DATABASE table function - Get

database level information on page 570
Version 10.5

dbm logical grouping snapshot information
on page 1304
Version 10.5
MON_GET_INSTANCE table function - Get

instance level information on page 617
Version 10.5

fcm logical data group snapshot information
on page 1325
Version 10.5
MON_GET_FCM - Get FCM metrics on page

599

detail_log logical data group on page 1315
Version 10.5
MON_GET_TRANSACTION_LOG table
function - Get log information on page 751

snapshot information on page 1328
Version 10.5
MON_GET_FCM - Get FCM metrics on page

599
Version 10.5
MON_CURRENT_SQL - Retrieve key metrics Version 9.7

for all activities on all members on page 834
and MON_GET_CONNECTION table
function - Get connection metrics on page 540

Version 10.5
MON_GET_TABLESPACE table function - Get

table space metrics on page 736

Version 10.5


statement snapshot information on page 1347
Version 10.5
1089
10.1 (continued)
Deprecated
since
New routine or view
Replacement
available since

Version 10.5
MON_GET_UTILITY table function - Get

utilities running on the database on page 783
TBSP_UTILIZATION administrative view Retrieve table space configuration and

utilization information on page 1525
Version 10.5
MON_TBSP_UTILIZATION - Retrieve
monitoring metrics for all table spaces and all
database partitions on page 848
ADMIN_GET_DBP_MEM_USAGE table
function - Get total memory consumption for
instance on page 1094
Version 10.1
ADMIN_GET_MEM_USAGE table function Get total memory consumption for instance

on page 222
Version 10.1
ADMINTABCOMPRESSINFO administrative
view and
function (deprecated) - returns compressed
Version 10.1
on page 226 and
table function - report properties of existing
table dictionaries on page 229
Version 10.1
_V97 on page 1101
Version 10.1
on page 226 and
table function - report properties of existing
table dictionaries on page 229
Version 10.1
ADMIN_GET_TAB_INFO_V95 table function Version 10.1

- Retrieve size and state information for tables
on page 1107
ADMIN_GET_TAB_INFO table function on

page 233
Version 10.1
ADMIN_GET_TAB_INFO_V97 table function Version 10.1

- Retrieve size and state information for tables
on page 1113
ADMIN_GET_TAB_INFO table function on

page 233
Version 10.1
Version 10.1
AM_BASE_RPT_RECOMS Recommendations for activity reports on page
1120
Not available
Version 10.1
AM_BASE_RPTS - Activity event monitor

reports on page 1121
Version 10.1
Not available
Version 10.1
AM_DROP_TASK - Delete a monitoring task Version 10.1

on page 1122
Not available
Version 10.1
AM_GET_LOCK_CHN_TB - Retrieve
application lock chain data in a tabular
format on page 1123
Version 10.1
Not available
Version 10.1
AM_GET_LOCK_CHNS - Retrieve lock chain

information for a specific application on page
1124
Version 10.1
Not available
Version 10.1
AM_GET_LOCK_RPT - Retrieve application

lock details on page 1125
Version 10.1
Not available
Version 10.1
AM_GET_RPT - Retrieve activity monitor

data on page 1133
Version 10.1
Not available
Version 10.1
AM_SAVE_TASK - Create or modify a

monitoring task on page 1134
Version 10.1
Not available
Version 10.1
APPLICATION_ID on page 1141
Version 10.1
MON_GET_APPLICATION_ID - Get
connection application ID on page 517
Version 10.1
REG_VARIABLES administrative view Retrieve DB2 registry settings in use on page

1216
Version 10.1
ENV_GET_REG_VARIABLES table function Retrieve DB2 registry settings in use on page

390
Version 10.1
1090
Version 10.5
10.1 (continued)
Deprecated
since
Replacement
available since
New routine or view

memory pool information on page 625 and
memory set information on page 627
Version 10.1
SNAP_GET_APPL_INFO_V95 table function - Version 10.1

Retrieve appl_info logical data group snapshot
Version 10.1
Version 10.1
Version 10.1
Version 10.1
SNAPAGENT_MEMORY_POOL
administrative view and
SNAP_GET_APPL_V95 table function Retrieve appl logical data group snapshot

Version 10.1
SNAP_GET_BP_V95 table function - Retrieve Version 10.1

bufferpool logical group snapshot information
on page 1267
SNAP_GET_CONTAINER_V91 table function
- Retrieve tablespace_container logical data
Version 10.1
MON_GET_CONTAINER table function - Get Version 10.1

SNAP_GET_DB_V97 table function - Retrieve

group on page 1294
Version 10.1
MON_GET_DATABASE table function - Get

database level information on page 570
Version 10.1
SNAP_GET_DBM_V95 table function Retrieve the dbm logical grouping snapshot

Version 10.1
MON_GET_INSTANCE table function - Get

instance level information on page 617
Version 10.1
SNAP_GET_DETAILLOG_V91 table function

- Retrieve snapshot information from the
detail_log logical data group on page 1319
Version 10.1
MON_GET_TRANSACTION_LOG table
function
Version 10.1
SNAP_GET_DYN_SQL_V95 table function Retrieve dynsql logical group snapshot

Version 10.1
SNAP_GET_DYN_SQL table function on

page 895
Version 10.1

Version 10.1
function - retrieve automatic storage path
Version 10.1
Version 10.1
MON_GET_BUFFERPOOL table function Version 10.1

Get buffer pool metrics on page 522,
MON_GET_TABLE table function - get table
metrics on page 731,
table space metrics on page 736, and
SNAP_GET_TAB_V91 on page 1362
Version 10.1
MON_GET_TABLE table function - get table

metrics on page 731
SNAP_GET_TBSP_PART_V97 table function Retrieve tablespace_nodeinfo logical data

Version 10.1
MON_GET_TABLESPACE table function - Get Version 10.1

SNAP_GET_TBSP_V91 on page 1380
Version 10.1
MON_GET_TABLESPACE table function - Get Version 10.1


hadr logical data group snapshot information
on page 1331
Version 10.1
MON_GET_HADR table function - Returns

high availability disaster recovery (HADR)
monitoring information on page 603
Version 10.1
_V97 - List agents running in a service class
on page 1533
Version 10.1
MON_GET_AGENT table function - List

agents running in a service class on page 505
Version 10.1

logical data group snapshot information on
page 1358
Version 10.1
1091
10.1 (continued)
Deprecated
since
New routine or view
Replacement
available since
_WORKLOAD_OCCURRENCES_V97 - List of
workload occurrences on page 1541
Version 10.1
_WORKLOAD_OCCURRENCES - list
workload occurrences on page 1033
Version 10.1
_STATS_V97 - return statistics of service
subclasses on page 1544
Version 10.1
WLM_GET_SERVICE_SUBCLASS_STATS
table function - Return statistics of service
subclasses on page 1036
Version 10.1
WLM_GET_WORKLOAD
_V97 - Return a list of activities on page 1550
Version 10.1
MON_GET_ACTIVITY table function - Return Version 10.1

a list of activities on page 475
WLM_GET_WORKLOAD_STATS_V97 return workload statistics on page 1554
Version 10.1
WLM_GET_WORKLOAD_STATS table
function - Return workload statistics on page
1038
Version 10.1
DB_PARTITIONS on page 1150
Version 9.8
DB2_MEMBER and DB2_CF administrative

views and DB2_GET_INSTANCE_INFO table
function on page 377
Version 9.8
memory usage information on page 1290
Version 9.7
memory pool information on page 625
Version 9.7 Fix

Pack 5
level memory usage information on page
1309
Version 9.7
memory pool information on page 625
Version 9.7 Fix

Pack 5
LOCKS_HELD administrative view - Retrieve

information about locks held on page 1206
Version 9.7
MON_GET_APPL_LOCKWAIT - Get
information about locks for which an
application is waiting on page 512
Version 9.7 Fix

Pack 1
MON_GET_LOCKS - List all locks in the

currently connected database on page 620
MON_FORMAT_LOCK_NAME - Format the
internal lock name and return details on page
445
MON_LOCKWAITS administrative view Retrieve metrics for applications that are
waiting to obtain locks on page 840
LOCKWAITS administrative view - Retrieve
current lockwaits information on page 1209
Version 9.7
445
1092
Version 9.7 Fix

Pack 1
10.1 (continued)
Deprecated
since

lock logical data group snapshot information
on page 1335
Version 9.7
Replacement
available since
New routine or view

Version 9.7 Fix

Pack 1

445

Version 9.7
Version 9.7 Fix

Pack 1

445
Version 9.7
WLM_GET_ACTIVITY_DETAILS - Return
detailed information about a specific activity
on page 1527
Version 9.5
MON_GET_ACTIVITY_DETAILS table
function - Get complete activity details on
page 490
GET_DB_CONFIG on page 1158
Version 9.1
Version 9.1
DBCFG administrative view and
DB_GET_CFG table function - Retrieve
database configuration parameter information
on page 366
GET_DBM_CONFIG on page 1160
Version 9.1
DBMCFG administrative view - Retrieve

database manager configuration parameter
Version 9.1
SNAP_GET_STO_PATHS on page 1353
Version 9.1
function - retrieve automatic storage path
Version 10.1
SYSINSTALLROUTINES on page 1524
Version 9.1
Not available
The health monitor has been deprecated in DB2 for Linux, UNIX, and Windows
Version 9.7 . The health monitor routines are also deprecated and might be
removed in a future release. A new suite of GUI tools for managing DB2 for Linux,
UNIX, and Windows data and data-centric applications is available and can be
used instead of the discontinued Control Center tools. For more information, see
Database management and application development tools.
The following section is a list of the deprecated health monitor routines:
v
v
v
v
v
v
HEALTH_CONT_HI on page 1161

HEALTH_CONT_HI_HIS on page 1163
HEALTH_CONT_INFO on page 1165
HEALTH_DB_HI on page 1167
HEALTH_DB_HI_HIS on page 1170
HEALTH_DB_HIC on page 1174
1093
v
v
v
v
v
HEALTH_DB_HIC_HIS on page 1176

HEALTH_DB_INFO on page 1179
HEALTH_DBM_HI on page 1181
HEALTH_DBM_HI_HIS on page 1182
HEALTH_DBM_INFO on page 1185
v
v
v
v
v
v
v
HEALTH_GET_ALERT_ACTION_CFG on page 1186

HEALTH_GET_ALERT_CFG on page 1190
HEALTH_GET_IND_DEFINITION on page 1193
HEALTH_HI_REC on page 1195
HEALTH_TBS_HI on page 1197
HEALTH_TBS_HI_HIS on page 1200
HEALTH_TBS_INFO on page 1204
ADMIN_GET_DBP_MEM_USAGE table function - Get total

memory consumption for instance
The ADMIN_GET_DBP_MEM_USAGE table function gets the total memory
consumption for a given instance.
Note: This table function has been deprecated and replaced by the
ADMIN_GET_MEM_USAGE table function - Get total memory consumption for
instance on page 222.
The ADMIN_GET_DBP_MEM_USAGE table function takes an optional input
argument member (INTEGER type), which specifies a valid database member
number, and returns only statistics for that single database member. If the
argument is omitted, statistics are returned for all active database members. When
in a multi-member environment, if you specify -1 or a NULL value for member,
data is returned from the currently connected member.
Syntax
ADMIN_GET_DBP_MEM_USAGE (
member

member
An optional input argument of type integer that specifies the database member
from which the memory usage statistics will be retrieved. If -1 or the NULL
value is specified, data will be returned from the currently connected member.
Authorization
v DBADM authority
v SQLADM authority
1094

Table 254. The result set for ADMIN_GET_DBP_MEM_USAGE
Column Name
Data Type
Description
DBPARTITIONNUM
SMALLINT
MAX_PARTITION_MEM
BIGINT
The maximum amount of instance memory (in bytes) allowed

to be consumed in the database partition if an instance
memory limit is enforced.
CURRENT_PARTITION_MEM
BIGINT
The amount of instance memory (in bytes) currently consumed

in the database partition.
PEAK_PARTITION_MEM
BIGINT
The peak or high watermark consumption of instance memory

(in bytes) in the database partition.
Examples
Example 1: Retrieve memory usage statistics from database partition 3
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_DBP_MEM_USAGE(3)) AS T
DBPARTITIONNUM
-------------3
MAX_PARTITION_MEM
----------------500000000
--------------------381000000
PEAK_PARTITION_MEM
-----------------481000000
Example 2: Retrieve memory usage statistics from the currently connected member
(assuming the user is connected to the database at member 2.)
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_DBP_MEM_USAGE(-1)) AS T
DBPARTITIONNUM
-------------2
MAX_PARTITION_MEM
----------------500000000
--------------------381000000
PEAK_PARTITION_MEM
-----------------481000000
Example 3: Retrieve memory usage statistics from all members

SELECT * FROM TABLE (SYSPROC.ADMIN_GET_DBP_MEM_USAGE()) AS T
DBPARTITIONNUM
-------------0
1
2
3
MAX_PARTITION_MEM
----------------500000000
500000000
500000000
500000000
--------------------381000000
381000000
381000000
381000000
PEAK_PARTITION_MEM
-----------------481000000
481000000
481000000
481000000
Example 4: Retrieve memory usage statistics in megabyte (MB) values

SELECT DBPARTITIONNUM, MAX_PARTITION_MEM/1048576 AS MAX_MEM_MB,
CURRENT_PARTITION_MEM/1048576 AS CURRENT_MEM_MB, PEAK_PARTITION_MEM/1048576
AS PEAK_MEM_MB FROM TABLE (SYSPROC.ADMIN_GET_DBP_MEM_USAGE()) AS T
DBPARTITIONNUM
--------------
MAX_MEM_MB
----------
CURRENT_MEM_MB
--------------
PEAK_MEM_MB
----------Built-in routines and views
1095
0
1
2
4590
4590
4590
1107
1108
1106
1107
1108
1106
ADMINTABCOMPRESSINFO administrative view and

ADMIN_GET_TAB_COMPRESS_INFO table function
(deprecated) - returns compressed information
The ADMINTABCOMPRESSINFO administrative view and the
ADMIN_GET_TAB_COMPRESS_INFO table function return compression
information for tables, materialized query tables (MQT) and hierarchy tables.
Note: This administrative view and the associated table function has been
deprecated and replaced by the following functions:
v ADMIN_GET_TAB_COMPRESS_INFO
table function - estimate compression savings on page 226. Note that this
replacement function has the same name as the deprecated function, but takes
fewer arguments than the deprecated function.
v ADMIN_GET_TAB_DICTIONARY_INFO
table function - report properties of existing table dictionaries on page 229.
This topic consists of the following sections:
v ADMINTABCOMPRESSINFO administrative view
v ADMIN_GET_TAB_COMPRESS_INFO table function on page 1097
ADMINTABCOMPRESSINFO administrative view

The ADMINTABCOMPRESSINFO administrative view returns compression
information for tables, materialized query tables (MQT) and hierarchy tables only.
These table types are reported as T for table, S for materialized query tables and H
for hierarchy tables in the SYSCAT.TABLES catalog view. The information is
returned at both the data partition level and the database partition level for a table.
Refer to the Information returned by ADMINTABCOMPRESSINFO administrative
view and ADMIN_GET_TAB_COMPRESS_INFO table for a complete list of
Authorization
v SELECT privilege on the ADMINTABCOMPRESSINFO administrative view
v CONTROL privilege on the ADMINTABCOMPRESSINFO administrative view
In addition, one of the following privileges or authorities is also required:
v EXECUTE privilege on the ADMIN_GET_TAB_COMPRESS_INFO table function
1096

None
Examples
Example 1: Retrieve all compression information for all tables
SELECT * FROM SYSIBMADM.ADMINTABCOMPRESSINFO

TABSCHEMA
--------SYSIBM
SYSIBM
...
SIMAP2
SIMAP2
...
TABNAME
DBPARTITIONNUM DATA_PARTITION_ID COMPRESS_ATTR
----------- -------------- ----------------- ------------SYSTABLES
0
0 N
SYSCOLUMNS
0
0 N
...
...
...
...
STAFF
PARTTAB
...
...
0
0
0 Y
0 Y
Output from this query (continued):

...
...
...
...
...
...
...
...
DICT_BUILDER
-----------NOT BUILT
NOT BUILT
REORG
REORG
DICT_BUILD_TIMESTAMP
COMPRESS_DICT_SIZE EXPAND_DICT_SIZE ...
-------------------------- -------------------- ---------------- ...
0
0 ...
0
0 ...
...
2006-08-27-19.07.36.000000
13312
5312 ...
2006-08-27-22.07.17.000000
5760
4248 ...

... ROWS_SAMPLED PAGES_SAVED_PERCENT BYTES_SAVED_PERCENT AVG_COMPRESS_REC_LENGTH
... ------------ ------------------- ------------------- ----------------------...
0
0
0
0
...
0
0
0
0
...
...
35
65
84
100
...
45
76
79
98
...
Example 2: Determine the dictionary building action and time of dictionary

creation for all tables.
SELECT TABSCHEMA, TABNAME, DBPARTITIONNUM, DATA_PARTITION_ID, DICT_BUILDER, DICT_BUILD_TIMESTAMP
FROM SYSIBMADM.ADMINTABCOMPRESSINFO

TABSCHEMA
--------SYSIBM
SYSIBM
...
SIMAP2
SIMAP2
SIMAP2
...
TABNAME
DBPARTITIONNUM DATA_PARTITION_ID DICT_BUILDER
---------- -------------- ----------------- -----------SYSTABLES
0
0 NOT BUILT
SYSCOLUMNS
0
0 NOT BUILT
--------------------------
STAFF
SALES
CATALOG
2006-08-27-19.07.36.000000
-
0
0
0
0 REORG
0 NOT BUILT
0 NOT BUILT

The ADMIN_GET_TAB_COMPRESS_INFO table function returns the same
information as the ADMINTABCOMPRESSINFO administrative view, but allows
you to specify a schema, table name and an execution mode.
1097
Refer to the Information returned by ADMINTABCOMPRESSINFO administrative

view and ADMIN_GET_TAB_COMPRESS_INFO table for a complete list of
Syntax
ADMIN_GET_TAB_COMPRESS_INFO (
tabschema
tabname
execmode

tabschema
tabname
execmode
An input argument of type VARCHAR(30) that specifies the execution mode.
The execution mode can be one of the following modes:
v 'REPORT'-- Reports compression information as of last generation. This is the
default value.
v 'ESTIMATE'-- Generates new compression information based on the current
table.
Authorization
EXECUTE privilege on the ADMIN_GET_TAB_COMPRESS_INFO function.

None
Examples
Example 1: Retrieve existing compression information for table SIMAP2.STAFF
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_TAB_COMPRESS_INFO(SIMAP2, STAFF, REPORT))
AS T
The following is an example from output of this query:

TABSCHEMA TABNAME DBPARTITIONNUM DATA_PARTITION_ID COMPRESS_ATTR ...
--------- ------- -------------- ----------------- ------------- ...
SIMAP2
STAFF
0
0 Y
...

... DICT_BUILDER DICT_BUILD_TIMESTAMP
COMPRESS_DICT_SIZE EXPAND_DICT_SIZE ...
... ------------ -------------------------- ------------------ ---------------- ...
... REORG
2006-08-27-19.07.36.000000
13312
5312 ...

... ROWS_SAMPLED PAGES_SAVED_PERCENT BYTES_SAVED_PERCENT AVG_COMPRESS_REC_LENGTH
... ------------ ------------------- ------------------- ----------------------...
35
65
84
100
1098
Example 2: Retrieve estimated compression information for table SIMAP2.STAFF as

of now.
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_TAB_COMPRESS_INFO(SIMAP2, STAFF, ESTIMATE))
AS T

TABSCHEMA TABNAME DBPARTITIONNUM DATA_PARTITION_ID COMPRESS_ATTR DICT_BUILDER ...
--------- ------- -------------- ----------------- ------------- -------------- ...
SIMAP2
STAFF
0
0 Y
TABLE FUNCTION ...

... DICT_BUILD_TIMESTAMP
COMPRESS_DICT_SIZE EXPAND_DICT_SIZE ROWS_SAMPLED ...
... -------------------------- ------------------ ---------------- ------------ ...
... 2006-08-28-19.18.13.000000
13508
6314
68 ...

... PAGES_SAVED_PERCENT BYTES_SAVED_PERCENT AVG_COMPRESS_REC_LENGTH
... ------------------- ------------------- ----------------------...
72
89
98
Example 3: Determine the total dictionary size for all tables in the schema SIMAP2
SELECT TABSCHEMA, TABNAME, DICT_BUILDER,
(COMPRESS_DICT_SIZE+EXPAND_DICT_SIZE) AS TOTAL_DICT_SIZE,
DBPARTITIONNUM, DATA_PARTITION_ID
FROM TABLE (SYSPROC.ADMIN_GET_TAB_COMPRESS_INFO(SIMAP2, , REPORT)) AS T

TABSCHEMA
--------SIMAP2
SIMAP2
...
SIMAP2
SIMAP2
SIMAP2
SIMAP2
SIMAP2
SIMAP2
SIMAP2
...
SIMAP2
SIMAP2
SIMAP2
TABNAME
--------ACT
ADEFUSR
DICT_BUILDER TOTAL_DICT_SIZE DBPARTITIONNUM DATA_PARTITION_ID

------------ --------------- -------------- ----------------NOT BUILT
0
0
0
NOT BUILT
0
0
0
INVENTORY
ORG
PARTTAB
PARTTAB
PARTTAB
PARTTAB
PARTTAB
NOT BUILT
NOT BUILT
REORG
REORG
REORG
REORG
REORG
0
0
10008
5464
8456
6960
7136
0
0
0
0
0
0
0
0
0
0
1
2
3
4
STAFF
REORG
SUPPLIERS NOT BUILT
TESTTABLE NOT BUILT
18624
0
0
0
0
0
0
0
0
Example 4: View a report of the dictionary information of tables in the SIMAP2

schema.
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_TAB_COMPRESS_INFO(SIMAP2, , REPORT))
AS T

TABSCHEMA
--------SIMAP2
SIMAP2
SIMAP2
SIMAP2
TABNAME DBPARTITIONNUM DATA_PARTITION_ID COMPRESS_ATTR

------- -------------- ----------------- ------------T1
0
0 Y
T2
0
0 N
T3
0
0 Y
T4
0
0 N
DICT_BUILDER
REORG
INSPECT
NOT BUILT
...
...
...
...
...
...
1099
...
...
...
...
...
...
-------------------------- ------------------ ---------------- ------------ ...
0
0
0 ...
2007-02-03-17.35.28.000000
1280
2562
- ...
2007-02-03-17.35.44.000000
1340
2232
- ...
0
0
0 ...

... PAGES_SAVED_PERCENT BYTES_SAVED_PERCENT AVG_COMPRESS_REC_LENGTH
... ------------------- ------------------- ----------------------...
0
0
0
...
...
...
0
0
0
Usage notes
all tables.
v When the ADMIN_GET_TAB_COMPRESS_INFO table function is retrieving data
for a given table, it will acquire a shared lock on the corresponding row of
v If the queried table is a non-XML table, there will be a row returned for the
XML storage object (XDA).
Table 255. Information returned by ADMINTABCOMPRESSINFO administrative view and
Column Name
Data Type
Description
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
DBPARTITIONNUM
SMALLINT

element
DATA_PARTITION_ID
INTEGER

element
COMPRESS_ATTR
CHAR(1)
The state of the COMPRESS attribute on the table which

v 'Y' = Row compression is set to yes
v 'N' = Row compression is set to no
1100
Table 255. Information returned by ADMINTABCOMPRESSINFO administrative view and

ADMIN_GET_TAB_COMPRESS_INFO (continued)
Column Name
Data Type
Description
DICT_BUILDER
VARCHAR(30)
Code path taken to build the dictionary which can be one

of the following values:
v 'INSPECT' = INSPECT ROWCOMPESTIMATE
v 'LOAD' = LOAD INSERT/REPLACE
v 'NOT BUILT' = no dictionary available
v
'REORG' = REORG RESETDICTIONARY
v 'TABLE FUNCTION' = built by table function for the

'ESTIMATE' option
TIMESTAMP
Timestamp of when the dictionary was built. Timestamp

granularity is to the second. If no dictionary is available,
then the timestamp is NULL.
COMPRESS_DICT_SIZE
BIGINT
Size of compression dictionary measured in bytes.
EXPAND_DICT_SIZE
BIGINT
Size of the expansion dictionary measured in bytes. If a

historical dictionary exists, this value is the sum of the
current and historical dictionary sizes.
ROWS_SAMPLED
INTEGER
Number of records that contributed to building the

dictionary. Migrated tables with compression dictionaries
will return NULL in this column.
PAGES_SAVED_PERCENT
SMALLINT
Percentage of pages saved from compression. This

information is based on the record data in the sample
buffer only. Migrated tables with compression dictionaries
BYTES_SAVED_PERCENT
SMALLINT
Percentage of bytes saved from compression. This

AVG_COMPRESS_REC_LENGTH
SMALLINT
Average compressed record length of the records

contributing to building the dictionary. Migrated tables
with compression dictionaries will return NULL in this
column.
_V97
The ADMIN_GET_TAB_COMPRESS_INFO_V97 table function returns compression
information for tables, materialized query tables (MQT) and hierarchy tables.
ADMIN_GET_TAB_COMPRESS_INFO table function and the
ADMIN_GET_TAB_DICTIONARY_INFO table function.
Refer to the Table 256 on page 1106 table for a complete list of information that can
be returned.
Syntax
1101

ADMIN_GET_TAB_COMPRESS_INFO_V97 (
tabschema
tabname
execmode

tabschema
tabname
execmode
An input argument of type VARCHAR(30) that specifies the execution mode.
The execution mode can be one of the following modes:
v 'REPORT' -- Reports compression information as of last generation. This is the
default value.
v 'ESTIMATE' -- Generates new compression information based on the current
table.
Authorization
v DBADM authority
v SQLADM authority

None
Examples
Example 1: Retrieve existing compression information for table SIMAP2.STAFF
SELECT *
FROM TABLE (
SYSPROC.ADMIN_GET_TAB_COMPRESS_INFO_V97(SIMAP2, STAFF, REPORT))
AS T

TABSCHEMA
--------SIMAP2
SIMAP2

------- -------------- ----------------- ------------STAFF
0
4 Y
STAFF
0
4 Y
DICT_BUILDER
-----------REORG
NOT BUILT
...
...
...
...

-------------------------- ------------------ ---------------- ------------ ...
2009-03-31-12.19.30.000000
13312
5296
35 ...
0
0
0 ...
1102
PAGES_SAVED_PERCENT BYTES_SAVED_PERCENT AVG_COMPRESS_REC_LENGTH OBJECT_TYPE

------------------- ------------------- ----------------------- ----------38
38
27 DATA
0
0
0 XML
Example 2: Retrieve estimated compression information for table SIMAP2.STAFF as

of now.
SELECT *
FROM TABLE (
SYSPROC.ADMIN_GET_TAB_COMPRESS_INFO_V97(SIMAP2, STAFF, ESTIMATE))
AS T

TABSCHEMA
--------SIMAP2
SIMAP2

------- -------------- ----------------- ------------STAFF
0
4 Y
STAFF
0
4 Y
DICT_BUILDER
-------------TABLE FUNCTION
TABLE FUNCTION
...
...
...
...

-------------------------- ------------------ ---------------- ------------ ...
2009-03-31-12.27.06.000000
13312
5296
35 ...
2009-03-31-12.27.06.000000
13312
9544
8 ...

------------------- ------------------- ----------------------- ----------38
38
27 DATA
75
75
95 XML
Example 3: Determine the total dictionary size for all objects in tables in the schema
SIMAP2
SELECT TABSCHEMA, TABNAME, OBJECT_TYPE, DICT_BUILDER, (
COMPRESS_DICT_SIZE+EXPAND_DICT_SIZE)
AS TOTAL_DICT_SIZE, DBPARTITIONNUM, DATA_PARTITION_ID
FROM TABLE (
SYSPROC.ADMIN_GET_TAB_COMPRESS_INFO_V97(SIMAP2, , REPORT))
AS T

TABSCHEMA
-----------SIMAP2
SIMAP2
SIMAP2
SIMAP2
...
SIMAP2
SIMAP2
SIMAP2
SIMAP2
...
SIMAP2
SIMAP2
SIMAP2
SIMAP2
TABNAME
OBJECT_TYPE DICT_BUILDER
---------- -------------- -----------ACT
DATA
NOT BUILT
ACT
XML
NOT BUILT
ADEFUSR
DATA
INSPECT
ADEFUSR
XML
NOT BUILT
...
...
...
...
...
...
CUSTOMER
CUSTOMER
DEPARTMENT
DEPARTMENT
DATA
XML
DATA
XML
REORG
REORG
NOT BUILT
NOT BUILT
...
...
...
...
STAFF
STAFF
SUPPLIERS
SUPPLIERS
DATA
XML
DATA
XML
REORG
NOT BUILT
TABLE GROWTH
NOT BUILT
...
...
...
...

1103
TOTAL_DICT_SIZE DBPARTITIONNUM DATA_PARTITION_ID

--------------- -------------- ----------------0
0
0
0
0
0
1890
0
0
0
0
0
...
6968
0
1
24256
0
1
0
1
0
0
1
0
...
18608
0
4
0
0
4
6960
0
2
0
0
2
Example 4: View a report of the dictionary information of tables in the SIMAP2

schema.
SELECT * FROM TABLE (
SYSPROC.ADMIN_GET_TAB_COMPRESS_INFO_V97(SIMAP2, , REPORT))
AS T

TABSCHEMA
--------SIMAP2
SIMAP2
SIMAP2
SIMAP2
...
SIMAP2
SIMAP2
...
SIMAP2
SIMAP2
SIMAP2
SIMAP2
TABNAME
DBPARTITIONNUM DATA_PARTITION_ID COMPRESS_ATTR
--------- -------------- ----------------- ------------ACT
0
0 N
ACT
0
0 N
ADEFUSR
0
0 N
ADEFUSR
0
0 N
DICT_BUILDER
NOT BUILT
INSPECT
NOT BUILT
...
...
...
...
...
...
CUSTOMER
CUSTOMER
0
0
1 Y
1 Y
REORG
REORG
...
...
STAFF
STAFF
SUPPLIERS
SUPPLIERS
0
0
0
0
4
4
2
2
REORG
NOT BUILT
NOT BUILT
NOT BUILT
...
...
...
...
Y
Y
N
N

-------------------------- ------------------ ---------------- ------------ ...
0
0
0 ...
0
0
0 ...
2009-03-31-12.11.02.000000
290
1890
22 ...
0
0
0 ...
...
2009-03-31-11.08.18.000000
3968
3000
6 ...
2009-03-31-11.08.18.000000
13312
10944
6 ...
...
2009-03-31-12.19.30.000000
13312
5296
35 ...
0
0
0 ...
0
0
0 ...
0
0
0 ...

------------------- ------------------- ----------------------- ----------0
0
0 DATA
0
0
0 XML
20
25
21 DATA
0
0
0 XML
1104
...
70
66
70
66
38
0
0
0
38
0
0
0
31 DATA
235 XML
...
27
0
0
0
DATA
XML
DATA
XML
Example 5: View a report of the dictionary information of DATA objects of tables in

the SIMAP2 schema.
SYSPROC.ADMIN_GET_TAB_COMPRESS_INFO_V97(SIMAP2,,REPORT))
WHERE OBJECT_TYPE=DATA

TABSCHEMA
--------SIMAP2
SIMAP2
...
SIMAP2
SIMAP2
...
SIMAP2
SIMAP2

--------- -------------- ----------------- ------------ACT
0
0 N
ADEFUSR
0
0 N
DICT_BUILDER
INSPECT
...
...
...
...
CUSTOMER
DEPARTMENT
0
1
1 Y
0 N
REORG
NOT BUILT
...
...
STAFF
SUPPLIERS
0
0
4 Y
2 N
REORG
NOT BUILT
...
...

COMPRESS_DICT_SIZE EXPAND_DICT_SIZE ROWS_SAMPLED...
-------------------------- ------------------ ---------------- ------------ ...
0
0
0 ...
2009-03-31-12.11.02.000000
290
1890
22 ...
...
2009-03-31-11.08.18.000000
3968
3000
6 ...
0
0
0 ...
...
2009-03-31-12.19.30.000000
13312
5296
35 ...
0
0
0 ...

------------------- ------------------- ----------------------- ----------0
0
0 DATA
20
25
21 DATA
70
0
70
0
31 DATA
0 DATA
38
0
38
0
27 DATA
0 DATA
Example 6: View a report of the dictionary information of XML objects of the

CUSTOMER table in the SIMAP2 schema.
SYSPROC.ADMIN_GET_TAB_COMPRESS_INFO_V97(SIMAP2, CUSTOMER,
WHERE OBJECT_TYPE=XML
REPORT))
1105
TABSCHEMA TABNAME
DBPARTITIONNUM DATA_PARTITION_ID COMPRESS_ATTR DICT_BUILDER ...
--------- --------- -------------- ----------------- ------------- ------------ ...
SIMAP2
CUSTOMER
0
1 Y
REORG
...

-------------------------- ------------------ ---------------- ------------ ...
2009-03-31-11.08.18.000000
13312
10944
6 ...

------------------- ------------------- ----------------------- ----------66
66
235 XML
Usage notes
all tables.
v When the ADMIN_GET_TAB_COMPRESS_INFO_V97 table function is retrieving
data for a given table, it will acquire a shared lock on the corresponding row of
v If the queried table is a non-XML table, there will be a row returned for the
XML storage object (XDA).
Table 256. Information returned by ADMIN_GET_TAB_COMPRESS_INFO_V97
Column Name
Data Type
Description
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
DBPARTITIONNUM
SMALLINT

element
DATA_PARTITION_ID
INTEGER

element
COMPRESS_ATTR
CHAR(1)
The state of the COMPRESS attribute on the table which

v 'Y' = Row compression is set to yes
v 'N' = Row compression is set to no
1106
Table 256. Information returned by ADMIN_GET_TAB_COMPRESS_INFO_V97 (continued)

Column Name
Data Type
Description
DICT_BUILDER
VARCHAR(30)
Code path taken to build the dictionary which can be one

of the following values:
v 'INSPECT' = INSPECT ROWCOMPESTIMATE
v 'LOAD' = LOAD INSERT/REPLACE
v 'NOT BUILT' = no dictionary available
v
'REORG' = REORG RESETDICTIONARY
v 'TABLE FUNCTION' = built by table function for the

'ESTIMATE' option
TIMESTAMP
Timestamp of when the dictionary was built. Timestamp

granularity is to the second. If no dictionary is available,
then the timestamp is NULL.
COMPRESS_DICT_SIZE
BIGINT
Size of compression dictionary measured in bytes.
EXPAND_DICT_SIZE
BIGINT
Size of the expansion dictionary measured in bytes. If a

historical dictionary exists, this value is the sum of the
current and historical dictionary sizes.
ROWS_SAMPLED
INTEGER
Number of records that contributed to building the

dictionary. Migrated tables with compression dictionaries
PAGES_SAVED_PERCENT
SMALLINT
Percentage of pages saved from compression. This

BYTES_SAVED_PERCENT
SMALLINT
Percentage of bytes saved from compression. This

AVG_COMPRESS_REC_LENGTH
SMALLINT
Average compressed record length of the records

contributing to building the dictionary. Migrated tables
with compression dictionaries will return NULL in this
column.
OBJECT_TYPE
VARCHAR(4)
ADMIN_GET_TAB_INFO_V95 table function - Retrieve size and

state information for tables
The ADMIN_GET_TAB_INFO_V95 table function provides methods to retrieve
table size and state information that is not currently available in the catalog views.
ADMINTABINFO administrative view and ADMIN_GET_TAB_INFO table
function - retrieve table size and state information on page 232.
be returned.
1107
Syntax
ADMIN_GET_TAB_INFO_V95 (
tabschema
, tabname

tabschema
tabname
Authorization
v DBADM authority
v SQLADM authority

Examples
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_TAB_INFO_V95(DBUSER1, EMPLOYEE))
AS T

lob_object_p_size + xml_object_p_size) as total_p_size
FROM TABLE( SYSPROC.ADMIN_GET_TAB_INFO_V95( DBUSER1, EMPLOYEE )) AS T
lob_object_l_size + xml_object_l_size) as total_l_size
db2 => select substr(tabschema, 1, 10) as tbschema, substr(tabname, 1, 10)
as tbname, statstype from SYSIBMADM.ADMINTABINFO where tabname = T1;
TBSCHEMA
1108
TBNAME
STATSTYPE
---------- ---------- --------DB2USER1

T1
U
Usage notes
all tables.
v When the ADMIN_GET_TAB_INFO_V95 table function is retrieving data for a
given table, it will acquire a shared lock on the corresponding row of
ensure that the table is not dropped while information is being retrieved for it).
The lock will only be held for as long as it takes to retrieve the size and state
information for the table, not for the duration of the table function call.
REDISTRIBUTING_PENDING
1. no redistribute has been run for the given table N
2. redistribute started to run on the database partition group but not on the table
N
3. redistribute failed in the phase before moving data N
4. redistribute failed in the phase of moving data Y
5. redistribute completely successfully and committed for the table. N
Table 257. Information returned by the ADMIN_GET_TAB_INFO_V95 table function
Column name
Data type
Description
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
TABTYPE
CHAR(1)
Table type:
v 'T' = table
DBPARTITIONNUM
SMALLINT

element
1109
Table 257. Information returned by the ADMIN_GET_TAB_INFO_V95 table function (continued)

Column name
Data type
Description
DATA_PARTITION_ID
INTEGER

element
AVAILABLE
CHAR(1)
State of the table:

will be NULL.
DATA_OBJECT_L_SIZE
BIGINT

table truncation). For multi-dimensional clustering (MDC)
tables, this size includes the logical size of the block map
that are logically allocated for the table and, for objects
created in DMS table spaces, an estimate of the Extent
Map Page (EMP) extents. This size represents the logical
size of the base table only. Space consumed by LOB data,
Long Data, Indexes and XML objects are reported by other
columns.
DATA_OBJECT_P_SIZE
BIGINT
Data object physical size. Amount of disk space physically

allocated for the table, reported in kilobytes. For MDC
tables, this size includes the size of the block map object.
for the table and includes the EMP extents for objects
created in DMS table spaces. This size represents the
physical size of the base table only. Space consumed by
LOB data, Long Data, Indexes and XML objects are
reported by other columns.
INDEX_OBJECT_L_SIZE
BIGINT

in DMS table spaces, an estimate of the EMP extents. This
value is only reported for non-partitioned tables. For
partitioned tables, this value will be 0.
INDEX_OBJECT_P_SIZE
BIGINT

full extents allocated for the indexes and includes the EMP
extents for indexes created in DMS table spaces. This value
is only reported for non-partitioned tables. For partitioned
tables this value will be 0.
1110

Column name
Data type
Description
LONG_OBJECT_L_SIZE
BIGINT

table (for example, in the case of a logical table truncation).
The size returned takes into account full extents that are
logically allocated for long field data and, for long field
extents.
LONG_OBJECT_P_SIZE
BIGINT
Long object physical size. Amount of disk space physically

kilobytes. The size returned takes into account full extents
allocated for long field data and includes the EMP extents
for long field data created in DMS table spaces.
LOB_OBJECT_L_SIZE
BIGINT

that are logically allocated for LOB data and, for LOB data
created in DMS table spaces, an estimate of the EMP
extents.
LOB_OBJECT_P_SIZE
BIGINT

XML_OBJECT_L_SIZE
BIGINT

XML_OBJECT_P_SIZE
BIGINT

INDEX_TYPE
SMALLINT

Returns:
v 1 if type-1 indexes are being used.
REORG_PENDING
CHAR(1)

has been applied to the table and a classic (offline) reorg is
required. Otherwise 'N' is returned.
1111

Column name
Data type
Description
VARCHAR(10)

STOP is required)
v EXECUTING
table)
v PAUSED
LOAD_STATUS
VARCHAR(12)

v IN_PROGRESS
v PENDING
READ_ACCESS_ONLY
CHAR(1)

pending, a value of 'Y' means the table data is available for
read access, and a value of 'N' means the table is
NO_LOAD_RESTART
CHAR(1)

returned otherwise.
SMALLINT

required) that have been performed against this table since
the last reorganization.
CHAR(1)
'Y' if any of the indexes defined on the table require a

LARGE_RIDS
CHAR(1)

indexes).
LARGE_SLOTS
CHAR(1)

maximum of 255 rows per page.
DICTIONARY_SIZE
BIGINT
Size of the dictionary, in bytes, used for row compression

if a row compression dictionary exists for the table.
1112

Column name
Data type
Description
BIGINT

STATSTYPE
CHAR(1)

catalogs.
v


catalogs.
ADMIN_GET_TAB_INFO_V97 table function - Retrieve size and

state information for tables
The ADMIN_GET_TAB_INFO_V97 table function provides methods to retrieve
table size and state information that is not currently available in the catalog views.
ADMINTABINFO administrative view and ADMIN_GET_TAB_INFO table
function - retrieve table size and state information on page 232.
be returned.
Syntax
ADMIN_GET_TAB_INFO_V97 (
tabschema
tabname

tabschema
tabname
1113
Authorization
v DBADM authority
v SQLADM authority

Examples
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_TAB_INFO_V97(DBUSER1, EMPLOYEE))
AS T

lob_object_p_size + xml_object_p_size) as total_p_size
lob_object_l_size + xml_object_l_size) as total_l_size
DBUSER1.EMPLOYEE.
FROM TABLE(SYSPROC.ADMIN_GET_TAB_INFO_V97(DBUSER1,EMPLOYEE))

FROM TABLE(SYSPROC.ADMIN_GET_TAB_INFO_V97(SAMPLE,STAFF))
Usage notes
1114

v When the ADMIN_GET_TAB_INFO_V97 table function is retrieving data for a
given table, it will acquire a shared lock on the corresponding row of
ensure that the table is not dropped while information is being retrieved for it).
The lock will only be held for as long as it takes to retrieve the size and state
information for the table, not for the duration of the table function call.
REDISTRIBUTING_PENDING
1. no redistribute has been run for the given table N
2. redistribute started to run on the database partition group but not on the table
N
3. redistribute failed in the phase before moving data N
4. redistribute failed in the phase of moving data Y
5. redistribute completely successfully and committed for the table N
Table 258. Information returned by ADMINTABINFO administrative view and the ADMIN_GET_TAB_INFO_V97
Column name
Data type
Description
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
TABTYPE
CHAR(1)
Table type:
v 'T' = table
DBPARTITIONNUM
SMALLINT

element
DATA_PARTITION_ID
INTEGER

element
AVAILABLE
CHAR(1)
State of the table:

will be NULL.
1115
Table 258. Information returned by ADMINTABINFO administrative view and the

ADMIN_GET_TAB_INFO_V97 (continued)
Column name
Data type
Description
DATA_OBJECT_L_SIZE
BIGINT

table truncation). For multi-dimensional clustering (MDC)
tables, this size includes the logical size of the block map
that are logically allocated for the table and, for objects
created in DMS table spaces, an estimate of the Extent
Map Page (EMP) extents. This size represents the logical
size of the base table only. Space consumed by LOB data,
Long Data, Indexes and XML objects are reported by
other columns.
DATA_OBJECT_P_SIZE
BIGINT
Data object physical size. Amount of disk space physically

allocated for the table, reported in kilobytes. For MDC
tables, this size includes the size of the block map object.
for the table and includes the EMP extents for objects
created in DMS table spaces. This size represents the
physical size of the base table only. Space consumed by
LOB data, Long Data, Indexes and XML objects are
reported by other columns.
INDEX_OBJECT_L_SIZE
BIGINT

indexes on partitioned tables. For information about both
partitioned and nonpartitioned indexes, you can use the
ADMIN_GET_INDEX_INFO function.
INDEX_OBJECT_P_SIZE
BIGINT

function.
1116

Column name
Data type
Description
LONG_OBJECT_L_SIZE
BIGINT

LONG_OBJECT_P_SIZE
BIGINT

LOB_OBJECT_L_SIZE
BIGINT

extents.
LOB_OBJECT_P_SIZE
BIGINT

XML_OBJECT_L_SIZE
BIGINT

XML_OBJECT_P_SIZE
BIGINT

INDEX_TYPE
SMALLINT

Returns:
REORG_PENDING
CHAR(1)

1117

Column name
Data type
Description
VARCHAR(10)

STOP is required)
v EXECUTING
table)
v PAUSED
LOAD_STATUS
VARCHAR(12)

v IN_PROGRESS
v PENDING
READ_ACCESS_ONLY
CHAR(1)

NO_LOAD_RESTART
CHAR(1)

returned otherwise.
SMALLINT

CHAR(1)

LARGE_RIDS
CHAR(1)

indexes).
1118

Column name
Data type
Description
LARGE_SLOTS
CHAR(1)

maximum of 255 rows per page.
DICTIONARY_SIZE
BIGINT

BIGINT

STATSTYPE
CHAR(1)

catalogs.
v


catalogs.
XML_RECORD_TYPE
SMALLINT

table.
used.
used.
RECLAIMABLE_SPACE
BIGINT
For an MDC table in a DMS table space, this value

by running the REORG command with the RECLAIM
option. Disk space is reported in kilobytes. For any other
table, the value is zero.
1119

Column name
Data type
Description
XML_DICTIONARY_SIZE
BIGINT

AM_BASE_RPT_RECOMS - Recommendations for activity

reports
The AM_BASE_RPT_RECOMS table function returns recommendations for activity
reports used by the activity event monitor.
Syntax
Important: The related activity monitor routines have been deprecated in Version
10.1 and might be removed in a future release. For more information, see Activity
monitor routines have been deprecated at http://pic.dhe.ibm.com/infocenter/
AM_BASE_RPT_RECOMS (
report_id
client_locale

report_id
An input argument of type INTEGER that specifies a report ID. If the
argument is null, recommendations for all available reports are returned.
client_locale
An input argument of type VARCHAR(33) that specifies a client language
identifier. If the argument is null or an empty string, the default value is
'En_US' (English). If the message files for the specified locale are not available
on the server, 'En_US' is used.
Authorization
v DBADM authority
v SQLADM authority

1120
Examples
Example 1: Request recommendations (in English) for the activity event monitor
report with an ID of 1. Assume the default client language identifier 'En_US'.
SELECT *
FROM TABLE(SYSPROC.AM_BASE_RPT_RECOMS(1, CAST(NULL AS VARCHAR(33))))
AS RECOMS
Example 2: Request recommendations (in French) for the activity event monitor
report with an ID of 12.
SELECT *
FROM TABLE(SYSPROC.AM_BASE_RPT_RECOMS(12, CAST(Fr_FR AS VARCHAR(33))))
AS RECOMS
Table 259. Information returned by the AM_BASE_RPT_RECOMS table function
Column name
Data type
Description
REPORT_ID
INTEGER
The report ID.
RECOM_NAME
VARCHAR(256)
The name or short

description of the
recommendation.
RECOM_DESCRIPTION
CLOB(32K)
The detailed description of

the recommendation.
AM_BASE_RPTS - Activity event monitor reports

The AM_BASE_RPTS table function returns activity reports used by the activity
event monitor.
Syntax
AM_BASE_RPTS (
report_id
type
client_locale

report_id
An input argument of type INTEGER that specifies a unique report ID. If the
argument is null, reports with any report ID are returned.
type
An input argument of type CHAR(4) that specifies the report type. Valid
values are:
APPL
Application
STMT SQL statement

TRAN Transaction
1121
CACH Dynamic SQL statement cache

Values can be specified in uppercase or lowercase characters. If the argument is
null or an empty string, reports of any type are returned.
client_locale
identifier. If the argument is null or an empty string, or the message files for
the specified locale are not available on the server, 'En_US' is used.
Authorization
v DBADM authority
v SQLADM authority

Examples
Example 1:
SELECT * FROM TABLE(SYSPROC.AM_BASE_RPTS(CAST(NULL AS INTEGER),
CAST(NULL AS CHAR(4)), CAST(NULL AS VARCHAR(33)))) AS REPORTS
Example 2:
SELECT ID, NAME FROM TABLE(SYSPROC.AM_BASE_RPTS(
CAST(NULL AS INTEGER), CAST(STMT AS CHAR(4)), En_US))
AS REPORTS WHERE TYPE = STMT
Table 260. Information returned by the AM_BASE_RPTS table function
Column name
Data type
Description
ID
INTEGER
id - cluster caching facility

element
TYPE
CHAR(4)
The report type. Valid values

are: APPL, STMT, TRAN, CACH.
NAME
VARCHAR(256)
The name or short

description of the report.
DESCRIPTION
VARCHAR(16384)
The detailed description of

the report.
SWITCHES
VARCHAR(100)
The monitor switches

required for this report.
AM_DROP_TASK - Delete a monitoring task

The AM_DROP_TASK procedure deletes a monitoring task. It does not return any
data.
1122
Syntax
AM_DROP_TASK ( task_id
Procedure parameter
task_id
An input argument of type INTEGER that specifies a unique monitoring task
ID.
Authorization
v DBADM authority
v SQLADM authority

Example
Drop the monitoring task with ID 5.
CALL SYSPROC.AM_DROP_TASK(5)
AM_GET_LOCK_CHN_TB - Retrieve application lock chain

data in a tabular format
The AM_GET_LOCK_CHN_TB procedure returns application lock chain data in
tabular format. A lock chain consists of all the applications that the current
application is holding up or waiting for, either directly or indirectly.
Syntax
AM_GET_LOCK_CHN_TB (
agent_id
1123
agent_id
An input argument of type BIGINT that specifies the agent ID of the
application for which lock chain data is to be retrieved.
Authorization
v SYSMON authority
v EXECUTE privilege on the AM_GET_LOCK_CHN_TB procedure.

Example
Retrieve lock chain information for agent ID 68.
CALL SYSPROC.AM_GET_LOCK_CHN_TB(68)
The procedure returns the following table. Each row of this table represents a
lock-wait relationship. The result set also contains a row for each holding-only
application; in this case, the HOLDING_AGENT_ID column is null, and the other
four columns are for the holding-only application.
Table 261. Information returned by the AM_GET_LOCK_CHN_TB procedure
Column name
Data Type
Description
HOLDING_AGENT_ID
BIGINT
The agent ID of the application

holding the lock.
AGENT_ID
BIGINT
agent_id - Application handle

(agent ID) monitor element
APPL_NAME
VARCHAR(255)

monitor element
AUTH_ID
VARCHAR(128)
auth_id - Authorization ID monitor

element
APPL_ID
VARCHAR(64)
appl_id - Application ID monitor

element
AM_GET_LOCK_CHNS - Retrieve lock chain information for a

specific application
The AM_GET_LOCK_CHNS procedure returns lock chains for the specified
application as a formatted string. A lock chain consists of all the applications that
the current application is holding up or waiting for, either directly or indirectly.
Syntax
1124
AM_GET_LOCK_CHNS (
agent_id
lock_chains
agent_id
application whose lock chains are to be displayed.
lock_chains
An output argument of type CLOB(2M) that shows all the lock chains for the
specified application.
Authorization
v SYSMON authority
v EXECUTE privilege on the AM_GET_LOCK_CHNS procedure.

Example
CALL SYSPROC.AM_GET_LOCK_CHNS(17,?)
-------------------------Parameter Name : LOCK_CHAINS
Parameter Value : >db2bp.exe (Agent ID: 17) (Auth ID: AMUSERC )
<db2bp.exe (Agent ID: 17) (Auth ID: AMUSERC )
<db2bp.exe (Agent ID: 18) (Auth ID: AMUSERB )
<db2bp.exe (Agent ID: 16) (Auth ID: AMUSERA )
Return Status = 0
AM_GET_LOCK_RPT - Retrieve application lock details

The AM_GET_LOCK_RPT procedure returns lock details for an application in three
output result sets.
Syntax
AM_GET_LOCK_RPT (
agent_id
Procedure parameter
agent_id
application whose lock details are to be returned.
1125
Authorization
v SYSMON authority
v EXECUTE privilege on the AM_GET_LOCK_RPT procedure.

Example
CALL SYSPROC.AM_GET_LOCK_RPT(68)
Usage note
The DFT_MON_LOCK monitor switch must be turned on for this procedure to
return any information.
The procedure returns three result sets: one for application general information;
one for locks that the application holds; and one for locks that the application is
waiting for.
Table 262. General application information returned by the AM_GET_LOCK_RPT procedure
1126
Column name
Data Type
Description
AGENT_ID
BIGINT

(agent ID)
APPL_NAME
VARCHAR(256)
PRIMARY_AUTH_ID
VARCHAR(128)
auth_id - Authorization ID
APPL_ID
VARCHAR(128)
Table 262. General application information returned by the AM_GET_LOCK_RPT

procedure (continued)
Column name
Data Type
Description
APPL_STATUS
VARCHAR(22)
appl_status - Application status.

v BACKUP
v COMMIT_ACT
v COMP
v CONNECTED
v CONNECTPEND
v CREATE_DB
v DECOUPLED
v DISCONNECTPEND
v INTR
v IOERROR_WAIT
v LOAD
v LOCKWAIT
v QUIESCE_TABLESPACE
v RECOMP
v REMOTE_RQST
v RESTART
v RESTORE
v ROLLBACK_ACT
v ROLLBACK_TO_SAVEPOINT
v TEND
v THABRT
v THCOMT
v TPREP
v UNLOAD
v UOWEXEC
v UOWWAIT
v WAITFOR_REMOTE
COORD_NODE_NUM
SMALLINT
coord_node - Coordinating node
SEQUENCE_NO
VARCHAR(4)
sequence_no - Sequence number
CLIENT_PRDID
VARCHAR(128)
client_prdid - Client
product/version ID
CLIENT_PID
BIGINT
1127

Column name
Data Type
Description
CLIENT_PLATFORM
VARCHAR(12)
client_platform - Client operating

platform. This interface returns a
text identifier based on the defines
in sqlmon.h,
v AIX
v AIX64
v AS400_DRDA
v DOS
v DYNIX
v HP
v HP64
v HPIA
v HPIA64
v LINUX
v LINUX390
v LINUXIA64
v LINUXPPC
v LINUXPPC64
v LINUXX8664
v LINUXZ64
v MAC
v MVS_DRDA
v NT
v NT64
v OS2
v OS390
v SCO
v SGI
v SNI
v SUN
v SUN64
v UNKNOWN
v UNKNOWN_DRDA
v VM_DRDA
v VSE_DRDA
v WINDOWS
v WINDOWS95
1128

Column name
Data Type
Description
CLIENT_PROTOCOL
VARCHAR(10)
client_protocol - Client
communication protocol. This
based on the defines in sqlmon.h,
v CPIC
v LOCAL
v NPIPE
v TCPIP (for DB2 Universal
Database, or DB2 UDB)
v TCPIP4
v TCPIP6
CLIENT_NNAME
VARCHAR(128)
client_nname - Client name

monitor element
LOCKS_HELD
BIGINT
TIMESTAMP
lock_wait_start_time - Lock wait

start timestamp
LOCK_WAIT_TIME
BIGINT
lock_wait_time - Time waited on

locks
LOCK_WAITS
BIGINT
LOCK_TIMEOUTS
BIGINT
lock_timeouts - Number of lock

timeouts
LOCK_ESCALS
BIGINT
lock_escals - Number of lock

escalations
X_LOCK_ESCALS
BIGINT
x_lock_escals - Exclusive lock

escalations
DEADLOCKS
BIGINT
Table 263. Locks held information returned by the AM_GET_LOCK_RPT procedure

Column name
Data Type
Description
TBSP_NAME
VARCHAR(128)

name
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
1129
Table 263. Locks held information returned by the AM_GET_LOCK_RPT

Column name
Data Type
Description
LOCK_OBJECT_TYPE
VARCHAR(18)

waited on. This interface returns a
in sqlmon.h and is one of:
v AUTORESIZE_LOCK
v AUTOSTORAGE_LOCK
v BLOCK_LOCK
v EOT_LOCK
v INPLACE_REORG_LOCK
v INTERNAL_LOCK
v INTERNALB_LOCK
v INTERNALC_LOCK
v INTERNALJ_LOCK
v INTERNALL_LOCK
v INTERNALO_LOCK
v INTERNALQ_LOCK
v INTERNALP_LOCK
v INTERNALS_LOCK
v INTERNALT_LOCK
v INTERNALV_LOCK
v KEYVALUE_LOCK
v ROW_LOCK
v SYSBOOT_LOCK
v TABLE_LOCK
v TABLE_PART_LOCK
v TABLESPACE_LOCK
v XML_PATH_LOCK
LOCK_MODE
VARCHAR(10)
lock_mode - Lock mode. This

and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
1130
Table 263. Locks held information returned by the AM_GET_LOCK_RPT

Column name
Data Type
Description
LOCK_STATUS
VARCHAR(10)
lock_status - Lock status. This

and is one of:
v CONV
v GRNT
LOCK_ESCALATION
SMALLINT
LOCK_NAME
VARCHAR(32)
DBPARTITIONNUM
SMALLINT
Table 264. Locks wait information returned by the AM_GET_LOCK_RPT procedure

Column name
Data Type
Description
AGENT_ID_HOLDING_LK
BIGINT
agent_id_holding_lock - Agent ID
holding lock
APPL_ID_HOLDING_LK
VARCHAR(128)
appl_id_holding_lk - Application
ID holding lock
TIMESTAMP

start timestamp
DBPARTITIONNUM
SMALLINT
TBSP_NAME
VARCHAR(128)

name
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
1131
Table 264. Locks wait information returned by the AM_GET_LOCK_RPT

Column name
Data Type
Description
LOCK_OBJECT_TYPE
VARCHAR(18)

v AUTORESIZE_LOCK
v AUTOSTORAGE_LOCK
v BLOCK_LOCK
v EOT_LOCK
v INTERNAL_LOCK
v INTERNALB_LOCK
v INTERNALC_LOCK
v INTERNALJ_LOCK
v INTERNALL_LOCK
v INTERNALO_LOCK
v INTERNALQ_LOCK
v INTERNALP_LOCK
v INTERNALS_LOCK
v INTERNALT_LOCK
v INTERNALV_LOCK
v KEYVALUE_LOCK
v ROW_LOCK
v SYSBOOT_LOCK
v TABLE_LOCK
v TABLE_PART_LOCK
v TABLESPACE_LOCK
v XML_PATH_LOCK
LOCK_MODE
VARCHAR(10)

and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
1132
Table 264. Locks wait information returned by the AM_GET_LOCK_RPT

Column name
Data Type
Description
LOCK_MODE_REQUESTED
VARCHAR(10)

requested. This interface returns a
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
LOCK_ESCALATION
SMALLINT
AM_GET_RPT - Retrieve activity monitor data

The AM_GET_RPT procedure returns activity monitor data for a report.
Syntax
AM_GET_RPT ( partition
, report_id
, appl_filter
, max_number )
partition
An input argument of type INTEGER that specifies a database partition
number. Valid values are -2 (denoting all database partitions) and the database
partition number of any existing database partition.
report_id
An input argument of type INTEGER that specifies a unique report ID.
appl_filter
An input argument of type CLOB(32K) that specifies an application filter. An
application filter is a search condition involving any or all of the three columns
AGENT_ID, APPL_NAME, and PRIMARY_AUTH_ID, where AGENT_ID and
PRIMARY_AUTH_ID are integers, and APPL_NAME is a character string. If
the argument is null or an empty string, no filtering is performed.
max_number
1133
applications, statements, or transactions that are to be displayed. If the

argument is null, all applications, statements, and transactions will be
displayed.
Authorization
v SYSMON authority
v EXECUTE privilege on the AM_GET_RPT procedure.

Example
CALL SYSPROC.AM_GET_RPT(-2, 18,
CAST(AGENT_ID=29 AND PRIMARY_AUTH_ID <> dbuser AND APPL_NAME LIKE db2%
AS CLOB(32K)), 100)
Usage note
The result set returned is different for each report id. This procedure is intended to
support the discontinued Activity Monitor graphical tool. To build reports that can
be parsed, snapshot administrative SQL routines and views should be used
instead. To use this procedure, the DFT_MON_LOCK monitor switch must be
turned on.
AM_SAVE_TASK - Create or modify a monitoring task

The AM_SAVE_TASK procedure creates or modifies a monitoring task.
Syntax
AM_SAVE_TASK ( mode
, task_id
, task_name
, appl_filter
show_lock_chains , report_ids )
mode
An input argument of type CHAR(1) that specifies whether to create a new
monitoring task ('C') or to modify an existing monitoring task ('M').
task_id
An input argument of type INTEGER that specifies a unique monitoring task
ID. When mode is 'C', any specified input for task_id is ignored. An ID for the
new monitoring task will be generated by the procedure and returned in the
output. When mode is 'M', specifies the ID of the monitoring task that is being
modified.
1134

task_name
An input argument of type VARCHAR(128) that specifies a name or short
description for a monitoring task.
appl_filter
An input argument of type CLOB(32K) that specifies an application filter. An
application filter is a search condition involving any or all of the three columns
AGENT_ID, APPL_NAME, and AUTH_ID, where AGENT_ID and AUTH_ID
are integers, and APPL_NAME is a character string. If the argument is null or
an empty string, no filtering is performed.
show_lock_chains
An input argument of type CHAR(1) that specifies whether lock chains are to
be shown. Valid values are 'Y' and 'N'. If the argument is null, lock chains are
not to be shown.
report_ids
An input argument of type VARCHAR(3893) that specifies one or more report
IDs separated by commas.
Authorization
v DBADM authority
v SQLADM authority

Example
Example:
CALL SYSPROC.AM_SAVE_TASK(M,11,Task ABC,CAST (NULL AS CLOB(32K)),
N,1,2,4,8,9,12)
APPL_PERFORMANCE administrative view - Retrieve

percentage of rows selected for an application
The APPL_PERFORMANCE administrative view displays information about the
percentage of rows selected by an application.
The information returned is for all database partitions for the currently connected
database. This view can be used to look for applications that might be performing
large table scans or to look for potentially troublesome queries.
Important: The APPL_PERFORMANCE administrative view is deprecated and has
been replaced by the MON_CONNECTION_SUMMARY - Retrieve metrics for all
connections on page 829.
1135
Authorization
v SELECT privilege on the APPL_PERFORMANCE administrative view
v CONTROL privilege on the APPL_PERFORMANCE administrative view
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve the report on application performance.
SELECT SNAPSHOT_TIMESTAMP, SUBSTR(AUTHID,1,10) AS AUTHID,
SUBSTR(APPL_NAME,1,10) AS APPL_NAME,AGENT_ID,
PERCENT_ROWS_SELECTED, DBPARTITIONNUM
FROM SYSIBMADM.APPL_PERFORMANCE

SNAPSHOT_TIMESTAMP
-------------------------2006-01-07-17.01.15.966668
2006-01-07-17.01.15.980278
2006-01-07-17.01.15.980278
AUTHID
---------JESSICAE
JESSICAE
JESSICAE
APPL_NAME
---------db2bp.exe
db2taskd
db2bp.exe
...
...
...
...
...
...
...

... AGENT_ID
PERCENT_ROWS_SELECTED DBPARTITIONNUM
... --------...-- --------------------- -------------...
67
1
...
68
0
...
67
57.14
0
...
Table 265. Information returned by the APPL_PERFORMANCE administrative view
1136
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
AUTHID
VARCHAR(128)
Table 265. Information returned by the APPL_PERFORMANCE administrative

view (continued)
Column name
Data type
monitor element
APPL_NAME
VARCHAR(256)
AGENT_ID
BIGINT

(agent ID)
PERCENT_ROWS_SELECTED
DECIMAL(5,2)
The percent of rows read from disk

that were actually returned to the
application.
Note: The percentage shown will
not be greater than 100.00 percent.
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
APPLICATIONS administrative view - Retrieve connected

database application information
The APPLICATIONS administrative view returns information about the connected
database applications.
The view is an SQL interface for the LIST APPLICATIONS SHOW DETAIL CLP
command, but only for the currently connected database. Its information is based
on the SNAPAPPL_INFO administrative view.
Important: The SNAPAPPL administrative view and the SNAP_GET_APPL table
function are deprecated and have been replaced by the
MON_GET_CONNECTION table function - Get connection metrics on page 540.
Authorization
v SELECT privilege on the APPLICATIONS administrative view
v
v
v
v
CONTROL privilege on the APPLICATIONS administrative view

DBADM authority
SQLADM authority

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM
1137

Example
Example 1: List information for all the active applications in the single-partitioned
database SAMPLE.
SELECT AGENT_ID, SUBSTR(APPL_NAME,1,10) AS APPL_NAME, AUTHID,
APPL_STATUS FROM SYSIBMADM.APPLICATIONS WHERE DB_NAME = SAMPLE

AGENT_ID
APPL_NAME AUTHID
APPL_STATUS
-------------------- ---------- ---------- --------------------23 db2bp.exe JESSICAE
UOWEXEC
Example 2: List the number of agents per application on database partition 0 for the
multi-partition database SAMPLE.
SELECT SUBSTR(APPL_NAME, 1, 10) AS APPL_NAME, COUNT(*) AS NUM
FROM SYSIBMADM.APPLICATIONS WHERE DBPARTITIONNUM = 0
AND DB_NAME = SAMPLE GROUP BY APPL_NAME

APPL_NAME NUM
---------- ----------db2bp.exe
3
javaw.exe
1
Usage notes
The view does not support the GLOBAL syntax available from the CLP. However,
aggregation can be done using SQL aggregation functions as data from all database
partitions is returned from the view.
Table 266. Information returned by the APPLICATIONS administrative view
1138
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
CLIENT_DB_ALIAS
VARCHAR(128)
client_db_alias - Database alias

used by application
DB_NAME
VARCHAR(128)
AGENT_ID
BIGINT

(agent ID)
APPL_NAME
VARCHAR(256)
AUTHID
VARCHAR(128)
APPL_ID
VARCHAR(128)
Table 266. Information returned by the APPLICATIONS administrative view (continued)

Column name
Data type
APPL_STATUS
VARCHAR(22)
monitor element
v BACKUP
v COMMIT_ACT
v COMP
v CONNECTED
v CONNECTPEND
v CREATE_DB
v DECOUPLED
v DISCONNECTPEND
v INTR
v IOERROR_WAIT
v LOAD
v LOCKWAIT
v RECOMP
v REMOTE_RQST
v RESTART
v RESTORE
v ROLLBACK_ACT
v TEND
v THABRT
v THCOMT
v TPREP
v UNLOAD
v UOWEXEC
v UOWWAIT
v WAITFOR_REMOTE
STATUS_CHANGE_TIME
TIMESTAMP
status_change_time - Application
status change time
SEQUENCE_NO
VARCHAR(4)
CLIENT_PRDID
VARCHAR(128)
product/version ID
CLIENT_PID
BIGINT
1139

Column name
Data type
CLIENT_PLATFORM
VARCHAR(12)
monitor element
text identifier based on defines in
v AIX
v AIX64
v AS400_DRDA
v DOS
v DYNIX
v HP
v HP64
v HPIA
v HPIA64
v LINUX
v LINUX390
v LINUXIA64
v LINUXPPC
v LINUXPPC64
v LINUXX8664
v LINUXZ64
v MAC
v MVS_DRDA
v NT
v NT64
v OS2
v OS390
v SCO
v SGI
v SNI
v SUN
v SUN64
v UNKNOWN
v UNKNOWN_DRDA
v VM_DRDA
v VSE_DRDA
v WINDOWS
v WINDOWS95
1140

Column name
Data type
CLIENT_PROTOCOL
VARCHAR(10)
monitor element
v CPIC
v LOCAL
v NPIPE
v TCPIP
v TCPIP4
v TCPIP6
CLIENT_NNAME
VARCHAR(128)

monitor element
COORD_NODE_NUM
SMALLINT
COORD_AGENT_PID
BIGINT
coord_agent_pid - Coordinator
agent
NUM_ASSOC_AGENTS
BIGINT
num_assoc_agents - Number of
associated agents
TPMON_CLIENT_USERID
VARCHAR(256)
tpmon_client_userid - TP monitor
client user ID
TPMON_CLIENT_WKSTN
VARCHAR(256)
tpmon_client_wkstn - TP monitor
client workstation name
TPMON_CLIENT_APP
VARCHAR(256)
tpmon_client_app - TP monitor
client application name
TPMON_ACC_STR
VARCHAR(200)
tpmon_acc_str - TP monitor client

accounting string
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
COORD_MEMBER
SMALLINT
COORD_DBPARTITIONNUM
SMALLINT
The coordinating database

partition number.
APPLICATION_ID
The APPLICATION_ID function returns the application ID of the current
connection.
The value returned by the function is unique within a 100-year interval and valid
only for the duration of the connection established before calling the function.
Note: This scalar function has been deprecated and replaced by the
MON_GET_APPLICATION_ID scalar function.
1141
Syntax
APPLICATION_ID (
Authorization
v DBADM authority
v SQLADM authority

Example
SELECT APPLICATION_ID() AS APPL_ID FROM SYSIBM.SYSDUMMY1
BP_HITRATIO administrative view - Retrieve bufferpool hit

ratio information
The BP_HITRATIO administrative view returns bufferpool hit ratios, including
total hit ratio, data hit ratio, XDA hit ratio and index hit ratio, for all bufferpools
and all database partitions in the currently connected database.
Important: The BP_HITRATIO administrative view is deprecated and has been
replaced by the MON_BP_UTILIZATION administrative view - Retrieve metrics
for bufferpools on page 820.
Note: This administrative view works only in DB2 environments without the IBM
DB2 pureScale Feature. For information about calculating hit ratios in a DB2
pureScale environment, see Calculating buffer pool hit ratios in a DB2 pureScale
environment, in the Database Monitoring Guide and Reference.
Authorization
v SELECT privilege on the BP_HITRATIO administrative view
v CONTROL privilege on the BP_HITRATIO administrative view
v DBADM authority
v SQLADM authority
also required:
v SYSMON
1142
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a report for all bufferpools in the connected database.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, SUBSTR(BP_NAME,1,14) AS BP_NAME,
TOTAL_HIT_RATIO_PERCENT, DATA_HIT_RATIO_PERCENT,
INDEX_HIT_RATIO_PERCENT, XDA_HIT_RATIO_PERCENT, DBPARTITIONNUM
FROM SYSIBMADM.BP_HITRATIO ORDER BY DBPARTITIONNUM

DB_NAME
-------TEST
TEST
TEST
TEST
TEST
BP_NAME
TOTAL_HIT_RATIO_PERCENT DATA_HIT_RATIO_PERCENT ...
-------------- ----------------------- ---------------------- ...
IBMDEFAULTBP
63.09
68.94 ...
IBMSYSTEMBP4K
- ...
IBMSYSTEMBP8K
- ...
IBMSYSTEMBP16K
- ...
IBMSYSTEMBP32K
- ...

... INDEX_HIT_RATIO_PERCENT XDA_HIT_RATIO_PERCENT DBPARTITIONNUM
... ----------------------- --------------------- -------------...
43.20
0
...
0
...
0
...
0
...
0
Usage notes
The ratio of physical reads to total reads gives the hit ratio for the bufferpool. The
lower the hit ratio, the more the data is being read from disk rather than the
cached buffer pool which can be a more costly operation.
Table 267. Information returned by the BP_HITRATIO administrative view
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
Timestamp when the report was

requested.
DB_NAME
VARCHAR(128)
BP_NAME
VARCHAR(128)
TOTAL_LOGICAL_READS
BIGINT
Total logical reads (index, XDA

and data) in the bufferpool.
BIGINT
Total physical reads (index, XDA

and data) in the bufferpool.
TOTAL_HIT_RATIO_PERCENT
DECIMAL(5,2)
Total hit ratio (index, XDA and

data reads).
1143
Table 267. Information returned by the BP_HITRATIO administrative view (continued)

monitor element
Column name
Data type
DATA_LOGICAL_READS
BIGINT
pool_data_l_reads - Buffer pool

data logical reads
DATA_PHYSICAL_READS
BIGINT

data physical reads
DATA_HIT_RATIO_PERCENT
DECIMAL(5,2)
Data hit ratio.
INDEX_LOGICAL_READS
BIGINT
pool_index_l_reads - Buffer pool

index logical reads
BIGINT

INDEX_HIT_RATIO_PERCENT
DECIMAL(5,2)
Index hit ratio.
XDA_LOGICAL_READS
BIGINT
pool_xda_l_reads - Buffer Pool

XDA Data Logical Reads
XDA_PHYSICAL_READS
BIGINT
pool_xda_p_reads - Buffer Pool

XDA Data Physical Reads
DECIMAL(5,2)
Auxiliary storage objects hit ratio.
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
BP_READ_IO administrative view - Retrieve bufferpool read

performance information
The BP_READ_IO administrative view returns bufferpool read performance
information. This view can be used to look at each bufferpool to see how effective
the prefetchers are.
Important: The BP_READ_IO administrative view is deprecated and has been
Authorization
v SELECT privilege on the BP_READ_IO administrative view
v CONTROL privilege on the BP_READ_IO administrative view
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
1144
v SYSADM

Example
Retrieve total physical reads and average read time for all bufferpools on all
partitions of the currently connected database.
SELECT SUBSTR(BP_NAME, 1, 15) AS BP_NAME, TOTAL_PHYSICAL_READS,
AVERAGE_READ_TIME_MS, DBPARTITIONNUM
FROM SYSIBMADM.BP_READ_IO ORDER BY DBPARTITIONNUM

BP_NAME
TOTAL_PHYSICAL_READS AVERAGE_READ_TIME_MS DBPARTITIONNUM
--------------- -------------------- -------------------- -------------IBMDEFAULTBP
811
4
0
IBMSYSTEMBP4K
0
0
IBMSYSTEMBP8K
0
0
IBMSYSTEMBP16K
0
0
IBMDEFAULTBP
34
0
1
IBMSYSTEMBP4K
0
1
IBMSYSTEMBP8K
0
1
IBMDEFAULTBP
34
0
2
IBMSYSTEMBP4K
0
2
IBMSYSTEMBP8K
0
2
Table 268. Information returned by the BP_READ_IO administrative view
Description or
corresponding
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
Date and time the

report was generated.
BP_NAME
VARCHAR(128)
bp_name - Buffer
pool name
BIGINT
Total physical reads.
AVERAGE_READ_TIME_MS
BIGINT
Average read time in

milliseconds.
TOTAL_ASYNC_READS
BIGINT
Total asynchronous
reads.
AVERAGE_ASYNC_READ_TIME_MS
BIGINT
Average
asynchronous read
time in milliseconds.
TOTAL_SYNC_READS
BIGINT
Total synchronous
reads.
AVERAGE_SYNC_READ_TIME_MS
BIGINT
Average synchronous
read time in
milliseconds.
1145
Table 268. Information returned by the BP_READ_IO administrative view (continued)

Description or
corresponding
monitor element
Column name
Data type
PERCENT_SYNC_READS
DECIMAL(5,2)
Percentage of pages
read synchronously
without prefetching.
If many of the
applications are
reading data
synchronously
without prefetching
then the system
might not be tuned
optimally.
ASYNC_NOT_READ_PERCENT
DECIMAL(5,2)
Percentage of pages
read asynchronously
from disk, but never
accessed by a query.
If too many pages are
read asynchronously
from disk into the
bufferpool, but no
query ever accesses
those pages, then the
prefetching might
degrade performance.
DBPARTITIONNUM
SMALLINT
dbpartitionnum Database partition

number monitor
element
MEMBER
SMALLINT
member - Database
member monitor
element
BP_WRITE_IO administrative view - Retrieve bufferpool write

performance information
The BP_WRITE_IO administrative view returns bufferpool write performance
information per bufferpool.
Important: The BP_WRITE_IO administrative view is deprecated and has been
Authorization
v
v
v
v
v
1146
SELECT privilege on the BP_WRITE_IO administrative view

CONTROL privilege on the BP_WRITE_IO administrative view
DBADM authority
SQLADM authority

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve total writes and average write time for all bufferpools on all database
partitions of the currently connected database.
SELECT SUBSTR(BP_NAME, 1, 15) AS BP_NAME, TOTAL_WRITES,
AVERAGE_WRITE_TIME_MS, DBPARTITIONNUM
FROM SYSIBMADM.BP_WRITE_IO ORDER BY DBPARTITIONNUM

BP_NAME
TOTAL_WRITES
AVERAGE_WRITE_TIME_MS DBPARTITIONNUM
--------------- ------------...- --------------------- -------------IBMDEFAULTBP
11
5
0
IBMSYSTEMBP4K
0
0
IBMSYSTEMBP8K
0
0
IBMSYSTEMBP16K
0
0
IBMSYSTEMBP32K
0
0
IBMDEFAULTBP
0
1
IBMSYSTEMBP4K
0
1
IBMSYSTEMBP8K
0
1
IBMDEFAULTBP
0
2
IBMSYSTEMBP4K
0
2
IBMSYSTEMBP8K
0
2
Table 269. Information returned by the BP_WRITE_IO administrative view
Description or
corresponding
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
The date and time the

report was generated.
BP_NAME
VARCHAR(128)
bp_name - Buffer
pool name
TOTAL_WRITES
BIGINT
Total writes.
AVERAGE_WRITE_TIME_MS
BIGINT
Average write time in

milliseconds.
TOTAL_ASYNC_WRITES
BIGINT
Total asynchronous
writes.
PERCENT_WRITES_ASYNC
BIGINT
Percent of writes that

are asynchronous.
1147
Table 269. Information returned by the BP_WRITE_IO administrative view (continued)

Description or
corresponding
monitor element
Column name
Data type
AVERAGE_ASYNC_WRITE_TIME_MS
BIGINT
Average
asynchronous write
time in milliseconds.
TOTAL_SYNC_WRITES
BIGINT
Total synchronous
writes.
AVERAGE_SYNC_WRITE_TIME_MS
BIGINT
Average synchronous
write time in
milliseconds.
DBPARTITIONNUM
SMALLINT
dbpartitionnum Database partition

number monitor
element
MEMBER
SMALLINT
member - Database
member monitor
element
CONTAINER_UTILIZATION administrative view - Retrieve table

space container and utilization information
The CONTAINER_UTILIZATION administrative view returns information about
table space containers and utilization rates.
It retrieve a similar report to the LIST TABLESPACES command on a single
partitioned database. Its information is based on the SNAPCONTAINER
administrative view.
Important: The CONTAINER_UTILIZATION administrative view is deprecated
and has been replaced by the MON_GET_CONTAINER table function - Get table
space container metrics on page 567.
Authorization
v SELECT privilege on the CONTAINER_UTILIZATION administrative view
v CONTROL privilege on the CONTAINER_UTILIZATION administrative view
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM
1148

Example
Retrieve a list of all table spaces containers in the connected single partition
database, including information about the total and usable pages as well as their
accessibility status.
SELECT SUBSTR(TBSP_NAME,1,20) AS TBSP_NAME, INT(TBSP_ID) AS TBSP_ID,
SUBSTR(CONTAINER_NAME,1,45) AS CONTAINER_NAME, INT(CONTAINER_ID)
AS CONTAINER_ID, CONTAINER_TYPE, INT(TOTAL_PAGES) AS TOTAL_PAGES,
INT(USABLE_PAGES) AS USABLE_PAGES, ACCESSIBLE
FROM SYSIBMADM.CONTAINER_UTILIZATION

TBSP_NAME
TBSP_ID
----------------...- ----------SYSCATSPACE
0
TEMPSPACE1
1
USERSPACE1
2
SYSTOOLSPACE
3
SYSTOOLSTMPSPACE
4
CONTAINER_NAME
-------------------------------------...-D:\DB2\NODE0000\SQL00001\SQLT0000.0
D:\DB2\NODE0000\SQL00001\SQLT0001.0
D:\DB2\NODE0000\SQL00001\SYSTOOLSPACE
D:\DB2\NODE0000\SQL00001\SYSTOOLSTMPSPACE
...
...
...
...
...
...
...

... CONTAINER_ID CONTAINER_TYPE TOTAL_PAGES USABLE_PAGES ACCESSIBLE
... ------------ -------------- ----------- ------------ ---------...
0 PATH
0
0
1
...
0 PATH
0
0
1
...
0 PATH
0
0
1
...
0 PATH
0
0
1
...
0 PATH
0
0
1
The BUFFERPOOL snapshot monitor switch must be enabled at the database
manager configuration for the file system information to be returned.
Table 270. Information returned by the CONTAINER_UTILIZATION administrative view
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TBSP_NAME
VARCHAR(128)

name
TBSP_ID
BIGINT

identification
CONTAINER_NAME
VARCHAR(256)
CONTAINER_ID
BIGINT
identification
1149
Table 270. Information returned by the CONTAINER_UTILIZATION administrative

view (continued)
Column name
Data type
monitor element
CONTAINER_TYPE
VARCHAR(16)
container_type - Container type

This is a text identifier based on
the defines in sqlutil.h and is one
of:
v DISK_EXTENT_TAG
v DISK_PAGE_TAG
v FILE_EXTENT_TAG
v FILE_PAGE_TAG
v PATH
TOTAL_PAGES
BIGINT
container_total_pages - Total pages

in container
USABLE_PAGES
BIGINT
container_usable_pages - Usable
pages in container
ACCESSIBLE
SMALLINT
container_accessible - Accessibility
of container
STRIPE_SET
BIGINT
FS_ID
VARCHAR(22)

FS_TOTAL_SIZE_KB
BIGINT

system. This interface returns the
value in KB.
FS_USED_SIZE_KB
BIGINT

used on a file system. This
interface returns the value in KB.
DBPARTITIONNUM
SMALLINT
DB_PARTITIONS
The DB_PARTITIONS table function returns the contents of the db2nodes.cfg file
in table format.
Note: This table function has been deprecated and replaced by the DB2_MEMBER
and DB2_CF administrative views and DB2_GET_INSTANCE_INFO table function.
Syntax
DB_PARTITIONS (
Authorization
1150
v DBADM authority
v SQLADM authority


The function has no input parameters.
Examples
Retrieve information from a 4 member partitioned database instance.
SELECT * FROM TABLE(DB_PARTITIONS()) as T

PARTITION_NUMBER
---------------0
1
2
3
HOST_NAME PORT_NUMBER SWITCHNAME

--------- ----------- ------so1
0 so1-ib0
so2
0 so2-ib0
so3
0 so3-ib0
so4
0 so4-ib0
In a DB2 pureScale environment, retrieve information from a 3 member and 1

cluster caching facility DB2 pureScale instance.
SELECT * FROM TABLE(DB_PARTITIONS()) as T

PARTITION_NUMBER
---------------0
0
0
HOST_NAME PORT_NUMBER SWITCHNAME

---------- ----------- ---------so1
0 so1-ib0
so2
0 so2-ib0
so3
0 so3-ib0
Usage notes
For DB2 Enterprise Server Edition and in a partitioned database environment, the
DB_PARTITIONS table function returns one row for each entry in the db2nodes.cfg
file.
In a DB2 pureScale environment, the DB_PARTITIONS table function returns
multiple rows, with the following information in the columns:
v The PARTITION_NUMBER column always contains 0.
v The remaining columns show information for the entry in the db2nodes.cfg file
for the current member.
1151
Table 271. Information returned by the DB_PARTITIONS table function
Column name
Data type
Description
PARTITION_NUMBER
SMALLINT
partition_number - Partition
Number monitor element
HOST_NAME
VARCHAR(256)

monitor element
PORT_NUMBER
SMALLINT
The port number for the

database partition server.
SWITCH_NAME
VARCHAR(128)
The name of a high speed

interconnect, or switch, for
database partition
communications.
ENV_SYS_RESOURCES administrative view - Return system

information
The ENV_SYS_RESOURCES administrative view returns operating system, CPU,
memory and other information related to the system.
Note: As of DB2 Version 9.8 Fix Pack 4, the ENV_SYS_RESOURCES administrative
view and the associated ENV_GET_SYS_RESOURCES table function have been
deprecated and replaced by the ENV_GET_SYSTEM_RESOURCES table function.
The ENV_SYS_RESOURCES administrative view returns operating system, CPU,
memory, and other information related to the system.
Authorization
v SELECT privilege on the ENV_SYS_RESOURCES administrative view
v CONTROL privilege on the ENV_SYS_RESOURCES administrative view

Example
SELECT SUBSTR(NAME,1,20) AS NAME, SUBSTR(VALUE,1,10) AS VALUE,
SUBSTR(DATATYPE,1,10) AS DATATYPE, DBPARTITIONNUM
FROM SYSIBMADM.ENV_SYS_RESOURCES
WHERE SUBSTR(NAME,1,8)=CPU_LOAD OR NAME=CPU_USAGE_TOTAL

NAME
----------------------CPU_LOAD_SHORT
CPU_LOAD_MEDIUM
1152
VALUE
---------0.044052
0.087250
DATATYPE
DBPARTITIONNUM
---------- -------------DECIMAL
0
DECIMAL
0
CPU_LOAD_LONG
CPU_USAGE_TOTAL
0.142059
7
DECIMAL
SMALLINT
0
0
ENV_SYS_RESOURCES administrative view metadata

Table 272. ENV_SYS_RESOURCES administrative view metadata
Column name
Data type
Description
NAME
VARCHAR(128)
Name of the attribute. See Table 273 for possible values.

Note: Some attributes might not be available depending
on the operating system and hardware configuration at
the server.
VALUE
VARCHAR(1024)
The value of the attribute.
DATATYPE
VARCHAR(128)
Attribute data type.
UNIT
VARCHAR(128)
Unit used for the VALUE column if applicable. NULL is

returned if not applicable.
DBPARTITIONNUM
SMALLINT

element
Table 273. Possible values for the NAME column
Information
type
Operating
system
Platforms
that return
this
information
UNIT
Name
Data types
Description
OS_NAME
VARCHAR(256)
Name of the
operating system
software.
All
NULL
HOST_NAME
VARCHAR(256)
Host name of the

system.
All
NULL
OS_VERSION
VARCHAR(256)
Version of the
operating system.
For example, AIX:
4.3 version = 4.
All
NULL
OS_RELEASE
VARCHAR(256)
Release of the
operating system.
For example, AIX:
4.3 release = 3.
All
NULL
VARCHAR(256)
Machine hardware
identification.
All
NULL
OS_LEVEL
VARCHAR(256)
Maintenance level of Linux

the current version
and release. For
example, LINUX:
2.4.9, level = 9.
NULL
1153
Table 273. Possible values for the NAME column (continued)

Platforms
that return
this
information
UNIT
Information
type
Name
Data types
Description
CPU
CPU_TOTAL
BIGINT
Total number of
CPUs.
All
NULL
CPU_ONLINE
BIGINT
Number of CPUs
online.
All
NULL
CPU_CONFIGURED
BIGINT
Number of CPUs
configured.
All
NULL
CPU_SPEED
BIGINT
Speed of CPUs.
All
MHz
CPU_TIMEBASE
BIGINT
Frequency of
timebase register
increment.
Linux
PowerPC
Hz
CPU_HMT_DEGREE
BIGINT
All
On systems that
support hardware
multithreading
(HMT), this is the
number of
processors that a
physical processor
will appear to the
operating system as.
On non-HMT
systems, this value
is 1. On HMT
systems, "total" will
reflect the number
of logical CPUs. To
get the number of
physical CPUs,
divide the "total" by
"threadingDegree".
NULL
BIGINT
All
Number of CPU
cores per socket. On
single core systems
this value is 1.
NULL
MEMORY_TOTAL
BIGINT
Total size of physical All

memory.
MB
MEMORY_FREE
BIGINT
Amount of free
physical memory.
All
MB
MEMORY_SWAP_TOTAL
BIGINT
Total amount of
swap space.
All
MB
MEMORY_SWAP_FREE
BIGINT
Amount of free
swap space.
All
MB
VIRTUAL_MEM_TOTAL
BIGINT
Total amount of
virtual memory on
the system.
All
MB
BIGINT
Amount of reserved
virtual memory.
All
MB
VIRTUAL_MEM_FREE
BIGINT
Amount of virtual
memory free.
All
MB
Physical
memory
Virtual memory
1154

Platforms
that return
this
information
Information
type
Name
Data types
Description
CPU load
CPU_LOAD_SHORT
DECIMAL
Shortest period
duration. For
example, load
samples over last 5
minutes.
All except
Windows
operating
systems
NULL
CPU_LOAD_MEDIUM
DECIMAL
Medium period
duration. For
example, load
samples over last 10
minutes.
All except
Windows
operating
systems
NULL
CPU_LOAD_LONG
DECIMAL
Long period
duration. For
example, load
minutes.
All except
Windows
operating
systems
NULL
CPU_USAGE_TOTAL
SMALLINT
Percentage of overall All

CPU usage of the
machine.
UNIT
Percent
ENV_GET_SYS_RESOURCES table function - return system

information
The ENV_GET_SYS_RESOURCES table function returns operating system, CPU,
memory, and other information related to the system.
Important: The ENV_GET_SYS_RESOURCES table function has been deprecated
and replaced by the ENV_GET_SYSTEM_RESOURCES table function - Return
system information on page 396.
Syntax
ENV_GET_SYS_RESOURCES (
Authorization
EXECUTE privilege on the ENV_GET_SYS_RESOURCES table function.
Examples
The following example describes a sample query that uses the
ENV_GET_SYS_RESOURCES table function, and the resulting output.
SELECT SUBSTR(NAME,1,20) AS NAME, SUBSTR(VALUE,1,10) AS VALUE,
SUBSTR(DATATYPE,1,10) AS DATATYPE, DBPARTITIONNUM
FROM TABLE(SYSPROC.ENV_GET_SYS_RESOURCES()) AS T
NAME
VALUE
DATATYPE DBPARTITIONNUM
-------------------- ---------- ---------- -------------OS_NAME
Linux VARCHAR(25
0
1155
HOST_NAME
OS_VERSION
OS_RELEASE
MACHINE_IDENTIFICATI
OS_LEVEL
CPU_TOTAL
CPU_ONLINE
CPU_CONFIGURED
CPU_SPEED
CPU_HMT_DEGREE
MEMORY_TOTAL
MEMORY_FREE
MEMORY_SWAP_TOTAL
MEMORY_SWAP_FREE
VIRTUAL_MEM_TOTAL
VIRTUAL_MEM_FREE
CPU_LOAD_SHORT
CPU_LOAD_MEDIUM
CPU_LOAD_LONG
CPU_USAGE_TOTAL
host1
2
6
x86_64
5
4
4
4
2599
1
1
7778
2474
2056
1964
9834
4438
0.020000
0.030000
0.040000
0
VARCHAR(25
VARCHAR(25
VARCHAR(25
VARCHAR(25
VARCHAR(25
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
DECIMAL
DECIMAL
DECIMAL
SMALLINT
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
ENV_SYS_RESOURCES administrative view metadata

Table 274. ENV_SYS_RESOURCES table function metadata
Column name
Data type
Description
NAME
VARCHAR(128)
Name of the attribute. See Table 275 for

possible values.
Note: Some attributes might not be available
depending on the operating system and
hardware configuration at the server.
VALUE
VARCHAR(1024)
The value of the attribute.
DATATYPE
VARCHAR(128)
Attribute data type.
UNIT
VARCHAR(128)
Unit used for the VALUE column if

applicable. NULL is returned if not
applicable.
DBPARTITIONNUM
SMALLINT
The database partition from which the data

was retrieved for this row.
Table 275. Possible values for the NAME column
Information
type
Platforms
that return
this
information
UNIT
Name
Data Types
Description
Operating
system
OS_NAME
VARCHAR(256)
Name of the
operating system
software.
All
NULL
Operating
system
HOST_NAME
VARCHAR(256)
Host name of the

system.
All
NULL
Operating
system
OS_VERSION
VARCHAR(256)
Version of the
operating system.
For example, AIX:
4.3 version = 4.
All
NULL
1156
Information
type
Platforms
that return
this
information
UNIT
Name
Data Types
Description
Operating
system
OS_RELEASE
VARCHAR(256)
Release of the
operating system.
For example, AIX:
4.3 release = 3.
All
NULL
Operating
system
VARCHAR(256)
Machine hardware
identification.
All
NULL
Operating
system
OS_LEVEL
VARCHAR(256)
Maintenance level of Linux

the current version
and release. For
example, LINUX:
2.4.9, level = 9.
NULL
CPU
CPU_TOTAL
BIGINT
Total number of
CPUs.
All
NULL
CPU
CPU_ONLINE
BIGINT
Number of CPUs
online.
All
NULL
CPU
CPU_CONFIGURED
BIGINT
Number of CPUs
configured.
All
NULL
CPU
CPU_SPEED
BIGINT
Speed of CPUs.
All
MHz
CPU
CPU_TIMEBASE
BIGINT
Frequency of
timebase register
increment.
Linux
PowerPC
Hz
CPU
CPU_HMT_DEGREE
BIGINT
All
On systems that
support hardware
multithreading
(HMT), this is the
number of
processors that a
physical processor
will appear to the
operating system as.
On non-HMT
systems, this value is
1. On HMT systems,
"total" will reflect the
number of logical
CPUs. To get the
number of physical
CPUs, divide the
"total" by
"threadingDegree".
NULL
CPU
BIGINT
Number of CPU
cores per socket. On
single core systems
this value is 1.
NULL
Physical
memory
MEMORY_TOTAL
BIGINT
Total size of physical All

memory.
MB
Physical
memory
MEMORY_FREE
BIGINT
Amount of free
physical memory.
MB
All
All
1157
Information
type
Platforms
that return
this
information
UNIT
Name
Data Types
Description
Physical
memory
MEMORY_SWAP_TOTAL
BIGINT
Total amount of
swap space.
All
MB
Physical
memory
MEMORY_SWAP_FREE
BIGINT
Amount of free
swap space.
All
MB
Virtual memory
VIRTUAL_MEM_TOTAL
BIGINT
Total amount of
virtual memory on
the system.
All
MB
Virtual memory
BIGINT
Amount of reserved
virtual memory.
All
MB
Virtual memory
VIRTUAL_MEM_FREE
BIGINT
Amount of virtual
memory free.
All
MB
CPU load
CPU_LOAD_SHORT
DECIMAL
Shortest period
duration. For
example, load
samples over last 5
minutes.
All except
Windows
operating
systems
NULL
CPU load
CPU_LOAD_MEDIUM
DECIMAL
Medium period
duration. For
example, load
minutes.
All except
Windows
operating
systems
NULL
CPU load
CPU_LOAD_LONG
DECIMAL
Long period
duration. For
example, load
minutes.
All except
Windows
operating
systems
NULL
CPU load
CPU_USAGE_TOTAL
SMALLINT
Percentage of overall All

CPU usage of the
machine.
Percent
GET_DB_CONFIG
The GET_DB_CONFIG procedure returns database configuration information.
The procedure does not take any arguments.
Note: This procedure has been deprecated and replaced by the DBCFG
administrative view and DB_GET_CFG table function - Retrieve database
configuration parameter information on page 366.
GET_DB_CONFIG (

The procedure returns a single result set with two rows containing a column for
each parameter. The first column is named DBCONFIG_TYPE, as shown in the
following table.
1158
Table 276. Information returned by the GET_DB_CONFIG procedure

Column name
Data type
Description
DBCONFIG_TYPE
INTEGER
The row with a value of 0 in this column

contains the values of the database
configuration parameters stored on disk.
contains the current values of the database
configuration parameters stored in memory.
This procedure requires a user temporary table space that is used to create a global
temporary table named DB_CONFIG to store the result set.
Authorization
v DBADM authority
v SQLADM authority

Example
Using the command line processor (CLP), change the value of the logarchmeth1
database configuration parameter. Retrieve the original (on disk) and updated (in
memory) values by calling the GET_DB_CONFIG procedure and then querying the
resulting global temporary table (DB_CONFIG).
CONNECT TO SAMPLE
CREATE BUFFERPOOL MY8KPOOL SIZE 250 PAGESIZE 8K
CREATE USER TEMPORARY TABLESPACE MYTSP2 PAGESIZE
8K MANAGED BY SYSTEM USING ( TSC2 ) BUFFERPOOL MY8KPOOL
UPDATE DB CFG USING LOGARCHMETH1 USEREXIT
CALL SYSPROC.GET_DB_CONFIG()
SELECT DBCONFIG_TYPE, LOGARCHMETH1
FROM SESSION.DB_CONFIG
CONNECT RESET

DBCONFIG_TYPE LOGARCHMETH1
------------- -----------0
1
1
0
1159
GET_DBM_CONFIG
The GET_DBM_CONFIG table function returns database manager configuration
information.
The function does not take any arguments.
Note: This table function has been deprecated and replaced by the DBMCFG
administrative view - Retrieve database manager configuration parameter
information on page 369.
GET_DBM_CONFIG (
Authorization
v DBADM authority
v SQLADM authority

The function returns a table with two rows containing a column for each
parameter. The first column is named DBMCONFIG_TYPE, as shown in the
following table.
Table 277. Information returned by the GET_DBM_CONFIG table function
Column name
Data type
Description
DBMCONFIG_TYPE
INTEGER

contains the values of the database manager
configuration parameters stored on disk.
contains the current values of the database
manager configuration parameters stored in
memory.
Example
Using the command line processor (CLP), change the value of the numdb and the
diaglevel database manager configuration parameters, and then retrieve the
original (on disk) and updated (in memory) values.
UPDATE DBM CFG USING NUMDB 32 DIAGLEVEL 4
CONNECT TO SAMPLE
SELECT DBMCONFIG_TYPE, NUMDB, DIAGLEVEL
FROM TABLE(SYSFUN.GET_DBM_CONFIG()) AS DBMCFG
CONNECT RESET
1160

DBMCONFIG_TYPE NUMDB
DIAGLEVEL
-------------- ----------- ----------0
32
4
1
8
3
Health snapshot routines

HEALTH_CONT_HI
The HEALTH_CONT_HI table function returns health indicator information for
table space containers from a health snapshot of table spaces in a database.
Important: This table function has been deprecated and might be removed in a
Syntax
HEALTH_CONT_HI (
dbname
member

dbname
this function. Specify a database name that has a directory entry type of either
"Indirect" or "Home", as returned by the LIST DATABASE DIRECTORY command.
Specify the null value to take the snapshot from the currently connected
database.
member
number. Specify -1 for the current database member, or -2 for an aggregate of
all active database members. An active database member is a member where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Authorization
v DBADM authority
v SQLADM authority

1161
Example
SELECT * FROM TABLE(HEALTH_CONT_HI(,-1)) AS T

SNAPSHOT_TIMESTAMP
-------------------------2006-02-13-12.30.40.759542
2006-02-13-12.30.40.759542
2006-02-13-12.30.40.759542
2006-02-13-12.30.40.759542
2006-02-13-12.30.40.759542
CONTAINER_NAME
-------------------------------------------...D:\DB2\NODE0000\SAMPLE\T0000000\C0000000.CAT
D:\DB2\NODE0000\SAMPLE\T0000003\C0000000.LRG
D:\DB2\NODE0000\SAMPLE\T0000004\C0000000.UTM
D:\DB2\NODE0000\SAMPLE\T0000001\C0000000.TMP
...
...
...
...
...
...
...

... NODE_NUMBER HI_ID
HI_VALUE HI_TIMESTAMP
...
... ----------- -------------------- -------- -------------------------- ...
...
3001
1 2006-02-13-12.26.26.158000 ...
...
3001
1 2006-02-13-12.26.26.158000 ...
...
3001
1 2006-02-13-12.26.26.158000 ...
...
3001
1 2006-02-13-12.26.26.158000 ...
...
3001
1 2006-02-13-12.26.26.158000 ...

... HI_ALERT_STATE
... -------------------...
1
...
1
...
1
...
1
...
1
HI_ALERT_STATE_DETAIL
--------------------Normal
Normal
Normal
Normal
Normal
HI_FORMULA
HI_ADDITIONAL_INFO
-----------...- -----------------1
1
1
1
1
-
Table 278. Information returned by the HEALTH_CONT_HI table function
1162
Description or
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
snapshot_timestamp Snapshot timestamp
CONTAINER_NAME
VARCHAR(256)
container_name - Container
name
NODE_NUMBER
INTEGER
node_number - Node
number
HI_ID
BIGINT
A number that uniquely

identifies the health indicator
in the snapshot data stream.
HI_VALUE
SMALLINT
The value of the health

indicator.
HI_TIMESTAMP
TIMESTAMP

alert was generated.
HI_ALERT_STATE
BIGINT
The severity of the alert.
VARCHAR(20)
The text description of the

HI_ALERT_STATE column.
HI_FORMULA
VARCHAR(2048)
The formula used to

calculate the health indicator.
Table 278. Information returned by the HEALTH_CONT_HI table function (continued)

Description or
element
Column name
Data type
HI_ADDITIONAL_INFO
VARCHAR(4096)
Additional information about

the health indicator.
HEALTH_CONT_HI_HIS
Returns health indicator history information for containers from a health snapshot
of a database.
Syntax
HEALTH_CONT_HI_HIS (
dbname
member

dbname
database.
member
Authorization
v DBADM authority
v SQLADM authority

1163
Example
SELECT * FROM TABLE(HEALTH_CONT_HI_HIS(,-1)) AS T

SNAPSHOT_TIMESTAMP
-------------------------2006-02-13-12.30.41.915646
2006-02-13-12.30.41.915646
2006-02-13-12.30.41.915646
2006-02-13-12.30.41.915646
2006-02-13-12.30.41.915646
2006-02-13-12.30.41.915646
2006-02-13-12.30.41.915646
2006-02-13-12.30.41.915646
2006-02-13-12.30.41.915646
2006-02-13-12.30.41.915646
CONTAINER_NAME
----------------------------------------...D:\DB2\NODE0000\SAMPLE\T0000000\C0000000.CAT
D:\DB2\NODE0000\SAMPLE\T0000000\C0000000.CAT
...
...
...
...
...
...
...
...
...
...
...
...

... NODE_NUMBER HI_ID
HI_TIMESTAMP
HI_VALUE HI_ALERT_STATE ...
... ----------- -----...- -------------------------- -------- -------------- ...
...
3001 2006-02-13-12.16.25.911000
1
1 ...
...
3001 2006-02-13-12.06.26.168000
1
1 ...
...
3001 2006-02-13-12.16.25.911000
1
1 ...
...
3001 2006-02-13-12.06.26.168000
1
1 ...
...
3001 2006-02-13-12.16.25.911000
1
1 ...
...
3001 2006-02-13-12.06.26.168000
1
1 ...
...
3001 2006-02-13-12.16.25.911000
1
1 ...
...
3001 2006-02-13-12.06.26.168000
1
1 ...
...
3001 2006-02-13-12.16.25.911000
1
1 ...
...
3001 2006-02-13-12.06.26.168000
1
1 ...

...
...
...
...
...
...
...
...
...
...
...
...
--------------------Normal
Normal
Normal
Normal
Normal
Normal
Normal
Normal
Normal
Normal
HI_FORMULA
HI_ADDITIONAL_INFO
-----------...- -----------------1
1
1
1
1
1
1
1
1
1
-
Table 279. Information returned by the HEALTH_CONT_HI_HIS table function
1164
Description or
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
CONTAINER_NAME
VARCHAR(256)
name
NODE_NUMBER
INTEGER
node_number - Node number
Table 279. Information returned by the HEALTH_CONT_HI_HIS table function (continued)

Description or
element
Column name
Data type
HI_ID
BIGINT

HI_TIMESTAMP
TIMESTAMP

HI_VALUE
SMALLINT

indicator.
HI_ALERT_STATE
BIGINT
VARCHAR(20)

HI_FORMULA
VARCHAR(2048)
The formula used to

HI_ADDITIONAL_INFO
VARCHAR(4096)

HEALTH_CONT_INFO
The HEALTH_CONT_INFO table function returns container information from a
health snapshot of a database.
Syntax
HEALTH_CONT_INFO (
dbname
member

dbname
database.
member
1165
Authorization
v DBADM authority
v SQLADM authority

Example
SELECT * FROM TABLE(HEALTH_CONT_INFO(,-1)) AS T

SNAPSHOT_TIMESTAMP
-------------------------2006-02-13-12.30.40.541209
2006-02-13-12.30.40.541209
2006-02-13-12.30.40.541209
2006-02-13-12.30.40.541209
2006-02-13-12.30.40.541209
CONTAINER_NAME
-----------------------------------------...D:\DB2\NODE0000\SAMPLE\T0000000\C0000000.CAT
...
...
...
...
...
...
...

...
...
...
...
...
...
...
TABLESPACE_NAME
NODE_NUMBER ...
---------------...- ----------- ...
SYSCATSPACE
- ...
SYSTOOLSPACE
- ...
SYSTOOLSTMPSPACE
- ...
TEMPSPACE1
- ...
USERSPACE1
- ...

... ROLLED_UP_ALERT_STATE ROLLED_UP_ALERT_STATE_DETAIL
... --------------------- ---------------------------...
1 Normal
...
1 Normal
...
1 Normal
...
1 Normal
...
1 Normal
Table 280. Information returned by the HEALTH_CONT_INFO table function
1166
Description or
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
CONTAINER_NAME
VARCHAR(256)
name
TABLESPACE_NAME
VARCHAR(128)
space name
Table 280. Information returned by the HEALTH_CONT_INFO table function (continued)
Column name
Data type
NODE_NUMBER
INTEGER
Description or
element
node_number - Node
number
ROLLED_UP_ALERT_STATE BIGINT
The most severe alert state

captured by this snapshot.
ROLLED_UP_ALERT_
STATE_DETAIL

ROLLED_UP_ALERT_STATE
column.
VARCHAR(20)
HEALTH_DB_HI
The HEALTH_DB_HI table function returns health indicator information from a
health snapshot of a database.
Syntax
HEALTH_DB_HI (
dbname
, member

dbname
Specify the null value to take the snapshot from all databases under the
database instance.
member
Authorization
v DBADM authority
v SQLADM authority
1167

Example
SELECT * FROM TABLE(HEALTH_DB_HI(,-1)) AS T

SNAPSHOT_TIMESTAMP
HI_ID
DB_NAME
HI_VALUE ...
-------------------------- -----...- -------...- -------- ...
2006-02-13-12.30.23.949888
1001 SAMPLE
0 ...
2006-02-13-12.30.23.949888
1002 SAMPLE
0 ...
2006-02-13-12.30.23.949888
1003 SAMPLE
0 ...
2006-02-13-12.30.23.949888
1005 SAMPLE
6 ...
2006-02-13-12.30.23.949888
1006 SAMPLE
53 ...
2006-02-13-12.30.23.949888
1008 SAMPLE
3 ...
2006-02-13-12.30.23.949888
1010 SAMPLE
0 ...
2006-02-13-12.30.23.949888
1014 SAMPLE
74 ...
2006-02-13-12.30.23.949888
1015 SAMPLE
1 ...
2006-02-13-12.30.23.949888
1018 SAMPLE
1 ...
2006-02-13-12.30.23.949888
1022 SAMPLE
1 ...

...
...
...
...
...
...
...
...
...
...
...
...
...
HI_TIMESTAMP
HI_ALERT_STATE HI_ALERT_STATE_DETAIL ...
-------------------------- -------------- --------------------- ...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.30.25.640000
2 Attention
...
2006-02-13-12.30.25.640000
2 Attention
...
2006-02-13-12.29.25.281000
2 Attention
...

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
1168
HI_FORMULA
----------------------------------------...0
((0 / 5000) * 100)
(((0 - 0) / ((118 - 0) + 1)) * 100)
((1170384 / (1170384 + 19229616)) * 100)
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
((11155116032 / 21138935808) * 100)
((5264 / (50 * 4096)) * 100)

((0 / 5) * 100)
((4587520 / 6160384) * 100)
-
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
HI_ADDITIONAL_INFO
---------------------------------------The high watermark for shared sort
memory is "57". "99"% of the time
the sort heap allocation is less
than or equal to "246". The sort
heap (sortheap) database
configuration parameter is set
to "256". The high watermark for
private sort memory is "0".
The sort heap (sortheap) database
configuration parameter is set to
"256". The high watermark for
private sort memory is "57". The
high watermark for shared sort
memory is "0"
The following are the related
database configuration parameter
settings: logprimary is "3",
logsecond is "2", and logfilsiz
is "1000". The application with
the oldest transaction is "712".
is "1000", blk_log_dsk_ful is
"NO", logarchmeth1 is "OFF" and
logarchmeth2 is "OFF".
The scope setting in the reorganization
policy is "TABSCHEMA NOT LIKE SYS%".
1169
...
Automatic reorganization (AUTO_REORG)
...
for this database is set to "OFF".
...
The longest estimated reorganization
...
time is "N/A".
... The last successful backup was taken
...
at "N/A". The log space consumed since
...
this last backup has been "N/A" 4KB
...
pages. Automation for database backup
...
is set to "OFF". The last automated
...
backup returned with SQLCODE = "N/A".
...
The longest estimated backup time
...
is "N/A".
... The scope is "N\A". Automatic
...
statistics collection (AUTO_RUNSTATS)
...
is set to "OFF".
Table 281. Information returned by the HEALTH_DB_HI table function
Description or
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
HI_ID
BIGINT

DB_NAME
VARCHAR(128)
HI_VALUE
SMALLINT

indicator.
HI_TIMESTAMP
TIMESTAMP

HI_ALERT_STATE
BIGINT
VARCHAR(20)

HI_FORMULA
VARCHAR(2048)
The formula used to

HI_ADDITIONAL_INFO
VARCHAR(4096)

HEALTH_DB_HI_HIS
The HEALTH_DB_HI_HIS table function returns health indicator history
information from a health snapshot of a database.
Syntax
HEALTH_DB_HI_HIS (
1170
dbname
member

dbname
database instance.
member
Authorization
v DBADM authority
v SQLADM authority

Example
SELECT * FROM TABLE(HEALTH_DB_HI_HIS(,-1)) AS T

SNAPSHOT_TIMESTAMP
HI_ID
-------------------------- -----...2006-02-13-12.30.26.325627
1001
...
2006-02-13-12.30.26.325627
1002
...
2006-02-13-12.30.26.325627
1003
...
2006-02-13-12.30.26.325627
1005
...
2006-02-13-12.30.26.325627
1008
...
2006-02-13-12.30.26.325627
1010
...
2006-02-13-12.30.26.325627
1014
...
2006-02-13-12.30.26.325627
1015
...
2006-02-13-12.30.26.325627
1018
...
2006-02-13-12.30.26.325627
1022
...
DB_NAME
HI_VALUE ...
-------...- -------- ...
SAMPLE
0 ...
...
SAMPLE
0 ...
...
SAMPLE
0 ...
...
SAMPLE
3 ...
...
SAMPLE
2 ...
...
SAMPLE
0 ...
...
SAMPLE
73 ...
...
SAMPLE
1 ...
...
SAMPLE
1 ...
...
SAMPLE
1 ...
1171

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
HI_TIMESTAMP
HI_ALERT_STATE
-------------------------- -------------------2006-02-13-12.21.25.649000
1
...
2006-02-13-12.21.25.649000
1
...
2006-02-13-12.20.25.182000
1
...
2006-02-13-12.16.25.911000
1
...
2006-02-13-12.16.25.911000
1
...
2006-02-13-12.16.25.911000
1
...
2006-02-13-12.21.25.649000
1
...
2006-02-13-12.29.55.461000
2
...
2006-02-13-12.29.25.281000
2
...
2006-02-13-12.27.55.743000
2
...

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
1172
HI_FORMULA
----------------------------------------0
...
((0 / 5000) * 100)
...
(((0 - 0) / ((68 - 0) + 1)) * 100)
...
((698410 / (698410 + 19701590)) * 100)
...
((3920 / (50 * 4096)) * 100)
...
((0 / 4) * 100)
...
((4521984 / 6160384) * 100)
...
-
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
HI_ALERT_STATE_DETAIL ...
--------------------- ...
Normal
...
...
Normal
...
...
Normal
...
...
Normal
...
...
Normal
...
...
Normal
...
...
Normal
...
...
Attention
...
...
Attention
...
...
Attention
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
-
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
HI_ADDITIONAL_INFO
--------------------------------------The high watermark for shared sort
memory is "15". "99"% of the time
the sort heap allocation is less
than or equal to "246". The sort
heap (sortheap) database
to "256". The high watermark
for private sort memory is "0".
The sort heap (sortheap) database
to "256". The high watermark for
private sort memory is "15". The
high watermark for shared sort
memory is "0"
is "1000". The application with
the oldest transaction is "712".
The scope setting in the
reorganization policy is
"TABSCHEMA NOT LIKE SYS%".
Automatic reorganization
(AUTO_REORG) for this database
is set to "OFF". The longest
estimated reorganization time
is "N/A".
The last successful backup was taken
at "N/A". The log space consumed
since this last backup has been
"N/A" 4KB pages. Automation for
database backup is set to "OFF". The
last automated backup returned with
SQLCODE = "N/A". The longest
estimated backup time is "N/A".
1173
...
... The scope is "N\A". Automatic
...
statistics collection
...
(AUTO_RUNSTATS) is set to "OFF".
...
Table 282. Information returned by the HEALTH_DB_HI_HIS table function
Description or
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
HI_ID
BIGINT

DB_NAME
VARCHAR(128)
HI_VALUE
SMALLINT

indicator.
HI_TIMESTAMP
TIMESTAMP

HI_ALERT_STATE
BIGINT
VARCHAR(20)

HI_FORMULA
VARCHAR(2048)
The formula used to

HI_ADDITIONAL_INFO
VARCHAR(4096)

HEALTH_DB_HIC
The HEALTH_DB_HIC function returns collection health indicator information
from a health snapshot of a database.
Syntax
HEALTH_DB_HIC (
dbname
member

dbname
1174

database instance.
member
number. Specify -1 for the current database member, or -2 for all active
database members. An active database member is a member where the
Authorization
v DBADM authority
v SQLADM authority

Example
SELECT * FROM TABLE(HEALTH_DB_HIC(,-1)) AS T

SNAPSHOT_TIMESTAMP
HI_ID
-------------------------- -----...2006-02-13-12.30.33.870959
1015
2006-02-13-12.30.33.870959
1022
DB_NAME
-------...SAMPLE
SAMPLE
...
...
...
...

...
...
...
...
HI_OBJ_NAME
---------------------------------...-"JESSICAE"."EMPLOYEE"
"SYSIBM"."SYSDATAPARTITIONEXPRESSION"
HI_OBJ_DETAIL
-------------...REORG TABLE
RUNSTATS
...
...
...
...

... HI_OBJ_STATE HI_OBJ_STATE_DETAIL HI_TIMESTAMP
... ------------ -------------------- -------------------------...
2 Attention
2006-02-13-12.24.27.000000
...
2 Attention
2006-02-13-12.29.26.000000
Table 283. Information returned by the HEALTH_DB_HIC table function
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
Description or
element
1175
Table 283. Information returned by the HEALTH_DB_HIC table function (continued)

Description or
element
Column name
Data type
HI_ID
BIGINT

DB_NAME
VARCHAR(128)
HI_OBJ_NAME
VARCHAR(512)
A name that uniquely

identifies an object in the
collection.
HI_OBJ_DETAIL
VARCHAR(512)
Text that describes why the

object was added to the
collection.
HI_OBJ_STATE
SMALLINT
The state of the object. Valid

states (defined in sqlmon.h)
include:
v NORMAL (1). Action is
not required on this object.
v ATTENTION (2).
Automation is not enabled
for this health indicator;
action must be taken
manually.
v AUTOMATED (5).
Automation is enabled for
this health indicator;
action will be started
automatically.
v AUTOMATE_FAILED (6).
action was started, but
could not complete
successfully. Manual
intervention is now
required.
HI_OBJ_STATE_DETAIL
VARCHAR(20)
A translated string version of

the value in the
HI_OBJ_STATE column.
HI_TIMESTAMP
TIMESTAMP

HEALTH_DB_HIC_HIS
Returns collection health indicator history information from a health snapshot of a
database.
1176
Syntax
HEALTH_DB_HIC_HIS (
dbname
member

dbname
database instance.
member
database partitions. An active database member is a member where the
Authorization
v DBADM authority
v SQLADM authority

Example
SELECT * FROM TABLE(HEALTH_DB_HIC_HIS(,-1)) AS T

HI_HIS_ENTRY_NUM
---------------1
2
3
4
5
6
7
8
9
10
SNAPSHOT_TIMESTAMP
HI_ID
-------------------------- -------------------2006-02-13-12.30.34.496720
1015
2006-02-13-12.30.34.496720
1022
2006-02-13-12.30.34.496720
1022
2006-02-13-12.30.34.496720
1022
2006-02-13-12.30.34.496720
1022
2006-02-13-12.30.34.496720
1022
2006-02-13-12.30.34.496720
1022
2006-02-13-12.30.34.496720
1022
2006-02-13-12.30.34.496720
1022
2006-02-13-12.30.34.496720
1022
...
...
...
...
...
...
...
...
...
...
...
...

1177
...
...
...
...
...
...
...
...
...
...
...
...
DB_NAME
-------...SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
HI_OBJ_NAME
HI_OBJ_STATE ...
----------------------------------...- ------------ ...
"JESSICAE"."EMPLOYEE"
2 ...
2 ...
2 ...
2 ...
1 ...
1 ...
1 ...
1 ...
1 ...
1 ...

...
...
...
...
...
...
...
...
...
...
...
...
HI_OBJ_STATE_DETAIL
-------------------Attention
Attention
Attention
Attention
Normal
Normal
Normal
Normal
Normal
Normal
HI_TIMESTAMP
-------------------------2006-02-10-09.04.57.000000
2006-02-13-12.27.56.000000
2006-02-13-12.26.27.000000
2006-02-13-12.24.56.000000
2006-02-13-12.23.28.000000
2006-02-13-12.21.56.000000
2006-02-13-12.20.26.000000
2006-02-13-12.18.57.000000
2006-02-13-12.17.27.000000
2006-02-13-12.15.56.000000
Table 284. Information returned by the HEALTH_DB_HIC_HIS table function
1178
Description or
element
Column name
Data type
HI_HIS_ENTRY_NUM
SMALLINT

identifies the history entry.
SNAPSHOT_TIMESTAMP
TIMESTAMP
HI_ID
BIGINT

DB_NAME
VARCHAR(128)
HI_OBJ_NAME
VARCHAR(512)
A name that uniquely

identifies an object in the
collection.
Table 284. Information returned by the HEALTH_DB_HIC_HIS table function (continued)
Column name
Data type
HI_OBJ_STATE
SMALLINT
Description or
element
The state of the object. Valid
states (defined in sqlmon.h)
include:
v NORMAL (1). Action is
not required on this object.
v ATTENTION (2).
Automation is not enabled
for this health indicator;
action must be taken
manually.
v AUTOMATED (5).
action will be started
automatically.
v AUTOMATE_FAILED (6).
action was started, but
could not complete
successfully. Manual
intervention is now
required.
HI_OBJ_STATE_DETAIL
VARCHAR(20)
A translated string version of

the value in the
HI_OBJ_STATE column.
HI_TIMESTAMP
TIMESTAMP

HEALTH_DB_INFO
The HEALTH_DB_INFO table function returns information from a health snapshot
of a database.
Syntax
HEALTH_DB_INFO (
dbname
member

dbname
1179
database instance.
member
Authorization
v DBADM authority
v SQLADM authority

Example
SELECT * FROM TABLE(HEALTH_DB_INFO(,-1)) AS T

SNAPSHOT_TIMESTAMP
DB_NAME
INPUT_DB_ALIAS
...
-------------------------- -------...- ---------------...- ...
2006-02-13-12.30.23.340081 SAMPLE
SAMPLE
...

... DB_PATH
DB_LOCATION SERVER_PLATFORM ...
... ------------------------...- ----------- --------------- ...
... D:\DB2\NODE0000\SQL00003\
1
5 ...

... --------------------- ---------------------------...
4 Alarm
Table 285. Information returned by the HEALTH_DB_INFO table function
1180
Description or
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
DB_NAME
VARCHAR(128)
Table 285. Information returned by the HEALTH_DB_INFO table function (continued)

Description or
element
Column name
Data type
INPUT_DB_ALIAS
VARCHAR(128)
input_db_alias - Input
database alias
DB_PATH
VARCHAR(1024)
db_path - Database path
DB_LOCATION
INTEGER
db_location - Database
location
SERVER_PLATFORM
INTEGER
server_platform - Server
operating system

ROLLED_UP_ALERT_
STATE_DETAIL

column.
VARCHAR(20)
HEALTH_DBM_HI
The HEALTH_DBM_HI table function returns health indicator information from a
health snapshot of the DB2 database manager.
Syntax
HEALTH_DBM_HI (
member

member
Authorization
v DBADM authority
v SQLADM authority
1181

Example
SELECT * FROM TABLE(HEALTH_DBM_HI(-1)) AS T

SNAPSHOT_TIMESTAMP
HI_ID
-------------------------- -----...2006-02-13-12.30.19.773632
1
2006-02-13-12.30.19.773632
4
SERVER_INSTANCE_NAME
--------------------...DB2
DB2
...
...
...
...

... HI_VALUE HI_TIMESTAMP
... -------- -------------------------- -------------- --------------------- ...
...
0 2006-02-13-12.26.26.158000
1 Normal
...
...
100 2006-02-13-12.26.26.158000
4 Alarm
...

...
...
...
...
HI_FORMULA
---------------------...0
((327680 / 327680) * 100)
HI_ADDITIONAL_INFO
------------------
Table 286. Information returned by the HEALTH_DBM_HI table function

Description or
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
HI_ID
BIGINT

SERVER_INSTANCE_NAME VARCHAR(128)
server_instance_name Server instance name
HI_VALUE
SMALLINT

indicator.
HI_TIMESTAMP
TIMESTAMP

HI_ALERT_STATE
BIGINT
VARCHAR(20)

HI_FORMULA
VARCHAR(2048)
The formula used to

HI_ADDITIONAL_INFO
VARCHAR(4096)

HEALTH_DBM_HI_HIS
The HEALTH_DBM_HI_HIS table function returns health indicator history
information from a health snapshot of the DB2 database manager.
1182
Syntax
HEALTH_DBM_HI_HIS (
member

member
Authorization
v DBADM authority
v SQLADM authority

Example
SELECT * FROM TABLE(HEALTH_DBM_HI_HIS(-1)) AS T

SNAPSHOT_TIMESTAMP
HI_ID
-------------------------- -----...2006-02-13-12.30.20.460905
1
2006-02-13-12.30.20.460905
1
2006-02-13-12.30.20.460905
1
2006-02-13-12.30.20.460905
1
2006-02-13-12.30.20.460905
1
2006-02-13-12.30.20.460905
1
2006-02-13-12.30.20.460905
1
2006-02-13-12.30.20.460905
1
2006-02-13-12.30.20.460905
1
2006-02-13-12.30.20.460905
4
2006-02-13-12.30.20.460905
4
2006-02-13-12.30.20.460905
4
2006-02-13-12.30.20.460905
4
2006-02-13-12.30.20.460905
4
2006-02-13-12.30.20.460905
4
2006-02-13-12.30.20.460905
4
HI_VALUE ...
--------------------...- -------- ...
DB2
0 ...
DB2
0 ...
DB2
0 ...
DB2
0 ...
DB2
0 ...
DB2
0 ...
DB2
0 ...
DB2
0 ...
DB2
0 ...
DB2
100 ...
DB2
100 ...
DB2
100 ...
DB2
100 ...
DB2
60 ...
DB2
60 ...
DB2
60 ...
1183
2006-02-13-12.30.20.460905
2006-02-13-12.30.20.460905
4 DB2
4 DB2
60 ...
60 ...

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
HI_TIMESTAMP
-------------------------- -------------- --------------------- ...
2006-02-13-12.21.25.649000
1 Normal
...
2006-02-13-12.16.25.911000
1 Normal
...
2006-02-13-12.11.25.377000
1 Normal
...
2006-02-13-12.06.26.168000
1 Normal
...
2006-02-13-12.01.25.165000
1 Normal
...
2006-02-13-11.56.25.927000
1 Normal
...
2006-02-13-11.51.25.452000
1 Normal
...
2006-02-13-11.46.25.211000
1 Normal
...
2006-02-13-11.41.25.972000
1 Normal
...
2006-02-13-12.21.25.649000
4 Alarm
...
2006-02-13-12.16.25.911000
4 Alarm
...
2006-02-13-12.11.25.377000
4 Alarm
...
2006-02-13-12.06.26.168000
4 Alarm
...
2006-02-13-12.01.25.165000
1 Normal
...
2006-02-13-11.56.25.927000
1 Normal
...
2006-02-13-11.51.25.452000
1 Normal
...
2006-02-13-11.46.25.211000
1 Normal
...
2006-02-13-11.41.25.972000
1 Normal
...

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
HI_FORMULA
HI_ADDITIONAL_INFO
-------------------------...- -----------------0
0
0
0
0
0
0
0
0
((327680 / 327680) * 100)
((327680 / 327680) * 100)
((327680 / 327680) * 100)
((327680 / 327680) * 100)
((196608 / 327680) * 100)
((196608 / 327680) * 100)
((196608 / 327680) * 100)
((196608 / 327680) * 100)
((196608 / 327680) * 100)
-
Table 287. Information returned by the HEALTH_DBM_HI_HIS table function
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
HI_ID
BIGINT

1184
Description or
element
Table 287. Information returned by the HEALTH_DBM_HI_HIS table function (continued)

Description or
element
Column name
Data type
HI_VALUE
SMALLINT

indicator.
HI_TIMESTAMP
TIMESTAMP

HI_ALERT_STATE
BIGINT
VARCHAR(20)

HI_FORMULA
VARCHAR(2048)
The formula used to

HI_ADDITIONAL_INFO
VARCHAR(4096)

HEALTH_DBM_INFO
The HEALTH_DBM_INFO function returns information from a health snapshot of
the DB2 database manager.
Syntax
HEALTH_DBM_INFO (
member

member
Authorization
v DBADM authority
v SQLADM authority
1185

Example
SELECT * FROM TABLE(HEALTH_DBM_INFO(-1)) AS T

SNAPSHOT_TIMESTAMP
ROLLED_UP_ALERT_STATE ...
-------------------------- --------------------...--- --------------------- ...
2006-02-13-12.30.19.663924 DB2
4 ...

... ROLLED_UP_ALERT_STATE_DETAIL DB2START_TIME
...
... ---------------------------- -------------------------- ...
... Alarm
2006-02-09-10.56.18.126182 ...

... LAST_RESET
NUM_NODES_IN_DB2_INSTANCE
... -----------...--- ------------------------... 1
Table 288. Information returned by the HEALTH_DBM_INFO table function
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
Description or
element

ROLLED_UP_ALERT_
STATE_DETAIL
VARCHAR(20)

column.
DB2START_TIME
TIMESTAMP
db2start_time - Start
database manager timestamp
LAST_RESET
TIMESTAMP
last_reset - Last reset

timestamp
NUM_NODES_IN_DB2_
INSTANCE
INTEGER
num_nodes_in_db2_instance
- Number of nodes in
database partition
HEALTH_GET_ALERT_ACTION_CFG
Returns health alert action configuration settings for various object types (database
manager, database, table space, and table space container) and for various
configuration levels (install default, instance, global, and object).
1186
Syntax
HEALTH_GET_ALERT_ACTION_CFG ( objecttype
, cfg_level
, dbname
objectname )

objecttype
value must be one of the following case-insensitive values:
v 'DBM' for database manager
v 'DB' for database
v 'TS' for table space
v 'TSC' for table space container
Note: Leading and trailing spaces will be ignored.
cfg_level
An input argument of type VARCHAR(1) that indicates the configuration level.
The value must be one of the following case-insensitive values:
v For objecttype 'DBM': 'D' for install default; 'G' or 'O' for instance level.
v For objecttype that is not 'DBM': 'D' for install default; 'G' for global level; 'O'
for object level.
dbname
An input argument of type VARCHAR(128) that indicates the database name.
The database name must be provided if objecttype is 'DB', 'TS', or 'TSC', and
cfg_level is 'O'. For all other combinations of objecttype and cfg_level, the dbname
parameter should be NULL (or an empty string).
objectname
An input argument of type VARCHAR(1024) that indicates the object name, for
example, <table space name> or <table space name>.<container name>. The
object name must be provided if objecttype is 'TS' or 'TSC', and cfg_level is 'O'.
For all other combinations of objecttype and cfg_level, the objectname parameter
should be NULL (or an empty string).
Authorization
v DBADM authority
v SQLADM authority
1187

Examples
Example 1: Retrieve object level alert action configuration settings for database
SAMPLE for health indicator ID 1004.
SELECT OBJECTTYPE, CFG_LEVEL, SUBSTR(DBNAME,1,8) AS DBNAME,
SUBSTR(OBJECTNAME,1,8) AS OBJECTNAME, ID, IS_DEFAULT,
SUBSTR(CONDITION,1,10) AS CONDITION, ACTIONTYPE,
SUBSTR(ACTIONNAME,1,30) AS ACTIONNAME, SUBSTR(USERID,1,8) AS USERID,
SUBSTR(HOSTNAME,1,10) AS HOSTNAME, SCRIPT_TYPE,
SUBSTR(WORKING_DIR,1,10) AS WORKING_DIR, TERMINATION_CHAR,
SUBSTR(PARAMETERS,1,10) AS PARAMETERS
FROM TABLE(HEALTH_GET_ALERT_ACTION_CFG(DB,O,SAMPLE,)) AS ACTION_CFG
WHERE ID = 1004

OBJECTTYPE
---------DB
DB
CFG_LEVEL
--------O
O
DBNAME
OBJECTNAME ID
IS_DEFAULT CONDITION
-------- ---------- --...---- ---------- ---------SAMPLE
1004
1 ALARM
SAMPLE
1004
1 ALARM

...
...
...
...
ACTIONTYPE
---------S
T
ACTIONNAME
-----------------------------~/health_center/script/scrpn6
00.0005
USERID
-------uid1
uid1
HOSTNAME
---------HOST3

...
...
...
...
SCRIPT_TYPE
----------O
-
WORKING_DIR
----------~/health_c
-
TERMINATION_CHAR
----------------
PARAMETERS
----------
Example 2: Retrieve the condition, action type, action name, hostname, and script
type for database SAMPLE for health indicator ID 1004.
SELECT CONDITION, ACTIONTYPE, SUBSTR(ACTIONNAME,1,35) AS ACTIONNAME,
SUBSTR(USERID,1,8) AS USERID, SUBSTR(HOSTNAME,1,10) AS HOSTNAME, SCRIPT_TYPE
FROM TABLE(HEALTH_GET_ALERT_ACTION_CFG(DB,O,SAMPLE,)) AS ALERT_ACTION_CFG
WHERE ID=1004

CONDITION
---------...--ALARM
ALARM
ACTIONTYPE
---------S
T
ACTIONNAME
-------------------------------~/health_center/script/scrpn6
00.0005

...
...
...
...
1188
USERID
-------uid1
uid1
HOSTNAME
---------HOST3
SCRIPT_TYPE
----------O
-
...
...
...
...
Usage notes
The HEALTH_GET_IND_DEFINITION table function can be used to map health
indicator IDs to the health indicator names.
Table 289. Information returned by the HEALTH_GET_ALERT_ACTION_CFG table function
Column name
Data type
Description
OBJECTTYPE
VARCHAR(3)
Object type.
CFG_LEVEL
CHAR(1)
Configuration level.
DBNAME
VARCHAR(128)
Database name.
OBJECTNAME
VARCHAR(512)

monitor element
ID
BIGINT

element
IS_DEFAULT
SMALLINT
Whether the settings is the

default: 1 if it is the default,
0 if it is not the default, Null
if it is not applicable.
CONDITION
VARCHAR(32)
Alert condition upon which

the action is triggered.
ACTIONTYPE
CHAR(1)
Action type: 'S' for script

action or 'T' for task action.
ACTIONNAME
VARCHAR(5000)
If ACTIONTYPE is 'S', this is

the script path name. If
ACTIONTYPE is 'T', this is
the task ID.
USERID
VARCHAR(1024)
User name under which the

action will be executed.
HOSTNAME
VARCHAR(255)

monitor element
SCRIPT_TYPE
CHAR(1)
Script type: If ACTIONTYPE

is 'S', 'O' for operating
system command script or
'D' for DB2 command script;
If ACTIONTYPE is 'T', Null.
WORKING_DIR
VARCHAR(5000)
The working directory for

the script if ACTIONTYPE is
'S' or Null if ACTIONTYPE
is 'T'.
TERMINATION_CHAR
VARCHAR(4)
The statement termination

character if it is a DB2
command script action,
otherwise Null.
PARAMETERS
VARCHAR(200)
The command line

parameters if it is an
operating system command
script action.
1189
HEALTH_GET_ALERT_CFG
Returns health alert configuration settings for various object types (database
manager, database, table space, table space container) and for various configuration
levels (install default, global, and object).
Syntax
HEALTH_GET_ALERT_CFG ( objecttype
, cfg_level
, dbname
objectname )


objecttype
value must be one of the following case-insensitive values:
v 'DBM' for database manager
v 'DB' for database
v 'TS' for table space
v 'TSC' for table space container
Note: Leading and trailing spaces will be ignored.
cfg_level
An input argument of type VARCHAR(1) that indicates the configuration level.
The value must be one of the following case-insensitive values:
v For objecttype 'DBM': 'D' for install default; 'G' or 'O' for instance level.
v For objecttype that is not 'DBM': 'D' for install default; 'G' for global level; 'O'
for object level.
dbname
An input argument of type VARCHAR(128) that indicates the database name.
The database name must be provided if objecttype is 'DB', 'TS', or 'TSC', and
cfg_level is 'O'. For all other combinations of objecttype and cfg_level, the dbname
parameter should be NULL (or an empty string).
objectname
An input argument of type VARCHAR(1024) that indicates the object name, for
example, <table space name> or <table space name>.<container name>. The
object name must be provided if objecttype is 'TS' or 'TSC', and cfg_level is 'O'.
For all other combinations of objecttype and cfg_level, the objectname parameter
should be NULL (or an empty string).
Authorization
1190
v DBADM authority
v SQLADM authority

Examples
Example 1: Retrieve the object level alert configuration settings for database
SAMPLE.
SELECT * FROM TABLE(SYSPROC.HEALTH_GET_ALERT_CFG(DB,O,SAMPLE,))
AS ALERT_CFG

OBJECTTYPE
---------DB
DB
DB
DB
DB
DB
DB
DB
DB
DB
DB
DB
DB
DB
...
CFG_LEVEL
--------O
O
O
O
O
O
O
O
O
O
O
O
O
O
DBNAME
OBJECTNAME
--------...----- -------------...-----SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...

... ID
IS_DEFAULT WARNING_THRESHOLD
...
... -------------------- ---------- -------------------- ...
...
1001
0
0 ...
...
1018
0
0 ...
...
1015
0
0 ...
...
1022
0
0 ...
...
1002
1
95 ...
...
1003
1
30 ...
...
1004
1
60 ...
...
1005
1
75 ...
...
1006
1
75 ...
...
1007
1
5 ...
...
1008
1
75 ...
...
1009
1
5 ...
...
1010
1
50 ...
...
1011
1
80 ...

... ALARM_THRESHOLD
SENSITIVITY
EVALUATE ACTION_ENABLED
... -------------------- -------------------- -------- -------------...
0
0
0
0
...
0
0
1
0
...
0
0
1
0
...
0
0
1
0
...
100
0
0
0
1191
...
...
...
...
...
...
...
...
...
50
30
85
85
10
85
10
70
70
0
0
0
0
0
0
0
0
0
1
1
1
1
1
1
1
1
0
0
0
0
0
0
0
0
0
0
Example 2: Retrieve the warning and alarm thresholds for the health indicator ID
'2002' for table space USERSPACE1 in database SAMPLE.
SELECT WARNING_THRESHOLD, ALARM_THRESHOLD
FROM TABLE(SYSPROC.HEALTH_GET_ALERT_CFG(TS,O,SAMPLE,USERSPACE1))
AS T WHERE ID = 2002

WARNING_THRESHOLD
ALARM_THRESHOLD
-------------------- -------------------80
90
SQL22004N Cannot find the requested configuration for the given object.
Returning default configuration for "tablespaces".
Usage notes
The HEALTH_GET_IND_DEFINITION table function can be used to map health
indicator IDs to the health indicator names.
Example: Retrieve the warning and alarm thresholds for the health indicator
Tablespace Utilization (ts.ts_util) for table space USERSPACE1 in database
SAMPLE.
WITH HINAME(ID) AS (SELECT ID FROM TABLE(SYSPROC.HEALTH_GET_IND_DEFINITION()) AS W
WHERE NAME = ts.ts_util)
SELECT WARNING_THRESHOLD, ALARM_THRESHOLD
FROM TABLE(SYSPROC.HEALTH_GET_ALERT_CFG(TS,O,SAMPLE,USERSPACE1)) AS T,
HINAME AS H
WHERE T.ID = H.ID

WARNING_THRESHOLD
ALARM_THRESHOLD
-------------------- -------------------80
90
SQL22004N Cannot find the requested configuration for the given object.
Returning default configuration for "tablespaces".
Table 290. Information returned by the HEALTH_GET_ALERT_CFG table function
1192
Column name
Data type
Description
OBJECTTYPE
VARCHAR(3)
Object type.
CFG_LEVEL
CHAR(1)
Configuration level.
DBNAME
VARCHAR(128)
Database name.
Table 290. Information returned by the HEALTH_GET_ALERT_CFG table

Column name
Data type
Description
OBJECTNAME
VARCHAR(512)

monitor element
ID
BIGINT

element
IS_DEFAULT
SMALLINT
Whether the settings is the

default: 1 if it is the default,
0 if it is not the default or
Null if not applicable.
WARNING_THRESHOLD
BIGINT
Warning threshold. Null if

not applicable.
ALARM_THRESHOLD
BIGINT
Alarm threshold. Null if not

applicable.
SENSITIVITY
BIGINT
Health indicator sensitivity.
EVALUATE
SMALLINT
1 if this health indicator is

being evaluated or 0 if it is
not being evaluated.
ACTION_ENABLED
SMALLINT
1 if an action is enabled to
run upon an alert occurrence
or 0 if no action is enabled to
run upon an alert occurrence.
HEALTH_GET_IND_DEFINITION
Returns the health indicator definitions.
Syntax
HEALTH_GET_IND_DEFINITION (
locale

locale
An input argument of type VARCHAR(33) that indicates the locale in which
the translatable output is to be returned. If the input locale is not supported by
the database server, an SQL warning message is issued, and the default
language (English) is used. If the input locale is not provided, that is, its value
is NULL (or an empty string), the default language is used.
1193
Authorization
v DBADM authority
v SQLADM authority

Examples
Example 1: Retrieve the type and short description for health indicator
db.db_op_status in French.
SELECT TYPE, SHORT_DESCRIPTION
FROM TABLE(SYSPROC.HEALTH_GET_IND_DEFINITION(fr_FR))
AS IND_DEFINITION WHERE NAME = db.db_op_status

TYPE
SHORT_DESCRIPTION
---------------- ----------------------------------------...--------STATE
Etat oprationnel de la base de donnes
Example 2: Retrieve the short description for health indicator ID 1001 in English.
SELECT SHORT_DESCRIPTION FROM TABLE(SYSPROC.HEALTH_GET_IND_DEFINITION(en_US)
AS IND_DEFINITION WHERE ID = 1001

SHORT_DESCRIPTION
-----------------------------...------------Database Operational State
Example 3: Retrieve all health indicator IDs and names.

SELECT ID, NAME FROM TABLE(HEALTH_GET_IND_DEFINITION()) AS T

ID
-------------------1
2
4
1001
1002
...
2001
2002
...
3002
1015
...
1194
NAME
---------------------------db2.db2_op_status
db2.sort_privmem_util
db2.mon_heap_util
db.db_op_status
db.sort_shrmem_util
ts.ts_op_status
ts.ts_util
tsc.tscont_util
db.tb_reorg_req
Table 291. Information returned by the HEALTH_GET_IND_DEFINITION table function
Column name
Data type
Description
ID
BIGINT

element
NAME
VARCHAR(128)
Health indicator name.
SHORT_DESCRIPTION
VARCHAR(1024)
Health indicator short

description.
LONG_DESCRIPTION
VARCHAR(32672)
Health indicator long

description.
TYPE
VARCHAR(16)
Health indicator type.

Possible values are:
v 'THRESHOLD_UPPER':
upper-bounded
threshold-based health
indicators.
v 'THRESHOLD_LOWER':
lower-bounded
threshold-based health
indicators.
v 'STATE': state-based health
indicators.
v 'COLLECTION_STATE':
collection state-based
health indicators.
UNIT
VARCHAR(1024)
Unit of the health indicator

values and thresholds or
Null if not applicable.
CATEGORY
VARCHAR(1024)
Health indicator category.
FORMULA
VARCHAR(512)
Health indicator formula.
REFRESH_INTERVAL
BIGINT
Health indicator evaluation

interval in seconds.
HEALTH_HI_REC
Retrieves a set of recommendations that address a health indicator in alert state on
a particular DB2 object. Recommendations are returned in an XML document that
contains information about actions that can be taken (for example, scripts that can
be run) to resolve the alert state.
Important: This procedure has been deprecated and might be removed in a future
release because the health monitor was deprecated in Version 9.7.
Syntax
HEALTH_HI_REC ( schema-version
object-type , object-name
, indicator-id
, dbpartitionnum
, dbname
, client-locale

,
recommendation-doc )

1195

Any scripts that are returned by this procedure must be invoked from the instance
on which the health indicator entered the alert state.
If the specified health indicator on the identified object is not in an alert state, an
error is returned (SQLSTATE 5U0ZZ).
schema-version
An input argument of type INTEGER that specifies the version ID of the
schema used to represent the XML document. The recommendation document
will only contain elements and attributes that were defined for that schema
version. Valid schema versions are defined in db2ApiDf.h, located in the
include subdirectory of the sqllib directory.
indicator-id
An input argument of type INTEGER that specifies the numeric identifier of
the health indicator for which recommendations are being requested. Valid
health indicator IDs are defined in sqlmon.h, located in the include
subdirectory of the sqllib directory.
dbname
An input argument of type VARCHAR(255) that specifies an alias name for the
database against which the health indicator entered an alert state, and when
object type is either DB2HEALTH_OBJTYPE_TS_CONTAINER,
DB2HEALTH_OBJTYPE_TABLESPACE, or DB2HEALTH_OBJTYPE_DATABASE. Specify NULL
otherwise.
object-type
An input argument of type INTEGER that specifies the type of object on which
the health indicator entered an alert state. Valid object types are defined in
sqlmon.h, located in the include subdirectory of the sqllib directory.
object-name
An input argument of type VARCHAR(255) that specifies the name of a table
space or table space container when the object type is set to
DB2HEALTH_OBJTYPE_TABLESPACE or DB2HEALTH_OBJTYPE_TS_CONTAINER. Specify
NULL if the object type is DB2HEALTH_OBJTYPE_DATABASE or
DB2HEALTH_OBJTYPE_DATABASE_MANAGER. In the case of a table space container,
the object name is specified as table_space_name.container_name.
dbpartitionnum
An input argument of type INTEGER that specifies the number of the database
partition on which the health indicator entered an alert state. Valid values are 0
to 999, -1 (which specifies the currently connected database partition), and -2
(which specifies all active database partitions). An active database partition is a
partition where the database is available for connection and use by
applications.
client-locale
identifier. Use this parameter to specify the language in which
recommendations are to be returned. If no value is specified, 'En_US' (English)
will be used. Note that if the message files for the specified locale are not
available on the server, 'En_US' will be used as the default.
recommendation-doc
An output argument of type BLOB(2M) that contains the recommendation
1196
document (XML), formatted according to the DB2 Health Recommendation

schema definition (see the XML schema DB2RecommendationSchema.xsd, located
in the misc subdirectory of the sqllib directory). The XML document is
encoded in UTF-8, and text in the document is in the locale of the caller, or
English, if messages are not available in the caller's locale at the target instance.
Authorization
v DBADM authority
v SQLADM authority

HEALTH_TBS_HI
Returns health indicator information for table spaces from a health snapshot of
table spaces in a database.
Syntax
HEALTH_TBS_HI (
dbname
, member

dbname
database.
member
1197
Authorization
v DBADM authority
v SQLADM authority

Example
SELECT * FROM TABLE(HEALTH_TBS_HI(,-1)) AS T

SNAPSHOT_TIMESTAMP
-------------------------2006-02-13-12.30.35.229196
2006-02-13-12.30.35.229196
2006-02-13-12.30.35.229196
2006-02-13-12.30.35.229196
2006-02-13-12.30.35.229196
2006-02-13-12.30.35.229196
2006-02-13-12.30.35.229196
2006-02-13-12.30.35.229196
2006-02-13-12.30.35.229196
2006-02-13-12.30.35.229196
2006-02-13-12.30.35.229196
TABLESPACE_NAME
HI_ID
HI_VALUE ...
---------------...- -----...- -------- ...
SYSCATSPACE
2001
0 ...
SYSCATSPACE
2002
99 ...
SYSCATSPACE
2003
0 ...
SYSTOOLSPACE
2001
0 ...
SYSTOOLSPACE
2002
62 ...
SYSTOOLSPACE
2003
0 ...
SYSTOOLSTMPSPACE
2001
0 ...
TEMPSPACE1
2001
0 ...
USERSPACE1
2001
0 ...
USERSPACE1
2002
100 ...
USERSPACE1
2003
0 ...

...
...
...
...
...
...
...
...
...
...
...
...
...
HI_TIMESTAMP
-------------------------- --------------- --------------------- ...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
4 Alarm
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
1 Normal
...
2006-02-13-12.26.26.158000
4 Alarm
...
2006-02-13-12.26.26.158000
1 Normal
...

...
...
...
...
1198
HI_FORMULA
---------------------...0
((9376 / 9468) * 100)
HI_ADDITIONAL_INFO
-----------------------------------------------The short term table space growth rate
from "02/13/2006 11:26:26.000158" to
"02/13/2006 12:26:26.000158" is "N/A"
bytes per second and the long term growth
rate from "02/12/2006 12:26:26.000158"
to "02/13/2006 12:26:26.000158" is "N/A"
bytes per second. Time to fullness is
projected to be "N/A" and "N/A".
... 0
... 0
... ((156 / 252) * 100)
... 0
...
...
...
...
0
0
0
((1504 / 1504) * 100)
... 0
The table space is defined

with automatic storage set to "YES" and
automatic resize enabled set to "YES".
The table space is defined with automatic
storage set to "YES" and automatic resize
enabled set to "YES". The following are
the automatic resize settings: increase
size (bytes) "-1", increase size (percent)
"N/A", maximum size (bytes) "-1". The
current table space size (bytes) is
"38797312".
The short term table space growth rate
from "02/13/2006 11:26:26.000158" to
"02/13/2006 12:26:26.000158" is "N/A"
rate from "02/12/2006 12:26:26.000158"
to "02/13/2006 12:26:26.000158" is "N/A"
"1048576".
The short term table space growth rate from
"02/13/2006 11:26:26.000158" to
"02/13/2006 12:26:26.000158" is "N/A"
rate from "02/12/2006 12:26:26.000158" to
"02/13/2006 12:26:26.000158" is "N/A" bytes
per second. Time to fullness is projected
to be "N/A" and "N/A". The
table space is defined with automatic storage
set to "YES" and automatic resize enabled
set to "YES".
"6291456".
Table 292. Information returned by the HEALTH_TBS_HI table function
Description or
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
TABLESPACE_NAME
VARCHAR(128)
space name
1199
Table 292. Information returned by the HEALTH_TBS_HI table function (continued)

Description or
element
Column name
Data type
HI_ID
BIGINT

HI_VALUE
SMALLINT

indicator.
HI_TIMESTAMP
TIMESTAMP

HI_ALERT_STATE
BIGINT
VARCHAR(20)

HI_FORMULA
VARCHAR(2048)
The formula used to

HI_ADDITIONAL_INFO
VARCHAR(4096)

HEALTH_TBS_HI_HIS
The HEALTH_TBS_HI_HIS table function returns health indicator history
information for table spaces from a health snapshot of a database.
Syntax
HEALTH_TBS_HI_HIS (
dbname
, member

dbname
database.
member
1200
Authorization
v DBADM authority
v SQLADM authority

Example
SELECT * FROM TABLE(HEALTH_TBS_HI_HIS(,-1)) AS T

SNAPSHOT_TIMESTAMP
-------------------------2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
2006-02-13-12.30.37.181478
TABLESPACE_NAME
HI_ID
...
---------------...- -----...- ...
SYSCATSPACE
2001 ...
SYSCATSPACE
2001 ...
SYSCATSPACE
2002 ...
SYSCATSPACE
2002 ...
SYSCATSPACE
2003 ...
SYSCATSPACE
2003 ...
SYSTOOLSPACE
2001 ...
SYSTOOLSPACE
2001 ...
SYSTOOLSPACE
2002 ...
SYSTOOLSPACE
2002 ...
SYSTOOLSPACE
2003 ...
SYSTOOLSPACE
2003 ...
SYSTOOLSTMPSPACE
2001 ...
SYSTOOLSTMPSPACE
2001 ...
TEMPSPACE1
2001 ...
TEMPSPACE1
2001 ...
USERSPACE1
2001 ...
USERSPACE1
2001 ...
USERSPACE1
2002 ...
USERSPACE1
2002 ...
USERSPACE1
2003 ...
USERSPACE1
2003 ...

...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
HI_TIMESTAMP
HI_VALUE HI_ALERT_STATE HI_ALERT_STATE_DETAIL
-------------------------- -------- -------------- --------------------2006-02-13-12.16.25.911000
0
1 Normal
2006-02-13-12.06.26.168000
0
1 Normal
2006-02-13-12.16.25.911000
99
4 Alarm
2006-02-13-12.06.26.168000
99
4 Alarm
2006-02-13-12.16.25.911000
0
1 Normal
2006-02-13-12.06.26.168000
0
1 Normal
2006-02-13-12.16.25.911000
0
1 Normal
2006-02-13-12.06.26.168000
0
1 Normal
2006-02-13-12.16.25.911000
62
1 Normal
2006-02-13-12.06.26.168000
62
1 Normal
2006-02-13-12.16.25.911000
0
1 Normal
2006-02-13-12.06.26.168000
0
1 Normal
2006-02-13-12.16.25.911000
0
1 Normal
2006-02-13-12.06.26.168000
0
1 Normal
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
1201
...
...
...
...
...
...
...
...
2006-02-13-12.16.25.911000
2006-02-13-12.06.26.168000
2006-02-13-12.16.25.911000
2006-02-13-12.06.26.168000
2006-02-13-12.16.25.911000
2006-02-13-12.06.26.168000
2006-02-13-12.16.25.911000
2006-02-13-12.06.26.168000
0
0
0
0
100
100
0
0
1
1
1
1
4
4
1
1
Normal
Normal
Normal
Normal
Alarm
Alarm
Normal
Normal

...
...
...
...
...
HI_FORMULA
--------------------...0
0
((9376 / 9468) * 100)
... ((9376 / 9468) * 100)
... 0
... 0
... 0
... 0
... ((156 / 252) * 100)
... ((156 / 252) * 100)
1202
HI_ADDITIONAL_INFO
-------------------...--The short term table space growth rate from
"02/13/2006 11:16:25.000911" to
"02/13/2006 12:16:25.000911" is "N/A" bytes
per second and the long term growth rate
from "02/12/2006 12:16:25.000911" to
"02/13/2006 12:16:25.000911" is "N/A" bytes
table space is defined with automatic
enabled set to "YES".
"02/13/2006 11:06:26.000168" to
"02/13/2006 12:06:26.000168" is "N/A" bytes
per second and the long term growth rate
from "02/12/2006 12:06:26.000168" to
"02/13/2006 12:06:26.000168" is "N/A" bytes
"38797312".
"38797312".
"02/13/2006 11:16:25.000911" to
"02/13/2006 12:16:25.000911" is "N/A"
rate from "02/12/2006 12:16:25.000911" to
"02/13/2006 12:16:25.000911" is "N/A" bytes
...
...
...
...
...
...
...
...
... 0
... 0
...
...
...
...
...
...
...
0
0
0
0
0
0
((1504 / 1504) * 100)
... ((1504 / 1504) * 100)
... 0
... 0
"02/13/2006 11:06:26.000168" to
"02/13/2006 12:06:26.000168" is "N/A"
rate from "02/12/2006 12:06:26.000168" to
"02/13/2006 12:06:26.000168" is "N/A" bytes
"1048576".
"1048576".
from "02/13/2006 11:16:25.000911" to
"02/13/2006 12:16:25.000911" is "N/A"
rate from "02/12/2006 12:16:25.000911"
to "02/13/2006 12:16:25.000911" is "N/A"
from "02/13/2006 11:06:26.000168" to
"02/13/2006 12:06:26.000168" is "N/A"
rate from "02/12/2006 12:06:26.000168"
to "02/13/2006 12:06:26.000168" is "N/A"
storage set to "YES" and automatic
resize enabled set to "YES". The
following are the automatic resize
settings: increase size (bytes) "-1",
increase size (percent) "N/A", maximum
size (bytes) "-1". The current table
space size (bytes) is "6291456".
storage set to "YES" and automatic
resize enabled set to "YES". The
following are the automatic resize
settings: increase size (bytes) "-1",
1203
increase size (percent) "N/A", maximum

size (bytes) "-1". The current table
space size (bytes) is "6291456".
Table 293. Information returned by the HEALTH_TBS_HI_HIS table function
Description or
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
TABLESPACE_NAME
VARCHAR(128)
space name
HI_ID
BIGINT

HI_TIMESTAMP
TIMESTAMP

HI_VALUE
SMALLINT

indicator.
HI_ALERT_STATE
BIGINT
VARCHAR(20)

HI_FORMULA
VARCHAR(2048)
The formula used to

HI_ADDITIONAL_INFO
VARCHAR(4096)

HEALTH_TBS_INFO
Returns table space information from a health snapshot of a database.
Syntax
HEALTH_TBS_INFO (
dbname
member

dbname
database.
1204
member
Authorization
v DBADM authority
v SQLADM authority

Example
SELECT * FROM TABLE(HEALTH_TBS_INFO(,-1)) AS T

SNAPSHOT_TIMESTAMP
-------------------------2006-02-13-12.30.35.027383
2006-02-13-12.30.35.027383
2006-02-13-12.30.35.027383
2006-02-13-12.30.35.027383
2006-02-13-12.30.35.027383
TABLESPACE_NAME
----------------...SYSCATSPACE
SYSTOOLSPACE
SYSTOOLSTMPSPACE
TEMPSPACE1
USERSPACE1
...
...
...
...
...
...
...

... --------------------- ---------------------------...
4 Alarm
...
1 Normal
...
1 Normal
...
1 Normal
...
4 Alarm
Table 294. Information returned by the HEALTH_TBS_INFO table function
Description or
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
TABLESPACE_NAME
VARCHAR(128)
space name

1205
Table 294. Information returned by the HEALTH_TBS_INFO table function (continued)
Column name
Data type
ROLLED_UP_ALERT_
STATE_DETAIL
VARCHAR(20)
Description or
element
column.
LOCKS_HELD administrative view - Retrieve information

about locks held
The LOCKS_HELD administrative view returns information about the current
locks held.
Note: This administrative view has been deprecated and replaced by the
application is waiting on page 512, MON_GET_LOCKS - List all locks in the
currently connected database on page 620, and MON_FORMAT_LOCK_NAME Format the internal lock name and return details on page 445.
Authorization
v SELECT privilege on the LOCKS_HELD administrative view
v CONTROL privilege on the LOCKS_HELD administrative view
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Example 1: List the total number of locks held by each table in the database
SAMPLE.
SELECT TABSCHEMA, TABNAME, COUNT(*) AS NUMBER_OF_LOCKS_HELD
FROM SYSIBMADM.LOCKS_HELD WHERE DB_NAME = SAMPLE
GROUP BY DBPARTITIONNUM, TABSCHEMA, TABNAME
1206
TABSCHEMA
----------...JESSICAE
JESSICAE
JESSICAE
TABNAME
NUMBER_OF_LOCKS_HELD
---------...- -------------------EMPLOYEE
5
EMP_RESUME
1
ORG
3
Example 2: List all the locks that have not escalated in the currently connected
database, SAMPLE.
SELECT AGENT_ID, TABSCHEMA, TABNAME, LOCK_OBJECT_TYPE, LOCK_MODE,
LOCK_STATUS FROM SYSIBMADM.LOCKS_HELD WHERE LOCK_ESCALATION = 0
AND DBPARTITIONNUM = 0

AGENT_ID
--------...680
680
TABSCHEMA
---------...JESSICAE
JESSICAE
TABNAME
--------...EMPLOYEE
EMPLOYEE
LOCK_OBJECT_TYPE
-----------------INTERNALV_LOCK
INTERNALP_LOCK
LOCK_MODE
---------S
S
LOCK_STATUS
----------GRNT
GRNT
Example 3: List lock information for the locks that are currently held by the
application with agent ID 310.
SELECT TABSCHEMA, TABNAME, LOCK_OBJECT_TYPE, LOCK_MODE, LOCK_STATUS,
LOCK_ESCALATION FROM SYSIBMADM.LOCKS_HELD WHERE AGENT_ID = 310

TABSCHEMA
---------...JESSICAE
JESSICAE
TABNAME
--------...EMP_RESUME
EMPLOYEE
LOCK_OBJECT_TYPE
-----------------TABLE_LOCK
ROW_LOCK
LOCK_MODE
---------S
S
LOCK_STATUS
----------GRNT
GRNT
Table 295. Information returned by the LOCKS_HELD administrative view
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
Date and time the report was

generated.
DB_NAME
VARCHAR(128)
AGENT_ID
BIGINT

(agent ID)
APPL_NAME
VARCHAR(256)
AUTHID
VARCHAR(128)
TBSP_NAME
VARCHAR(128)

name
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
TAB_FILE_ID
BIGINT
table_file_id - Table file

identification
1207
Table 295. Information returned by the LOCKS_HELD administrative view (continued)

Column name
Data type
LOCK_OBJECT_TYPE
VARCHAR(18)
monitor element
v AUTORESIZE_LOCK
v AUTOSTORAGE_LOCK
v BLOCK_LOCK
v EOT_LOCK
v INTERNAL_LOCK
v INTERNALB_LOCK
v INTERNALC_LOCK
v INTERNALJ_LOCK
v INTERNALL_LOCK
v INTERNALO_LOCK
v INTERNALQ_LOCK
v INTERNALP_LOCK
v INTERNALS_LOCK
v INTERNALT_LOCK
v INTERNALV_LOCK
v KEYVALUE_LOCK
v ROW_LOCK
v SYSBOOT_LOCK
v TABLE_LOCK
v TABLE_PART_LOCK
v TABLESPACE_LOCK
v XML_PATH_LOCK
LOCK_NAME
VARCHAR(32)
LOCK_MODE
VARCHAR(10)

and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
1208
Table 295. Information returned by the LOCKS_HELD administrative view (continued)

Column name
Data type
LOCK_STATUS
VARCHAR(10)
monitor element
and is one of:
v CONV
v GRNT
LOCK_ESCALATION
SMALLINT
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
LOCKWAITS administrative view - Retrieve current lockwaits

information
The LOCKWAITS administrative view returns information about DB2 agents
working on behalf of applications that are waiting to obtain locks.
MON_LOCKWAITS administrative view - Retrieve metrics for applications that
are waiting to obtain locks on page 840.
Authorization
v SELECT privilege on the LOCKWAITS administrative view
v CONTROL privilege on the LOCKWAITS administrative view
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Examples
Example 1: List information for all the lock waits for application with agent ID 89.
SELECT SUBSTR(TABSCHEMA,1,8) AS TABSCHEMA, SUBSTR(TABNAME,1,15) AS TABNAME,
LOCK_OBJECT_TYPE, LOCK_MODE, LOCK_MODE_REQUESTED, AGENT_ID_HOLDING_LK
FROM SYSIBMADM.LOCKWAITS WHERE AGENT_ID = 89
1209

TABSCHEMA TABNAME
LOCK_OBJECT_TYPE LOCK_MODE ...
--------- -------...- ---------------- ---------- ...
JESSICAE T1
ROW_LOCK
X
...

... LOCK_MODE_REQUESTED AGENT_ID_HOLDING_LK
... ------------------- -------------------... NS
7
Example 2: List the total number of outstanding lock requests per table in the
database SAMPLE. By sorting the output by number of requests, tables with the
highest contention can be identified.
SELECT SUBSTR(TABSCHEMA,1,8) AS TABSCHEMA, SUBSTR(TABNAME, 1, 15)
AS TABNAME, COUNT(*) AS NUM_OF_LOCK_REQUESTS_WAITING,
DBPARTITIONNUM
FROM SYSIBMADM.LOCKWAITS WHERE DB_NAME = SAMPLE
GROUP BY TABSCHEMA, TABNAME, DBPARTITIONNUM
ORDER BY NUM_OF_LOCK_REQUESTS_WAITING DESC

TABSCHEMA
--------JESSICAE
JESSICAE
JESSICAE
TABNAME
NUM_OF_LOCK_REQUESTS_WAITING DBPARTITIONNUM
-------...- ---------------------------- -------------T3
2
0
T1
1
0
T2
1
0
Table 296. Information returned by the LOCKWAITS administrative view
1210
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
Date and time the report was

generated.
DB_NAME
VARCHAR(128)
AGENT_ID
BIGINT

(agent ID)
APPL_NAME
VARCHAR(256)
AUTHID
VARCHAR(128)
TBSP_NAME
VARCHAR(128)

name
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
SUBSECTION_NUMBER
BIGINT
Table 296. Information returned by the LOCKWAITS administrative view (continued)

Column name
Data type
LOCK_OBJECT_TYPE
VARCHAR(18)
monitor element
v AUTORESIZE_LOCK
v AUTOSTORAGE_LOCK
v BLOCK_LOCK
v EOT_LOCK
v INTERNAL_LOCK
v INTERNALB_LOCK
v INTERNALC_LOCK
v INTERNALJ_LOCK
v INTERNALL_LOCK
v INTERNALO_LOCK
v INTERNALQ_LOCK
v INTERNALP_LOCK
v INTERNALS_LOCK
v INTERNALT_LOCK
v INTERNALV_LOCK
v KEYVALUE_LOCK
v ROW_LOCK
v SYSBOOT_LOCK
v TABLE_LOCK
v TABLE_PART_LOCK
v TABLESPACE_LOCK
v XML_PATH_LOCK
TIMESTAMP

start timestamp
LOCK_NAME
VARCHAR(32)
LOCK_MODE
VARCHAR(10)

and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
1211
Table 296. Information returned by the LOCKWAITS administrative view (continued)

Column name
Data type
LOCK_MODE_REQUESTED
VARCHAR(10)
monitor element
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
AGENT_ID_HOLDING_LK
BIGINT
holding lock
APPL_ID_HOLDING_LK
VARCHAR(128)
ID holding lock
LOCK_ESCALATION
SMALLINT
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
LOG_UTILIZATION administrative view - Retrieve log

utilization information
The LOG_UTILIZATION administrative view returns information about log
utilization for the currently connected database. A single row is returned for each
database partition.
Important: The LOG_UTILIZATION administrative view is deprecated and has
been replaced by the MON_TRANSACTION_LOG_UTILIZATION administrative
view - Retrieve log utilization information on page 853.
Authorization
v SELECT privilege on the LOG_UTILIZATION administrative view
v CONTROL privilege on the LOG_UTILIZATION administrative view
v DBADM authority
v SQLADM authority
1212

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
List the log utilization for the currently connected database, SAMPLE.
SELECT * FROM SYSIBMADM.LOG_UTILIZATION

DB_NAME ... LOG_UTILIZATION_PERCENT TOTAL_LOG_USED_KB
...
-------- ... ----------------------- -------------------- ...
SAMPLE
...
9.75
1989 ...
...
...

... TOTAL_LOG_AVAILABLE_KB TOTAL_LOG_USED_TOP_KB DBPARTITIONNUM
... ---------------------- --------------------- -------------...
18411
1990
0
...
...
Usage note
For databases that are configured for infinite logging, the
LOG_UTILIZATION_PERCENT and TOTAL_LOG_AVAILABLE_KB will be NULL.
Table 297. Information returned by the LOG_UTILIZATION administrative view
Column name
Data type
monitor element
DB_NAME
VARCHAR(128)
LOG_UTILIZATION_PERCENT
DECIMAL(5,2)
Percent utilization of total log

space.
TOTAL_LOG_USED_KB
BIGINT
total_log_used - Total log space

used. This interface returns the
value in KB.
TOTAL_LOG_AVAILABLE_KB
BIGINT
total_log_available - Total log

available. This interface returns the
value in KB.
TOTAL_LOG_USED_TOP_KB
BIGINT
tot_log_used_top - Maximum total

log space used. This interface
returns the value in KB.
1213
Table 297. Information returned by the LOG_UTILIZATION administrative view (continued)

monitor element
Column name
Data type
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
LONG_RUNNING_SQL administrative view

The LONG_RUNNING_SQL administrative view returns SQL statements executed
in the currently connected database. This view can be used to identify
long-running SQL statements in the database.
Important: The LONG_RUNNING_SQL administrative view is deprecated and has
been replaced by the MON_CURRENT_SQL - Retrieve key metrics for all
activities on all members on page 834.
Authorization
v SELECT privilege on the LONG_RUNNING_SQL administrative view
v
v
v
v
CONTROL privilege on the LONG_RUNNING_SQL administrative view

DBADM authority
SQLADM authority

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a report on long running SQL statements in the currently connected
database.
SELECT SUBSTR(STMT_TEXT, 1, 50) AS STMT_TEXT, AGENT_ID,
ELAPSED_TIME_MIN, APPL_STATUS, DBPARTITIONNUM
FROM SYSIBMADM.LONG_RUNNING_SQL ORDER BY DBPARTITIONNUM

STMT_TEXT
AGENT_ID
...
-----------------------------...- --------...- ...
228 ...
1214

228 ...
228 ...
...
...

... ELAPSED_TIME_MIN APPL_STATUS
DBPARTITIONNUM
... ---------------- -----------...- -------------...
2 UOWWAIT
0
...
0 CONNECTED
1
...
0 CONNECTED
2
Usage note
This view can be used to identify long-running SQL statements in the database.
You can look at the currently running queries to see which statements are the
longest running and the current status of the query. Further investigation can be
done of the application containing the SQL statement, using agent ID as the unique
identifier. If executing a long time and waiting on a lock, you might want to dig
deeper using the LOCKWAITS or LOCKS_HELD administrative views. If "waiting
on User", this means that the DB2 server is not doing anything but rather is
waiting for the application to do something (like issue the next fetch or submit the
next SQL statement).
Table 298. Information returned by the LONG_RUNNING_SQL administrative view
Column name
Data type
monitor element
SNAPSHOT_TIMESTAMP
TIMESTAMP
Time the report was generated.
ELAPSED_TIME_MIN
INTEGER
Elapsed time of the statement in

minutes.
AGENT_ID
BIGINT

(agent ID)
APPL_NAME
VARCHAR(256)
1215
Table 298. Information returned by the LONG_RUNNING_SQL administrative

view (continued)
Column name
Data type
APPL_STATUS
VARCHAR(22)
monitor element
v BACKUP
v COMMIT_ACT
v COMP
v CONNECTED
v CONNECTPEND
v CREATE_DB
v DECOUPLED
v DISCONNECTPEND
v INTR
v IOERROR_WAIT
v LOAD
v LOCKWAIT
v RECOMP
v REMOTE_RQST
v RESTART
v RESTORE
v ROLLBACK_ACT
v TEND
v THABRT
v THCOMT
v TPREP
v UNLOAD
v UOWEXEC
v UOWWAI
v WAITFOR_REMOTE
AUTHID
VARCHAR(128)
INBOUND_COMM_ADDRESS
VARCHAR(32)
inbound_comm_address - Inbound
communication address
STMT_TEXT
CLOB(16 M)
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
REG_VARIABLES administrative view - Retrieve DB2 registry

settings in use
The REG_VARIABLES administrative view returns the DB2 registry settings from
all database partitions.
1216
The DB2 registry variable values returned when the REG_VARIABLES

administrative view is queried can differ from those returned by the db2set
command if a DB2 registry variable is configured using the db2set command after
the instance has been started. The difference occurs because REG_VARIABLES only
returns the values that were in effect when the instance was started.
ENV_GET_REG_VARIABLES table function.
Authorization
v SELECT privilege on the REG_VARIABLES administrative view
v CONTROL privilege on the REG_VARIABLES administrative view

Example
Request the DB2 registry settings that are currently being used.
SELECT * from SYSIBMADM.REG_VARIABLES

DBPARTITIONNUM
-------------0
0
0
0
0
0
REG_VAR_NAME
---------------...DB2ADMINSERVER
DB2INSTPROF
DB2PATH
DB2SYSTEM
DB2TEMPDIR
DB2_EXTSECURITY
REG_VAR_VALUE
IS_AGGREGATE AGGREGATE_NAME
-------------...- ------------ --------------...DB2DAS00
0 D:\SQLLIB
0 D:\SQLLIB
0 D570
0 D:\SQLLIB\
0 YES
0 -
Table 299. Information returned by the REG_VARIABLES administrative view
Column name
Data type
Description
DBPARTITIONNUM
SMALLINT
element
REG_VAR_NAME
VARCHAR(256)
Name of the DB2 registry

variable.
REG_VAR_VALUE
VARCHAR(2048)

registry variable.
1217
Table 299. Information returned by the REG_VARIABLES administrative view (continued)

Column name
Data type
Description
IS_AGGREGATE
SMALLINT
Indicates whether or not the

DB2 registry variable is an
aggregate variable. The
possible return values are 0
if it is not an aggregate
variable, and 1 if it is an
aggregate variable.
AGGREGATE_NAME
VARCHAR(256)
Name of the aggregate if the

DB2 registry variable is
aggregate, or is set through
an aggregate but has been
AGGREGATE_NAME is
NULL.
LEVEL
CHAR(1)

acquires its value. The
possible return values and
the corresponding levels that
they represent are:
v I = instance
v G = global
v N = database partition
v E = environment
REG_LIST_VARIABLES table function - return registry settings

Note: The REG_LIST_VARIABLES table function has been deprecated and replaced
by the ENV_GET_REG_VARIABLES table function.
The REG_LIST_VARIABLES table function returns the DB2 registry settings that
are currently being used by the database partition from which the function was
invoked.
Syntax
REG_LIST_VARIABLES (
Authorization
EXECUTE privilege on the REG_LIST_VARIABLES table function.
1218
Table 300. Information returned by the REG_LIST_VARIABLES table function
Column name
Data type
Description
DBPARTITIONNUM
SMALLINT
The logical partition number

of each database partition on
which this function runs.
REG_VAR_NAME
VARCHAR(256)
The name of the DB2 registry

variable.
REG_VAR_VALUE
VARCHAR(2048)
The current setting of the

DB2 registry variable.
IS_AGGREGATE
SMALLINT
Indicates if the DB2 registry

variable is an aggregate
variable. Possible return
values are:
v 0 - Not aggregate
v 1 - Aggregate
AGGREGATE_NAME
VARCHAR(256)
The name of the aggregate if

the DB2 registry variable is
aggregate or if it is being set
by an aggregate that is
AGGREGATE_NAME is
NULL.
LEVEL
CHAR(1)

acquires its value. Possible
return value are:
v I - Instance
v G - Global
v N - Database partition
v E - Environment
Usage notes
The output from the db2set command and REG_LIST_VARIABLES might not be
identical if a DB2 registry variable is configured using the db2set command after
the instance is started because REG_LIST_VARIABLES only returns the values that
are used when the instance starts.
Example
Request the DB2 registry settings that are currently being used by the current
database partition. To format the output into a manageable table, you can use the
SUBSTR scalar function to remove trailing blanks from variable length character
string column values.
SELECT DBPARTITIONNUM,
SUBSTR(REG_VAR_NAME, 1, 15) AS REG_VAR_NAME,
SUBSTR(REG_VAR_VALUE, 1, 13) AS REG_VAR_VALUE,
IS_AGGREGATE,
1219
SUBSTR(AGGREGATE_NAME, 1, 14) AS AGGREGATE_NAME,

LEVEL
FROM TABLE(SYSPROC.REG_LIST_VARIABLES()) AS REGISTRYINFO

DBPARTITIONNUM
-------------0
0
0
0
0
0
REG_VAR_NAME
--------------DB2ADMINSERVER
DB2INSTPROF
DB2PATH
DB2SYSTEM
DB2TEMPDIR
DB2_EXTSECURITY
REG_VAR_VALUE IS_AGGREGATE AGGREGATE_NAME LEVEL

------------- ------------ -------------- ----DB2DAS00
0
I
D:\SQLLIB
0
I
D:\SQLLIB
0
I
D570
0
I
D:\SQLLIB\
0
I
YES
0
I
SNAPAGENT administrative view and SNAP_GET_AGENT

table function - Retrieve agent logical data group application
The SNAPAGENT administrative view and the SNAP_GET_AGENT table function
return information about agents from an application snapshot, in particular, the
agent logical data group.
Important: The SNAPAGENT administrative view and the SNAP_GET_AGENT
table function are deprecated and have been replaced by the MON_GET_AGENT
table function - List agents running in a service class on page 505 and
v SNAPAGENT administrative view
v SNAP_GET_AGENT table function on page 1221
SNAPAGENT administrative view

This administrative view allows you to retrieve agent logical data group
application snapshot information for the currently connected database.
Used with the MON_GET_CONNECTION, MON_GET_MEMORY_POOL, and
MON_GET_MEMORY_SET table functions and the MON_CURRENT_SQL and
SNAPSUBSECTION administrative views, the SNAPAGENT administrative view
provides information equivalent to the GET SNAPSHOT FOR APPLICATIONS ON
database-alias CLP command, but retrieves data from all database members.
returned.
Authorization
v SELECT privilege on the SNAPAGENT administrative view
v CONTROL privilege on the SNAPAGENT administrative view
1220
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_AGENT table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve all application snapshot information for the currently connected database
from the agent logical data group.
SELECT * FROM SYSIBMADM.SNAPAGENT

SNAPSHOT_TIMESTAMP
-------------------------2005-07-19-11.03.26.740423
2005-07-19-11.03.26.740423
DB_NAME
AGENT_ID
-------...- ---------...--SAMPLE
101
SAMPLE
49
...
...
...
...
...
...

...
...
...
...
...
...
AGENT_PID
LOCK_TIMEOUT_VAL
DBPARTITIONNUM
-------------------- -------------------- -------------11980
-1
0
15940
-1
0
SNAP_GET_AGENT table function

The SNAP_GET_AGENT table function returns the same information as the
SNAPAGENT administrative view, but allows you to retrieve the information for a
specific database on a specific database member, aggregate of all database
Used with the SNAP_GET_AGENT_MEMORY_POOL, SNAP_GET_APPL,
SNAP_GET_APPL_INFO, SNAP_GET_STMT and SNAP_GET_SUBSECTION table
functions, the SNAP_GET_AGENT table function provides information equivalent
to the GET SNAPSHOT FOR ALL APPLICATIONS CLP command, but retrieves data from
all database members.
1221
returned.
Syntax
SNAP_GET_AGENT (
dbname
, member

dbname
member
SNAP_GET_AGENT table function takes a snapshot for the currently connected
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1222
Example
Retrieve all application snapshot information for all applications in all active
databases.
SELECT * FROM TABLE(SNAP_GET_AGENT(CAST(NULL AS VARCHAR(128)), -1)) AS T

SNAPSHOT_TIMESTAMP
-------------------------2006-01-03-17.21.38.530785
2006-01-03-17.21.38.530785
2006-01-03-17.21.38.530785
2006-01-03-17.21.38.530785
2006-01-03-17.21.38.530785
2006-01-03-17.21.38.530785
DB_NAME
AGENT_ID
-------...- --------...-SAMPLE
48
SAMPLE
47
SAMPLE
46
TESTDB
30
TESTDB
29
TESTDB
28
...
...
...
...
...
...
...
...

... AGENT_PID
LOCK_TIMEOUT_VAL
DBPARTITIONNUM
... ---------...---- -------------------- -------------...
7696
-1
0
...
8536
-1
0
...
6672
-1
0
...
2332
-1
0
...
8360
-1
0
...
6736
-1
0
...
Table 301. Information returned by the SNAPAGENT administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
AGENT_ID
BIGINT

(agent ID)
AGENT_PID
BIGINT
agent_pid - Engine dispatchable

unit (EDU)
LOCK_TIMEOUT_VAL
BIGINT
lock_timeout_val - Lock timeout

(seconds)
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAPAGENT_MEMORY_POOL administrative view and

SNAP_GET_AGENT_MEMORY_POOL table function - Retrieve
memory_pool logical data group snapshot information
The SNAPAGENT_MEMORY_POOL administrative view and the
SNAP_GET_AGENT_MEMORY_POOL table function return information about
memory usage at the agent level.
1223
Important: The SNAPAGENT_MEMORY_POOL administrative view and

SNAP_GET_AGENT_MEMORY_POOL table function have been deprecated and
replaced by the MON_GET_MEMORY_POOL - get
memory pool information on page 625 and MON_GET_MEMORY_SET - get
memory set information on page 627.
v SNAPAGENT_MEMORY_POOL administrative view
v SNAP_GET_AGENT_MEMORY_POOL table function on page 1225
SNAPAGENT_MEMORY_POOL administrative view

This administrative view allows you to retrieve the memory_pool logical data
group snapshot information about memory usage at the agent level for the
Used with the MON_GET_AGENT and MON_GET_CONNECTION table functions
and the MON_CURRENT_SQL and SNAPSUBSECTION administrative views, the
SNAPAGENT_MEMORY_POOL administrative view provides information
equivalent to the GET SNAPSHOT FOR APPLICATIONS ON database-alias CLP
command.
returned.
Authorization
One of the following is required to use the view:
v SELECT privilege on the SNAPAGENT_MEMORY_POOL administrative view
v CONTROL privilege on the SNAPAGENT_MEMORY_POOL administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_AGENT_MEMORY_POOL table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM
1224

Example
Retrieve a list of memory pools and their current size.
SELECT AGENT_ID, POOL_ID, POOL_CUR_SIZE FROM SYSIBMADM.SNAPAGENT_MEMORY_POOL

AGENT_ID
--------...--48
48
48
47
47
47
46
46
46
POOL_ID POOL_ CUR_SIZE

-------------- ---------...-----APPLICATION
65536
OTHER
65536
APPL_CONTROL
65536
APPLICATION
65536
OTHER
131072
APPL_CONTROL
65536
OTHER
327680
APPLICATION
262144
APPL_CONTROL
65536
SNAP_GET_AGENT_MEMORY_POOL table function

The SNAP_GET_AGENT_MEMORY_POOL table function returns the same
information as the SNAPAGENT_MEMORY_POOL administrative view, but allows
you to retrieve the information for a specific database on a specific database
member, aggregate of all database members or all database members.
Used with the SNAP_GET_AGENT, SNAP_GET_APPL, SNAP_GET_APPL_INFO,
SNAP_GET_STMT and SNAP_GET_SUBSECTION table functions, the
SNAP_GET_AGENT_MEMORY_POOL table function provides information
equivalent to the GET SNAPSHOT FOR ALL APPLICATIONS CLP command.
returned.
Syntax
SNAP_GET_AGENT_MEMORY_POOL (
dbname
, member

dbname
1225
member
SNAP_GET_AGENT_MEMORY_POOL table function takes a snapshot for the
currently connected database and database member number.
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a list of memory pools and their current size for all databases.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, AGENT_ID, POOL_ID, POOL_CUR_SIZE
FROM TABLE(SNAP_GET_AGENT_MEMORY_POOL(CAST (NULL AS VARCHAR(128)), -1))
AS T

DB_NAME AGENT_ID
-------- --------...--SAMPLE
48
SAMPLE
48
SAMPLE
48
SAMPLE
47
SAMPLE
47
SAMPLE
47
SAMPLE
46
SAMPLE
46
SAMPLE
46
TESTDB
30
TESTDB
30
TESTDB
30
TESTDB
29
1226
POOL_ID
POOL_CUR_SIZE
-------------- -------------------APPLICATION
65536
OTHER
65536
APPL_CONTROL
65536
APPLICATION
65536
OTHER
131072
APPL_CONTROL
65536
OTHER
327680
APPLICATION
262144
APPL_CONTROL
65536
APPLICATION
65536
OTHER
65536
APPL_CONTROL
65536
APPLICATION
65536
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
29
29
28
28
28
OTHER
APPL_CONTROL
OTHER
APPLICATION
APPL_CONTROL
131072
65536
327680
65536
65536
Table 302. Information returned by the SNAPAGENT_MEMORY_POOL administrative view
and the SNAP_GET_AGENT_MEMORY_POOL table function
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
AGENT_ID
BIGINT

(agent ID)
AGENT_PID
BIGINT

unit (EDU)
POOL_ID
VARCHAR(14)
pool_id - Memory pool identifier.

v APP_GROUP
v APPL_CONTROL
v APPLICATION
v BP
v CAT_CACHE
v DATABASE
v DFM
v FCMBP
v IMPORT_POOL
v LOCK_MGR
v MONITOR
v OTHER
v PACKAGE_CACHE
v QUERY
v SHARED_SORT
v SORT
v STATEMENT
v STATISTICS
v UTILITY
POOL_CUR_SIZE
BIGINT
pool_cur_size - Current size of

memory pool
POOL_WATERMARK
BIGINT
pool_watermark - Memory pool

watermark
POOL_CONFIG_SIZE
BIGINT
pool_config_size - Configured size

of memory pool
1227

and the SNAP_GET_AGENT_MEMORY_POOL table function (continued)
monitor element
Column name
Data type
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

SNAP_GET_APPL_INFO table function - Retrieve appl_info
The SNAPAPPL_INFO administrative view and the SNAP_GET_APPL_INFO table
function return information about applications from an application snapshot, in
particular, the appl_info logical data group.
Important: The SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO table function are deprecated and have been replaced by
the MON_GET_CONNECTION table function - Get connection metrics on page
540.
v SNAPAPPL_INFO administrative view
v SNAP_GET_APPL_INFO table function on page 1229
SNAPAPPL_INFO administrative view

This administrative view allows you to retrieve appl_info logical data group
Used with the MON_GET_AGENT, MON_GET_CONNECTION,
MON_GET_MEMORY_POOL, and MON_GET_MEMORY_SET table functions and
the MON_CURRENT_SQL and SNAPSUBSECTION administrative views, the
SNAPAPPL_INFO administrative view provides information equivalent to the GET
SNAPSHOT FOR APPLICATIONS ON database-alias CLP command, but retrieves data
from all database members.
returned.
Authorization
v SELECT privilege on the SNAPAPPL_INFO administrative view
v
v
v
v
1228
CONTROL privilege on the SNAPAPPL_INFO administrative view

DBADM authority
SQLADM authority

v EXECUTE privilege on the SNAP_GET_APPL_INFO table function
v DBADM authority
v SQLADM authority
Also, one of the following authorities is required:
v SYSMON
v SYSMAINT
v SYSCTRL
v SYSADM

Example
Retrieve the status of the applications connected to the current database.
SELECT AGENT_ID, SUBSTR(APPL_NAME,1,10) AS APPL_NAME, APPL_STATUS
FROM SYSIBMADM.SNAPAPPL_INFO

AGENT_ID
-------------------101
49
APPL_NAME
---------db2bp.exe
db2bp.exe
APPL_STATUS
---------------------UOWEXEC
CONNECTED
SNAP_GET_APPL_INFO table function

The SNAP_GET_APPL_INFO table function returns the same information as the
SNAPAPPL_INFO administrative view, but allows you to retrieve the information
SNAP_GET_APPL, SNAP_GET_STMT and SNAP_GET_SUBSECTION table
functions, the SNAP_GET_APPL_INFO table function provides information
returned.
Syntax
SNAP_GET_APPL_INFO (
dbname
, member

1229

dbname
member
SNAP_GET_APPL_INFO table function takes a snapshot for the currently
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Examples
Retrieve the status of all applications on the connected database member.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, AGENT_ID,
SUBSTR(APPL_NAME,1,10) AS APPL_NAME, APPL_STATUS
FROM TABLE(SNAP_GET_APPL_INFO(CAST(NULL AS VARCHAR(128)),-1)) AS T

DB_NAME AGENT_ID
APPL_NAME APPL_STATUS
-------- -------------------- ---------- ---------------------TOOLSDB
14 db2bp.exe CONNECTED
1230
SAMPLE
SAMPLE
SAMPLE
15 db2bp.exe
8 javaw.exe
7 db2bp.exe
UOWEXEC
CONNECTED
UOWWAIT
The following shows what you obtain when you SELECT from the result of the
table function.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, AUTHORITY_LVL

DB_NAME AUTHORITY_LVL
-------- -----------------------------------------------------....
TESTDB
SYSADM(GROUP) + DBADM(USER) + CREATETAB(USER, GROUP) +
BINDADD(USER, GROUP) + CONNECT(USER, GROUP) +
CREATE_NOT_FENC(USER) + IMPLICIT_SCHEMA(USER, GROUP) +
LOAD(USER) + CREATE_EXT_RT(USER) + QUIESCE_CONN(USER)
TESTDB
TESTDB
Table 303. Information returned by the SNAPAPPL_INFO administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
AGENT_ID
BIGINT

(agent ID)
1231
SNAP_GET_APPL_INFO table function (continued)
Column name
Data type
APPL_STATUS
VARCHAR(22)
monitor element
v BACKUP
v COMMIT_ACT
v COMP
v CONNECTED
v CONNECTPEND
v CREATE_DB
v DECOUPLED
v DISCONNECTPEND
v INTR
v IOERROR_WAIT
v LOAD
v LOCKWAIT
v RECOMP
v REMOTE_RQST
v RESTART
v RESTORE
v ROLLBACK_ACT
v TEND
v THABRT
v THCOMT
v TPREP
v UNLOAD
v UOWEXEC
v UOWWAIT
v WAITFOR_REMOTE
1232
CODEPAGE_ID
BIGINT
codepage_id - ID of code page

used by application
NUM_ASSOC_AGENTS
BIGINT
associated agents
COORD_NODE_NUM
SMALLINT
COORD_NODE_NUM is
deprecated and is replaced by
MEMBER.
Column name
Data type
AUTHORITY_LVL
VARCHAR(512)
monitor element
authority_bitmap - User
authorization level.
identifier based on the database
authorities defined in sql.h and
their source, and has the following
format: authority(source, ...) +
authority(source, ...) + ... The
source of an authority can be
multiple: either from a USER, a
GROUP, or a USER and a GROUP.
Possible values for "authority":
v ACCESSCTRL
v BINDADD
v CONNECT
v CREATE_EXT_RT
v CREATE_NOT_FENC
v CREATETAB
v DATAACCESS
v DBADM
v EXPLAIN
v IMPLICIT_SCHEMA
v LOAD
v LIBADM
v QUIESCE_CONN
v SECADM
v SQLADM
v SYSADM
v SYSCTRL
v SYSMAINT
v SYSMON
v SYSQUIESCE
v WLMADM
Possible values for "source":
v USER - authority granted to the
user or to a role granted to the
user.
v GROUP - authority granted to a
group to which the user belongs
or to a role granted to the group
to which the user belongs.
CLIENT_PID
BIGINT
COORD_AGENT_PID
BIGINT
agent
1233
monitor element
Column name
Data type
STATUS_CHANGE_TIME
TIMESTAMP
status change time
CLIENT_PLATFORM
VARCHAR(12)

in sqlmon.h,
v AIX
v AIX64
v AS400_DRDA
v DOS
v DYNIX
v HP
v HP64
v HPIA
v HPIA64
v LINUX
v LINUX390
v LINUXIA64
v LINUXPPC
v LINUXPPC64
v LINUXX8664
v LINUXZ64
v MAC
v MVS_DRDA
v NT
v NT64
v OS2
v OS390
v SCO
v SGI
v SNI
v SUN
v SUN64
v UNKNOWN
v UNKNOWN_DRDA
v VM_DRDA
v VSE_DRDA
v WINDOWS
1234
Column name
Data type
CLIENT_PROTOCOL
VARCHAR(10)
monitor element
v CPIC
v LOCAL
v NPIPE
v TCPIP (for DB2 for Linux,
UNIX, and Windows)
v TCPIP4
v TCPIP6
TERRITORY_CODE
SMALLINT
territory_code - Database territory

code
APPL_NAME
VARCHAR(256)
APPL_ID
VARCHAR(128)
SEQUENCE_NO
VARCHAR(4)
PRIMARY_AUTH_ID
VARCHAR(128)
SESSION_AUTH_ID
VARCHAR(128)
authorization ID
CLIENT_NNAME
VARCHAR(128)

monitor element
CLIENT_PRDID
VARCHAR(128)
product/version ID
INPUT_DB_ALIAS
VARCHAR(128)
input_db_alias - Input database

alias
CLIENT_DB_ALIAS
VARCHAR(128)

used by application
DB_NAME
VARCHAR(128)
DB_PATH
VARCHAR(1024) db_path - Database path
EXECUTION_ID
VARCHAR(128)
execution_id - User login ID
CORR_TOKEN
VARCHAR(128)
corr_token - DRDA correlation

token
TPMON_CLIENT_USERID
VARCHAR(256)
client user ID
TPMON_CLIENT_WKSTN
VARCHAR(256)
TPMON_CLIENT_APP
VARCHAR(256)
TPMON_ACC_STR
VARCHAR(200)

accounting string
DBPARTITIONNUM
SMALLINT
WORKLOAD_ID
INTEGER
monitor element
1235
monitor element
Column name
Data type
IS_SYSTEM_APPL
SMALLINT
Application monitor element
MEMBER
SMALLINT

monitor element
COORD_MEMBER
SMALLINT
SMALLINT

partition number.
SNAP_GET_APPL_INFO_V95 table function - Retrieve

appl_info logical data group snapshot information
The SNAP_GET_APPL_INFO_V95 table function returns information about
applications from an application snapshot, in particular, the appl_info logical data
group.
Important: The SNAP_GET_APPL_INFO_V95 table function is deprecated and has
been replaced by the MON_GET_CONNECTION table function - Get connection
metrics on page 540.
returned.
Syntax
SNAP_GET_APPL_INFO_V95 (
dbname
, member

dbname
member
1236
SNAP_GET_APPL_INFO_V95 table function takes a snapshot for the currently
Authorization
v EXECUTE privilege on the SNAP_GET_APPL_INFO_V95 table function
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Examples
FROM TABLE(SNAP_GET_APPL_INFO_V95(CAST(NULL AS VARCHAR(128)),-1)) AS T

DB_NAME AGENT_ID
-------- -------------------TOOLSDB
14
SAMPLE
15
SAMPLE
8
SAMPLE
7
APPL_NAME
---------db2bp.exe
db2bp.exe
javaw.exe
db2bp.exe
APPL_STATUS
---------------------CONNECTED
UOWEXEC
CONNECTED
UOWWAIT
table function.
FROM TABLE(SNAP_GET_APPL_INFO_V95(CAST(NULL AS VARCHAR(128)),-1)) AS T

-------- -----------------------------------------------------....
TESTDB
TESTDB
1237
TESTDB

Table 304. Information returned by the SNAP_GET_APPL_INFO_V95 table function
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
AGENT_ID
BIGINT

(agent ID)
APPL_STATUS
VARCHAR(22)

v BACKUP
v COMMIT_ACT
v COMP
v CONNECTED
v CONNECTPEND
v CREATE_DB
v DECOUPLED
v DISCONNECTPEND
v INTR
v IOERROR_WAIT
v LOAD
v LOCKWAIT
v RECOMP
v REMOTE_RQST
v RESTART
v RESTORE
v ROLLBACK_ACT
v TEND
v THABRT
v THCOMT
v TPREP
v UNLOAD
v UOWEXEC
v UOWWAIT
v WAITFOR_REMOTE
CODEPAGE_ID
1238
BIGINT

used by application
Table 304. Information returned by the SNAP_GET_APPL_INFO_V95 table

monitor element
Column name
Data type
NUM_ASSOC_AGENTS
BIGINT
associated agents
COORD_NODE_NUM
SMALLINT
AUTHORITY_LVL
VARCHAR(512)
v ACCESSCTRL
v BINDADD
v CONNECT
v CREATE_EXT_RT
v CREATE_NOT_FENC
v CREATETAB
v DATAACCESS
v DBADM
v EXPLAIN
v IMPLICIT_SCHEMA
v LOAD
v LIBADM
v QUIESCE_CONN
v SECADM
v SQLADM
v SYSADM
v SYSCTRL
v SYSMAINT
v SYSMON
v SYSQUIESCE
v WLMADM
user.
CLIENT_PID
BIGINT
1239

monitor element
Column name
Data type
COORD_AGENT_PID
BIGINT
agent
STATUS_CHANGE_TIME
TIMESTAMP
status change time
CLIENT_PLATFORM
VARCHAR(12)

in sqlmon.h,
v AIX
v AIX64
v AS400_DRDA
v DOS
v DYNIX
v HP
v HP64
v HPIA
v HPIA64
v LINUX
v LINUX390
v LINUXIA64
v LINUXPPC
v LINUXPPC64
v LINUXX8664
v LINUXZ64
v MAC
v MVS_DRDA
v NT
v NT64
v OS2
v OS390
v SCO
v SGI
v SNI
v SUN
v SUN64
v UNKNOWN
v UNKNOWN_DRDA
v VM_DRDA
v VSE_DRDA
v WINDOWS
1240

Column name
Data type
CLIENT_PROTOCOL
VARCHAR(10)
monitor element
v CPIC
v LOCAL
v NPIPE
v TCPIP (for DB2 for Linux, UNIX,
and Windows)
v TCPIP4
v TCPIP6
TERRITORY_CODE
SMALLINT

code
APPL_NAME
VARCHAR(256)
APPL_ID
VARCHAR(128)
SEQUENCE_NO
VARCHAR(4)
PRIMARY_AUTH_ID
VARCHAR(128)
SESSION_AUTH_ID
VARCHAR(128)
authorization ID
CLIENT_NNAME
VARCHAR(128)

monitor element
CLIENT_PRDID
VARCHAR(128)
product/version ID
INPUT_DB_ALIAS
VARCHAR(128)

alias
CLIENT_DB_ALIAS
VARCHAR(128)

used by application
DB_NAME
VARCHAR(128)
DB_PATH
EXECUTION_ID
VARCHAR(128)
CORR_TOKEN
VARCHAR(128)

token
TPMON_CLIENT_USERID
VARCHAR(256)
client user ID
TPMON_CLIENT_WKSTN
VARCHAR(256)
TPMON_CLIENT_APP
VARCHAR(256)
TPMON_ACC_STR
VARCHAR(200)

accounting string
DBPARTITIONNUM
SMALLINT
WORKLOAD_ID
INTEGER
monitor element
1241

Column name
Data type
IS_SYSTEM_APPL
SMALLINT
monitor element
SNAPAPPL administrative view and SNAP_GET_APPL table

function - Retrieve appl logical data group snapshot
information
The SNAPAPPL administrative view and the SNAP_GET_APPL table function
return information about applications from an application snapshot, in particular,
the appl logical data group.
v SNAPAPPL administrative view
v SNAP_GET_APPL table function on page 1243
SNAPAPPL administrative view

This administrative view allows you to retrieve appl logical data group snapshot
SNAPAPPL administrative view provides information equivalent to the GET
returned.
Authorization
v SELECT privilege on the SNAPAPPL administrative view
v CONTROL privilege on the SNAPAPPL administrative view
v DBADM authority
v SQLADM authority
One of the following privileges or authorities is required to use the table function:
v EXECUTE privilege on the SNAP_GET_APPL table function
1242
v DBADM authority
v SQLADM authority
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve details on rows read and written for each application in the connected
database.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, AGENT_ID, ROWS_READ, ROWS_WRITTEN
FROM SYSIBMADM.SNAPAPPL

DB_NAME AGENT_ID
ROWS_READ
ROWS_WRITTEN
-------- -------------------- -------------------- -------------------SAMPLE
7
25
0
SNAP_GET_APPL table function

The SNAP_GET_APPL table function returns the same information as the
SNAPAPPL administrative view, but allows you to retrieve the information for a
functions, the SNAP_GET_APPL table function provides information equivalent to
the GET SNAPSHOT FOR ALL APPLICATIONS CLP command, but retrieves data from all
database members.
returned.
Syntax
SNAP_GET_APPL (
dbname
, member
1243

dbname
member
SNAP_GET_APPL table function takes a snapshot for the currently connected
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve details on rows read and written for each application for all active
databases.
FROM TABLE (SNAP_GET_APPL(CAST(NULL AS VARCHAR(128)),-1)) AS T

DB_NAME AGENT_ID
ROWS_READ
ROWS_WRITTEN
-------- --------...--- ---------...-- ------------...WSDB
679
0
0
1244
WSDB
WSDB
TEST
TEST
TEST
TEST
461
460
680
455
454
453
3
4
4
6
0
50
0
0
0
0
0
0
Table 305. Information returned by the SNAPAPPL administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
AGENT_ID
BIGINT

(agent ID)
UOW_LOG_SPACE_USED
BIGINT
uow_log_space_used - Unit of
work log space used
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
INACT_STMTHIST_SZ
BIGINT
inact_stmthist_sz - Statement
history list size
POOL_DATA_L_READS
BIGINT

data logical reads
POOL_DATA_P_READS
BIGINT

data physical reads
POOL_DATA_WRITES
BIGINT
pool_data_writes - Buffer pool data

writes
POOL_INDEX_L_READS
BIGINT

index logical reads
POOL_INDEX_P_READS
BIGINT

POOL_INDEX_WRITES
BIGINT

index writes
BIGINT
pool_temp_data_l_reads - Buffer
pool temporary data logical reads
BIGINT
pool temporary data physical reads
BIGINT
pool_temp_index_l_reads - Buffer
pool temporary index logical reads
BIGINT
pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
BIGINT
pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
BIGINT
Pool Temporary XDA Data
Physical Reads monitor element
1245
SNAP_GET_APPL table function (continued)
1246
monitor element
Column name
Data type
POOL_XDA_L_READS
BIGINT

POOL_XDA_P_READS
BIGINT

POOL_XDA_WRITES
BIGINT
pool_xda_writes - Buffer Pool XDA

Data Writes
POOL_READ_TIME
BIGINT
pool_read_time - Total buffer pool

physical read time
POOL_WRITE_TIME
BIGINT
pool_write_time - Total buffer pool

physical write time
DIRECT_READS
BIGINT
direct_reads - Direct reads from

database
DIRECT_WRITES
BIGINT
direct_writes - Direct writes to

database
DIRECT_READ_REQS
BIGINT
direct_read_reqs - Direct read

requests
DIRECT_WRITE_REQS
BIGINT
direct_write_reqs - Direct write

requests
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT
direct_write_time - Direct write

time
BIGINT
prefetch pages
LOCKS_HELD
BIGINT
LOCK_WAITS
BIGINT
LOCK_WAIT_TIME
BIGINT

locks
LOCK_ESCALS
BIGINT

escalations
X_LOCK_ESCALS
BIGINT

escalations
DEADLOCKS
BIGINT
TOTAL_SORTS
BIGINT
TOTAL_SORT_TIME
BIGINT
SORT_OVERFLOWS
BIGINT
COMMIT_SQL_STMTS
BIGINT
commit_sql_stmts - Commit
statements attempted
ROLLBACK_SQL_STMTS
BIGINT
rollback_sql_stmts - Rollback
DYNAMIC_SQL_STMTS
BIGINT

STATIC_SQL_STMTS
BIGINT
static_sql_stmts - Static SQL

monitor element
Column name
Data type
FAILED_SQL_STMTS
BIGINT
failed_sql_stmts - Failed statement

operations
SELECT_SQL_STMTS
BIGINT
select_sql_stmts - Select SQL

statements executed
DDL_SQL_STMTS
BIGINT
ddl_sql_stmts - Data definition

language (DDL) SQL statements
UID_SQL_STMTS
BIGINT
uid_sql_stmts UPDATE/INSERT/DELETE SQL

statements executed
INT_AUTO_REBINDS
BIGINT
int_auto_rebinds - Internal
automatic rebinds
INT_ROWS_DELETED
BIGINT
int_rows_deleted - Internal rows

deleted
INT_ROWS_UPDATED
BIGINT
int_rows_updated - Internal rows

updated
INT_COMMITS
BIGINT
INT_ROLLBACKS
BIGINT
INT_DEADLOCK_ROLLBACKS
BIGINT
int_deadlock_rollbacks - Internal
rollbacks due to deadlock
ROWS_DELETED
BIGINT
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
ROWS_SELECTED
BIGINT
rows_selected - Rows selected
BINDS_PRECOMPILES
BIGINT
binds_precompiles Binds/precompiles attempted
OPEN_REM_CURS
BIGINT
open_rem_curs - Open remote

cursors
OPEN_REM_CURS_BLK
BIGINT
open_rem_curs_blk - Open remote

cursors with blocking
REJ_CURS_BLK
BIGINT
rej_curs_blk - Rejected block cursor

requests
ACC_CURS_BLK
BIGINT
acc_curs_blk - Accepted block

cursor requests
BIGINT
sql_reqs_since_commit - SQL
requests since last commit
LOCK_TIMEOUTS
BIGINT

timeouts
INT_ROWS_INSERTED
BIGINT
int_rows_inserted - Internal rows

inserted
OPEN_LOC_CURS
BIGINT
open_loc_curs - Open local cursors
OPEN_LOC_CURS_BLK
BIGINT
open_loc_curs_blk - Open local

PKG_CACHE_LOOKUPS
BIGINT
pkg_cache_lookups - Package
cache lookups
1247
monitor element
Column name
Data type
PKG_CACHE_INSERTS
BIGINT
pkg_cache_inserts - Package cache

inserts
CAT_CACHE_LOOKUPS
BIGINT
cat_cache_lookups - Catalog cache

lookups
CAT_CACHE_INSERTS
BIGINT
cat_cache_inserts - Catalog cache

inserts
CAT_CACHE_OVERFLOWS
BIGINT
cat_cache_overflows - Catalog
cache overflows
NUM_AGENTS
BIGINT
num_agents - Number of agents

working on a statement
AGENTS_STOLEN
BIGINT
agents_stolen - Stolen agents
BIGINT
associated_agents_top - Maximum
number of associated agents
APPL_PRIORITY
BIGINT
appl_priority - Application agent

priority
APPL_PRIORITY_TYPE
VARCHAR(16)
appl_priority_type - Application
priority type. This interface returns
a text identifier, based on defines
v DYNAMIC_PRIORITY
v FIXED_PRIORITY
1248
PREFETCH_WAIT_TIME
BIGINT
prefetch_wait_time - Time waited

for prefetch
APPL_SECTION_LOOKUPS
BIGINT
appl_section_lookups - Section
lookups
APPL_SECTION_INSERTS
BIGINT
appl_section_inserts - Section
inserts
LOCKS_WAITING
BIGINT
locks_waiting - Current agents

waiting on locks
TOTAL_HASH_JOINS
BIGINT
total_hash_joins - Total hash joins
TOTAL_HASH_LOOPS
BIGINT
total_hash_loops - Total hash loops
HASH_JOIN_OVERFLOWS
BIGINT
hash_join_overflows - Hash join

overflows
HASH_JOIN_SMALL_
OVERFLOWS
BIGINT
hash_join_small_overflows - Hash
join small overflows
APPL_IDLE_TIME
BIGINT
appl_idle_time - Application idle

time
UOW_LOCK_WAIT_TIME
BIGINT
uow_lock_wait_time - Total time

unit of work waited on locks
Column name
Data type
UOW_COMP_STATUS
VARCHAR(14)
monitor element
uow_comp_status - Unit of work
completion status. This interface
returns a text identifier, based on
v APPL_END
v UOWABEND
v UOWCOMMIT
v UOWDEADLOCK
v UOWLOCKTIMEOUT
v UOWROLLBACK
v UOWUNKNOWN
AGENT_USR_CPU_TIME_S
BIGINT
agent_usr_cpu_time - User CPU

time used by agent (in seconds)*
AGENT_USR_CPU_TIME_MS
BIGINT

time used by agent (fractional, in
microseconds)*
AGENT_SYS_CPU_TIME_S
BIGINT
agent_sys_cpu_time - System CPU

AGENT_SYS_CPU_TIME_MS
BIGINT

microseconds)*
APPL_CON_TIME
TIMESTAMP
appl_con_time - Connection
request start timestamp
CONN_COMPLETE_TIME
TIMESTAMP
conn_complete_time - Connection
request completion timestamp
LAST_RESET
TIMESTAMP
last_reset - Last reset timestamp
UOW_START_TIME
TIMESTAMP
uow_start_time - Unit of work

start timestamp
UOW_STOP_TIME
TIMESTAMP
uow_stop_time - Unit of work stop

timestamp
PREV_UOW_STOP_TIME
TIMESTAMP
prev_uow_stop_time - Previous
unit of work completion timestamp
UOW_ELAPSED_TIME_S
BIGINT
uow_elapsed_time - Most recent

unit of work elapsed time (in
seconds)*
UOW_ELAPSED_TIME_MS
BIGINT

unit of work elapsed time
(fractional, in microseconds)*
ELAPSED_EXEC_TIME_S
BIGINT
elapsed_exec_time - Statement
execution elapsed time (in
seconds)*
ELAPSED_EXEC_TIME_MS
BIGINT
execution elapsed time (fractional,
in microseconds)*
VARCHAR(32)
1249
monitor element
Column name
Data type
LOCK_TIMEOUT_VAL
BIGINT

(seconds)
PRIV_WORKSPACE_NUM_
OVERFLOWS
BIGINT
priv_workspace_num_overflows Private workspace overflows
PRIV_WORKSPACE_SECTION_
INSERTS
BIGINT
priv_workspace_section_inserts Private workspace section inserts
LOOKUPS
BIGINT
priv_workspace_section_lookups Private workspace section lookups
PRIV_WORKSPACE_SIZE_
TOP
BIGINT
priv_workspace_size_top Maximum private workspace size
SHR_WORKSPACE_NUM_
OVERFLOWS
BIGINT
shr_workspace_num_overflows Shared workspace overflows
SHR_WORKSPACE_SECTION_
INSERTS
BIGINT
shr_workspace_section_inserts Shared workspace section inserts
LOOKUPS
BIGINT
shr_workspace_section_lookups Shared workspace section lookups
SHR_WORKSPACE_SIZE_
TOP
BIGINT
shr_workspace_size_top Maximum shared workspace size
DBPARTITIONNUM
SMALLINT
CAT_CACHE_SIZE_TOP
BIGINT
cat_cache_size_top - Catalog cache

high water mark
TOTAL_OLAP_FUNCS
BIGINT
total_olap_funcs - Total OLAP

functions
OLAP_FUNC_OVERFLOWS
BIGINT
olap_func_overflows - OLAP
function overflows
MEMBER
SMALLINT

monitor element
SNAP_GET_APPL_V95 table function - Retrieve appl logical

data group snapshot information
The SNAP_GET_APPL_V95 table function returns information about applications
from an application snapshot, in particular, the appl logical data group.
Important: The SNAP_GET_APPL_V95 table function is deprecated and has been
replaced by the MON_GET_CONNECTION table function - Get connection
returned.
1250
Syntax
SNAP_GET_APPL_V95 (
dbname
, member

dbname
member
SNAP_GET_APPL_V95 table function takes a snapshot for the currently connected
Authorization
v EXECUTE privilege on the SNAP_GET_APPL_V95 table function
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1251
Example
databases.
FROM TABLE (SNAP_GET_APPL_V95(CAST(NULL AS VARCHAR(128)),-1)) AS T

DB_NAME AGENT_ID
ROWS_READ
ROWS_WRITTEN
-------- --------...--- ---------...-- ------------...WSDB
679
0
0
WSDB
461
3
0
WSDB
460
4
0
TEST
680
4
0
TEST
455
6
0
TEST
454
0
0
TEST
453
50
0
Table 306. Information returned by the SNAP_GET_APPL_V95 table function
1252
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
AGENT_ID
BIGINT

(agent ID)
UOW_LOG_SPACE_USED
BIGINT
work log space used
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
STMT_HISTORY_LIST_SIZE
BIGINT
stmt_history_list_size - Statement
history list size
POOL_DATA_L_READS
BIGINT

data logical reads
POOL_DATA_P_READS
BIGINT

data physical reads
POOL_DATA_WRITES
BIGINT

writes
POOL_INDEX_L_READS
BIGINT

index logical reads
POOL_INDEX_P_READS
BIGINT

POOL_INDEX_WRITES
BIGINT

index writes
BIGINT
BIGINT
BIGINT
Table 306. Information returned by the SNAP_GET_APPL_V95 table function (continued)

monitor element
Column name
Data type
BIGINT
reads
BIGINT
Reads
BIGINT
POOL_XDA_L_READS
BIGINT

POOL_XDA_P_READS
BIGINT

POOL_XDA_WRITES
BIGINT

Data Writes
POOL_READ_TIME
BIGINT

physical read time
POOL_WRITE_TIME
BIGINT

physical write time
DIRECT_READS
BIGINT

database
DIRECT_WRITES
BIGINT

database
DIRECT_READ_REQS
BIGINT

requests
DIRECT_WRITE_REQS
BIGINT

requests
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT

time
BIGINT
prefetch pages
LOCKS_HELD
BIGINT
LOCK_WAITS
BIGINT
LOCK_WAIT_TIME
BIGINT

locks
LOCK_ESCALS
BIGINT

escalations
X_LOCK_ESCALS
BIGINT

escalations
DEADLOCKS
BIGINT
TOTAL_SORTS
BIGINT
TOTAL_SORT_TIME
BIGINT
SORT_OVERFLOWS
BIGINT
COMMIT_SQL_STMTS
BIGINT
1253
1254
monitor element
Column name
Data type
ROLLBACK_SQL_STMTS
BIGINT
DYNAMIC_SQL_STMTS
BIGINT

STATIC_SQL_STMTS
BIGINT

FAILED_SQL_STMTS
BIGINT

operations
SELECT_SQL_STMTS
BIGINT

statements executed
DDL_SQL_STMTS
BIGINT

UID_SQL_STMTS
BIGINT

statements executed
INT_AUTO_REBINDS
BIGINT
automatic rebinds
INT_ROWS_DELETED
BIGINT

deleted
INT_ROWS_UPDATED
BIGINT

updated
INT_COMMITS
BIGINT
INT_ROLLBACKS
BIGINT
BIGINT
ROWS_DELETED
BIGINT
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
ROWS_SELECTED
BIGINT
BINDS_PRECOMPILES
BIGINT
OPEN_REM_CURS
BIGINT

cursors
OPEN_REM_CURS_BLK
BIGINT

REJ_CURS_BLK
BIGINT

requests
ACC_CURS_BLK
BIGINT

cursor requests
BIGINT
LOCK_TIMEOUTS
BIGINT

timeouts
INT_ROWS_INSERTED
BIGINT

inserted

Column name
Data type
monitor element
OPEN_LOC_CURS
BIGINT
OPEN_LOC_CURS_BLK
BIGINT

PKG_CACHE_LOOKUPS
BIGINT
cache lookups
PKG_CACHE_INSERTS
BIGINT

inserts
CAT_CACHE_LOOKUPS
BIGINT

lookups
CAT_CACHE_INSERTS
BIGINT

inserts
CAT_CACHE_OVERFLOWS
BIGINT
cache overflows
NUM_AGENTS
BIGINT

AGENTS_STOLEN
BIGINT
BIGINT
APPL_PRIORITY
BIGINT

priority
APPL_PRIORITY_TYPE
VARCHAR(16)
v DYNAMIC_PRIORITY
v FIXED_PRIORITY
PREFETCH_WAIT_TIME
BIGINT

for prefetch
BIGINT
lookups
BIGINT
inserts
LOCKS_WAITING
BIGINT

waiting on locks
TOTAL_HASH_JOINS
BIGINT
TOTAL_HASH_LOOPS
BIGINT
HASH_JOIN_OVERFLOWS
BIGINT

overflows
HASH_JOIN_SMALL_
OVERFLOWS
BIGINT
APPL_IDLE_TIME
BIGINT

time
UOW_LOCK_WAIT_TIME
BIGINT

1255

Column name
Data type
UOW_COMP_STATUS
VARCHAR(14)
monitor element
v APPL_END
v UOWABEND
v UOWCOMMIT
v UOWDEADLOCK
v UOWLOCKTIMEOUT
v UOWROLLBACK
v UOWUNKNOWN
1256
BIGINT

BIGINT

microseconds)*
BIGINT

BIGINT

microseconds)*
APPL_CON_TIME
TIMESTAMP
CONN_COMPLETE_TIME
TIMESTAMP
LAST_RESET
TIMESTAMP
UOW_START_TIME
TIMESTAMP

start timestamp
UOW_STOP_TIME
TIMESTAMP

timestamp
PREV_UOW_STOP_TIME
TIMESTAMP
UOW_ELAPSED_TIME_S
BIGINT

seconds)*
UOW_ELAPSED_TIME_MS
BIGINT

ELAPSED_EXEC_TIME_S
BIGINT
seconds)*
BIGINT
in microseconds)*
VARCHAR(32)

monitor element
Column name
Data type
LOCK_TIMEOUT_VAL
BIGINT

(seconds)
PRIV_WORKSPACE_NUM_
OVERFLOWS
BIGINT
INSERTS
BIGINT
LOOKUPS
BIGINT
TOP
BIGINT
SHR_WORKSPACE_NUM_
OVERFLOWS
BIGINT
INSERTS
BIGINT
LOOKUPS
BIGINT
SHR_WORKSPACE_SIZE_
TOP
BIGINT
DBPARTITIONNUM
SMALLINT
CAT_CACHE_SIZE_TOP
BIGINT

high water mark
TOTAL_OLAP_FUNCS
BIGINT

Functions monitor element
OLAP_FUNC_OVERFLOWS
BIGINT
Function Overflows monitor
element
SNAPBP administrative view and SNAP_GET_BP table

function - Retrieve bufferpool logical group snapshot
information
The SNAPBP administrative view and the SNAP_GET_BP table function return
information about buffer pools from a bufferpool snapshot, in particular, the
bufferpool logical data group.
Important: The SNAPBP administrative view and the SNAP_GET_BP table
function are deprecated and have been replaced by the MON_GET_BUFFERPOOL
table function - Get buffer pool metrics on page 522.
1257
v SNAPBP administrative view

v SNAP_GET_BP table function on page 1259
SNAPBP administrative view

This administrative view allows you to retrieve bufferpool logical group snapshot
Used with the MON_GET_BUFFERPOOL table function, the SNAPBP
administrative view provides the data equivalent to the GET SNAPSHOT FOR
BUFFERPOOLS ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPBP administrative view
v
v
v
v
CONTROL privilege on the SNAPBP administrative view

DBADM authority
SQLADM authority

v
v
v
v
EXECUTE privilege on the SNAP_GET_BP table function

DBADM authority
SQLADM authority

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve data and index writes for all the bufferpools of the currently connected
database.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME,SUBSTR(BP_NAME,1,15)
AS BP_NAME,POOL_DATA_WRITES,POOL_INDEX_WRITES
FROM SYSIBMADM.SNAPBP
1258
DB_NAME
-------TEST
TEST
TEST
TEST
TEST
BP_NAME
POOL_DATA_WRITES
POOL_INDEX_WRITES
--------------- -------------------- -------------------IBMDEFAULTBP
0
0
IBMSYSTEMBP4K
0
0
IBMSYSTEMBP8K
0
0
IBMSYSTEMBP16K
0
0
IBMSYSTEMBP32K
0
0
SNAP_GET_BP table function

The SNAP_GET_BP table function returns the same information as the SNAPBP
administrative view, but allows you to retrieve the information for a specific
database on a specific database member, aggregate of all database members or all
database members.
Used with the SNAP_GET_BP_PART table function, the SNAP_GET_BP table
function provides the data equivalent to the GET SNAPSHOT FOR ALL BUFFERPOOLS
CLP command.
returned.
Syntax
SNAP_GET_BP (
dbname
, member

dbname
member
SNAP_GET_BP table function takes a snapshot for the currently connected
1259
Authorization
v EXECUTE privilege on the SNAP_GET_BP table function
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve total physical and logical reads for all bufferpools for all active databases
for the currently connected database member.
SELECT SUBSTR(T.DB_NAME,1,10) AS DB_NAME,
SUBSTR(T.BP_NAME,1,20) AS BP_NAME,
(T.POOL_DATA_L_READS+T.POOL_INDEX_L_READS) AS TOTAL_LOGICAL_READS,
(T.POOL_DATA_P_READS+T.POOL_INDEX_P_READS) AS TOTAL_PHYSICAL_READS,
T.DBPARTITIONNUM
FROM TABLE(SNAP_GET_BP(CAST(NULL AS VARCHAR(128)), -1)) AS T

DB_NAME
---------SAMPLE
TOOLSDB
TOOLSDB
BP_NAME
TOTAL_LOGICAL_READS ...
------------...- -------------------- ...
IBMDEFAULTBP
0 ...
IBMDEFAULTBP
0 ...
BP32K0000
0 ...

... TOTAL_PHYSICAL_READS DBPARTITIONNUM
... -------------------- -------------...
0
0
...
0
0
...
0
0
Table 307. Information returned by the SNAPBP administrative view and the
1260
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
BP_NAME
VARCHAR(128)
DB_NAME
VARCHAR(128)
SNAP_GET_BP table function (continued)
monitor element
Column name
Data type
DB_PATH
INPUT_DB_ALIAS
VARCHAR(128)

alias
POOL_DATA_L_READS
BIGINT

data logical reads
POOL_DATA_P_READS
BIGINT

data physical reads
POOL_DATA_WRITES
BIGINT

writes
POOL_INDEX_L_READS
BIGINT

index logical reads
POOL_INDEX_P_READS
BIGINT

POOL_INDEX_WRITES
BIGINT

index writes
POOL_XDA_L_READS
BIGINT

POOL_XDA_P_READS
BIGINT

POOL_XDA_WRITES
BIGINT

Data Writes
POOL_READ_TIME
BIGINT

physical read time
POOL_WRITE_TIME
BIGINT

physical write time
BIGINT
BIGINT
pool_async_data_writes - Buffer
pool asynchronous data writes
BIGINT
BIGINT
pool_async_index_writes - Buffer
pool asynchronous index writes
BIGINT
Pool Asynchronous XDA Data
Reads
BIGINT
pool_async_xda_writes - Buffer
Writes
BIGINT
pool_async_read_time - Buffer pool

asynchronous read time
BIGINT
pool_async_write_time - Buffer
pool asynchronous write time
POOL_ASYNC_DATA_
READ_REQS
BIGINT
pool_async_data_read_reqs - Buffer
pool asynchronous read requests
1261
1262
monitor element
Column name
Data type
POOL_ASYNC_INDEX_
READ_REQS
BIGINT
pool_async_index_read_reqs Buffer pool asynchronous index

read requests
POOL_ASYNC_XDA_
READ_REQS
BIGINT
pool_async_xda_read_reqs - Buffer
Pool Asynchronous XDA Read
Requests
DIRECT_READS
BIGINT

database
DIRECT_WRITES
BIGINT

database
DIRECT_READ_REQS
BIGINT

requests
DIRECT_WRITE_REQS
BIGINT

requests
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT

time
BIGINT
prefetch pages
FILES_CLOSED
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
reads
BIGINT
Reads
BIGINT
BIGINT
pool_no_victim_buffer - Buffer
pool no victim buffers
BIGINT
pages_from_block_ios - Total
number of pages read by block
I/O
BIGINT
pages_from_vectored_ios - Total
pages read by vectored I/O
VECTORED_IOS
BIGINT
vectored_ios - Number of vectored

I/O requests
DBPARTITIONNUM
SMALLINT
Column name
Data type
MEMBER
SMALLINT
monitor element
monitor element
SNAPBP_PART administrative view and SNAP_GET_BP_PART

table function - Retrieve bufferpool_nodeinfo logical data
group snapshot information
The SNAPBP_PART administrative view and the SNAP_GET_BP_PART table
function return information about buffer pools from a bufferpool snapshot, in
particular, the bufferpool_nodeinfo logical data group.
Important: The SNAPBP_PART administrative view and the SNAP_GET_BP_PART
table function are deprecated and have been replaced by the
MON_GET_BUFFERPOOL table function - Get buffer pool metrics on page 522.
v SNAPBP_PART administrative view
v SNAP_GET_BP_PART table function on page 1264
SNAPBP_PART administrative view

This administrative view allows you to retrieve bufferpool_nodeinfo logical data
group snapshot information for the currently connected database.
Used with the MON_GET_BUFFERPOOL table function, the SNAPBP_PART
returned.
Authorization
v SELECT privilege on the SNAPBP_PART administrative view
v CONTROL privilege on the SNAPBP_PART administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_BP_PART table function
v DBADM authority
v SQLADM authority
1263

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve data for all bufferpools when connected to SAMPLE database.
BP_CUR_BUFFSZ, BP_NEW_BUFFSZ, BP_PAGES_LEFT_TO_REMOVE, BP_TBSP_USE_COUNT
FROM SYSIBMADM.SNAPBP_PART

DB_NAME
-------SAMPLE
SAMPLE
SAMPLE
SAMPLE
BP_NAME
BP_CUR_BUFFSZ
BP_NEW_BUFFSZ
--------------- -------------------- -------------------IBMDEFAULTBP
1000
1000
IBMSYSTEMBP4K
16
16
IBMSYSTEMBP8K
16
16
IBMSYSTEMBP16K
16
16
...
...
...
...
...
...
...

... BP_PAGES_LEFT_TO_REMOVE BP_TBSP_USE_COUNT
... ----------------------- -------------------...
0
3
...
0
0
...
0
0
...
0
0
...
SNAP_GET_BP_PART table function

The SNAP_GET_BP_PART table function returns the same information as the
SNAPBP_PART administrative view, but allows you to retrieve the information for
Used with the SNAP_GET_BP table function, the SNAP_GET_BP_PART table
CLP command.
returned.
Syntax
SNAP_GET_BP_PART (
dbname
)
, member
1264

dbname
value to take the snapshot for all bufferpools in all databases within the same
instance as the currently connected database.
member
SNAP_GET_BP_PART table function takes a snapshot for the currently connected
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve data for all bufferpools for all active databases when connected to the
SAMPLE database.
FROM TABLE(SNAP_GET_BP_PART(CAST(NULL AS VARCHAR(128)),-1)) AS T

1265
DB_NAME
-------SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
BP_NAME
BP_CUR_BUFFSZ
BP_NEW_BUFFSZ
--------------- -------------------- -------------------IBMDEFAULTBP
250
250
IBMSYSTEMBP4K
16
16
IBMSYSTEMBP8K
16
16
IBMSYSTEMBP16K
16
16
IBMSYSTEMBP32K
16
16
IBMDEFAULTBP
250
250
IBMSYSTEMBP4K
16
16
IBMSYSTEMBP8K
16
16
IBMSYSTEMBP16K
16
16
IBMSYSTEMBP32K
16
16
...
...
...
...
...
...
...
...
...
...
...
...
...

... ----------------------- -------------------...
0
3
...
0
0
...
0
0
...
0
0
...
0
0
...
0
3
...
0
0
...
0
0
...
0
0
...
0
0
...
Table 308. Information returned by the SNAPBP_PART administrative view and the
1266
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
BP_NAME
VARCHAR(128)
DB_NAME
VARCHAR(128)
BP_CUR_BUFFSZ
BIGINT
bp_cur_buffsz - current size of

buffer pool
BP_NEW_BUFFSZ
BIGINT
bp_new_buffsz - New buffer pool

size
BIGINT
bp_pages_left_to_remove Number of pages left to remove
BP_TBSP_USE_COUNT
BIGINT
bp_tbsp_use_count - Number of
table spaces mapped to buffer pool
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAP_GET_BP_V95 table function - Retrieve bufferpool

logical group snapshot information
The SNAP_GET_BP_V95 table function returns information about buffer pools
from a bufferpool snapshot, in particular, the bufferpool logical data group.
Important: The SNAP_GET_BP_V95 table function is deprecated and have been
replaced by the MON_GET_BUFFERPOOL table function - Get buffer pool
returned.
Syntax
SNAP_GET_BP_V95 (
dbname
, member

dbname
member
SNAP_GET_BP_V95 table function takes a snapshot for the currently connected
Authorization
v EXECUTE privilege on the SNAP_GET_BP_V95 table function
also required:
1267
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
T.DBPARTITIONNUM
FROM TABLE(SNAP_GET_BP_V95(CAST(NULL AS VARCHAR(128)), -1)) AS T

DB_NAME
BP_NAME
---------- ------------...- -------------------- ...
SAMPLE
IBMDEFAULTBP
0 ...
TOOLSDB
IBMDEFAULTBP
0 ...
TOOLSDB
BP32K0000
0 ...

... -------------------- -------------...
0
0
...
0
0
...
0
0
Table 309. Information returned by the SNAP_GET_BP_V95 table function
1268
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
BP_NAME
VARCHAR(128)
DB_NAME
VARCHAR(128)
DB_PATH
INPUT_DB_ALIAS
VARCHAR(128)

alias
POOL_DATA_L_READS
BIGINT

data logical reads
POOL_DATA_P_READS
BIGINT

data physical reads
POOL_DATA_WRITES
BIGINT

writes
Table 309. Information returned by the SNAP_GET_BP_V95 table function (continued)

monitor element
Column name
Data type
POOL_INDEX_L_READS
BIGINT

index logical reads
POOL_INDEX_P_READS
BIGINT

POOL_INDEX_WRITES
BIGINT

index writes
POOL_XDA_L_READS
BIGINT

POOL_XDA_P_READS
BIGINT

POOL_XDA_WRITES
BIGINT

Data Writes
POOL_READ_TIME
BIGINT

physical read time
POOL_WRITE_TIME
BIGINT

physical write time
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
Reads
BIGINT
Writes
BIGINT

BIGINT
POOL_ASYNC_DATA_
READ_REQS
BIGINT
POOL_ASYNC_INDEX_
READ_REQS
BIGINT

read requests
POOL_ASYNC_XDA_
READ_REQS
BIGINT
Requests
DIRECT_READS
BIGINT

database
DIRECT_WRITES
BIGINT

database
1269
Table 309. Information returned by the SNAP_GET_BP_V95 table function (continued)

monitor element
Column name
Data type
DIRECT_READ_REQS
BIGINT

requests
DIRECT_WRITE_REQS
BIGINT

requests
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT

time
BIGINT
prefetch pages
FILES_CLOSED
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
reads
BIGINT
Reads
BIGINT
BIGINT
BIGINT
I/O
BIGINT
VECTORED_IOS
BIGINT

I/O requests
DBPARTITIONNUM
SMALLINT

SNAP_GET_CONTAINER table function - Retrieve
tablespace_container logical data group snapshot information
The SNAPCONTAINER administrative view and the SNAP_GET_CONTAINER
table function return table space snapshot information from the
tablespace_container logical data group.
1270
Important: The SNAPCONTAINER administrative view and the

SNAP_GET_CONTAINER table function are deprecated and have been replaced by
the MON_GET_CONTAINER table function - Get table space container metrics
on page 567.
v SNAPCONTAINER administrative view
v SNAP_GET_CONTAINER table function on page 1272
SNAPCONTAINER administrative view

This administrative view allows you to retrieve tablespace_container logical data
Used with the MON_GET_TABLESPACE table function and the
SNAPTBSP_QUIESCER SNAPTBSP_RANGE administrative view, the
SNAPCONTAINER administrative view returns data equivalent to the GET
SNAPSHOT FOR TABLESPACES ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPCONTAINER administrative view
v
v
v
v
CONTROL privilege on the SNAPCONTAINER administrative view

DBADM authority
SQLADM authority

v
v
v
v
EXECUTE privilege on the SNAP_GET_CONTAINER table function

DBADM authority
SQLADM authority

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1271
Example
Retrieve details for the table space containers for all database members for the
SELECT SNAPSHOT_TIMESTAMP, SUBSTR(TBSP_NAME, 1, 15) AS TBSP_NAME,
TBSP_ID, SUBSTR(CONTAINER_NAME, 1, 20) AS CONTAINER_NAME,
CONTAINER_ID, CONTAINER_TYPE, ACCESSIBLE, DBPARTITIONNUM
FROM SYSIBMADM.SNAPCONTAINER ORDER BY DBPARTITIONNUM

SNAPSHOT_TIMESTAMP
-------------------------2006-01-08-16.49.24.639945
2006-01-08-16.49.24.639945
2006-01-08-16.49.24.639945
2006-01-08-16.49.24.639945
2006-01-08-16.49.24.640747
2006-01-08-16.49.24.640747
2006-01-08-16.49.24.639981
2006-01-08-16.49.24.639981
TBSP_NAME
TBSP_ID ...
--------------- -------- ...
SYSCATSPACE
0 ...
TEMPSPACE1
1 ...
USERSPACE1
2 ...
SYSTOOLSPACE
3 ...
TEMPSPACE1
1 ...
USERSPACE1
2 ...
TEMPSPACE1
1 ...
USERSPACE1
2 ...
...

...
...
...
...
...
...
...
...
...
...
CONTAINER_NAME
CONTAINER_ID CONTAINER_TYPE
...
-------------------- ------------- ---------------- ...
/home/swalkty/swalkt
0 FILE_EXTENT_TAG ...
0 PATH
...
0 PATH
...
0 PATH
...

... ACCESSIBLE DBPARTITIONNUM
... ---------- -------------...
1
0
...
1
0
...
1
0
...
1
0
...
1
1
...
1
1
...
1
2
...
1
2
SNAP_GET_CONTAINER table function

The SNAP_GET_CONTAINER table function returns the same information as the
SNAPCONTAINER administrative view, but allows you to retrieve the information
SNAP_GET_TBSP_QUIESCER and SNAP_GET_TBSP_RANGE table functions, the
SNAP_GET_CONTAINER table function returns data equivalent to the GET
returned.
1272
Syntax
SNAP_GET_CONTAINER (
dbname
, member

dbname
member
used, that is, only dbname is provided, data is returned from all members
where the database is active.
SNAP_GET_CONTAINER table function takes a snapshot for the currently
connected database and database member.
Authorization
v EXECUTE privilege on the SNAP_GET_CONTAINER table function
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve details for the table space containers on the currently connected database
1273
SELECT SNAPSHOT_TIMESTAMP, TBSP_NAME, TBSP_ID, CONTAINER_NAME,

CONTAINER_ID, CONTAINER_TYPE, ACCESSIBLE
FROM TABLE(SNAP_GET_CONTAINER(,-1)) AS T

SNAPSHOT_TIMESTAMP
-------------------------2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
TBSP_NAME
TBSP_ID ...
-------------------- ------- ...
SYSCATSPACE
0 ...
TEMPSPACE1
1 ...
USERSPACE1
2 ...
SYSTOOLSPACE
3 ...
MYTEMP
4 ...
WHATSNEWTEMPSPACE
5 ...

...
...
...
...
...
...
...
...
CONTAINER_NAME
CONTAINER_ID ...
---------------------------------------- ------------ ...
0 ...
0 ...
0 ...
0 ...
D:\DB2\NODE0000\SQL003
0 ...
d:\DGTTsWhatsNewContainer
0 ...

...
...
...
...
...
...
...
...
CONTAINER_TYPE ACCESSIBLE
-------------- ---------CONT_PATH
1
CONT_PATH
1
CONT_PATH
1
CONT_PATH
1
CONT_PATH
1
CONT_PATH
1
NOTE: The BUFFERPOOL database manager monitor switch must be turned on in
order for the file system information to be returned.
Table 310. Information returned by the SNAPCONTAINER administrative view and the
1274
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TBSP_NAME
VARCHAR(128)

name
TBSP_ID
BIGINT

identification
CONTAINER_NAME
VARCHAR(256)
CONTAINER_ID
BIGINT
identification
SNAP_GET_CONTAINER table function (continued)
Column name
Data type
CONTAINER_TYPE
VARCHAR(16)
monitor element
container_type - Container type.
of:
v DISK_EXTENT_TAG
v DISK_PAGE_TAG
v FILE_EXTENT_TAG
v FILE_PAGE_TAG
v PATH
TOTAL_PAGES
BIGINT

in container
USABLE_PAGES
BIGINT
pages in container
ACCESSIBLE
SMALLINT
of container
STRIPE_SET
BIGINT
DBPARTITIONNUM
SMALLINT
FS_ID
VARCHAR(22)

FS_TOTAL_SIZE
BIGINT

system
FS_USED_SIZE
BIGINT

SNAP_GET_CONTAINER_V91 table function - Retrieve

SNAP_GET_CONTAINER_V91 returns table space snapshot information from the
SNAPCONTAINER administrative view and SNAP_GET_CONTAINER table
function
returned.
Syntax
SNAP_GET_CONTAINER_V91 (
dbname
, dbpartitionnum
1275

dbname
dbpartitionnum
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If dbname is not set to NULL and
dbpartitionnum is set to NULL, -1 is set implicitly for dbpartitionnum. If this input
option is not used, that is, only dbname is provided, data is returned from all
active database partitions. An active database partition is a partition where the
If both dbname and dbpartitionnum are set to NULL, an attempt is made to read data
from the file created by SNAP_WRITE_FILE procedure. Note that this file could
have been created at any time, which means that the data might not be current. If
a file with the corresponding snapshot API request type does not exist, then the
SNAP_GET_CONTAINER_V91 table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v EXECUTE privilege on the SNAP_GET_CONTAINER_V91 table function
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
on the currently connected database partition.
FROM TABLE(SNAP_GET_CONTAINER_V91(,-1)) AS T

SNAPSHOT_TIMESTAMP
-------------------------2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
1276
TBSP_NAME
TBSP_ID ...
-------------------- ------- ...
SYSCATSPACE
0 ...
TEMPSPACE1
1 ...
2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
USERSPACE1
SYSTOOLSPACE
MYTEMP
WHATSNEWTEMPSPACE
2
3
4
5
...
...
...
...

...
...
...
...
...
...
...
...
CONTAINER_NAME
CONTAINER_ID ...
---------------------------------------- ------------ ...
0 ...
0 ...
0 ...
0 ...
0 ...
0 ...

...
...
...
...
...
...
...
...
-------------- ---------CONT_PATH
1
CONT_PATH
1
CONT_PATH
1
CONT_PATH
1
CONT_PATH
1
CONT_PATH
1
NOTE: The bufferpool database manager monitor switch must be turned on in
Table 311. Information returned by the SNAP_GET_CONTAINER_V91 table function
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TBSP_NAME
VARCHAR(128)

name
TBSP_ID
BIGINT

identification
CONTAINER_NAME
VARCHAR(256)
CONTAINER_ID
BIGINT
identification
CONTAINER_TYPE
VARCHAR(16)

of:
v DISK_EXTENT_TAG
v DISK_PAGE_TAG
v FILE_EXTENT_TAG
v FILE_PAGE_TAG
v PATH
TOTAL_PAGES
BIGINT

in container
USABLE_PAGES
BIGINT
pages in container
1277
Table 311. Information returned by the SNAP_GET_CONTAINER_V91 table

monitor element
Column name
Data type
ACCESSIBLE
SMALLINT
of container
STRIPE_SET
BIGINT
DBPARTITIONNUM
SMALLINT
FS_ID
VARCHAR(22)

FS_TOTAL_SIZE
BIGINT

system
FS_USED_SIZE
BIGINT

SNAPDB administrative view and SNAP_GET_DB table

function - Retrieve snapshot information from the dbase
logical group
The SNAPDB administrative view and the SNAP_GET_DB table function return
snapshot information from the database (dbase) logical group.
Important: The SNAPDB administrative view and SNAP_GET_DB table function
are deprecated and have been replaced by the MON_GET_DATABASE table
function - Get database level information on page 570 and
MON_GET_TRANSACTION_LOG table function - Get log information on page
751.
v SNAPDB administrative view
v SNAP_GET_DB table function on page 1280
SNAPDB administrative view

This administrative view allows you to retrieve snapshot information from the
dbase logical group for the currently connected database.
Used in conjunction with ADMIN_GET_STORAGE_PATHS table function,
MON_GET_MEMORY_POOL, MON_GET_TRANSACTION_LOG, and
MON_GET_HADR, the SNAPDB administrative view provides information
equivalent to the GET SNAPSHOT FOR DATABASE on database-alias CLP command.
Refer to Table 312 on page 1282 for a complete list of information that is returned.
Authorization
v SELECT privilege on the SNAPDB administrative view
1278
v
v
v
v
CONTROL privilege on the SNAPDB administrative view

DBADM authority
SQLADM authority

v EXECUTE privilege on the SNAP_GET_DB table function
v DBADM authority
v SQLADM authority
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Examples
Retrieve the status, platform, location, and connect time for all database members
of the currently connected database.
SELECT SUBSTR(DB_NAME, 1, 20) AS DB_NAME, DB_STATUS, SERVER_PLATFORM,
DB_LOCATION, DB_CONN_TIME, DBPARTITIONNUM
FROM SYSIBMADM.SNAPDB ORDER BY DBPARTITIONNUM

DB_NAME
-------...TEST
TEST
TEST
DB_STATUS
-----------ACTIVE
ACTIVE
ACTIVE
SERVER_PLATFORM
--------------AIX64
AIX64
AIX64
DB_LOCATION
-----------LOCAL
LOCAL
LOCAL
...
...
...
...
...

...
...
...
...
...
DB_CONN_TIME
DBPARTITIONNUM
-------------------------- -------------2006-01-08-16.48.30.665477
0
2006-01-08-16.48.34.005328
1
2006-01-08-16.48.34.007937
2
This routine can be used by calling the following on the command line:
SELECT TOTAL_OLAP_FUNCS, OLAP_FUNC_OVERFLOWS, ACTIVE_OLAP_FUNCS
FROM SYSIBMADM.SNAPDB
TOTAL_OLAP_FUNCS
OLAP_FUNC_OVERFLOWS ACTIVE_OLAP_FUNCS
-------------------- -------------------- ----------------7
2
1
1279
After running a workload, a user can use the following query:

SELECT STATS_CACHE_SIZE, STATS_FABRICATIONS, SYNC_RUNSTATS,
ASYNC_RUNSTATS, STATS_FABRICATE_TIME, SYNC_RUNSTATS_TIME
STATS_CACHE_SIZE STATS_FABRICATIONS SYNC_RUNSTATS ASYNC_RUNSTATS ...
---------------- ------------------ ------------- -------------- ...
128
2
1
0 ...
... STATS_FABRICATE_TIME SYNC_RUNSTATS_TIME
... -------------------- -----------------...
10
100
SNAP_GET_DB table function

The SNAP_GET_DB table function returns the same information as the SNAPDB
Used in conjunction with the ADMIN_GET_STORAGE_PATHS table function,
MON_GET_HADR table functions, the SNAP_GET_DB table function provides
information equivalent to the GET SNAPSHOT FOR ALL DATABASES CLP command.
Syntax
SNAP_GET_DB (
dbname
, member

dbname
member
1280
SNAP_GET_DB table function takes a snapshot for the currently connected
Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Examples
Example 1: Retrieve the status, platform, location, and connect time as an aggregate
view across all database members of the currently connected database.
DB_LOCATION, DB_CONN_TIME FROM TABLE(SNAP_GET_DB(, -2)) AS T

DB_NAME
DB_STATUS
SERVER_PLATFORM ...
-------...- ---------... --------------- ...
SAMPLE
ACTIVE
AIX64
...

... DB_LOCATION DB_CONN_TIME
... ------------ -------------------------... LOCAL
2005-07-24-22.09.22.013196
view across all database members for all active databases in the same instance that
contains the currently connected database.
DB_LOCATION, DB_CONN_TIME
FROM TABLE(SNAP_GET_DB(CAST (NULL AS VARCHAR(128)), -2)) AS T

DB_NAME
--------...TOOLSDB
SAMPLE
DB_STATUS
---------...
ACTIVE
ACTIVE
SERVER_PLATFORM
--------------AIX64
AIX64
...
...
...
...

1281
...
...
...
...
DB_LOCATION
-----------LOCAL
LOCAL
DB_CONN_TIME
-------------------------2005-07-24-22.26.54.396335
2005-07-24-22.09.22.013196
Example 3: This routine can be used by calling the following on the command line:
When connected to a database:
FROM TABLE (SNAP_GET_DB(, 0)) AS T
The output will look like:
TOTAL_OLAP_FUNCS
---------------7
-------------------- -------------------2
1
Example 4: After running a workload, a user can use the following query with the
table function.
FROM TABLE (SNAP_GET_DB(mytestdb, -1)) AS SNAPDB
---------------- ------------------ ------------- -------------- ...
200
1
2
0 ...
Continued
...STATS_FABRICATE_TIME
...-------------------...
2
SYNC_RUNSTATS_TIME
-----------------32
Example 5: The following example shows how you can use the SNAP_GET_DB
table function to determine the status of a database:
SELECT SUBSTR
(DB_NAME, 1, 20) AS DB_NAME, DB_STATUS
FROM table(SNAP_GET_DB(hadrdb, 0))
DB_NAME
DB_STATUS
-------------------- ---------------HADRDB
ACTIVE_STANDBY
Table 312. Information returned by the SNAPDB administrative view and SNAP_GET_DB table function
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
DB_NAME
VARCHAR(128)
DB_PATH
VARCHAR(1024)
INPUT_DB_ALIAS
VARCHAR(128)
input_db_alias - Input database alias
1282
Table 312. Information returned by the SNAPDB administrative view and SNAP_GET_DB table function (continued)
Column name
Data type
DB_STATUS
VARCHAR(16)

element
db_status - Status of database. This interface
returns a text identifier based on defines in
v ACTIVE
v QUIESCE_PEND
v QUIESCED
v ROLLFWD
v ACTIVE_STANDBY - the HADR database is in
a standby mode with reads on standby
enabled.
v STANDBY - the HADR database is in
standby mode (reads on standby are not
enabled).
CATALOG_PARTITION
SMALLINT
catalog_node - Catalog database partition

number
CATALOG_PARTITION_NAME
VARCHAR(128)
catalog_node_name - Catalog database

partition network name
1283
Column name
Data type
SERVER_PLATFORM
VARCHAR(12)

element
server_platform - Server operating system.
This interface returns a text identifier based
on defines in sqlmon.h, and is one of:
v AIX
v AIX64
v AS400_DRDA
v DOS
v DYNIX
v HP
v HP64
v HPIA
v HPIA64
v LINUX
v LINUX390
v LINUXIA64
v LINUXPPC
v LINUXPPC64
v LINUXX8664
v LINUXZ64
v MAC
v MVS_DRDA
v NT
v NT64
v OS2
v OS390
v SCO
v SGI
v SNI
v SUN
v SUN64
v UNKNOWN
v UNKNOWN_DRDA
v VM_DRDA
v VSE_DRDA
v WINDOWS
DB_LOCATION
VARCHAR(12)
db_location - Database location. This

v LOCAL
v REMOTE
DB_CONN_TIME
TIMESTAMP
db_conn_time - Database activation

timestamp
LAST_RESET
TIMESTAMP
LAST_BACKUP
TIMESTAMP
last_backup - Last backup timestamp
1284
element
Column name
Data type
CONNECTIONS_TOP
BIGINT
connections_top - Maximum number of

concurrent connections
TOTAL_CONS
BIGINT
total_cons - Connects since database

activation
TOTAL_SEC_CONS
BIGINT
total_sec_cons - Secondary connections
APPLS_CUR_CONS
BIGINT
appls_cur_cons - Applications connected

currently
APPLS_IN_DB2
BIGINT
appls_in_db2 - Applications executing in the

database currently
NUM_ASSOC_AGENTS
BIGINT
num_assoc_agents - Number of associated

agents
AGENTS_TOP
BIGINT
agents_top - Number of agents created
COORD_AGENTS_TOP
BIGINT
coord_agents_top - Maximum number of

coordinating agents
LOCKS_HELD
BIGINT
LOCK_WAITS
BIGINT
LOCK_WAIT_TIME
BIGINT
LOCK_LIST_IN_USE
BIGINT
lock_list_in_use - Total lock list memory in

use
DEADLOCKS
BIGINT
LOCK_ESCALS
BIGINT
X_LOCK_ESCALS
BIGINT
x_lock_escals - Exclusive lock escalations
LOCKS_WAITING
BIGINT
locks_waiting - Current agents waiting on

locks
LOCK_TIMEOUTS
BIGINT
NUM_INDOUBT_TRANS
BIGINT
num_indoubt_trans - Number of indoubt

transactions
SORT_HEAP_ALLOCATED
BIGINT
sort_heap_allocated - Total sort heap

allocated
BIGINT
sort_shrheap_allocated - Sort share heap

currently allocated
SORT_SHRHEAP_TOP
BIGINT
sort_shrheap_top - Sort share heap high

water mark
BIGINT

threshold sorts
TOTAL_SORTS
BIGINT
TOTAL_SORT_TIME
BIGINT
SORT_OVERFLOWS
BIGINT
ACTIVE_SORTS
BIGINT
active_sorts - Active sorts
POOL_DATA_L_READS
BIGINT

reads
POOL_DATA_P_READS
BIGINT

physical reads
1285
element
Column name
Data type
BIGINT

BIGINT

BIGINT

POOL_DATA_WRITES
BIGINT
BIGINT

POOL_INDEX_L_READS
BIGINT

logical reads
POOL_INDEX_P_READS
BIGINT

physical reads
BIGINT

BIGINT

BIGINT

POOL_INDEX_WRITES
BIGINT
BIGINT

POOL_XDA_P_READS
BIGINT

Physical Reads
POOL_XDA_L_READS
BIGINT

Logical Reads
POOL_XDA_WRITES
BIGINT
pool_xda_writes - Buffer Pool XDA Data

Writes
BIGINT
pool_async_xda_reads - Buffer Pool

Asynchronous XDA Data Reads
BIGINT
pool_async_xda_writes - Buffer Pool

Asynchronous XDA Data Writes
BIGINT

monitor element
BIGINT

POOL_READ_TIME
BIGINT

read time
POOL_WRITE_TIME
BIGINT

write time
BIGINT

BIGINT

1286
element
Column name
Data type
POOL_ASYNC_DATA_
READ_REQS
BIGINT

BIGINT

BIGINT
pool_async_xda_read_reqs - Buffer Pool

Asynchronous XDA Read Requests
BIGINT
pool_no_victim_buffer - Buffer pool no

victim buffers
POOL_LSN_GAP_CLNS
BIGINT

cleaners triggered
BIGINT
pool_drty_pg_steal_clns - Buffer pool victim

page cleaners triggered
BIGINT
pool_drty_pg_thrsh_clns - Buffer pool

threshold cleaners triggered
PREFETCH_WAIT_TIME
BIGINT

prefetch
BIGINT
unread_prefetch_pages - Unread prefetch

pages
DIRECT_READS
BIGINT
DIRECT_WRITES
BIGINT
DIRECT_READ_REQS
BIGINT
DIRECT_WRITE_REQS
BIGINT
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT
FILES_CLOSED
BIGINT
ELAPSED_EXEC_TIME_S
BIGINT
elapsed_exec_time - Statement execution

elapsed time
BIGINT

elapsed time
COMMIT_SQL_STMTS
BIGINT
commit_sql_stmts - Commit statements

attempted
ROLLBACK_SQL_STMTS
BIGINT
rollback_sql_stmts - Rollback statements

attempted
DYNAMIC_SQL_STMTS
BIGINT

STATIC_SQL_STMTS
BIGINT
static_sql_stmts - Static SQL statements

attempted
FAILED_SQL_STMTS
BIGINT
failed_sql_stmts - Failed statement operations
SELECT_SQL_STMTS
BIGINT
select_sql_stmts - Select SQL statements

executed
UID_SQL_STMTS
BIGINT
uid_sql_stmts - UPDATE/INSERT/DELETE
SQL statements executed
DDL_SQL_STMTS
BIGINT
ddl_sql_stmts - Data definition language

(DDL) SQL statements
INT_AUTO_REBINDS
BIGINT
int_auto_rebinds - Internal automatic rebinds

1287
Column name
Data type

element
INT_ROWS_DELETED
BIGINT
INT_ROWS_INSERTED
BIGINT
INT_ROWS_UPDATED
BIGINT
INT_COMMITS
BIGINT
INT_ROLLBACKS
BIGINT
BIGINT
int_deadlock_rollbacks - Internal rollbacks

due to deadlock
ROWS_DELETED
BIGINT
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
ROWS_SELECTED
BIGINT
ROWS_READ
BIGINT
BINDS_PRECOMPILES
BIGINT
binds_precompiles - Binds/precompiles
attempted
TOTAL_LOG_AVAILABLE
BIGINT
total_log_available - Total log available
TOTAL_LOG_USED
BIGINT
total_log_used - Total log space used
SEC_LOG_USED_TOP
BIGINT
sec_log_used_top - Maximum secondary log

space used
TOT_LOG_USED_TOP
BIGINT
tot_log_used_top - Maximum total log space

used
SEC_LOGS_ALLOCATED
BIGINT
sec_logs_allocated - Secondary logs allocated

currently
LOG_READS
BIGINT
log_reads - Number of log pages read
LOG_READ_TIME_S
BIGINT
log_read_time - Log read time
LOG_READ_TIME_NS
BIGINT
LOG_WRITES
BIGINT
log_writes - Number of log pages written
LOG_WRITE_TIME_S
BIGINT
log_write_time - Log write time
LOG_WRITE_TIME_NS
BIGINT
NUM_LOG_WRITE_IO
BIGINT
num_log_write_io - Number of log writes
NUM_LOG_READ_IO
BIGINT
num_log_read_io - Number of log reads
BIGINT
num_log_part_page_io - Number of partial

log page writes
NUM_LOG_BUFFER_FULL
BIGINT
num_log_buffer_full - Number of full log

buffers
NUM_LOG_DATA_FOUND_IN_BUFFER
BIGINT
num_log_data_found_in_buffer - Number of
log data found in buffer
APPL_ID_OLDEST_XACT
BIGINT
appl_id_oldest_xact - Application with oldest

transaction
LOG_TO_REDO_FOR_RECOVERY
BIGINT
log_to_redo_for_recovery - Amount of log to

be redone for recovery
LOG_HELD_BY_DIRTY_PAGES
BIGINT
log_held_by_dirty_pages - Amount of log

space accounted for by dirty pages
1288
Column name
Data type

element
PKG_CACHE_LOOKUPS
BIGINT
PKG_CACHE_INSERTS
BIGINT
BIGINT
pkg_cache_num_overflows - Package cache

overflows
PKG_CACHE_SIZE_TOP
BIGINT
pkg_cache_size_top - Package cache high

water mark
BIGINT
appl_section_lookups - Section lookups
BIGINT
appl_section_inserts - Section inserts
CAT_CACHE_LOOKUPS
BIGINT
CAT_CACHE_INSERTS
BIGINT
CAT_CACHE_OVERFLOWS
BIGINT
cat_cache_overflows - Catalog cache

overflows
CAT_CACHE_SIZE_TOP
BIGINT
cat_cache_size_top - Catalog cache high

water mark
PRIV_WORKSPACE_SIZE_TOP
BIGINT
priv_workspace_size_top - Maximum private

workspace size
PRIV_WORKSPACE_NUM_OVERFLOWS
BIGINT
priv_workspace_num_overflows - Private
workspace overflows
PRIV_WORKSPACE_SECTION_INSERTS
BIGINT
priv_workspace_section_inserts - Private
workspace section inserts
PRIV_WORKSPACE_SECTION_LOOKUPS
BIGINT
priv_workspace_section_lookups - Private
workspace section lookups
SHR_WORKSPACE_SIZE_TOP
BIGINT
shr_workspace_size_top - Maximum shared

workspace size
SHR_WORKSPACE_NUM_OVERFLOWS
BIGINT
shr_workspace_num_overflows - Shared
workspace overflows
SHR_WORKSPACE_SECTION_INSERTS
BIGINT
shr_workspace_section_inserts - Shared
SHR_WORKSPACE_SECTION_LOOKUPS
BIGINT
shr_workspace_section_lookups - Shared
TOTAL_HASH_JOINS
BIGINT
TOTAL_HASH_LOOPS
BIGINT
HASH_JOIN_OVERFLOWS
BIGINT
hash_join_overflows - Hash join overflows
BIGINT
hash_join_small_overflows - Hash join small

overflows
BIGINT
threshold hash joins
ACTIVE_HASH_JOINS
BIGINT
active_hash_joins - Active hash joins
NUM_DB_STORAGE_PATHS
BIGINT
num_db_storage_paths - Number of
automatic storage paths
DBPARTITIONNUM
SMALLINT

monitor element
SMALLEST_LOG_AVAIL_NODE
INTEGER
smallest_log_avail_node - Node with least

available log space
1289
Column name
Data type

element
TOTAL_OLAP_FUNCS
BIGINT
total_olap_funcs - Total OLAP functions
OLAP_FUNC_OVERFLOWS
BIGINT
olap_func_overflows - OLAP function

overflows
ACTIVE_OLAP_FUNCS
BIGINT
active_olap_funcs - Active OLAP functions
STATS_CACHE_SIZE
BIGINT
STATS_FABRICATIONS
BIGINT
stats_fabrications - Total number of statistics

fabrications
SYNC_RUNSTATS
BIGINT
sync_runstats - Total number of synchronous

RUNSTATS activities
ASYNC_RUNSTATS
BIGINT
async_runstats - Total number of

asynchronous RUNSTATS requests
BIGINT
stats_fabricate_time - Total time spent on

statistics fabrication activities
SYNC_RUNSTATS_TIME
BIGINT
sync_runstats_time - Total time spent on

synchronous RUNSTATS activities
NUM_THRESHOLD_VIOLATIONS
BIGINT
num_threshold_violations - Number of
threshold violations
MEMBER
SMALLINT
SNAPDB_MEMORY_POOL administrative view and

SNAP_GET_DB_MEMORY_POOL table function - Retrieve
database level memory usage information
The SNAPDB_MEMORY_POOL administrative view and the
SNAP_GET_DB_MEMORY_POOL table function return information about memory
usage at the database level for UNIX platforms only.
Important: Starting in Version 9.7 Fix Pack 5, the SNAPDB_MEMORY_POOL
administrative view and SNAP_GET_DB_MEMORY_POOL table function have
been deprecated and replaced by the MON_GET_MEMORY_POOL - get
v SNAPDB_MEMORY_POOL administrative view
v SNAP_GET_DB_MEMORY_POOL table function on page 1292
SNAPDB_MEMORY_POOL administrative view

This administrative view allows you to retrieve database level memory usage
1290
Used with the MON_GET_DATABASE, MON_GET_TRANSACTION_LOG,

MON_GET_HADR, and ADMIN_GET_STORAGE_PATHS table functions, the
SNAPDB_MEMORY_POOL administrative view provides information equivalent
to the GET SNAPSHOT FOR DATABASE ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPDB_MEMORY_POOL administrative view
v CONTROL privilege on the SNAPDB_MEMORY_POOL administrative view
v EXECUTE privilege on the SNAP_GET_DB_MEMORY_POOL table function
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a list of memory pools and their current size for the currently connected
database, SAMPLE.
SELECT POOL_ID, POOL_CUR_SIZE FROM SYSIBMADM.SNAPDB_MEMORY_POOL

POOL_ID
POOL_CUR_SIZE
------------- -------------------UTILITY
32768
PACKAGE_CACHE
475136
CAT_CACHE
65536
BP
2097152
BP
1081344
BP
540672
BP
278528
BP
147456
BP
81920
LOCK_MGR
294912
DATABASE
3833856
OTHER
0
1291
SNAP_GET_DB_MEMORY_POOL table function

The SNAP_GET_DB_MEMORY_POOL table function returns the same information
as the SNAPDB_MEMORY_POOL administrative view, but allows you to retrieve
the information for a specific database on a specific database member, aggregate of
all database members or all database members.
Used with the SNAP_GET_DB, SNAP_GET_DETAILLOG, SNAP_GET_HADR and
ADMIN_GET_STORAGE_PATHS table functions, the
SNAP_GET_DB_MEMORY_POOL table function provides information equivalent
to the GET SNAPSHOT FOR ALL DATABASES CLP command.
returned.
Syntax
SNAP_GET_DB_MEMORY_POOL (
dbname
, member

dbname
member
SNAP_GET_DB_MEMORY_POOL table function takes a snapshot for the currently
Authorization
1292

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, POOL_ID, POOL_CUR_SIZE
FROM TABLE(SNAPSHOT_GET_DB_MEMORY_POOL
(CAST(NULL AS VARCHAR(128)), -1)) AS T

DB_NAME
-------TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
POOL_ID
POOL_CUR_SIZE
-------------- -------------------UTILITY
65536
PACKAGE_CACHE
851968
CAT_CACHE
65536
BP
35913728
BP
589824
BP
327680
BP
196608
BP
131072
SHARED_SORT
65536
LOCK_MGR
10092544
DATABASE
4980736
OTHER
196608
UTILITY
65536
PACKAGE_CACHE
655360
CAT_CACHE
131072
BP
4325376
BP
589824
BP
327680
BP
196608
BP
131072
SHARED_SORT
0
LOCK_MGR
655360
DATABASE
4653056
OTHER
196608
Table 313. Information returned by the SNAPDB_MEMORY_POOL administrative view and
the SNAP_GET_DB_MEMORY_POOL table function
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
1293

the SNAP_GET_DB_MEMORY_POOL table function (continued)
Column name
Data type
POOL_ID
VARCHAR(14)
monitor element
v APP_GROUP
v APPL_CONTROL
v APPLICATION
v BP
v CAT_CACHE
v DATABASE
v DFM
v FCMBP
v IMPORT_POOL
v LOCK_MGR
v MONITOR
v OTHER
v PACKAGE_CACHE
v QUERY
v SHARED_SORT
v SORT
v STATEMENT
v STATISTICS
v UTILITY
POOL_SECONDARY_ID
VARCHAR(32)
pool_secondary_id - Memory pool

secondary identifier
POOL_CUR_SIZE
BIGINT

memory pool
POOL_WATERMARK
BIGINT

watermark
POOL_CONFIG_SIZE
BIGINT

of memory pool
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAP_GET_DB_V97 table function - Retrieve snapshot

information from the dbase logical group
The SNAP_GET_DB_V97 table function returns snapshot information from the
database (dbase) logical group.
Important: The SNAP_GET_DB_V97 table function is deprecated and has been
replaced by the MON_GET_DATABASE table function - Get database level
information on page 570 and MON_GET_TRANSACTION_LOG table function Get log information on page 751.
1294
Syntax
SNAP_GET_DB_V97 (
dbname
, member

dbname
member
SNAP_GET_DB_V97 table function takes a snapshot for the currently connected
Authorization
v EXECUTE privilege on the SNAP_GET_DB_V97 table function
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1295
Examples
DB_LOCATION, DB_CONN_TIME FROM TABLE(SNAP_GET_DB_V97(, -2)) AS T

DB_NAME
DB_STATUS
SERVER_PLATFORM ...
-------...- ---------... --------------- ...
SAMPLE
ACTIVE
AIX64
...

... ------------ -------------------------... LOCAL
2005-07-24-22.09.22.013196
FROM TABLE(SNAP_GET_DB_V97(CAST (NULL AS VARCHAR(128)), -2)) AS T

DB_NAME
--------...TOOLSDB
SAMPLE
DB_STATUS
---------...
ACTIVE
ACTIVE
SERVER_PLATFORM
--------------AIX64
AIX64
...
...
...
...

...
...
...
...
DB_LOCATION
-----------LOCAL
LOCAL
DB_CONN_TIME
-------------------------2005-07-24-22.26.54.396335
2005-07-24-22.09.22.013196
FROM TABLE (SNAP_GET_DB_V97(, 0)) AS T
TOTAL_OLAP_FUNCS
---------------7
-------------------- -------------------2
1
table function.
FROM TABLE (SNAP_GET_DB_V97(mytestdb, -1)) AS SNAPDB
1296
---------------- ------------------ ------------- -------------- ...

200
1
2
0 ...
Continued
...-------------------...
2
SYNC_RUNSTATS_TIME
-----------------32
Example 5: The following example shows how you can use the
SNAP_GET_DB_V97 table function to determine the status of a database:
SELECT SUBSTR
FROM table(SNAP_GET_DB_V97(hadrdb, 0))
DB_NAME
DB_STATUS
-------------------- ---------------HADRDB
ACTIVE_STANDBY
Table 314. Information returned by the SNAP_GET_DB_V97 table function
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
DB_NAME
VARCHAR(128)
DB_PATH
VARCHAR(1024)
INPUT_DB_ALIAS
VARCHAR(128)
DB_STATUS
VARCHAR(16)

v ACTIVE
v QUIESCE_PEND
v QUIESCED
v ROLLFWD
v ACTIVE_STANDBY - the HADR database
is in a standby mode with reads on
standby enabled.
enabled).
CATALOG_PARTITION
SMALLINT
catalog_node - Catalog node number
VARCHAR(128)
catalog_node_name - Catalog node network

name
1297
Table 314. Information returned by the SNAP_GET_DB_V97 table function (continued)

Column name
Data type
SERVER_PLATFORM
VARCHAR(12)

element
v AIX
v AIX64
v AS400_DRDA
v DOS
v DYNIX
v HP
v HP64
v HPIA
v HPIA64
v LINUX
v LINUX390
v LINUXIA64
v LINUXPPC
v LINUXPPC64
v LINUXX8664
v LINUXZ64
v MAC
v MVS_DRDA
v NT
v NT64
v OS2
v OS390
v SCO
v SGI
v SNI
v SUN
v SUN64
v UNKNOWN
v UNKNOWN_DRDA
v VM_DRDA
v VSE_DRDA
v WINDOWS
DB_LOCATION
VARCHAR(12)

v LOCAL
v REMOTE
DB_CONN_TIME
TIMESTAMP

timestamp
LAST_RESET
TIMESTAMP
LAST_BACKUP
TIMESTAMP
1298

element
Column name
Data type
CONNECTIONS_TOP
BIGINT

TOTAL_CONS
BIGINT

activation
TOTAL_SEC_CONS
BIGINT
APPLS_CUR_CONS
BIGINT

currently
APPLS_IN_DB2
BIGINT

database currently
NUM_ASSOC_AGENTS
BIGINT

agents
AGENTS_TOP
BIGINT
COORD_AGENTS_TOP
BIGINT

coordinating agents
LOCKS_HELD
BIGINT
LOCK_WAITS
BIGINT
LOCK_WAIT_TIME
BIGINT
LOCK_LIST_IN_USE
BIGINT

use
DEADLOCKS
BIGINT
LOCK_ESCALS
BIGINT
X_LOCK_ESCALS
BIGINT
LOCKS_WAITING
BIGINT

locks
LOCK_TIMEOUTS
BIGINT
NUM_INDOUBT_TRANS
BIGINT

transactions
SORT_HEAP_ALLOCATED
BIGINT

allocated
BIGINT

currently allocated
SORT_SHRHEAP_TOP
BIGINT

water mark
BIGINT

threshold sorts
TOTAL_SORTS
BIGINT
TOTAL_SORT_TIME
BIGINT
SORT_OVERFLOWS
BIGINT
ACTIVE_SORTS
BIGINT
POOL_DATA_L_READS
BIGINT

reads
POOL_DATA_P_READS
BIGINT

physical reads
1299

element
Column name
Data type
BIGINT

BIGINT

BIGINT

POOL_DATA_WRITES
BIGINT
BIGINT

POOL_INDEX_L_READS
BIGINT

logical reads
POOL_INDEX_P_READS
BIGINT

physical reads
BIGINT

BIGINT

BIGINT

POOL_INDEX_WRITES
BIGINT
BIGINT

POOL_XDA_P_READS
BIGINT

Physical Reads
POOL_XDA_L_READS
BIGINT

Logical Reads
POOL_XDA_WRITES
BIGINT

Writes
BIGINT

BIGINT

BIGINT

monitor element
BIGINT

POOL_READ_TIME
BIGINT

read time
POOL_WRITE_TIME
BIGINT

write time
BIGINT

BIGINT

1300

element
Column name
Data type
POOL_ASYNC_DATA_
READ_REQS
BIGINT

POOL_ASYNC_INDEX_
READ_REQS
BIGINT

POOL_ASYNC_XDA_
READ_REQS
BIGINT

BIGINT

victim buffers
POOL_LSN_GAP_CLNS
BIGINT

cleaners triggered
BIGINT

BIGINT

PREFETCH_WAIT_TIME
BIGINT

prefetch
BIGINT

pages
DIRECT_READS
BIGINT
DIRECT_WRITES
BIGINT
DIRECT_READ_REQS
BIGINT
DIRECT_WRITE_REQS
BIGINT
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT
FILES_CLOSED
BIGINT
ELAPSED_EXEC_TIME_S
BIGINT

elapsed time
BIGINT

elapsed time
COMMIT_SQL_STMTS
BIGINT

attempted
ROLLBACK_SQL_STMTS
BIGINT

attempted
DYNAMIC_SQL_STMTS
BIGINT

STATIC_SQL_STMTS
BIGINT

attempted
FAILED_SQL_STMTS
BIGINT
SELECT_SQL_STMTS
BIGINT

executed
UID_SQL_STMTS
BIGINT
DDL_SQL_STMTS
BIGINT

INT_AUTO_REBINDS
BIGINT

1301

Column name
Data type

element
INT_ROWS_DELETED
BIGINT
INT_ROWS_INSERTED
BIGINT
INT_ROWS_UPDATED
BIGINT
INT_COMMITS
BIGINT
INT_ROLLBACKS
BIGINT
BIGINT

due to deadlock
ROWS_DELETED
BIGINT
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
ROWS_SELECTED
BIGINT
ROWS_READ
BIGINT
BINDS_PRECOMPILES
BIGINT
attempted
TOTAL_LOG_AVAILABLE
BIGINT
TOTAL_LOG_USED
BIGINT
SEC_LOG_USED_TOP
BIGINT

space used
TOT_LOG_USED_TOP
BIGINT

used
SEC_LOGS_ALLOCATED
BIGINT

currently
LOG_READS
BIGINT
LOG_READ_TIME_S
BIGINT
LOG_READ_TIME_NS
BIGINT
LOG_WRITES
BIGINT
LOG_WRITE_TIME_S
BIGINT
LOG_WRITE_TIME_NS
BIGINT
NUM_LOG_WRITE_IO
BIGINT
NUM_LOG_READ_IO
BIGINT
BIGINT

log page writes
NUM_LOG_BUFFER_FULL
BIGINT

buffers
NUM_LOG_DATA_FOUND_
IN_BUFFER
BIGINT
APPL_ID_OLDEST_XACT
BIGINT

transaction
LOG_TO_REDO_FOR_
RECOVERY
BIGINT

BIGINT

1302

Column name
Data type

element
PKG_CACHE_LOOKUPS
BIGINT
PKG_CACHE_INSERTS
BIGINT
PKG_CACHE_NUM_
OVERFLOWS
BIGINT

overflows
PKG_CACHE_SIZE_TOP
BIGINT

water mark
BIGINT
BIGINT
CAT_CACHE_LOOKUPS
BIGINT
CAT_CACHE_INSERTS
BIGINT
CAT_CACHE_OVERFLOWS
BIGINT

overflows
CAT_CACHE_SIZE_TOP
BIGINT

water mark
BIGINT

workspace size
PRIV_WORKSPACE_NUM_
OVERFLOWS
BIGINT
workspace overflows
INSERTS
BIGINT
LOOKUPS
BIGINT
BIGINT

workspace size
SHR_WORKSPACE_NUM_
OVERFLOWS
BIGINT
workspace overflows
INSERTS
BIGINT
LOOKUPS
BIGINT
TOTAL_HASH_JOINS
BIGINT
TOTAL_HASH_LOOPS
BIGINT
HASH_JOIN_OVERFLOWS
BIGINT
HASH_JOIN_SMALL_
OVERFLOWS
BIGINT

overflows
POST_SHRTHRESHOLD_
HASH_JOINS
BIGINT
ACTIVE_HASH_JOINS
BIGINT
BIGINT
DBPARTITIONNUM
SMALLINT

monitor element
SMALLEST_LOG_AVAIL_
NODE
INTEGER

available log space
1303

Column name
Data type

element
TOTAL_OLAP_FUNCS
BIGINT
OLAP_FUNC_OVERFLOWS
BIGINT

overflows
ACTIVE_OLAP_FUNCS
BIGINT
STATS_CACHE_SIZE
BIGINT
stats_cache_size Size of statistics cache
STATS_FABRICATIONS
BIGINT
stats_fabrications Total number of statistics

fabrications
SYNC_RUNSTATS
BIGINT
sync_runstats Total number of synchronous

RUNSTATS activities
ASYNC_RUNSTATS
BIGINT
async_runstats Total number of

BIGINT
stats_fabricate_time Total time spent on

SYNC_RUNSTATS_TIME
BIGINT
sync_runstats_time Total time spent on

BIGINT
SNAPDBM administrative view and SNAP_GET_DBM table

function - Retrieve the dbm logical grouping snapshot
information
The SNAPDBM administrative view and the SNAP_GET_DBM table function
return the snapshot monitor DB2 database manager (dbm) logical grouping
information.
Important: The SNAPDBM administrative view and SNAP_GET_DBM table
function are deprecated and have been replaced by the MON_GET_INSTANCE
table function - Get instance level information on page 617.
v SNAPDBM administrative view
v SNAP_GET_DBM table function on page 1306
SNAPDBM administrative view

Used with the SNAPSWITCHES administrative view and the MON_GET_FCM,
MON_GET_MEMORY_SET, MON_GET_MEMORY_POOL table functions, the
SNAPDBM administrative view provides the data equivalent to the GET SNAPSHOT
FOR DBM command.
returned.
1304
Authorization
v SELECT privilege on the SNAPDBM administrative view
v CONTROL privilege on the SNAPDBM administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_DBM table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve database manager status and connection information for all database
members.
SELECT DB2_STATUS, DB2START_TIME, LAST_RESET, LOCAL_CONS, REM_CONS_IN,
(AGENTS_CREATED_EMPTY_POOL/AGENTS_FROM_POOL) AS AGENT_USAGE,
DBPARTITIONNUM FROM SYSIBMADM.SNAPDBM ORDER BY DBPARTITIONNUM

DB2_STATUS
-----------ACTIVE
ACTIVE
ACTIVE
DB2START_TIME
LAST_RESET
-------------------------- ----------...2006-01-06-14.59.59.059879
2006-01-06-14.59.59.097605
2006-01-06-14.59.59.062798
-
...
...
...
...
...
...

... LOCAL_CONS
REM_CONS_IN
AGENT_USAGE
DBPARTITIONNUM
... ----------...- -----------...- -----------...- -------------...
1
1
0
0
...
0
0
0
1
...
0
0
0
2
1305
SNAP_GET_DBM table function

The SNAP_GET_DBM table function returns the same information as the
SNAPDBM administrative view, but allows you to retrieve the information for a
specific database member, aggregate of all database members or all database
members.
Used with the SNAP_GET_DBM_MEMORY_POOL, SNAP_GET_FCM,
SNAP_GET_FCM_PART and SNAP_GET_SWITCHES table functions, the
SNAP_GET_DBM table function provides the data equivalent to the GET SNAPSHOT
FOR DBM command.
returned.
Syntax
SNAP_GET_DBM (
member

member
applications.
SNAP_GET_DBM table function calls the snapshot from memory.
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM
1306

Example
Retrieve the start time and current status of database member number 2.
SELECT DB2START_TIME, DB2_STATUS FROM TABLE(SNAP_GET_DBM(2)) AS T

DB2START_TIME
DB2_STATUS
-------------------------- -----------2006-01-06-14.59.59.062798 ACTIVE
Table 315. Information returned by the SNAPDBM administrative view and the SNAP_GET_DBM table function
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
SORT_HEAP_ALLOCATED
BIGINT

allocated
BIGINT
PIPED_SORTS_REQUESTED
BIGINT
piped_sorts_requested - Piped sorts

requested
PIPED_SORTS_ACCEPTED
BIGINT
piped_sorts_accepted - Piped sorts accepted
REM_CONS_IN
BIGINT
rem_cons_in - Remote connections to

database manager
REM_CONS_IN_EXEC
BIGINT
rem_cons_in_exec - Remote Connections

Executing in the Database Manager monitor
element
LOCAL_CONS
BIGINT
local_cons - Local connections
LOCAL_CONS_IN_EXEC
BIGINT
local_cons_in_exec - Local Connections

element
CON_LOCAL_DBASES
BIGINT
con_local_dbases - Local databases with

current connects
AGENTS_REGISTERED
BIGINT
agents_registered - Agents registered
AGENTS_WAITING_ON_TOKEN
BIGINT
agents_waiting_on_token - Agents waiting

for a token
DB2_STATUS
VARCHAR(12)
db2_status - Status of DB2 instance

v ACTIVE
v QUIESCE_PEND
v QUIESCED
AGENTS_REGISTERED_TOP
BIGINT
agents_registered_top - Maximum number

of agents registered
1307
Table 315. Information returned by the SNAPDBM administrative view and the SNAP_GET_DBM table
element
Column name
Data type
AGENTS_WAITING_TOP
BIGINT
agents_waiting_top - Maximum number of

agents waiting
COMM_PRIVATE_MEM
BIGINT
comm_private_mem - Committed private

memory
IDLE_AGENTS
BIGINT
idle_agents - Number of idle agents
AGENTS_FROM_POOL
BIGINT
agents_from_pool - Agents assigned from

pool
AGENTS_CREATED_EMPTY_POOL
BIGINT
agents_created_empty_pool - Agents
created due to empty agent pool
COORD_AGENTS_TOP
BIGINT

coordinating agents
MAX_AGENT_OVERFLOWS
BIGINT
max_agent_overflows - Maximum agent

overflows
AGENTS_STOLEN
BIGINT
GW_TOTAL_CONS
BIGINT
gw_total_cons - Total number of attempted

connections for DB2 Connect
GW_CUR_CONS
BIGINT
gw_cur_cons - Current number of

GW_CONS_WAIT_HOST
BIGINT
gw_cons_wait_host - Number of
connections waiting for the host to reply
GW_CONS_WAIT_CLIENT
BIGINT
gw_cons_wait_client - Number of
connections waiting for the client to send
request
POST_THRESHOLD_ HASH_JOINS
BIGINT
post_threshold_hash_joins - Hash join

threshold
NUM_GW_CONN_SWITCHES
BIGINT
num_gw_conn_switches - Connection
switches
DB2START_TIME
TIMESTAMP
db2start_time - Start database manager

timestamp
LAST_RESET
TIMESTAMP
NUM_NODES_IN_ DB2_INSTANCE
INTEGER
num_nodes_in_db2_instance - Number of
nodes in database partition
PRODUCT_NAME
VARCHAR(32)
product_name - Product name
SERVICE_LEVEL
VARCHAR(18)
service_level - Service level
SORT_HEAP_TOP
BIGINT
sort_heap_top - Sort private heap high

water mark
DBPARTITIONNUM
SMALLINT

BIGINT

threshold
MEMBER
SMALLINT

element
1308
SNAPDBM_MEMORY_POOL administrative view and

SNAP_GET_DBM_MEMORY_POOL table function - Retrieve
database manager level memory usage information
The SNAPDBM_MEMORY_POOL administrative view and the
SNAP_GET_DBM_MEMORY_POOL table function return information about
memory usage at the database manager.
Important: Starting in Version 9.7 Fix Pack 5, the SNAPDBM_MEMORY_POOL
administrative view and SNAP_GET_DBM_MEMORY_POOL table function have
v SNAPDBM_MEMORY_POOL administrative view
v SNAP_GET_DBM_MEMORY_POOL table function on page 1310
SNAPDBM_MEMORY_POOL administrative view

MON_GET_INSTANCE, MON_GET_MEMORY_SET, and
MON_GET_MEMORY_POOL table functions, the SNAPDBM_MEMORY_POOL
administrative view provides the data equivalent to the GET SNAPSHOT FOR DBM
command.
returned.
Authorization
v SELECT privilege on the SNAPDBM_MEMORY_POOL administrative view
v CONTROL privilege on the SNAPDBM_MEMORY_POOL administrative view
v EXECUTE privilege on the SNAP_GET_DBM_MEMORY_POOL table function
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM
1309

Example
Retrieve a list of the memory pools and their current size for the database manager
of the connected database.
SELECT POOL_ID, POOL_CUR_SIZE FROM SNAPDBM_MEMORY_POOL

POOL_ID
POOL_CUR_SIZE
-------------- -------------------MONITOR
65536
OTHER
29622272
FCMBP
57606144
...
SNAP_GET_DBM_MEMORY_POOL table function

The SNAP_GET_DBM_MEMORY_POOL table function returns the same
information as the SNAPDBM_MEMORY_POOL administrative view, but allows
you to retrieve the information for a specific database member, aggregate of all
Used with the SNAP_GET_DBM, SNAP_GET_FCM, SNAP_GET_FCM_PART and
SNAP_GET_SWITCHES table functions, the SNAP_GET_DBM_MEMORY_POOL
table function provides the data equivalent to the GET SNAPSHOT FOR DBM command.
returned.
Syntax
SNAP_GET_DBM_MEMORY_POOL (
member

member
applications.
SNAP_GET_DBM_MEMORY_POOL table function takes a snapshot for the
1310
Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve a list of the memory pools and their current size for all database partitions
of the database manager of the connected database.
SELECT POOL_ID, POOL_CUR_SIZE, DBPARTITIONNUM
FROM TABLE(SYSPROC.SNAP_GET_DBM_MEMORY_POOL())
AS T ORDER BY DBPARTITIONNUM

POOL_ID
POOL_CUR_SIZE
DBPARTITIONNUM
-------------- -------------------- -------------MONITOR
65536
0
OTHER
29622272
0
FCMBP
57606144
0
MONITOR
65536
1
OTHER
29425664
1
FCMBP
57606144
1
MONITOR
65536
2
OTHER
29425664
2
FCMBP
57606144
2
Table 316. Information returned by the SNAPDBM_MEMORY_POOL administrative view
and the SNAP_GET_DBM_MEMORY_POOL table function
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
monitor element
snapshot was taken.
1311

and the SNAP_GET_DBM_MEMORY_POOL table function (continued)
Column name
Data type
POOL_ID
VARCHAR(14)
monitor element
v APP_GROUP
v APPL_CONTROL
v APPLICATION
v BP
v CAT_CACHE
v DATABASE
v DFM
v FCMBP
v IMPORT_POOL
v LOCK_MGR
v MONITOR
v OTHER
v PACKAGE_CACHE
v QUERY
v SHARED_SORT
v SORT
v STATEMENT
v STATISTICS
v UTILITY
POOL_CUR_SIZE
BIGINT

memory pool
POOL_WATERMARK
BIGINT

watermark
POOL_CONFIG_SIZE
BIGINT

of memory pool
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAP_GET_DBM_V95 table function - Retrieve the dbm

logical grouping snapshot information
The SNAP_GET_DBM_V95 table function returns the snapshot monitor DB2
database manager (dbm) logical grouping information.
Important: The SNAP_GET_DBM_V95 table function is deprecated and have been
replaced by the MON_GET_INSTANCE table function - Get instance level
returned.
1312
Syntax
SNAP_GET_DBM_V95 (
member

member
applications.
SNAP_GET_DBM_V95 table function calls the snapshot from memory.
Authorization
v EXECUTE privilege on the SNAP_GET_DBM_V95 table function
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
SELECT DB2START_TIME, DB2_STATUS FROM TABLE(SNAP_GET_DBM_V95(2)) AS T

DB2START_TIME
DB2_STATUS
-------------------------- -----------2006-01-06-14.59.59.062798 ACTIVE
1313
Table 317. Information returned by SNAP_GET_DBM_V95 table function
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
SORT_HEAP_ALLOCATED
BIGINT

allocated
BIGINT
BIGINT

requested
BIGINT
REM_CONS_IN
BIGINT

database manager
REM_CONS_IN_EXEC
BIGINT

element
LOCAL_CONS
BIGINT
LOCAL_CONS_IN_EXEC
BIGINT

element
CON_LOCAL_DBASES
BIGINT

current connects
AGENTS_REGISTERED
BIGINT
BIGINT

for a token
DB2_STATUS
VARCHAR(12)

v ACTIVE
v QUIESCE_PEND
v QUIESCED
BIGINT

AGENTS_WAITING_TOP
BIGINT

agents waiting
COMM_PRIVATE_MEM
BIGINT

memory
IDLE_AGENTS
BIGINT
AGENTS_FROM_POOL
BIGINT

pool
BIGINT
COORD_AGENTS_TOP
BIGINT

coordinating agents
MAX_AGENT_OVERFLOWS
BIGINT

overflows
AGENTS_STOLEN
BIGINT
1314
Table 317. Information returned by SNAP_GET_DBM_V95 table function (continued)

element
Column name
Data type
GW_TOTAL_CONS
BIGINT

GW_CUR_CONS
BIGINT

GW_CONS_WAIT_HOST
BIGINT
GW_CONS_WAIT_CLIENT
BIGINT
request
BIGINT

threshold
BIGINT
switches
DB2START_TIME
TIMESTAMP

timestamp
LAST_RESET
TIMESTAMP
INTEGER
PRODUCT_NAME
VARCHAR(32)
SERVICE_LEVEL
VARCHAR(18)
SORT_HEAP_TOP
BIGINT

water mark
DBPARTITIONNUM
SMALLINT

BIGINT

threshold

SNAP_GET_DETAILLOG table function - Retrieve snapshot
information from the detail_log logical data group
The SNAPDETAILLOG administrative view and the SNAP_GET_DETAILLOG
table function return snapshot information from the detail_log logical data group.
Important: The SNAPDETAILLOG administrative view and the
SNAP_GET_DETAILLOG table function are deprecated and have been replaced by
the MON_GET_TRANSACTION_LOG table function - Get log information on
page 751.
v SNAPDETAILLOG administrative view on page 1316
v SNAP_GET_DETAILLOG table function on page 1317
1315
SNAPDETAILLOG administrative view

detail_log logical data group for the currently connected database.
Used in conjunction with ADMIN_GET_STORAGE_PATHS,
MON_GET_DATABASE, MON_GET_HADR, MON_GET_MEMORY_POOL, and
MON_GET_MEMORY_SET table functions, the SNAPDETAILLOG administrative
view provides information equivalent to the GET SNAPSHOT FOR DATABASE on
Authorization
v SELECT privilege on the SNAPDETAILLOG administrative view
v CONTROL privilege on the SNAPDETAILLOG administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_DETAILLOG table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve log information for all database members for the currently connected
database.
SELECT SUBSTR(DB_NAME, 1, 8) AS DB_NAME, FIRST_ACTIVE_LOG,
LAST_ACTIVE_LOG, CURRENT_ACTIVE_LOG, CURRENT_ARCHIVE_LOG,
DBPARTITIONNUM
FROM SYSIBMADM.SNAPDETAILLOG ORDER BY DBPARTITIONNUM
1316
DB_NAME FIRST_ACTIVE_LOG
LAST_ACTIVE_LOG
-------- -------------------- -------------------TEST
0
8
TEST
0
8
TEST
0
8
...
...
...
...
...

... CURRENT_ACTIVE_LOG
CURRENT_ARCHIVE_LOG DBPARTITIONNUM
... -------------------- -------------------- -------------...
0
0
...
0
1
...
0
2
SNAP_GET_DETAILLOG table function

The SNAP_GET_DETAILLOG table function returns the same information as the
SNAPDETAILLOG administrative view.
Used in conjunction with ADMIN_GET_STORAGE_PATHS, MON_GET_HADR,
MON_GET_MEMORY_POOL, and SNAP_GET_DB, the SNAPDETAILLOG
administrative view provides information equivalent to the GET SNAPSHOT FOR ALL
DATABASES CLP command.
Syntax
SNAP_GET_DETAILLOG (
dbname
, member

dbname
member
1317
SNAP_GET_DETAILLOG table function takes a snapshot for the currently

Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve log information for database member 1 for the currently connected
database.
LAST_ACTIVE_LOG, CURRENT_ACTIVE_LOG, CURRENT_ARCHIVE_LOG
FROM TABLE(SNAP_GET_DETAILLOG(, 1)) AS T

LAST_ACTIVE_LOG
...
-------- -------------------- -------------------- ...
TEST
0
8 ...

CURRENT_ARCHIVE_LOG
... -------------------- -------------------...
0
-
Table 318. Information returned by the SNAPDETAILLOG administrative view and
1318
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
FIRST_ACTIVE_LOG
BIGINT
first_active_log - First active log

file number
LAST_ACTIVE_LOG
BIGINT
last_active_log - Last active log file

number

SNAP_GET_DETAILLOG table function (continued)
monitor element
Column name
Data type
CURRENT_ACTIVE_LOG
BIGINT
current_active_log - Current active

log file number
CURRENT_ARCHIVE_LOG
BIGINT
current_archive_log - Current
archive log file number
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAP_GET_DETAILLOG_V91 table function - Retrieve

snapshot information from the detail_log logical data group
The SNAP_GET_DETAILLOG_V91 table function returns snapshot information
from the detail_log logical data group.
751.
Syntax
SNAP_GET_DETAILLOG_V91 (
dbname
, dbpartitionnum

dbname
dbpartitionnum
1319
SNAP_GET_DETAILLOG_V91 table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v EXECUTE privilege on the SNAP_GET_DETAILLOG_V91 table function
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve log information for database partition 1 for the currently connected
database.
FROM TABLE(SNAP_GET_DETAILLOG_V91(, 1)) AS T

LAST_ACTIVE_LOG
...
-------- -------------------- -------------------- ...
TEST
0
8 ...

CURRENT_ARCHIVE_LOG
... -------------------- -------------------...
0
-
Table 319. Information returned by the SNAP_GET_DETAILLOG_V91 table function
1320
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
FIRST_ACTIVE_LOG
BIGINT

file number
Table 319. Information returned by the SNAP_GET_DETAILLOG_V91 table

monitor element
Column name
Data type
LAST_ACTIVE_LOG
BIGINT

number
CURRENT_ACTIVE_LOG
BIGINT

log file number
CURRENT_ARCHIVE_LOG
BIGINT
DBPARTITIONNUM
SMALLINT
SNAP_GET_DYN_SQL_V95 table function - Retrieve dynsql

logical group snapshot information
The SNAP_GET_DYN_SQL_V95 table function returns snapshot information from
the dynsql logical data group.
SNAP_GET_DYN_SQL table function on page 895.
returned.
Syntax
SNAP_GET_DYN_SQL_V95 (
dbname
, member

dbname
member
1321
SNAP_GET_DYN_SQL_V95 table function takes a snapshot for the currently

Authorization
v EXECUTE privilege on the SNAP_GET_DYN_SQL_V95 table function
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve a list of dynamic SQL run on the currently connected database member of
the currently connected database, ordered by the number of rows read.
AS STMT_TEXT FROM TABLE(SNAP_GET_DYN_SQL_V95(,-1)) as T
ORDER BY ROWS_READ

PREP_TIME_WORST
-------------------0
3
4
4
4
3
4
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...

... NUM_COMPILATIONS
... -------------------...
0
...
1
...
...
1
...
...
1
...
...
1
...
1322
STMT_TEXT
---------------------------------------...SET CURRENT LOCALE LC_CTYPE = en_US
select rows_read, rows_written,
substr(stmt_text, 1, 40) as
select * from table
(snap_get_dyn_sqlv9(,-1)) as t
select * from table
(snap_getdetaillog9(,-1)) as t
select * from table
(snap_get_hadr(,-1)) as t
...
...
...
...
1 select prep_time_worst, num_compilations,

substr(stmt_text,
1 select prep_time_worst, num_compilations,
substr(stmt_text,
function.
FROM TABLE (SNAP_GET_DYN_SQL_V95(mytestdb, -1))
AS SNAPDB
SYNC_RUNSTATS_TIME
---------------------- -----------------2
12
1
30

SYNC_RUNSTATS_TIME
---------------------- -----------------5
10
3
20
Table 320. Information returned by the SNAP_GET_DYN_SQL_V95 table function
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
NUM_EXECUTIONS
BIGINT
NUM_COMPILATIONS
BIGINT
PREP_TIME_WORST
BIGINT

preparation time
PREP_TIME_BEST
BIGINT

time
INT_ROWS_DELETED
BIGINT
INT_ROWS_INSERTED
BIGINT
INT_ROWS_UPDATED
BIGINT
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
STMT_SORTS
BIGINT
SORT_OVERFLOWS
BIGINT
TOTAL_SORT_TIME
BIGINT
POOL_DATA_L_READS
BIGINT

reads
POOL_DATA_P_READS
BIGINT

physical reads
BIGINT

1323
Table 320. Information returned by the SNAP_GET_DYN_SQL_V95 table function (continued)

element
Column name
Data type
BIGINT

POOL_INDEX_L_READS
BIGINT

logical reads
POOL_INDEX_P_READS
BIGINT

physical reads
BIGINT

BIGINT

POOL_XDA_L_READS
BIGINT

Logical Reads
POOL_XDA_P_READS
BIGINT

Physical Reads
BIGINT

BIGINT

monitor element
TOTAL_EXEC_TIME
BIGINT

TOTAL_EXEC_TIME_MS
BIGINT

TOTAL_USR_CPU_TIME
BIGINT

BIGINT

TOTAL_SYS_CPU_TIME
BIGINT

BIGINT

STMT_TEXT
CLOB(2 M)
DBPARTITIONNUM
SMALLINT

monitor element
BIGINT

SYNC_RUNSTATS_TIME
BIGINT

1324
SNAPFCM administrative view and SNAP_GET_FCM table

function - Retrieve the fcm logical data group snapshot
information
The SNAPFCM administrative view and the SNAP_GET_FCM table function
return information about the fast communication manager from a database
manager snapshot, in particular, the fcm logical data group.
Important: The SNAPFCM administrative view and the SNAP_GET_FCM table
function are deprecated and have been replaced by the MON_GET_FCM - Get
FCM metrics on page 599.
v SNAPFCM administrative view
v SNAP_GET_FCM table function on page 1326
SNAPFCM administrative view

Used with the SNAPSWITCHES administrative view an the MON_GET_FCM,
MON_GET_MEMORY_POOL table functions, the SNAPFCM administrative view
provides the data equivalent to the GET SNAPSHOT FOR DBM command.
returned.
Authorization
v SELECT privilege on the SNAPFCM administrative view
v CONTROL privilege on the SNAPFCM administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_FCM table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM
1325

Example
Retrieve information about the fast communication manager's message buffers on
all members.
SELECT BUFF_FREE, BUFF_FREE_BOTTOM, MEMBER
FROM SYSIBMADM.SNAPFCM ORDER BY MEMBER

BUFF_FREE
BUFF_FREE_BOTTOM
MEMBER
---------...---- -------------------- -------------5120
5100
0
5120
5100
1
5120
5100
2
SNAP_GET_FCM table function

The SNAP_GET_FCM table function returns the same information as the
SNAPFCM administrative view, but allows you to retrieve the information for a
members.
Used with the SNAP_GET_DBM, SNAP_GET_DBM_MEMORY_POOL,
SNAP_GET_FCM table function provides the data equivalent to the GET SNAPSHOT
FOR DBM command.
returned.
Syntax
SNAP_GET_FCM (
member

member
all active members. If dbname is not set to NULL and member is set to NULL,-1 is
set implicitly for member. If this input option is not used, data will be returned
from all active database members. An active database member is a member
where the database is available for connection and use by applications.
corresponding snapshot API request type does not exist, then the SNAP_GET_FCM
1326
table function takes a snapshot for the currently connected database and database
member.
Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
database member 1.
FROM TABLE(SYSPROC.SNAP_GET_FCM( 1 )) AS T

BUFF_FREE
BUFF_FREE_BOTTOM
MEMBER
-------------------- -------------------- -----5120
5100
1
Table 321. Information returned by the SNAPFCM administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
BUFF_FREE
BIGINT
buff_free - FCM buffers currently

free
BUFF_FREE_BOTTOM
BIGINT
buff_free_bottom - Minimum FCM

Buffers Free
CH_FREE
BIGINT
ch_free - Channels Currently Free
CH_FREE_BOTTOM
BIGINT
ch_free_bottom - Minimum
Channels Free
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
1327

SNAP_GET_FCM_PART table function - Retrieve the fcm_node
The SNAPFCM_PART administrative view and the SNAP_GET_FCM_PART table
function return information about the fast communication manager from a
database manager snapshot, in particular, the fcm_node logical data group.
Important: The SNAPFCM_PART administrative view and the
SNAP_GET_FCM_PART table function are deprecated and have been replaced by
the MON_GET_FCM - Get FCM metrics on page 599.
v SNAPFCM_PART administrative view
v SNAP_GET_FCM_PART table function on page 1329
SNAPFCM_PART administrative view

Used with he SNAPSWITCHES administrative view an the MON_GET_FCM,
MON_GET_MEMORY_POOL table functions, the SNAPFCM_PART administrative
view provides the data equivalent to the GET SNAPSHOT FOR DBM command.
returned.
Authorization
v SELECT privilege on the SNAPFCM_PART administrative view
v CONTROL privilege on the SNAPFCM_PART administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_FCM_PART table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM
1328

Example
Retrieve buffers sent and received information for the fast communication
manager.
SELECT CONNECTION_STATUS, TOTAL_BUFFERS_SENT, TOTAL_BUFFERS_RECEIVED
FROM SYSIBMADM.SNAPFCM_PART WHERE MEMBER = 0

CONNECTION_STATUS
TOTAL_BUFFERS_SENT
TOTAL_BUFFERS_RCVD
-------------------- -------------------- -------------------INACTIVE
2
1
SNAP_GET_FCM_PART table function

The SNAP_GET_FCM_PART table function returns the same information as the
SNAPFCM_PART administrative view, but allows you to retrieve the information
members.
SNAP_GET_FCM and SNAP_GET_SWITCHES table functions, the
SNAP_GET_FCM_PART table function provides the data equivalent to the GET
SNAPSHOT FOR DBM command.
returned.
Syntax
SNAP_GET_FCM_PART (
member

member
member number. Specify -1 for the current member. If this input option is not
used, data will be returned from all active database members. An active
database member is a member where the database is available for connection
and use by applications.
SNAP_GET_FCM_PART table function takes a snapshot for the currently connected
database and member.
1329
Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve buffers sent and received information for the fast communication manager
for all members.
SELECT FCM_MEMBER, TOTAL_BUFFERS_SENT, TOTAL_BUFFERS_RCVD,
MEMBER FROM TABLE(SNAP_GET_FCM_PART()) AS T
ORDER BY MEMBER

FCM_MEMBER TOTAL_BUFFERS_SENT
TOTAL_BUFFERS_RCVD
MEMBER
---------- -------------------- -------------------- -----0
305
305
0
1
5647
1664
0
2
5661
1688
0
0
19
19
1
1
305
301
1
2
1688
5661
1
0
1664
5647
2
1
10
10
2
2
301
305
2
Table 322. Information returned by the SNAPFCM_PART administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
CONNECTION_STATUS
VARCHAR(10)
connection_status - Connection
status. This interface returns a text
v INACTIVE
v ACTIVE
v CONGESTED
1330
SNAP_GET_FCM_PART table function (continued)
monitor element
Column name
Data type
TOTAL_BUFFERS_SENT
BIGINT
total_buffers_sent - Total FCM

buffers sent
TOTAL_BUFFERS_RCVD
BIGINT
total_buffers_rcvd - Total FCM

buffers received
DBPARTITIONNUM
SMALLINT
FCM_DBPARTITIONNUM
SMALLINT
The database partition number to

which data was sent or from which
data was received (as per the
TOTAL_BUFFERS_SENT and
TOTAL_BUFFERS_RCVD
columns).
MEMBER
SMALLINT

monitor element
FCM_MEMBER
SMALLINT
The member to which data was

sent or from which data was
received (as per the
TOTAL_BUFFERS_RCVD
columns).
SNAPHADR administrative view and SNAP_GET_HADR table

function - Retrieve hadr logical data group snapshot
information
The SNAPHADR administrative view and the SNAP_GET_HADR table function
return information about high availability disaster recovery from a database
snapshot, in particular, the hadr logical data group.
The SNAPHADR administrative view and SNAP_GET_HADR table function have
been deprecated and replaced by the MON_GET_HADR table function - Returns
high availability disaster recovery (HADR) monitoring information on page 603.
v SNAPHADR administrative view
v SNAP_GET_HADR table function on page 1332
SNAPHADR administrative view

This administrative view allows you to retrieve hadr logical data group snapshot
information for the currently connected database. The data is only returned by this
view if the database is a primary or standby high availability disaster recovery
(HADR) database.
Used with the MON_GET_DATABASE, MON_GET_MEMORY_SET,
MON_GET_MEMORY_POOL, MON_GET_TRANSACTION_LOG and
1331
ADMIN_GET_STORAGE_PATHS table functions, the SNAPHADR administrative

view provides information equivalent to the GET SNAPSHOT FOR DATABASE ON
returned.
Authorization
v SELECT privilege on the SNAPHADR administrative view
v CONTROL privilege on the SNAPHADR administrative view
v EXECUTE privilege on the SNAP_GET_HADR table function
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve the configuration and status information for HADR on the primary
HADR database.
SELECT SUBSTR(DB_NAME, 1, 8) AS DBNAME, HADR_ROLE, HADR_STATE,
HADR_SYNCMODE, HADR_CONNECT_STATUS
FROM SYSIBMADM.SNAPHADR

DBNAME
HADR_ROLE HADR_STATE
HADR_SYNCMODE HADR_CONNECT_STATUS
-------- --------- -------------- ------------- ------------------SAMPLE
PRIMARY
PEER
SYNC
CONNECTED
SNAP_GET_HADR table function

The SNAP_GET_HADR table function returns the same information as the
SNAPHADR administrative view, but allows you to retrieve the information for a
1332
Used with the SNAP_GET_DB, SNAP_GET_DB_MEMORY_POOL,

SNAP_GET_DETAILLOG and ADMIN_GET_STORAGE_PATHS table functions,
the SNAP_GET_HADR table function provides information equivalent to the GET
SNAPSHOT FOR ALL DATABASES CLP command.
returned.
Syntax
SNAP_GET_HADR (
dbname
, member

dbname
member
SNAP_GET_HADR table function takes a snapshot for the currently connected
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM
1333

Example
Retrieve the configuration and status information for HADR for all databases.
FROM TABLE (SNAP_GET_HADR (CAST (NULL as VARCHAR(128)), 0)) as T

DBNAME
-------SAMPLE
TESTDB
HADR_ROLE
--------PRIMARY
PRIMARY
HADR_STATE
-------------PEER
DISCONNECTED
HADR_SYNCMODE
------------SYNC
NEARSYNC
HADR_CONNECT_STATUS
------------------CONNECTED
DISCONNECTED
Table 323. Information returned by the SNAPHADR administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
HADR_ROLE
VARCHAR(10)
hadr_role - HADR role. This

and is one of:
v PRIMARY
v STANDARD
v STANDBY
HADR_STATE
VARCHAR(14)
hadr_state - HADR state. This

and is one of:
v DISCONNECTED
v LOCAL_CATCHUP
v PEER
v REM_CATCH_PEN
v REM_CATCHUP
HADR_SYNCMODE
VARCHAR(10)
hadr_syncmode - HADR
synchronization mode. This
and is one of:
v ASYNC
v NEARSYNC
v SUPERASYNC
v SYNC
1334
SNAP_GET_HADR table function (continued)
Column name
Data type
HADR_CONNECT_STATUS
VARCHAR(12)
monitor element
hadr_connect_status - HADR
connection status. This interface
returns a text identifier based on
the defines in sqlmon.h, and is one
of:
v CONGESTED
v CONNECTED
v DISCONNECTED
HADR_CONNECT_TIME
TIMESTAMP
hadr_connect_time - HADR
connection time
HADR_HEARTBEAT
INTEGER
hadr_heartbeat - HADR heartbeat
HADR_LOCAL_HOST
VARCHAR(255)
hadr_local_host - HADR local host
HADR_LOCAL_SERVICE
VARCHAR(40)
hadr_local_service - HADR local

service
HADR_REMOTE_HOST
VARCHAR(255)
hadr_remote_host - HADR remote

host
HADR_REMOTE_SERVICE
VARCHAR(40)
hadr_remote_service - HADR
remote service
HADR_REMOTE_INSTANCE
VARCHAR(128)
hadr_remote_instance - HADR
remote instance
HADR_TIMEOUT
BIGINT
hadr_timeout - HADR timeout
HADR_PRIMARY_LOG_FILE
VARCHAR(255)
hadr_primary_log_file - HADR
primary log file
HADR_PRIMARY_LOG_PAGE
BIGINT
hadr_primary_log_page - HADR
primary log page
HADR_PRIMARY_LOG_LSN
BIGINT
hadr_primary_log_lsn - HADR
primary log LSN
HADR_STANDBY_LOG_FILE
VARCHAR(255)
hadr_standby_log_file - HADR
standby log file
HADR_STANDBY_LOG_PAGE
BIGINT
hadr_standby_log_page - HADR
standby log page
HADR_STANDBY_LOG_LSN
BIGINT
hadr_standby_log_lsn - HADR
standby log LSN
HADR_LOG_GAP
BIGINT
hadr_log_gap - HADR log gap
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAPLOCK administrative view and SNAP_GET_LOCK table

function - Retrieve lock logical data group snapshot
information
The SNAPLOCK administrative view and the SNAP_GET_LOCK table function
return snapshot information about locks, in particular, the lock logical data group.
1335
Note: This administrative view and table function have been deprecated and
replaced by the MON_GET_APPL_LOCKWAIT - Get information about locks for
which an application is waiting on page 512, MON_GET_LOCKS - List all locks
in the currently connected database on page 620, and
details on page 445.
v SNAPLOCK administrative view
v SNAP_GET_LOCK table function on page 1337
SNAPLOCK administrative view

This administrative view allows you to retrieve lock logical data group snapshot
Used with the SNAPLOCKWAIT administrative view, the SNAPLOCK
LOCKS ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPLOCK administrative view
v CONTROL privilege on the SNAPLOCK administrative view
v EXECUTE privilege on the SNAP_GET_LOCK table function
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve lock information for the database member 0 of the currently connected
database.
1336
SELECT AGENT_ID, LOCK_OBJECT_TYPE, LOCK_MODE, LOCK_STATUS

FROM SYSIBMADM.SNAPLOCK WHERE DBPARTITIONNUM = 0

AGENT_ID
LOCK_OBJECT_TYPE LOCK_MODE LOCK_STATUS
-------------------- ---------------- --------- ----------7 TABLE
IX
GRNT
SNAP_GET_LOCK table function

The SNAP_GET_LOCK table function returns the same information as the
SNAPLOCK administrative view, but allows you to retrieve the information for a
Used with the SNAP_GET_LOCKWAIT table function, the SNAP_GET_LOCK table
function provides information equivalent to the GET SNAPSHOT FOR LOCKS ON
returned.
Syntax
SNAP_GET_LOCK (
dbname
, member

dbname
returned by the LIST DATABASE DIRECTORY command. Specify a null value or
empty string to take the snapshot from the currently connected database.
member
SNAP_GET_LOCK table function takes a snapshot for the currently connected
1337
Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve lock information for the current database member of the currently
connected database.
FROM TABLE(SNAP_GET_LOCK(,-1)) as T

AGENT_ID
--------...--680
680
LOCK_OBJECT_TYPE
INTERNALP_LOCK
LOCK_MODE
---------S
S
LOCK_STATUS
----------GRNT
GRNT
Table 324. Information returned by the SNAPLOCK administrative view and the
1338
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
AGENT_ID
BIGINT

(agent ID)
TAB_FILE_ID
BIGINT

identification
SNAP_GET_LOCK table function (continued)
Column name
Data type
LOCK_OBJECT_TYPE
VARCHAR(18)
monitor element
v AUTORESIZE_LOCK
v AUTOSTORAGE_LOCK
v BLOCK_LOCK
v EOT_LOCK
v INTERNAL_LOCK
v INTERNALB_LOCK
v INTERNALC_LOCK
v INTERNALJ_LOCK
v INTERNALL_LOCK
v INTERNALO_LOCK
v INTERNALQ_LOCK
v INTERNALP_LOCK
v INTERNALS_LOCK
v INTERNALT_LOCK
v INTERNALV_LOCK
v KEYVALUE_LOCK
v ROW_LOCK
v SYSBOOT_LOCK
v TABLE_LOCK
v TABLE_PART_LOCK
v TABLESPACE_LOCK
v XML_PATH_LOCK
LOCK_MODE
VARCHAR(10)

and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
1339
Column name
Data type
LOCK_STATUS
VARCHAR(10)
monitor element
and is one of:
v CONV
v GRNT
LOCK_ESCALATION
SMALLINT
TABNAME
VARCHAR(128)
TABSCHEMA
VARCHAR(128)
TBSP_NAME
VARCHAR(128)

name
LOCK_ATTRIBUTES
VARCHAR(128)
lock_attributes - Lock attributes.

sqlmon.h. If there are no locks, the
text identifier is NONE, otherwise, it
is any combination of the
following separated by a '+' sign:
v ALLOW_NEW
v DELETE_IN_BLOCK
v ESCALATED
v INSERT
v NEW_REQUEST
v RR
v RR_IN_BLOCK
v UPDATE_DELETE
v WAIT_FOR_AVAIL
LOCK_COUNT
BIGINT
lock_count - Lock count
LOCK_CURRENT_MODE
VARCHAR(10)
lock_current_mode - Original lock

mode before conversion. This
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
LOCK_HOLD_COUNT
1340
BIGINT
lock_hold_count - Lock hold count
Column name
Data type
monitor element
LOCK_NAME
VARCHAR(32)
LOCK_RELEASE_FLAGS
BIGINT
lock_release_flags - Lock release

flags
DATA_PARTITION_ID
INTEGER
data_partition_id - Data Partition

identifier. For a non-partitioned
table, this element is NULL.
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

SNAP_GET_LOCKWAIT table function - Retrieve lockwait
The SNAPLOCKWAIT administrative view and the SNAP_GET_LOCKWAIT table
function return snapshot information about lock waits, in particular, the lockwait
logical data group.
replaced by the MON_LOCKWAITS administrative view - Retrieve metrics for
applications that are waiting to obtain locks on page 840 and the
v SNAPLOCKWAIT administrative view
v SNAP_GET_LOCKWAIT table function on page 1342
SNAPLOCKWAIT administrative view

This administrative view allows you to retrieve lockwait logical data group
Used with the SNAPLOCK administrative view, the SNAPLOCKWAIT
returned.
1341
Authorization
v SELECT privilege on the SNAPLOCKWAIT administrative view
v CONTROL privilege on the SNAPLOCKWAIT administrative view
v EXECUTE privilege on the SNAP_GET_LOCKWAIT table function
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve lock wait information for database member 0 for the currently connected
database.
SELECT AGENT_ID, LOCK_MODE, LOCK_OBJECT_TYPE, AGENT_ID_HOLDING_LK,
LOCK_MODE_REQUESTED FROM SYSIBMADM.SNAPLOCKWAIT
WHERE DBPARTITIONNUM = 0

AGENT_ID
LOCK_MODE LOCK_OBJECT_TYPE ...
--------...- --------- ---------------- ...
7 IX
TABLE
...

... AGENT_ID_HOLDING_LK LOCK_MODE_REQUESTED
... -------------------- ------------------...
12 IS
SNAP_GET_LOCKWAIT table function

The SNAP_GET_LOCKWAIT table function returns the same information as the
SNAPLOCKWAIT administrative view, but allows you to retrieve the information
Used with the SNAP_GET_LOCK table function, the SNAP_GET_LOCKWAIT table
1342
returned.
Syntax
SNAP_GET_LOCKWAIT (
dbname
, member

dbname
member
SNAP_GET_LOCKWAIT table function takes a snapshot for the currently
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1343
Example
Retrieve lock wait information for current database member for the currently
connected database.
LOCK_MODE_REQUESTED FROM TABLE(SNAP_GET_LOCKWAIT(,-1)) AS T

AGENT_ID
LOCK_MODE LOCK_OBJECT_TYPE
...
--------...-- ---------- ------------------ ...
12 X
ROW_LOCK
...

... -------------------- ------------------...
7 X
Usage note
To see lock wait information, you must first turn on the default LOCK monitor
switch in the database manager configuration. To have the change take effect
immediately explicitly attach to the instance using CLP and then issue the CLP
command:
UPDATE DATABASE MANAGER CONFIGURATION CLP USING DFT_MON_LOCK ON
The default setting can also be turned on through the ADMIN_CMD stored
procedure. For example:
CALL SYSPROC.ADMIN_CMD(update dbm cfg using DFT_MON_LOCK ON)
If the ADMIN_CMD stored procedure is used or if the clp command is used

without having previously attached to the instance, the instance must be recycled
before the change takes effect.
Table 325. Information returned by the SNAPLOCKWAIT administrative view and the
1344
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
AGENT_ID
BIGINT

(agent ID)
SUBSECTION_NUMBER
BIGINT
SNAP_GET_LOCKWAIT table function (continued)
Column name
Data type
LOCK_MODE
VARCHAR(10)
monitor element
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
LOCK_OBJECT_TYPE
VARCHAR(18)

v AUTORESIZE_LOCK
v AUTOSTORAGE_LOCK
v BLOCK_LOCK
v EOT_LOCK
v INTERNAL_LOCK
v INTERNALB_LOCK
v INTERNALC_LOCK
v INTERNALJ_LOCK
v INTERNALL_LOCK
v INTERNALO_LOCK
v INTERNALQ_LOCK
v INTERNALP_LOCK
v INTERNALS_LOCK
v INTERNALT_LOCK
v INTERNALV_LOCK
v KEYVALUE_LOCK
v ROW_LOCK
v SYSBOOT_LOCK
v TABLE_LOCK
v TABLE_PART_LOCK
v TABLESPACE_LOCK
v XML_PATH_LOCK
AGENT_ID_HOLDING_LK
BIGINT
holding lock
1345
monitor element
Column name
Data type
TIMESTAMP

start timestamp
LOCK_MODE_REQUESTED
VARCHAR(10)

v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
LOCK_ESCALATION
SMALLINT
TABNAME
VARCHAR(128)
TABSCHEMA
VARCHAR(128)
TBSP_NAME
VARCHAR(128)

name
APPL_ID_HOLDING_LK
VARCHAR(128)
ID holding lock
LOCK_ATTRIBUTES
VARCHAR(128)

text identifier is NONE, otherwise,
it is any combination of the
v ALLOW_NEW
v DELETE_IN_BLOCK
v ESCALATED
v INSERT
v NEW_REQUEST
v RR
v RR_IN_BLOCK
v UPDATE_DELETE
v WAIT_FOR_AVAIL
1346
Column name
Data type
LOCK_CURRENT_MODE
VARCHAR(10)
monitor element
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
LOCK_NAME
VARCHAR(32)
LOCK_RELEASE_FLAGS
BIGINT

flags.
DATA_PARTITION_ID
INTEGER

DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAPSTMT administrative view and SNAP_GET_STMT table

function - Retrieve statement snapshot information
The SNAPSTMT administrative view and the SNAP_GET_STMT table function
return information about SQL or XQuery statements from an application snapshot.
Important: The SNAPSTMT administrative view and the SNAP_GET_STMT table
function are deprecated. Use the MON_GET_ACTIVITY table function - Return a
list of activities on page 475 to retrieve the information returned by these
deprecated interfaces.
v SNAPSTMT administrative view
v SNAP_GET_STMT table function on page 1349
SNAPSTMT administrative view

This administrative view allows you to retrieve statement snapshot information for
1347

SNAPSTMT administrative view provides information equivalent to the GET
SNAPSHOT FOR APPLICATIONS on database-alias CLP command, but retrieves data
returned.
Authorization
v SELECT privilege on the SNAPSTMT administrative view
v CONTROL privilege on the SNAPSTMT administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_STMT table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve rows read, written and operation performed for statements executed on
the currently connected single-member database.
SELECT SUBSTR(STMT_TEXT,1,30) AS STMT_TEXT, ROWS_READ, ROWS_WRITTEN,
STMT_OPERATION FROM SYSIBMADM.SNAPSTMT

STMT_TEXT
ROWS_READ
ROWS_WRITTEN
---------...- ---------...- ------------...0
0
0
0
1348
STMT_OPERATION
-------------------FETCH
STATIC_COMMIT
SNAP_GET_STMT table function

The SNAP_GET_STMT table function returns the same information as the
SNAPSTMT administrative view, but allows you to retrieve the information for a
SNAP_GET_APPL, SNAP_GET_APPL_INFO and SNAP_GET_SUBSECTION table
functions, the SNAP_GET_STMT table function provides information equivalent to
returned.
Syntax
SNAP_GET_STMT (
dbname
, member

dbname
member
SNAP_GET_STMT table function takes a snapshot for the currently connected
Authorization
1349

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
current database member of currently connected database.
SELECT SUBSTR(STMT_TEXT,1,30) AS STMT_TEXT, ROWS_READ,
ROWS_WRITTEN, STMT_OPERATION FROM TABLE(SNAP_GET_STMT(,-1)) AS T

STMT_TEXT
ROWS_READ
------------------------------ ---------...update t set a=3
0
SELECT SUBSTR(STMT_TEXT,1,30)
0
0
0
update t set a=2
9
...
...
...
...
...
...
...
...
...

... ROWS_WRITTEN
... ------------......
0
...
0
...
0
...
0
...
1
...
STMT_OPERATION
-------------------EXECUTE_IMMEDIATE
FETCH
NONE
NONE
EXECUTE_IMMEDIATE
Table 326. Information returned by the SNAPSTMT administrative view and the
1350
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
AGENT_ID
BIGINT

(agent ID)
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
NUM_AGENTS
BIGINT

SNAP_GET_STMT table function (continued)
monitor element
Column name
Data type
AGENTS_TOP
BIGINT
agents_top - Number of agents

created
STMT_TYPE
VARCHAR(20)
stmt_type - Statement type. This

is one of:
v DYNAMIC
v NON_STMT
v STATIC
v STMT_TYPE_UNKNOWN
STMT_OPERATION
VARCHAR(20)
stmt_operation/operation Statement operation. This interface

v CALL
v CLOSE
v COMPILE
v DESCRIBE
v EXECUTE
v EXECUTE_IMMEDIATE
v FETCH
v FREE_LOCATOR
v GETAA
v GETNEXTCHUNK
v GETTA
v NONE
v OPEN
v PREP_COMMIT
v PREP_EXEC
v PREP_OPEN
v PREPARE
v REBIND
v REDIST
v REORG
v RUNSTATS
v SELECT
v SET
v STATIC_COMMIT
v STATIC_ROLLBACK
SECTION_NUMBER
BIGINT
QUERY_COST_ESTIMATE
BIGINT
query_cost_estimate - Query cost

estimate
QUERY_CARD_ESTIMATE
BIGINT
query_card_estimate - Query
number of rows estimate
1351
1352
monitor element
Column name
Data type
DEGREE_PARALLELISM
BIGINT
degree_parallelism - Degree of
parallelism
STMT_SORTS
BIGINT
TOTAL_SORT_TIME
BIGINT
SORT_OVERFLOWS
BIGINT
INT_ROWS_DELETED
BIGINT

deleted
INT_ROWS_UPDATED
BIGINT

updated
INT_ROWS_INSERTED
BIGINT

inserted
FETCH_COUNT
BIGINT
fetch_count - Number of successful

fetches
STMT_START
TIMESTAMP
stmt_start - Statement operation

start timestamp
STMT_STOP
TIMESTAMP
stmt_stop - Statement operation

stop timestamp
STMT_USR_CPU_TIME_S
BIGINT
stmt_usr_cpu_time - User CPU

time used by statement (in
seconds)*
STMT_USR_CPU_TIME_MS
BIGINT

time used by statement (fractional,
in microseconds)*
STMT_SYS_CPU_TIME_S
BIGINT
stmt_sys_cpu_time - System CPU

seconds)*
STMT_SYS_CPU_TIME_MS
BIGINT

in microseconds)*
STMT_ELAPSED_TIME_S
BIGINT
stmt_elapsed_time - Most recent

statement elapsed time (in
seconds)*
STMT_ELAPSED_TIME_MS
BIGINT

statement elapsed time (fractional,
in microseconds)*
BLOCKING_CURSOR
SMALLINT
blocking_cursor - Blocking cursor
STMT_NODE_NUMBER
SMALLINT
stmt_node_number - Statement
node
CURSOR_NAME
VARCHAR(128)
cursor_name - Cursor name
CREATOR
VARCHAR(128)
creator - Application creator
PACKAGE_NAME
VARCHAR(128)
STMT_TEXT
CLOB(16 M)
CONSISTENCY_TOKEN
VARCHAR(128)
consistency_token - Package
consistency token
monitor element
Column name
Data type
PACKAGE_VERSION_ID
VARCHAR(128)
package_version_id - Package
version
POOL_DATA_L_READS
BIGINT

data logical reads
POOL_DATA_P_READS
BIGINT

data physical reads
POOL_INDEX_L_READS
BIGINT

index logical reads
POOL_INDEX_P_READS
BIGINT

POOL_XDA_L_READS
BIGINT

XDA Data Logical Reads monitor
element
POOL_XDA_P_READS
BIGINT

XDA Data Physical Reads monitor
element
BIGINT
BIGINT
BIGINT
BIGINT
reads
BIGINT
Reads
BIGINT
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAP_GET_STO_PATHS
The SNAP_GET_STO_PATHS table function returns snapshot information from the
storage_paths logical data group.
1353
ADMIN_GET_STORAGE_PATHS table function - retrieve automatic storage path
SNAP_GET_STO_PATHS (
dbname
, member

dbname
Specify the NULL value to take the snapshot from the currently connected
database.
member
database partitions. An active database member is a member where the
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAP_WRITE_FILE stored procedure for the
corresponding snapshot API request type.
Authorization
To access snapshot monitor data, one of the following authorities is required:
v
v
v
v
SYSMON authority
SYSCTRL authority
SYSMAINT authority
SYSADM authority

The function returns the following table.
1354
Table 327. Information returned by the SNAP_GET_STO_PATHS table function

Description or
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
DB_NAME
VARCHAR(128)
DB_STORAGE_PATH
VARCHAR(256)
storage path
SNAPSTORAGE_PATHS administrative view and

SNAP_GET_STORAGE_PATHS_V97 table function - Retrieve
The SNAPSTORAGE_PATHS administrative view and the
SNAP_GET_STORAGE_PATHS_V97 return a list of automatic storage paths for the
database including file system information for each storage path, specifically, from
the db_storage_group logical data group.
Note: The SNAPSTORAGE_PATHS administrative view and the
SNAP_GET_STORAGE_PATHS_V97 on page 1356 have been deprecated and
replaced by the ADMIN_GET_STORAGE_PATHS table function - retrieve
automatic storage path information on page 224. This function and view might be
removed in a future release.
v SNAPSTORAGE_PATHS administrative view
v SNAP_GET_STORAGE_PATHS_V97 on page 1356

This administrative view allows you to retrieve automatic storage path information
for the currently connected database.
Used with the MON_GET_DATABASE, MON_GET_HADR,
MON_GET_MEMORY_POOL, MON_GET_MEMORY_SET, and
MON_GET_TRANSACTION_LOG table functions, the SNAPSTORAGE_PATHS
DATABASE ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPSTORAGE_PATHS administrative view
v CONTROL privilege on the SNAPSTORAGE_PATHS administrative view
1355
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_STORAGE_PATHS_V97 table function
v DBADM authority
v SQLADM authority
To access snapshot monitor data, one of the following authorities is also required:
v
v
v
v
SYSMON authority
SYSCTRL authority
SYSMAINT authority
SYSADM authority

Example
Retrieve the storage path for the currently connected single-member database.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, SUBSTR(DB_STORAGE_PATH,1,8)
AS DB_STORAGE_PATH, SUBSTR(HOSTNAME,1,10) AS HOSTNAME
FROM SYSIBMADM.SNAPSTORAGE_PATHS

DB_NAME DB_STORAGE_PATH HOSTNAME
-------- --------------- ---------STOPATH d:
JESSICAE
SNAP_GET_STORAGE_PATHS_V97
The SNAP_GET_STORAGE_PATHS_V97 table function returns similar information
as the SNAPSTORAGE_PATHS administrative view. It allows you to retrieve the
SNAP_GET_DB_MEMORY_POOL table functions, the
SNAP_GET_STORAGE_PATHS_V97 table function provides information equivalent
returned.
Syntax
SNAP_GET_STORAGE_PATHS_V97 (
dbname
)
, member
1356

dbname
member
An optional input argument of type INTEGER that specifies a valid member
number. Specify -1 for the current member, or -2 for an aggregate of all active
members. If dbname is not set to NULL and member is set to NULL,-1 is set
implicitly for member. If this input option is not used, that is, only dbname is
provided, data is returned from all members where the database is active.
SNAP_GET_STORAGE_PATHS_V97 table function takes a snapshot for the
currently connected database and database member.
Authorization
v EXECUTE privilege on the SNAP_GET_STORAGE_PATHS_V97 table function.
v SYSMON authority
v SYSCTRL authority
v SYSMAINT suthority
v SYSADM authority

Examples
Retrieve the storage path information for all active databases.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, DB_STORAGE_PATH
FROM TABLE(SNAP_GET_STORAGE_PATHS_V97(CAST (NULL AS VARCHAR(128)), -1)) AS T

DB_NAME
-------STOPATH
MYDB
DB_STORAGE_PATH
-------------------...
/home/jessicae/sdb
/home/jessicae/mdb
1357
The BUFFERPOOL monitor switch must be turned on in order for the file system
information to be returned.
Table 328. Information returned by the SNAPSTORAGE_PATHS administrative view and the
SNAP_GET_STORAGE_PATHS_V97 table function
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
DB_STORAGE_PATH
VARCHAR(256)
storage path
VARCHAR(256)
db_storage_path_with_dpe Storage path including database

partition expression monitor
element
DBPARTITIONNUM
SMALLINT
VARCHAR(16)
path state monitor element
FS_ID
VARCHAR(22)

FS_TOTAL_SIZE
BIGINT

system
FS_USED_SIZE
BIGINT

STO_PATH_FREE_SIZE
BIGINT
storage path free space
SNAPTAB administrative view and SNAP_GET_TAB table

function - Retrieve table logical data group snapshot
information
The SNAPTAB administrative view and the SNAP_GET_TAB table function return
snapshot information from the table logical data group.
Important: The SNAPTAB administrative view and SNAP_GET_TAB table
function are deprecated. Use the MON_GET_TABLE table function - get table
metrics on page 731, to retrieve the information returned by these deprecated
interfaces.
v SNAPTAB administrative view
v SNAP_GET_TAB table function on page 1360
SNAPTAB administrative view

This administrative view allows you to retrieve table logical data group snapshot
1358
Used in conjunction with the SNAPTAB_REORG administrative view, the

SNAPTAB administrative view returns equivalent information to the GET SNAPSHOT
FOR TABLES ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPTAB administrative view
v CONTROL privilege on the SNAPTAB administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_TAB table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve the schema and name for all active tables.
SELECT SUBSTR(TABSCHEMA,1,8), SUBSTR(TABNAME,1,15) AS TABNAME, TAB_TYPE,
DBPARTITIONNUM FROM SYSIBMADM.SNAPTAB

TABSCHEMA TABNAME
TAB_TYPE
DBPARTITIONNUM
--------- --------------- ------------ -------------SYSTOOLS HMON_ATM_INFO
USER_TABLE
0
1 record selected.
1359
SNAP_GET_TAB table function

The SNAP_GET_TAB table function returns the same information as the SNAPTAB
database members.
Used in conjunction with the SNAP_GET_TAB_REORG table function, the
SNAP_GET_TAB table function returns equivalent information to the GET SNAPSHOT
returned.
Syntax
SNAP_GET_TAB (
dbname
, member

dbname
member
SNAP_GET_TAB table function takes a snapshot for the currently connected
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
1360
v SYSADM

Example
Retrieve a list of active tables as an aggregate view for the currently connected
database.
TAB_TYPE, DBPARTITIONNUM FROM TABLE(SNAP_GET_TAB(,-2)) AS T

TABSCHEMA
--------SYSTOOLS
JESSICAE
TABNAME
--------------HMON_ATM_INFO
EMPLOYEE
TAB_TYPE
DBPARTITIONNUM
------------- -------------USER_TABLE
USER_TABLE
-
Table 329. Information returned by the SNAPTAB administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
TAB_FILE_ID
BIGINT

identification
TAB_TYPE
VARCHAR(14)
table_type - Table type. This

based on defines in sqlmon.h, and
is one of:
v CATALOG_TABLE
v DROPPED_TABLE
v REORG_TABLE
v SYNOPSIS_TABLE
v TEMP_TABLE
v USER_TABLE
DATA_OBJECT_PAGES
BIGINT
data_object_pages - Data object

pages
INDEX_OBJECT_PAGES
BIGINT
index_object_pages - Index object

pages
LOB_OBJECT_PAGES
BIGINT
lob_object_pages - LOB object

pages
LONG_OBJECT_PAGES
BIGINT
long_object_pages - Long object

pages
XDA_OBJECT_PAGES
BIGINT
xda_object_pages - XDA Object

Pages
1361
SNAP_GET_TAB table function (continued)
Column name
Data type
monitor element
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
OVERFLOW_ACCESSES
BIGINT
overflow_accesses - Accesses to
overflowed records
PAGE_REORGS
BIGINT
DBPARTITIONNUM
SMALLINT
TBSP_ID
BIGINT

identification
DATA_PARTITION_ID
INTEGER

table, this element will be NULL.
MEMBER
SMALLINT

monitor element
SNAP_GET_TAB_V91
The SNAP_GET_TAB_V91 table function returns snapshot information from the
table logical data group.
Important: The SNAP_GET_TAB_V91 table function is deprecated. Use the
MON_GET_TABLE table function - get table metrics on page 731 to retrieve the
information returned by this deprecated interface.
returned.
Syntax
SNAP_GET_TAB_V91 (
dbname
, dbpartitionnum

dbname
dbpartitionnum
1362

SNAP_GET_TAB_V91 table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v EXECUTE privilege on the SNAP_GET_TAB_V91 table function
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
database.

TABSCHEMA
--------SYSTOOLS
JESSICAE
TABNAME
EMPLOYEE
TAB_TYPE
DBPARTITIONNUM
------------- -------------USER_TABLE
USER_TABLE
-
Table 330. Information returned by the SNAP_GET_TAB_V91 table function
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TABSCHEMA
VARCHAR(128)
TABNAME
VARCHAR(128)
TAB_FILE_ID
BIGINT

identification
1363
Table 330. Information returned by the SNAP_GET_TAB_V91 table function (continued)

Column name
Data type
TAB_TYPE
VARCHAR(14)
monitor element
is one of:
v USER_TABLE
v DROPPED_TABLE
v TEMP_TABLE
v CATALOG_TABLE
v REORG_TABLE
DATA_OBJECT_PAGES
BIGINT

pages
INDEX_OBJECT_PAGES
BIGINT

pages
LOB_OBJECT_PAGES
BIGINT

pages
LONG_OBJECT_PAGES
BIGINT

pages
XDA_OBJECT_PAGES
BIGINT

Pages
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
OVERFLOW_ACCESSES
BIGINT
overflowed records
PAGE_REORGS
BIGINT
DBPARTITIONNUM
SMALLINT
TBSP_ID
BIGINT

identification
DATA_PARTITION_ID
INTEGER

SNAPTBSP administrative view and SNAP_GET_TBSP table

function - Retrieve table space logical data group snapshot
information
The SNAPTBSP administrative view and the SNAP_GET_TBSP table function
return snapshot information from the table space logical data group.
Important: The SNAPTBSP administrative view and the SNAP_GET_TBSP table
function are deprecated and have been replaced by the MON_GET_TABLESPACE
table function - Get table space metrics on page 736.
v SNAPTBSP administrative view on page 1365
v SNAP_GET_TBSP table function on page 1366
1364
SNAPTBSP administrative view

This administrative view allows you to retrieve table space logical data group
Used in conjunction with the SNAPTBSP_PART, SNAPTBSP_QUIESCER,
SNAPTBSP_RANGE, SNAPCONTAINER administrative views, the SNAPTBSP
administrative view returns information equivalent to the GET SNAPSHOT FOR
TABLESPACES ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPTBSP administrative view
v CONTROL privilege on the SNAPTBSP administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_TBSP table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a list of table spaces on the catalog database member for the currently
connected database.
SELECT SUBSTR(TBSP_NAME,1,30) AS TBSP_NAME, TBSP_ID, TBSP_TYPE,
TBSP_CONTENT_TYPE FROM SYSIBMADM.SNAPTBSP WHERE DBPARTITIONNUM = 1
1365
TBSP_NAME TBSP_ID
---------- -------...TEMPSPACE1
1
USERSPACE1
2
TBSP_TYPE
---------SMS
DMS
TBSP_CONTENT_TYPE
----------------SYSTEMP
LONG
SNAP_GET_TBSP table function

The SNAP_GET_TBSP table function returns the same information as the
SNAPTBSP administrative view, but allows you to retrieve the information for a
Used in conjunction with the SNAP_GET_TBSP_PART,
SNAP_GET_TBSP_QUIESCER, SNAP_GET_TBSP_RANGE,
SNAP_GET_CONTAINER table functions, the SNAP_GET_TBSP table function
returns information equivalent to the GET SNAPSHOT FOR TABLESPACES ON
returned.
Syntax
SNAP_GET_TBSP (
dbname
, member

dbname
member
An input argument of type INTEGER that specifies a valid member number.
Specify -1 for the current member. If the null value is specified, -1 is set
implicitly.
SNAP_GET_TBSP table function takes a snapshot for the currently connected
Authorization
1366

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a list of table spaces for all database members for the currently connected
database.
TBSP_CONTENT_TYPE, DBPARTITIONNUM FROM TABLE(SNAP_GET_TBSP()) AS T

TBSP_NAME TBSP_ID
---------- -------...TEMPSPACE1
1
USERSPACE1
2
SYSCATSPAC
0
TEMPSPACE1
1
USERSPACE1
2
SYSTOOLSPA
3
TEMPSPACE1
1
USERSPACE1
2
TBSP_TYPE
---------SMS
DMS
DMS
SMS
DMS
DMS
SMS
DMS
TBSP_CONTENT_TYPE DBPARTITIONNUM
----------------- -------------SYSTEMP
1
LONG
1
ANY
0
SYSTEMP
0
LONG
0
LONG
0
SYSTEMP
2
LONG
2
Table 331. Information returned by the SNAPTBSP administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TBSP_NAME
VARCHAR(128)

name
TBSP_ID
BIGINT

identification
TBSP_TYPE
VARCHAR(10)
tablespace_type - Table space type.

sqlutil.h, and is one of:
v DMS
v SMS
1367
SNAP_GET_TBSP table function (continued)
Column name
Data type
TBSP_CONTENT_TYPE
VARCHAR(10)
monitor element
space contents type. This interface
v ANY
v LARGE
v SYSTEMP
v USRTEMP
1368
TBSP_PAGE_SIZE
BIGINT
tablespace_page_size - Table space

page size
TBSP_EXTENT_SIZE
BIGINT
space extent size
TBSP_PREFETCH_SIZE
BIGINT
space prefetch size
TBSP_CUR_POOL_ID
BIGINT
tablespace_cur_pool_id - Buffer
pool currently being used
TBSP_NEXT_POOL_ID
BIGINT
tablespace_next_pool_id - Buffer
pool that will be used at next
startup
FS_CACHING
SMALLINT
POOL_DATA_L_READS
BIGINT

data logical reads
POOL_DATA_P_READS
BIGINT

data physical reads
BIGINT
BIGINT
BIGINT
POOL_DATA_WRITES
BIGINT

writes
BIGINT
POOL_INDEX_L_READS
BIGINT

index logical reads
POOL_INDEX_P_READS
BIGINT

BIGINT
BIGINT
reads
BIGINT
monitor element
Column name
Data type
POOL_INDEX_WRITES
BIGINT

index writes
BIGINT
POOL_XDA_L_READS
BIGINT

POOL_XDA_P_READS
BIGINT

POOL_XDA_WRITES
BIGINT

Data Writes
BIGINT
Reads
BIGINT
Writes
BIGINT
Reads
BIGINT
POOL_READ_TIME
BIGINT

physical read time
POOL_WRITE_TIME
BIGINT

physical write time
BIGINT

BIGINT
POOL_ASYNC_DATA_
READ_REQS
BIGINT
POOL_ASYNC_INDEX_
READ_REQS
BIGINT

read requests
POOL_ASYNC_XDA_READ_REQS BIGINT
Requests
BIGINT
DIRECT_READS
BIGINT

database
DIRECT_WRITES
BIGINT

database
DIRECT_READ_REQS
BIGINT

requests
1369
monitor element
Column name
Data type
DIRECT_WRITE_REQS
BIGINT

requests
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT

time
FILES_CLOSED
BIGINT
BIGINT
prefetch pages
VARCHAR(10)
tablespace_rebalancer_mode Rebalancer mode. This interface

v NO_REBAL
v FWD_REBAL
v REV_REBAL
SMALLINT
tablespace_using_auto_storage Table space enabled for automatic

storage
SMALLINT
tablespace_auto_resize_enabled Table space automatic resizing

enabled
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

SNAP_GET_TBSP_PART table function - Retrieve
tablespace_nodeinfo logical data group snapshot information
The SNAPTBSP_PART administrative view and the SNAP_GET_TBSP_PART table
function return snapshot information from the tablespace_nodeinfo logical data
group.
Important: The SNAPTBSP_PART administrative view and the
SNAP_GET_TBSP_PART table function are deprecated and have been replaced by
the MON_GET_TABLESPACE table function - Get table space metrics on page
736.
v SNAPTBSP_PART administrative view on page 1371
v SNAP_GET_TBSP_PART table function on page 1372
1370
SNAPTBSP_PART administrative view

This administrative view allows you to retrieve tablespace_nodeinfo logical data
Used in conjunction with the SNAPTBSP, SNAPTBSP_QUIESCER,
SNAPTBSP_RANGE, SNAPCONTAINER administrative views, the
SNAPTBSP_PART administrative view returns information equivalent to the GET
returned.
Authorization
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_TBSP_PART table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a list of table spaces and their state for all database partitions of the
SELECT SUBSTR(TBSP_NAME,1,30) AS TBSP_NAME, TBSP_ID,
SUBSTR(TBSP_STATE,1,30) AS TBSP_STATE, DBPARTITIONNUM
FROM SYSIBMADM.SNAPTBSP_PART
1371
TBSP_NAME
TBSP_ID
-----------...- -------...SYSCATSPACE
0
TEMPSPACE1
1
USERSPACE1
2
TEMPSPACE1
1
USERSPACE1
2
TBSP_STATE
DBPARTITIONNUM
----------...- -------------NORMAL
0
NORMAL
0
NORMAL
0
NORMAL
1
NORMAL
1
SNAP_GET_TBSP_PART table function

The SNAP_GET_TBSP_PART table function returns the same information as the
SNAPTBSP_PART administrative view, but allows you to retrieve the information
for a specific database on a specific database partition, aggregate of all database
partitions or all database partitions.
Used in conjunction with the SNAP_GET_TBSP, SNAP_GET_TBSP_QUIESCER,
SNAP_GET_TBSP_PART table function returns information equivalent to the GET
returned.
Syntax
SNAP_GET_TBSP_PART (
dbname
, member

dbname
member
members. If dbname is not set to NULL and member is set to NULL, -1 is set
SNAP_GET_TBSP_PART table function takes a snapshot for the currently
connected database and member.
1372
Authorization
v EXECUTE privilege on the SNAP_GET_TBSP_PART table function.
v SYSMON authority
v SYSCTRL authority
v SYSMAINT authority
v SYSADM authority

Example
Retrieve a list of table spaces and their state for the connected database partition of
the connected database.
SUBSTR(TBSP_STATE,1,30) AS TBSP_STATE
FROM TABLE(SNAP_GET_TBSP_PART(CAST(NULL AS VARCHAR(128)),-1)) AS T

TBSP_NAME
TBSP_ID
------------------------------ -------------------SYSCATSPACE
0
TEMPSPACE1
1
USERSPACE1
2
SYSTOOLSPACE
3
SYSTOOLSTMPSPACE
4
TBSP_STATE
------------...NORMAL
NORMAL
NORMAL
NORMAL
NORMAL
Table 332. Information returned by the SNAPTBSP_PART administrative view and the
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
TBSP_NAME
VARCHAR
(128)
TBSP_ID
BIGINT
1373
SNAP_GET_TBSP_PART table function (continued)
Column name
Data type
TBSP_STATE
VARCHAR
(256)

element
tablespace_state - Table space state. This
defines in sqlutil.h and is combination of
the following separated by a '+' sign:
v BACKUP_IN_PROGRESS
v BACKUP_PENDING
v DELETE_PENDING
v DISABLE_PENDING
v DROP_PENDING
v LOAD_IN_PROGRESS
v LOAD_PENDING
v NORMAL
v OFFLINE
v PSTAT_CREATION
v PSTAT_DELETION
v QUIESCED_EXCLUSIVE
v QUIESCED_SHARE
v QUIESCED_UPDATE
v REBAL_IN_PROGRESS
v REORG_IN_PROGRESS
v RESTORE_IN_PROGRESS
v RESTORE_PENDING
v ROLLFORWARD_IN_PROGRESS
v ROLLFORWARD_PENDING
v STORDEF_ALLOWED
v STORDEF_CHANGED
v STORDEF_FINAL_VERSION
v STORDEF_PENDING
v SUSPEND_WRITE
1374
TBSP_PREFETCH_SIZE
BIGINT
tablespace_prefetch_size - Table space

prefetch size
TBSP_NUM_QUIESCERS
BIGINT
tablespace_num_quiescers - Number of
quiescers
TBSP_STATE_CHANGE_
OBJECT_ID
BIGINT
tablespace_state_change_object_id - State
change object identification
TBSP_STATE_CHANGE_
TBSP_ID
BIGINT
tablespace_state_change_ts_id - State
change table space identification
TBSP_MIN_RECOVERY_
TIME
TIMESTAMP
tablespace_min_recovery_time - Minimum
recovery time for rollforward
TBSP_TOTAL_PAGES
BIGINT
tablespace_total_pages - Total pages in table

space
TBSP_USABLE_PAGES
BIGINT
tablespace_usable_pages - Usable pages in

table space
TBSP_USED_PAGES
BIGINT
tablespace_used_pages - Used pages in

table space
element
Column name
Data type
TBSP_FREE_PAGES
BIGINT
tablespace_free_pages - Free pages in table

space
TBSP_PENDING_FREE_
PAGES
BIGINT
tablespace_pending_free_pages - Pending
free pages in table space
TBSP_PAGE_TOP
BIGINT
tablespace_page_top - Table space high

water mark
REBALANCER_MODE
VARCHAR
(30)
tablespace_rebalancer_mode - Rebalancer
mode. This interface returns a text identifier
based on defines in sqlmon.h, and is one of:
v FWD_REBAL
v NO_REBAL
v REV_REBAL
REBALANCER_EXTENTS_
REMAINING
BIGINT
tablespace_rebalancer_extents_remaining Total number of extents to be processed by

the rebalancer
REBALANCER_EXTENTS_
PROCESSED
BIGINT
tablespace_rebalancer_extents_processed Number of extents the rebalancer has

processed
REBALANCER_PRIORITY
BIGINT
tablespace_rebalancer_priority Currentrebalancer priority
REBALANCER_START_
TIME
TIMESTAMP
tablespace_rebalancer_start_time Rebalancer start time
REBALANCER_RESTART_
TIME
TIMESTAMP
tablespace_rebalancer_restart_time Rebalancer restart time
REBALANCER_LAST_
EXTENT_MOVED
BIGINT
tablespace_rebalancer_last_extent_moved Last extent moved by the rebalancer
TBSP_NUM_RANGES
BIGINT
tablespace_num_ranges - Number of ranges

in the table space map
TBSP_NUM_CONTAINERS
BIGINT
tablespace_num_containers - Number of
containers in table space
TBSP_INITIAL_SIZE
BIGINT
tablespace_initial_size - Initial table space

size
TBSP_CURRENT_SIZE
BIGINT
tablespace_current_size - Current table

space size
TBSP_MAX_SIZE
BIGINT
tablespace_max_size - Maximum table

space size
TBSP_INCREASE_SIZE
BIGINT
tablespace_increase_size - Increase size in

bytes
TBSP_INCREASE_SIZE_
PERCENT
SMALLINT
tablespace_increase_size_percent - Increase
size by percent
TIMESTAMP
tablespace_last_resize_time - Time of last

successful resize
TBSP_LAST_RESIZE_
FAILED
SMALLINT
tablespace_last_resize_failed - Last resize

attempt failed
1375
element
Column name
Data type
DBPARTITIONNUM
SMALLINT

TBSP_PATHS_DROPPED
SMALLINT
Indicates that the table space resides on one

or more storage paths that have been
dropped (0 - No, 1 - Yes)
SNAP_GET_TBSP_PART_V97 table function - Retrieve

The SNAP_GET_TBSP_PART_V97 table function returns tablespace_nodeinfo
logical data group snapshot information for a specific database on a specific
database member, aggregate of all database members or all database members.
Important: The SNAP_GET_TBSP_PART_V97 table function is deprecated and has
been replaced by the MON_GET_TABLESPACE table function - Get table space
returned.
Syntax
SNAP_GET_TBSP_PART_V97 (
dbname
, member

dbname
member
SNAP_GET_TBSP_PART_V97 table function takes a snapshot for the currently
1376
Authorization
v EXECUTE privilege on the SNAP_GET_TBSP_PART_V97 table function.
v SYSMON authority
v SYSCTRL authority
v SYSADM authority

Example
Retrieve a list of table spaces and their state for the connected database member of
FROM TABLE(SNAP_GET_TBSP_PART_V97(CAST(NULL AS VARCHAR(128)),-1)) AS T

TBSP_NAME
TBSP_ID
------------------------------ -------------------SYSCATSPACE
0
TEMPSPACE1
1
USERSPACE1
2
SYSTOOLSPACE
3
SYSTOOLSTMPSPACE
4
TBSP_STATE
------------...NORMAL
NORMAL
NORMAL
NORMAL
NORMAL
Table 333. Information returned by the SNAP_GET_TBSP_PART_V97 table function
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
TBSP_NAME
VARCHAR
(128)
TBSP_ID
BIGINT
1377
Table 333. Information returned by the SNAP_GET_TBSP_PART_V97 table

Column name
Data type
TBSP_STATE
VARCHAR
(256)

element
v BACKUP_PENDING
v DELETE_PENDING
v DISABLE_PENDING
v DROP_PENDING
v LOAD_IN_PROGRESS
v LOAD_PENDING
v NORMAL
v OFFLINE
v PSTAT_CREATION
v PSTAT_DELETION
v QUIESCED_SHARE
v QUIESCED_UPDATE
v REBAL_IN_PROGRESS
v REORG_IN_PROGRESS
v RESTORE_PENDING
v STORDEF_ALLOWED
v STORDEF_CHANGED
v STORDEF_PENDING
v SUSPEND_WRITE
1378
TBSP_PREFETCH_SIZE
BIGINT

prefetch size
TBSP_NUM_QUIESCERS
BIGINT
quiescers
TBSP_STATE_CHANGE_
OBJECT_ID
BIGINT
TBSP_STATE_CHANGE_
TBSP_ID
BIGINT
TBSP_MIN_RECOVERY_
TIME
TIMESTAMP
TBSP_TOTAL_PAGES
BIGINT

space
TBSP_USABLE_PAGES
BIGINT

table space
TBSP_USED_PAGES
BIGINT

table space

element
Column name
Data type
TBSP_FREE_PAGES
BIGINT

space
TBSP_PENDING_FREE_
PAGES
BIGINT
TBSP_PAGE_TOP
BIGINT

water mark
REBALANCER_MODE
VARCHAR
(30)
v FWD_REBAL
v NO_REBAL
v REV_REBAL
REBALANCER_EXTENTS_
REMAINING
BIGINT

the rebalancer
REBALANCER_EXTENTS_
PROCESSED
BIGINT

processed
REBALANCER_PRIORITY
BIGINT
REBALANCER_START_
TIME
TIMESTAMP
REBALANCER_RESTART_
TIME
TIMESTAMP
REBALANCER_LAST_
EXTENT_MOVED
BIGINT
TBSP_NUM_RANGES
BIGINT

TBSP_NUM_CONTAINERS
BIGINT
TBSP_INITIAL_SIZE
BIGINT

size
TBSP_CURRENT_SIZE
BIGINT

space size
TBSP_MAX_SIZE
BIGINT

space size
TBSP_INCREASE_SIZE
BIGINT

bytes
TBSP_INCREASE_SIZE_
PERCENT
SMALLINT
size by percent
TIMESTAMP

successful resize
TBSP_LAST_RESIZE_
FAILED
SMALLINT

attempt failed
1379

element
Column name
Data type
TBSP_PATHS_DROPPED
SMALLINT

DBPARTITIONNUM
SMALLINT

SNAP_GET_TBSP_V91
The SNAP_GET_TBSP_V91 table function returns snapshot information from the
table space logical data group.
Important: The SNAP_GET_TBSP_V91 table function is deprecated and have been
replaced by the MON_GET_TABLESPACE table function - Get table space
returned.
Syntax
SNAP_GET_TBSP_V91 (
dbname
, dbpartitionnum

dbname
dbpartitionnum
SNAP_GET_TBSP_V91 table function takes a snapshot for the currently connected
database and database partition number.
1380
Authorization
v EXECUTE privilege on the SNAP_GET_TBSP_V91 table function
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve a list of table spaces for all database partitions for the currently connected
database.
TBSP_CONTENT_TYPE, DBPARTITIONNUM FROM TABLE(SNAP_GET_TBSP_V91()) AS T

TBSP_NAME TBSP_ID
---------- -------...TEMPSPACE1
1
USERSPACE1
2
SYSCATSPAC
0
TEMPSPACE1
1
USERSPACE1
2
SYSTOOLSPA
3
TEMPSPACE1
1
USERSPACE1
2
TBSP_TYPE
---------SMS
DMS
DMS
SMS
DMS
DMS
SMS
DMS
----------------- -------------SYSTEMP
1
LONG
1
ANY
0
SYSTEMP
0
LONG
0
LONG
0
SYSTEMP
2
LONG
2
Table 334. Information returned by the SNAP_GET_TBSP_V91 table function
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TBSP_NAME
VARCHAR(128)

name
TBSP_ID
BIGINT

identification
1381
Table 334. Information returned by the SNAP_GET_TBSP_V91 table function (continued)

Column name
Data type
TBSP_TYPE
VARCHAR(10)
monitor element
v DMS
v SMS
TBSP_CONTENT_TYPE
VARCHAR(10)
v ANY
v LARGE
v SYSTEMP
v USRTEMP
1382
TBSP_PAGE_SIZE
BIGINT

page size
TBSP_EXTENT_SIZE
BIGINT
space extent size
TBSP_PREFETCH_SIZE
BIGINT
space prefetch size
TBSP_CUR_POOL_ID
BIGINT
TBSP_NEXT_POOL_ID
BIGINT
startup
FS_CACHING
SMALLINT
POOL_DATA_L_READS
BIGINT

data logical reads
POOL_DATA_P_READS
BIGINT

data physical reads
BIGINT
BIGINT
BIGINT
POOL_DATA_WRITES
BIGINT

writes
BIGINT
POOL_INDEX_L_READS
BIGINT

index logical reads
POOL_INDEX_P_READS
BIGINT

BIGINT

monitor element
Column name
Data type
BIGINT
reads
BIGINT
POOL_INDEX_WRITES
BIGINT

index writes
BIGINT
POOL_XDA_L_READS
BIGINT

POOL_XDA_P_READS
BIGINT

POOL_XDA_WRITES
BIGINT

Data Writes
BIGINT
Reads
BIGINT
Writes
BIGINT
Reads
BIGINT
POOL_READ_TIME
BIGINT

physical read time
POOL_WRITE_TIME
BIGINT

physical write time
BIGINT

BIGINT
POOL_ASYNC_DATA_
READ_REQS
BIGINT
POOL_ASYNC_INDEX_
READ_REQS
BIGINT

read requests
POOL_ASYNC_XDA_
READ_REQS
BIGINT
Requests
BIGINT
DIRECT_READS
BIGINT

database
1383

monitor element
Column name
Data type
DIRECT_WRITES
BIGINT

database
DIRECT_READ_REQS
BIGINT

requests
DIRECT_WRITE_REQS
BIGINT

requests
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT

time
FILES_CLOSED
BIGINT
BIGINT
prefetch pages
VARCHAR(10)

v NO_REBAL
v FWD_REBAL
v REV_REBAL
SMALLINT

storage
SMALLINT

enabled
DBPARTITIONNUM
SMALLINT
SNAPUTIL administrative view and SNAP_GET_UTIL table

function - Retrieve utility_info logical data group snapshot
information
The SNAPUTIL administrative view and the SNAP_GET_UTIL table function
return snapshot information about the utilities from the utility_info logical data
group.
Important: The SNAPUTIL administrative view and the SNAP_GET_UTIL table
function are deprecated and have been replaced by the MON_GET_UTILITY table
function - Get utilities running on the database on page 783.
v SNAPUTIL administrative view on page 1385
v SNAP_GET_UTIL table function on page 1386
1384
SNAPUTIL administrative view

Used in conjunction with the SNAPUTIL_PROGRESS administrative view, the
SNAPUTIL administrative view provides the same information as the LIST
UTILITIES SHOW DETAIL CLP command.
returned.
Authorization
v SELECT privilege on the SNAPUTIL administrative view
v CONTROL privilege on the SNAPUTIL administrative view
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_UTIL table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a list of utilities and their states on all database members for all active
databases in the instance that contains the connected database.
SELECT UTILITY_TYPE, UTILITY_PRIORITY, SUBSTR(UTILITY_DESCRIPTION, 1, 72)
AS UTILITY_DESCRIPTION, SUBSTR(UTILITY_DBNAME, 1, 17) AS
UTILITY_DBNAME, UTILITY_STATE, UTILITY_INVOKER_TYPE, DBPARTITIONNUM
FROM SYSIBMADM.SNAPUTIL ORDER BY DBPARTITIONNUM

UTILITY_TYPE
UTILITY_PRIORITY ...
------------...- ---------------- ...
LOAD
- ...
1385
LOAD
LOAD
- ...
- ...

...
...
...
...
...
UTILITY_DESCRIPTION
...
-----------------------------------------------------------------...
ONLINE LOAD DEL AUTOMATIC INDEXING INSERT COPY NO TEST .LOADTEST ...

...
...
...
...
...
UTILITY_DBNAME
----------------SAMPLE
SAMPLE
SAMPLE
UTILITY_STATE
------------EXECUTE
EXECUTE
EXECUTE
UTILITY_INVOKER_TYPE DBPARTITIONNUM
-------------------- -------------USER
0
USER
1
USER
2
SNAP_GET_UTIL table function

The SNAP_GET_UTIL table function returns the same information as the
SNAPUTIL administrative view, but allows you to retrieve the information for a
members.
Used in conjunction with the SNAP_GET_UTIL_PROGRESS table function, the
SNAP_GET_UTIL table function provides the same information as the LIST
returned.
Syntax
SNAP_GET_UTIL (
member

member
applications.
SNAP_GET_UTIL table function takes a snapshot for the currently connected
1386
Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Examples
Example 1: Retrieve a list of utility ids with their type and state for the currently
connected database member on database SAMPLE.
SELECT UTILITY_ID, UTILITY_TYPE, UTILITY_STATE
FROM TABLE(SNAP_GET_UTIL(-1)) AS T WHERE UTILITY_DBNAME=SAMPLE

UTILITY_ID
UTILITY_TYPE
STATE
-------------------- -------------------------- -------1 BACKUP
EXECUTE
Example 2: Retrieve a list of utility ids with their type, member number and
database partition number for the currently connected database member.
SELECT UTILITY_ID, UTILITY_TYPE, MEMBER, DBPARTITIONNUM
FROM TABLE(SNAP_GET_UTIL(-1)) AS T

UTILITY_ID UTILITY_TYPE
----------- -------------------------- ------ -------------2 BACKUP
2
2
Table 335. Information returned by the SNAPUTIL administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
UTILITY_ID
INTEGER

database partition.
1387
SNAP_GET_UTIL table function (continued)
Column name
Data type
UTILITY_TYPE
VARCHAR(26)
monitor element
utility_type - Utility type. This
and is one of:
v BACKUP
v CRASH_RECOVERY
v LOAD
v REBALANCE
v REDISTRIBUTE
v RESTORE
v RUNSTATS
UTILITY_PRIORITY
INTEGER
utility_priority - Utility priority.

UTILITY_DESCRIPTION
VARCHAR(2048) utility_description - Utility

description. Can be null.
UTILITY_DBNAME
VARCHAR(128)
utility_dbname - Database
operated on by utility
UTILITY_START_TIME
TIMESTAMP

time
UTILITY_STATE
VARCHAR(10)

and is one of:
v ERROR
v EXECUTE
v WAIT
VARCHAR(10)
invoker type. This interface returns
v AUTO
v USER
DBPARTITIONNUM
SMALLINT
PROGRESS_LIST_ATTR
VARCHAR(10)
progress_list_attr - Current
progress list attributes
PROGRESS_LIST_CUR_SEQ_NUM INTEGER
1388
progress_list_current_seq_num Currentprogress list sequence

number
Column name
Data type
MEMBER
SMALLINT
monitor element
monitor element
SNAP_WRITE_FILE procedure
The SNAP_WRITE_FILE procedure writes system snapshot data to a file in the tmp
subdirectory of the instance directory.
Important: The SNAP_WRITE_FILE procedure is deprecated and might be
removed in a future release. Start using the monitoring SQL interfaces. If you still
need to write snapshot data to a file, use other methods before this procedure
becomes discontinued.
Syntax
SNAP_WRITE_FILE (
requestType
, dbname
member
requestType
An input argument of type VARCHAR (32) that specifies a valid snapshot
request type. The possible request types are text identifiers based on defines in
sqlmon.h, and are one of:
v APPL_ALL
v BUFFERPOOLS_ALL
v DB2
v DBASE_ALL
v
v
v
v
DBASE_LOCKS
DBASE_TABLES
DBASE_TABLESPACES
DYNAMIC_SQL
dbname
Specify NULL or empty string to take the snapshot from the currently connected
database.
member
Specify -1 for the current member, or -2 for an aggregate of all active
members. An active member is a member where the database is available for
connection and use by applications.
If a null value is specified, -1 is set implicitly.
1389
Authorization
One of the following authorizations is required to execute the procedure:
v SYSMON authority
v SYSCTRL authority
v SYSADM authority
Note: If you do not have SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority,
you can read the saved snapshot data by passing null values as the inputs to
snapshot functions.

Example
Take a snapshot of database manager information by specifying a request type of
'DB2' (which corresponds to SQLMA_DB2), and defaulting to the currently
connected database and current database partition.
CALL SYSPROC.SNAP_WRITE_FILE (DB2, , -1)
This will result in snapshot data being written to the instance temporary directory,
which is sqllib/tmp/SQLMA_DB2.dat on UNIX operating systems, and
sqllib\DB2\tmp\SQLMA_DB2.dat on a Windows operating system.
Usage notes
If an unrecognized input parameter is provided, the following error is returned:
SQL2032N The "REQUEST_TYPE" parameter is not valid.
SNAPAGENT administrative view and SNAP_GET_AGENT

table function - Retrieve agent logical data group application
The SNAPAGENT administrative view and the SNAP_GET_AGENT table function
return information about agents from an application snapshot, in particular, the
agent logical data group.
Important: The SNAPAGENT administrative view and the SNAP_GET_AGENT
table function are deprecated and have been replaced by the MON_GET_AGENT
table function - List agents running in a service class on page 505 and
v SNAPAGENT administrative view on page 1220
v SNAP_GET_AGENT table function on page 1221
1390
SNAPAGENT administrative view

This administrative view allows you to retrieve agent logical data group
application snapshot information for the currently connected database.
Used with the MON_GET_CONNECTION, MON_GET_MEMORY_POOL, and
MON_GET_MEMORY_SET table functions and the MON_CURRENT_SQL and
SNAPSUBSECTION administrative views, the SNAPAGENT administrative view
provides information equivalent to the GET SNAPSHOT FOR APPLICATIONS ON
database-alias CLP command, but retrieves data from all database members.
returned.
Authorization
v SELECT privilege on the SNAPAGENT administrative view
v
v
v
v
CONTROL privilege on the SNAPAGENT administrative view

DBADM authority
SQLADM authority

v
v
v
v
EXECUTE privilege on the SNAP_GET_AGENT table function

DBADM authority
SQLADM authority

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve all application snapshot information for the currently connected database
from the agent logical data group.
SELECT * FROM SYSIBMADM.SNAPAGENT

SNAPSHOT_TIMESTAMP
DB_NAME
AGENT_ID
...
-------------------------- -------...- ---------...--- ...
2005-07-19-11.03.26.740423 SAMPLE
101 ...
1391
2005-07-19-11.03.26.740423 SAMPLE
49 ...
...
...

...
...
...
...
...
...
AGENT_PID
LOCK_TIMEOUT_VAL
DBPARTITIONNUM
-------------------- -------------------- -------------11980
-1
0
15940
-1
0

The SNAP_GET_AGENT table function returns the same information as the
SNAPAGENT administrative view, but allows you to retrieve the information for a
Used with the SNAP_GET_AGENT_MEMORY_POOL, SNAP_GET_APPL,
functions, the SNAP_GET_AGENT table function provides information equivalent
to the GET SNAPSHOT FOR ALL APPLICATIONS CLP command, but retrieves data from
all database members.
returned.
Syntax
SNAP_GET_AGENT (
dbname
, member

dbname
member
1392
SNAP_GET_AGENT table function takes a snapshot for the currently connected
Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve all application snapshot information for all applications in all active
databases.
SELECT * FROM TABLE(SNAP_GET_AGENT(CAST(NULL AS VARCHAR(128)), -1)) AS T

SNAPSHOT_TIMESTAMP
-------------------------2006-01-03-17.21.38.530785
2006-01-03-17.21.38.530785
2006-01-03-17.21.38.530785
2006-01-03-17.21.38.530785
2006-01-03-17.21.38.530785
2006-01-03-17.21.38.530785
DB_NAME
AGENT_ID
-------...- --------...-SAMPLE
48
SAMPLE
47
SAMPLE
46
TESTDB
30
TESTDB
29
TESTDB
28
...
...
...
...
...
...
...
...

... AGENT_PID
LOCK_TIMEOUT_VAL
DBPARTITIONNUM
... ---------...---- -------------------- -------------...
7696
-1
0
...
8536
-1
0
...
6672
-1
0
...
2332
-1
0
...
8360
-1
0
...
6736
-1
0
...
1393
Table 336. Information returned by the SNAPAGENT administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
AGENT_ID
BIGINT

(agent ID)
AGENT_PID
BIGINT

unit (EDU)
LOCK_TIMEOUT_VAL
BIGINT

(seconds)
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAPAGENT_MEMORY_POOL administrative view and

SNAP_GET_AGENT_MEMORY_POOL table function - Retrieve
memory_pool logical data group snapshot information
The SNAPAGENT_MEMORY_POOL administrative view and the
SNAP_GET_AGENT_MEMORY_POOL table function return information about
memory usage at the agent level.
Important: The SNAPAGENT_MEMORY_POOL administrative view and
SNAP_GET_AGENT_MEMORY_POOL table function have been deprecated and
replaced by the MON_GET_MEMORY_POOL - get
v SNAPAGENT_MEMORY_POOL administrative view on page 1224
v SNAP_GET_AGENT_MEMORY_POOL table function on page 1225
SNAPAGENT_MEMORY_POOL administrative view

This administrative view allows you to retrieve the memory_pool logical data
group snapshot information about memory usage at the agent level for the
Used with the MON_GET_AGENT and MON_GET_CONNECTION table functions
and the MON_CURRENT_SQL and SNAPSUBSECTION administrative views, the
SNAPAGENT_MEMORY_POOL administrative view provides information
equivalent to the GET SNAPSHOT FOR APPLICATIONS ON database-alias CLP
command.
1394
returned.
Authorization
One of the following is required to use the view:
v SELECT privilege on the SNAPAGENT_MEMORY_POOL administrative view
v CONTROL privilege on the SNAPAGENT_MEMORY_POOL administrative view
v DBADM authority
v SQLADM authority
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a list of memory pools and their current size.
SELECT AGENT_ID, POOL_ID, POOL_CUR_SIZE FROM SYSIBMADM.SNAPAGENT_MEMORY_POOL

AGENT_ID
--------...--48
48
48
47
47
47
46
46
46
POOL_ID POOL_ CUR_SIZE

-------------- ---------...-----APPLICATION
65536
OTHER
65536
APPL_CONTROL
65536
APPLICATION
65536
OTHER
131072
APPL_CONTROL
65536
OTHER
327680
APPLICATION
262144
APPL_CONTROL
65536
SNAP_GET_AGENT_MEMORY_POOL table function

The SNAP_GET_AGENT_MEMORY_POOL table function returns the same
information as the SNAPAGENT_MEMORY_POOL administrative view, but allows
1395
you to retrieve the information for a specific database on a specific database

member, aggregate of all database members or all database members.
Used with the SNAP_GET_AGENT, SNAP_GET_APPL, SNAP_GET_APPL_INFO,
SNAP_GET_STMT and SNAP_GET_SUBSECTION table functions, the
SNAP_GET_AGENT_MEMORY_POOL table function provides information
equivalent to the GET SNAPSHOT FOR ALL APPLICATIONS CLP command.
returned.
Syntax
SNAP_GET_AGENT_MEMORY_POOL (
dbname
, member

dbname
member
SNAP_GET_AGENT_MEMORY_POOL table function takes a snapshot for the
Authorization
also required:
v SYSMON
v SYSCTRL
1396
v SYSMAINT
v SYSADM

Example
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, AGENT_ID, POOL_ID, POOL_CUR_SIZE
FROM TABLE(SNAP_GET_AGENT_MEMORY_POOL(CAST (NULL AS VARCHAR(128)), -1))
AS T

DB_NAME AGENT_ID
-------- --------...--SAMPLE
48
SAMPLE
48
SAMPLE
48
SAMPLE
47
SAMPLE
47
SAMPLE
47
SAMPLE
46
SAMPLE
46
SAMPLE
46
TESTDB
30
TESTDB
30
TESTDB
30
TESTDB
29
TESTDB
29
TESTDB
29
TESTDB
28
TESTDB
28
TESTDB
28
POOL_ID
POOL_CUR_SIZE
-------------- -------------------APPLICATION
65536
OTHER
65536
APPL_CONTROL
65536
APPLICATION
65536
OTHER
131072
APPL_CONTROL
65536
OTHER
327680
APPLICATION
262144
APPL_CONTROL
65536
APPLICATION
65536
OTHER
65536
APPL_CONTROL
65536
APPLICATION
65536
OTHER
131072
APPL_CONTROL
65536
OTHER
327680
APPLICATION
65536
APPL_CONTROL
65536
and the SNAP_GET_AGENT_MEMORY_POOL table function
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
AGENT_ID
BIGINT

(agent ID)
AGENT_PID
BIGINT

unit (EDU)
1397

and the SNAP_GET_AGENT_MEMORY_POOL table function (continued)
Column name
Data type
POOL_ID
VARCHAR(14)
monitor element
v APP_GROUP
v APPL_CONTROL
v APPLICATION
v BP
v CAT_CACHE
v DATABASE
v DFM
v FCMBP
v IMPORT_POOL
v LOCK_MGR
v MONITOR
v OTHER
v PACKAGE_CACHE
v QUERY
v SHARED_SORT
v SORT
v STATEMENT
v STATISTICS
v UTILITY
POOL_CUR_SIZE
BIGINT

memory pool
POOL_WATERMARK
BIGINT

watermark
POOL_CONFIG_SIZE
BIGINT

of memory pool
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

SNAP_GET_APPL_INFO table function - Retrieve appl_info
The SNAPAPPL_INFO administrative view and the SNAP_GET_APPL_INFO table
function return information about applications from an application snapshot, in
particular, the appl_info logical data group.
Important: The SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO table function are deprecated and have been replaced by
the MON_GET_CONNECTION table function - Get connection metrics on page
540.
1398
v SNAPAPPL_INFO administrative view on page 1228
v SNAP_GET_APPL_INFO table function on page 1229
SNAPAPPL_INFO administrative view

This administrative view allows you to retrieve appl_info logical data group
SNAPAPPL_INFO administrative view provides information equivalent to the GET
returned.
Authorization
v SELECT privilege on the SNAPAPPL_INFO administrative view
v
v
v
v
CONTROL privilege on the SNAPAPPL_INFO administrative view

DBADM authority
SQLADM authority

v DBADM authority
v SQLADM authority
Also, one of the following authorities is required:
v SYSMON
v SYSMAINT
v SYSCTRL
v SYSADM

Example
Retrieve the status of the applications connected to the current database.
1399
SELECT AGENT_ID, SUBSTR(APPL_NAME,1,10) AS APPL_NAME, APPL_STATUS

FROM SYSIBMADM.SNAPAPPL_INFO

AGENT_ID
-------------------101
49
APPL_NAME
---------db2bp.exe
db2bp.exe
APPL_STATUS
---------------------UOWEXEC
CONNECTED

The SNAP_GET_APPL_INFO table function returns the same information as the
SNAPAPPL_INFO administrative view, but allows you to retrieve the information
SNAP_GET_APPL, SNAP_GET_STMT and SNAP_GET_SUBSECTION table
functions, the SNAP_GET_APPL_INFO table function provides information
returned.
Syntax
SNAP_GET_APPL_INFO (
dbname
, member

dbname
member
1400
SNAP_GET_APPL_INFO table function takes a snapshot for the currently
Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Examples

DB_NAME AGENT_ID
-------- -------------------TOOLSDB
14
SAMPLE
15
SAMPLE
8
SAMPLE
7
APPL_NAME
---------db2bp.exe
db2bp.exe
javaw.exe
db2bp.exe
APPL_STATUS
---------------------CONNECTED
UOWEXEC
CONNECTED
UOWWAIT
table function.

-------- -----------------------------------------------------....
TESTDB
TESTDB
TESTDB
1401

monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
AGENT_ID
BIGINT

(agent ID)
APPL_STATUS
VARCHAR(22)

v BACKUP
v COMMIT_ACT
v COMP
v CONNECTED
v CONNECTPEND
v CREATE_DB
v DECOUPLED
v DISCONNECTPEND
v INTR
v IOERROR_WAIT
v LOAD
v LOCKWAIT
v RECOMP
v REMOTE_RQST
v RESTART
v RESTORE
v ROLLBACK_ACT
v TEND
v THABRT
v THCOMT
v TPREP
v UNLOAD
v UOWEXEC
v UOWWAIT
v WAITFOR_REMOTE
1402
CODEPAGE_ID
BIGINT

used by application
NUM_ASSOC_AGENTS
BIGINT
associated agents
monitor element
Column name
Data type
COORD_NODE_NUM
SMALLINT
COORD_NODE_NUM is
deprecated and is replaced by
MEMBER.
AUTHORITY_LVL
VARCHAR(512)
v ACCESSCTRL
v BINDADD
v CONNECT
v CREATE_EXT_RT
v CREATE_NOT_FENC
v CREATETAB
v DATAACCESS
v DBADM
v EXPLAIN
v IMPLICIT_SCHEMA
v LOAD
v LIBADM
v QUIESCE_CONN
v SECADM
v SQLADM
v SYSADM
v SYSCTRL
v SYSMAINT
v SYSMON
v SYSQUIESCE
v WLMADM
user.
CLIENT_PID
BIGINT
1403
monitor element
Column name
Data type
COORD_AGENT_PID
BIGINT
agent
STATUS_CHANGE_TIME
TIMESTAMP
status change time
CLIENT_PLATFORM
VARCHAR(12)

in sqlmon.h,
v AIX
v AIX64
v AS400_DRDA
v DOS
v DYNIX
v HP
v HP64
v HPIA
v HPIA64
v LINUX
v LINUX390
v LINUXIA64
v LINUXPPC
v LINUXPPC64
v LINUXX8664
v LINUXZ64
v MAC
v MVS_DRDA
v NT
v NT64
v OS2
v OS390
v SCO
v SGI
v SNI
v SUN
v SUN64
v UNKNOWN
v UNKNOWN_DRDA
v VM_DRDA
v VSE_DRDA
v WINDOWS
1404
Column name
Data type
CLIENT_PROTOCOL
VARCHAR(10)
monitor element
v CPIC
v LOCAL
v NPIPE
v TCPIP (for DB2 for Linux,
UNIX, and Windows)
v TCPIP4
v TCPIP6
TERRITORY_CODE
SMALLINT

code
APPL_NAME
VARCHAR(256)
APPL_ID
VARCHAR(128)
SEQUENCE_NO
VARCHAR(4)
PRIMARY_AUTH_ID
VARCHAR(128)
SESSION_AUTH_ID
VARCHAR(128)
authorization ID
CLIENT_NNAME
VARCHAR(128)

monitor element
CLIENT_PRDID
VARCHAR(128)
product/version ID
INPUT_DB_ALIAS
VARCHAR(128)

alias
CLIENT_DB_ALIAS
VARCHAR(128)

used by application
DB_NAME
VARCHAR(128)
DB_PATH
EXECUTION_ID
VARCHAR(128)
CORR_TOKEN
VARCHAR(128)

token
TPMON_CLIENT_USERID
VARCHAR(256)
client user ID
TPMON_CLIENT_WKSTN
VARCHAR(256)
TPMON_CLIENT_APP
VARCHAR(256)
TPMON_ACC_STR
VARCHAR(200)

accounting string
DBPARTITIONNUM
SMALLINT
WORKLOAD_ID
INTEGER
monitor element
1405
monitor element
Column name
Data type
IS_SYSTEM_APPL
SMALLINT
MEMBER
SMALLINT

monitor element
COORD_MEMBER
SMALLINT
SMALLINT

partition number.
SNAPAPPL administrative view and SNAP_GET_APPL table

function - Retrieve appl logical data group snapshot
information
The SNAPAPPL administrative view and the SNAP_GET_APPL table function
return information about applications from an application snapshot, in particular,
the appl logical data group.
v SNAPAPPL administrative view on page 1242
v SNAP_GET_APPL table function on page 1243
SNAPAPPL administrative view

This administrative view allows you to retrieve appl logical data group snapshot
SNAPAPPL administrative view provides information equivalent to the GET
returned.
Authorization
v SELECT privilege on the SNAPAPPL administrative view
v CONTROL privilege on the SNAPAPPL administrative view
1406
v DBADM authority
v SQLADM authority
One of the following privileges or authorities is required to use the table function:
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve details on rows read and written for each application in the connected
database.
FROM SYSIBMADM.SNAPAPPL

DB_NAME AGENT_ID
ROWS_READ
ROWS_WRITTEN
-------- -------------------- -------------------- -------------------SAMPLE
7
25
0

The SNAP_GET_APPL table function returns the same information as the
SNAPAPPL administrative view, but allows you to retrieve the information for a
functions, the SNAP_GET_APPL table function provides information equivalent to
database members.
returned.
1407
Syntax
SNAP_GET_APPL (
dbname
, member

dbname
member
SNAP_GET_APPL table function takes a snapshot for the currently connected
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1408
Example
databases.
FROM TABLE (SNAP_GET_APPL(CAST(NULL AS VARCHAR(128)),-1)) AS T

DB_NAME AGENT_ID
ROWS_READ
ROWS_WRITTEN
-------- --------...--- ---------...-- ------------...WSDB
679
0
0
WSDB
461
3
0
WSDB
460
4
0
TEST
680
4
0
TEST
455
6
0
TEST
454
0
0
TEST
453
50
0
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
AGENT_ID
BIGINT

(agent ID)
UOW_LOG_SPACE_USED
BIGINT
work log space used
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
INACT_STMTHIST_SZ
BIGINT
inact_stmthist_sz - Statement
history list size
POOL_DATA_L_READS
BIGINT

data logical reads
POOL_DATA_P_READS
BIGINT

data physical reads
POOL_DATA_WRITES
BIGINT

writes
POOL_INDEX_L_READS
BIGINT

index logical reads
POOL_INDEX_P_READS
BIGINT

POOL_INDEX_WRITES
BIGINT

index writes
BIGINT
BIGINT
BIGINT
1409
1410
monitor element
Column name
Data type
BIGINT
reads
BIGINT
Reads
BIGINT
POOL_XDA_L_READS
BIGINT

POOL_XDA_P_READS
BIGINT

POOL_XDA_WRITES
BIGINT

Data Writes
POOL_READ_TIME
BIGINT

physical read time
POOL_WRITE_TIME
BIGINT

physical write time
DIRECT_READS
BIGINT

database
DIRECT_WRITES
BIGINT

database
DIRECT_READ_REQS
BIGINT

requests
DIRECT_WRITE_REQS
BIGINT

requests
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT

time
BIGINT
prefetch pages
LOCKS_HELD
BIGINT
LOCK_WAITS
BIGINT
LOCK_WAIT_TIME
BIGINT

locks
LOCK_ESCALS
BIGINT

escalations
X_LOCK_ESCALS
BIGINT

escalations
DEADLOCKS
BIGINT
TOTAL_SORTS
BIGINT
TOTAL_SORT_TIME
BIGINT
SORT_OVERFLOWS
BIGINT
monitor element
Column name
Data type
COMMIT_SQL_STMTS
BIGINT
ROLLBACK_SQL_STMTS
BIGINT
DYNAMIC_SQL_STMTS
BIGINT

STATIC_SQL_STMTS
BIGINT

FAILED_SQL_STMTS
BIGINT

operations
SELECT_SQL_STMTS
BIGINT

statements executed
DDL_SQL_STMTS
BIGINT

UID_SQL_STMTS
BIGINT

statements executed
INT_AUTO_REBINDS
BIGINT
automatic rebinds
INT_ROWS_DELETED
BIGINT

deleted
INT_ROWS_UPDATED
BIGINT

updated
INT_COMMITS
BIGINT
INT_ROLLBACKS
BIGINT
BIGINT
ROWS_DELETED
BIGINT
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
ROWS_SELECTED
BIGINT
BINDS_PRECOMPILES
BIGINT
OPEN_REM_CURS
BIGINT

cursors
OPEN_REM_CURS_BLK
BIGINT

REJ_CURS_BLK
BIGINT

requests
ACC_CURS_BLK
BIGINT

cursor requests
BIGINT
LOCK_TIMEOUTS
BIGINT

timeouts
1411
monitor element
Column name
Data type
INT_ROWS_INSERTED
BIGINT

inserted
OPEN_LOC_CURS
BIGINT
OPEN_LOC_CURS_BLK
BIGINT

PKG_CACHE_LOOKUPS
BIGINT
cache lookups
PKG_CACHE_INSERTS
BIGINT

inserts
CAT_CACHE_LOOKUPS
BIGINT

lookups
CAT_CACHE_INSERTS
BIGINT

inserts
CAT_CACHE_OVERFLOWS
BIGINT
cache overflows
NUM_AGENTS
BIGINT

AGENTS_STOLEN
BIGINT
BIGINT
APPL_PRIORITY
BIGINT

priority
APPL_PRIORITY_TYPE
VARCHAR(16)
v DYNAMIC_PRIORITY
v FIXED_PRIORITY
1412
PREFETCH_WAIT_TIME
BIGINT

for prefetch
BIGINT
lookups
BIGINT
inserts
LOCKS_WAITING
BIGINT

waiting on locks
TOTAL_HASH_JOINS
BIGINT
TOTAL_HASH_LOOPS
BIGINT
HASH_JOIN_OVERFLOWS
BIGINT

overflows
HASH_JOIN_SMALL_
OVERFLOWS
BIGINT
APPL_IDLE_TIME
BIGINT

time
monitor element
Column name
Data type
UOW_LOCK_WAIT_TIME
BIGINT

UOW_COMP_STATUS
VARCHAR(14)

v APPL_END
v UOWABEND
v UOWCOMMIT
v UOWDEADLOCK
v UOWLOCKTIMEOUT
v UOWROLLBACK
v UOWUNKNOWN
BIGINT

BIGINT

microseconds)*
BIGINT

BIGINT

microseconds)*
APPL_CON_TIME
TIMESTAMP
CONN_COMPLETE_TIME
TIMESTAMP
LAST_RESET
TIMESTAMP
UOW_START_TIME
TIMESTAMP

start timestamp
UOW_STOP_TIME
TIMESTAMP

timestamp
PREV_UOW_STOP_TIME
TIMESTAMP
UOW_ELAPSED_TIME_S
BIGINT

seconds)*
UOW_ELAPSED_TIME_MS
BIGINT

ELAPSED_EXEC_TIME_S
BIGINT
seconds)*
BIGINT
in microseconds)*
1413
monitor element
Column name
Data type
VARCHAR(32)
LOCK_TIMEOUT_VAL
BIGINT

(seconds)
PRIV_WORKSPACE_NUM_
OVERFLOWS
BIGINT
INSERTS
BIGINT
LOOKUPS
BIGINT
TOP
BIGINT
SHR_WORKSPACE_NUM_
OVERFLOWS
BIGINT
INSERTS
BIGINT
LOOKUPS
BIGINT
SHR_WORKSPACE_SIZE_
TOP
BIGINT
DBPARTITIONNUM
SMALLINT
CAT_CACHE_SIZE_TOP
BIGINT

high water mark
TOTAL_OLAP_FUNCS
BIGINT

functions
OLAP_FUNC_OVERFLOWS
BIGINT
function overflows
MEMBER
SMALLINT

monitor element
SNAPBP administrative view and SNAP_GET_BP table

function - Retrieve bufferpool logical group snapshot
information
The SNAPBP administrative view and the SNAP_GET_BP table function return
information about buffer pools from a bufferpool snapshot, in particular, the
bufferpool logical data group.
1414
Important: The SNAPBP administrative view and the SNAP_GET_BP table

function are deprecated and have been replaced by the MON_GET_BUFFERPOOL
table function - Get buffer pool metrics on page 522.
v SNAPBP administrative view on page 1258
v SNAP_GET_BP table function on page 1259
SNAPBP administrative view

This administrative view allows you to retrieve bufferpool logical group snapshot
Used with the MON_GET_BUFFERPOOL table function, the SNAPBP
returned.
Authorization
v SELECT privilege on the SNAPBP administrative view
v
v
v
v
CONTROL privilege on the SNAPBP administrative view

DBADM authority
SQLADM authority

v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1415
Example
Retrieve data and index writes for all the bufferpools of the currently connected
database.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME,SUBSTR(BP_NAME,1,15)
AS BP_NAME,POOL_DATA_WRITES,POOL_INDEX_WRITES
FROM SYSIBMADM.SNAPBP

DB_NAME
-------TEST
TEST
TEST
TEST
TEST
BP_NAME
POOL_DATA_WRITES
POOL_INDEX_WRITES
--------------- -------------------- -------------------IBMDEFAULTBP
0
0
IBMSYSTEMBP4K
0
0
IBMSYSTEMBP8K
0
0
IBMSYSTEMBP16K
0
0
IBMSYSTEMBP32K
0
0

The SNAP_GET_BP table function returns the same information as the SNAPBP
database members.
Used with the SNAP_GET_BP_PART table function, the SNAP_GET_BP table
CLP command.
returned.
Syntax
SNAP_GET_BP (
dbname
, member

dbname
member
1416

SNAP_GET_BP table function takes a snapshot for the currently connected
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
T.DBPARTITIONNUM
FROM TABLE(SNAP_GET_BP(CAST(NULL AS VARCHAR(128)), -1)) AS T

DB_NAME
---------SAMPLE
TOOLSDB
TOOLSDB
BP_NAME
------------...- -------------------- ...
IBMDEFAULTBP
0 ...
IBMDEFAULTBP
0 ...
BP32K0000
0 ...

... -------------------- -------------...
0
0
...
0
0
...
0
0
1417
1418
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
BP_NAME
VARCHAR(128)
DB_NAME
VARCHAR(128)
DB_PATH
INPUT_DB_ALIAS
VARCHAR(128)

alias
POOL_DATA_L_READS
BIGINT

data logical reads
POOL_DATA_P_READS
BIGINT

data physical reads
POOL_DATA_WRITES
BIGINT

writes
POOL_INDEX_L_READS
BIGINT

index logical reads
POOL_INDEX_P_READS
BIGINT

POOL_INDEX_WRITES
BIGINT

index writes
POOL_XDA_L_READS
BIGINT

POOL_XDA_P_READS
BIGINT

POOL_XDA_WRITES
BIGINT

Data Writes
POOL_READ_TIME
BIGINT

physical read time
POOL_WRITE_TIME
BIGINT

physical write time
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
Reads
BIGINT
Writes
monitor element
Column name
Data type
BIGINT

BIGINT
POOL_ASYNC_DATA_
READ_REQS
BIGINT
POOL_ASYNC_INDEX_
READ_REQS
BIGINT

read requests
POOL_ASYNC_XDA_
READ_REQS
BIGINT
Requests
DIRECT_READS
BIGINT

database
DIRECT_WRITES
BIGINT

database
DIRECT_READ_REQS
BIGINT

requests
DIRECT_WRITE_REQS
BIGINT

requests
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT

time
BIGINT
prefetch pages
FILES_CLOSED
BIGINT
BIGINT
BIGINT
BIGINT
BIGINT
reads
BIGINT
Reads
BIGINT
BIGINT
BIGINT
I/O
1419
monitor element
Column name
Data type
BIGINT
VECTORED_IOS
BIGINT

I/O requests
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAPBP_PART administrative view and SNAP_GET_BP_PART

table function - Retrieve bufferpool_nodeinfo logical data
group snapshot information
The SNAPBP_PART administrative view and the SNAP_GET_BP_PART table
function return information about buffer pools from a bufferpool snapshot, in
particular, the bufferpool_nodeinfo logical data group.
Important: The SNAPBP_PART administrative view and the SNAP_GET_BP_PART
table function are deprecated and have been replaced by the
MON_GET_BUFFERPOOL table function - Get buffer pool metrics on page 522.
v SNAPBP_PART administrative view on page 1263
v SNAP_GET_BP_PART table function on page 1264
SNAPBP_PART administrative view

This administrative view allows you to retrieve bufferpool_nodeinfo logical data
Used with the MON_GET_BUFFERPOOL table function, the SNAPBP_PART
returned.
Authorization
v SELECT privilege on the SNAPBP_PART administrative view
v
v
v
v
1420
CONTROL privilege on the SNAPBP_PART administrative view

DBADM authority
SQLADM authority

v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve data for all bufferpools when connected to SAMPLE database.
FROM SYSIBMADM.SNAPBP_PART

DB_NAME
-------SAMPLE
SAMPLE
SAMPLE
SAMPLE
BP_NAME
BP_CUR_BUFFSZ
BP_NEW_BUFFSZ
--------------- -------------------- -------------------IBMDEFAULTBP
1000
1000
IBMSYSTEMBP4K
16
16
IBMSYSTEMBP8K
16
16
IBMSYSTEMBP16K
16
16
...
...
...
...
...
...
...

... ----------------------- -------------------...
0
3
...
0
0
...
0
0
...
0
0
...

The SNAP_GET_BP_PART table function returns the same information as the
SNAPBP_PART administrative view, but allows you to retrieve the information for
Used with the SNAP_GET_BP table function, the SNAP_GET_BP_PART table
CLP command.
1421
returned.
Syntax
SNAP_GET_BP_PART (
dbname
, member

dbname
value to take the snapshot for all bufferpools in all databases within the same
instance as the currently connected database.
member
SNAP_GET_BP_PART table function takes a snapshot for the currently connected
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1422
Example
Retrieve data for all bufferpools for all active databases when connected to the
SAMPLE database.
FROM TABLE(SNAP_GET_BP_PART(CAST(NULL AS VARCHAR(128)),-1)) AS T

DB_NAME
-------SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
BP_NAME
BP_CUR_BUFFSZ
BP_NEW_BUFFSZ
--------------- -------------------- -------------------IBMDEFAULTBP
250
250
IBMSYSTEMBP4K
16
16
IBMSYSTEMBP8K
16
16
IBMSYSTEMBP16K
16
16
IBMSYSTEMBP32K
16
16
IBMDEFAULTBP
250
250
IBMSYSTEMBP4K
16
16
IBMSYSTEMBP8K
16
16
IBMSYSTEMBP16K
16
16
IBMSYSTEMBP32K
16
16
...
...
...
...
...
...
...
...
...
...
...
...
...

... ----------------------- -------------------...
0
3
...
0
0
...
0
0
...
0
0
...
0
0
...
0
3
...
0
0
...
0
0
...
0
0
...
0
0
...
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
BP_NAME
VARCHAR(128)
DB_NAME
VARCHAR(128)
BP_CUR_BUFFSZ
BIGINT
bp_cur_buffsz - current size of

buffer pool
BP_NEW_BUFFSZ
BIGINT
bp_new_buffsz - New buffer pool

size
BIGINT
bp_pages_left_to_remove Number of pages left to remove
BP_TBSP_USE_COUNT
BIGINT
bp_tbsp_use_count - Number of
table spaces mapped to buffer pool
1423
SNAP_GET_BP_PART table function (continued)
monitor element
Column name
Data type
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

SNAP_GET_CONTAINER table function - Retrieve
The SNAPCONTAINER administrative view and the SNAP_GET_CONTAINER
table function return table space snapshot information from the
Important: The SNAPCONTAINER administrative view and the
SNAP_GET_CONTAINER table function are deprecated and have been replaced by
the MON_GET_CONTAINER table function - Get table space container metrics
on page 567.
v SNAPCONTAINER administrative view on page 1271
v SNAP_GET_CONTAINER table function on page 1272
SNAPCONTAINER administrative view

This administrative view allows you to retrieve tablespace_container logical data
Used with the MON_GET_TABLESPACE table function and the
SNAPTBSP_QUIESCER SNAPTBSP_RANGE administrative view, the
SNAPCONTAINER administrative view returns data equivalent to the GET
returned.
Authorization
v SELECT privilege on the SNAPCONTAINER administrative view
v CONTROL privilege on the SNAPCONTAINER administrative view
v DBADM authority
v SQLADM authority
1424
v
v
v
v
EXECUTE privilege on the SNAP_GET_CONTAINER table function

DBADM authority
SQLADM authority

also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve details for the table space containers for all database members for the
SELECT SNAPSHOT_TIMESTAMP, SUBSTR(TBSP_NAME, 1, 15) AS TBSP_NAME,
TBSP_ID, SUBSTR(CONTAINER_NAME, 1, 20) AS CONTAINER_NAME,
CONTAINER_ID, CONTAINER_TYPE, ACCESSIBLE, DBPARTITIONNUM
FROM SYSIBMADM.SNAPCONTAINER ORDER BY DBPARTITIONNUM

SNAPSHOT_TIMESTAMP
-------------------------2006-01-08-16.49.24.639945
2006-01-08-16.49.24.639945
2006-01-08-16.49.24.639945
2006-01-08-16.49.24.639945
2006-01-08-16.49.24.640747
2006-01-08-16.49.24.640747
2006-01-08-16.49.24.639981
2006-01-08-16.49.24.639981
TBSP_NAME
TBSP_ID ...
--------------- -------- ...
SYSCATSPACE
0 ...
TEMPSPACE1
1 ...
USERSPACE1
2 ...
SYSTOOLSPACE
3 ...
TEMPSPACE1
1 ...
USERSPACE1
2 ...
TEMPSPACE1
1 ...
USERSPACE1
2 ...
...

...
...
...
...
...
...
...
...
...
...
CONTAINER_NAME
CONTAINER_ID CONTAINER_TYPE
...
-------------------- ------------- ---------------- ...
0 PATH
...
0 PATH
...
0 PATH
...

... ACCESSIBLE DBPARTITIONNUM
... ---------- -------------...
1
0
...
1
0
...
1
0
1425
...
...
...
...
...
1
1
1
1
1
0
1
1
2
2

The SNAP_GET_CONTAINER table function returns the same information as the
SNAPCONTAINER administrative view, but allows you to retrieve the information
SNAP_GET_TBSP_QUIESCER and SNAP_GET_TBSP_RANGE table functions, the
SNAP_GET_CONTAINER table function returns data equivalent to the GET
returned.
Syntax
SNAP_GET_CONTAINER (
dbname
, member

dbname
member
used, that is, only dbname is provided, data is returned from all members
where the database is active.
SNAP_GET_CONTAINER table function takes a snapshot for the currently
connected database and database member.
Authorization
v EXECUTE privilege on the SNAP_GET_CONTAINER table function
1426
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
FROM TABLE(SNAP_GET_CONTAINER(,-1)) AS T

SNAPSHOT_TIMESTAMP
-------------------------2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
2005-04-25-14.42.10.899253
TBSP_NAME
TBSP_ID ...
-------------------- ------- ...
SYSCATSPACE
0 ...
TEMPSPACE1
1 ...
USERSPACE1
2 ...
SYSTOOLSPACE
3 ...
MYTEMP
4 ...
WHATSNEWTEMPSPACE
5 ...

...
...
...
...
...
...
...
...
CONTAINER_NAME
CONTAINER_ID ...
---------------------------------------- ------------ ...
0 ...
0 ...
0 ...
0 ...
0 ...
0 ...

...
...
...
...
...
...
...
...
-------------- ---------CONT_PATH
1
CONT_PATH
1
CONT_PATH
1
CONT_PATH
1
CONT_PATH
1
CONT_PATH
1
NOTE: The BUFFERPOOL database manager monitor switch must be turned on in
1427
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TBSP_NAME
VARCHAR(128)

name
TBSP_ID
BIGINT

identification
CONTAINER_NAME
VARCHAR(256)
CONTAINER_ID
BIGINT
identification
CONTAINER_TYPE
VARCHAR(16)

of:
v DISK_EXTENT_TAG
v DISK_PAGE_TAG
v FILE_EXTENT_TAG
v FILE_PAGE_TAG
v PATH
TOTAL_PAGES
BIGINT

in container
USABLE_PAGES
BIGINT
pages in container
ACCESSIBLE
SMALLINT
of container
STRIPE_SET
BIGINT
DBPARTITIONNUM
SMALLINT
FS_ID
VARCHAR(22)

FS_TOTAL_SIZE
BIGINT

system
FS_USED_SIZE
BIGINT


logical group
751.
1428
v SNAPDB administrative view on page 1278

Authorization
v CONTROL privilege on the SNAPDB administrative view
v DBADM authority
v SQLADM authority
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Examples
1429


DB_NAME
-------...TEST
TEST
TEST
DB_STATUS
-----------ACTIVE
ACTIVE
ACTIVE
SERVER_PLATFORM
--------------AIX64
AIX64
AIX64
DB_LOCATION
-----------LOCAL
LOCAL
LOCAL
...
...
...
...
...

...
...
...
...
...
DB_CONN_TIME
DBPARTITIONNUM
-------------------------- -------------2006-01-08-16.48.30.665477
0
2006-01-08-16.48.34.005328
1
2006-01-08-16.48.34.007937
2
TOTAL_OLAP_FUNCS
-------------------- -------------------- ----------------7
2
1

---------------- ------------------ ------------- -------------- ...
128
2
1
0 ...
... -------------------- -----------------...
10
100

1430
Syntax
SNAP_GET_DB (
dbname
, member

dbname
member
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1431
Examples

DB_NAME
DB_STATUS
SERVER_PLATFORM ...
-------...- ---------... --------------- ...
SAMPLE
ACTIVE
AIX64
...

... ------------ -------------------------... LOCAL
2005-07-24-22.09.22.013196

DB_NAME
--------...TOOLSDB
SAMPLE
DB_STATUS
---------...
ACTIVE
ACTIVE
SERVER_PLATFORM
--------------AIX64
AIX64
...
...
...
...

...
...
...
...
DB_LOCATION
-----------LOCAL
LOCAL
DB_CONN_TIME
-------------------------2005-07-24-22.26.54.396335
2005-07-24-22.09.22.013196
TOTAL_OLAP_FUNCS
---------------7
-------------------- -------------------2
1
table function.
1432
---------------- ------------------ ------------- -------------- ...

200
1
2
0 ...
Continued
...-------------------...
2
SYNC_RUNSTATS_TIME
-----------------32
SELECT SUBSTR
DB_NAME
DB_STATUS
-------------------- ---------------HADRDB
ACTIVE_STANDBY
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
DB_NAME
VARCHAR(128)
DB_PATH
VARCHAR(1024)
INPUT_DB_ALIAS
VARCHAR(128)
DB_STATUS
VARCHAR(16)

v ACTIVE
v QUIESCE_PEND
v QUIESCED
v ROLLFWD
enabled.
enabled).
CATALOG_PARTITION
SMALLINT

number
VARCHAR(128)

1433
Column name
Data type
SERVER_PLATFORM
VARCHAR(12)

element
v AIX
v AIX64
v AS400_DRDA
v DOS
v DYNIX
v HP
v HP64
v HPIA
v HPIA64
v LINUX
v LINUX390
v LINUXIA64
v LINUXPPC
v LINUXPPC64
v LINUXX8664
v LINUXZ64
v MAC
v MVS_DRDA
v NT
v NT64
v OS2
v OS390
v SCO
v SGI
v SNI
v SUN
v SUN64
v UNKNOWN
v UNKNOWN_DRDA
v VM_DRDA
v VSE_DRDA
v WINDOWS
DB_LOCATION
VARCHAR(12)

v LOCAL
v REMOTE
DB_CONN_TIME
TIMESTAMP

timestamp
LAST_RESET
TIMESTAMP
LAST_BACKUP
TIMESTAMP
1434
element
Column name
Data type
CONNECTIONS_TOP
BIGINT

TOTAL_CONS
BIGINT

activation
TOTAL_SEC_CONS
BIGINT
APPLS_CUR_CONS
BIGINT

currently
APPLS_IN_DB2
BIGINT

database currently
NUM_ASSOC_AGENTS
BIGINT

agents
AGENTS_TOP
BIGINT
COORD_AGENTS_TOP
BIGINT

coordinating agents
LOCKS_HELD
BIGINT
LOCK_WAITS
BIGINT
LOCK_WAIT_TIME
BIGINT
LOCK_LIST_IN_USE
BIGINT

use
DEADLOCKS
BIGINT
LOCK_ESCALS
BIGINT
X_LOCK_ESCALS
BIGINT
LOCKS_WAITING
BIGINT

locks
LOCK_TIMEOUTS
BIGINT
NUM_INDOUBT_TRANS
BIGINT

transactions
SORT_HEAP_ALLOCATED
BIGINT

allocated
BIGINT

currently allocated
SORT_SHRHEAP_TOP
BIGINT

water mark
BIGINT

threshold sorts
TOTAL_SORTS
BIGINT
TOTAL_SORT_TIME
BIGINT
SORT_OVERFLOWS
BIGINT
ACTIVE_SORTS
BIGINT
POOL_DATA_L_READS
BIGINT

reads
POOL_DATA_P_READS
BIGINT

physical reads
1435
element
Column name
Data type
BIGINT

BIGINT

BIGINT

POOL_DATA_WRITES
BIGINT
BIGINT

POOL_INDEX_L_READS
BIGINT

logical reads
POOL_INDEX_P_READS
BIGINT

physical reads
BIGINT

BIGINT

BIGINT

POOL_INDEX_WRITES
BIGINT
BIGINT

POOL_XDA_P_READS
BIGINT

Physical Reads
POOL_XDA_L_READS
BIGINT

Logical Reads
POOL_XDA_WRITES
BIGINT

Writes
BIGINT

BIGINT

BIGINT

monitor element
BIGINT

POOL_READ_TIME
BIGINT

read time
POOL_WRITE_TIME
BIGINT

write time
BIGINT

BIGINT

1436
element
Column name
Data type
POOL_ASYNC_DATA_
READ_REQS
BIGINT

BIGINT

BIGINT

BIGINT

victim buffers
POOL_LSN_GAP_CLNS
BIGINT

cleaners triggered
BIGINT

BIGINT

PREFETCH_WAIT_TIME
BIGINT

prefetch
BIGINT

pages
DIRECT_READS
BIGINT
DIRECT_WRITES
BIGINT
DIRECT_READ_REQS
BIGINT
DIRECT_WRITE_REQS
BIGINT
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT
FILES_CLOSED
BIGINT
ELAPSED_EXEC_TIME_S
BIGINT

elapsed time
BIGINT

elapsed time
COMMIT_SQL_STMTS
BIGINT

attempted
ROLLBACK_SQL_STMTS
BIGINT

attempted
DYNAMIC_SQL_STMTS
BIGINT

STATIC_SQL_STMTS
BIGINT

attempted
FAILED_SQL_STMTS
BIGINT
SELECT_SQL_STMTS
BIGINT

executed
UID_SQL_STMTS
BIGINT
DDL_SQL_STMTS
BIGINT

INT_AUTO_REBINDS
BIGINT

1437
Column name
Data type

element
INT_ROWS_DELETED
BIGINT
INT_ROWS_INSERTED
BIGINT
INT_ROWS_UPDATED
BIGINT
INT_COMMITS
BIGINT
INT_ROLLBACKS
BIGINT
BIGINT

due to deadlock
ROWS_DELETED
BIGINT
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
ROWS_SELECTED
BIGINT
ROWS_READ
BIGINT
BINDS_PRECOMPILES
BIGINT
attempted
TOTAL_LOG_AVAILABLE
BIGINT
TOTAL_LOG_USED
BIGINT
SEC_LOG_USED_TOP
BIGINT

space used
TOT_LOG_USED_TOP
BIGINT

used
SEC_LOGS_ALLOCATED
BIGINT

currently
LOG_READS
BIGINT
LOG_READ_TIME_S
BIGINT
LOG_READ_TIME_NS
BIGINT
LOG_WRITES
BIGINT
LOG_WRITE_TIME_S
BIGINT
LOG_WRITE_TIME_NS
BIGINT
NUM_LOG_WRITE_IO
BIGINT
NUM_LOG_READ_IO
BIGINT
BIGINT

log page writes
NUM_LOG_BUFFER_FULL
BIGINT

buffers
BIGINT
APPL_ID_OLDEST_XACT
BIGINT

transaction
BIGINT

BIGINT

1438
Column name
Data type

element
PKG_CACHE_LOOKUPS
BIGINT
PKG_CACHE_INSERTS
BIGINT
BIGINT

overflows
PKG_CACHE_SIZE_TOP
BIGINT

water mark
BIGINT
BIGINT
CAT_CACHE_LOOKUPS
BIGINT
CAT_CACHE_INSERTS
BIGINT
CAT_CACHE_OVERFLOWS
BIGINT

overflows
CAT_CACHE_SIZE_TOP
BIGINT

water mark
BIGINT

workspace size
BIGINT
workspace overflows
BIGINT
BIGINT
BIGINT

workspace size
BIGINT
workspace overflows
BIGINT
BIGINT
TOTAL_HASH_JOINS
BIGINT
TOTAL_HASH_LOOPS
BIGINT
HASH_JOIN_OVERFLOWS
BIGINT
BIGINT

overflows
BIGINT
ACTIVE_HASH_JOINS
BIGINT
BIGINT
DBPARTITIONNUM
SMALLINT

monitor element
INTEGER

available log space
1439
Column name
Data type

element
TOTAL_OLAP_FUNCS
BIGINT
OLAP_FUNC_OVERFLOWS
BIGINT

overflows
ACTIVE_OLAP_FUNCS
BIGINT
STATS_CACHE_SIZE
BIGINT
STATS_FABRICATIONS
BIGINT

fabrications
SYNC_RUNSTATS
BIGINT

RUNSTATS activities
ASYNC_RUNSTATS
BIGINT

BIGINT

SYNC_RUNSTATS_TIME
BIGINT

BIGINT
MEMBER
SMALLINT
SNAPDB_MEMORY_POOL administrative view and

SNAP_GET_DB_MEMORY_POOL table function - Retrieve
database level memory usage information
Important: Starting in Version 9.7 Fix Pack 5, the SNAPDB_MEMORY_POOL
administrative view and SNAP_GET_DB_MEMORY_POOL table function have
v SNAPDB_MEMORY_POOL administrative view on page 1290
v SNAP_GET_DB_MEMORY_POOL table function on page 1292
SNAPDB_MEMORY_POOL administrative view

This administrative view allows you to retrieve database level memory usage
1440
Used with the MON_GET_DATABASE, MON_GET_TRANSACTION_LOG,

MON_GET_HADR, and ADMIN_GET_STORAGE_PATHS table functions, the
SNAPDB_MEMORY_POOL administrative view provides information equivalent
to the GET SNAPSHOT FOR DATABASE ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPDB_MEMORY_POOL administrative view
v CONTROL privilege on the SNAPDB_MEMORY_POOL administrative view
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a list of memory pools and their current size for the currently connected
database, SAMPLE.
SELECT POOL_ID, POOL_CUR_SIZE FROM SYSIBMADM.SNAPDB_MEMORY_POOL

POOL_ID
POOL_CUR_SIZE
------------- -------------------UTILITY
32768
PACKAGE_CACHE
475136
CAT_CACHE
65536
BP
2097152
BP
1081344
BP
540672
BP
278528
BP
147456
BP
81920
LOCK_MGR
294912
DATABASE
3833856
OTHER
0
1441
SNAP_GET_DB_MEMORY_POOL table function

The SNAP_GET_DB_MEMORY_POOL table function returns the same information
as the SNAPDB_MEMORY_POOL administrative view, but allows you to retrieve
the information for a specific database on a specific database member, aggregate of
all database members or all database members.
ADMIN_GET_STORAGE_PATHS table functions, the
SNAP_GET_DB_MEMORY_POOL table function provides information equivalent
returned.
Syntax
SNAP_GET_DB_MEMORY_POOL (
dbname
, member

dbname
member
SNAP_GET_DB_MEMORY_POOL table function takes a snapshot for the currently
Authorization
1442

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, POOL_ID, POOL_CUR_SIZE
FROM TABLE(SNAPSHOT_GET_DB_MEMORY_POOL
(CAST(NULL AS VARCHAR(128)), -1)) AS T

DB_NAME
-------TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
TESTDB
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
SAMPLE
POOL_ID
POOL_CUR_SIZE
-------------- -------------------UTILITY
65536
PACKAGE_CACHE
851968
CAT_CACHE
65536
BP
35913728
BP
589824
BP
327680
BP
196608
BP
131072
SHARED_SORT
65536
LOCK_MGR
10092544
DATABASE
4980736
OTHER
196608
UTILITY
65536
PACKAGE_CACHE
655360
CAT_CACHE
131072
BP
4325376
BP
589824
BP
327680
BP
196608
BP
131072
SHARED_SORT
0
LOCK_MGR
655360
DATABASE
4653056
OTHER
196608
the SNAP_GET_DB_MEMORY_POOL table function
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
1443

the SNAP_GET_DB_MEMORY_POOL table function (continued)
Column name
Data type
POOL_ID
VARCHAR(14)
monitor element
v APP_GROUP
v APPL_CONTROL
v APPLICATION
v BP
v CAT_CACHE
v DATABASE
v DFM
v FCMBP
v IMPORT_POOL
v LOCK_MGR
v MONITOR
v OTHER
v PACKAGE_CACHE
v QUERY
v SHARED_SORT
v SORT
v STATEMENT
v STATISTICS
v UTILITY
POOL_SECONDARY_ID
VARCHAR(32)
pool_secondary_id - Memory pool

secondary identifier
POOL_CUR_SIZE
BIGINT

memory pool
POOL_WATERMARK
BIGINT

watermark
POOL_CONFIG_SIZE
BIGINT

of memory pool
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAPDBM administrative view and SNAP_GET_DBM table

function - Retrieve the dbm logical grouping snapshot
information
The SNAPDBM administrative view and the SNAP_GET_DBM table function
return the snapshot monitor DB2 database manager (dbm) logical grouping
information.
1444
Important: The SNAPDBM administrative view and SNAP_GET_DBM table

function are deprecated and have been replaced by the MON_GET_INSTANCE
table function - Get instance level information on page 617.
v SNAPDBM administrative view on page 1304
v SNAP_GET_DBM table function on page 1306
SNAPDBM administrative view

MON_GET_MEMORY_SET, MON_GET_MEMORY_POOL table functions, the
SNAPDBM administrative view provides the data equivalent to the GET SNAPSHOT
FOR DBM command.
returned.
Authorization
v SELECT privilege on the SNAPDBM administrative view
v
v
v
v
CONTROL privilege on the SNAPDBM administrative view

DBADM authority
SQLADM authority

v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve database manager status and connection information for all database
members.
1445
SELECT DB2_STATUS, DB2START_TIME, LAST_RESET, LOCAL_CONS, REM_CONS_IN,

(AGENTS_CREATED_EMPTY_POOL/AGENTS_FROM_POOL) AS AGENT_USAGE,
DBPARTITIONNUM FROM SYSIBMADM.SNAPDBM ORDER BY DBPARTITIONNUM

DB2_STATUS
-----------ACTIVE
ACTIVE
ACTIVE
DB2START_TIME
LAST_RESET
-------------------------- ----------...2006-01-06-14.59.59.059879
2006-01-06-14.59.59.097605
2006-01-06-14.59.59.062798
-
...
...
...
...
...
...

... LOCAL_CONS
REM_CONS_IN
AGENT_USAGE
DBPARTITIONNUM
... ----------...- -----------...- -----------...- -------------...
1
1
0
0
...
0
0
0
1
...
0
0
0
2
SNAP_GET_DBM table function

The SNAP_GET_DBM table function returns the same information as the
SNAPDBM administrative view, but allows you to retrieve the information for a
members.
Used with the SNAP_GET_DBM_MEMORY_POOL, SNAP_GET_FCM,
SNAP_GET_DBM table function provides the data equivalent to the GET SNAPSHOT
FOR DBM command.
returned.
Syntax
SNAP_GET_DBM (
member

member
applications.
SNAP_GET_DBM table function calls the snapshot from memory.
1446
Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
SELECT DB2START_TIME, DB2_STATUS FROM TABLE(SNAP_GET_DBM(2)) AS T

DB2START_TIME
DB2_STATUS
-------------------------- -----------2006-01-06-14.59.59.062798 ACTIVE
Table 345. Information returned by the SNAPDBM administrative view and the SNAP_GET_DBM table function
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
SORT_HEAP_ALLOCATED
BIGINT

allocated
BIGINT
BIGINT

requested
BIGINT
REM_CONS_IN
BIGINT

database manager
REM_CONS_IN_EXEC
BIGINT

element
LOCAL_CONS
BIGINT
LOCAL_CONS_IN_EXEC
BIGINT

element
CON_LOCAL_DBASES
BIGINT

current connects
1447
Column name
Data type

element
AGENTS_REGISTERED
BIGINT
BIGINT

for a token
DB2_STATUS
VARCHAR(12)

v ACTIVE
v QUIESCE_PEND
v QUIESCED
BIGINT

AGENTS_WAITING_TOP
BIGINT

agents waiting
COMM_PRIVATE_MEM
BIGINT

memory
IDLE_AGENTS
BIGINT
AGENTS_FROM_POOL
BIGINT

pool
BIGINT
COORD_AGENTS_TOP
BIGINT

coordinating agents
MAX_AGENT_OVERFLOWS
BIGINT

overflows
AGENTS_STOLEN
BIGINT
GW_TOTAL_CONS
BIGINT

GW_CUR_CONS
BIGINT

GW_CONS_WAIT_HOST
BIGINT
GW_CONS_WAIT_CLIENT
BIGINT
request
BIGINT

threshold
BIGINT
switches
DB2START_TIME
TIMESTAMP

timestamp
LAST_RESET
TIMESTAMP
INTEGER
PRODUCT_NAME
VARCHAR(32)
1448
Column name
Data type

element
SERVICE_LEVEL
VARCHAR(18)
SORT_HEAP_TOP
BIGINT

water mark
DBPARTITIONNUM
SMALLINT

BIGINT

threshold
MEMBER
SMALLINT

element
SNAPDBM_MEMORY_POOL administrative view and

SNAP_GET_DBM_MEMORY_POOL table function - Retrieve
database manager level memory usage information
The SNAPDBM_MEMORY_POOL administrative view and the
SNAP_GET_DBM_MEMORY_POOL table function return information about
memory usage at the database manager.
Important: Starting in Version 9.7 Fix Pack 5, the SNAPDBM_MEMORY_POOL
administrative view and SNAP_GET_DBM_MEMORY_POOL table function have
v SNAPDBM_MEMORY_POOL administrative view on page 1309
v SNAP_GET_DBM_MEMORY_POOL table function on page 1310
SNAPDBM_MEMORY_POOL administrative view

MON_GET_MEMORY_POOL table functions, the SNAPDBM_MEMORY_POOL
administrative view provides the data equivalent to the GET SNAPSHOT FOR DBM
command.
returned.
Authorization
v SELECT privilege on the SNAPDBM_MEMORY_POOL administrative view
v CONTROL privilege on the SNAPDBM_MEMORY_POOL administrative view
1449

also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve a list of the memory pools and their current size for the database manager
of the connected database.
SELECT POOL_ID, POOL_CUR_SIZE FROM SNAPDBM_MEMORY_POOL

POOL_ID
POOL_CUR_SIZE
-------------- -------------------MONITOR
65536
OTHER
29622272
FCMBP
57606144
...
SNAP_GET_DBM_MEMORY_POOL table function

The SNAP_GET_DBM_MEMORY_POOL table function returns the same
information as the SNAPDBM_MEMORY_POOL administrative view, but allows
you to retrieve the information for a specific database member, aggregate of all
Used with the SNAP_GET_DBM, SNAP_GET_FCM, SNAP_GET_FCM_PART and
SNAP_GET_SWITCHES table functions, the SNAP_GET_DBM_MEMORY_POOL
table function provides the data equivalent to the GET SNAPSHOT FOR DBM command.
returned.
Syntax
SNAP_GET_DBM_MEMORY_POOL (
)
member
1450

member
applications.
SNAP_GET_DBM_MEMORY_POOL table function takes a snapshot for the
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a list of the memory pools and their current size for all database partitions
of the database manager of the connected database.
SELECT POOL_ID, POOL_CUR_SIZE, DBPARTITIONNUM
FROM TABLE(SYSPROC.SNAP_GET_DBM_MEMORY_POOL())
AS T ORDER BY DBPARTITIONNUM

POOL_ID
POOL_CUR_SIZE
DBPARTITIONNUM
-------------- -------------------- -------------MONITOR
65536
0
OTHER
29622272
0
FCMBP
57606144
0
MONITOR
65536
1
OTHER
29425664
1
FCMBP
57606144
1
MONITOR
65536
2
OTHER
29425664
2
FCMBP
57606144
2
1451
and the SNAP_GET_DBM_MEMORY_POOL table function
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
POOL_ID
VARCHAR(14)

v APP_GROUP
v APPL_CONTROL
v APPLICATION
v BP
v CAT_CACHE
v DATABASE
v DFM
v FCMBP
v IMPORT_POOL
v LOCK_MGR
v MONITOR
v OTHER
v PACKAGE_CACHE
v QUERY
v SHARED_SORT
v SORT
v STATEMENT
v STATISTICS
v UTILITY
POOL_CUR_SIZE
BIGINT

memory pool
POOL_WATERMARK
BIGINT

watermark
POOL_CONFIG_SIZE
BIGINT

of memory pool
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

SNAP_GET_DETAILLOG table function - Retrieve snapshot
information from the detail_log logical data group
The SNAPDETAILLOG administrative view and the SNAP_GET_DETAILLOG
table function return snapshot information from the detail_log logical data group.
1452
Important: The SNAPDETAILLOG administrative view and the

SNAP_GET_DETAILLOG table function are deprecated and have been replaced by
the MON_GET_TRANSACTION_LOG table function - Get log information on
page 751.
v SNAPDETAILLOG administrative view on page 1316
v SNAP_GET_DETAILLOG table function on page 1317
SNAPDETAILLOG administrative view

detail_log logical data group for the currently connected database.
Used in conjunction with ADMIN_GET_STORAGE_PATHS,
MON_GET_DATABASE, MON_GET_HADR, MON_GET_MEMORY_POOL, and
MON_GET_MEMORY_SET table functions, the SNAPDETAILLOG administrative
view provides information equivalent to the GET SNAPSHOT FOR DATABASE on
Authorization
v SELECT privilege on the SNAPDETAILLOG administrative view
v
v
v
v
CONTROL privilege on the SNAPDETAILLOG administrative view

DBADM authority
SQLADM authority

v
v
v
v
EXECUTE privilege on the SNAP_GET_DETAILLOG table function

DBADM authority
SQLADM authority

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1453
Example
Retrieve log information for all database members for the currently connected
database.
LAST_ACTIVE_LOG, CURRENT_ACTIVE_LOG, CURRENT_ARCHIVE_LOG,
DBPARTITIONNUM
FROM SYSIBMADM.SNAPDETAILLOG ORDER BY DBPARTITIONNUM

LAST_ACTIVE_LOG
-------- -------------------- -------------------TEST
0
8
TEST
0
8
TEST
0
8
...
...
...
...
...

CURRENT_ARCHIVE_LOG DBPARTITIONNUM
... -------------------- -------------------- -------------...
0
0
...
0
1
...
0
2

The SNAP_GET_DETAILLOG table function returns the same information as the
SNAPDETAILLOG administrative view.
Used in conjunction with ADMIN_GET_STORAGE_PATHS, MON_GET_HADR,
MON_GET_MEMORY_POOL, and SNAP_GET_DB, the SNAPDETAILLOG
administrative view provides information equivalent to the GET SNAPSHOT FOR ALL
DATABASES CLP command.
Syntax
SNAP_GET_DETAILLOG (
dbname
, member

dbname
member
1454
SNAP_GET_DETAILLOG table function takes a snapshot for the currently
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve log information for database member 1 for the currently connected
database.
FROM TABLE(SNAP_GET_DETAILLOG(, 1)) AS T

LAST_ACTIVE_LOG
...
-------- -------------------- -------------------- ...
TEST
0
8 ...

CURRENT_ARCHIVE_LOG
... -------------------- -------------------...
0
-
1455
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
FIRST_ACTIVE_LOG
BIGINT

file number
LAST_ACTIVE_LOG
BIGINT

number
CURRENT_ACTIVE_LOG
BIGINT

log file number
CURRENT_ARCHIVE_LOG
BIGINT
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAPFCM administrative view and SNAP_GET_FCM table

function - Retrieve the fcm logical data group snapshot
information
The SNAPFCM administrative view and the SNAP_GET_FCM table function
return information about the fast communication manager from a database
manager snapshot, in particular, the fcm logical data group.
Important: The SNAPFCM administrative view and the SNAP_GET_FCM table
function are deprecated and have been replaced by the MON_GET_FCM - Get
FCM metrics on page 599.
v SNAPFCM administrative view on page 1325
v SNAP_GET_FCM table function on page 1326
SNAPFCM administrative view

Used with the SNAPSWITCHES administrative view an the MON_GET_FCM,
MON_GET_MEMORY_POOL table functions, the SNAPFCM administrative view
provides the data equivalent to the GET SNAPSHOT FOR DBM command.
returned.
1456
Authorization
v SELECT privilege on the SNAPFCM administrative view
v CONTROL privilege on the SNAPFCM administrative view
v DBADM authority
v SQLADM authority
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
all members.
FROM SYSIBMADM.SNAPFCM ORDER BY MEMBER

BUFF_FREE
BUFF_FREE_BOTTOM
MEMBER
---------...---- -------------------- -------------5120
5100
0
5120
5100
1
5120
5100
2

The SNAP_GET_FCM table function returns the same information as the
SNAPFCM administrative view, but allows you to retrieve the information for a
members.
SNAP_GET_FCM table function provides the data equivalent to the GET SNAPSHOT
FOR DBM command.
1457
returned.
Syntax
SNAP_GET_FCM (
member

member
all active members. If dbname is not set to NULL and member is set to NULL,-1 is
set implicitly for member. If this input option is not used, data will be returned
from all active database members. An active database member is a member
where the database is available for connection and use by applications.
corresponding snapshot API request type does not exist, then the SNAP_GET_FCM
table function takes a snapshot for the currently connected database and database
member.
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
database member 1.
FROM TABLE(SYSPROC.SNAP_GET_FCM( 1 )) AS T
1458
BUFF_FREE
BUFF_FREE_BOTTOM
MEMBER
-------------------- -------------------- -----5120
5100
1
Table 348. Information returned by the SNAPFCM administrative view and the
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
BUFF_FREE
BIGINT
buff_free - FCM buffers currently

free
BUFF_FREE_BOTTOM
BIGINT
buff_free_bottom - Minimum FCM

Buffers Free
CH_FREE
BIGINT
ch_free - Channels Currently Free
CH_FREE_BOTTOM
BIGINT
ch_free_bottom - Minimum
Channels Free
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

SNAP_GET_FCM_PART table function - Retrieve the fcm_node
The SNAPFCM_PART administrative view and the SNAP_GET_FCM_PART table
function return information about the fast communication manager from a
database manager snapshot, in particular, the fcm_node logical data group.
Important: The SNAPFCM_PART administrative view and the
SNAP_GET_FCM_PART table function are deprecated and have been replaced by
the MON_GET_FCM - Get FCM metrics on page 599.
v SNAPFCM_PART administrative view on page 1328
v SNAP_GET_FCM_PART table function on page 1329
SNAPFCM_PART administrative view

Used with he SNAPSWITCHES administrative view an the MON_GET_FCM,
MON_GET_MEMORY_POOL table functions, the SNAPFCM_PART administrative
view provides the data equivalent to the GET SNAPSHOT FOR DBM command.
returned.
1459
Authorization
v SELECT privilege on the SNAPFCM_PART administrative view
v CONTROL privilege on the SNAPFCM_PART administrative view
v DBADM authority
v SQLADM authority
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve buffers sent and received information for the fast communication
manager.
SELECT CONNECTION_STATUS, TOTAL_BUFFERS_SENT, TOTAL_BUFFERS_RECEIVED
FROM SYSIBMADM.SNAPFCM_PART WHERE MEMBER = 0

CONNECTION_STATUS
TOTAL_BUFFERS_SENT
TOTAL_BUFFERS_RCVD
-------------------- -------------------- -------------------INACTIVE
2
1

The SNAP_GET_FCM_PART table function returns the same information as the
SNAPFCM_PART administrative view, but allows you to retrieve the information
members.
SNAP_GET_FCM and SNAP_GET_SWITCHES table functions, the
SNAP_GET_FCM_PART table function provides the data equivalent to the GET
SNAPSHOT FOR DBM command.
1460
returned.
Syntax
SNAP_GET_FCM_PART (
member

member
member number. Specify -1 for the current member. If this input option is not
used, data will be returned from all active database members. An active
database member is a member where the database is available for connection
and use by applications.
SNAP_GET_FCM_PART table function takes a snapshot for the currently connected
database and member.
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve buffers sent and received information for the fast communication manager
for all members.
SELECT FCM_MEMBER, TOTAL_BUFFERS_SENT, TOTAL_BUFFERS_RCVD,
MEMBER FROM TABLE(SNAP_GET_FCM_PART()) AS T
ORDER BY MEMBER
1461
FCM_MEMBER TOTAL_BUFFERS_SENT
TOTAL_BUFFERS_RCVD
MEMBER
---------- -------------------- -------------------- -----0
305
305
0
1
5647
1664
0
2
5661
1688
0
0
19
19
1
1
305
301
1
2
1688
5661
1
0
1664
5647
2
1
10
10
2
2
301
305
2
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
CONNECTION_STATUS
VARCHAR(10)
connection_status - Connection
status. This interface returns a text
v INACTIVE
v ACTIVE
v CONGESTED
TOTAL_BUFFERS_SENT
BIGINT
total_buffers_sent - Total FCM

buffers sent
TOTAL_BUFFERS_RCVD
BIGINT
total_buffers_rcvd - Total FCM

buffers received
DBPARTITIONNUM
SMALLINT
FCM_DBPARTITIONNUM
SMALLINT
The database partition number to

which data was sent or from which
data was received (as per the
TOTAL_BUFFERS_RCVD
columns).
MEMBER
SMALLINT

monitor element
FCM_MEMBER
SMALLINT
The member to which data was

sent or from which data was
received (as per the
TOTAL_BUFFERS_RCVD
columns).
SNAPHADR administrative view and SNAP_GET_HADR table

function - Retrieve hadr logical data group snapshot
information
The SNAPHADR administrative view and the SNAP_GET_HADR table function
return information about high availability disaster recovery from a database
snapshot, in particular, the hadr logical data group.
1462
The SNAPHADR administrative view and SNAP_GET_HADR table function have

been deprecated and replaced by the MON_GET_HADR table function - Returns
high availability disaster recovery (HADR) monitoring information on page 603.
v SNAPHADR administrative view on page 1331
v SNAP_GET_HADR table function on page 1332
SNAPHADR administrative view

This administrative view allows you to retrieve hadr logical data group snapshot
information for the currently connected database. The data is only returned by this
view if the database is a primary or standby high availability disaster recovery
(HADR) database.
Used with the MON_GET_DATABASE, MON_GET_MEMORY_SET,
MON_GET_MEMORY_POOL, MON_GET_TRANSACTION_LOG and
ADMIN_GET_STORAGE_PATHS table functions, the SNAPHADR administrative
view provides information equivalent to the GET SNAPSHOT FOR DATABASE ON
returned.
Authorization
v SELECT privilege on the SNAPHADR administrative view
v CONTROL privilege on the SNAPHADR administrative view
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1463
Example
Retrieve the configuration and status information for HADR on the primary
HADR database.
FROM SYSIBMADM.SNAPHADR

DBNAME
HADR_ROLE HADR_STATE
HADR_SYNCMODE HADR_CONNECT_STATUS
-------- --------- -------------- ------------- ------------------SAMPLE
PRIMARY
PEER
SYNC
CONNECTED

The SNAP_GET_HADR table function returns the same information as the
SNAPHADR administrative view, but allows you to retrieve the information for a
Used with the SNAP_GET_DB, SNAP_GET_DB_MEMORY_POOL,
SNAP_GET_DETAILLOG and ADMIN_GET_STORAGE_PATHS table functions,
the SNAP_GET_HADR table function provides information equivalent to the GET
SNAPSHOT FOR ALL DATABASES CLP command.
returned.
Syntax
SNAP_GET_HADR (
dbname
, member

dbname
member
1464
SNAP_GET_HADR table function takes a snapshot for the currently connected
Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve the configuration and status information for HADR for all databases.
FROM TABLE (SNAP_GET_HADR (CAST (NULL as VARCHAR(128)), 0)) as T

DBNAME
-------SAMPLE
TESTDB
HADR_ROLE
--------PRIMARY
PRIMARY
HADR_STATE
-------------PEER
DISCONNECTED
HADR_SYNCMODE
------------SYNC
NEARSYNC
HADR_CONNECT_STATUS
------------------CONNECTED
DISCONNECTED
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
1465
Column name
Data type
HADR_ROLE
VARCHAR(10)
monitor element
hadr_role - HADR role. This
and is one of:
v PRIMARY
v STANDARD
v STANDBY
HADR_STATE
VARCHAR(14)
hadr_state - HADR state. This

and is one of:
v DISCONNECTED
v LOCAL_CATCHUP
v PEER
v REM_CATCH_PEN
v REM_CATCHUP
HADR_SYNCMODE
VARCHAR(10)
hadr_syncmode - HADR
synchronization mode. This
and is one of:
v ASYNC
v NEARSYNC
v SUPERASYNC
v SYNC
HADR_CONNECT_STATUS
VARCHAR(12)
hadr_connect_status - HADR
connection status. This interface
the defines in sqlmon.h, and is one
of:
v CONGESTED
v CONNECTED
v DISCONNECTED
1466
HADR_CONNECT_TIME
TIMESTAMP
hadr_connect_time - HADR
connection time
HADR_HEARTBEAT
INTEGER
hadr_heartbeat - HADR heartbeat
HADR_LOCAL_HOST
VARCHAR(255)
hadr_local_host - HADR local host
HADR_LOCAL_SERVICE
VARCHAR(40)
hadr_local_service - HADR local

service
HADR_REMOTE_HOST
VARCHAR(255)
hadr_remote_host - HADR remote

host
HADR_REMOTE_SERVICE
VARCHAR(40)
hadr_remote_service - HADR
remote service
HADR_REMOTE_INSTANCE
VARCHAR(128)
hadr_remote_instance - HADR
remote instance
HADR_TIMEOUT
BIGINT
hadr_timeout - HADR timeout
monitor element
Column name
Data type
HADR_PRIMARY_LOG_FILE
VARCHAR(255)
hadr_primary_log_file - HADR
primary log file
HADR_PRIMARY_LOG_PAGE
BIGINT
hadr_primary_log_page - HADR
primary log page
HADR_PRIMARY_LOG_LSN
BIGINT
hadr_primary_log_lsn - HADR
primary log LSN
HADR_STANDBY_LOG_FILE
VARCHAR(255)
hadr_standby_log_file - HADR
standby log file
HADR_STANDBY_LOG_PAGE
BIGINT
hadr_standby_log_page - HADR
standby log page
HADR_STANDBY_LOG_LSN
BIGINT
hadr_standby_log_lsn - HADR
standby log LSN
HADR_LOG_GAP
BIGINT
hadr_log_gap - HADR log gap
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAPLOCK administrative view and SNAP_GET_LOCK table

function - Retrieve lock logical data group snapshot
information
The SNAPLOCK administrative view and the SNAP_GET_LOCK table function
return snapshot information about locks, in particular, the lock logical data group.
replaced by the MON_GET_APPL_LOCKWAIT - Get information about locks for
which an application is waiting on page 512, MON_GET_LOCKS - List all locks
in the currently connected database on page 620, and
details on page 445.
v SNAPLOCK administrative view on page 1336
v SNAP_GET_LOCK table function on page 1337
SNAPLOCK administrative view

This administrative view allows you to retrieve lock logical data group snapshot
Used with the SNAPLOCKWAIT administrative view, the SNAPLOCK
1467
returned.
Authorization
v SELECT privilege on the SNAPLOCK administrative view
v CONTROL privilege on the SNAPLOCK administrative view
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve lock information for the database member 0 of the currently connected
database.
FROM SYSIBMADM.SNAPLOCK WHERE DBPARTITIONNUM = 0

AGENT_ID
LOCK_OBJECT_TYPE LOCK_MODE LOCK_STATUS
-------------------- ---------------- --------- ----------7 TABLE
IX
GRNT

The SNAP_GET_LOCK table function returns the same information as the
SNAPLOCK administrative view, but allows you to retrieve the information for a
Used with the SNAP_GET_LOCKWAIT table function, the SNAP_GET_LOCK table
returned.
1468
Syntax
SNAP_GET_LOCK (
dbname
, member

dbname
member
SNAP_GET_LOCK table function takes a snapshot for the currently connected
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve lock information for the current database member of the currently
connected database.
1469

FROM TABLE(SNAP_GET_LOCK(,-1)) as T

AGENT_ID
--------...--680
680
LOCK_OBJECT_TYPE
INTERNALP_LOCK
LOCK_MODE
---------S
S
LOCK_STATUS
----------GRNT
GRNT
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
AGENT_ID
BIGINT

(agent ID)
TAB_FILE_ID
BIGINT

identification
LOCK_OBJECT_TYPE
VARCHAR(18)

v AUTORESIZE_LOCK
v AUTOSTORAGE_LOCK
v BLOCK_LOCK
v EOT_LOCK
v INTERNAL_LOCK
v INTERNALB_LOCK
v INTERNALC_LOCK
v INTERNALJ_LOCK
v INTERNALL_LOCK
v INTERNALO_LOCK
v INTERNALQ_LOCK
v INTERNALP_LOCK
v INTERNALS_LOCK
v INTERNALT_LOCK
v INTERNALV_LOCK
v KEYVALUE_LOCK
v ROW_LOCK
v SYSBOOT_LOCK
v TABLE_LOCK
v TABLE_PART_LOCK
v TABLESPACE_LOCK
v XML_PATH_LOCK
1470
Column name
Data type
LOCK_MODE
VARCHAR(10)
monitor element
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
LOCK_STATUS
VARCHAR(10)

and is one of:
v CONV
v GRNT
LOCK_ESCALATION
SMALLINT
TABNAME
VARCHAR(128)
TABSCHEMA
VARCHAR(128)
TBSP_NAME
VARCHAR(128)

name
LOCK_ATTRIBUTES
VARCHAR(128)

text identifier is NONE, otherwise, it
is any combination of the
v ALLOW_NEW
v DELETE_IN_BLOCK
v ESCALATED
v INSERT
v NEW_REQUEST
v RR
v RR_IN_BLOCK
v UPDATE_DELETE
v WAIT_FOR_AVAIL
LOCK_COUNT
BIGINT
lock_count - Lock count
1471
Column name
Data type
LOCK_CURRENT_MODE
VARCHAR(10)
monitor element
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
LOCK_HOLD_COUNT
BIGINT
lock_hold_count - Lock hold count
LOCK_NAME
VARCHAR(32)
LOCK_RELEASE_FLAGS
BIGINT

flags
DATA_PARTITION_ID
INTEGER

DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

SNAP_GET_LOCKWAIT table function - Retrieve lockwait
The SNAPLOCKWAIT administrative view and the SNAP_GET_LOCKWAIT table
function return snapshot information about lock waits, in particular, the lockwait
logical data group.
replaced by the MON_LOCKWAITS administrative view - Retrieve metrics for
applications that are waiting to obtain locks on page 840 and the
v SNAPLOCKWAIT administrative view on page 1341
1472
v SNAP_GET_LOCKWAIT table function on page 1342
SNAPLOCKWAIT administrative view

This administrative view allows you to retrieve lockwait logical data group
Used with the SNAPLOCK administrative view, the SNAPLOCKWAIT
returned.
Authorization
v SELECT privilege on the SNAPLOCKWAIT administrative view
v CONTROL privilege on the SNAPLOCKWAIT administrative view
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve lock wait information for database member 0 for the currently connected
database.
LOCK_MODE_REQUESTED FROM SYSIBMADM.SNAPLOCKWAIT
WHERE DBPARTITIONNUM = 0

AGENT_ID
LOCK_MODE LOCK_OBJECT_TYPE ...
--------...- --------- ---------------- ...
7 IX
TABLE
...
1473

... -------------------- ------------------...
12 IS

The SNAP_GET_LOCKWAIT table function returns the same information as the
SNAPLOCKWAIT administrative view, but allows you to retrieve the information
Used with the SNAP_GET_LOCK table function, the SNAP_GET_LOCKWAIT table
returned.
Syntax
SNAP_GET_LOCKWAIT (
dbname
, member

dbname
member
SNAP_GET_LOCKWAIT table function takes a snapshot for the currently
Authorization
1474

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve lock wait information for current database member for the currently
connected database.
LOCK_MODE_REQUESTED FROM TABLE(SNAP_GET_LOCKWAIT(,-1)) AS T

AGENT_ID
LOCK_MODE LOCK_OBJECT_TYPE
...
--------...-- ---------- ------------------ ...
12 X
ROW_LOCK
...

... -------------------- ------------------...
7 X
Usage note
To see lock wait information, you must first turn on the default LOCK monitor
switch in the database manager configuration. To have the change take effect
immediately explicitly attach to the instance using CLP and then issue the CLP
command:
UPDATE DATABASE MANAGER CONFIGURATION CLP USING DFT_MON_LOCK ON
The default setting can also be turned on through the ADMIN_CMD stored
procedure. For example:
CALL SYSPROC.ADMIN_CMD(update dbm cfg using DFT_MON_LOCK ON)
If the ADMIN_CMD stored procedure is used or if the clp command is used

without having previously attached to the instance, the instance must be recycled
before the change takes effect.
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP
monitor element
snapshot was taken.
1475
monitor element
Column name
Data type
AGENT_ID
BIGINT

(agent ID)
SUBSECTION_NUMBER
BIGINT
LOCK_MODE
VARCHAR(10)

and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
LOCK_OBJECT_TYPE
VARCHAR(18)

v AUTORESIZE_LOCK
v AUTOSTORAGE_LOCK
v BLOCK_LOCK
v EOT_LOCK
v INTERNAL_LOCK
v INTERNALB_LOCK
v INTERNALC_LOCK
v INTERNALJ_LOCK
v INTERNALL_LOCK
v INTERNALO_LOCK
v INTERNALQ_LOCK
v INTERNALP_LOCK
v INTERNALS_LOCK
v INTERNALT_LOCK
v INTERNALV_LOCK
v KEYVALUE_LOCK
v ROW_LOCK
v SYSBOOT_LOCK
v TABLE_LOCK
v TABLE_PART_LOCK
v TABLESPACE_LOCK
v XML_PATH_LOCK
1476
monitor element
Column name
Data type
AGENT_ID_HOLDING_LK
BIGINT
holding lock
TIMESTAMP

start timestamp
LOCK_MODE_REQUESTED
VARCHAR(10)

v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
LOCK_ESCALATION
SMALLINT
TABNAME
VARCHAR(128)
TABSCHEMA
VARCHAR(128)
TBSP_NAME
VARCHAR(128)

name
APPL_ID_HOLDING_LK
VARCHAR(128)
ID holding lock
LOCK_ATTRIBUTES
VARCHAR(128)

text identifier is NONE, otherwise,
it is any combination of the
v ALLOW_NEW
v DELETE_IN_BLOCK
v ESCALATED
v INSERT
v NEW_REQUEST
v RR
v RR_IN_BLOCK
v UPDATE_DELETE
v WAIT_FOR_AVAIL
1477
Column name
Data type
LOCK_CURRENT_MODE
VARCHAR(10)
monitor element
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v S
v SIX
v U
v X
v Z
LOCK_NAME
VARCHAR(32)
LOCK_RELEASE_FLAGS
BIGINT

flags.
DATA_PARTITION_ID
INTEGER

DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

logical group
751.
v SNAPDB administrative view on page 1278
1478

Authorization
v CONTROL privilege on the SNAPDB administrative view
v DBADM authority
v SQLADM authority
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Examples

DB_NAME
DB_STATUS
SERVER_PLATFORM DB_LOCATION ...
-------...- ------------ --------------- ------------ ...
TEST
ACTIVE
AIX64
LOCAL
...
1479
TEST
TEST
ACTIVE
ACTIVE
AIX64
AIX64
LOCAL
LOCAL
...
...

...
...
...
...
...
DB_CONN_TIME
DBPARTITIONNUM
-------------------------- -------------2006-01-08-16.48.30.665477
0
2006-01-08-16.48.34.005328
1
2006-01-08-16.48.34.007937
2
TOTAL_OLAP_FUNCS
-------------------- -------------------- ----------------7
2
1

---------------- ------------------ ------------- -------------- ...
128
2
1
0 ...
... -------------------- -----------------...
10
100

Syntax
SNAP_GET_DB (
dbname
)
, member
1480

dbname
member
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Examples
1481
DB_NAME
DB_STATUS
SERVER_PLATFORM ...
-------...- ---------... --------------- ...
SAMPLE
ACTIVE
AIX64
...

... ------------ -------------------------... LOCAL
2005-07-24-22.09.22.013196

DB_NAME
--------...TOOLSDB
SAMPLE
DB_STATUS
---------...
ACTIVE
ACTIVE
SERVER_PLATFORM
--------------AIX64
AIX64
...
...
...
...

...
...
...
...
DB_LOCATION
-----------LOCAL
LOCAL
DB_CONN_TIME
-------------------------2005-07-24-22.26.54.396335
2005-07-24-22.09.22.013196
TOTAL_OLAP_FUNCS
---------------7
-------------------- -------------------2
1
table function.
---------------- ------------------ ------------- -------------- ...
200
1
2
0 ...
Continued
...-------------------...
2
1482
SYNC_RUNSTATS_TIME
-----------------32
SELECT SUBSTR
DB_NAME
DB_STATUS
-------------------- ---------------HADRDB
ACTIVE_STANDBY
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
DB_NAME
VARCHAR(128)
DB_PATH
VARCHAR(1024)
INPUT_DB_ALIAS
VARCHAR(128)
DB_STATUS
VARCHAR(16)

v ACTIVE
v QUIESCE_PEND
v QUIESCED
v ROLLFWD
enabled.
enabled).
CATALOG_PARTITION
SMALLINT

number
VARCHAR(128)

1483
Column name
Data type
SERVER_PLATFORM
VARCHAR(12)

element
v AIX
v AIX64
v AS400_DRDA
v DOS
v DYNIX
v HP
v HP64
v HPIA
v HPIA64
v LINUX
v LINUX390
v LINUXIA64
v LINUXPPC
v LINUXPPC64
v LINUXX8664
v LINUXZ64
v MAC
v MVS_DRDA
v NT
v NT64
v OS2
v OS390
v SCO
v SGI
v SNI
v SUN
v SUN64
v UNKNOWN
v UNKNOWN_DRDA
v VM_DRDA
v VSE_DRDA
v WINDOWS
DB_LOCATION
VARCHAR(12)

v LOCAL
v REMOTE
DB_CONN_TIME
TIMESTAMP

timestamp
LAST_RESET
TIMESTAMP
LAST_BACKUP
TIMESTAMP
1484
element
Column name
Data type
CONNECTIONS_TOP
BIGINT

TOTAL_CONS
BIGINT

activation
TOTAL_SEC_CONS
BIGINT
APPLS_CUR_CONS
BIGINT

currently
APPLS_IN_DB2
BIGINT

database currently
NUM_ASSOC_AGENTS
BIGINT

agents
AGENTS_TOP
BIGINT
COORD_AGENTS_TOP
BIGINT

coordinating agents
LOCKS_HELD
BIGINT
LOCK_WAITS
BIGINT
LOCK_WAIT_TIME
BIGINT
LOCK_LIST_IN_USE
BIGINT

use
DEADLOCKS
BIGINT
LOCK_ESCALS
BIGINT
X_LOCK_ESCALS
BIGINT
LOCKS_WAITING
BIGINT

locks
LOCK_TIMEOUTS
BIGINT
NUM_INDOUBT_TRANS
BIGINT

transactions
SORT_HEAP_ALLOCATED
BIGINT

allocated
BIGINT

currently allocated
SORT_SHRHEAP_TOP
BIGINT

water mark
BIGINT

threshold sorts
TOTAL_SORTS
BIGINT
TOTAL_SORT_TIME
BIGINT
SORT_OVERFLOWS
BIGINT
ACTIVE_SORTS
BIGINT
POOL_DATA_L_READS
BIGINT

reads
POOL_DATA_P_READS
BIGINT

physical reads
1485
element
Column name
Data type
BIGINT

BIGINT

BIGINT

POOL_DATA_WRITES
BIGINT
BIGINT

POOL_INDEX_L_READS
BIGINT

logical reads
POOL_INDEX_P_READS
BIGINT

physical reads
BIGINT

BIGINT

BIGINT

POOL_INDEX_WRITES
BIGINT
BIGINT

POOL_XDA_P_READS
BIGINT

Physical Reads
POOL_XDA_L_READS
BIGINT

Logical Reads
POOL_XDA_WRITES
BIGINT

Writes
BIGINT

BIGINT

BIGINT

monitor element
BIGINT

POOL_READ_TIME
BIGINT

read time
POOL_WRITE_TIME
BIGINT

write time
BIGINT

BIGINT

1486
element
Column name
Data type
POOL_ASYNC_DATA_
READ_REQS
BIGINT

BIGINT

BIGINT

BIGINT

victim buffers
POOL_LSN_GAP_CLNS
BIGINT

cleaners triggered
BIGINT

BIGINT

PREFETCH_WAIT_TIME
BIGINT

prefetch
BIGINT

pages
DIRECT_READS
BIGINT
DIRECT_WRITES
BIGINT
DIRECT_READ_REQS
BIGINT
DIRECT_WRITE_REQS
BIGINT
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT
FILES_CLOSED
BIGINT
ELAPSED_EXEC_TIME_S
BIGINT

elapsed time
BIGINT

elapsed time
COMMIT_SQL_STMTS
BIGINT

attempted
ROLLBACK_SQL_STMTS
BIGINT

attempted
DYNAMIC_SQL_STMTS
BIGINT

STATIC_SQL_STMTS
BIGINT

attempted
FAILED_SQL_STMTS
BIGINT
SELECT_SQL_STMTS
BIGINT

executed
UID_SQL_STMTS
BIGINT
DDL_SQL_STMTS
BIGINT

INT_AUTO_REBINDS
BIGINT

1487
Column name
Data type

element
INT_ROWS_DELETED
BIGINT
INT_ROWS_INSERTED
BIGINT
INT_ROWS_UPDATED
BIGINT
INT_COMMITS
BIGINT
INT_ROLLBACKS
BIGINT
BIGINT

due to deadlock
ROWS_DELETED
BIGINT
ROWS_INSERTED
BIGINT
ROWS_UPDATED
BIGINT
ROWS_SELECTED
BIGINT
ROWS_READ
BIGINT
BINDS_PRECOMPILES
BIGINT
attempted
TOTAL_LOG_AVAILABLE
BIGINT
TOTAL_LOG_USED
BIGINT
SEC_LOG_USED_TOP
BIGINT

space used
TOT_LOG_USED_TOP
BIGINT

used
SEC_LOGS_ALLOCATED
BIGINT

currently
LOG_READS
BIGINT
LOG_READ_TIME_S
BIGINT
LOG_READ_TIME_NS
BIGINT
LOG_WRITES
BIGINT
LOG_WRITE_TIME_S
BIGINT
LOG_WRITE_TIME_NS
BIGINT
NUM_LOG_WRITE_IO
BIGINT
NUM_LOG_READ_IO
BIGINT
BIGINT

log page writes
NUM_LOG_BUFFER_FULL
BIGINT

buffers
BIGINT
APPL_ID_OLDEST_XACT
BIGINT

transaction
BIGINT

BIGINT

1488
Column name
Data type

element
PKG_CACHE_LOOKUPS
BIGINT
PKG_CACHE_INSERTS
BIGINT
BIGINT

overflows
PKG_CACHE_SIZE_TOP
BIGINT

water mark
BIGINT
BIGINT
CAT_CACHE_LOOKUPS
BIGINT
CAT_CACHE_INSERTS
BIGINT
CAT_CACHE_OVERFLOWS
BIGINT

overflows
CAT_CACHE_SIZE_TOP
BIGINT

water mark
BIGINT

workspace size
BIGINT
workspace overflows
BIGINT
BIGINT
BIGINT

workspace size
BIGINT
workspace overflows
BIGINT
BIGINT
TOTAL_HASH_JOINS
BIGINT
TOTAL_HASH_LOOPS
BIGINT
HASH_JOIN_OVERFLOWS
BIGINT
BIGINT

overflows
BIGINT
ACTIVE_HASH_JOINS
BIGINT
BIGINT
DBPARTITIONNUM
SMALLINT

monitor element
INTEGER

available log space
1489
Column name
Data type

element
TOTAL_OLAP_FUNCS
BIGINT
OLAP_FUNC_OVERFLOWS
BIGINT

overflows
ACTIVE_OLAP_FUNCS
BIGINT
STATS_CACHE_SIZE
BIGINT
STATS_FABRICATIONS
BIGINT

fabrications
SYNC_RUNSTATS
BIGINT

RUNSTATS activities
ASYNC_RUNSTATS
BIGINT

BIGINT

SYNC_RUNSTATS_TIME
BIGINT

BIGINT
MEMBER
SMALLINT

information
group.

returned.
1490
Authorization
v DBADM authority
v SQLADM authority
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example

UTILITY_TYPE
------------...- ---------------- ...
LOAD
- ...
LOAD
- ...
LOAD
- ...

...
...
...
...
...
UTILITY_DESCRIPTION
...
-----------------------------------------------------------------...
1491
...
...
...
...
...
UTILITY_DBNAME
----------------SAMPLE
SAMPLE
SAMPLE
UTILITY_STATE
------------EXECUTE
EXECUTE
EXECUTE
-------------------- -------------USER
0
USER
1
USER
2

members.
returned.
Syntax
SNAP_GET_UTIL (
member

member
applications.
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
1492
v SYSADM

Examples

UTILITY_ID
UTILITY_TYPE
STATE
-------------------- -------------------------- -------1 BACKUP
EXECUTE

----------- -------------------------- ------ -------------2 BACKUP
2
2
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
UTILITY_ID
INTEGER

database partition.
1493
Column name
Data type
UTILITY_TYPE
VARCHAR(26)
monitor element
and is one of:
v BACKUP
v CRASH_RECOVERY
v LOAD
v REBALANCE
v REDISTRIBUTE
v RESTORE
v RUNSTATS
UTILITY_PRIORITY
INTEGER

UTILITY_DESCRIPTION

UTILITY_DBNAME
VARCHAR(128)
UTILITY_START_TIME
TIMESTAMP

time
UTILITY_STATE
VARCHAR(10)

and is one of:
v ERROR
v EXECUTE
v WAIT
VARCHAR(10)
v AUTO
v USER
DBPARTITIONNUM
SMALLINT
PROGRESS_LIST_ATTR
VARCHAR(10)
1494

number
Column name
Data type
MEMBER
SMALLINT
monitor element
monitor element
SNAPSTMT administrative view and SNAP_GET_STMT table

function - Retrieve statement snapshot information
The SNAPSTMT administrative view and the SNAP_GET_STMT table function
return information about SQL or XQuery statements from an application snapshot.
Important: The SNAPSTMT administrative view and the SNAP_GET_STMT table
function are deprecated. Use the MON_GET_ACTIVITY table function - Return a
list of activities on page 475 to retrieve the information returned by these
deprecated interfaces.
v SNAPSTMT administrative view on page 1347
v SNAP_GET_STMT table function on page 1349
SNAPSTMT administrative view

This administrative view allows you to retrieve statement snapshot information for
SNAPSTMT administrative view provides information equivalent to the GET
SNAPSHOT FOR APPLICATIONS on database-alias CLP command, but retrieves data
returned.
Authorization
v SELECT privilege on the SNAPSTMT administrative view
v CONTROL privilege on the SNAPSTMT administrative view
v DBADM authority
v SQLADM authority
1495
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
the currently connected single-member database.
SELECT SUBSTR(STMT_TEXT,1,30) AS STMT_TEXT, ROWS_READ, ROWS_WRITTEN,
STMT_OPERATION FROM SYSIBMADM.SNAPSTMT

STMT_TEXT
ROWS_READ
ROWS_WRITTEN
---------...- ---------...- ------------...0
0
0
0
STMT_OPERATION
-------------------FETCH
STATIC_COMMIT

The SNAP_GET_STMT table function returns the same information as the
SNAPSTMT administrative view, but allows you to retrieve the information for a
SNAP_GET_APPL, SNAP_GET_APPL_INFO and SNAP_GET_SUBSECTION table
functions, the SNAP_GET_STMT table function provides information equivalent to
returned.
Syntax
SNAP_GET_STMT (
dbname
)
, member
1496

dbname
member
SNAP_GET_STMT table function takes a snapshot for the currently connected
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
current database member of currently connected database.
SELECT SUBSTR(STMT_TEXT,1,30) AS STMT_TEXT, ROWS_READ,
ROWS_WRITTEN, STMT_OPERATION FROM TABLE(SNAP_GET_STMT(,-1)) AS T

STMT_TEXT
ROWS_READ
...
------------------------------ ---------...- ...
update t set a=3
0 ...
1497
SELECT SUBSTR(STMT_TEXT,1,30)
update t set a=2
0
0
0
9
...
...
...
...
...
...

... ROWS_WRITTEN
... ------------......
0
...
0
...
0
...
0
...
1
...
STMT_OPERATION
-------------------EXECUTE_IMMEDIATE
FETCH
NONE
NONE
EXECUTE_IMMEDIATE
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
AGENT_ID
BIGINT

(agent ID)
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
NUM_AGENTS
BIGINT

AGENTS_TOP
BIGINT
agents_top - Number of agents

created
STMT_TYPE
VARCHAR(20)
stmt_type - Statement type. This

is one of:
v DYNAMIC
v NON_STMT
v STATIC
v STMT_TYPE_UNKNOWN
1498
Column name
Data type
STMT_OPERATION
VARCHAR(20)
monitor element
stmt_operation/operation Statement operation. This interface
v CALL
v CLOSE
v COMPILE
v DESCRIBE
v EXECUTE
v EXECUTE_IMMEDIATE
v FETCH
v FREE_LOCATOR
v GETAA
v GETNEXTCHUNK
v GETTA
v NONE
v OPEN
v PREP_COMMIT
v PREP_EXEC
v PREP_OPEN
v PREPARE
v REBIND
v REDIST
v REORG
v RUNSTATS
v SELECT
v SET
v STATIC_COMMIT
v STATIC_ROLLBACK
SECTION_NUMBER
BIGINT
QUERY_COST_ESTIMATE
BIGINT
query_cost_estimate - Query cost

estimate
QUERY_CARD_ESTIMATE
BIGINT
query_card_estimate - Query
number of rows estimate
DEGREE_PARALLELISM
BIGINT
degree_parallelism - Degree of
parallelism
STMT_SORTS
BIGINT
TOTAL_SORT_TIME
BIGINT
SORT_OVERFLOWS
BIGINT
INT_ROWS_DELETED
BIGINT

deleted
INT_ROWS_UPDATED
BIGINT

updated
1499
1500
monitor element
Column name
Data type
INT_ROWS_INSERTED
BIGINT

inserted
FETCH_COUNT
BIGINT
fetch_count - Number of successful

fetches
STMT_START
TIMESTAMP
stmt_start - Statement operation

start timestamp
STMT_STOP
TIMESTAMP
stmt_stop - Statement operation

stop timestamp
STMT_USR_CPU_TIME_S
BIGINT

seconds)*
STMT_USR_CPU_TIME_MS
BIGINT

in microseconds)*
STMT_SYS_CPU_TIME_S
BIGINT

seconds)*
STMT_SYS_CPU_TIME_MS
BIGINT

in microseconds)*
STMT_ELAPSED_TIME_S
BIGINT

statement elapsed time (in
seconds)*
STMT_ELAPSED_TIME_MS
BIGINT

statement elapsed time (fractional,
in microseconds)*
BLOCKING_CURSOR
SMALLINT
blocking_cursor - Blocking cursor
STMT_NODE_NUMBER
SMALLINT
stmt_node_number - Statement
node
CURSOR_NAME
VARCHAR(128)
cursor_name - Cursor name
CREATOR
VARCHAR(128)
creator - Application creator
PACKAGE_NAME
VARCHAR(128)
STMT_TEXT
CLOB(16 M)
CONSISTENCY_TOKEN
VARCHAR(128)
consistency_token - Package
consistency token
PACKAGE_VERSION_ID
VARCHAR(128)
package_version_id - Package
version
POOL_DATA_L_READS
BIGINT

data logical reads
POOL_DATA_P_READS
BIGINT

data physical reads
POOL_INDEX_L_READS
BIGINT

index logical reads
POOL_INDEX_P_READS
BIGINT

monitor element
Column name
Data type
POOL_XDA_L_READS
BIGINT

XDA Data Logical Reads monitor
element
POOL_XDA_P_READS
BIGINT

XDA Data Physical Reads monitor
element
BIGINT
BIGINT
BIGINT
BIGINT
reads
BIGINT
Reads
BIGINT
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element
SNAPSTORAGE_PATHS administrative view and

SNAP_GET_STORAGE_PATHS_V97 table function - Retrieve
The SNAPSTORAGE_PATHS administrative view and the
SNAP_GET_STORAGE_PATHS_V97 return a list of automatic storage paths for the
database including file system information for each storage path, specifically, from
the db_storage_group logical data group.
Note: The SNAPSTORAGE_PATHS administrative view on page 1355 and the
SNAP_GET_STORAGE_PATHS_V97 on page 1356 have been deprecated and
replaced by the ADMIN_GET_STORAGE_PATHS table function - retrieve
automatic storage path information on page 224. This function and view might be
removed in a future release.
1501
v SNAPSTORAGE_PATHS administrative view on page 1355

v SNAP_GET_STORAGE_PATHS_V97 on page 1356

This administrative view allows you to retrieve automatic storage path information
for the currently connected database.
Used with the MON_GET_DATABASE, MON_GET_HADR,
MON_GET_MEMORY_POOL, MON_GET_MEMORY_SET, and
MON_GET_TRANSACTION_LOG table functions, the SNAPSTORAGE_PATHS
DATABASE ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPSTORAGE_PATHS administrative view
v
v
v
v
CONTROL privilege on the SNAPSTORAGE_PATHS administrative view

DBADM authority
SQLADM authority

v
v
v
v
EXECUTE privilege on the SNAP_GET_STORAGE_PATHS_V97 table function

DBADM authority
SQLADM authority
v SYSMON authority
v SYSCTRL authority
v SYSADM authority

Example
Retrieve the storage path for the currently connected single-member database.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, SUBSTR(DB_STORAGE_PATH,1,8)
AS DB_STORAGE_PATH, SUBSTR(HOSTNAME,1,10) AS HOSTNAME
FROM SYSIBMADM.SNAPSTORAGE_PATHS
1502
DB_NAME DB_STORAGE_PATH HOSTNAME

-------- --------------- ---------STOPATH d:
JESSICAE
SNAP_GET_STORAGE_PATHS_V97
The SNAP_GET_STORAGE_PATHS_V97 table function returns similar information
as the SNAPSTORAGE_PATHS administrative view. It allows you to retrieve the
SNAP_GET_DB_MEMORY_POOL table functions, the
SNAP_GET_STORAGE_PATHS_V97 table function provides information equivalent
returned.
Syntax
SNAP_GET_STORAGE_PATHS_V97 (
dbname
, member

dbname
member
members. If dbname is not set to NULL and member is set to NULL,-1 is set
SNAP_GET_STORAGE_PATHS_V97 table function takes a snapshot for the
currently connected database and database member.
Authorization
v EXECUTE privilege on the SNAP_GET_STORAGE_PATHS_V97 table function.
1503

v SYSMON authority
v SYSCTRL authority
v SYSMAINT suthority
v SYSADM authority

Examples
Retrieve the storage path information for all active databases.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, DB_STORAGE_PATH
FROM TABLE(SNAP_GET_STORAGE_PATHS_V97(CAST (NULL AS VARCHAR(128)), -1)) AS T

DB_NAME
-------STOPATH
MYDB
DB_STORAGE_PATH
-------------------...
/home/jessicae/sdb
/home/jessicae/mdb
The BUFFERPOOL monitor switch must be turned on in order for the file system
information to be returned.
SNAP_GET_STORAGE_PATHS_V97 table function
1504
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
DB_NAME
VARCHAR(128)
DB_STORAGE_PATH
VARCHAR(256)
storage path
VARCHAR(256)
db_storage_path_with_dpe Storage path including database

partition expression monitor
element
DBPARTITIONNUM
SMALLINT
VARCHAR(16)
path state monitor element
FS_ID
VARCHAR(22)

FS_TOTAL_SIZE
BIGINT

system
FS_USED_SIZE
BIGINT

SNAP_GET_STORAGE_PATHS_V97 table function (continued)
Column name
Data type
STO_PATH_FREE_SIZE
BIGINT
monitor element
storage path free space
SNAPTAB administrative view and SNAP_GET_TAB table

function - Retrieve table logical data group snapshot
information
The SNAPTAB administrative view and the SNAP_GET_TAB table function return
snapshot information from the table logical data group.
Important: The SNAPTAB administrative view and SNAP_GET_TAB table
function are deprecated. Use the MON_GET_TABLE table function - get table
metrics on page 731, to retrieve the information returned by these deprecated
interfaces.
v SNAPTAB administrative view on page 1358
v SNAP_GET_TAB table function on page 1360
SNAPTAB administrative view

This administrative view allows you to retrieve table logical data group snapshot
Used in conjunction with the SNAPTAB_REORG administrative view, the
SNAPTAB administrative view returns equivalent information to the GET SNAPSHOT
returned.
Authorization
v SELECT privilege on the SNAPTAB administrative view
v CONTROL privilege on the SNAPTAB administrative view
v DBADM authority
v SQLADM authority
v DBADM authority
v SQLADM authority
1505

also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve the schema and name for all active tables.
SELECT SUBSTR(TABSCHEMA,1,8), SUBSTR(TABNAME,1,15) AS TABNAME, TAB_TYPE,
DBPARTITIONNUM FROM SYSIBMADM.SNAPTAB

TABSCHEMA TABNAME
TAB_TYPE
DBPARTITIONNUM
--------- --------------- ------------ -------------SYSTOOLS HMON_ATM_INFO
USER_TABLE
0
1 record selected.

The SNAP_GET_TAB table function returns the same information as the SNAPTAB
database members.
Used in conjunction with the SNAP_GET_TAB_REORG table function, the
SNAP_GET_TAB table function returns equivalent information to the GET SNAPSHOT
returned.
Syntax
SNAP_GET_TAB (
dbname
, member

dbname
1506
member
SNAP_GET_TAB table function takes a snapshot for the currently connected
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
database.

TABSCHEMA
--------SYSTOOLS
JESSICAE
TABNAME
EMPLOYEE
TAB_TYPE
DBPARTITIONNUM
------------- -------------USER_TABLE
USER_TABLE
-
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TABSCHEMA
VARCHAR(128)

1507
SNAP_GET_TAB table function (continued)
Column name
Data type
monitor element
TABNAME
VARCHAR(128)
TAB_FILE_ID
BIGINT

identification
TAB_TYPE
VARCHAR(14)

is one of:
v CATALOG_TABLE
v DROPPED_TABLE
v REORG_TABLE
v SYNOPSIS_TABLE
v TEMP_TABLE
v USER_TABLE
DATA_OBJECT_PAGES
BIGINT

pages
INDEX_OBJECT_PAGES
BIGINT

pages
LOB_OBJECT_PAGES
BIGINT

pages
LONG_OBJECT_PAGES
BIGINT

pages
XDA_OBJECT_PAGES
BIGINT

Pages
ROWS_READ
BIGINT
ROWS_WRITTEN
BIGINT
OVERFLOW_ACCESSES
BIGINT
overflowed records
PAGE_REORGS
BIGINT
DBPARTITIONNUM
SMALLINT
TBSP_ID
BIGINT

identification
DATA_PARTITION_ID
INTEGER

MEMBER
SMALLINT

monitor element
SNAPTBSP administrative view and SNAP_GET_TBSP table

function - Retrieve table space logical data group snapshot
information
The SNAPTBSP administrative view and the SNAP_GET_TBSP table function
return snapshot information from the table space logical data group.
1508
Important: The SNAPTBSP administrative view and the SNAP_GET_TBSP table

function are deprecated and have been replaced by the MON_GET_TABLESPACE
table function - Get table space metrics on page 736.
v SNAPTBSP administrative view on page 1365
v SNAP_GET_TBSP table function on page 1366
SNAPTBSP administrative view

This administrative view allows you to retrieve table space logical data group
Used in conjunction with the SNAPTBSP_PART, SNAPTBSP_QUIESCER,
SNAPTBSP_RANGE, SNAPCONTAINER administrative views, the SNAPTBSP
administrative view returns information equivalent to the GET SNAPSHOT FOR
TABLESPACES ON database-alias CLP command.
returned.
Authorization
v SELECT privilege on the SNAPTBSP administrative view
v CONTROL privilege on the SNAPTBSP administrative view
v DBADM authority
v SQLADM authority
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

1509
Example
Retrieve a list of table spaces on the catalog database member for the currently
connected database.
TBSP_CONTENT_TYPE FROM SYSIBMADM.SNAPTBSP WHERE DBPARTITIONNUM = 1

TBSP_NAME TBSP_ID
---------- -------...TEMPSPACE1
1
USERSPACE1
2
TBSP_TYPE
---------SMS
DMS
TBSP_CONTENT_TYPE
----------------SYSTEMP
LONG

The SNAP_GET_TBSP table function returns the same information as the
SNAPTBSP administrative view, but allows you to retrieve the information for a
Used in conjunction with the SNAP_GET_TBSP_PART,
SNAP_GET_TBSP_QUIESCER, SNAP_GET_TBSP_RANGE,
SNAP_GET_CONTAINER table functions, the SNAP_GET_TBSP table function
returns information equivalent to the GET SNAPSHOT FOR TABLESPACES ON
returned.
Syntax
SNAP_GET_TBSP (
dbname
, member

dbname
member
Specify -1 for the current member. If the null value is specified, -1 is set
implicitly.
1510
SNAP_GET_TBSP table function takes a snapshot for the currently connected

Authorization
also required:
v
v
v
v
SYSMON
SYSCTRL
SYSMAINT
SYSADM

Example
Retrieve a list of table spaces for all database members for the currently connected
database.
TBSP_CONTENT_TYPE, DBPARTITIONNUM FROM TABLE(SNAP_GET_TBSP()) AS T

TBSP_NAME TBSP_ID
---------- -------...TEMPSPACE1
1
USERSPACE1
2
SYSCATSPAC
0
TEMPSPACE1
1
USERSPACE1
2
SYSTOOLSPA
3
TEMPSPACE1
1
USERSPACE1
2
TBSP_TYPE
---------SMS
DMS
DMS
SMS
DMS
DMS
SMS
DMS
----------------- -------------SYSTEMP
1
LONG
1
ANY
0
SYSTEMP
0
LONG
0
LONG
0
SYSTEMP
2
LONG
2
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TBSP_NAME
VARCHAR(128)

name
TBSP_ID
BIGINT

identification
1511
Column name
Data type
TBSP_TYPE
VARCHAR(10)
monitor element
v DMS
v SMS
TBSP_CONTENT_TYPE
VARCHAR(10)
v ANY
v LARGE
v SYSTEMP
v USRTEMP
1512
TBSP_PAGE_SIZE
BIGINT

page size
TBSP_EXTENT_SIZE
BIGINT
space extent size
TBSP_PREFETCH_SIZE
BIGINT
space prefetch size
TBSP_CUR_POOL_ID
BIGINT
TBSP_NEXT_POOL_ID
BIGINT
startup
FS_CACHING
SMALLINT
POOL_DATA_L_READS
BIGINT

data logical reads
POOL_DATA_P_READS
BIGINT

data physical reads
BIGINT
BIGINT
BIGINT
POOL_DATA_WRITES
BIGINT

writes
BIGINT
POOL_INDEX_L_READS
BIGINT

index logical reads
POOL_INDEX_P_READS
BIGINT

BIGINT
monitor element
Column name
Data type
BIGINT
reads
BIGINT
POOL_INDEX_WRITES
BIGINT

index writes
BIGINT
POOL_XDA_L_READS
BIGINT

POOL_XDA_P_READS
BIGINT

POOL_XDA_WRITES
BIGINT

Data Writes
BIGINT
Reads
BIGINT
Writes
BIGINT
Reads
BIGINT
POOL_READ_TIME
BIGINT

physical read time
POOL_WRITE_TIME
BIGINT

physical write time
BIGINT

BIGINT
POOL_ASYNC_DATA_
READ_REQS
BIGINT
POOL_ASYNC_INDEX_
READ_REQS
BIGINT

read requests
POOL_ASYNC_XDA_READ_REQS BIGINT
Requests
BIGINT
DIRECT_READS
BIGINT

database
1513
monitor element
Column name
Data type
DIRECT_WRITES
BIGINT

database
DIRECT_READ_REQS
BIGINT

requests
DIRECT_WRITE_REQS
BIGINT

requests
DIRECT_READ_TIME
BIGINT
DIRECT_WRITE_TIME
BIGINT

time
FILES_CLOSED
BIGINT
BIGINT
prefetch pages
VARCHAR(10)

v NO_REBAL
v FWD_REBAL
v REV_REBAL
SMALLINT

storage
SMALLINT

enabled
DBPARTITIONNUM
SMALLINT
MEMBER
SMALLINT

monitor element

SNAP_GET_TBSP_PART table function - Retrieve
The SNAPTBSP_PART administrative view and the SNAP_GET_TBSP_PART table
function return snapshot information from the tablespace_nodeinfo logical data
group.
Important: The SNAPTBSP_PART administrative view and the
SNAP_GET_TBSP_PART table function are deprecated and have been replaced by
the MON_GET_TABLESPACE table function - Get table space metrics on page
736.
v SNAPTBSP_PART administrative view on page 1371
v SNAP_GET_TBSP_PART table function on page 1372
1514
SNAPTBSP_PART administrative view

This administrative view allows you to retrieve tablespace_nodeinfo logical data
Used in conjunction with the SNAPTBSP, SNAPTBSP_QUIESCER,
SNAPTBSP_RANGE, SNAPCONTAINER administrative views, the
SNAPTBSP_PART administrative view returns information equivalent to the GET
returned.
Authorization
v DBADM authority
v SQLADM authority
v EXECUTE privilege on the SNAP_GET_TBSP_PART table function
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve a list of table spaces and their state for all database partitions of the
SUBSTR(TBSP_STATE,1,30) AS TBSP_STATE, DBPARTITIONNUM
FROM SYSIBMADM.SNAPTBSP_PART
1515
TBSP_NAME
TBSP_ID
-----------...- -------...SYSCATSPACE
0
TEMPSPACE1
1
USERSPACE1
2
TEMPSPACE1
1
USERSPACE1
2
TBSP_STATE
DBPARTITIONNUM
----------...- -------------NORMAL
0
NORMAL
0
NORMAL
0
NORMAL
1
NORMAL
1

The SNAP_GET_TBSP_PART table function returns the same information as the
SNAPTBSP_PART administrative view, but allows you to retrieve the information
for a specific database on a specific database partition, aggregate of all database
partitions or all database partitions.
Used in conjunction with the SNAP_GET_TBSP, SNAP_GET_TBSP_QUIESCER,
SNAP_GET_TBSP_PART table function returns information equivalent to the GET
returned.
Syntax
SNAP_GET_TBSP_PART (
dbname
, member

dbname
member
members. If dbname is not set to NULL and member is set to NULL, -1 is set
SNAP_GET_TBSP_PART table function takes a snapshot for the currently
connected database and member.
1516
Authorization
v EXECUTE privilege on the SNAP_GET_TBSP_PART table function.
v SYSMON authority
v SYSCTRL authority
v SYSADM authority

Example
Retrieve a list of table spaces and their state for the connected database partition of
FROM TABLE(SNAP_GET_TBSP_PART(CAST(NULL AS VARCHAR(128)),-1)) AS T

TBSP_NAME
TBSP_ID
------------------------------ -------------------SYSCATSPACE
0
TEMPSPACE1
1
USERSPACE1
2
SYSTOOLSPACE
3
SYSTOOLSTMPSPACE
4
TBSP_STATE
------------...NORMAL
NORMAL
NORMAL
NORMAL
NORMAL
element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

taken.
TBSP_NAME
VARCHAR
(128)
TBSP_ID
BIGINT
1517
Column name
Data type
TBSP_STATE
VARCHAR
(256)

element
v BACKUP_PENDING
v DELETE_PENDING
v DISABLE_PENDING
v DROP_PENDING
v LOAD_IN_PROGRESS
v LOAD_PENDING
v NORMAL
v OFFLINE
v PSTAT_CREATION
v PSTAT_DELETION
v QUIESCED_SHARE
v QUIESCED_UPDATE
v REBAL_IN_PROGRESS
v REORG_IN_PROGRESS
v RESTORE_PENDING
v STORDEF_ALLOWED
v STORDEF_CHANGED
v STORDEF_PENDING
v SUSPEND_WRITE
1518
TBSP_PREFETCH_SIZE
BIGINT

prefetch size
TBSP_NUM_QUIESCERS
BIGINT
quiescers
TBSP_STATE_CHANGE_
OBJECT_ID
BIGINT
TBSP_STATE_CHANGE_
TBSP_ID
BIGINT
TBSP_MIN_RECOVERY_
TIME
TIMESTAMP
TBSP_TOTAL_PAGES
BIGINT

space
TBSP_USABLE_PAGES
BIGINT

table space
TBSP_USED_PAGES
BIGINT

table space
element
Column name
Data type
TBSP_FREE_PAGES
BIGINT

space
TBSP_PENDING_FREE_
PAGES
BIGINT
TBSP_PAGE_TOP
BIGINT

water mark
REBALANCER_MODE
VARCHAR
(30)
v FWD_REBAL
v NO_REBAL
v REV_REBAL
REBALANCER_EXTENTS_
REMAINING
BIGINT

the rebalancer
REBALANCER_EXTENTS_
PROCESSED
BIGINT

processed
REBALANCER_PRIORITY
BIGINT
REBALANCER_START_
TIME
TIMESTAMP
REBALANCER_RESTART_
TIME
TIMESTAMP
REBALANCER_LAST_
EXTENT_MOVED
BIGINT
TBSP_NUM_RANGES
BIGINT

TBSP_NUM_CONTAINERS
BIGINT
TBSP_INITIAL_SIZE
BIGINT

size
TBSP_CURRENT_SIZE
BIGINT

space size
TBSP_MAX_SIZE
BIGINT

space size
TBSP_INCREASE_SIZE
BIGINT

bytes
TBSP_INCREASE_SIZE_
PERCENT
SMALLINT
size by percent
TIMESTAMP

successful resize
TBSP_LAST_RESIZE_
FAILED
SMALLINT

attempt failed
1519
element
Column name
Data type
DBPARTITIONNUM
SMALLINT

TBSP_PATHS_DROPPED
SMALLINT


information
group.

returned.
Authorization
v DBADM authority
v SQLADM authority
v DBADM authority
1520
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example

UTILITY_TYPE
------------...- ---------------- ...
LOAD
- ...
LOAD
- ...
LOAD
- ...

...
...
...
...
...
UTILITY_DESCRIPTION
...
-----------------------------------------------------------------...

...
...
...
...
...
UTILITY_DBNAME
----------------SAMPLE
SAMPLE
SAMPLE
UTILITY_STATE
------------EXECUTE
EXECUTE
EXECUTE
-------------------- -------------USER
0
USER
1
USER
2

members.
1521
returned.
Syntax
SNAP_GET_UTIL (
member

member
applications.
Authorization
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Examples
1522
UTILITY_ID
UTILITY_TYPE
STATE
-------------------- -------------------------- -------1 BACKUP
EXECUTE

----------- -------------------------- ------ -------------2 BACKUP
2
2
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
UTILITY_ID
INTEGER

database partition.
UTILITY_TYPE
VARCHAR(26)

and is one of:
v BACKUP
v CRASH_RECOVERY
v LOAD
v REBALANCE
v REDISTRIBUTE
v RESTORE
v RUNSTATS
UTILITY_PRIORITY
INTEGER

UTILITY_DESCRIPTION

UTILITY_DBNAME
VARCHAR(128)
UTILITY_START_TIME
TIMESTAMP

time
1523
Column name
Data type
UTILITY_STATE
VARCHAR(10)
monitor element
and is one of:
v ERROR
v EXECUTE
v WAIT
VARCHAR(10)
v AUTO
v USER
DBPARTITIONNUM
SMALLINT
PROGRESS_LIST_ATTR
VARCHAR(10)

number
MEMBER

monitor element
SMALLINT
SYSINSTALLROUTINES
This procedure has been deprecated.
SYSINSTALLROUTINES (
Authorization
v DBADM authority
v SQLADM authority

1524
TBSP_UTILIZATION administrative view - Retrieve table space

configuration and utilization information
The TBSP_UTILIZATION administrative view returns table space configuration
and utilization information.
It retrieves a similar report to the LIST TABLESPACES command on a single
partitioned database. Its information is based on the SNAPTBSP, SNAPTBSP_PART
administrative views and TABLESPACES catalog view.
Important: The TBSP_UTILIZATION administrative view is deprecated and have
been replaced by the MON_TBSP_UTILIZATION - Retrieve monitoring metrics
for all table spaces and all database partitions on page 848.
Authorization
v SELECT privilege on the TBSP_UTILIZATION administrative view
v CONTROL privilege on the TBSP_UTILIZATION administrative view
v DBADM authority
v SQLADM authority
also required:
v SYSMON
v SYSCTRL
v SYSMAINT
v SYSADM

Example
Retrieve the same report as the LIST TABLESPACES command on a single partitioned
database.
SELECT TBSP_ID, SUBSTR(TBSP_NAME,1,20) as TBSP_NAME, TBSP_TYPE,
TBSP_CONTENT_TYPE, TBSP_STATE FROM SYSIBMADM.TBSP_UTILIZATION

TBSP_ID
-------...0
1
2
3
4
TBSP_NAME
-------------------SYSCATSPACE
TEMPSPACE1
USERSPACE1
SYSTOOLSPACE
SYSTOOLSTMPSPACE
TBSP_TYPE
---------DMS
DMS
DMS
DMS
DMS
...
...
...
...
...
...
...

1525
...
...
...
...
...
...
...
TBSP_CONTENT_TYPE
----------------ANY
SYSTEMP
ANY
ANY
USRTEMP
TBSP_STATE
----------NORMAL
NORMAL
NORMAL
NORMAL
NORMAL
Table 361. Information returned by the TBSP_UTILIZATION administrative view
1526
monitor element
Column name
Data type
SNAPSHOT_TIMESTAMP
TIMESTAMP

snapshot was taken.
TBSP_ID
BIGINT

identification
TBSP_NAME
VARCHAR(128)

name
TBSP_TYPE
VARCHAR(10)
tablespace_type - Table space type
TBSP_CONTENT_TYPE
VARCHAR(10)
space content type
TBSP_CREATE_TIME
TIMESTAMP
Creation time of the table space.
TBSP_STATE
VARCHAR(256)
tablespace_state - Table space state
TBSP_TOTAL_SIZE_KB
BIGINT
The total size of the table space in

KB, calculated as
total_pages*pagesize/1024.
TBSP_USABLE_SIZE_KB
BIGINT
The total usable size of the table

space in KB, calculated as
usable_pages*pagesize/1024.
TBSP_USED_SIZE_KB
BIGINT
The total used size of the table

used_pages*pagesize/1024.
TBSP_FREE_SIZE_KB
BIGINT
The total available size of the table

free_pages*pagesize/1024.
TBSP_UTILIZATION_PERCENT
BIGINT
The utilization of the table space as

a percentage. Calculated as
(used_pages/usable_pages)*100, if
usable_pages is available.
Otherwise, -1 will be displayed.
TBSP_TOTAL_PAGES
BIGINT
tablespace_total_pages - Total
pages in table space
TBSP_USABLE_PAGES
BIGINT
tablespace_usable_pages - Usable
TBSP_USED_PAGES
BIGINT
tablespace_used_pages - Used
TBSP_FREE_PAGES
BIGINT
tablespace_free_pages - Free pages

in table space
TBSP_PAGE_TOP
BIGINT
tablespace_page_top - Table space

high water mark
TBSP_PAGE_SIZE
INTEGER

page size
Table 361. Information returned by the TBSP_UTILIZATION administrative view (continued)

monitor element
Column name
Data type
TBSP_EXTENT_SIZE
INTEGER
space extent size
TBSP_PREFETCH_SIZE
BIGINT
space prefetch size
TBSP_MAX_SIZE
BIGINT
tablespace_max_size - Maximum
table space size
TBSP_INCREASE_SIZE
BIGINT
tablespace_increase_size - Increase
size in bytes
TBSP_INCREASE_SIZE_PERCENT
SMALLINT
tablespace_increase_size_percent Increase size by percent
TIMESTAMP
tablespace_last_resize_time - Time
of last successful resize
TBSP_LAST_RESIZE_FAILED
SMALLINT
tablespace_last_resize_failed - Last
resize attempt failed
SMALLINT

storage
SMALLINT

enabled
DBPGNAME
VARCHAR(128)
Name of the database partition

group for the table space.
TBSP_NUM_CONTAINERS
BIGINT
tablespace_num_containers Number of containers in table

space
REMARKS
VARCHAR(254)
User-provided comment.
DBPARTITIONNUM
SMALLINT
WLM_GET_ACTIVITY_DETAILS - Return detailed information

about a specific activity
This function returns detailed information about a specific activity identified by its
application handle, unit of work ID, and activity ID. This information includes
details about any thresholds that the activity has violated.
MON_GET_ACTIVITY_DETAILS table function.
This function returns basic statistics of one or more service subclasses.
Syntax
WLM_GET_ACTIVITY_DETAILS (
activity_id ,
member
application_handle
uow_id


1527

application_handle
An input argument of type BIGINT that specifies a valid application handle. If
the argument is null, no rows are returned from this function. If the argument
is null, an SQL171N error is returned.
uow_id
An input argument of type INTEGER that specifies a valid unit of work
identifier unique within the application. If the argument is null, no rows are
returned from this function. If the argument is null, an SQL171N error is
returned.
activity_id
An input argument of type INTEGER that specifies a valid activity ID unique
within the unit of work. If the argument is null, no rows are returned from this
function. If the argument is null, an SQL171N error is returned.
member
members. If a null value is specified, -1 is set implicitly.
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
Example
Detailed information about an individual activity can be obtained by using the
WLM_GET_ACTIVITY_DETAILS table function. This table function returns activity
information as name-value pairs for each member. This example is restricted to
showing only an eleven member subset of the name-value pairs for each member
for an activity identified by an application handle of 1, a unit of work ID of 1 and
an activity ID of 5. For a complete list of name-value pairs, see Table 363 on page
1529 and Table 364 on page 1531.
SELECT SUBSTR(CHAR(DBPARTITIONNUM),1,4) AS PART,
SUBSTR(NAME, 1, 20) AS NAME,
SUBSTR(VALUE, 1, 30) AS VALUE
FROM TABLE(WLM_GET_ACTIVITY_DETAILS(1, 1, 5, -2)) AS ACTDETAIL
WHERE NAME IN (APPLICATION_HANDLE,
COORD_PARTITION_NUM,
LOCAL_START_TIME,
UOW_ID,
ACTIVITY_ID,
PARENT_UOW_ID,
PARENT_ACTIVITY_ID,
ACTIVITY_TYPE,
1528
NESTING_LEVEL,
INVOCATION_ID,
ROUTINE_ID)
ORDER BY PART

PART
---0
0
0
0
0
0
0
0
0
0
0
1
1
1
1
1
1
1
1
1
1
1
NAME
-------------------APPLICATION_HANDLE
COORD_PARTITION_NUM
LOCAL_START_TIME
UOW_ID
ACTIVITY_ID
PARENT_UOW_ID
PARENT_ACTIVITY_ID
ACTIVITY_TYPE
NESTING_LEVEL
INVOCATION_ID
ROUTINE_ID
APPLICATION_HANDLE
COORD_PARTITION_NUM
LOCAL_START_TIME
UOW_ID
ACTIVITY_ID
PARENT_UOW_ID
PARENT_ACTIVITY_ID
ACTIVITY_TYPE
NESTING_LEVEL
INVOCATION_ID
ROUTINE_ID
VALUE
-----------------------------1
0
2005-11-25-18.52.49.343000
1
5
1
3
READ_DML
0
1
0
1
0
2005-11-25-18.52.49.598000
1
5
READ_DML
0
1
0
Usage note
An ACTIVITY_STATE of QUEUED means that the coordinator activity has made a
RPC to the catalog member to obtain threshold tickets and has not yet received a
response. Seeing this state might indicate that the activity has been queued by
WLM or, over short periods of time, might just indicate that the activity is in the
process of obtaining its tickets. To obtain a more accurate picture of whether or not
the activity is really being queued, one can determine which agent is working on
the activity (using the WLM_GET_SERVICE_CLASS_AGENTS table function) and
find out whether this agent's event_object at the catalog member has a value of
WLM_QUEUE.
Table 362. Information returned for WLM_GET_ACTIVITY_DETAILS
Column Name
Data Type
Description
DBPARTITIONNUM
SMALLINT

element
NAME
VARCHAR(256)
Element name. See Table 363 and Table 364 on page 1531
for possible values.
VALUE
VARCHAR(1024)
Element values. See Table 363 and Table 364 on page

1531 for possible values.
Table 363. Elements returned

Element Name
Description
ACTIVITY_ID
ACTIVITY_STATE
activity_state - Activity state monitor element

1529
Table 363. Elements returned (continued)

Element Name
Description
ACTIVITY_TYPE
activity_type - Activity type monitor element
APPLICATION_HANDLE
COORD_PARTITION_NUM
coord_partition_num - Coordinator partition number

monitor element
If this activity has been mapped to a work action set that

has been applied to the database, this column contains
the ID of the work action set. This column contains 0 if
the activity has not been mapped to a work action set
that has been applied to the database.

has been applied to the database, this column contains
the ID of the work class of this activity. This column
contains 0 if the activity has not been mapped to a work
action set that has been applied to the database.
EFFECTIVE_ISOLATION
effective_isolation - Effective isolation monitor element
EFFECTIVE_LOCK_TIMEOUT
effective_lock_timeout - Effective lock timeout monitor

element
EFFECTIVE_QUERY_DEGREE
effective_query_degree - Effective query degree monitor

element
ENTRY_TIME
entry_time - Entry time monitor element
INVOCATION_ID
LAST_REFERENCE_TIME
last_reference_time - Last reference time monitor element
LOCAL_START_TIME
local_start_time - Local start time monitor element
NESTING_LEVEL
PACKAGE_NAME
package_name - Package name monitor element
PACKAGE_SCHEMA
package_schema - Package schema monitor element
PACKAGE_VERSION_ID
package_version_id - Package version monitor element
PARENT_ACTIVITY_ID
PARENT_UOW_ID
Unique unit of work identifier within an application.

Refers to the original unit of work this activity's parent
activity started in. Returns an empty string if the activity
has no parent activity or when at a remote member.
QUERY_COST_ESTIMATE
query_cost_estimate - Query cost estimate monitor

element
ROUTINE_ID
ROWS_FETCHED
rows_fetched - Rows fetched monitor element
ROWS_MODIFIED
SECTION_NUMBER
section_number - Section number monitor element
SERVICE_CLASS_ID

has been applied to a service class, this column contains
the ID of the work action set. This column contains 0 if
the activity has not been mapped to a work action set
that has been applied to a service class.
1530
Table 363. Elements returned (continued)

Element Name
Description

has been applied to a service class, this column contains
the ID of the work class of this activity. This column
contains 0 if the activity has not been mapped to a work
action set that has been applied to a service class.
STMT_PKG_CACHE_ID
stmt_pkgcache_id - Statement package cache identifier

monitor element
STMT_TEXT
stmt_text - SQL statement text monitor element
SYSTEM_CPU_TIME
system_cpu_time - System CPU time monitor element
UOW_ID
USER_CPU_TIME
user_cpu_time - User CPU time monitor element
UTILITY_ID
Important: The WLM_GET_ACTIVITY_DETAILS table function shows only the

thresholds that are currently being applied to an activity.
The following elements are returned only if the corresponding thresholds apply to
the activity.
Table 364. Elements returned if applicable
Element Name
Description
ACTIVITYTOTALTIME_THRESHOLD_ID
activitytotaltime_threshold_id - Activity total time threshold

ID monitor element
VALUE
activitytotaltime_threshold_value - Activity total time

VIOLATED
activitytotaltime_threshold_violated - Activity total time

CONCURRENTDBCOORDACTIVITIES_DB_
THRESHOLD_ID
concurrentdbcoordactivities_db_threshold_id - Concurrent
database coordinator activities database threshold ID monitor
element
THRESHOLD_QUEUED
concurrentdbcoordactivities_db_threshold_queued Concurrent database coordinator activities database threshold

THRESHOLD_VALUE
concurrentdbcoordactivities_db_threshold_value - Concurrent
database coordinator activities database threshold value
monitor element
THRESHOLD_VIOLATED
concurrentdbcoordactivities_db_threshold_violated Concurrent database coordinator activities database threshold

SUBCLASS_THRESHOLD_ID
concurrentdbcoordactivities_subclass_threshold_id Concurrent database coordinator activities service subclass

SUBCLASS_THRESHOLD_QUEUED
'Yes' indicates that the activity was queued by the

CONCURRENTDBCOORDACTIVITIES_SUBCLASS
threshold. 'No' indicates that the activity was not queued.
SUBCLASS_THRESHOLD_VALUE
concurrentdbcoordactivities_subclass_threshold_value Concurrent database coordinator activities service subclass

1531
Table 364. Elements returned if applicable (continued)

Element Name
Description
SUBCLASS_THRESHOLD_VIOLATED
'Yes' indicates that the activity violated the

CONCURRENTDBCOORDACTIVITIES_SUBCLASS
threshold. 'No' indicates that the activity has not yet violated
the threshold.
SUPERCLASS_THRESHOLD_ID
The ID of the
CONCURRENTDBCOORDACTIVITIES
_SUPERCLASS threshold that was applied to the
activity.
SUPERCLASS_THRESHOLD_QUEUED
'Yes' indicates that the activity was queued by

the CONCURRENTDBCOORDACTIVITIES
_SUPERCLASS threshold. 'No' indicates that the
activity was not queued.
SUPERCLASS_THRESHOLD_VALUE
The upper bound of the

_SUPERCLASS threshold that was applied to the
activity.
SUPERCLASS_THRESHOLD_VIOLATED

_SUPERCLASS threshold. 'No' indicates that the
activity has not yet violated the threshold.
WORK_ACTION_SET_THRESHOLD_ID
The ID of the
CONCURRENTDBCOORDACTIVITIES_WORK
_ACTION_SET threshold that was applied to the
activity.
WORK_ACTION_SET_THRESHOLD_QUEUED
'Yes' indicates that the activity was queued by

the CONCURRENTDBCOORDACTIVITIES
_WORK_ACTION_SET threshold. 'No' indicates
that the activity was not queued.
WORK_ACTION_SET_THRESHOLD_VALUE

_ACTION_SET threshold that was applied to the
activity.
WORK_ACTION_SET_THRESHOLD_VIOLATED

_ACTION_SET threshold. 'No' indicates that the
activity has not yet violated the threshold.
CONCURRENTWORKLOADACTIVITIES
_THRESHOLD_ID
The ID of the CONCURRENTWORKLOADACTIVITIES

threshold that was applied to the activity.
_THRESHOLD_VALUE

CONCURRENTWORKLOADACTIVITIES threshold that was
applied to the activity.
_THRESHOLD_VIOLATED

CONCURRENTWORKLOADACTIVITIES threshold. 'No'
indicates that the activity has not yet violated the threshold.
ESTIMATEDSQLCOST_THRESHOLD_
ID
estimatedsqlcost_threshold_id - Estimated SQL cost threshold

ID monitor element
VALUE
estimatedsqlcost_threshold_value - Estimated SQL cost

VIOLATED
estimatedsqlcost_threshold_violated - Estimated SQL cost

1532
Table 364. Elements returned if applicable (continued)

Element Name
Description
SQLROWSRETURNED_THRESHOLD_
ID
sqlrowsreturned_threshold_id - SQL rows read returned

VALUE
sqlrowsreturned_threshold_value - SQL rows read returned

VIOLATED
sqlrowsreturned_threshold_violated - SQL rows read returned

SQLTEMPSPACE_THRESHOLD_ID
sqltempspace_threshold_id - SQL temporary space threshold

ID monitor element
SQLTEMPSPACE_THRESHOLD_
VALUE
sqltempspace_threshold_value - SQL temporary space

SQLTEMPSPACE_THRESHOLD_
VIOLATED
sqltempspace_threshold_violated - SQL temporary space

_V97 - List agents running in a service class
The WLM_GET_SERVICE_CLASS_AGENTS_V97 table function returns the list of
agents, fenced mode processes (db2fmp processes), and system entities on a
specified member that are running in a specified service class or on behalf of a
specified application. The system entities are non-agent threads and processes, such
as page cleaners and prefetchers.
WLM_GET_SERVICE_CLASS_AGENTS table function.
Syntax
WLM_GET_SERVICE_CLASS_AGENTS_V97 (
application_handle
member

An input argument of type VARCHAR(128) that refers to a specific subclass
within a superclass. If the argument is null or an empty string, data is
retrieved for all the subclasses in the database.
application_handle
An input argument of type BIGINT that specifies the application handle for
which agent information is to be returned. If the argument is null, data is
retrieved for all applications in the database. An application handle of 0
returns the system entities only.
1533
member
An input argument of type INTEGER that specifies the member number in the
database member, or -2 for all database members. If a null value is specified, -1
is set implicitly.
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
Examples
Example 1
The following query returns a list of agents that are associated with
application handle 1 for all database members. You can determine the
application handle by using the LIST APPLICATIONS command or the
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES_V97 table
function.
SELECT SUBSTR(CHAR(APPLICATION_HANDLE),1,7) AS APPHANDLE,
SUBSTR(CHAR(DBPARTITIONNUM),1,4) AS PART,
SUBSTR(CHAR(AGENT_TID),1,9) AS AGENT_TID,
SUBSTR(AGENT_TYPE,1,11) AS AGENTTYPE,
SUBSTR(AGENT_STATE,1,10) AS AGENTSTATE,
SUBSTR(REQUEST_TYPE,1,12) AS REQTYPE,
SUBSTR(CHAR(UOW_ID),1,6) AS UOW_ID,
SUBSTR(CHAR(ACTIVITY_ID),1,6) AS ACT_ID
FROM TABLE(WLM_GET_SERVICE_CLASS_AGENTS_V97(CAST(NULL AS VARCHAR(128)),
CAST(NULL AS VARCHAR(128)), 1, -2)) AS SCDETAILS
ORDER BY APPHANDLE, PART, AGENT_TID

APPHANDLE
--------1
1
1
PART
---0
0
1
AGENT_TID
--------3
4
2
AGENTTYPE
SUBAGENT
SUBAGENT
AGENTSTATE
---------ACTIVE
ACTIVE
ACTIVE
REQTYPE
-------------FETCH
SUBSECTION:1
SUBSECTION:2
UOW_ID
-----1
1
1
ACT_ID
-----5
5
5
The output shows a coordinator agent and a subagent on member 0 and a

subagent on member 1 operating on behalf of an activity with UOW ID 1
and activity ID 5. The AGENTTYPE column with a value of COORDINATOR has a
value of FETCH for the REQTYPE column (which indicates the main or initial
request type). This means that the type of request is a fetch request for the
coordinator agent.
Example 2
The following query determines which lock an agent is waiting on:
1534
select event_object, event_type, event_state, varchar

(event_object_name, 30)
as event_object_name
from table
(wlm_get_service_class_agents_v97(,,cast(NULL as bigint), -1)) as t

EVENT_OBJECT
--------------REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
LOCK
ROUTINE
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
EVENT_TYPE
----------------PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
WAIT
ACQUIRE
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
EVENT_STATE
------------------EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
IDLE
IDLE
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EVENT_OBJECT_NAME
-------------------------02000500000000000000000054
Using the same query at a later time shows that the WLM threshold has
queued an agent:
EVENT_OBJECT
--------------REQUEST
REQUEST
REQUEST
EVENT_TYPE
----------------PROCESS
PROCESS
PROCESS
EVENT_STATE
------------------EXECUTING
EXECUTING
EXECUTING
1535
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
WLM_QUEUE
ROUTINE
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
REQUEST
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
WAIT
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
PROCESS
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
IDLE
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EXECUTING
EVENT_OBJECT_NAME
-------------------------MYCONCDBCOORDTH
Usage note
Table 365. Information returned by WLM_GET_SERVICE_CLASS_AGENTS_V97
Column name
Data type
Description
VARCHAR
(128)
service_superclass_name - Service superclass name monitor

element
VARCHAR
(128)
service_subclass_name - Service subclass name monitor

element
APPLICATION_HANDLE
BIGINT
1536
Table 365. Information returned by WLM_GET_SERVICE_CLASS_AGENTS_V97 (continued)

Column name
Data type
Description
DBPARTITIONNUM
SMALLINT

element
ENTITY
VARCHAR (32)

v If the type of entity is an agent, the value is db2agent.
v If the type of entity is a fenced mode process, the value is
db2fmp (pid) where pid is the process ID of the fenced
mode process.
v Otherwise, the value is the name of the system entity.
WORKLOAD_NAME
VARCHAR
(128)
INTEGER
workload_occurrence_id - Workload occurrence identifier

monitor element
UOW_ID
INTEGER
ACTIVITY_ID
INTEGER
PARENT_UOW_ID
INTEGER
parent_uow_id - Parent unit of work ID monitor element
PARENT_ACTIVITY_ID
INTEGER
AGENT_TID
BIGINT
agent_tid - Agent thread ID monitor element
AGENT_TYPE
VARCHAR (32)
Agent type. The agent types are as follows:

v COORDINATOR
v OTHER
v PDBSUBAGENT
v SMPSUBAGENT
If the value is COORDINATOR, the agent ID might change
in concentrator environments.
SMP_COORDINATOR
INTEGER
Indication of whether the agent is an SMP coordinator: 1 for

yes and 0 for no.
AGENT_SUBTYPE
VARCHAR (32)
Agent subtype. The possible subtypes are as follows:

v DSS
v OTHER
v RPC
v SMP
AGENT_STATE
VARCHAR (32)
Indication of whether an agent is associated or active. The

v ASSOCIATED
v ACTIVE
EVENT_TYPE
VARCHAR (32)
Type of event last processed by this agent. The possible

v ACQUIRE
v PROCESS
v WAIT
1537

Column name
Data type
Description
EVENT_OBJECT
VARCHAR (32)
Object of the event last processed by this agent. The possible

v COMPRESSION_DICTIONARY_BUILD
v IMPLICIT_REBIND
v INDEX_RECREATE
v LOCK
v LOCK_ESCALATION
v QP_QUEUE
v REMOTE_REQUEST
v REQUEST
v ROUTINE
v WLM_QUEUE
EVENT_STATE
VARCHAR (32)
State of the event last processed by this agent. The possible

v EXECUTING
v IDLE
REQUEST_ID
1538
VARCHAR (64)
Request ID. This value is unique only in combination with

the value of application_handle. You can use this combination
to distinguish between one request that is taking a long time
and multiple requests; for example, to distinguish between
one long fetch and multiple fetches.

Column name
Data type
Description
REQUEST_TYPE
VARCHAR (32)
Type of request. The possible values are as follows:

v For coordinator agents:
CLOSE
COMMIT
COMPILE
DESCRIBE
EXCSQLSET
EXECIMMD
EXECUTE
FETCH
internal constant
OPEN
PREPARE
REBIND
REDISTRIBUTE
REORG
ROLLBACK
RUNSTATS
v For subagents with an AGENT_SUBTYPE of DSS or SMP:
If the subsection number is nonzero, the subsection
number in the form SUBSECTION:subsection number;
otherwise, returns NULL.
1539

Column name
Data type
Description
REQUEST_TYPE (continued)
VARCHAR (32)
v For subagents with an AGENT_SUBTYPE of RPC:

ABP
CATALOG
INTERNAL
REORG
RUNSTATS
WLM
v For subagents with a SUBTYPE of OTHER:
ABP
APP_RBSVPT
APP_RELSVPT
BACKUP
CLOSE
EXTERNAL_RBSVPT
EVMON
FORCE
FORCE_ALL
internal constant
INTERRUPT
NOOP (if there is no request)
QP
REDISTRIBUTE
STMT_RBSVPT
STOP_USING
UPDATE_DBM_CFG
WLM
NESTING_LEVEL
INTEGER
INVOCATION_ID
INTEGER
ROUTINE_ID
INTEGER
EVENT_OBJECT_NAME
VARCHAR
(1024)
Event object name. If the value of EVENT_OBJECT is LOCK,

the value of this column is the name of the lock that the
agent is waiting on. If the value of EVENT_OBJECT is
WLM_QUEUE, the value of the column is the name of the
WLM threshold that the agent is queued on. Otherwise, the
value is NULL.
APPLICATION_NAME
VARCHAR
(128)
APPLICATION_ID
VARCHAR
(128)
CLIENT_PID
BIGINT
SESSION_AUTH_ID
VARCHAR
(128)
REQUEST_START_TIME
TIMESTAMP
Time that the agent started processing the request on which

it is currently working
1540

Column name
Data type
Description
AGENT_STATE_LAST
_UPDATE_TIME
TIMESTAMP
The last time that the event, being processed by the agent,
was changed. The event currently processed by the agent is
identified by the EVENT_TYPE, EVENT_OBJECT, and
EVENT_STATE columns.
EXECUTABLE_ID
VARCHAR (32)
FOR BIT DATA
Note: The possible combinations of EVENT_STATE, EVENT_TYPE,

EVENT_OBJECT and EVENT_OBJECT_NAME column values are listed in the
following table.
Table 366. Possible combinations for EVENT_STATE, EVENT_TYPE, EVENT_OBJECT and
EVENT_OBJECT_NAME column values
Event description
EVENT_STATE
value
EVENT_TYPE
value
EVENT_OBJECT value
EVENT_OBJECT
_NAME value
Acquire lock
IDLE
ACQUIRE
LOCK
Lock name
Escalate lock
EXECUTING
PROCESS
LOCK
_ESCALATION
NULL
Process request
EXECUTING
PROCESS
REQUEST
NULL
Wait for a new

request
IDLE
WAIT
REQUEST
NULL
Wait for a request to

be processed at a
remote partition
IDLE
WAIT
REMOTE
_REQUEST
NULL
Wait on a WLM
threshold queue
IDLE
WAIT
WLM_QUEUE
Threshold name
Process a routine
EXECUTING
PROCESS
ROUTINE
NULL
Re-create an index
EXECUTING
PROCESS
INDEX
_RECREATE
NULL
Build compression
dictionary
EXECUTING
PROCESS
COMP
_DICT_BLD
NULL
Implicit rebind
EXECUTING
PROCESS
IMPLICIT
_REBIND
NULL
_WORKLOAD_OCCURRENCES_V97 - List of workload
occurrences
The WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES_V97 function
returns the list of all workload occurrences running in a specified service class on a
particular member. A workload occurrence is a specific database connection whose
attributes match the definition of a workload and hence is associated with or
assigned to the workload.
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES table function.
1541
A workload occurrence is a specific database connection whose attributes match

with the definition of a workload and hence is associated with or assigned to the
workload.
Syntax
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES_V97 ( service_superclass_name ,
service_subclass_name , member )

empty string, the data is retrieved for all the superclasses in the database that
match the values of the other parameters.
Target service subclass for the workload occurrence. Any work submitted by
this workload occurrence will run in this service subclass under the target
service superclass with the exception of activities that are mapped, or
remapped, to a different subclass.
member
Authorization
v
v
v
v
v

DBADM authority
SQLADM authority
WLMADM authority

None
Example
If an administrator wants to see what workload occurrences are running on the
system as a whole, the administrator can call the
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES_V97 function by
specifying a null value or an empty string for service_superclass_name and
service_subclass_name and -2 for member:
SUBSTR(CHAR(COORD_PARTITION_NUM),1,4) AS COORDPART,
1542
SUBSTR(CHAR(APPLICATION_HANDLE),1,7) AS APPHNDL,
SUBSTR(WORKLOAD_NAME,1,22) AS WORKLOAD_NAME,
SUBSTR(CHAR(WORKLOAD_OCCURRENCE_ID),1,6) AS WLO_ID
FROM TABLE(WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES_V97
(CAST(NULL AS VARCHAR(128)), CAST(NULL AS VARCHAR(128)), -2))
AS SCINFO
ORDER BY SUPERCLASS_NAME, SUBCLASS_NAME, PART, APPHNDL,
WORKLOAD_NAME, WLO_ID
If the system has four database members and is currently running two workloads,
the previous query produces results such as the following ones:
SUPERCLASS_NAME
------------------SYSDEFAULTMAINTENAN
SYSDEFAULTSYSTEMCLA
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
...
...
...
...
...
...
...
...
...
...
...
...
APPHNDL
------1
2
1
2
1
2
1
2
SUBCLASS_NAME
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
WORKLOAD_NAME
---------------------SYSDEFAULTUSERWORKLOAD
PART
---0
0
0
0
1
1
2
2
3
3
COORDPART
--------0
0
0
0
0
0
0
0
0
0
...
...
...
...
...
...
...
...
...
...
...
...
WLO_ID
-----1
2
1
2
1
2
1
2
Usage note
Note: Statistics reported for the workload occurrence (for example,
coord_act_completed_total) are reset at the beginning of each unit of work when
they are combined with the corresponding workload statistics.
Table 367. Information returned for WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES_V97
Column name
Data type
Description
VARCHAR(128)

VARCHAR(128)

monitor element
DBPARTITIONNUM
SMALLINT

monitor element
COORD_PARTITION_NUM
SMALLINT

1543
Table 367. Information returned for WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES_V97 (continued)

Column name
Data type
Description
APPLICATION_HANDLE
BIGINT

element
WORKLOAD_NAME
VARCHAR(128)
workload_name - Workload name monitor

element
INTEGER

UOW_ID
INTEGER
VARCHAR(32)
workload_occurrence_state - Workload
occurrence state monitor element
SYSTEM_AUTH_ID
VARCHAR(128)

monitor element
SESSION_AUTH_ID
VARCHAR(128)

monitor element
APPLICATION_NAME
VARCHAR(128)
CLIENT_WRKSTNNAME
VARCHAR(255)

monitor element
CLIENT_ACCTNG
VARCHAR(255)

element
CLIENT_USER
VARCHAR(255)
Current value of the CLIENT_USERID special

register for this workload occurrence.
CLIENT_APPLNAME
VARCHAR(255)

monitor element
INTEGER
INTEGER

INTEGER

CONCURRENT_ACT_TOP
INTEGER
concurrent_act_top - Concurrent activity top

monitor element
ADDRESS
VARCHAR(255)
address - IP address from which the connection

was initiated
_STATS_V97 - return statistics of service subclasses
The WLM_GET_SERVICE_SUBCLASS_STATS_V97 table function returns basic
statistics of one or more service subclasses.
WLM_GET_SERVICE_SUBCLASS_STATS table function.
returned.
Syntax
1544
WLM_GET_SERVICE_SUBCLASS_STATS_V97 (
member


empty string, the data is retrieved for all of the superclasses in the database.
subclass in the currently connected database. If the argument is null or an
empty string, the data is retrieved for all of the subclasses in the database.
member
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
Examples
Example 1: Because every activity must be mapped to a DB2 service class before
being run, you can monitor the global state of the system by using the service class
statistics table functions and querying all of the service classes on all members. In
the following example, a null value is passed for service_superclass_name and
service_subclass_name to return statistics for all service classes, and the value -2 is
specified for dbpartitionnum to return statistics for all partitions:
CAST(COORD_ACT_LIFETIME_AVG / 1000 AS DECIMAL(9,3))
AS AVGLIFETIME,
CAST(COORD_ACT_LIFETIME_STDDEV / 1000 AS DECIMAL(9,3))
AS STDDEVLIFETIME,
SUBSTR(CAST(LAST_RESET AS VARCHAR(30)),1,16) AS LAST_RESET
FROM TABLE(WLM_GET_SERVICE_SUBCLASS_STATS_V97(CAST(NULL AS VARCHAR(128)),
ORDER BY SUPERCLASS_NAME, SUBCLASS_NAME, PART
1545
The statement returns service class statistics such as average activity lifetime and
standard deviation in seconds, as shown in the following sample output:
SUPERCLASS_NAME
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SUBCLASS_NAME
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
PART
---0
1
2
3
...
...
...
...
...
...
... AVGLIFETIME STDDEVLIFETIME LAST_RESET

... ----------- -------------- ---------------...
691.242
34.322 2006-07-24-11.44
...
644.740
22.124 2006-07-24-11.44
...
612.431
43.347 2006-07-24-11.44
...
593.451
28.329 2006-07-24-11.44
Example 2: The same table function can also give the highest value for average
concurrency of coordinator activities running in the service class on each partition:
CONCURRENT_ACT_TOP AS ACTTOP,
CONCURRENT_WLO_TOP AS CONNTOP
ORDER BY SUPERCLASS_NAME, SUBCLASS_NAME, PART

SUPERCLASS_NAME
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SYSDEFAULTUSERCLASS
SUBCLASS_NAME
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
SYSDEFAULTSUBCLASS
PART ACTTOP
CONNTOP
---- --------- --------0
10
7
1
0
0
2
0
0
3
0
0
By checking the average execution times and numbers of activities in the output of
this table function, you can get a good high-level view of the load on each
partition for a specific database. Any significant variations in the high-level gauges
returned by this table function might indicate a change in the load on the system.
Example 3: If an activity uses thresholds with REMAP ACTIVITY TO actions, the
activity might spend time in more than one service class during its lifetime. You
can determine how many activities have passed through a set of service classes by
looking at the ACTIVITIES_MAPPED_IN and ACTIVITIES_MAPPED_OUT
columns, as shown in the following example:
ACTIVITIES_MAPPED_IN AS MAPPED_IN,
ACTIVITIES_MAPPED_OUT AS MAPPED_OUT
ORDER BY SUPERCLASS_NAME, SUBCLASS_NAME

SUPERCLASS_NAME
SUPERCLASS1
SUPERCLASS1
SUPERCLASS1
1546
SUBCLASS_NAME
MAPPED_IN MAPPED_OUT
------------------ --------- ---------SYSDEFAULTSUBCLASS
0
0
SYSDEFAULTSUBCLASS
0
0
SUBCLASS1
0
7
SUBCLASS2
7
0
Usage notes
Some statistics are returned only if you set the COLLECT AGGREGATE ACTIVITY
DATA and COLLECT AGGREGATE REQUEST DATA parameters for the
corresponding service subclass to a value other than NONE.
The WLM_GET_SERVICE_SUBCLASS_STATS_V97 table function returns one row
of data per service subclass and per partition. The function does not aggregate data
across service classes (on a partition) or across partitions (for one or more service
classes). However, you can use SQL queries to aggregate data.
input parameters, such as a superclass named SUPA and a subclass named SUBB
such that SUBB is not a subclass of SUPA, no rows are returned.
Table 368. Information returned for WLM_GET_SERVICE_SUBCLASS_STATS_V97
Column name
Data type
Description
VARCHAR(128)
VARCHAR(128)
service_subclass_name - Service subclass

DBPARTITIONNUM
SMALLINT

LAST_RESET
TIMESTAMP
last_reset - Last Reset Timestamp monitor

element
BIGINT
BIGINT
coord_act_aborted_total - Coordinator
activities aborted total monitor element
BIGINT
coord_act_rejected_total - Coordinator
activities rejected total monitor element
CONCURRENT_ACT_TOP
INTEGER
concurrent_act_top - Concurrent activity

top monitor element
BIGINT
coord_act_lifetime_top - Coordinator
activity lifetime top monitor element
DOUBLE
coord_act_lifetime_avg - Coordinator
activity lifetime average monitor element
1547
Table 368. Information returned for WLM_GET_SERVICE_SUBCLASS_STATS_V97 (continued)

Column name
Data type
Description
DOUBLE
Standard deviation of lifetime for

milliseconds.
the coordinator activity lifetime histogram
and may be inaccurate if the histogram is
not correctly sized to fit the data. The value
of -1 is returned if any values fall into the
last histogram bin.
The COORD_ACT_LIFETIME_STDDEV
value of a service subclass is unaffected by
activities that pass through the service
subclass but are remapped to a different
subclass before they are completed.
DOUBLE
coord_act_exec_time_avg - Coordinator
activities execution time average monitor
element
DOUBLE

for coordinator activities at nesting level 0
milliseconds.
the coordinator activity executetime
service subclass is unaffected by activities
that pass through the subclass but are
remapped to a different subclass before
they are completed.
1548
DOUBLE
coord_act_queue_time_avg - Coordinator
activity queue time average monitor
element

Column name
Data type
Description
DOUBLE
Standard deviation of the queue time for

milliseconds.
the coordinator activity queuetime
The queue time standard deviation is
counted only toward the service subclass in
which the activity was queued.
NUM_REQUESTS_ACTIVE
BIGINT
Number of requests that are running in the

service subclass at the time that this table
function is running.
NUM_REQUESTS_TOTAL
BIGINT
Number of requests that finished running

in this service subclass since the last reset.
This finished state applies to any request
regardless of its membership in an activity.
If the COLLECT AGGREGATE ACTIVITY
DATA parameter of the service class is set
The NUM_REQUESTS_TOTAL value of a
that pass through the service subclass but
are not completed in it.
REQUEST_EXEC_TIME_AVG
DOUBLE
request_exec_time_avg - Request execution

time average monitor element
REQUEST_EXEC_TIME_STDDEV
DOUBLE

for requests that were associated with this
service subclass since the last reset. Units
are milliseconds. If the COLLECT
the request executetime histogram and may
be inaccurate if the histogram is not
correctly sized to fit the data. The value of
-1 is returned if any values fall into the last
histogram bin.
that pass through the subclass but were not
completed in it.
1549

Column name
Data type
Description
REQUEST_EXEC_TIME_TOTAL
BIGINT
Sum of the execution times for requests

milliseconds. If the COLLECT
This total is computed from the request
execution time histogram and may be
inaccurate if the histogram is not correctly
sized to fit the data. The value of -1 is
returned if any values fall into the last
histogram bin.
The execution time total of a service
subclass is unaffected by requests that pass
through the subclass but are not completed
in it.
ACT_REMAPPED_IN
BIGINT
Number of activities remapped into this

service subclass by a threshold REMAP
ACTIVITY action since the last reset.
ACT_REMAPPED_OUT
BIGINT
Number of activities remapped out of this

service subclass by a threshold REMAP
ACTIVITY action since the last reset.
CONCURRENT_WLO_TOP
INTEGER

UOW_TOTAL_TIME_TOP
BIGINT
uow_total_time_top - UOW total time top

monitor element
WLM_GET_WORKLOAD
_V97 - Return a list of activities
The WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES_V97 table function
returns the list of all activities that were submitted by a specified application on a
specified member and have not yet been completed.
WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES table function.
returned.
Syntax
WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES_V97 (
member )
1550
application_handle


application_handle
An input argument of type BIGINT that specifies an application handle for
which a list of activities is to be returned. If the argument is null, the data is
retrieved for all the applications in the database.
member
current member, or -2 for all members. If the null value is specified, -1 is set
implicitly.
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
Example 1: Activities currently running with a known application

handle
After you identify the application handle, you can look up all the activities
currently running in this application. For example, suppose that an administrator
wants to list the activities of an application whose application handle, determined
by using the LIST APPLICATIONS command, is 1. The administrator runs the
following query:
SELECT SUBSTR(CHAR(COORD_PARTITION_NUM),1,5) AS COORD,
SUBSTR(CHAR(UOW_ID),1,5) AS UOWID,
SUBSTR(CHAR(ACTIVITY_ID),1,5) AS ACTID,
SUBSTR(CHAR(PARENT_UOW_ID),1,8) AS PARUOWID,
SUBSTR(CHAR(PARENT_ACTIVITY_ID),1,8) AS PARACTID,
ACTIVITY_TYPE AS ACTTYPE,
SUBSTR(CHAR(NESTING_LEVEL),1,7) AS NESTING
FROM TABLE(WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES_V97(1, -2)) AS WLOACTS
ORDER BY PART, UOWID, ACTID

COORD
----0
0
PART
---0
0
UOWID
----2
2
ACTID
----3
5
PARUOWID
-------2
PARACTID
-------3
ACTTYPE
-------CALL
READ_DML
NESTING
------0
1
Example 2: Activities currently running on the system

The following query joins the
WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES_V97 output with the
MON_GET_PKG_CACHE_STMT output on EXECUTABLE_ID to provide
statement text for all the SQL activities currently running on the system:
1551
SELECT t.application_handle,
t.uow_id,
t.activity_id,
varchar(p.stmt_text, 256) as stmt_text
FROM table(wlm_get_workload_occurrence_activities_v97(NULL, -1)) as t,
table(mon_get_pkg_cache_stmt(NULL, NULL, NULL, -1)) as p
WHERE t.executable_id = p.executable_id

APPLICATION_HANDLE
UOW_ID
ACTIVITY_ID
STMT_TEXT
------------------ ----------- -------------- -----------------------------1
1
1
SELECT * FROM SYSCAT.TABLES
47
1
36
INSERT INTO T1 VALUES(123)
Table 369. Information returned by WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES_V97
Column name
Data type
Description
APPLICATION_HANDLE
BIGINT

monitor element
MEMBER
SMALLINT

element
COORD_PARTITION_NUM
SMALLINT

LOCAL_START_TIME
TIMESTAMP
local_start_time - Local start time monitor

element
UOW_ID
INTEGER
ACTIVITY_ID
INTEGER
PARENT_UOW_ID
INTEGER
parent_uow_id - Parent unit of work ID

monitor element
PARENT_ACTIVITY_ID
INTEGER
parent_activity_id - Parent activity ID

monitor element
ACTIVITY_STATE
VARCHAR(32)
activity_state - Activity state monitor

element
1552
Table 369. Information returned by WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES_V97 (continued)

Column name
Data type
Description
ACTIVITY_STATE (continued)
VARCHAR(32)
Activity state. Possible values are as follows:

QUEUED
The activity is queued by a
workload management queuing
threshold. In a partitioned database
environment, this state might mean
that the coordinator agent has made
an RPC to the catalog partition to
obtain threshold tickets and has not
yet received a response. This state
might indicate that the activity has
been queued by a workload
management queuing threshold or,
if not much time has elapsed, can
indicate that the activity is in the
process of obtaining its tickets. To
obtain a more accurate picture of
whether the activity is being
queued, determine what agent is
working on the activity, and find
out whether the EVENT_OBJECT
value of the object at the catalog
partition has a value of
WLM_QUEUE.
TERMINATING
The activity has finished running
and is being removed from the
system.
ACTIVITY_TYPE
VARCHAR(32)
Activity type. Possible values are as follows:

v CALL
v DDL
v LOAD
v OTHER
v READ_DML
v WRITE_DML
NESTING_LEVEL
INTEGER
nesting_level - Nesting level monitor

element
INVOCATION_ID
INTEGER
invocation_id - Invocation ID monitor

element
ROUTINE_ID
INTEGER
UTILITY_ID
INTEGER
SERVICE_CLASS_ID
INTEGER
service_class_id - Service class ID monitor

element
INTEGER

v If this activity has been categorized into a
work class of database scope, the value is
the ID of the work class set of which this
work class is a member.
v If this activity has not been categorized
into a work class of database scope, the
value is null.
1553
Table 369. Information returned by WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES_V97 (continued)

Column name
Data type
Description
INTEGER

work class of database scope, the value is
the ID of the work class.
into a work class of database scope, the
value is null.
INTEGER

work class of service class scope, the
value is the ID of the work action set
associated with the work class set to
which the work class belongs.
into a work class of service class scope,
the value is null.
INTEGER

work class of service class scope, the
value is the ID of the work class assigned
to this activity.
into a work class of service class scope,
the value is null.
EXECUTABLE_ID
VARCHAR(32) FOR executable_id - Executable ID monitor

BIT DATA
element
TOTAL_CPU_TIME
BIGINT
ROWS_READ
BIGINT
ROWS_RETURNED
BIGINT
QUERY_COST_ESTIMATE
BIGINT
DIRECT_READS
BIGINT
DIRECT_WRITES
BIGINT
WLM_GET_WORKLOAD_STATS_V97 - return workload

statistics
The WLM_GET_WORKLOAD_STATS_V97 table function returns workload
WLM_GET_WORKLOAD_STATS table function.
returned.
Syntax
WLM_GET_WORKLOAD_STATS_V97 (
1554
workload_name
member

workload_name
An input argument of type VARCHAR(128) that specifies a workload for
which the statistics are to be returned. If the argument is NULL or an empty
string, statistics are returned for all workloads.
member
current member, or -2 for all members. If a null value is specified, -1 is set
implicitly.
Authorization
v DBADM authority
v SQLADM authority
v WLMADM authority

None
Example
The following query displays statistics for workloads:
SELECT SUBSTR(WORKLOAD_NAME,1,18) AS WL_DEF_NAME,
COORD_ACT_LIFETIME_TOP,
COORD_ACT_LIFETIME_AVG,
FROM TABLE(WLM_GET_WORKLOAD_STATS_V97(CAST(NULL AS VARCHAR(128)), -2)) AS WLSTATS
ORDER BY WL_DEF_NAME, PART

WL_DEF_NAME
-----------------SYSDEFAULTADMWORKL
SYSDEFAULTUSERWORK
WL1
...
...
...
...
...
PART COORD_ACT_LIFETIME_TOP ...

---- ---------------------- ...
0
-1 ...
0
-1 ...
0
2 ...
------------------------ -------------------------1.00000000000000E+000
-1.00000000000000E+000
-1.00000000000000E+000
-1.00000000000000E+000
+2.56000000000000E+000
+6.00000000000001E-002
Usage note
The function does not aggregate data across workloads, members, or service
classes. However, you can use SQL queries to aggregate data.
1555
Table 370. Information returned by WLM_GET_WORKLOAD_STATS_V97
Column name
Data type
Description
WORKLOAD_NAME
VARCHAR(128)
DBPARTITIONNUM
SMALLINT

monitor element
LAST_RESET
TIMESTAMP
CONCURRENT_WLO_TOP
INTEGER

CONCURRENT_WLO_ACT_TOP
INTEGER
concurrent_wlo_act_top - Concurrent WLO activity

top monitor element
BIGINT
coord_act_completed_total - Coordinator activities

BIGINT

BIGINT

WLO_COMPLETED_TOTAL
BIGINT
wlo_completed_total - Workload occurrences

BIGINT
coord_act_lifetime_top - Coordinator activity

lifetime top monitor element
DOUBLE
coord_act_lifetime_avg - Coordinator activity

DOUBLE
Standard deviation of lifetime for completed or

aborted coordinator activities at nesting level 0 that
are associated with this workload. Units are
coordinator activity lifetime histogram and may be
inaccurate if the histogram is not correctly sized to
fit the data. If any values fall into the last
DOUBLE
coord_act_exec_time_avg - Coordinator activities

execution time average monitor element
DOUBLE
Standard deviation of the execution times for

completed or aborted coordinator activities at
nesting level 0 that are associated with this
workload. Units are milliseconds. This standard
deviation is computed from the coordinator activity
executetime histogram and may be inaccurate if the
histogram is not correctly sized to fit the data. If
any values fall into the last histogram bin, the value
-1 is returned. If the COLLECT AGGREGATE
DOUBLE
coord_act_queue_time_avg - Coordinator activity

queue time average monitor element
1556
Table 370. Information returned by WLM_GET_WORKLOAD_STATS_V97 (continued)

Column name
Data type
Description
DOUBLE
Standard deviation of the queue time for completed

or aborted coordinator activities at nesting level 0
that are associated with this workload. Units are
coordinator activity queuetime histogram and may
be inaccurate if the histogram is not correctly sized
to fit the data. If any values fall into the last
UOW_TOTAL_TIME_TOP
BIGINT
uow_total_time_top - UOW total time top monitor

element
1557
1558
Appendix A. Overview of the DB2 technical information

DB2 technical information is available in multiple formats that can be accessed in
multiple ways.
DB2 technical information is available through the following tools and methods:
v DB2 Information Center
Topics (Task, concept and reference topics)
Sample programs
Tutorials
v DB2 books
PDF files (downloadable)
PDF files (from the DB2 PDF DVD)
printed books
v Command-line help
Command help
Message help
Note: The DB2 Information Center topics are updated more frequently than either
the PDF or the hardcopy books. To get the most current information, install the
documentation updates as they become available, or refer to the DB2 Information
Center at ibm.com.
You can access additional DB2 technical information such as technotes, white
papers, and IBM Redbooks publications online at ibm.com. Access the DB2
Information Management software library site at http://www.ibm.com/software/
data/sw-library/.
Documentation feedback
We value your feedback on the DB2 documentation. If you have suggestions for
how to improve the DB2 documentation, send an email to db2docs@ca.ibm.com.
The DB2 documentation team reads all of your feedback, but cannot respond to
you directly. Provide specific examples wherever possible so that we can better
understand your concerns. If you are providing feedback on a specific topic or
help file, include the topic title and URL.
Do not use this email address to contact DB2 Customer Support. If you have a DB2
technical issue that the documentation does not resolve, contact your local IBM
service center for assistance.
DB2 technical library in hardcopy or PDF format

The following tables describe the DB2 library available from the IBM Publications
Center at www.ibm.com/e-business/linkweb/publications/servlet/pbi.wss.
English and translated DB2 Version 10.1 manuals in PDF format can be
downloaded from www.ibm.com/support/docview.wss?rs=71&uid=swg27009474.
Although the tables identify books available in print, the books might not be
available in your country or region.
1559
The form number increases each time a manual is updated. Ensure that you are
reading the most recent version of the manuals, as listed below.
Note: The DB2 Information Center is updated more frequently than either the PDF
or the hard-copy books.
Table 371. DB2 technical information
1560
Name
Form Number
Available in print
Availability date
Administrative API
Reference
SC27-5506-00
Yes
July 28, 2013
Administrative Routines
and Views
SC27-5507-00
No
July 28, 2013
Call Level Interface

Guide and Reference
Volume 1
SC27-5511-00
Yes
July 28, 2013
Call Level Interface

Guide and Reference
Volume 2
SC27-5512-00
Yes
July 28, 2013
Command Reference
SC27-5508-00
Yes
July 28, 2013
Database Administration SC27-4546-00

Concepts and
Configuration Reference
Yes
July 28, 2013
Data Movement Utilities SC27-5528-00

Guide and Reference
Yes
July 28, 2013
Database Monitoring
Guide and Reference
SC27-4547-00
Yes
July 28, 2013
Data Recovery and High

Availability Guide and
Reference
SC27-5529-00
Yes
July 28, 2013
Database Security Guide
SC27-5530-00
Yes
July 28, 2013
DB2 Workload
Management Guide and
Reference
SC27-5520-00
Yes
July 28, 2013
Developing ADO.NET
and OLE DB
Applications
SC27-4549-00
Yes
July 28, 2013
Developing Embedded
SQL Applications
SC27-4550-00
Yes
July 28, 2013
Developing Java
Applications
SC27-5503-00
Yes
July 28, 2013
Developing Perl, PHP,

Python, and Ruby on
Rails Applications
SC27-5504-00
No
July 28, 2013
Developing RDF
Applications for IBM
Data Servers
SC27-5505-00
Yes
July 28, 2013
Developing User-defined
Routines (SQL and
External)
SC27-5501-00
Yes
July 28, 2013
Getting Started with

Database Application
Development
GI13-2084-00
Yes
July 28, 2013
Table 371. DB2 technical information (continued)

Name
Form Number
Available in print
Availability date
Getting Started with

GI13-2085-00
DB2 Installation and
Administration on Linux
and Windows
Yes
July 28, 2013
Globalization Guide
SC27-5531-00
Yes
July 28, 2013
Installing DB2 Servers
GC27-5514-00
Yes
July 28, 2013
Installing IBM Data

Server Clients
GC27-5515-00
No
July 28, 2013
Message Reference
Volume 1
SC27-5523-00
No
July 28, 2013
Message Reference
Volume 2
SC27-5524-00
No
July 28, 2013
Net Search Extender

Administration and
User's Guide
SC27-5526-00
No
July 28, 2013
Partitioning and
Clustering Guide
SC27-5532-00
Yes
July 28, 2013
pureXML Guide
SC27-5521-00
Yes
July 28, 2013
Spatial Extender User's

Guide and Reference
SC27-5525-00
No
July 28, 2013
SQL Procedural
Languages: Application
Enablement and Support
SC27-5502-00
Yes
July 28, 2013
SQL Reference Volume 1 SC27-5509-00
Yes
July 28, 2013
SQL Reference Volume 2 SC27-5510-00
Yes
July 28, 2013
Text Search Guide
SC27-5527-00
Yes
July 28, 2013
Troubleshooting and
Tuning Database
Performance
SC27-4548-00
Yes
July 28, 2013
Upgrading to DB2
Version 10.5
SC27-5513-00
Yes
July 28, 2013
What's New for DB2

Version 10.5
SC27-5519-00
Yes
July 28, 2013
XQuery Reference
SC27-5522-00
No
July 28, 2013
Table 372. DB2 Connect-specific technical information

Name
Form Number
Available in print
Availability date
DB2 Connect Installing SC27-5516-00

and Configuring DB2
Connect Personal Edition
Yes
July 28, 2013
DB2 Connect Installing

and Configuring DB2
Connect Servers
SC27-5517-00
Yes
July 28, 2013
DB2 Connect User's

Guide
SC27-5518-00
Yes
July 28, 2013
1561
Displaying SQL state help from the command line processor

DB2 products return an SQLSTATE value for conditions that can be the result of an
SQL statement. SQLSTATE help explains the meanings of SQL states and SQL state
class codes.
Procedure
To start SQL state help, open the command line processor and enter:
? sqlstate or ? class code
where sqlstate represents a valid five-digit SQL state and class code represents the
first two digits of the SQL state.
For example, ? 08003 displays help for the 08003 SQL state, and ? 08 displays help
for the 08 class code.
Accessing different versions of the DB2 Information Center

Documentation for other versions of DB2 products is found in separate information
centers on ibm.com.
About this task

For DB2 Version 10.1 topics, the DB2 Information Center URL is
http://pic.dhe.ibm.com/infocenter/db2luw/v10r1.
For DB2 Version 9.8 topics, the DB2 Information Center URL is http://
pic.dhe.ibm.com/infocenter/db2luw/v9r8/.
pic.dhe.ibm.com/infocenter/db2luw/v9r7/.
publib.boulder.ibm.com/infocenter/db2luw/v9r5.
Terms and conditions

Permissions for the use of these publications are granted subject to the following
terms and conditions.
Applicability: These terms and conditions are in addition to any terms of use for
the IBM website.
Personal use: You may reproduce these publications for your personal,
noncommercial use provided that all proprietary notices are preserved. You may
not distribute, display or make derivative work of these publications, or any
portion thereof, without the express consent of IBM.
Commercial use: You may reproduce, distribute and display these publications
solely within your enterprise provided that all proprietary notices are preserved.
You may not make derivative works of these publications, or reproduce, distribute
or display these publications or any portion thereof outside your enterprise,
without the express consent of IBM.
1562
Rights: Except as expressly granted in this permission, no other permissions,

licenses or rights are granted, either express or implied, to the publications or any
information, data, software or other intellectual property contained therein.
IBM reserves the right to withdraw the permissions granted herein whenever, in its
discretion, the use of the publications is detrimental to its interest or, as
determined by IBM, the previous instructions are not being properly followed.
You may not download, export or re-export this information except in full
compliance with all applicable laws and regulations, including all United States
export laws and regulations.
IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESE
PUBLICATIONS. THE PUBLICATIONS ARE PROVIDED "AS-IS" AND WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING
BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY,
NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
IBM Trademarks: IBM, the IBM logo, and ibm.com are trademarks or registered
trademarks of International Business Machines Corp., registered in many
jurisdictions worldwide. Other product and service names might be trademarks of
IBM or other companies. A current list of IBM trademarks is available on the Web
at www.ibm.com/legal/copytrade.shtml
1563
1564
Appendix B. Notices
This information was developed for products and services offered in the U.S.A.
Information about non-IBM products is based on information available at the time
of first publication of this document and is subject to change.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information about the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte character set (DBCS) information,
contact the IBM Intellectual Property Department in your country or send
inquiries, in writing, to:
Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan, Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan
The following paragraph does not apply to the United Kingdom or any other
country/region where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions; therefore, this statement may not apply
to you.
This information could include technical inaccuracies or typographical errors.
Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements,
changes, or both in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to websites not owned by IBM are provided for
convenience only and do not in any manner serve as an endorsement of those
1565
websites. The materials at those websites are not part of the materials for this IBM
product and use of those websites is at your own risk.
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information that has been exchanged, should contact:
IBM Canada Limited
U59/3600
3600 Steeles Avenue East
Markham, Ontario L3R 9Z7
CANADA
Such information may be available, subject to appropriate terms and conditions,
including, in some cases, payment of a fee.
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement, or any equivalent agreement
between us.
Any performance data contained herein was determined in a controlled
environment. Therefore, the results obtained in other operating environments may
vary significantly. Some measurements may have been made on development-level
systems, and there is no guarantee that these measurements will be the same on
generally available systems. Furthermore, some measurements may have been
estimated through extrapolation. Actual results may vary. Users of this document
should verify the applicable data for their specific environment.
Information concerning non-IBM products was obtained from the suppliers of
those products, their published announcements, or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility, or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.
All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.
This information may contain examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious, and any similarity to the names and addresses used by an actual
business enterprise is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which
illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
1566
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs. The sample
programs are provided "AS IS", without warranty of any kind. IBM shall not be
liable for any damages arising out of your use of the sample programs.
Each copy or any portion of these sample programs or any derivative work must
include a copyright notice as follows:
(your company name) (year). Portions of this code are derived from IBM Corp.
Sample Programs. Copyright IBM Corp. _enter the year or years_. All rights
reserved.
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the web at Copyright and
trademark information at www.ibm.com/legal/copytrade.shtml.
The following terms are trademarks or registered trademarks of other companies
v Linux is a registered trademark of Linus Torvalds in the United States, other
countries, or both.
v Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle, its affiliates, or both.
v UNIX is a registered trademark of The Open Group in the United States and
other countries.
v Intel, Intel logo, Intel Inside, Intel Inside logo, Celeron, Intel SpeedStep, Itanium,
and Pentium are trademarks or registered trademarks of Intel Corporation or its
subsidiaries in the United States and other countries.
v Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
Other company, product, or service names may be trademarks or service marks of
others.
Appendix B. Notices
1567
1568
Index
A
ADD CONTACT command
using ADMIN_CMD procedure 24
ADD CONTACTGROUP command
ADMIN_CMD procedure
commands
ADD CONTACT 24
ADD CONTACTGROUP 25
AUTOCONFIGURE 26
BACKUP DATABASE 30
DESCRIBE 38
DROP CONTACT 52
DROP CONTACTGROUP 53
EXPORT 53
FORCE APPLICATION 64
GET STMM TUNING 66
IMPORT 67
INITIALIZE TAPE 93
LOAD 94
PRUNE HISTORY/LOGFILE 135
QUIESCE DATABASE 137
QUIESCE TABLESPACES FOR TABLE 139
REDISTRIBUTE DATABASE PARTITION GROUP 141
REORG INDEXES/TABLE 149
RESET ALERT CONFIGURATION 168
RESET DATABASE CONFIGURATION 169
RESET DATABASE MANAGER
CONFIGURATION 171
REWIND TAPE 172
RUNSTATS 173
SET TAPE POSITION 186
UNQUIESCE DATABASE 187
UPDATE ALERT CONFIGURATION 188
UPDATE CONTACT 194
UPDATE CONTACTGROUP 195
UPDATE DATABASE CONFIGURATION 196
UPDATE DATABASE MANAGER
CONFIGURATION 199
UPDATE HEALTH NOTIFICATION CONTACT
LIST 201
UPDATE HISTORY 202
UPDATE STMM TUNING 204
details 21
messages
removing 271
retrieving 223
ADMIN_COPY_SCHEMA procedure
details 205
ADMIN_DROP_SCHEMA procedure 209
ADMIN_EST_INLINE_LENGTH function 211
ADMIN_GET_DBP_MEM_USAGE table function 1095
ADMIN_GET_INDEX_COMPRESS_INFO table function 213
ADMIN_GET_INDEX_INFO table function 217
ADMIN_GET_INTRA_PARALLEL scalar function 221
ADMIN_GET_MEM_USAGE table function 222
ADMIN_GET_MSGS table function 223
ADMIN_GET_STORAGE_PATHS table function 224
ADMIN_GET_TAB_COMPRESS_INFO table function 226
(deprecated) 1097
ADMIN_GET_TAB_COMPRESS_INFO_V97 table
function 1102
ADMIN_GET_TAB_DICTIONARY_INFO table function 229
ADMIN_GET_TAB_INFO table function 232, 278
ADMIN_GET_TAB_INFO_V95 table function 1108
ADMIN_GET_TAB_INFO_V97 table function
details 1114
ADMIN_GET_TEMP_COLUMNS table function 240, 287
ADMIN_GET_TEMP_TABLES table function 244, 290
ADMIN_IS_INLINED function 247
ADMIN_LIST_DB_PATHS table function 1057
ADMIN_MOVE_TABLE procedure 249
ADMIN_MOVE_TABLE_UTIL procedure 269
ADMIN_REMOVE_MSGS procedure 271
ADMIN_REVALIDATE_DB_OBJECTS procedure 272
ADMIN_SET_INTRA_PARALLEL procedure 276
ADMIN_SET_MAINT_MODE procedure 277
ADMIN_TASK_ADD procedure 294
ADMIN_TASK_LIST administrative view 299
ADMIN_TASK_REMOVE procedure 301
ADMIN_TASK_STATUS administrative view 302
ADMIN_TASK_UPDATE procedure 304
administrative task scheduler
defining task schedules 298
ADMINTABCOMPRESSINFO administrative view
(deprecated) 1097
ADMINTABINFO administrative view 232, 278
ADMINTEMPCOLUMNS administrative view 240, 287
ADMINTEMPTABLES administrative view 244, 290
ALTER_ROUTINE_PACKAGE procedure 959
ALTOBJ procedure 1044
AM_BASE_RPT_RECOMS table function 1121
AM_BASE_RPTS table function 1122
AM_DROP_TASK procedure 1124
AM_GET_LOCK_CHN_TB procedure 1124
AM_GET_LOCK_CHNS procedure 1125
AM_GET_LOCK_RPT procedure 1126
AM_GET_RPT procedure 1134
AM_SAVE_TASK procedure 1135
ANALYZE_LOG_SPACE procedure 969
APPL_PERFORMANCE administrative view 1136
APPLICATION_ID scalar function 1142
APPLICATIONS administrative view 1138
AUDIT_ARCHIVE stored procedure and table function 307
AUDIT_DELIM_EXTRACT stored procedure 308
AUDIT_LIST_LOGS table function 309
AUTH_GET_INSTANCE_AUTHID scalar function 879
AUTH_LIST_AUTHORITIES_FOR_AUTHID table
function 880
AUTH_LIST_GROUPS_FOR_AUTHID table function 884
AUTH_LIST_ROLES_FOR_AUTHID function 886
authorization IDs
built-in routines 2
built-in views 2
group membership list 884
instance owner 879
retrieving 888
AUTHORIZATIONIDS administrative view 888
AUTOCONFIGURE command
AUTOMAINT_GET_POLICY stored procedure 310
1569
AUTOMAINT_GET_POLICYFILE stored procedure 311

AUTOMAINT_SET_POLICY stored procedure 312
AUTOMAINT_SET_POLICYFILE stored procedure 314
B
BACKUP DATABASE command
BP_HITRATIO administrative view 1143
BP_READ_IO administrative view 1145
BP_WRITE_IO administrative view 1147
built-in routines
authorizations 2
coding practices 1
summary 3
built-in views
ADMIN_TASK_LIST 299
ADMIN_TASK_STATUS 302
ADMINTABCOMPRESSINFO (deprecated)
ADMINTABINFO 232, 278
ADMINTEMPCOLUMNS 240, 287
ADMINTEMPTABLES 244, 290
APPL_PERFORMANCE
details 1136
APPLICATIONS 1138
AUTHORIZATIONIDS
details 888
authorizations 2
BP_HITRATIO
details 1143
BP_READ_IO
details 1145
BP_WRITE_IO
details 1147
coding practices 1
CONTACTGROUPS 1049
CONTACTS 1050
CONTAINER_UTILIZATION 1149
DB_HISTORY
details 1052
DB2_CF
details 377
DB2_CLUSTER_HOST_STATE
details 374
DB2_INSTANCE_ALERTS
details 376
DB2_MEMBER
details 377
DBCFG 366
DBMCFG 369
DBPATHS 1057
ENV_CF_SYS_RESOURCES 383
ENV_FEATURE_INFO 384
ENV_INST_INFO 399
ENV_PROD_INFO 400
ENV_SYS_INFO 402
ENV_SYS_RESOURCES 1153
LOCKS_HELD 1207
LOCKWAIT 1210
LOG_UTILIZATION 1213
LONG_RUNNING_SQL
details 1215
MON_BP_UTILIZATION 820
MON_CONNECTION_SUMMARY 829
MON_CURRENT_SQL 834
MON_CURRENT_UOW 835
MON_DB_SUMMARY 837
1570
1097
built-in views (continued)

MON_LOCKWAITS 840
MON_PKG_CACHE_SUMMARY 842
MON_SERVICE_SUBCLASS_SUMMARY 844
MON_TBSP_UTILIZATION 848
MON_TRANSACTION_LOG_UTILIZATION 854
MON_WORKLOAD_SUMMARY 854
NOTIFICATIONLIST 1063
OBJECTOWNERS
details 889
overview 1
PDLOGMSGS_LAST24HOURS 1072
PRIVILEGES
details 890
QUERY_PREP_COST
details 892
REG_VARIABLES 1218
SNAPAGENT 1221, 1391
SNAPAGENT_MEMORY_POOL 1225, 1395
SNAPAPPL 1243, 1407
SNAPAPPL_INFO 1229, 1399
SNAPBP 1258, 1416
SNAPBP_PART 1264, 1421
SNAPCONTAINER 1271, 1425
SNAPDB 1279, 1429, 1479
SNAPDB_MEMORY_POOL 1291, 1441
SNAPDBM 1305, 1446
SNAPDBM_MEMORY_POOL 1310, 1450
SNAPDETAILLOG 1316, 1454
SNAPDYN_SQL 893, 926
SNAPFCM 1326, 1457
SNAPFCM_PART 1329, 1460
SNAPHADR 1332, 1464
SNAPLOCK 1337, 1468
SNAPLOCKWAIT 1342, 1473
SNAPSTMT 1348, 1496
SNAPSTORAGE_PATHS 1356, 1502
SNAPSUBSECTION 899, 932
SNAPSWITCHES 903, 936
SNAPTAB 1359, 1506
SNAPTAB_REORG 907, 940
SNAPTBSP 1365, 1510
SNAPTBSP_PART 1371, 1515
SNAPTBSP_QUIESCER 913, 945
SNAPTBSP_RANGE 918, 950
SNAPUTIL 1385, 1491, 1521
SNAPUTIL_PROGRESS 922, 954
summary 3
table functions comparison 3
TBSP_UTILIZATION 1526
TOP_DYNAMIC_SQL
details 958
C
CANCEL_WORK stored procedure 321
CAPTURE_STORAGEMGMT_INFO procedure
commands
ADD CONTACT 24
ADD CONTACTGROUP 25
AUTOCONFIGURE 26
BACKUP DATABASE 30
calling from procedure 21, 982
DESCRIBE
details 38
DROP CONTACT 52
DROP CONTACTGROUP 53
979
commands (continued)
EXPORT 53
FORCE APPLICATION 64
GET STMM TUNING 66
IMPORT 67
INITIALIZE TAPE 93
LOAD 94
PRUNE HISTORY/LOGFILE 135
PRUNE LOGFILE
details 135
QUIESCE DATABASE 137
QUIESCE TABLESPACES FOR TABLE 139
REDISTRIBUTE DATABASE PARTITION GROUP 141
REORG INDEXES/TABLE 149
RESET ALERT CONFIGURATION 168
RESET DATABASE CONFIGURATION 169
RESET DATABASE MANAGER CONFIGURATION 171
REWIND TAPE 172
RUNSTATS 173
SET TAPE POSITION 186
UNQUIESCE DATABASE 187
UPDATE ALERT CONFIGURATION 188
UPDATE CONTACT 194
UPDATE CONTACTGROUP 195
UPDATE DATABASE CONFIGURATION 196
UPDATE DATABASE MANAGER CONFIGURATION 199
UPDATE HEALTH NOTIFICATION CONTACT LIST 201
UPDATE HISTORY 202
UPDATE STMM TUNING 204
common SQL API stored procedures
complete mode 318
filtering output 319
overview 315
signature 316
stored procedures 317
XML input documents 318
XML message documents 320
XML output files 318
COMPILATION_ENV table function 1046
complete mode 318
configuration parameters
database
retrieving values 366
getting values 335
setting with SET_CONFIG procedure 356
CONTACTGROUPS administrative view 1049
contacts
retrieving contact group lists 1049
retrieving contact lists 1050
CONTACTS administrative view 1050
CONTAINER_UTILIZATION administrative view 1149
CREATE_STORAGEMGMT_TABLES procedure 981
D
database manager configuration parameters
retrieving values 369
database paths
retrieving 1057
DB_GET_CFG table function 366
DB_HISTORY administrative view
details 1052
DB_MEMBERS table function 373
DB_PARTITIONS table function 1151
DB2 Information Center
versions 1562
DB2 pureScale instances

hosts
information 373
DB2_CF administrative view
details 377
DB2_CLUSTER_HOST_STATE administrative view
details 374
DB2_GET_CLUSTER_HOST_STATE table function
details 374
details 377
DB2_INSTANCE_ALERTS administrative view
details 376
DB2_MEMBER administrative view
details 377
DBCFG administrative view 366
DBMCFG administrative view 369
DBPATHS administrative view 1057
deprecated functionality
administrative views
SNAPTAB 1359, 1506
procedures
GET_DB_CONFIG 1159
HEALTH_CONT_HI 1162
HEALTH_CONT_HI_HIS 1164
HEALTH_CONT_INFO 1166
HEALTH_DB_HI 1168
HEALTH_DB_HI_HIS 1171
HEALTH_DB_HIC 1175
HEALTH_DB_HIC_HIS 1177
HEALTH_DB_INFO 1180
HEALTH_DBM_HI 1182
HEALTH_DBM_HI_HIS 1184
HEALTH_DBM_INFO 1186
HEALTH_GET_ALERT_ACTION_CFG 1188
HEALTH_GET_ALERT_CFG 1191
HEALTH_GET_IND_DEFINITION 1194
HEALTH_HI_REC 1196
HEALTH_TBS_HI 1198
HEALTH_TBS_HI_HIS 1201
HEALTH_TBS_INFO 1205
SYSINSTALLROUTINES 1525
_ACTIVITIES_V97 1551
WLM_GET_WORKLOAD_STATS_V97 1555
SQL administrative routines 1089
table functions
ADMIN_GET_TAB_COMPRESS_INFO 1097
ADMIN_GET_TAB_COMPRESS_INFO_V97 1102
GET_DBM_CONFIG 1161
SNAP_GET_APPL_V95 1251
SNAP_GET_BP_V95 1268
SNAP_GET_CONTAINER_V91 1276
SNAP_GET_DB_MEMORY_POOL 1291, 1441
SNAP_GET_DB_V97 1295
SNAP_GET_DBM_V95 1313
SNAP_GET_DETAILLOG_V91 1320
SNAP_GET_DYN_SQL_V95 1322
SNAP_GET_STO_PATHS 1355
SNAP_GET_STORAGE_PATHS_V97 1356, 1502
SNAP_GET_TAB 1359, 1506
SNAP_GET_TAB_V91 1363
SNAP_GET_TBSP_PART_V97 1377
SNAP_GET_TBSP_V91 1381
WLM_GET_SERVICE_CLASS_AGENTS_V97 1534
Index
1571
deprecated functionality (continued)

table functions (continued)
_OCCURRENCES_V97 1542
WLM_GET_SERVICE_SUBCLASS_STATS_V97
DESCRIBE command
details 38
Design Advisor
DESIGN_ADVISOR stored procedure 327
DESIGN_ADVISOR procedure 327
documentation
overview 1559
PDF files 1559
printed 1559
terms and conditions of use 1562
DROP CONTACT command
details
using ADMIN_CMD 52
DROP CONTACTGROUP command
details
using ADMIN_CMD 53
DROP_STORAGEMGMT_TABLES procedure 982
1545
E
ENV_CF_SYS_RESOURCES administrative view
details 383
ENV_FEATURE_INFO administrative view 384
ENV_GET_DB2_EDU_SYSTEM_RESOURCES table
function 385
ENV_GET_DB2_SYSTEM_RESOURCES 388
ENV_GET_NETWORK_RESOURCES 389
ENV_GET_REG_VARIABLES 390
ENV_GET_ROLLING_UPDATE_STATUS table function
ENV_GET_SYS_RESOURCES table function 1156
ENV_GET_SYSTEM_RESOURCES table function 396
ENV_INST_INFO administrative view 399
ENV_PROD_INFO administrative view 400
ENV_SYS_INFO administrative view 402
ENV_SYS_RESOURCES administrative view 1153
error messages
retrieving
SQLERRM scalar functions 1085
EVMON_FORMAT_UE_TO_TABLES procedure
details 425
details 434
EVMON_UPGRADE_TABLES procedure 437
EXPLAIN_FORMAT_STATS scalar function 406
EXPLAIN_FROM_ACTIVITY procedure 411
EXPLAIN_FROM_CATALOG procedure 414
EXPLAIN_FROM_DATA procedure 416
EXPLAIN_FROM_SECTION procedure
details 419
EXPLAIN_GET_MSGS table function 403
EXPORT command
details
using ADMIN_CMD 53
extents
movement status 598
F
FORCE APPLICATION command
using ADMIN_CMD 64
1572
393
functions
scalar
ADMIN_GET_INTRA_PARALLEL 221
APPLICATION_ID 1142
AUTH_GET_INSTANCE_AUTHID 879
EXPLAIN_FORMAT_STATS 406
GET_ROUTINE_OPTS 963
MON_GET_APPLICATION_HANDLE 516
MON_GET_APPLICATION_ID 517
MQPUBLISH 858
MQREAD 860
MQREADCLOB 866
MQRECEIVE 867
MQRECEIVECLOB 873
MQSEND 875
MQSUBSCRIBE 876
MQUNSUBSCRIBE 878
SQLERRM 1085
stored procedures
SYSTS_ALTER 984
SYSTS_CLEANUP 990
SYSTS_CLEAR_COMMANDLOCKS 991
SYSTS_CLEAR_EVENTS 993
SYSTS_DROP 1009
SYSTS_ENABLE 1012
SYSTS_UPDATE 1014
SYSTS_UPGRADE_CATALOG 1019
SYSTS_UPGRADE_INDEX 1020
summary 3
table
ADMIN_GET_MSGS 223
ADMIN_GET_STORAGE_PATHS 224
(deprecated) 1097
ADMIN_GET_TAB_INFO 232, 278
ADMIN_GET_TAB_INFO_V95 1108
ADMIN_GET_TEMP_COLUMNS 240, 287
ADMIN_GET_TEMP_TABLES 244, 290
ADMIN_IS_INLINED 247
ADMIN_IS_INLINED_LENGTH 211
ADMIN_LIST_DB_PATHS 1057
AM_BASE_RPT_RECOMS 1121
AM_BASE_RPTS 1122
AUDIT_ARCHIVE 307
AUDIT_LIST_LOGS 309
AUTH_LIST_AUTHORITIES_FOR_AUTHID 880
AUTH_LIST_GROUPS_FOR_AUTHID 884
AUTH_LIST_ROLES_FOR_AUTHID 886
built-in views comparison 3
COMPILATION_ENV 1046
DB_GET_CFG 366
DB_MEMBERS 373
DB_PARTITIONS 1151
deprecated 1089
ENV_GET_DB2_EDU_SYSTEM_RESOURCES 385
ENV_GET_ROLLING_UPDATE_STATUS 393
ENV_GET_SYSTEM_RESOURCES 396
EVMON_FORMAT_UE_TO_XML 434
EXPLAIN_GET_MSGS 403
GET_DB_CONFIG 1159
GET_DBM_CONFIG 1161
HEALTH_CONT_HI 1162
functions (continued)
table (continued)
HEALTH_CONT_HI_HIS 1164
HEALTH_CONT_INFO 1166
HEALTH_DB_HI 1168
HEALTH_DB_HI_HIS 1171
HEALTH_DB_HIC 1175
HEALTH_DB_HIC_HIS 1177
HEALTH_DB_INFO 1180
HEALTH_DBM_HI 1182
HEALTH_DBM_HI_HIS 1184
HEALTH_DBM_INFO 1186
HEALTH_TBS_HI 1198
HEALTH_TBS_HI_HIS 1201
HEALTH_TBS_INFO 1205
MON_GET_ACTIVITY 475
MON_GET_ACTIVITY_DETAILS 491
MON_GET_AGENT 505
MON_GET_AUTO_MAINT_QUEUE 517
MON_GET_AUTO_RUNSTATS_QUEUE 520
MON_GET_BUFFERPOOL 522
MON_GET_CF 532
MON_GET_CF_CMD 534
MON_GET_CF_WAIT_TIME 537
MON_GET_CONNECTION 540
MON_GET_CONNECTION_DETAILS 554
MON_GET_CONTAINER 567
MON_GET_DATABASE 570
MON_GET_DATABASE_DETAILS 585
MON_GET_EXTENDED_LATCH_WAIT 597
MON_GET_EXTENT_MOVEMENT_STATUS 598
MON_GET_FCM 599
MON_GET_FCM_CONNECTION_LIST 601
MON_GET_GROUP_BUFFERPOOL 602
MON_GET_HADR 603
MON_GET_INDEX 612
MON_GET_INDEX_USAGE_LIST 615
MON_GET_INSTANCE 618
MON_GET_PAGE_ACCESS 630
MON_GET_PKG_CACHE_STMT 632
MON_GET_QUEUE_STATS 655
MON_GET_ROUTINE 660
MON_GET_ROUTINE_DETAILS 674
MON_GET_ROUTINE_EXEC_LIST 688
MON_GET_RTS_RQST 691
MON_GET_SECTION_ROUTINE 693
MON_GET_SERVERLIST 695
MON_GET_SERVICE_SUBCLASS 697
MON_GET_SERVICE_SUBCLASS_DETAILS 712
MON_GET_SERVICE_SUBCLASS_STATS 724
MON_GET_SERVICE_SUPERCLASS_STATS 729
MON_GET_TABLE 731
MON_GET_TABLE_USAGE_LIST 748
MON_GET_TABLESPACE 736
MON_GET_TRANSACTION_LOG 751
MON_GET_UNIT_OF_WORK 754
MON_GET_UNIT_OF_WORK_DETAILS 768
MON_GET_USAGE_LIST_STATUS 781
MON_GET_UTILITY 783
MON_GET_WORK_ACTION_SET_STATS 811
MON_GET_WORKLOAD 785
MON_GET_WORKLOAD_DETAILS 798
MON_GET_WORKLOAD_STATS 809
MON_SAMPLE_SERVICE_CLASS_METRICS 814
table (continued)
MON_SAMPLE_WORKLOAD_METRICS 818
MQREADALL 862
MQREADALLCLOB 864
MQRECEIVEALL 869
MQRECEIVEALLCLOB 871
overview 1
PD_GET_DIAG_HIST 1064
PD_GET_LOG_MSGS 1072
REG_LIST_VARIABLES table function 1219
SNAP_GET_AGENT 1221, 1391
SNAP_GET_AGENT_MEMORY_POOL 1225, 1395
SNAP_GET_APPL 1243, 1407
SNAP_GET_APPL_INFO 1229, 1399
SNAP_GET_APPL_INFO_V95 1237
SNAP_GET_APPL_V95 1251
SNAP_GET_BP 1258, 1416
SNAP_GET_BP_PART 1264, 1421
SNAP_GET_CONTAINER 1271, 1425
SNAP_GET_CONTAINER_V91 (deprecated) 1276
SNAP_GET_DBM 1305, 1446
SNAP_GET_DBM_MEMORY_POOL 1310, 1450
SNAP_GET_DETAIL_LOG 1316, 1454
SNAP_GET_DETAIL_LOG_V91 1320
SNAP_GET_DYN_SQL 893, 926
SNAP_GET_FCM 1326, 1457
SNAP_GET_FCM_PART 1329, 1460
SNAP_GET_HADR 1332, 1464
SNAP_GET_LOCK 1337, 1468
SNAP_GET_LOCKWAIT 1342, 1473
SNAP_GET_STMT 1348, 1496
SNAP_GET_STO_PATHS (deprecated) 1355
SNAP_GET_SUBSECTION 899, 932
SNAP_GET_SWITCHES 903, 936
SNAP_GET_TAB_REORG 907, 940
SNAP_GET_TAB_V91 (deprecated) 1363
SNAP_GET_TBSP 1365, 1510
SNAP_GET_TBSP_PART (deprecated) 1371, 1515
SNAP_GET_TBSP_QUIESCER 913, 945
SNAP_GET_TBSP_RANGE 918, 950
SNAP_GET_TBSP_V91 (deprecated) 1381
SNAP_GET_UTIL 1385, 1491, 1521
SNAP_GET_UTIL_PROGRESS 922, 954
summary 3
WLM_GET_ACTIVITY_DETAILS 1528
WLM_GET_CONN_ENV 1030
WLM_GET_QUEUE_STATS 1032
WLM_GET_SERVICE_CLASS_AGENTS 1033
WLM_GET_SERVICE_CLASS_AGENTS_V97 1534
_OCCURRENCES 1033
_OCCURRENCES_V97 1542
WLM_GET_SERVICE_SUBCLASS_STATS 1036
WLM_GET_SERVICE_SUBCLASS_STATS_V97 1545
WLM_GET_SERVICE_SUPERCLASS_STATS 1037
WLM_GET_WORK_ACTION_SET_STATS 1037
Index
1573
table (continued)
_ACTIVITIES 1038
_ACTIVITIES_V97 1551
WLM_GET_WORKLOAD_STATS 1038
WLM_GET_WORKLOAD_STATS_V97 1555
table functions
ENV_GET_SYS_RESOURCES table function 1156
MON_FORMAT_XML_COMPONENT_TIMES
_BY_ROW 447
MON_FORMAT_XML_METRICS_BY_ROW 451
MON_FORMAT_XML_TIMES_BY_ROW 465
MON_FORMAT_XML_WAIT_TIMES_BY_ROW 471
MON_GET_PKG_CACHE_STMT_DETAILS 644
MON_GET_REBALANCE_STATUS 658
SNAP_GET_DB 1279, 1429, 1479
health alerts
alert action configuration 1188
alert configuration 1191
health indicators
retrieving definitions 1194
HEALTH_CONT_HI table function 1162
HEALTH_CONT_HI_HIS table function 1164
HEALTH_CONT_INFO table function 1166
HEALTH_DB_HI table function 1168
HEALTH_DB_HI_HIS table function 1171
HEALTH_DB_HIC table function 1175
HEALTH_DB_HIC_HIS table function 1177
HEALTH_DB_INFO table function 1180
HEALTH_DBM_HI table function 1182
HEALTH_DBM_HI_HIS table function 1184
HEALTH_DBM_INFO table function 1186
HEALTH_GET_ALERT_ACTION_CFG table function 1188
HEALTH_GET_ALERT_CFG table function 1191
HEALTH_GET_IND_DEFINITION table function 1194
HEALTH_HI_REC procedure 1196
HEALTH_TBS_HI table function 1198
HEALTH_TBS_HI_HIS table function 1201
HEALTH_TBS_INFO table function 1205
help
SQL statements 1562
history file
retrieving information 1052
961
1574
IMPORT command
details
INITIALIZE TAPE command
installation
license information 384, 1153
retrieving DB2 product information 400
instance owner authorization ID
obtaining 879
instances
current
retrieving information 399
latch waits
MON_GET_EXTENDED_LATCH_WAIT table
function 597
LOAD command
details
LOCKS_HELD administrative view 1207
LOCKWAIT administrative view 1210
LOG_UTILIZATION administrative view 1213
LONG_RUNNING_SQL administrative view 1215
G
GENERATE_DISTFILE procedure 972
GET STMM TUNING command 66
GET_CONFIG stored procedure 335
GET_DB_CONFIG table function 1159
GET_DBM_CONFIG table function 1161
GET_DBSIZE_INFO procedure 1061
GET_MESSAGE stored procedure 342
GET_ROUTINE_NAME procedure stored procedure
GET_ROUTINE_OPTS scalar function 963
GET_ROUTINE_SAR procedure 963
GET_SWRD_SETTINGS procedure 972
GET_SYSTEM_INFO stored procedure 349
groups
retrieving group membership 884
M
MON_BP_UTILIZATION administrative view 820
MON_CAPTURE_ACTIVITY_IN_PROGRESS stored
procedure 441
MON_COLLECT_STATS stored procedure 443
MON_CONNECTION_SUMMARY administrative view 829
MON_CURRENT_SQL administrative view 834
MON_CURRENT_UOW administrative view 835
MON_DB_SUMMARY administrative view 837
MON_FORMAT_LOCK_NAME table function 445
MON_FORMAT_XML_COMPONENT_TIMES_BY_ROW table
function
details 447
MON_FORMAT_XML_METRICS_BY_ROW table function
details 451
MON_FORMAT_XML_TIMES_BY_ROW table function
details 465
MON_FORMAT_XML_WAIT_TIMES_BY_ROW table function
details 471
MON_GET_ACTIVITY table function 475
MON_GET_ACTIVITY_DETAILS table function 491
MON_GET_AGENT table function 505
MON_GET_APPL_LOCKWAIT table function 512
MON_GET_APPLICATION_HANDLE scalar function 516
MON_GET_APPLICATION_ID scalar function 517
MON_GET_AUTO_MAINT_QUEUE table function 517
MON_GET_AUTO_RUNSTATS_QUEUE table function 520
MON_GET_BUFFERPOOL table function 522
MON_GET_CF table function
details 532
MON_GET_CF_CMD table function 534
MON_GET_CF_WAIT_TIME table function 537
MON_GET_CONNECTION table function 540
MON_GET_CONNECTION_DETAILS table function 554
MON_GET_CONTAINER table function 567
MON_GET_DATABASE table function 570
MON_GET_DATABASE_DETAILS table function 585
MON_GET_EXTENDED_LATCH_WAIT table function 597

MON_GET_EXTENT_MOVEMENT_STATUS table
function 598
MON_GET_FCM table function 599
MON_GET_FCM_CONNECTION_LIST table function 601
MON_GET_GROUP_BUFFERPOOL table function
details 602
MON_GET_HADR table function
details 603
MON_GET_INDEX table function 612
MON_GET_INDEX_USAGE_LIST table function 615
MON_GET_INSTANCE table function 618
MON_GET_LOCKS table function 620
MON_GET_MEMORY_POOL table function 625
MON_GET_MEMORY_SET table function 627
MON_GET_PAGE_ACCESS
details 630
MON_GET_PKG_CACHE_STMT table function
details 632
MON_GET_PKG_CACHE_STMT_DETAILS table function
details 644
MON_GET_QUEUE_STATS table function 655
MON_GET_REBALANCE_STATUS table function
details 658
MON_GET_ROUTINE table function 660
MON_GET_ROUTINE_DETAILS table function 674
MON_GET_ROUTINE_EXEC_LIST table function 688
MON_GET_RTS_RQST table function 691
MON_GET_SECTION_ROUTINE table function 693
MON_GET_SERVERLIST table function 695
MON_GET_SERVICE_SUBCLASS table function 697
MON_GET_SERVICE_SUBCLASS_DETAILS table
function 712
MON_GET_SERVICE_SUBCLASS_STATS table function 724
MON_GET_SERVICE_SUPERCLASS_STATS table
function 729
MON_GET_TABLE table function 731
MON_GET_TABLE_USAGE_LIST table function 748
MON_GET_TABLESPACE table function 736
MON_GET_TRANSACTION_LOG table function 751
MON_GET_UNIT_OF_WORK table function 754
MON_GET_UNIT_OF_WORK_DETAILS table function 768
MON_GET_USAGE_LIST_STATUS table function 781
MON_GET_UTILITY table function 783
MON_GET_WORK_ACTION_SET_STATS table function 811
MON_GET_WORKLOAD table function 785
MON_GET_WORKLOAD_DETAILS table function 798
MON_GET_WORKLOAD_STATS table function 809
MON_INCREMENT_INTERVAL_ID stored procedure 813
MON_LOCKWAITS administrative view 840
MON_PKG_CACHE_SUMMARY administrative view 842
MON_SAMPLE_SERVICE_CLASS_METRICS table
function 814
MON_SAMPLE_WORKLOAD_METRICS table function 818
MON_SERVICE_SUBCLASS_SUMMARY administrative
view 844
MON_TBSP_UTILIZATION administrative view 848
MON_TRANSACTION_LOG_UTILIZATION administrative
view 854
MON_WORKLOAD_SUMMARY administrative view 854
monitoring
routines 422
MQPUBLISH scalar function 858
MQREAD scalar function 860
MQREADALL table function 862
MQREADALLCLOB table function 864
MQREADCLOB scalar function 866
MQRECEIVE scalar function 867

MQRECEIVEALL table function 869
MQRECEIVEALLCLOB table function 871
MQRECEIVECLOB scalar function 873
MQSEND scalar function 875
MQSUBSCRIBE scalar function 876
MQUNSUBSCRIBE scalar function 878
N
notices 1565
notification lists
retrieving contact list 1063
notification log messages
retrieving 1072
NOTIFICATIONLIST administrative view
1063
O
OBJECTOWNERS administrative view 889
objects
retrieving ownership 889
online table moves
ADMIN_MOVE_TABLE_UTIL procedure
269
P
packages
rebinding
REBIND_ROUTINE_PACKAGE procedure 966
PD_GET_DIAG_HIST table function 1064
PD_GET_LOG_MSGS table function 1072
PDLOGMSGS_LAST24HOURS administrative view 1072
privileges
information about granted
PRIVILEGES administrative view 890
PRIVILEGES administrative view 890
problem determination
notification log messages 1072
procedures
ADMIN_CMD
details 21
ADMIN_COPY_SCHEMA 205
ADMIN_DROP_SCHEMA 209
ADMIN_MOVE_TABLE 249
ADMIN_MOVE_TABLE_UTIL 269
ADMIN_REMOVE_MSGS 271
ADMIN_REVALIDATE_DB_OBJECTS 272
ADMIN_SET_INTRA_PARALLEL 276
ADMIN_SET_MAINT_MODE 277
ADMIN_TASK_ADD 294
ADMIN_TASK_REMOVE 301
ADMIN_TASK_UPDATE 304
ALTER_ROUTINE_PACKAGE 959
ALTOBJ 1044
AM_DROP_TASK 1124
AM_GET_LOCK_CHN_TB 1124
AM_GET_LOCK_CHNS 1125
AM_GET_LOCK_RPT 1126
AM_GET_RPT 1134
AM_SAVE_TASK 1135
ANALYZE_LOG_SPACE 969
AUDIT_ARCHIVE 307
AUDIT_DELIM_EXTRACT 308
AUTOMAINT_GET_POLICY 310
Index
1575
procedures (continued)
AUTOMAINT_GET_POLICYFILE 311
AUTOMAINT_SET_POLICY 312
AUTOMAINT_SET_POLICYFILE 314
CANCEL_WORK 321
CAPTURE_STORAGEMGMT_INFO 979
common SQL API
overview 315
XPath expressions for filtering output 319
CREATE_STORAGEMGMT_TABLES 981
deprecated 1089
DESIGN_ADVISOR 327
DROP_STORAGEMGMT_TABLES 982
EVMON_FORMAT_UE_TO_TABLES 425
EVMON_UPGRADE_TABLES 437
EXPLAIN_FROM_ACTIVITY 411
EXPLAIN_FROM_CATALOG 414
EXPLAIN_FROM_DATA 416
EXPLAIN_FROM_SECTION 419
GENERATE_DISTFILE 972
GET_CONFIG 335
GET_DBSIZE_INFO 1061
GET_MESSAGE 342
GET_ROUTINE_NAME procedure 961
GET_ROUTINE_SAR 963
GET_SWRD_SETTINGS 972
GET_SYSTEM_INFO 349
HEALTH_HI_REC 1196
MON_CAPTURE_ACTIVITY_IN_PROGRESS 441
MON_COLLECT_STATS 443
MON_INCREMENT_INTERVAL_ID 813
PUT_ROUTINE_SAR 964
REBIND_ROUTINE_PACKAGE 966
REORGCHK_IX_STATS 1080
REORGCHK_TB_STATS 1082
SET_CONFIG 356
SET_ROUTINE_OPTS 968
SET_SWRD_SETTINGS 975
SNAP_WRITE_FILE 1390
SQL
summary 3
STEPWISE_REDISTRIBUTE_DBPG 977
SYSINSTALLOBJECTS 1088
SYSINSTALLROUTINES 1525
SYSTS_ADMIN_CMD 982
SYSTS_CONFIGURE 995
SYSTS_CREATE 998
WLM_ALTER_MEMBER_SUBSET 1024
WLM_CANCEL_ACTIVITY 1022
WLM_CAPTURE_ACTIVITY_IN_PROGRESS 1023
WLM_COLLECT_STATS 1024
WLM_CREATE_MEMBER_SUBSET 1027
WLM_DROP_MEMBER_SUBSET 1029
WLM_SET_CLIENT_INFO 1039
WLM_SET_CONN_ENV 1041
PRUNE HISTORY/LOGFILE command
PUT_ROUTINE_SAR procedure 964
Q
QUERY_PREP_COST administrative view 892
QUIESCE DATABASE command 137
QUIESCE TABLESPACES FOR TABLE command
1576
R
REBIND_ROUTINE_PACKAGE procedure 966
REDISTRIBUTE DATABASE PARTITION GROUP command
redistribution of data
procedures 969, 972, 975, 977
REG_VARIABLES administrative view 1218
registry variables
retrieving settings 390, 1218
REORG INDEXES command
REORG TABLE command
REORGCHK_IX_STATS procedure 1080
REORGCHK_TB_STATS procedure 1082
RESET ALERT CONFIGURATION command
RESET DATABASE CONFIGURATION command
RESET DATABASE MANAGER CONFIGURATION command
revalidation
procedures 272
REWIND TAPE command
routines
authorization 2
monitor 422
SQL
administrative (deprecated) 1089
built-in (summary) 3
RUNSTATS command
details
1084
S
scalar functions
AUTH_GET_INSTANCE_AUTHID 879
SQLERRM 1085
schemas
copying 205
dropping 209
objects 205
SET TAPE POSITION command
SET_CONFIG stored procedure 356
procedure 1084
SET_ROUTINE_OPTS procedure 968
SET_SWRD_SETTINGS procedure 975
SNAP_GET_AGENT table function 1221, 1391
SNAP_GET_AGENT_MEMORY_POOL table function 1225,
1395
SNAP_GET_APPL table function 1243, 1407
SNAP_GET_APPL_INFO table function 1229, 1399
SNAP_GET_APPL_INFO_V95 table function 1237
SNAP_GET_BP table function 1258, 1416
SNAP_GET_BP_PART table function 1264, 1421
SNAP_GET_CONTAINER table function 1271, 1425
SNAP_GET_CONTAINER_V91 deprecated table
function 1276
SNAP_GET_DB table function 1279, 1429, 1479
SNAP_GET_DB_MEMORY_POOL table function 1291, 1441
SNAP_GET_DB_V97 table function 1295
SNAP_GET_DBM table function 1305, 1446

SNAP_GET_DBM_MEMORY_POOL table function 1310, 1450
SNAP_GET_DETAILLOG table function 1316, 1454
SNAP_GET_DETAILLOG_V91 table function 1320
SNAP_GET_DYN_SQL table function 893, 926
SNAP_GET_DYN_SQL_V95 table function 1322
SNAP_GET_FCM table function 1326, 1457
SNAP_GET_FCM_PART table function 1329, 1460
SNAP_GET_HADR table function 1332, 1464
SNAP_GET_LOCK table function 1337, 1468
SNAP_GET_LOCKWAIT table function 1342, 1473
SNAP_GET_STMT table function 1348, 1496
SNAP_GET_STO_PATHS deprecated table function 1355
SNAP_GET_STORAGE_PATHS_V97 table function 1356, 1502
SNAP_GET_SUBSECTION table function 899, 932
SNAP_GET_SWITCHES table function 903, 936
SNAP_GET_TAB table function 1359, 1506
SNAP_GET_TAB_REORG table function 907, 940
SNAP_GET_TAB_V91 deprecated table function 1363
SNAP_GET_TBSP table function 1365, 1510
SNAP_GET_TBSP_PART table function 1371, 1515
SNAP_GET_TBSP_PART_V97 table function 1377
SNAP_GET_TBSP_QUIESCER table function 913, 945
SNAP_GET_TBSP_RANGE table function 918, 950
SNAP_GET_TBSP_V91 deprecated table function 1381
SNAP_GET_UTIL table function 1385, 1491, 1521
SNAP_GET_UTIL_PROGRESS table function 922, 954
SNAP_WRITE_FILE procedure 1390
SNAPAGENT administrative view 1221, 1391
SNAPAGENT_MEMORY_POOL administrative view 1225,
1395
SNAPAPPL administrative view 1243, 1407
SNAPAPPL_INFO administrative view 1229, 1399
SNAPBP administrative view 1258, 1416
SNAPBP_PART administrative view 1264, 1421
SNAPCONTAINER administrative view 1271, 1425
SNAPDB administrative view 1279, 1429, 1479
SNAPDB_MEMORY_POOL administrative view 1291, 1441
SNAPDBM administrative view 1305, 1446
SNAPDBM_MEMORY_POOL administrative view 1310, 1450
SNAPDETAILLOG administrative view 1316, 1454
SNAPDYN_SQL administrative view 893, 926
SNAPFCM administrative view 1326, 1457
SNAPFCM_PART administrative view 1329, 1460
SNAPHADR administrative view 1332, 1464
SNAPLOCK administrative view 1337, 1468
SNAPLOCKWAIT administrative view 1342, 1473
SNAPSTMT administrative view 1348, 1496
SNAPSTORAGE_PATHS administrative view 1356, 1502
SNAPSUBSECTION administrative view 899, 932
SNAPSWITCHES administrative view 903, 936
SNAPTAB_REORG administrative view 907, 940
SNAPTBSP administrative view 1365, 1510
SNAPTBSP_PART administrative view 1371, 1515
SNAPTBSP_QUIESCER administrative view 913, 945
SNAPTBSP_RANGE administrative view 918, 950
SNAPUTIL administrative view 1385, 1491, 1521
SNAPUTIL_PROGRESS administrative view 922, 954
split mirrors
retrieving database paths 1057
SQL
administrative routines
deprecated 1089
SQL statements
help
displaying 1562
SQLCODE
returning message information 342
SQLERRM scalar functions 1085
STEPWISE_REDISTRIBUTE_DBPG procedure
details 977
storage management tool
stored procedures 979, 981, 982
stored procedures
AUDIT_ARCHIVE 307
AUDIT_DELIM_EXTRACT 308
GET_ROUTINE_NAME procedure 961
MON_CAPTURE_ACTIVITY_IN_PROGRESS 441
MON_COLLECT_STATS 443
WLM_ALTER_MEMBER_SUBSET 1024
WLM_CREATE_MEMBER_SUBSET 1027
WLM_DROP_MEMBER_SUBSET 1029
SYSINSTALLOBJECTS procedure
details 1088
SYSINSTALLROUTINES deprecated procedure 1525
system information
retrieving 349, 402
SYSTS_ADMIN_CMD procedure 982
SYSTS_ALTER stored procedure 984
SYSTS_CLEANUP stored procedure 990
SYSTS_CLEAR_COMMANDLOCKS stored procedure 991
SYSTS_CLEAR_EVENTS stored procedure 993
SYSTS_CONFIGURE procedure 995
SYSTS_CREATE procedure 998
SYSTS_DISABLE procedure 1007
SYSTS_DROP stored procedure 1009
SYSTS_ENABLE stored procedure 1012
SYSTS_UPDATE stored procedure 1014
SYSTS_UPGRADE_CATALOG stored procedure 1019
SYSTS_UPGRADE_INDEX stored procedure 1020
T
table compression
information 1097
table functions
ADMIN_GET_DBP_MEM_USAGE 1095
ADMIN_GET_INDEX_COMPRESS_INFO 213
ADMIN_GET_INDEX_INFO 217
ADMIN_GET_MEM_USAGE 222
ADMIN_GET_MSGS 223
ADMIN_GET_STORAGE_PATHS 224
ADMIN_GET_TAB_DICTIONARY_INFO 229
ADMIN_GET_TAB_INFO 232, 278
ADMIN_GET_TEMP_COLUMNS 240, 287
ADMIN_GET_TEMP_TABLES 244, 290
ADMIN_LIST_DB_PATHS 1057
AUDIT_ARCHIVE 307
AUTH_LIST_GROUPS_FOR_AUTHID 884
built-in views comparison 3
DB_GET_CFG 366
DB2_GET_CLUSTER_HOST_STATE
details 374
DB2_GET_INSTANCE_INFO
details 377
deprecated functionality
SNAP_GET_APPL_INFO_V95 1237
Index
1577
1084

deprecated functionality (continued)
summary 1089
ENV_GET_DB2_EDU_SYSTEM_RESOURCES 385
ENV_GET_ROLLING_UPDATE_STATUS 393
ENV_GET_SYSTEM_RESOURCES 396
MON_FORMAT_LOCK_NAME 445
MON_GET_ACTIVITY 475
MON_GET_AGENT 505
MON_GET_APPL_LOCKWAIT 512
MON_GET_DATABASE 570
MON_GET_DATABASE_DETAILS 585
MON_GET_INSTANCE 618
MON_GET_LOCKS 620
MON_GET_MEMORY_POOL 625
MON_GET_MEMORY_SET 627
MON_GET_QUEUE_STATS 655
MON_GET_ROUTINE 660
MON_GET_ROUTINE_DETAILS 674
MON_GET_ROUTINE_EXEC_LIST 688
MON_GET_SECTION_ROUTINE 693
MON_GET_SERVICE_SUBCLASS_STATS 724
MON_GET_SERVICE_SUPERCLASS_STATS 729
MON_GET_UTILITY 783
MON_GET_WORK_ACTION_SET_STATS 811
MON_GET_WORKLOAD_STATS 809
PD_GET_DIAG_HIST 1064
PD_GET_LOG_MSGS 1072
SNAP_GET_AGENT 1221, 1391
SNAP_GET_AGENT_MEMORY_POOL 1225, 1395
SNAP_GET_APPL 1243, 1407
SNAP_GET_APPL_INFO 1229, 1399
SNAP_GET_BP 1258, 1416
SNAP_GET_BP_PART 1264, 1421
SNAP_GET_CONTAINER 1271, 1425
SNAP_GET_DB 1279, 1429, 1479
SNAP_GET_DBM 1305, 1446
SNAP_GET_DBM_MEMORY_POOL 1310, 1450
SNAP_GET_DETAILLOG 1316, 1454
SNAP_GET_DYN_SQL 893, 926
SNAP_GET_FCM 1326, 1457
SNAP_GET_FCM_PART 1329, 1460
SNAP_GET_HADR 1332, 1464
SNAP_GET_LOCK 1337, 1468
SNAP_GET_LOCKWAIT 1342, 1473
SNAP_GET_STMT 1348, 1496
SNAP_GET_SUBSECTION 899, 932
SNAP_GET_SWITCHES 903, 936
SNAP_GET_TAB_REORG 907, 940
SNAP_GET_TBSP 1365, 1510
SNAP_GET_TBSP_PART 1371, 1515
1578

SNAP_GET_TBSP_QUIESCER 913, 945
SNAP_GET_TBSP_RANGE 918, 950
SNAP_GET_UTIL 1385, 1491, 1521
SNAP_GET_UTIL_PROGRESS 922, 954
summary 3
WLM_GET_SERVICE_CLASS_AGENTS 1033
_OCCURRENCES 1033
WLM_GET_SERVICE_SUBCLASS_STATS 1036
WLM_GET_SERVICE_SUBCLASS_STATS_V97 1545
WLM_GET_WORKLOAD_STATS 1038
tables
moving online
ADMIN_MOVE_TABLE_UTIL procedure 269
retrieving information
column information for temporary tables 240, 287
size 232, 278, 1114
state 232, 278, 1114
temporary tables 244, 290
TBSP_UTILIZATION administrative view 1526
terms and conditions
publications 1562
TOP_DYNAMIC_SQL administrative view 958
U
UNQUIESCE DATABASE command
UPDATE ALERT CONFIGURATION command
UPDATE CONTACT command
UPDATE CONTACTGROUP command
UPDATE DATABASE CONFIGURATION command
UPDATE DATABASE MANAGER CONFIGURATION
command
UPDATE HEALTH NOTIFICATION CONTACT LIST
command
UPDATE HISTORY command 202
UPDATE STMM TUNING command 204
V
views
administrative views
ADMIN_TASK_LIST 299
ADMIN_TASK_STATUS 302
ADMINTABCOMPRESSINFO (deprecated)
ADMINTABINFO 232, 278
ADMINTEMPCOLUMNS 240, 287
ADMINTEMPTABLES 244, 290
APPL_PERFORMANCE 1136
APPLICATIONS 1138
AUTHORIZATIONIDS 888
BP_HITRATIO 1143
BP_READ_IO 1145
BP_WRITE_IO 1147
CONTACTGROUPS 1049
CONTACTS 1050
1097
views (continued)
administrative views (continued)
CONTAINER_UTILIZATION 1149
DB_HISTORY 1052
DB2_CF 377
DB2_CLUSTER_HOST_STATE 374
DB2_INSTANCE_ALERTS 376
DB2_MEMBER 377
DBCFG 366
DBMCFG 369
DBPATHS 1057
ENV_FEATURE_INFO 384
ENV_INST_INFO 399
ENV_PROD_INFO 400
ENV_SYS_INFO 402
ENV_SYS_RESOURCES 1153
LOCKS_HELD 1207
LOCKWAITS 1210
LOG_UTILIZATION 1213
LONG_RUNNING_SQL 1215
MON_BP_UTILIZATION 820
MON_CONNECTION_SUMMARY 829
MON_CURRENT_SQL 834
MON_CURRENT_UOW 835
MON_DB_SUMMARY 837
MON_LOCKWAITS 840
MON_PKG_CACHE_SUMMARY 842
MON_SERVICE_SUBCLASS_SUMMARY 844
MON_TBSP_UTILIZATION 848
MON_WORKLOAD_SUMMARY 854
NOTIFICATIONLIST 1063
OBJECTOWNERS 889
PDLOGMSGS_LAST24HOURS 1072
PRIVILEGES 890
QUERY_PREP_COST 892
REG_VARIABLES 1218
SNAPAGENT 1221, 1391
SNAPAGENT_MEMORY_POOL 1225, 1395
SNAPAPPL 1243, 1407
SNAPAPPL_INFO 1229, 1399
SNAPBP 1258, 1416
SNAPBP_PART 1264, 1421
SNAPCONTAINER 1271, 1425
SNAPDB 1279, 1429, 1479
SNAPDBM 1305, 1446
SNAPDBM_MEMORY_POOL 1310, 1450
SNAPDETAILLOG 1316, 1454
SNAPDYN_SQL 893, 926
SNAPFCM 1326, 1457
SNAPFCM_PART 1329, 1460
SNAPHADR 1332, 1464
SNAPLOCK 1337, 1468
SNAPLOCKWAIT 1342, 1473
SNAPSTMT 1348, 1496
SNAPSUBSECTION 899, 932
SNAPSWITCHES 903, 936
SNAPTAB 1359, 1506
SNAPTAB_REORG 907, 940
SNAPTBSP 1365, 1510
SNAPTBSP_PART 1371, 1515
SNAPTBSP_QUIESCER 913, 945
SNAPTBSP_RANGE 918, 950
SNAPUTIL 1385, 1491, 1521
SNAPUTIL_PROGRESS 922, 954
TBSP_UTILIZATION 1526
views (continued)
administrative views (continued)
TOP_DYNAMIC_SQL 958
854
W
WLM_ALTER_MEMBER_SUBSET stored procedure 1024
WLM_CANCEL_ACTIVITY procedure 1022
WLM_CAPTURE_ACTIVITY_IN_PROGRESS procedure 1023
WLM_COLLECT_STATS procedure
details 1024
WLM_CREATE_MEMBER_SUBSET stored procedure 1027
WLM_DROP_MEMBER_SUBSET stored procedure 1029
WLM_GET_ACTIVITY_DETAILS table function 1528
WLM_GET_CONN_ENV table function 1030
WLM_GET_QUEUE_STATS table function 1032
WLM_GET_SERVICE_CLASS_AGENTS table function
details 1033
WLM_GET_SERVICE_CLASS_AGENTS_V97 table
function 1534
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES
table function
details 1033
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES
_V97 table function 1542
WLM_GET_SERVICE_SUBCLASS_STATS table function
details 1036
WLM_GET_SERVICE_SUBCLASS_STATS_V97 table
function 1545
WLM_GET_SERVICE_SUPERCLASS_STATS table
function 1037
WLM_GET_WORK_ACTION_SET_STATS table function
details 1037
WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES table
function
details 1038
WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES_V97
table function 1551
WLM_GET_WORKLOAD_STATS table function 1038
WLM_GET_WORKLOAD_STATS_V97 table function 1555
WLM_SET_CLIENT_INFO procedure 1039
WLM_SET_CONN_ENV procedure 1041
X
XML
common SQL API input 318
XML documents
output documents
versioning for common SQL API
317
Index
1579
1580

Printed in USA
SC27-5507-00
IBM DB2 10.5 for Linux, UNIX, and Windows
Spine information:

Db2 Admin Routines Views

Diunggah oleh

Informasi Dokumen

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

Db2 Admin Routines Views

Diunggah oleh

Hak Cipta:

Format Tersedia

IBM DB2 10.

Administrative Routines and Views

IBM DB2 10.5

Administrative Routines and Views

AM_SAVE_TASK - Create or modify a

SNAP_GET_APPL_V95 table function Retrieve appl logical data group snapshot

Administrative Routines and Views

SNAPLOCK administrative view and

SNAPCONTAINER administrative view and

SNAPTAB administrative view and

Appendix A. Overview of the DB2

Appendix B. Notices . . . . . . . . 1565

Administrative Routines and Views

Built-in routines and views

Best practices for calling built-in routines and views in applications

Copyright IBM Corp. 2006, 2013

Authorizations for using built-in routines and views

where routine_name is the name of the built-in routine.

where view_name is the name of the built-in view.

Administrative Routines and Views

Built-in views versus table functions

Supported built-in SQL routines and views

Administrative SQL routines and the ADMIN_CMD stored procedure: Table 1

Configuration built-in SQL routines and views: Table 6 on page 7

v Stepwise redistribute built-in SQL routines: Table 15 on page 18

This procedure allows the administrator to

This procedure is used to copy a specific

This procedure is used to drop a specific

This function returns an estimate of the

This table function returns the potential

This table function returns index

This scalar function returns the current state

This table function returns the memory

ADMIN_GET_INDEX_INFO table function

Administrative Routines and Views

Table 1. Administrative SQL routines (continued)

This table function is used to retrieve

This administrative view and table function

This table function returns compression

This table function returns dictionary

This function retrieves state information

This procedure moves data in an active

This procedure alters the user definable

This procedure is used to clean up

This procedure revalidates invalid database

This procedure enables or disables

This view and table function return size

ADMINTEMPCOLUMNS view and

This view and table function retrieve

ADMINTEMPTABLES view and

This view and table function retrieve table

ADMIN_GET_MSGS table function

Built-in routines and views

Table 2. Administrative task scheduler routines and views

This procedure schedules an administrative

This administrative view retrieves

This procedure removes scheduled tasks or

This administrative view retrieves

This procedure updates an existing task

Routine or view name

AUDIT_ARCHIVE procedure and table

This procedure and table function archives

This procedure extracts data from the

AUDIT_LIST_LOGS table function