DB 2 Are 951
Uploaded by
TrurlScribdDB 2 Are 951
Uploaded by
TrurlScribdDB2 Version 9.
5
for Linux, UNIX, and Windows
Administrative Routines and Views
Updated March, 2008
SC23-5843-01
DB2 Version 9.5
for Linux, UNIX, and Windows
Administrative Routines and Views
Updated March, 2008
SC23-5843-01
Note
Before using this information and the product it supports, read the general information under Appendix B, “Notices,” on
page 817.
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 www.ibm.com/shop/publications/order
v To find your local IBM representative, go to the IBM Directory of Worldwide Contacts at 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 International Business Machines Corporation 2006, 2008. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Part 1. Administrative SQL routines AUTOMAINT_GET_POLICYFILE procedure -
retrieve automatic maintenance policy . . . . 210
and views . . . . . . . . . . . . . 1 AUTOMAINT_SET_POLICY procedure -
configure automatic maintenance policy . . . 211
Chapter 1. Authorization for AUTOMAINT_SET_POLICYFILE procedure -
administrative views . . . . . . . . . 3 configure automatic maintenance policy . . . 212
Configuration routines and views . . . . . . 213
Chapter 2. Administrative views versus DB_PARTITIONS . . . . . . . . . . . 213
DBCFG administrative view - Retrieve database
table functions . . . . . . . . . . . . 5 configuration parameter information . . . . 214
DBMCFG administrative view - Retrieve
Chapter 3. Supported administrative database manager configuration parameter
SQL routines and views . . . . . . . . 7 information . . . . . . . . . . . . . 216
Activity monitor routines . . . . . . . . . . 19 REG_VARIABLES administrative view -
AM_BASE_RPT_RECOMS – Recommendations Retrieve DB2 registry settings in use. . . . . 219
for activity reports . . . . . . . . . . . 19 Environment views . . . . . . . . . . . 220
AM_BASE_RPTS – Activity monitor reports . . 20 ENV_INST_INFO administrative view - Retrieve
AM_DROP_TASK – Delete a monitoring task . . 21 information about the current instance . . . . 220
AM_GET_LOCK_CHN_TB – Retrieve application ENV_PROD_INFO administrative view -
lock chain data in a tabular format . . . . . 22 Retrieve information about installed DB2
AM_GET_LOCK_CHNS – Retrieve lock chain products . . . . . . . . . . . . . . 221
information for a specific application . . . . . 23 ENV_FEATURE_INFO administrative view -
AM_GET_LOCK_RPT – Retrieve application lock Return license information for DB2 features . . 223
details . . . . . . . . . . . . . . . 24 ENV_SYS_INFO administrative view - Retrieve
AM_GET_RPT – Retrieve activity monitor data 31 information about the system . . . . . . . 224
AM_SAVE_TASK – Create or modify a ENV_SYS_RESOURCES administrative view -
monitoring task . . . . . . . . . . . . 32 Return system information . . . . . . . . 225
ADMIN_CMD procedure and associated routines . 33 Health snapshot routines . . . . . . . . . 228
ADMIN_CMD – Run administrative commands 33 HEALTH_CONT_HI . . . . . . . . . . 228
ADMIN_GET_DBP_MEM_USAGE table HEALTH_CONT_HI_HIS . . . . . . . . 230
function - Get total memory consumption for HEALTH_CONT_INFO . . . . . . . . . 232
instance . . . . . . . . . . . . . . 191 HEALTH_DB_HI . . . . . . . . . . . 233
ADMIN_GET_MSGS table function - Retrieve HEALTH_DB_HI_HIS . . . . . . . . . 236
messages generated by a data movement utility HEALTH_DB_HIC . . . . . . . . . . 240
that is executed through the ADMIN_CMD HEALTH_DB_HIC_HIS . . . . . . . . . 242
procedure . . . . . . . . . . . . . 193 HEALTH_DB_INFO . . . . . . . . . . 244
ADMINTABCOMPRESSINFO view and HEALTH_DBM_HI . . . . . . . . . . 246
ADMIN_GET_TAB_COMPRESS_INFO . . . . 194 HEALTH_DBM_HI_HIS . . . . . . . . . 247
ADMIN_REMOVE_MSGS procedure - Clean up HEALTH_DBM_INFO . . . . . . . . . 249
messages generated by a data movement utility HEALTH_GET_ALERT_ACTION_CFG table
that is executed through the ADMIN_CMD function -Retrieve health alert action
procedure . . . . . . . . . . . . . 199 configuration settings. . . . . . . . . . 250
ADMINTABINFO administrative view and HEALTH_GET_ALERT_CFG table function -
ADMIN_GET_TAB_INFO_V95 table function - Retrieve health alert configuration settings . . 253
Retrieve size and state information for tables . . 199 HEALTH_GET_IND_DEFINITION table
Audit routines and procedures . . . . . . . 206 function - Retrieve health indicator definitions . 256
AUDIT_ARCHIVE procedure and table function HEALTH_HI_REC . . . . . . . . . . . 258
- Archive audit log file . . . . . . . . . 206 HEALTH_TBS_HI . . . . . . . . . . . 260
AUDIT_DELIM_EXTRACT - performs extract to HEALTH_TBS_HI_HIS . . . . . . . . . 262
delimited file . . . . . . . . . . . . 207 HEALTH_TBS_INFO . . . . . . . . . . 266
AUDIT_LIST_LOGS table function - Lists MQSeries routines . . . . . . . . . . . . 267
archived audit log files . . . . . . . . . 208 MQPUBLISH . . . . . . . . . . . . 267
Automatic maintenance routines . . . . . . . 209 MQREAD . . . . . . . . . . . . . 269
AUTOMAINT_GET_POLICY procedure - MQREADALL . . . . . . . . . . . . 270
retrieve automatic maintenance policy . . . . 209 MQREADALLCLOB . . . . . . . . . . 272
MQREADCLOB . . . . . . . . . . . 274
© Copyright IBM Corp. 2006, 2008 iii
MQRECEIVE . . . . . . . . . . . . 275 SNAPBP administrative view and
MQRECEIVEALL . . . . . . . . . . . 276 SNAP_GET_BP_V95 table function - Retrieve
MQRECEIVEALLCLOB . . . . . . . . . 279 bufferpool logical group snapshot information . 340
MQRECEIVECLOB . . . . . . . . . . 281 SNAPBP_PART administrative view and
MQSEND . . . . . . . . . . . . . 282 SNAP_GET_BP_PART table function – Retrieve
MQSUBSCRIBE . . . . . . . . . . . 283 bufferpool_nodeinfo logical data group snapshot
MQUNSUBSCRIBE . . . . . . . . . . 285 information . . . . . . . . . . . . . 344
Security routines and views . . . . . . . . 286 SNAPCONTAINER administrative view and
AUTH_LIST_AUTHORITIES_FOR_AUTHID 286 SNAP_GET_CONTAINER_V91 table function -
AUTH_LIST_GROUPS_FOR_AUTHID table Retrieve tablespace_container logical data group
function - Retrieve group membership list for a snapshot information . . . . . . . . . . 347
given authorization ID . . . . . . . . . 289 SNAPDB administrative view and
AUTH_LIST_ROLES_FOR_AUTHID function - SNAP_GET_DB_V95 table function - Retrieve
Returns the list of roles . . . . . . . . . 290 snapshot information from the dbase logical
AUTHORIZATIONIDS administrative view - group . . . . . . . . . . . . . . . 351
Retrieve authorization IDs and types . . . . 292 SNAPDB_MEMORY_POOL administrative view
OBJECTOWNERS administrative view – and SNAP_GET_DB_MEMORY_POOL table
Retrieve object ownership information . . . . 293 function – Retrieve database level memory
PRIVILEGES administrative view – Retrieve usage information . . . . . . . . . . . 362
privilege information . . . . . . . . . . 294 SNAPDBM administrative view and
Snapshot routines and views . . . . . . . . 295 SNAP_GET_DBM_V95 table function - Retrieve
APPL_PERFORMANCE administrative view - the dbm logical grouping snapshot information . 366
Retrieve percentage of rows selected for an SNAPDBM_MEMORY_POOL administrative
application . . . . . . . . . . . . . 295 view and SNAP_GET_DBM_MEMORY_POOL
APPLICATIONS administrative view - Retrieve table function – Retrieve database manager level
connected database application information . . 296 memory usage information . . . . . . . . 370
BP_HITRATIO administrative view - Retrieve SNAPDETAILLOG administrative view and
bufferpool hit ratio information . . . . . . 300 SNAP_GET_DETAILLOG_V91 table function -
BP_READ_IO administrative view - Retrieve Retrieve snapshot information from the
bufferpool read performance information . . . 302 detail_log logical data group . . . . . . . 372
BP_WRITE_IO administrative view - Retrieve SNAPDYN_SQL administrative view and
bufferpool write performance information . . . 304 SNAP_GET_DYN_SQL_V95 table function -
CONTAINER_UTILIZATION administrative Retrieve dynsql logical group snapshot
view - Retrieve table space container and information . . . . . . . . . . . . . 375
utilization information . . . . . . . . . 305 SNAPFCM administrative view and
LOCKS_HELD administrative view - Retrieve SNAP_GET_FCM table function – Retrieve the
information on locks held . . . . . . . . 307 fcm logical data group snapshot information . . 380
LOCKWAITS administrative view - Retrieve SNAPFCM_PART administrative view and
current lockwaits information . . . . . . . 310 SNAP_GET_FCM_PART table function –
LOG_UTILIZATION administrative view - Retrieve the fcm_node logical data group
Retrieve log utilization information . . . . . 314 snapshot information . . . . . . . . . . 382
LONG_RUNNING_SQL administrative view 315 SNAPHADR administrative view and
QUERY_PREP_COST administrative view - SNAP_GET_HADR table function – Retrieve
Retrieve statement prepare time information . . 317 hadr logical data group snapshot information . 384
SNAPAGENT administrative view and SNAPLOCK administrative view and
SNAP_GET_AGENT table function – Retrieve SNAP_GET_LOCK table function – Retrieve
agent logical data group application snapshot lock logical data group snapshot information . . 388
information . . . . . . . . . . . . . 318 SNAPLOCKWAIT administrative view and
SNAPAGENT_MEMORY_POOL administrative SNAP_GET_LOCKWAIT table function –
view and Retrieve lockwait logical data group snapshot
SNAP_GET_AGENT_MEMORY_POOL table information . . . . . . . . . . . . . 393
function – Retrieve memory_pool logical data SNAPSTMT administrative view and
group snapshot information . . . . . . . 321 SNAP_GET_STMT table function – Retrieve
SNAPAPPL_INFO administrative view and statement snapshot information . . . . . . 398
SNAP_GET_APPL_INFO_V95 table function - SNAPSTORAGE_PATHS administrative view
Retrieve appl_info logical data group snapshot and SNAP_GET_STORAGE_PATHS table
information . . . . . . . . . . . . . 324 function - Retrieve automatic storage path
SNAPAPPL administrative view and information . . . . . . . . . . . . . 403
SNAP_GET_APPL_V95 table function - Retrieve
appl logical data group snapshot information . 332
iv Administrative Routines and Views
SNAPSUBSECTION administrative view and SNAPBP_PART administrative view and
SNAP_GET_SUBSECTION table function – SNAP_GET_BP_PART table function – Retrieve
Retrieve subsection logical monitor group bufferpool_nodeinfo logical data group snapshot
snapshot information . . . . . . . . . . 406 information . . . . . . . . . . . . . 468
SNAPSWITCHES administrative view and SNAPCONTAINER administrative view and
SNAP_GET_SWITCHES table function – SNAP_GET_CONTAINER_V91 table function -
Retrieve database snapshot switch state Retrieve tablespace_container logical data group
information . . . . . . . . . . . . . 409 snapshot information . . . . . . . . . . 471
SNAPTAB administrative view and SNAPDB administrative view and
SNAP_GET_TAB_V91 table function - Retrieve SNAP_GET_DB_V95 table function - Retrieve
table logical data group snapshot information . 412 snapshot information from the dbase logical
SNAPTAB_REORG administrative view and group . . . . . . . . . . . . . . . 475
SNAP_GET_TAB_REORG table function - SNAPDB_MEMORY_POOL administrative view
Retrieve table reorganization snapshot and SNAP_GET_DB_MEMORY_POOL table
information . . . . . . . . . . . . . 415 function – Retrieve database level memory
SNAPTBSP administrative view and usage information . . . . . . . . . . . 486
SNAP_GET_TBSP_V91 table function - Retrieve SNAPDBM administrative view and
table space logical data group snapshot SNAP_GET_DBM_V95 table function - Retrieve
information . . . . . . . . . . . . . 419 the dbm logical grouping snapshot information . 490
SNAPTBSP_PART administrative view and SNAPDBM_MEMORY_POOL administrative
SNAP_GET_TBSP_PART_V91 table function - view and SNAP_GET_DBM_MEMORY_POOL
Retrieve tablespace_nodeinfo logical data group table function – Retrieve database manager level
snapshot information . . . . . . . . . . 424 memory usage information . . . . . . . . 494
SNAPTBSP_QUIESCER administrative view and SNAPDETAILLOG administrative view and
SNAP_GET_TBSP_QUIESCER table function - SNAP_GET_DETAILLOG_V91 table function -
Retrieve quiescer table space snapshot Retrieve snapshot information from the
information . . . . . . . . . . . . . 429 detail_log logical data group . . . . . . . 496
SNAPTBSP_RANGE administrative view and SNAPDYN_SQL administrative view and
SNAP_GET_TBSP_RANGE table function - SNAP_GET_DYN_SQL_V95 table function -
Retrieve range snapshot information . . . . 432 Retrieve dynsql logical group snapshot
SNAPUTIL administrative view and information . . . . . . . . . . . . . 499
SNAP_GET_UTIL table function - Retrieve SNAPFCM administrative view and
utility_info logical data group snapshot SNAP_GET_FCM table function – Retrieve the
information . . . . . . . . . . . . . 435 fcm logical data group snapshot information . . 504
SNAPUTIL_PROGRESS administrative view SNAPFCM_PART administrative view and
and SNAP_GET_UTIL_PROGRESS table SNAP_GET_FCM_PART table function –
function - Retrieve progress logical data group Retrieve the fcm_node logical data group
snapshot information . . . . . . . . . . 439 snapshot information . . . . . . . . . . 506
SNAP_WRITE_FILE procedure . . . . . . 441 SNAPHADR administrative view and
SNAPAGENT administrative view and SNAP_GET_HADR table function – Retrieve
SNAP_GET_AGENT table function – Retrieve hadr logical data group snapshot information . 508
agent logical data group application snapshot SNAPLOCK administrative view and
information . . . . . . . . . . . . . 442 SNAP_GET_LOCK table function – Retrieve
SNAPAGENT_MEMORY_POOL administrative lock logical data group snapshot information . . 512
view and SNAPLOCKWAIT administrative view and
SNAP_GET_AGENT_MEMORY_POOL table SNAP_GET_LOCKWAIT table function –
function – Retrieve memory_pool logical data Retrieve lockwait logical data group snapshot
group snapshot information . . . . . . . 445 information . . . . . . . . . . . . . 517
SNAPAPPL_INFO administrative view and SNAPSTMT administrative view and
SNAP_GET_APPL_INFO_V95 table function - SNAP_GET_STMT table function – Retrieve
Retrieve appl_info logical data group snapshot statement snapshot information . . . . . . 522
information . . . . . . . . . . . . . 449 SNAPSTORAGE_PATHS administrative view
SNAPAPPL administrative view and and SNAP_GET_STORAGE_PATHS table
SNAP_GET_APPL_V95 table function - Retrieve function - Retrieve automatic storage path
appl logical data group snapshot information . 456 information . . . . . . . . . . . . . 527
SNAPBP administrative view and SNAPSUBSECTION administrative view and
SNAP_GET_BP_V95 table function - Retrieve SNAP_GET_SUBSECTION table function –
bufferpool logical group snapshot information . 464 Retrieve subsection logical monitor group
snapshot information . . . . . . . . . . 530
Contents v
SNAPSWITCHES administrative view and CAPTURE_STORAGEMGMT_INFO procedure -
SNAP_GET_SWITCHES table function – Retrieve storage-related information for a given
Retrieve database snapshot switch state root object . . . . . . . . . . . . . 584
information . . . . . . . . . . . . . 533 CREATE_STORAGEMGMT_TABLES procedure
SNAPTAB administrative view and - Create storage management tables . . . . . 585
SNAP_GET_TAB_V91 table function - Retrieve DROP_STORAGEMGMT_TABLES procedure -
table logical data group snapshot information . 536 Drop all storage management tables . . . . . 586
SNAPTAB_REORG administrative view and Text Search routines . . . . . . . . . . . 587
SNAP_GET_TAB_REORG table function - SYSTS_ADMIN_CMD stored procedure - Run
Retrieve table reorganization snapshot text search administration commands . . . . 587
information . . . . . . . . . . . . . 539 SYSTS_ALTER procedure - Change the update
SNAPTBSP administrative view and characteristics of an index . . . . . . . . 588
SNAP_GET_TBSP_V91 table function - Retrieve SYSTS_CLEAR_COMMANDLOCKS procedure -
table space logical data group snapshot Remove command locks for text search indexes . 591
information . . . . . . . . . . . . . 543 SYSTS_CLEAR_EVENTS procedure - Delete
SNAPTBSP_PART administrative view and indexing events from an index’s event table . . 593
SNAP_GET_TBSP_PART_V91 table function - SYSTS_CREATE procedure - Create a text search
Retrieve tablespace_nodeinfo logical data group index on a column . . . . . . . . . . 595
snapshot information . . . . . . . . . . 548 SYSTS_DISABLE procedure - Disable current
SNAPTBSP_QUIESCER administrative view and database for text search . . . . . . . . . 601
SNAP_GET_TBSP_QUIESCER table function - SYSTS_DROP procedure - Drop a text search
Retrieve quiescer table space snapshot index . . . . . . . . . . . . . . . 603
information . . . . . . . . . . . . . 553 SYSTS_ENABLE procedure - Enable current
SNAPTBSP_RANGE administrative view and database for text search . . . . . . . . . 605
SNAP_GET_TBSP_RANGE table function - SYSTS_UPDATE procedure - Update the text
Retrieve range snapshot information . . . . 556 search index . . . . . . . . . . . . . 607
SNAPUTIL administrative view and Workload Management routines . . . . . . . 609
SNAP_GET_UTIL table function - Retrieve WLM_CANCEL_ACTIVITY - Cancel an activity 609
utility_info logical data group snapshot WLM_CAPTURE_ACTIVITY_IN_PROGRESS -
information . . . . . . . . . . . . . 559 Collect activity information for activities event
SNAPUTIL_PROGRESS administrative view monitor . . . . . . . . . . . . . . 610
and SNAP_GET_UTIL_PROGRESS table WLM_COLLECT_STATS - Collect and reset
function - Retrieve progress logical data group workload management statistics . . . . . . 612
snapshot information . . . . . . . . . . 563 WLM_GET_ACTIVITY_DETAILS - Return
SNAP_WRITE_FILE procedure . . . . . . 565 detailed information about a specific activity . . 613
TBSP_UTILIZATION administrative view - WLM_GET_QUEUE_STATS table function -
Retrieve table space configuration and Return threshold queue statistics . . . . . . 619
utilization information . . . . . . . . . 566 WLM_GET_SERVICE_CLASS_AGENTS - List
TOP_DYNAMIC_SQL administrative view - agents executing in a service class . . . . . 623
Retrieve information on the top dynamic SQL WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES
statements . . . . . . . . . . . . . 570 - List of workload occurrences . . . . . . . 627
SQL procedures routines . . . . . . . . . 571 WLM_GET_SERVICE_SUBCLASS_STATS -
GET_ROUTINE_OPTS . . . . . . . . . 571 Return statistics of service subclasses . . . . 631
GET_ROUTINE_SAR . . . . . . . . . . 571 WLM_GET_SERVICE_SUPERCLASS_STATS -
PUT_ROUTINE_SAR . . . . . . . . . . 572 Return statistics of service superclasses . . . . 636
REBIND_ROUTINE_PACKAGE . . . . . . 573 WLM_GET_WORK_ACTION_SET_STATS -
SET_ROUTINE_OPTS . . . . . . . . . 574 Return work action set statistics . . . . . . 638
Stepwise redistribute routines . . . . . . . . 575 WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES
ANALYZE_LOG_SPACE procedure - Retrieve - Return a list of activities . . . . . . . . 640
log space analysis information . . . . . . . 575 WLM_GET_WORKLOAD_STATS - Return
GENERATE_DISTFILE procedure - Generate a workload statistics . . . . . . . . . . . 644
data distribution file . . . . . . . . . . 577 WLM_SET_CLIENT_INFO procedure - Set client
GET_SWRD_SETTINGS procedure - Retrieve information . . . . . . . . . . . . . 646
redistribute information . . . . . . . . . 578 Miscellaneous routines and views . . . . . . 648
SET_SWRD_SETTINGS procedure - Create or ADMIN_COPY_SCHEMA procedure - Copy a
change redistribute registry . . . . . . . . 580 specific schema and its objects . . . . . . . 648
STEPWISE_REDISTRIBUTE_DBPG procedure - ADMIN_DROP_SCHEMA procedure - Drop a
Redistribute part of database partition group . . 582 specific schema and its objects . . . . . . . 652
Storage management tool routines . . . . . . 584 ALTOBJ . . . . . . . . . . . . . . 654
APPLICATION_ID . . . . . . . . . . 656
vi Administrative Routines and Views
COMPILATION_ENV table function - Retrieve SNAP_GET_TAB . . . . . . . . . . . . 758
compilation environment elements . . . . . 657 SNAP_GET_TBSP . . . . . . . . . . . . 759
CONTACTGROUPS administrative view - SNAP_GET_TBSP_PART . . . . . . . . . 762
Retrieve the list of contact groups . . . . . 659 SNAPSHOT_AGENT . . . . . . . . . . . 764
CONTACTS administrative view - Retrieve list SNAPSHOT_APPL . . . . . . . . . . . 765
of contacts . . . . . . . . . . . . . 660 SNAPSHOT_APPL_INFO . . . . . . . . . 770
DB_HISTORY administrative view - Retrieve SNAPSHOT_BP . . . . . . . . . . . . 772
history file information . . . . . . . . . 661 SNAPSHOT_CONTAINER . . . . . . . . . 774
DBPATHS administrative view - Retrieve SNAPSHOT_DATABASE . . . . . . . . . 775
database paths . . . . . . . . . . . . 665 SNAPSHOT_DBM . . . . . . . . . . . . 781
EXPLAIN_FORMAT_STATS . . . . . . . 668 SNAPSHOT_DYN_SQL . . . . . . . . . . 783
EXPLAIN_GET_MSGS . . . . . . . . . 673 SNAPSHOT_FCM . . . . . . . . . . . . 784
GET_DBSIZE_INFO . . . . . . . . . . 675 SNAPSHOT_FCMNODE . . . . . . . . . 785
NOTIFICATIONLIST administrative view - SNAPSHOT_FILEW . . . . . . . . . . . 786
Retrieve contact list for health notification . . . 677 SNAPSHOT_LOCK . . . . . . . . . . . 787
PD_GET_DIAG_HIST - Return records from a SNAPSHOT_LOCKWAIT . . . . . . . . . 788
given facility . . . . . . . . . . . . 678 SNAPSHOT_QUIESCERS . . . . . . . . . 789
PDLOGMSGS_LAST24HOURS administrative SNAPSHOT_RANGES . . . . . . . . . . 790
view and PD_GET_LOG_MSGS table function – SNAPSHOT_STATEMENT . . . . . . . . . 791
Retrieve problem determination messages . . . 685 SNAPSHOT_SUBSECT . . . . . . . . . . 793
REORGCHK_IX_STATS procedure – Retrieve SNAPSHOT_SWITCHES . . . . . . . . . 795
index statistics for reorganization evaluation . . 692 SNAPSHOT_TABLE . . . . . . . . . . . 796
REORGCHK_TB_STATS procedure – Retrieve SNAPSHOT_TBREORG . . . . . . . . . . 797
table statistics for reorganization evaluation . . 694 SNAPSHOT_TBS . . . . . . . . . . . . 799
SQLERRM scalar functions - Retrieves error SNAPSHOT_TBS_CFG . . . . . . . . . . 801
message information . . . . . . . . . . 695 SQLCACHE_SNAPSHOT . . . . . . . . . 803
SYSINSTALLOBJECTS . . . . . . . . . 698 SYSINSTALLROUTINES . . . . . . . . . 804
Chapter 4. Deprecated SQL Part 2. Appendixes . . . . . . . . 805
administrative routines and their
replacement routines or views . . . . 701 Appendix A. Overview of the DB2
ADMIN_GET_TAB_INFO table function - Retrieve technical information . . . . . . . . 807
size and state information for tables . . . . . . 704 DB2 technical library in hardcopy or PDF format 807
GET_DB_CONFIG . . . . . . . . . . . . 713 Ordering printed DB2 books . . . . . . . . 810
GET_DBM_CONFIG . . . . . . . . . . . 714 Displaying SQL state help from the command line
SNAP_GET_APPL table function – Retrieve appl processor . . . . . . . . . . . . . . . 810
logical data group snapshot information . . . . 715 Accessing different versions of the DB2 Information
SNAP_GET_APPL_INFO table function – Retrieve Center . . . . . . . . . . . . . . . . 811
appl_info logical data group snapshot information . 721 Displaying topics in your preferred language in the
SNAP_GET_BP table function – Retrieve bufferpool DB2 Information Center . . . . . . . . . . 811
logical group snapshot information . . . . . . 728 Updating the DB2 Information Center installed on
SNAP_GET_CONTAINER . . . . . . . . . 731 your computer or intranet server . . . . . . . 812
SNAP_GET_DB . . . . . . . . . . . . 732 DB2 tutorials . . . . . . . . . . . . . 813
SNAP_GET_DBM table function – Retrieve the DB2 troubleshooting information . . . . . . . 814
dbm logical grouping snapshot information . . . 739 Terms and Conditions . . . . . . . . . . 814
SNAP_GET_DB_V91 table function - Retrieve
snapshot information from the dbase logical group . 742
SNAP_GET_DYN_SQL_V91 table function -
Appendix B. Notices . . . . . . . . 817
Retrieve dynsql logical group snapshot information 752
SNAP_GET_DYN_SQL . . . . . . . . . . 755 Index . . . . . . . . . . . . . . . 821
SNAP_GET_STO_PATHS . . . . . . . . . 757
Contents vii
viii Administrative Routines and Views
Part 1. Administrative SQL routines and views
The administrative routines and views provide a primary, easy to use
programmatic interface to administer DB2® through SQL. They encompass a
collection of built-in views, table functions, procedures, and scalar functions for
performing a variety of DB2 administrative tasks. For example: reorganizing a
table, capturing and retrieving monitor data or retrieving the application ID of the
current connection.
These routines and views can be invoked from an SQL-based application, a DB2
command line or a command script.
© Copyright IBM Corp. 2006, 2008 1
2 Administrative Routines and Views
Chapter 1. Authorization for administrative views
For all administrative views in the SYSIBMADM schema, you need SELECT
privilege on the view. This can be validated with the following query to check that
your authorization ID, or a group or a role to which you belong, has SELECT
privilege (that is, it meets the search criteria and is listed in the GRANTEE
column):
SELECT GRANTEE, GRANTEETYPE
FROM SYSCAT.TABAUTH
WHERE TABSCHEMA = ’SYSIBMADM’ AND TABNAME = ’<view_name>’ AND
SELECTAUTH <> ’N’
where <view_name> is the name of the administrative view.
With the exception of SYSIBMADM.AUTHORIZATIONIDS,
SYSIBMADM.OBJECTOWNERS, and SYSIBMADM.PRIVILEGES, you also need
EXECUTE privilege on the underlying administrative table function. The
underlying administrative table function is listed in the authorization section of the
administrative view. This can be validated with the following query:
SELECT GRANTEE, GRANTEETYPE
FROM SYSCAT.ROUTINEAUTH
WHERE SCHEMA = ’SYSPROC’ AND SPECIFICNAME = ’<routine_name>’ AND
EXECUTEAUTH <> ’N’
where <routine_name> is the name of the underlying administrative table function
as listed in the documentation.
Some administrative views require additional authorities beyond SELECT on the
view and EXECUTE on the underlying administrative table function. Any
additional authority required is documented in the reference information
describing the view.
© Copyright IBM Corp. 2006, 2008 3
4 Administrative Routines and Views
Chapter 2. Administrative views versus table functions
DB2 Version 9.5 introduces administrative views that provide an easy-to-use
application programming interface to DB2 administrative functions through SQL.
The administrative views fall into three categories:
v Views based on catalog views.
v Views based on table functions with no input parameters.
v Views based on table functions with one or more input parameters.
The administrative views are the preferred and only documented interfaces for the
views based on catalog views and the views based on table functions with no
input parameters because the table functions do not provide any additional
information or performance benefits.
For administrative views based on table functions with one or more input
parameters, both the administrative view and the table function can be used, each
achieving a different goal:
v The ADMINTABINFO administrative view and the
ADMIN_GET_TAB_INFO_V95 table function: The administrative view retrieves
information for all tables in the database. This can have a significant
performance impact for large databases. The performance impact can be reduced
by using the table function and specifying a schema name, table name, or both
as input.
v The PDLOGMSGS_LAST24HOURS administrative view and the
PD_GET_LOG_MSGS table function: The administrative view, which retrieves
notification log messages, provides quick access to data from the previous 24
hours, whereas the table function allows you to retrieve data from a specified
period of time.
v All snapshot monitor administrative views and table functions (SNAP*
administrative views, SNAP_GET_* table functions): The snapshot monitor
administrative views provide access to data from each database partition. The
table functions provide the option to choose between data from a single
database partition or data aggregated across all database partitions.
Applications that use the table functions instead of the views might need to be
changed because the table functions might change from release to release to enable
new information to be returned. The new table function will have the same base
name as the original function and will be suffixed with ’_Vxx’ for the version of
the product in which it is added (for example, _V95). The administrative views
will always be based on the most current version of the table functions, and
therefore allow for more application portability. Since the columns might vary from
one release to the next, it is recommended that specific columns be selected from
the administrative views, or that the result set be described if a SELECT *
statement is used by an application.
© Copyright IBM Corp. 2006, 2008 5
6 Administrative Routines and Views
Chapter 3. Supported administrative SQL routines and views
The following tables summarize information about the supported administrative
SQL routines and views.
v Activity monitor administrative SQL routines: Table 1
v ADMIN_CMD stored procedure and associated administrative SQL routines:
Table 2 on page 8
v Audit routines and proceduresTable 3 on page 8
v Automatic maintenance administrative SQL routines and views:Table 4 on page 8
v Configuration administrative SQL routines and views: Table 5 on page 9
v Environment administrative views: Table 6 on page 9
v Health snapshot administrative SQL routines: Table 7 on page 9
v MQSeries® administrative SQL routines: Table 8 on page 11
v Security administrative SQL routines and views: Table 9 on page 11
v Snapshot administrative SQL routines and views: Table 10 on page 12
v SQL procedures administrative SQL routines: Table 11 on page 15
v Stepwise redistribute administrative SQL routines: Table 12 on page 16
v Storage management tool administrative SQL routines: Table 13 on page 16
v Text search administrative SQL routines: Table 14 on page 16
v Workload Management routines: Table 15 on page 17
v Miscellaneous administrative SQL routines and views: Table 16 on page 18
Table 1. Activity monitor administrative SQL routines
Routine name Schema Description
“AM_BASE_RPT_RECOMS – SYSPROC This table function returns recommendations
Recommendations for activity reports” on for activity reports used by the activity
page 19 monitor.
“AM_BASE_RPTS – Activity monitor SYSPROC This table function returns activity reports
reports” on page 20 used by the activity monitor.
“AM_DROP_TASK – Delete a monitoring SYSPROC This procedure deletes a monitoring task.
task” on page 21
“AM_GET_LOCK_CHN_TB – Retrieve SYSPROC This procedure returns application lock chain
application lock chain data in a tabular data in tabular format.
format” on page 22
“AM_GET_LOCK_CHNS – Retrieve lock SYSPROC This procedure displays lock chains for a
chain information for a specific application” specified application using a formatted
on page 23 string.
“AM_GET_LOCK_RPT – Retrieve application SYSPROC This procedure displays lock details for an
lock details” on page 24 application.
“AM_GET_RPT – Retrieve activity monitor SYSPROC This procedure displays activity monitor
data” on page 31 data for a report.
“AM_SAVE_TASK – Create or modify a SYSPROC This procedure creates or modifies a
monitoring task” on page 32 monitoring task.
© Copyright IBM Corp. 2006, 2008 7
Table 2. ADMIN_CMD stored procedure and associated administrative SQL routines
Routine name Schema Description
SYSPROC This procedure allows the administrator to
execute administrative commands
“ADMIN_CMD – Run administrative
(including DB2 command line processor
commands” on page 33
(CLP) commands) by running
ADMIN_CMD through a CALL statement.
“ADMIN_GET_DBP_MEM_USAGE table SYSPROC This function gets the total memory
function - Get total memory consumption for consumption for a given instance.
instance” on page 191
“ADMIN_GET_MSGS table function - Retrieve SYSPROC This table function is used to retrieve
messages generated by a data movement messages generated by data movement
utility that is executed through the utilities that are executed through the
ADMIN_CMD procedure” on page 193 ADMIN_CMD procedure.
“ADMINTABCOMPRESSINFO view and SYSPROC This function returns compression
ADMIN_GET_TAB_COMPRESS_INFO” on information for tables, materialized query
page 194 tables (MQT) and hierarchy tables only.
“ADMIN_REMOVE_MSGS procedure - Clean SYSPROC This procedure is used to clean up
up messages generated by a data movement messages generated by data movement
utility that is executed through the utilities that are executed through the
ADMIN_CMD procedure” on page 199 ADMIN_CMD procedure.
Table 3. Audit routines and procedures
Routine or view name Schema Description
“AUDIT_ARCHIVE procedure and table SYSPROC This procedure and table function archives
function - Archive audit log file” on page 206 the current audit log.
“AUDIT_DELIM_EXTRACT - performs extract SYSPROC This procedure extracts data from the
to delimited file” on page 207 binary archived logs and loads it into
delimited files.
“AUDIT_LIST_LOGS table function - Lists SYSPROC This procedure returns a list of the archived
archived audit log files” on page 208 audit logs at the specified path, for the
current database.
Table 4. Automatic Maintenance administrative SQL routines and views
Routine or view name Schema Description
“AUTOMAINT_GET_POLICY procedure - SYSPROC This procedure gets the current automatic
retrieve automatic maintenance policy” on maintenance settings for the database.
page 209
“AUTOMAINT_GET_POLICYFILE procedure - SYSPROC This procedure gets the current automatic
retrieve automatic maintenance policy” on maintenance settings for the database.
page 210
“AUTOMAINT_SET_POLICY procedure - SYSPROC This procedure sets the automatic
configure automatic maintenance policy” on maintenance policy settings for the
page 211 currently connected database.
“AUTOMAINT_SET_POLICYFILE procedure - SYSPROC This procedure sets the automatic
configure automatic maintenance policy” on maintenance settings for the currently
page 212 connected database.
8 Administrative Routines and Views
Table 5. Configuration administrative SQL routines and views
Routine or view name Schema Description
SYSPROC This table function returns the contents of
“DB_PARTITIONS” on page 213
the db2nodes.cfg file in table form.
“DBCFG administrative view - Retrieve SYSIBMADM This administrative view returns database
database configuration parameter information” configuration information.
on page 214
“DBMCFG administrative view - Retrieve SYSIBMADM This administrative view returns database
database manager configuration parameter manager configuration information.
information” on page 216
“REG_VARIABLES administrative view - SYSIBMADM This administrative view returns the DB2
Retrieve DB2 registry settings in use” on page registry settings from all database
219 partitions.
Table 6. Environment administrative views
View name Schema Description
“ENV_FEATURE_INFO administrative view - SYSPROC This table function returns information
Return license information for DB2 features” about all available features for which a
on page 223 license is required.
“ENV_INST_INFO administrative view - SYSIBMADM This administrative view returns
Retrieve information about the current information about the current instance.
instance” on page 220
“ENV_PROD_INFO administrative view - SYSIBMADM This administrative view returns
Retrieve information about installed DB2 information about installed DB2 products.
products” on page 221
“ENV_SYS_INFO administrative view - SYSIBMADM This administrative view returns
Retrieve information about the system” on information about the system.
page 224
SYSIBMADM This administrative view returns operating
“ENV_SYS_RESOURCES administrative view -
system, CPU, memory and other
Return system information” on page 225
information related to the system
Table 7. Health snapshot administrative SQL routines
Routine name Schema Description
SYSPROC This table function returns a table with
“HEALTH_CONT_HI” on page 228 health indicator information for containers
from a health snapshot of a database.
SYSPROC This table function returns a table with
health indicator history information for
“HEALTH_CONT_HI_HIS” on page 230
containers from a health snapshot of a
database.
SYSPROC This table function returns a table with
rolled-up alert state information for
“HEALTH_CONT_INFO” on page 232
containers from a health snapshot of a
database.
SYSPROC This table function returns a table with
“HEALTH_DB_HI” on page 233 health indicator information from a health
snapshot of a database.
SYSPROC This table function returns a table with
“HEALTH_DB_HI_HIS” on page 236 health indicator history information from a
health snapshot of a database.
Chapter 3. Supported routines and views 9
Table 7. Health snapshot administrative SQL routines (continued)
Routine name Schema Description
SYSPROC This table function returns collection health
“HEALTH_DB_HIC” on page 240 indicator information from a health
snapshot of a database.
SYSPROC This table function returns collection health
“HEALTH_DB_HIC_HIS” on page 242 indicator history information from a health
snapshot of a database.
SYSPROC This table function returns a table with
“HEALTH_DB_INFO” on page 244 rolled-up alert state information from a
health snapshot of one or all databases.
SYSPROC This table function returns a table with
“HEALTH_DBM_HI” on page 246 health indicator information from a health
snapshot of the DB2 database manager.
SYSPROC This table function returns a table with
health indicator history information from a
“HEALTH_DBM_HI_HIS” on page 247
health snapshot of the DB2 database
manager.
SYSPROC This table function returns a table with
rolled-up alert state information from a
“HEALTH_DBM_INFO” on page 249
health snapshot of the DB2 database
manager.
SYSPROC This table function returns health alert
action configuration settings for objects of
“HEALTH_GET_ALERT_ACTION_CFG table
various types (dbm, database, table space,
function -Retrieve health alert action
and table space containers) and for various
configuration settings” on page 250
configuration levels (install default,
instance, global, and object).
SYSPROC This table function returns health alert
configuration settings for objects of various
“HEALTH_GET_ALERT_CFG table function -
types (dbm, database, table space, table
Retrieve health alert configuration settings” on
space containers) and for various
page 253
configuration levels (install default, global,
and object).
“HEALTH_GET_IND_DEFINITION table SYSPROC This table function returns the health
function - Retrieve health indicator definitions” indicator definition.
on page 256
SYSPROC This procedure retrieves a set of
recommendations that address a health
“HEALTH_HI_REC” on page 258
indicator in alert state on a particular DB2
object.
SYSPROC This table function returns a table with
“HEALTH_TBS_HI” on page 260 health indicator information for table spaces
from a health snapshot of a database.
SYSPROC This table function returns a table with
health indicator history information for
“HEALTH_TBS_HI_HIS” on page 262
table spaces from a health snapshot of a
database.
SYSPROC This table function returns a table with
rolled-up alert state information for table
“HEALTH_TBS_INFO” on page 266
spaces from a health snapshot of a
database.
10 Administrative Routines and Views
Table 8. MQSeries administrative SQL routines
Routine name Schema Description
DB2MQ, DB2MQ1C This scalar function publishes data to an
“MQPUBLISH” on page 267
MQSeries location.
DB2MQ, DB2MQ1C This scalar function returns a message from
“MQREAD” on page 269
an MQSeries location.
DB2MQ, DB2MQ1C This table function returns a table with
“MQREADALL” on page 270 messages and message metadata from an
MQSeries location.
DB2MQ This table function returns a table
“MQREADALLCLOB” on page 272 containing messages and message metadata
from a specified MQSeries location.
DB2MQ This scalar function returns a message from
“MQREADCLOB” on page 274
a specified MQSeries location.
DB2MQ, DB2MQ1C This scalar function returns a message from
“MQRECEIVE” on page 275 an MQSeries location and removes the
message from the associated queue.
DB2MQ, DB2MQ1C This table function returns a table
containing the messages and message
“MQRECEIVEALL” on page 276 metadata from an MQSeries location and
removes the messages from the associated
queue.
DB2MQ This table function returns a table
“MQRECEIVEALLCLOB” on page 279 containing messages and message metadata
from a specified MQSeries location.
DB2MQ This scalar function returns a message from
“MQRECEIVECLOB” on page 281
a specified MQSeries location.
DB2MQ, DB2MQ1C This scalar function sends data to an
“MQSEND” on page 282
MQSeries location.
DB2MQ, DB2MQ1C This scalar function subscribes to MQSeries
“MQSUBSCRIBE” on page 283
messages published on a specific topic.
DB2MQ, DB2MQ1C This scalar function unsubscribes from
“MQUNSUBSCRIBE” on page 285 MQSeries messages published on a specific
topic.
Table 9. Security administrative SQL routines and views:
Routine or view name Schema Description
SYSPROC This function returns all authorities held by
the authorization ID, either found in the
“AUTH_LIST_AUTHORITIES_FOR_AUTHID”
database configuration file or granted to an
on page 286
authorization ID directly or indirectly
through a group or a role.
“AUTH_LIST_GROUPS_FOR_AUTHID table SYSPROC This function returns the list of groups of
function - Retrieve group membership list for which the given Authorization ID is a
a given authorization ID” on page 289 member.
SYSPROC This function returns the list of roles in
“AUTH_LIST_ROLES_FOR_AUTHID function
which the given authorization ID is a
- Returns the list of roles” on page 290
member.
SYSIBMADM This administrative view contains a list of
“AUTHORIZATIONIDS administrative view -
authorization IDs that have been granted
Retrieve authorization IDs and types” on page
privileges or authorities, along with their
292
types, for the currently connected database.
Chapter 3. Supported routines and views 11
Table 9. Security administrative SQL routines and views: (continued)
Routine or view name Schema Description
“OBJECTOWNERS administrative view – SYSIBMADM This administrative view contains all object
Retrieve object ownership information” on ownership information for the currently
page 293 connected database.
SYSIBMADM This administrative view contains all
“PRIVILEGES administrative view – Retrieve
explicit privileges for the currently
privilege information” on page 294
connected database.
Table 10. Snapshot administrative SQL routines and views
Routine or view name Schema Description
“APPLICATIONS administrative view - SYSIBMADM This administrative view returns
Retrieve connected database application information on connected database
information” on page 296 applications.
“APPL_PERFORMANCE administrative view - SYSIBMADM This administrative view displays
Retrieve percentage of rows selected for an information about the rate of rows selected
application” on page 295 versus rows read per application.
SYSIBMADM This administrative view returns bufferpool
“BP_HITRATIO administrative view - Retrieve
hit ratios, including total, data, and index,
bufferpool hit ratio information” on page 300
in the database.
“BP_READ_IO administrative view - Retrieve SYSIBMADM This administrative view returns bufferpool
bufferpool read performance information” on read performance information.
page 302
“BP_WRITE_IO administrative view - Retrieve SYSIBMADM This administrative view returns bufferpool
bufferpool write performance information” on write performance information per
page 304 bufferpool.
“CONTAINER_UTILIZATION administrative SYSIBMADM This administrative view returns
view - Retrieve table space container and information about table space containers
utilization information” on page 305 and utilization rates.
“LOCKS_HELD administrative view - Retrieve SYSIBMADM This administrative view returns
information on locks held” on page 307 information on current locks held.
SYSIBMADM This administrative view returns
“LOCKWAITS administrative view - Retrieve
information on locks that are waiting to be
current lockwaits information” on page 310
granted.
“LOG_UTILIZATION administrative view - SYSIBMADM This administrative view returns
Retrieve log utilization information” on page information about log utilization for the
314 currently connected database.
SYSIBMADM This administrative view returns the longest
“LONG_RUNNING_SQL administrative view”
running SQL statements in the currently
on page 315
connected database.
“QUERY_PREP_COST administrative view - SYSIBMADM This administrative view returns a list of
Retrieve statement prepare time information” statements with information about the time
on page 317 required to prepare the statement.
SYSPROC This procedure writes system snapshot data
“SNAP_WRITE_FILE procedure” on page 441 to a file in the tmp subdirectory of the
instance directory.
“SNAPAGENT administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_AGENT table function – Retrieve (administrative view), return information about agents from an
agent logical data group application snapshot SYSPROC (table application snapshot, in particular, the
information” on page 318 function) agent logical data group.
12 Administrative Routines and Views
Table 10. Snapshot administrative SQL routines and views (continued)
Routine or view name Schema Description
“SNAPAGENT_MEMORY_POOL SYSIBMADM This administrative view and table function
administrative view and (administrative view), return information about memory usage at
SNAP_GET_AGENT_MEMORY_POOL table SYSPROC (table the agent level.
function – Retrieve memory_pool logical data function)
group snapshot information” on page 321
“SNAPAPPL administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_APPL_V95 table function - (administrative view), return information about applications from
Retrieve appl logical data group snapshot SYSPROC (table an application snapshot, in particular, the
information” on page 332 function) appl logical data group.
“SNAPAPPL_INFO administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_APPL_INFO_V95 table function - (administrative view), return information about applications from
Retrieve appl_info logical data group snapshot SYSPROC (table an application snapshot, in particular, the
information” on page 324 function) appl_info logical data group.
“SNAPBP administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_BP_V95 table function - Retrieve (administrative view), return information about buffer pools from
bufferpool logical group snapshot information” SYSPROC (table a bufferpool snapshot, in particular, the
on page 340 function) bufferpool logical data group.
“SNAPBP_PART administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_BP_PART table function – Retrieve (administrative view), return information about buffer pools from
bufferpool_nodeinfo logical data group SYSPROC (table a bufferpool snapshot, in particular, the
snapshot information” on page 344 function) bufferpool_nodeinfo logical data group.
“SNAPCONTAINER administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_CONTAINER_V91 table function - (administrative view), return table space snapshot information
Retrieve tablespace_container logical data SYSPROC (table from the tablespace_container logical data
group snapshot information” on page 347 function) group.
“SNAPDB administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_DB_V95 table function - Retrieve (administrative view), return snapshot information from the
snapshot information from the dbase logical SYSPROC (table database (dbase) and database storage
group” on page 351 function) (db_storage_group) logical groupings.
“SNAPDB_MEMORY_POOL administrative SYSIBMADM This administrative view and table function
view and SNAP_GET_DB_MEMORY_POOL (administrative view), return information about memory usage at
table function – Retrieve database level SYSPROC (table the database level for UNIX® platforms
memory usage information” on page 362 function) only.
“SNAPDBM administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_DBM_V95 table function - (administrative view), return the snapshot monitor DB2 database
Retrieve the dbm logical grouping snapshot SYSPROC (table manager (dbm) logical grouping
information” on page 366 function) information.
“SNAPDBM_MEMORY_POOL administrative SYSIBMADM This administrative view and table function
view and SNAP_GET_DBM_MEMORY_POOL (administrative view), return information about memory usage at
table function – Retrieve database manager SYSPROC (table the database manager.
level memory usage information” on page 370 function)
“SNAPDETAILLOG administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_DETAILLOG_V91 table function - (administrative view), return snapshot information from the
Retrieve snapshot information from the SYSPROC (table detail_log logical data group.
detail_log logical data group” on page 372 function)
“SNAPDYN_SQL administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_DYN_SQL_V95 table function - (administrative view), return snapshot information from the
Retrieve dynsql logical group snapshot SYSPROC (table dynsql logical data group.
information” on page 375 function)
Chapter 3. Supported routines and views 13
Table 10. Snapshot administrative SQL routines and views (continued)
Routine or view name Schema Description
SYSIBMADM This administrative view and table function
“SNAPFCM administrative view and
(administrative view), return information about the fast
SNAP_GET_FCM table function – Retrieve the
SYSPROC (table communication manager (FCM) from a
fcm logical data group snapshot information”
function) database manager snapshot, in particular,
on page 380
the fcm logical data group.
SYSIBMADM This administrative view and table function
“SNAPFCM_PART administrative view and
(administrative view), return information about the fast
SNAP_GET_FCM_PART table function –
SYSPROC (table communication manager (FCM) from a
Retrieve the fcm_node logical data group
function) database manager snapshot, in particular,
snapshot information” on page 382
the fcm_node logical data group.
“SNAPHADR administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_HADR table function – Retrieve (administrative view), return information about high availability
hadr logical data group snapshot information” SYSPROC (table disaster recovery from a database snapshot,
on page 384 function) in particular, the hadr logical data group.
“SNAPLOCK administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_LOCK table function – Retrieve (administrative view), return snapshot information about locks, in
lock logical data group snapshot information” SYSPROC (table particular, the lock logical data group.
on page 388 function)
“SNAPLOCKWAIT administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_LOCKWAIT table function – (administrative view), return snapshot information about lock
Retrieve lockwait logical data group snapshot SYSPROC (table waits, in particular, the lockwait logical
information” on page 393 function) data group.
SYSIBMADM This administrative view and table function
“SNAPSTMT administrative view and
(administrative view), return information about statements from
SNAP_GET_STMT table function – Retrieve
SYSPROC (table an application snapshot.
statement snapshot information” on page 398
function)
SYSIBMADM This administrative view and table function
“SNAPSTORAGE_PATHS administrative view (administrative view), return a list of automatic storage paths for
and SNAP_GET_STORAGE_PATHS table SYSPROC (table the database including file system
function - Retrieve automatic storage path function) information for each storage path,
information” on page 403 specifically, from the db_storage_group
logical data group
“SNAPSUBSECTION administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_SUBSECTION table function – (administrative view), return information about application
Retrieve subsection logical monitor group SYSPROC (table subsections, namely the subsection logical
snapshot information” on page 406 function) monitor grouping.
“SNAPSWITCHES administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_SWITCHES table function – (administrative view), return information about the database
Retrieve database snapshot switch state SYSPROC (table snapshot switch state.
information” on page 409 function)
“SNAPTAB administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_TAB_V91 table function - Retrieve (administrative view), return snapshot information from the table
table logical data group snapshot information” SYSPROC (table logical data group.
on page 412 function)
“SNAPTAB_REORG administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_TAB_REORG table function - (administrative view), return table reorganization information.
Retrieve table reorganization snapshot SYSPROC (table
information” on page 415 function)
“SNAPTBSP administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_TBSP_V91 table function - (administrative view), return snapshot information from the table
Retrieve table space logical data group SYSPROC (table space logical data group.
snapshot information” on page 419 function)
14 Administrative Routines and Views
Table 10. Snapshot administrative SQL routines and views (continued)
Routine or view name Schema Description
“SNAPTBSP_PART administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_TBSP_PART_V91 table function - (administrative view), return snapshot information from the
Retrieve tablespace_nodeinfo logical data SYSPROC (table tablespace_nodeinfo logical data group.
group snapshot information” on page 424 function)
“SNAPTBSP_QUIESCER administrative view SYSIBMADM This administrative view and table function
and SNAP_GET_TBSP_QUIESCER table (administrative view), return information about quiescers from a
function - Retrieve quiescer table space SYSPROC (table table space snapshot.
snapshot information” on page 429 function)
“SNAPTBSP_RANGE administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_TBSP_RANGE table function - (administrative view), return information from a range snapshot.
Retrieve range snapshot information” on page SYSPROC (table
432 function)
“SNAPUTIL administrative view and SYSIBMADM This administrative view and table function
SNAP_GET_UTIL table function - Retrieve (administrative view), return snapshot information on utilities
utility_info logical data group snapshot SYSPROC (table from the utility_info logical data group.
information” on page 435 function)
“SNAPUTIL_PROGRESS administrative view SYSIBMADM This administrative view and table function
and SNAP_GET_UTIL_PROGRESS table (administrative view), return information about utility progress, in
function - Retrieve progress logical data group SYSPROC (table particular, the progress logical data group.
snapshot information” on page 439 function)
“TBSP_UTILIZATION administrative view - SYSIBMADM This administrative view returns table space
Retrieve table space configuration and configuration and utilization information.
utilization information” on page 566
SYSIBMADM This administrative view returns the top
“TOP_DYNAMIC_SQL administrative view - dynamic SQL statements sortable by
Retrieve information on the top dynamic SQL number of executions, average execution
statements” on page 570 time, number of sorts, or sorts per
statement.
Table 11. SQL procedures administrative SQL routines
Routine name Schema Description
SYSPROC This scalar function returns a character
string value of the options that are to be
“GET_ROUTINE_OPTS” on page 571
used for the creation of SQL procedures in
the current session.
SYSFUN This procedure returns the information
necessary to install an identical routine on
“GET_ROUTINE_SAR” on page 571
another database server running at least at
the same level and operating system.
SYSFUN This procedure passes the information
“PUT_ROUTINE_SAR” on page 572 necessary to create and define an SQL
routine at the database server.
SYSPROC This procedure rebinds the package
“REBIND_ROUTINE_PACKAGE” on page 573
associated with an SQL procedure.
SYSPROC This procedure sets the options that are to
“SET_ROUTINE_OPTS” on page 574 be used for the creation of SQL procedures
in the current session.
Chapter 3. Supported routines and views 15
Table 12. Stepwise redistribute administrative SQL routines
Routine name Schema Description
“ANALYZE_LOG_SPACE procedure - Retrieve SYSPROC This procedure returns log space analysis
log space analysis information” on page 575 information.
“GENERATE_DISTFILE procedure - Generate a SYSPROC This procedure generates a data
data distribution file” on page 577 distribution file.
“GET_SWRD_SETTINGS procedure - Retrieve SYSPROC This procedure returns redistribute
redistribute information” on page 578 information.
“SET_SWRD_SETTINGS procedure - Create or SYSPROC This procedure creates or changes the
change redistribute registry” on page 580 redistribute registry.
“STEPWISE_REDISTRIBUTE_DBPG procedure SYSPROC This procedure redistributes part of
- Redistribute part of database partition group” database partition group.
on page 582
Table 13. Storage management tool administrative SQL routines
Routine name Schema Description
“CAPTURE_STORAGEMGMT_INFO SYSPROC This procedure returns storage-related
procedure - Retrieve storage-related information for a given root object.
information for a given root object” on page
584
“CREATE_STORAGEMGMT_TABLES SYSPROC This procedure creates storage management
procedure - Create storage management tables” tables.
on page 585
“DROP_STORAGEMGMT_TABLES procedure - SYSPROC This procedure drops all storage
Drop all storage management tables” on page management tables.
586
Table 14. Text search administrative SQL routines
Routine name Schema Description
“SYSTS_ADMIN_CMD stored procedure - Run SYSPROC This procedure runs text search
text search administration commands” on page administrative commands using the SQL
587 CALL statement.
“SYSTS_ALTER procedure - Change the update SYSPROC This procedure changes the update
characteristics of an index” on page 588 characteristics of an index.
“SYSTS_CLEAR_COMMANDLOCKS SYSPROC This procedure removes all command locks
procedure - Remove command locks for text for a specific text search index or for all
search indexes” on page 591 text search indexes in the database.
“SYSTS_CLEAR_EVENTS procedure - Delete SYSPROC This procedure deletes indexing events
indexing events from an index’s event table” from an index’s event table used for
on page 593 administration.
SYSPROC This procedure creates a text search index
“SYSTS_CREATE procedure - Create a text for a text column which allows the column
search index on a column” on page 595 data to be searched using text search
functions.
“SYSTS_DISABLE procedure - Disable current SYSPROC This procedure disables DB2 Text Search for
database for text search” on page 601 the current database.
SYSPROC This procedure drops an existing text
“SYSTS_DROP procedure - Drop a text search
search index associated with any table
index” on page 603
column.
16 Administrative Routines and Views
Table 14. Text search administrative SQL routines (continued)
Routine name Schema Description
SYSPROC This procedure must be issued successfully
“SYSTS_ENABLE procedure - Enable current
before text search indexes on columns in
database for text search” on page 605
tables within the database can be created.
SYSPROC This procedure updates the text search
“SYSTS_UPDATE procedure - Update the text index to reflect the current contents of the
search index” on page 607 text columns with which the index is
associated.
Table 15. Workload management tool administrative SQL routines
Routine name Schema Description
“WLM_CANCEL_ACTIVITY - Cancel an SYSPROC This procedure cancels the given activity.
activity” on page 609
“WLM_CAPTURE_ACTIVITY_IN_PROGRESS - SYSPROC This procedure sends information on the
Collect activity information for activities event given activity to the activities event
monitor” on page 610 monitor.
“WLM_COLLECT_STATS - Collect and reset SYSPROC This procedure sends statistics for service
workload management statistics” on page 612 classes, workloads, work classes and
threshold queues to the statistics event
monitor and resets the in-memory copy of
the statistics.
“WLM_GET_ACTIVITY_DETAILS - Return SYSPROC This function returns detailed information
detailed information about a specific activity” about a specific activity identified by its
on page 613 APPLICATION_HANDLE, UOW_ID, and
ACTIVITY_ID.
“WLM_GET_QUEUE_STATS table function - SYSPROC This function returns basic statistic
Return threshold queue statistics” on page 619 information for one or more threshold
queues.
“WLM_GET_SERVICE_CLASS_AGENTS - List SYSPROC This function returns the list of agents on
agents executing in a service class” on page 623 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_ SYSPROC This function returns the list of all
WORKLOAD_OCCURRENCES - List of workload occurrences executing in a given
workload occurrences service class on a particular partition.
“WLM_GET_SERVICE_SUBCLASS_STATS - SYSPROC This function returns basic statistics of one
Return statistics of service subclasses” on page or more service subclasses.
631
“WLM_GET_SERVICE_SUPERCLASS_STATS - SYSPROC This function returns basic statistics of one
Return statistics of service superclasses” on or more service superclasses.
page 636
“WLM_GET_WORK_ACTION_SET_STATS - SYSPROC This function returns basic statistics for
Return work action set statistics” on page 638 work classes in a work action set.
WLM_GET_WORKLOAD_ SYSPROC This function returns the list of all activities
OCCURRENCE_ACTIVITIES - Return a list of that were submitted through the given
activities application on the specified partition and
have not yet completed.
“WLM_GET_WORKLOAD_STATS - Return SYSPROC This function returns basic statistics for one
workload statistics” on page 644 or more workloads.
Chapter 3. Supported routines and views 17
Table 15. Workload management tool administrative SQL routines (continued)
Routine name Schema Description
“WLM_SET_CLIENT_INFO procedure - Set SYSPROC This procedure sets client information
client information” on page 646 associated with the current connection at
the DB2 server.
Table 16. Miscellaneous administrative SQL routines and views
Routine or view name Schema Description
“ADMIN_COPY_SCHEMA procedure - Copy a SYSPROC This procedure is used to copy a specific
specific schema and its objects” on page 648 schema and all objects contained in it.
“ADMIN_DROP_SCHEMA procedure - Drop a SYSPROC This procedure is used to drop a specific
specific schema and its objects” on page 652 schema and all objects contained in it.
“ADMINTABINFO administrative view and SYSIBMADM This administrative view and table function
ADMIN_GET_TAB_INFO_V95 table function - (administrative view), return size and state information for tables,
Retrieve size and state information for tables” SYSPROC (table materialized query tables (MQT) and
on page 199 function) hierarchy tables.
SYSPROC This procedure alters an existing table
“ALTOBJ” on page 654 using the input CREATE TABLE statement
as the target table definition.
SYSFUN This scalar function returns the application
“APPLICATION_ID” on page 656
ID of the current connection.
“COMPILATION_ENV table function - Retrieve SYSPROC This table function returns the elements of
compilation environment elements” on page a compilation environment.
657
“CONTACTGROUPS administrative view - SYSIBMADM This administrative view returns the list of
Retrieve the list of contact groups” on page 659 contact groups.
“CONTACTS administrative view - Retrieve list SYSIBMADM This administrative view returns the list of
of contacts” on page 660 contacts defined on the database server.
SYSIBMADM This administrative view returns
“DB_HISTORY administrative view - Retrieve information from the history file that is
history file information” on page 661 associated with the currently connected
database partition.
SYSIBMADM This administrative view returns the values
“DBPATHS administrative view - Retrieve
for database paths required for tasks such
database paths” on page 665
as split mirror backups.
SYSPROC This new scalar function is used to display
formatted statistics information which is
“EXPLAIN_FORMAT_STATS” on page 668
parsed and extracted from explain snapshot
captured for a given query.
The schema is the This table function queries the
same as the Explain EXPLAIN_DIAGNOSTIC and
“EXPLAIN_GET_MSGS” on page 673
table schema. EXPLAIN_DIAGNOSTIC_DATA Explain
tables, and returns formatted messages.
SYSPROC This procedure calculates the database size
“GET_DBSIZE_INFO” on page 675
and maximum capacity.
SYSPROC The function returns log records, event
“PD_GET_DIAG_HIST - Return records from a
records and notification records from a
given facility” on page 678
given facility.
“NOTIFICATIONLIST administrative view - SYSIBMADM This administrative view returns the list of
Retrieve contact list for health notification” on contacts and contact groups that are
page 677 notified about the health of an instance.
18 Administrative Routines and Views
Table 16. Miscellaneous administrative SQL routines and views (continued)
Routine or view name Schema Description
SYSIBMADM This administrative view and table function
“PDLOGMSGS_LAST24HOURS administrative
(administrative view), return problem determination log messages
view and PD_GET_LOG_MSGS table function
SYSPROC (table that were logged in the DB2 notification
– Retrieve problem determination messages”
function) log. The information is intended for use by
on page 685
database and system administrators.
“REORGCHK_IX_STATS procedure – Retrieve SYSPROC This procedure checks index statistics to
index statistics for reorganization evaluation” determine whether or not there is a need
on page 692 for reorganization.
“REORGCHK_TB_STATS procedure – Retrieve SYSPROC This procedure checks table statistics to
table statistics for reorganization evaluation” on determine whether or not there is a need
page 694 for reorganization.
SYSPROC This scaler function has two versions. The
first allows for full flexibility of message
retrieval including using message tokens
“SQLERRM scalar functions - Retrieves error
and language selection. The second is a
message information” on page 695
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
“SYSINSTALLOBJECTS” on page 698 database objects that are required for a
specific tool.
Activity monitor routines
AM_BASE_RPT_RECOMS – Recommendations for activity
reports
The AM_BASE_RPT_RECOMS table function returns recommendations for activity
reports used by the activity monitor.
Syntax
AM_BASE_RPT_RECOMS ( report-id , client-locale )
The schema is SYSPROC.
Table function parameters
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
EXECUTE privilege on the AM_BASE_RPT_RECOMS table function.
Chapter 3. Supported routines and views 19
Examples
Example 1: Request recommendations (in English) for the activity 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 monitor report
with an ID of 12.
SELECT *
FROM TABLE(SYSPROC.AM_BASE_RPT_RECOMS(12, CAST(’Fr_FR’ AS VARCHAR(33))))
AS RECOMS
Information returned
Table 17. 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 monitor reports
The AM_BASE_RPTS table function returns activity reports used by the activity
monitor.
Syntax
AM_BASE_RPTS ( report-id , type , client-locale )
The schema is SYSPROC.
Table function parameters
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
20 Administrative Routines and Views
’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
An input argument of type VARCHAR(33) that specifies a client language
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
EXECUTE privilege on the AM_BASE_RPTS table function.
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’
Information returned
Table 18. Information returned by the AM_BASE_RPTS table function
Column name Data type Description
ID INTEGER The unique report ID.
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.
Syntax
AM_DROP_TASK ( task-id )
The schema is SYSPROC.
Chapter 3. Supported routines and views 21
Procedure parameter
task-id
An input argument of type INTEGER that specifies a unique monitoring task
ID.
Authorization
EXECUTE privilege on the AM_DROP_TASK procedure.
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 )
The schema is SYSPROC.
Procedure paramater
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)
Information returned
The procedure returns a table as shown below. Each row of the 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 19. 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.
22 Administrative Routines and Views
Table 19. Information returned by the AM_GET_LOCK_CHN_TB procedure (continued)
Column name Data Type Description
AGENT_ID BIGINT The agent ID of the application
waiting for the lock.
APPL_NAME VARCHAR(255) The name of the application
waiting for the lock.
AUTH_ID VARCHAR(128) The authorization ID of the
application waiting for the lock.
APPL_ID VARCHAR(64) The application ID of the
application waiting for the lock.
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
AM_GET_LOCK_CHNS ( agent-id , lock-chains )
The schema is SYSPROC.
Procedure parameters
agent-id
An input argument of type BIGINT that specifies the agent ID of the
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,?)
Value of output parameters
--------------------------
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
Chapter 3. Supported routines and views 23
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 )
The schema is SYSPROC.
Procedure parameter
agent-id
An input argument of type BIGINT that specifies the agent ID of the
application whose lock details are to be returned.
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.
Information returned
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 20. General application information returned by the AM_GET_LOCK_RPT procedure
Column name Data Type Description
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
APPL_NAME VARCHAR(256) appl_name - Application name
AUTH_ID VARCHAR(128) auth_id - Authorization ID
APPL_ID VARCHAR(128) appl_id - Application ID
24 Administrative Routines and Views
Table 20. 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.
This interface returns a text
identifier based on the defines in
sqlmon.h, and is one of:
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_PARTITION_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 client_pid - Client process ID
Chapter 3. Supported routines and views 25
Table 20. General application information returned by the AM_GET_LOCK_RPT
procedure (continued)
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
26 Administrative Routines and Views
Table 20. General application information returned by the AM_GET_LOCK_RPT
procedure (continued)
Column name Data Type Description
CLIENT_PROTOCOL VARCHAR(10) client_protocol - Client
communication protocol. This
interface returns a text identifier
based on the defines in sqlmon.h,
v CPIC
v LOCAL
v NETBIOS
v NPIPE
v TCPIP (for DB2 Universal
Database™, or DB2 UDB)
v TCPIP4
v TCPIP6
CLIENT_NNAME VARCHAR(128) The client_nname monitor element
is deprecated. The value returned is
not a valid value.
LOCKS_HELD BIGINT locks_held - Locks held
LOCK_WAIT_START_TIME TIMESTAMP lock_wait_start_time - Lock wait
start timestamp
LOCK_WAIT_TIME BIGINT lock_wait_time - Time waited on
locks
LOCK_WAITS BIGINT lock_waits - Lock waits
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 deadlocks - Deadlocks detected
Table 21. Locks held information returned by the AM_GET_LOCK_RPT procedure
Column name Data Type Description
TBSP_NAME VARCHAR(128) tablespace_name - Table space
name
TABSCHEMA VARCHAR(128) table_schema - Table schema name
TABNAME VARCHAR(128) table_name - Table name
Chapter 3. Supported routines and views 27
Table 21. Locks held information returned by the AM_GET_LOCK_RPT
procedure (continued)
Column name Data Type Description
LOCK_OBJECT_TYPE VARCHAR(18) lock_object_type - Lock object type
waited on. This interface returns a
text identifier based on the defines
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
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
28 Administrative Routines and Views
Table 21. Locks held information returned by the AM_GET_LOCK_RPT
procedure (continued)
Column name Data Type Description
LOCK_STATUS VARCHAR(10) lock_status - Lock status. This
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v CONV
v GRNT
LOCK_ESCALATION SMALLINT lock_escalation - Lock escalation
LOCK_NAME VARCHAR(32) lock_name - Lock name
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
Table 22. 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
LOCK_WAIT_START_TIME TIMESTAMP lock_wait_start_time - Lock wait
start timestamp
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
TBSP_NAME VARCHAR(128) tablespace_name - Table space
name
TABSCHEMA VARCHAR(128) table_schema - Table schema name
TABNAME VARCHAR(128) table_name - Table name
Chapter 3. Supported routines and views 29
Table 22. Locks wait information returned by the AM_GET_LOCK_RPT
procedure (continued)
Column name Data Type Description
LOCK_OBJECT_TYPE VARCHAR(18) lock_object_type - Lock object type
waited on. This interface returns a
text identifier based on the defines
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
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
30 Administrative Routines and Views
Table 22. Locks wait information returned by the AM_GET_LOCK_RPT
procedure (continued)
Column name Data Type Description
LOCK_MODE_REQUESTED VARCHAR(10) lock_mode_requested - Lock mode
requested. This interface returns a
text identifier based on the defines
in sqlmon.h and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
LOCK_ESCALATION SMALLINT lock_escalation - Lock escalation
AM_GET_RPT – Retrieve activity monitor data
The AM_GET_RPT procedure returns activity monitor data for a report.
Syntax
AM_GET_RPT ( database partition , report-id , appl-filter ,
max-number )
The schema is SYSPROC.
Procedure parameters
database 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 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.
max-number
An input argument of type INTEGER that specifies the maximum number of
Chapter 3. Supported routines and views 31
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 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 Activity Monitor graphical tool. To build reports that can be parsed,
snapshot administrative SQL routines and views should be used instead.
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 )
The schema is SYSPROC.
Procedure parameters
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.
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.
32 Administrative Routines and Views
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
EXECUTE privilege on the AM_SAVE_TASK procedure.
Example
Example:
CALL SYSPROC.AM_SAVE_TASK(’M’,11,’Task ABC’,CAST (NULL AS CLOB(32K)),
’N’,’1,2,4,8,9,12’)
ADMIN_CMD procedure and associated routines
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
EXECUTE privilege on the ADMIN_CMD procedure.
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 DESCRIBE
v DROP CONTACT
v DROP CONTACTGROUP
v EXPORT
v FORCE APPLICATION
Chapter 3. Supported routines and views 33
v IMPORT
v 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 SET TAPE POSITION
v UNQUIESCE DATABASE
v UPDATE ALERT CONFIGURATION
v UPDATE CONTACT
v 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 DBPARTITIONNUM
v UPDATE STMM TUNING DBPARTITIONNUM
Usage notes
Retrieving command execution information:
v Since the ADMIN_CMD procedure runs on the server, the utility messages are
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
34 Administrative Routines and Views
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 23. SQLCODE and information returned by the ADMIN_CMD procedure
Administrative command MESSAGES ON SERVER MESSAGES ON SERVER
execution status option specified option not specified
Successful The SQLCODE returned is The SQLCODE returned is
>= 0: Additional information >= 0: Additional information
(result sets) returned, if any. (result sets) returned, if any,
but the MSG_RETRIEVAL
and MSG_REMOVAL
columns are NULL.
Failed The SQLCODE returned The SQLCODE returned is <
20397: Additional 0: No additional information
information (result sets) (result sets) is returned.
returned, but only the
MSG_RETRIEVAL and
MSG_REMOVAL columns
are populated.
v The result sets can be retrieved from the CLP or from applications such as JDBC
and DB2 CLI applications, but not from embedded C applications.
For all commands executed through the ADMIN_CMD, the user ID that
established the connection to the database is used for authentication.
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
The command 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
Chapter 3. Supported routines and views 35
ADD CONTACT name TYPE EMAIL
PAGE
MAXIMUM PAGE LENGTH pg-length
MAX LEN
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 wishes to be notified by e-mail at (ADDRESS).
PAGE This contact wishes 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 e-mail or call the pager.
ADDRESS recipients-address
The SMTP mailbox address of the recipient. For example,
[email protected]. 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 e-mail address ’[email protected]’.
CALL SYSPROC.ADMIN_CMD
(’add contact testuser type email address [email protected]’)
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
36 Administrative Routines and Views
the Scheduler and Health Monitor can 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 CONTACTGROUP name CONTACT name
GROUP
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.
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
The DAS must have been created and be running.
Command execution status is returned in the SQLCA resulting from the CALL
statement.
Chapter 3. Supported routines and views 37
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 recommended values.
Authorization
sysadm
Required connection
Database
Command syntax
AUTOCONFIGURE
USING input-keyword param-value
APPLY DB ONLY
DB AND DBM ON CURRENT NODE
NONE
Command parameters
USING input-keyword param-value
Table 24. Valid input keywords and parameter values
Keyword Valid values Default value Explanation
mem_percent 1–100 25 Percentage of
memory to dedicate.
If other applications
(other than the
operating system) are
running on this
server, set this to less
than 100.
workload_type simple, mixed, mixed Simple workloads
complex 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
38 Administrative Routines and Views
Table 24. Valid input keywords and parameter values (continued)
Keyword Valid values Default value Explanation
admin_priority performance, both Optimize for better
recovery, both 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 0 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 yes Are buffer pools
resizeable?
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 NODE
In the Database Partitioning Feature (DPF), the Configuration Advisor
updates the database configuration on all nodes by default. Running with
the ON CURRENT NODE option makes the advisor apply the
recommended database configuration to the coordinator (connection) node
only.
The bufferpool changes are always applied to the system catalogs. Thus, all
nodes are affected. The ON CURRENT NODE option does not matter for
bufferpool recommendations.
Chapter 3. Supported routines and views 39
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 NAME VALUE RECOMMENDED_VALUE DATATYPE
-----...- ----------------...- -------...- ------------------ --------...-
DBM ASLHEAPSZ 15 15 BIGINT
DBM FCM_NUM_BUFFERS 512 512 BIGINT
...
DB APP_CTL_HEAP_SZ 128 144 INTEGER
DB APPGROUP_MEM_SZ 20000 14559 BIGINT
...
BP IBMDEFAULTBP 1000 164182 BIGINT
Usage notes
v On systems with multiple logical partitions, the mem_percent parameter refers
to the percentage of memory that is to be used by all logical partitions. For
example, if DB2 uses 25% of the memory on the system, specify 25% regardless
of the number of logical partitions. The database configuration recommendations
made, however, will be adjusted for one logical partition.
v This command makes configuration recommendations for the currently
connected database, assuming that the database is the only active database on
the system. If more than one database is active on the system, adjust the
mem_percent parameter to reflect the current database’s share of memory. For
example, if the DB2 database uses 80% of the system’s memory and there are
two active databases on the system that should share the resources equally,
specify 40% (80% divided by 2 databases) for the parameter mem_percent.
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.
v Command execution status is returned in the SQLCA resulting from the CALL
statement.
v SQL executed in the ADMIN_CMD procedure on behalf of AUTOCONFIGURE
is monitored by Query Patroller.
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.
Result set information
Command execution status is returned in the SQLCA resulting from the CALL
statement. If execution is successful, the command returns additional information
the following result set:
40 Administrative Routines and Views
Table 25. 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 bufferpool 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 prior to 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 bufferpool
identified in the NAME column
prior to 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
bufferpool.
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
bufferpool 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.
Chapter 3. Supported routines and views 41
For information on 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 node. 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:
v sysadm
v sysctrl
v sysmaint
Required connection
Database. The existing database connection remains after the completion of the
backup operation.
Command syntax
BACKUP DATABASE database-alias
DB
ON DBPARTITIONNUM Partition number(s)
DBPARTITIONNUMS
ALL DBPARTITIONNUMS
EXCEPT DBPARTITIONNUM Partition number(s)
DBPARTITIONNUMS
ONLINE
, INCREMENTAL
DELTA
TABLESPACE ( tablespace-name )
USE TSM Open sessions Options WITH num-buffers BUFFERS
XBSA
SNAPSHOT
LIBRARY library-name
LOAD library-name Open sessions Options
,
TO dir
dev
BUFFER buffer-size PARALLELISM n
42 Administrative Routines and Views
COMPRESS
COMPRLIB name COMPROPTS string
EXCLUDE
EXCLUDE LOGS WITHOUT PROMPTING
UTIL_IMPACT_PRIORITY INCLUDE LOGS
priority
Partition number(s):
( db-partition-number1 )
TO db-partition-number2
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.
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.
Chapter 3. Supported routines and views 43
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.
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 non-cumulative (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.
USE
TSM Specifies that the backup is to use Tivoli® Storage Manager (TSM)
output.
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.
SNAPSHOT
Specifies that a snapshot backup is to be taken.
You cannot use the SNAPSHOT parameter with any of the
following parameters:
v TABLESPACE
v INCREMENTAL
v WITH num-buffers BUFFERS
v BUFFER
v PARALLELISM
v 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 Data Server is a DB2 ACS API driver
for the following storage hardware:
v IBM TotalStorage SAN Volume Controller
44 Administrative Routines and Views
v IBM Enterprise Storage Server Model 800
v IBM System Storage DS6000
v IBM System Storage DS8000
v IBM System Storage N Series
v NetApp V-series
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.
OPTIONS
″options-string″
Specifies options to be used for the backup operation. The string
will be passed to the DB2 ACS API driver exactly as it was
entered, without the double quotation marks. 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.
@ 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.
OPEN num-sessions SESSIONS
The number of I/O sessions to be created between DB2 and TSM or
another backup vendor product. This parameter has no effect when
backing up to tape, disk, or other local device.
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
exist 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.
Chapter 3. Supported routines and views 45
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.
WITH num-buffers BUFFERS
The number of buffers to be used. DB2 will automatically choose an
optimal value for this parameter unless you explicitly enter a value.
However, when creating a backup to multiple locations, a larger number of
buffers can be used to improve performance.
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.
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 DB2’s default buffer size 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 (e.g., db2compr.dll for Windows; libdb2compr.so for
Linux/UNIX 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.
46 Administrative Routines and Views
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
performing an offline backup operation, logs are excluded whether or not
this option is specified, with the exception of snapshot backups.
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 where this option is the default unless explicitly told to
exclude.
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 mid-week cumulative
(incremental) backup operation:
(Sun) CALL SYSPROC.ADMIN_CMD(’backup db sample online use tsm’)
(Mon) CALL SYSPROC.ADMIN_CMD
(’backup db sample online incremental delta use tsm’)
(Tue) CALL SYSPROC.ADMIN_CMD
(’backup db sample online incremental delta use tsm’)
(Wed) CALL SYSPROC.ADMIN_CMD
(’backup db sample online incremental use tsm’)
(Thu) CALL SYSPROC.ADMIN_CMD
(’backup db sample online incremental delta use tsm’)
(Fri) CALL SYSPROC.ADMIN_CMD
(’backup db sample online incremental delta use tsm’)
(Sat) CALL SYSPROC.ADMIN_CMD
(’backup db sample online incremental use tsm’)
Usage notes
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.
Chapter 3. Supported routines and views 47
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.
Snapshot backups should be complemented with regular disk backups in case of
failure in the filer/storage system.
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 on how to manage these recovery objects.
Result set information
Command execution status is returned in the SQLCA resulting from the CALL
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 26. 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
from the backup processing
on the specified database
partition.
SQLERRML SMALLINT Final SQLERRML resulting
from the backup processing
on the specified database
partition.
If a non-partitioned 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.
48 Administrative Routines and Views
DESCRIBE command using the ADMIN_CMD procedure
This command:
v Displays output information about a SELECT, CALL, or XQuery statement
v Displays columns of a table or a view
v Displays indexes of a table or a view
v Displays data partitions of a table or view
Authorization
To display output information about a SELECT statement, one of the privileges or
authorities listed below for each table or view referenced in the SELECT statement
is required.
To display the columns, indexes or data partitions of a table or a view, SELECT
privilege, CONTROL privilege, sysadm authority or dbadm authority is required for
the following system catalogs:
v SYSCAT.COLUMNS (DESCRIBE TABLE), SYSCAT.DATAPARTITIONEXPRESSION
(with SHOW DETAIL)
v SYSCAT.INDEXES (DESCRIBE INDEXES FOR TABLE) execute privilege on
GET_INDEX_COLNAMES() UDF (with SHOW DETAIL)
v SYSCAT.DATAPARTITIONS (DESCRIBE DATA PARTITIONS FOR TABLE)
As PUBLIC has all the privileges over declared global temporary tables, a user can
use the command to display information about any declared global temporary
table that exists within its connection.
To display output information about a CALL statement, one of the privileges or
authorities listed below is required:
v EXECUTE privilege on the stored procedure
v sysadm or dbadm authority
Required connection
Database
Command syntax
OUTPUT
DESCRIBE select-statement
call-statement
XQUERY XQuery-statement
TABLE table-name
INDEXES FOR TABLE SHOW DETAIL
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
Chapter 3. Supported routines and views 49
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
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.
The DESCRIBE TABLE command lists the following information about
each column:
v Column name
v Type schema
v Type name
v Length
v Scale
v Nulls (yes/no)
INDEXES FOR TABLE table-name
Specifies the table or view for which indexes need to be described. 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 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 Column count
For the DESCRIBE INDEXES FOR TABLE command, the index name is
truncated when the index name is greater than 18 bytes. The output
includes the following additional information:
v Column names
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
50 Administrative Routines and Views
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 Default
v Table partitioning type (for tables partitioned by range this output
appears below the original output)
v Partitioning key columns (for tables partitioned by range this output
appears below 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 SQLTYPE SQLLENGTH SQLSCALE SQLNAME_DATA ...
---------- ---------..- --------- -------- ------------..- ...
452 CHARACTER 6 0 EMPNO ...
448 VARCHAR 10 0 PHOTO_FORMAT ...
405 BLOB 102400 0 PICTURE ...
...
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 TYPENAME FOR_BINARY_DATA ...
-------...- ----------...- --------...- ---------------...- ...
Chapter 3. Supported routines and views 51
DEPTNUMB SYSIBM SMALLINT N ...
DEPTNAME SYSIBM VARCHAR N ...
MANAGER SYSIBM SMALLINT N ...
DIVISION SYSIBM VARCHAR N ...
LOCATION SYSIBM VARCHAR N ...
5 record(s) selected.
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 -
Output for this CALL statement (continued).
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’)
The following is an example of output for this CALL statement.
Result set 1
--------------
COLNAME TYPESCHEMA TYPENAME FOR_BINARY_DATA ...
-------...- ----------...- -------- --------------- ...
COL1 SYSIBM INTEGER N ...
1 record(s) selected.
Output for this CALL statement (continued).
... LENGTH SCALE NULLABLE COLNO PARTKEYSEQ CODEPAGE DEFAULT
... ------ ----- -------- ----- ---------- -------- -------
... 4 0 N 0 1 0 -
Output for this CALL statement (continued).
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.
CALL SYSPROC.ADMIN_CMD(’describe indexes for table t1’)
The following is an example of output for this CALL statement.
52 Administrative Routines and Views
Result set 1
--------------
INDSCHEMA INDNAME UNIQUE_RULE NUMBER_OF_COLUMNS COLNAMES
---------..- ------------------ ------------------ ----------------- -------------
SYSIBM SQL050117181625680 PRIMARY_INDEX 1 +PK
TXU T1_INDEX1 DUPLICATES_ALLOWED 1 +C1
2 record(s) selected.
Return Status = 0
Describing a data partition
The following example shows how to describe data partitions.
CALL SYSPROC.ADMIN_CMD(’describe data partitions for table part_table2’)
The following is an example of output for this CALL statement.
Result set 1
--------------
DATA_PARTITION_ID LOW_KEY_INCLUSIVE LOW_KEY_VALUE ...
----------------- ----------------- ------------- ...
0 Y 1 ...
1 Y 10 ...
2 Y 20 ...
3 record(s) selected.
Output for this CALL statement (continued).
... HIGH_KEY_INCLUSIVE HIGH_KEY_VALUE
... ------------------ --------------
... N 10
... N 20
... N 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’)
The following is an example of output for this CALL statement.
Result set 1
--------------
DATA_PARTITION_ID LOW_KEY_INCLUSIVE LOW_KEY_VALUE ...
----------------- ----------------- ------------- ...
0 Y 1 ...
1 Y 10 ...
2 Y 20 ...
3 record(s) selected.
Return Status = 0
Output for this CALL statement (continued).
... HIGH_KEY_INCLUSIVE HIGH_KEY_VALUE
... ------------------ --------------
... N 10
... N 20
... N 40
Chapter 3. Supported routines and views 53
Output for this CALL statement (continued).
Result set 2
--------------
DATA_PARTITION_ID DATA_PARTITION_NAME TBSPID ...
----------------- ------------------- ------ ...
0 PART0 3 ...
1 PART1 3 ...
2 PART2 3 ...
3 record(s) selected.
Return Status = 0
Output for this CALL statement (continued).
... 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.
Result set information
Command execution status is returned in the SQLCA resulting from the CALL
statement. If execution is successful, the commands return additional information
in result sets as follows:
v Table 27: DESCRIBE select-statement, DESCRIBE call-statement and DESCRIBE
XQUERY XQuery-statement commands
v Table 28 on page 55: Result set 1 for the DESCRIBE TABLE command
v Table 29 on page 56: Result set 2 for the DESCRIBE TABLE command
v Table 30 on page 56: DESCRIBE INDEXES FOR TABLE command
v Table 31 on page 57: Result set 1 for the DESCRIBE DATA PARTITIONS FOR
TABLE command
v Table 32 on page 57: Result set 2 for the DESCRIBE DATA PARTITIONS FOR
TABLE command
Table 27. 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 No Data type corresponding to
(257) the SQLTYPE_ID value.
SQLLEN INTEGER No Length attribute of the
column, as it appears in the
SQLLEN field of the SQLDA.
54 Administrative Routines and Views
Table 27. 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
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 No Name of the column.
(128)
SQLNAME_LENGTH SMALLINT No Length of the column name.
SQLDATA_TYPESCHEMA VARCHAR Yes Data type schema name.
(128)
SQLDATA_TYPENAME VARCHAR Yes Data type name.
(128)
Note: 1: Yes indicates that non-null values are returned only when there is LOB
data being described.
Table 28. Result set 1 returned by the DESCRIBE TABLE command
Column name Data type Detail2 Description
COLNAME VARCHAR No Column name.
(128)
TYPESCHEMA VARCHAR No If the column name is
(128) distinct, the schema name is
returned, otherwise,
’SYSIBM’ is returned.
TYPENAME VARCHAR No Name of the column type.
(128)
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.
Chapter 3. Supported routines and views 55
Table 28. 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 Yes Default value for the column
(254) 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 29. 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 30. Result set returned by the DESCRIBE INDEXES FOR TABLE command
Column name Data type Detail2 Description
INDSCHEMA VARCHAR No Index schema name.
(128)
INDNAME VARCHAR No Index name.
(128)
UNIQUE_RULE VARCHAR No One of:
(30) v DUPLICATES_ALLOWED
v PRIMARY_INDEX
v
UNIQUE_ENTRIES_ONLY
COLCOUNT SMALLINT No Number of columns in the
key, plus the number of
include columns, if any.
COLNAMES VARCHAR Yes List of the column names,
(2048) each preceded with a + to
indicate ascending order or a
- to indicate descending
order.
56 Administrative Routines and Views
Note: 2: Yes indicates that non-null values are returned only when the SHOW
DETAIL clause is used.
Table 31. 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 No Low key value for this data
(512) partition.
HIGH_KEY_INCLUSIVE CHAR (1) No ’Y’ if the high key value is
inclusive, otherwise, ’N’.
HIGH_KEY_VALUE VARCHAR No High key value for this data
(512) partition.
Note: 2: Yes indicates that non-null values are returned only when the SHOW
DETAIL clause is used.
Table 32. 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.
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
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.
Chapter 3. Supported routines and views 57
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
Database. The DAS must be running.
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
The DAS must have been created and be running.
Command execution status is returned in the SQLCA resulting from the CALL
statement.
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
Database. The DAS must be running.
Command Syntax
58 Administrative Routines and Views
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
The DAS must have been created and be running.
Command execution status is returned in the SQLCA resulting from the CALL
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 65.
Authorization
One of the following:
v sysadm
v dbadm
or CONTROL or SELECT privilege on each participating table or view.
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 TO xml-path
Chapter 3. Supported routines and views 59
,
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
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.
HIERARCHY STARTING sub-table-name
Using the default traverse order (OUTER order for ASC, DEL, or WSF files,
or the order stored in PC/IXF data files), export a sub-hierarchy starting
from sub-table-name.
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. The
maximum number of file names that can be specified is 999. 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 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.
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,
60 Administrative Routines and Views
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.
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.
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.
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 WSF and IXF files, but is not valid when
exporting hierarchical data.
MODIFIED BY filetype-mod
Specifies file type modifier options. See “File type modifiers for the export
utility” on page 65.
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.
v WSF (work sheet format), which is used by programs such as:
– Lotus® 1-2-3®
– Lotus Symphony
When exporting BIGINT or DECIMAL data, only values that fall within
the range of type DOUBLE can be exported accurately. Although values
that do not fall within this range are also exported, importing or loading
these values back might result in incorrect data, depending on the
operating system.
v IXF (Integration Exchange Format, PC version) is a proprietary binary
format.
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.
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.
Chapter 3. Supported routines and views 61
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.
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.
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.
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.
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.
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.
62 Administrative Routines and Views
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 The export utility produces a warning message whenever a character column
with a length greater than 254 is selected for export to DEL format files.
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 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
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.
Chapter 3. Supported routines and views 63
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
3 record(s) selected.
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
Result set information
Command execution status is returned in the SQLCA resulting from the CALL
statement. If execution is successful, the command returns additional information
in result sets as follows:
Table 33. 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 by this utility. For
example:
CALL SYSPROC.ADMIN_REMOVE_MSGS
(’3203498_txu’)
64 Administrative Routines and Views
File type modifiers for the export utility
Table 34. 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/.
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 codepage. 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, 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 35. 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’’
Chapter 3. Supported routines and views 65
Table 35. Valid file type modifiers for the export utility: DEL (delimited ASCII) file format (continued)
Modifier Description
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
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.
66 Administrative Routines and Views
Table 35. 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)
M - 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)
D - Day (one or two digits ranging from 1 - 31)
DD - Day (two digits ranging from 1 - 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 0 - 12
for a 12 hour system, and 0 - 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 0 - 59;
mutually exclusive with M, minute)
S - Second (one or two digits ranging from 0 - 59)
SS - Second (two digits ranging from 0 - 59;
mutually exclusive with S)
SSSSS - Second of the day after midnight (5 digits
ranging from 00000 - 86399; mutually
exclusive with other time elements)
UUUUUU - Microsecond (6 digits ranging from 000000 - 999999;
mutually exclusive with all other microsecond elements)
UUUUU - Microsecond (5 digits ranging from 00000 - 99999,
maps to range from 000000 - 999990;
mutually exclusive with all other microseond elements)
UUUU - Microsecond (4 digits ranging from 0000 - 9999,
maps to range from 000000 - 999900;
mutually exclusive with all other microseond elements)
UUU - Microsecond (3 digits ranging from 000 - 999,
maps to range from 000000 - 999000;
mutually exclusive with all other microseond elements)
UU - Microsecond (2 digits ranging from 00 - 99,
maps to range from 000000 - 990000;
mutually exclusive with all other microseond elements)
U - Microsecond (1 digit ranging from 0 - 9,
maps to range from 000000 - 900000;
mutually exclusive with all other microseond elements)
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
Chapter 3. Supported routines and views 67
Table 36. Valid file type modifiers for the export utility: IXF file format
Modifier Description
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 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. The codepage modifier cannot be used with the
lobsinfile modifier.
Table 37. Valid file type modifiers for the export utility: WSF file format
Modifier Description
1 Creates a WSF file that is compatible with Lotus 1-2-3 Release 1, or Lotus 1-2-3
Release 1a.5 This is the default.
2 Creates a WSF file that is compatible with Lotus Symphony Release 1.0.5
3 Creates a WSF file that is compatible with Lotus 1-2-3 Version 2, or Lotus
Symphony Release 1.1.5
4 Creates a WSF file containing DBCS characters.
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. These files can also be directed to a specific product by specifying an L for
Lotus 1-2-3, or an S for Symphony in the filetype-mod parameter string. Only
one value or product designator can be specified.
68 Administrative Routines and Views
6. The WSF file format is not supported for XML columns.
7. 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.
8. 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.
9. By default, all XDM instances are written in Unicode unless the XMLCHAR or
XMLGRAPHIC file type modifier is specified.
10. 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
, 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.
11. 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 zeroes (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
.
12. 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
Chapter 3. Supported routines and views 69
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 node (database partition server) in the partitioned database
environment.
Authorization
One of the following:
v sysadm
v sysctrl
v sysmaint
Required connection
Database
Command syntax
FORCE APPLICATION ALL
, MODE ASYNC
( application-handle )
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
70 Administrative Routines and Views
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
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.
Command execution status is returned in the SQLCA resulting from the CALL
statement.
GET STMM TUNING DBPARTITIONNUM command using the
ADMIN_CMD procedure
Used to read the catalog tables to report the user preferred self tuning memory
manager (STMM) tuning database partition number and current STMM tuning
database partition number.
Authorization
SYSADM or DBADM authority
Required connection
Database
Command syntax
GET STMM TUNING DBPARTITIONNUM
Chapter 3. Supported routines and views 71
Example
CALL SYSPROC.ADMIN_CMD( ’get stmm tuning dbpartitionnum’ )
The following is an example of output from this query.
Result set 1
--------------
USER_PREFERRED_NUMBER CURRENT_NUMBER
--------------------- --------------
2 2
1 record(s) selected.
Return Status = 0
Usage notes
The user preferred self tuning memory manager (STMM) tuning database partition
number (USER_PREFERRED_NUMBER) is set by the user and specifies the
database partition on which the user wishes to run the memory tuner. While the
database is running, the tuning partition is updated asynchronously a few times an
hour. As a result, it is possible that the CURRENT_NUMBER and
USER_PREFERRED_NUMBER returned are not in sync after an update of the user
preferred STMM partition number. 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.
Result set information
Command execution status is returned in the SQLCA resulting from the CALL
statement. If execution is successful, the command returns additional information
in the following result set:
Table 38. Result set returned by the GET STMM TUNING DBPARTITIONNUM command
Column name Data type Description
USER_PREFERRED_NUMBER INTEGER User preferred self tuning memory
manager (STMM) tuning database
partition number. A value of -1
indicates that the default database
partition is used.
CURRENT_NUMBER INTEGER Current STMM tuning database
partition number. A value of -1
indicates that the default database
partition 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 86.
Authorization
v IMPORT using the INSERT option requires one of the following:
– sysadm
72 Administrative Routines and Views
– dbadm
– 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:
– sysadm
– dbadm
– 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:
– sysadm
– dbadm
– CONTROL privilege on the table or view
– 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:
– sysadm
– dbadm
– 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:
– sysadm
– dbadm
– 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
following:
– sysadm
– dbadm
– 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:
Chapter 3. Supported routines and views 73
– 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.
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
IMPORT FROM filename OF filetype
, ,
LOBS FROM lob-path XML FROM xml-path
MODIFIED BY filetype-mod
,
METHOD L ( column-start column-end )
,
NULL INDICATORS ( null-indicator-list )
,
N ( column-name )
,
P ( column-position )
XMLPARSE STRIP WHITESPACE
PRESERVE
ALLOW NO ACCESS
XMLVALIDATE USING XDS Ignore and Map parameters ALLOW WRITE ACCESS
DEFAULT schema-sqlid
SCHEMA schema-sqlid
SCHEMALOCATION HINTS
COMMITCOUNT n RESTARTCOUNT n ROWCOUNT n WARNINGCOUNT n NOTIMEOUT
AUTOMATIC SKIPCOUNT
MESSAGES ON SERVER
INSERT INTO table-name
INSERT_UPDATE ,
REPLACE
REPLACE_CREATE ( insert-column )
hierarchy description
CREATE INTO table-name tblspace-specs
,
( insert-column )
hierarchy description AS ROOT TABLE
UNDER sub-table-name
74 Administrative Routines and Views
Ignore and Map parameters:
,
IGNORE ( schema-sqlid )
,
MAP ( ( schema-sqlid , schema-sqlid ) )
hierarchy description:
ALL TABLES
sub-table-list HIERARCHY STARTING sub-table-name
IN traversal-order-list
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
ALL TABLES
An implicit keyword for hierarchy only. When importing a hierarchy, the
default is to import all tables specified in the traversal order.
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.
Chapter 3. Supported routines and views 75
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).
AS ROOT TABLE
Creates one or more sub-tables as a stand-alone table hierarchy.
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
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.
If the IMPORT command encounters an SQL0964C (Transaction Log Full)
while inserting or updating a record and the COMMITCOUNT n is
specified, IMPORT will attempt to resolve the issue by performing an
unconditional commit and then reattempt to insert or update the record. If
this does not help resolve the log full condition (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. The
RESTARTCOUNT or SKIPCOUNT option can be used to avoid processing
those row already committed.
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.
This parameter is not valid when you import to a nickname.
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.
76 Administrative Routines and Views
DEFAULT schema-sqlid
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.
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.
HIERARCHY
Specifies that hierarchical data is to be imported.
IGNORE schema-sqlid
This option can only be used when the USING XDS parameter is specified.
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 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.
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
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.
insert-column
Specifies the name of a column in the table or the view into which data is
to be inserted.
INSERT
Adds the imported data to the table without changing the existing table
data.
Chapter 3. Supported routines and views 77
INSERT_UPDATE
Adds rows of imported data to the target table, or updates existing rows
(of the target table) with matching primary keys.
INTO table-name
Specifies the database table into which the data is to be imported. This
table cannot be a system 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.
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.
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.
MAP schema-sqlid
This option can only be used when the USING XDS parameter is specified.
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.
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
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.
78 Administrative Routines and Views
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.
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.
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.
N 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.
P Specifies the field numbers of the input data fields to be imported.
Note: This method can only be used with IXF or DEL files, and is
the only valid option for the DEL file type.
MODIFIED BY filetype-mod
Specifies file type modifier options. See “File type modifiers for the import
utility” on page 86.
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.
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.
Chapter 3. Supported routines and views 79
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 WSF (work sheet format), which is used by programs such as:
– Lotus 1-2-3
– Lotus Symphony
v IXF (Integration Exchange Format, PC version) is a binary format that is
used exclusively by DB2.
The WSF file type is not supported when you import to a nickname.
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 parameter is not valid when you import to a nickname.
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.
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 recreate it, then invoke the import with INSERT
statement.
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.
This parameter is not valid when you import to a nickname.
80 Administrative Routines and Views
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.
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.
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.
STARTING sub-table-name
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.
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.
traversal-order-list
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.
UNDER sub-table-name
Specifies a parent table for creating one or more sub-tables.
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 desired. If the import file or the target table is specified
incorrectly, the import utility will generate a warning for each row that it
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.
XML FROM xml-path
Specifies one or more paths that contain the XML files.
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.
Chapter 3. Supported routines and views 81
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 below.
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 node 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.
82 Administrative Routines and Views
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 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.
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. If automatic COMMITs are not performed, a full log results
in a ROLLBACK.
Offline import does not perform automatic COMMITs if any of the following
conditions is true:
v the target is a view, not a table
v compound inserts are used
v buffered inserts are used
By default, online import performs automatic COMMITs 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.
Chapter 3. Supported routines and views 83
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 recreate 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
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.
The database table or hierarchy must exist before data in the ASC, DEL, or WSF
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,
84 Administrative Routines and Views
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.
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 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 or WSF 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.
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.
Chapter 3. Supported routines and views 85
Some data sources, such as ODBC, do not support importing into nicknames.
Result set information
Command execution status is returned in the SQLCA resulting from the CALL
statement. If execution is successful, the command returns additional information
in result sets as follows:
Table 39. 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 by this utility. For
example:
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 by this utility. For
example:
CALL SYSPROC.ADMIN_REMOVE_MSGS
(’1203498_txu’)
File type modifiers for the import utility
Table 40. 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.
86 Administrative Routines and Views
Table 40. Valid file type modifiers for the import utility: All file formats (continued)
Modifier Description
generatedignore 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.
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 If this modifier is specified, the utility assumes that the input data file contains no
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.
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.
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
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/.
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.
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.
Chapter 3. Supported routines and views 87
Table 40. Valid file type modifiers for the import utility: All file formats (continued)
Modifier Description
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 If this modifier is specified, the utility assumes that the input data file contains no
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.
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/WSF 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
of the following occurs:
v For DEL/ASC/WSF files: If the column is nullable, a NULL is loaded. If the
column is not nullable, the utility rejects the row.
88 Administrative Routines and Views
Table 41. Valid file type modifiers for the import utility: ASCII file formats (ASC/DEL)
Modifier Description
codepage=x x is an ASCII character string. The value is interpreted as the code page of the
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.
dateformat=″x″ x is the format of the date in the source file.2 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 1 - 12;
mutually exclusive with M)
D - Day (one or two digits ranging from 1 - 31)
DD - Day (two digits ranging from 1 - 31;
mutually exclusive with D)
DDD - Day of the year (three digits ranging
from 001 - 366; mutually exclusive
with other day or month elements)
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.
Chapter 3. Supported routines and views 89
Table 41. Valid file type modifiers for the import utility: ASCII file formats (ASC/DEL) (continued)
Modifier Description
timeformat=″x″ x is the format of the time in the source file.2 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 0 - 12
for a 12 hour system, and 0 - 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 0 - 59;
mutually exclusive with M)
S - Second (one or two digits ranging
from 0 - 59)
SS - Second (two digits ranging from 0 - 59;
mutually exclusive with S)
SSSSS - Second of the day after midnight (5 digits
ranging from 00000 - 86399; mutually
exclusive with other time elements)
TT - Meridian indicator (AM or PM)
A default value of 0 is assigned for each element that is not specified. Some
examples of time formats are:
"HH:MM:SS"
"HH.MM TT"
"SSSSS"
90 Administrative Routines and Views
Table 41. Valid file type modifiers for the import utility: ASCII file formats (ASC/DEL) (continued)
Modifier Description
timestampformat=″x″ x is the format of the time stamp in the source file.2 Valid time stamp 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 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 1 - 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 0 - 12
for a 12 hour system, and 0 - 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 0 - 59;
mutually exclusive with M, minute)
S - Second (one or two digits ranging from 0 - 59)
SS - Second (two digits ranging from 0 - 59;
mutually exclusive with S)
SSSSS - Second of the day after midnight (5 digits
ranging from 00000 - 86399; mutually
exclusive with other time elements)
UUUUUU - Microsecond (6 digits ranging from 000000 - 999999;
mutually exclusive with all other microsecond elements)
UUUUU - Microsecond (5 digits ranging from 00000 - 99999,
maps to range from 000000 - 999990;
mutually exclusive with all other microseond elements)
UUUU - Microsecond (4 digits ranging from 0000 - 9999,
maps to range from 000000 - 999900;
mutually exclusive with all other microseond elements)
UUU - Microsecond (3 digits ranging from 000 - 999,
maps to range from 000000 - 999000;
mutually exclusive with all other microseond elements)
UU - Microsecond (2 digits ranging from 00 - 99,
maps to range from 000000 - 990000;
mutually exclusive with all other microseond elements)
U - Microsecond (1 digit ranging from 0 - 9,
maps to range from 000000 - 900000;
mutually exclusive with all other microseond elements)
TT - Meridian indicator (AM or PM)
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:
"YYYY/MM/DD HH:MM:SS.UUUUUU"
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
modified by timestampformat="yyyy.mm.dd hh:mm tt"
insert into schedule
Chapter 3. Supported routines and views 91
Table 41. Valid file type modifiers for the import utility: ASCII file formats (ASC/DEL) (continued)
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 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.
For each document, if a declaration tag exists and contains an encoding attribute,
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
an encoding attribute.
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 42. 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.
92 Administrative Routines and Views
Table 42. 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 43. Valid file type modifiers for the import 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.34 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.
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 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.34
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 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.
Chapter 3. Supported routines and views 93
Table 43. Valid file type modifiers for the import utility: DEL (delimited ASCII) file format (continued)
Modifier Description
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.34
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 44. 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 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.
94 Administrative Routines and Views
Table 44. 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
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.
forcecreate Specifies that the table should be created with possible missing or limited
information after returning SQL3311N during an import operation.
Table 45. 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
unsupported file types with the MODIFIED BY option. If this is attempted, the
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
Chapter 3. Supported routines and views 95
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
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)
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:
... modified by coldel# ...
... modified by coldel0x23 ...
... modified by coldelX23 ...
4. Delimiter considerations for moving data lists restrictions that apply to the
characters that can be used as delimiter overrides.
5. The following file type modifiers are not allowed when importing into a
nickname:
v indexixf
v indexschema
v dldelfiletype
v nodefaults
v usedefaults
v no_type_idfiletype
v generatedignore
v generatedmissing
v identityignore
v identitymissing
v lobsinfile
6. The WSF file format is not supported for XML columns.
7. The CREATE mode is not supported for XML columns.
8. 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.
96 Administrative Routines and Views
9. 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.
10. Rows containing documents that are not well-formed will be rejected.
11. 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 SYSADM or DBADM authority
v USAGE privilege on the XML schema to be used in the validation
12. When importing into a table containing an implicitly hidden row change
timestamp column, the implicitly hidden property of the column is not
honoured. Therefore, the rowchangetimestampmissing file type modifier must
be specified in the import command if data for the column is not present in
the data to be imported and there is no explicit column list present.
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
One of the following:
v sysadm
v sysctrl
v sysmaint
Required connection
Database
Command syntax
INITIALIZE TAPE
ON device USING blksize
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
Chapter 3. Supported routines and views 97
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
Command execution status is returned in the SQLCA resulting from the CALL
statement.
LOAD command using the ADMIN_CMD procedure
Loads data into a DB2 table. Data residing 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 or a different database
under the same instance, or by using a user-written script or application. If the
COMPRESS attribute for the table is set to YES, the data loaded will be subject to
compression on every data and database partition for which a dictionary already
exists in 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.
Scope
This command can be issued against multiple database partitions in a single
request.
Authorization
One of the following:
v sysadm
v dbadm
v LOAD authority on the database and
– 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)
98 Administrative Routines and Views
– 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 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:
– It is part of the security policy protecting the table
– It was granted to the session authorization ID 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. This security label is used to
protect a loaded row if the session authorization ID’s 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.
v If the REPLACE option is specified, the session authorization ID must have the
authority to drop 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
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 OF filetype
pipename ,
device
( query-statement ) LOBS FROM lob-path
( DATABASE database-alias query-statement )
,
XML FROM xml-path MODIFIED BY file-type-mod
Chapter 3. Supported routines and views 99
,
METHOD L ( column-start column-end )
,
NULL INDICATORS ( null-indicator-list )
,
N ( column-name )
,
P ( column-position )
XMLPARSE STRIP WHITESPACE
PRESERVE
XMLVALIDATE USING XDS Ignore and Map parameters SAVECOUNT n
DEFAULT schema-sqlid
SCHEMA schema-sqlid
SCHEMALOCATION HINTS
ROWCOUNT n WARNINGCOUNT n MESSAGES ON SERVER TEMPFILES PATH temp-pathname
INSERT INTO table-name
KEEPDICTIONARY ,
REPLACE
RESETDICTIONARY ( insert-column )
RESTART
TERMINATE
, STATISTICS USE PROFILE
(1) (2) NO
FOR EXCEPTION table-name
NORANGEEXC
NOUNIQUEEXC
WITHOUT PROMPTING
NO
COPY 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 n DISK_PARALLELISM n
YES INDEXING MODE AUTOSELECT
FETCH_PARALLELISM NO REBUILD
INCREMENTAL
DEFERRED
ALLOW NO ACCESS
ALLOW READ ACCESS SET INTEGRITY PENDING CASCADE IMMEDIATE
USE tablespace-name DEFERRED
LOCK WITH FORCE SOURCEUSEREXIT executable Redirect Input/Output parameters
PARALLELIZE
100 Administrative Routines and Views
PARTITIONED DB CONFIG
partitioned-db-option
Ignore and Map parameters:
,
IGNORE ( schema-sqlid )
,
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.
2 Each of these keywords can only appear once.
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 prior to 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, which is defined on the server. It must point to a
database exist on the server, and is a different database that the application
is currently connected to. 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:
Chapter 3. Supported routines and views 101
1. A fully qualified path file name must be used and must exist on the
server.
2. 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.
3. 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. (Multiple physical files
would be considered logically one if they were all created with one
invocation of the EXPORT command.)
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.
v CURSOR (a cursor declared against a SELECT or VALUES statement).
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.
102 Administrative Routines and Views
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 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.
P 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.
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 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
Chapter 3. Supported routines and views 103
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 below.
IGNORE schema-sqlid
This option can only be used when the USING XDS parameter is specified.
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.
DEFAULT schema-sqlid
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 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
This option can only be used when the USING XDS parameter is specified.
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
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.
104 Administrative Routines and Views
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 ignored when specified in conjunction with the CURSOR file
type.
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
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.
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.
Chapter 3. Supported routines and views 105
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. Following 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.
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.
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.
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 prior to 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. This is the default parameter. For summary, see
Table 1 below.
The following example keeps the old dictionary if it is currently in
the table:
CALL SYSPROC.ADMIN_CMD(’load from staff.del of del replace
keepdictionary into SAMPLE.STAFF statistics use profile
data buffer 8’)
Table 46. LOAD REPLACE KEEPDICTIONARY
Dictionary
Compress exists Result outcome
Y Y Preserve dictionary; all input rows are subject to compression
with existing dictionary.
Y N Insert new dictionary into table only if sufficient user data
exists; remaining rows subject to compression after dictionary
built.
N Y Preserve dictionary; all input rows are not compressed.
N N No effect; all rows not compressed.
106 Administrative Routines and Views
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 pre-existing
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 summary, see Table 2 below.
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 47. LOAD REPLACE RESETDICTIONARY
Dictionary
Compress exists Result outcome
Y Y Build a new dictionary*; remaining rows to be loaded are
subject to compression after dictionary built.
Y N Build new dictionary; remaining rows subject to compression
after dictionary built.
N Y Remove dictionary; all input rows are not compressed.
N N No effect; all rows not compressed.
* 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.
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 below.
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 below.
INTO table-name
Specifies the database table into which the data is to be loaded. This table
Chapter 3. Supported routines and views 107
cannot be a system table or a declared 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.
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.
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.
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.
STATISTICS USE PROFILE
Instructs load to collect statistics during the load according to the profile
defined for this table. This profile must be created before load is executed.
The profile is created by the RUNSTATS command. If the profile does not
exist and load is instructed to collect statistics according to the profile, a
warning is returned and no statistics are collected.
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.
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, logretain or
userexit is on). 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.
108 Administrative Routines and Views
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 (logretain or logarchmeth1 is
enabled), 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 (both logretain and userexit are off).
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 non-recoverable 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
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 non-recoverable 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
(logretain or logarchmeth1 is not enabled), 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.
Chapter 3. Supported routines and views 109
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.
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 intra-partition parallelism. 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:
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.
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,
110 Administrative Routines and Views
no parallel fetching is performed. The default value is YES. For more
information, see Moving data using the CURSOR file type.
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.
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.
Incremental indexing is not supported when all of the following
conditions are true:
v The LOAD COPY option is specified (logarchmeth1 with the
USEREXIT or LOGRETAIN option).
v The table resides in a DMS table space.
v The index object resides in a table space that is shared by other
table objects belonging to the table being loaded.
To bypass this restriction, it is recommended that indexes be placed
in a separate table space.
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.
Chapter 3. Supported routines and views 111
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. LOAD TERMINATE or LOAD RESTART of an ALLOW READ
ACCESS load can use this option; LOAD TERMINATE or LOAD RESTART
of an ALLOW NO ACCESS load cannot use this option. 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
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,
112 Administrative Routines and Views
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.
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.
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 warning
(SQLSTATE 01586) will be issued to indicate that dependent 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.
Chapter 3. Supported routines and views 113
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.
SOURCEUSEREXITexecutable
Specifies an executable filename which will be called to feed data into the
utility.
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:
114 Administrative Routines and Views
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.
RESTARTCOUNT
Reserved.
USING directory
Reserved.
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 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 ...
...
1 record(s) selected.
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’)
...
...
Chapter 3. Supported routines and views 115
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 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 ...
...
...
1 record(s) selected.
Output from a multi-partition database (continued).
... MSG_RETRIEVAL MSG_REMOVAL
... ----------------------------------...- -----------------------------...-
... SELECT DBPARTITIONNUM, AGENT_TYPE, CALL SYSPROC.ADMIN_REMOVE_MSGS
... 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 TABSTATE AGENTTYPE
--------------...- -------...- --------...- ------------...-
10 0 NORMAL LOAD
20 0 NORMAL LOAD
30 0 NORMAL LOAD
20 0 NORMAL PARTITION
10 0 NORMAL PRE_PARTITION
1 record(s) selected.
Return Status = 0
Examples of loading data from XML documents
Loading data from an XML document
Example 1
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’ />"
116 Administrative Routines and Views
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.
Example 2
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
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
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 below in the 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 prior to loading. Data does not need to be sorted prior to
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.
Chapter 3. Supported routines and views 117
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
which, in the case of Type 2 connections, causes the procedure to return
SQL30090N with reason code 1.
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 command, 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 command). 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 command.
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.
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.
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 48. LOAD TERMINATE dictionary management
TERMINATE: LOAD
Table Does Dictionary REPLACE TERMINATE: LOAD
COMPRESS exist prior to KEEPDICTIONARY or REPLACE
Attribute LOAD? LOAD INSERT RESETDICTIONARY
YES YES Keep existing dictionary. Nothing kept.
YES NO Nothing kept. Nothing kept.
NO YES Keep existing dictionary. Nothing kept.
NO NO Do nothing. Do nothing.
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 below.
118 Administrative Routines and Views
Table 49. LOAD RESTART dictionary management
Does Dictionary RESTART: LOAD
Table exist prior to REPLACE RESTART: LOAD
COMPRESS LOAD Consistency KEEPDICTIONARY or REPLACE
Attribute point? LOAD INSERT RESETDICTIONARY
YES YES Keep existing dictionary. Keep existing
dictionary.
YES NO Build dictionary subject to Build dictionary.
ADC.
NO YES Keep existing dictionary. Remove existing
dictionary.
NO NO Do nothing. Do nothing.
Result set information
Command execution status is returned in the SQLCA resulting from the CALL
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 50: Result set for a load operation.
v Table 51 on page 120: Result set 2 contains information for each database
partition in a multi-partition load operation.
Table 50. 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.
Chapter 3. Supported routines and views 119
Table 50. Result set returned by the LOAD command (continued)
Column name Data type Description
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:
CALL SYSPROC.ADMIN_REMOVE_MSGS
(’2203498_thx’)
This information is returned only if
the MESSAGES ON SERVER clause
is specified.
Table 51. 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.
SQLCODE INTEGER Final SQLCODE resulting from the
load processing.
120 Administrative Routines and Views
Table 51. Result set 2 returned by the LOAD command for each database partition in a
multi-partition database. (continued)
Column name Data type Description
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 52. 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.
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.
Chapter 3. Supported routines and views 121
Table 52. Valid file type modifiers for the load 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 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 If this modifier is specified, the utility assumes that the input data file contains no
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 Administrative Routines and Views
Table 52. Valid file type modifiers for the load utility: All file formats (continued)
Modifier Description
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.
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.
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/.
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.
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.
Chapter 3. Supported routines and views 123
Table 52. Valid file type modifiers for the load utility: All file formats (continued)
Modifier Description
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 If this modifier is specified, the utility assumes that the input data file contains no
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.
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
124 Administrative Routines and Views
Table 52. Valid file type modifiers for the load utility: All file formats (continued)
Modifier Description
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.
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/WSF 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
of the following occurs:
v For DEL/ASC/WSF files: If the column is nullable, a NULL is loaded. If the
column is not nullable, the utility rejects the row.
Chapter 3. Supported routines and views 125
Table 53. Valid file type modifiers for the load utility: ASCII file formats (ASC/DEL)
Modifier Description
codepage=x x is an ASCII character string. The value is interpreted as the code page of the
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.
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 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.
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 1 - 12;
mutually exclusive with M)
D - Day (one or two digits ranging from 1 - 31)
DD - Day (two digits ranging from 1 - 31;
mutually exclusive with D)
DDD - Day of the year (three digits ranging
from 001 - 366; mutually exclusive
with other day or month elements)
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"
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. Following 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 recreated, but it will be
appended.
126 Administrative Routines and Views
Table 53. Valid file type modifiers for the load utility: ASCII file formats (ASC/DEL) (continued)
Modifier Description
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.
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 0 - 12
for a 12 hour system, and 0 - 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 0 - 59;
mutually exclusive with M)
S - Second (one or two digits ranging
from 0 - 59)
SS - Second (two digits ranging from 0 - 59;
mutually exclusive with S)
SSSSS - Second of the day after midnight (5 digits
ranging from 00000 - 86399; mutually
exclusive with other time elements)
TT - Meridian indicator (AM or PM)
A default value of 0 is assigned for each element that is not specified. Some
examples of time formats are:
"HH:MM:SS"
"HH.MM TT"
"SSSSS"
Chapter 3. Supported routines and views 127
Table 53. Valid file type modifiers for the load utility: ASCII file formats (ASC/DEL) (continued)
Modifier Description
timestampformat=″x″ x is the format of the time stamp in the source file.1 Valid time stamp 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 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 1 - 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 0 - 12
for a 12 hour system, and 0 - 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 0 - 59;
mutually exclusive with M, minute)
S - Second (one or two digits ranging from 0 - 59)
SS - Second (two digits ranging from 0 - 59;
mutually exclusive with S)
SSSSS - Second of the day after midnight (5 digits
ranging from 00000 - 86399; mutually
exclusive with other time elements)
UUUUUU - Microsecond (6 digits ranging from 000000 - 999999;
mutually exclusive with all other microsecond elements)
UUUUU - Microsecond (5 digits ranging from 00000 - 99999,
maps to range from 000000 - 999990;
mutually exclusive with all other microseond elements)
UUUU - Microsecond (4 digits ranging from 0000 - 9999,
maps to range from 000000 - 999900;
mutually exclusive with all other microseond elements)
UUU - Microsecond (3 digits ranging from 000 - 999,
maps to range from 000000 - 999000;
mutually exclusive with all other microseond elements)
UU - Microsecond (2 digits ranging from 00 - 99,
maps to range from 000000 - 990000;
mutually exclusive with all other microseond elements)
U - Microsecond (1 digit ranging from 0 - 9,
maps to range from 000000 - 900000;
mutually exclusive with all other microseond elements)
TT - Meridian indicator (AM or PM)
128 Administrative Routines and Views
Table 53. Valid file type modifiers for the load utility: ASCII file formats (ASC/DEL) (continued)
Modifier Description
timestampformat=″x″ A default value of 1 is assigned for unspecified YYYY, M, MM, D, DD, or DDD
(Continued) 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:
"YYYY/MM/DD HH:MM:SS.UUUUUU"
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:
db2 load from delfile2 of del
modified by timestampformat="yyyy.mm.dd hh:mm tt"
insert into schedule
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.
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 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.
Chapter 3. Supported routines and views 129
Table 53. Valid file type modifiers for the load utility: ASCII file formats (ASC/DEL) (continued)
Modifier Description
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.
For each document, if a declaration tag exists and contains an encoding attribute,
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
an encoding attribute.
Table 54. 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.
The following rules apply:
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
source data has a column definition that exceeds the size of the target table
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
mismatched column definitions.
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.
130 Administrative Routines and Views
Table 54. Valid file type modifiers for the load utility: ASC file formats (Non-delimited ASCII) (continued)
Modifier Description
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 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.
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:
+ = 0xC 0xA 0xE 0xF
- = 0xD 0xB
Supported values for digits are 0x0 to 0x9.
Supported values for zones are 0x3 and 0xF.
Chapter 3. Supported routines and views 131
Table 55. Valid file type modifiers for the load utility: DEL file formats (Delimited ASCII)
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.23 If you want to explicitly specify the double quotation
mark (″) as the character string delimiter, you should specify it as follows:
modified by chardel""
The single quotation mark (’) can also be specified as a character string delimiter
as follows:
modified by chardel’’
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.23
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.23
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>.
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.
The following example illustrates how to load data into a table called TABLE1,
while preserving all leading and trailing spaces in the data file:
db2 load from delfile3 of del
modified by keepblanks
insert into table1
nochardel 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 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.
132 Administrative Routines and Views
Table 56. 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.
nochecklengths If nochecklengths is specified, an attempt is made to load 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 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
mismatched column definitions.
Note:
1. 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 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
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)
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:
... modified by coldel# ...
... modified by coldel0x23 ...
... modified by coldelX23 ...
3. Delimiter considerations for moving data lists restrictions that apply to the
characters that can be used as delimiter overrides.
Chapter 3. Supported routines and views 133
4. The load 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
load operation fails, and an error code is returned.
5. When importing into a table containing an implicitly hidden row change
timestamp column, the implicitly hidden property of the column is not
honoured. Therefore, the rowchangetimestampmissing file type modifier must
be specified in the import command if data for the column is not present in the
data to be imported and there is no explicit column list present.
Table 57. 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.
Warning: Graphic data will be corrupted when loaded
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.
Warning: Graphic data will be corrupted when loaded
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.
Authorization
One of the following:
v sysadm
v sysctrl
v sysmaint
v dbadm
134 Administrative Routines and Views
Required connection
Database
Command syntax
PRUNE HISTORY timestamp
WITH FORCE OPTION AND DELETE
LOGFILE PRIOR TO log-file-name
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.
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 prior to (but not including) the specified log file will be deleted. The
logretain database configuration parameter must be set to RECOVERY or
CAPTURE.
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 prior to (but not
including) S0000100.LOG:
CALL SYSPROC.ADMIN_CMD(’prune logfile prior to S0000100.LOG’)
Chapter 3. Supported routines and views 135
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/group and sysadm, sysmaint, dbadm, or sysctrl will be
able to access the database or its objects.
Authorization
One of the following:
For database level quiesce:
v sysadm
v dbadm
v sysadm
v sysctrl
136 Administrative Routines and Views
Required connection
Database
Command syntax
QUIESCE DATABASE IMMEDIATE
DB 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 rollback 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/REVOKE privileges can designate who will be able to
connect. This information will be stored permanently in the database catalog
tables.
For example,
Chapter 3. Supported routines and views 137
grant quiesce_connect on database to <username/groupname>
revoke quiesce_connect on database from <username/groupname>
v Command execution status is returned in the SQLCA resulting from the CALL
statement.
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’, respectively) are quiesced.
Authorization
One of the following:
v sysadm
v sysctrl
v sysmaint
v dbadm
v load
Required connection
Database
Command syntax
QUIESCE TABLESPACES FOR TABLE tablename SHARE
schema.tablename INTENT TO UPDATE
EXCLUSIVE
RESET
Command parameters
TABLE
tablename
Specifies the unqualified table name. The table cannot be a system
catalog table.
138 Administrative Routines and Views
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.
Example
Quiesce the table spaces containing the staff table.
CALL SYSPROC.ADMIN_CMD( ’quiesce tablespaces for table staff share’ )
Usage notes
This command is not supported for declared temporary tables.
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).
Chapter 3. Supported routines and views 139
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 delete pending, 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 upgrade 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.
Command execution status is returned in the SQLCA resulting from the CALL
statement.
REDISTRIBUTE DATABASE PARTITION GROUP command using
the ADMIN_CMD procedure
Redistributes data across the database partitions in a database partition group. The
target distribution of data can be uniform (default) or user specified to meet
specific system requirements.
Note: This topic contains references to some keyword updates that are only valid
when DB2 9.5 Fix Pack 1 is installed. If DB2 9.5 Fix Pack 1 is not yet available or
installed, refer to the DB2 9 version of this topic available in the DB2 9 Information
Center at:http://publib.boulder.ibm.com/infocenter/db2luw/v9/index.jsp
Scope
This command affects all database partitions in the database partition group.
Authorization
One of the following:
v sysadm
v sysctrl
v dbadm
Required connection
Connection to the catalog partition.
140 Administrative Routines and Views
Command syntax
REDISTRIBUTE DATABASE PARTITION GROUP db-partition-group
NOT ROLLFORWARD RECOVERABLE
UNIFORM Add/Drop DB partition
USING DISTFILE distfilename
USING TARGETMAP targetmapfilename
CONTINUE
ABORT
Redistribute options
,
ONLY
TABLE ( table-name )
FIRST
Add/Drop DB partition:
,
ADD DBPARTITIONNUM ( n )
DBPARTITIONNUMS TO m
,
DROP DBPARTITIONNUM ( n )
DBPARTITIONNUMS TO m
Redistribute options:
INDEXING MODE REBUILD
INDEXING MODE DEFERRED
DATA BUFFER n
STATISTICS USE PROFILE
STATISTICS NONE
STOP AT local-isotime
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.
NOT ROLLFORWARD RECOVERABLE
This option is only available when DB2 9.5 Fix Pack 1 is installed. When
Chapter 3. Supported routines and views 141
this option is used, the REDISTRIBUTE DATABASE PARTITION GROUP
command is not roll forward 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. This is particularly beneficial if, in
the past, large active log space and storage requirements forced you to
break a single data redistribution operation into multiple smaller
redistribution tasks, which might have resulted in even more time
required to complete the end-to-end data redistribution operation.
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
database partition group.
Use the distfilename to indicate the current distribution of data across the
4 096 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 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 112 000, and partition 3
(with a weight of 0) has no data mapping to it at all.
The distfilename should contain 4 096 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.
142 Administrative Routines and Views
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.
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 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
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 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: 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 prior to issuing the REDISTRIBUTE
Chapter 3. Supported routines and views 143
DATABASE PARTITION GROUP command. Table space containers
can then be created manually specifying appropriate names.
DROP
DBPARTITIONNUM n
TO m
n or n TO m specifies a list or lists of database partition numbers
which are 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
n or n TO m specifies a list or lists of database partition numbers
which are 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 subsequent
REDISTRIBUTE CONTINUE commands. This is the default.
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.
INDEXING MODE
This parameter specifies how indexes are maintained during redistribution.
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
may force a rebuild, or indexes may be rebuilt when the database
is restarted.
Note: For non-MDC tables, if there are invalid indexes on the
tables, the REDISTRIBUTE DATABASE PARTITION GROUP
command automatically rebuilds them if you do not specify
INDEXING MODE DEFERRED. For an MDC table, even if you
specify INDEXING MODE DEFERRED, a composite index that is
144 Administrative Routines and Views
invalid is rebuilt before table redistribution begins because the
utility needs the composite index to process an MDC table.
DATA BUFFER n
Specifies the number of 4 KB pages to use as buffered space for
transferring data within the utility. If the value specified is lower than the
minimum supported value, the minimum value 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. If a 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.
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.
STATISTICS
This option specifies that the utility should collect statistics for the tables
that have a statistics profile. 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.
Consequences of using the NOT ROLLFORWARD RECOVERABLE
option
When the REDISTRIBUTE DATABASE PARTITION GROUP command is issued
and the NOT ROLLFORWARD RECOVERABLE option is specified, a minimal
logging strategy is used that minimizes the writing of log records for each moved
row. This type of logging is important for the usability of the redistribute operation
since an approach that fully logs all data movement could, for large systems,
require an impractical amount of active and permanent log space and would
generally have poorer performance characteristics. It is important, however, for
users to be aware that as a result of this minimal logging model, the
REDISTRIBUTE DATABASE PARTITION GROUP command is not rollforward
recoverable. This means that any operation that results in the database rolling
forward through a redistribute operation results in all tables touched by the
redistribution operation being left in the UNAVAILABLE state. Such tables can
only be dropped, which means there is no way to recover the data in these tables.
Chapter 3. Supported routines and views 145
This is why, for recoverable databases, the REDISTRIBUTE DATABASE
PARTITION GROUP utility when issued with the NOT ROLLFORWARD
RECOVERABLE option puts all table spaces it touches into the BACKUP
PENDING state, forcing the user to backup all redistributed table spaces at the end
of a successful redistribute operation. With a backup taken after the redistribution
operation, the user should not have a need to rollforward through the redistribute
operation itself.
There is one very important consequence of the redistribute utility’s lack of
rollforward recoverability of which the user should be aware: If the user chooses to
allow updates to be made against tables in the database (even tables outside the
database partition group being redistributed) while the redistribute operation is
running, including the period at the end of redistribute where the table spaces
touched by redistribute are being backed up by the user, such updates can be lost
in the event of a serious failure, e.g., a database container is destroyed. The reason
that such updates can be lost is that the redistribute operation is not rollforward
recoverable. If it is necessary to restore the database from a backup taken prior to
the redistribution operation, then it will not be possible to rollforward through the
logs in order to replay the updates that were made during the redistribution
operation without also rolling forward through the redistribute which, as was
described above, leaves the redistributed tables in the UNAVAILABLE state. Thus,
the only thing that can be done in this situation is to restore the database from the
backup taken prior to redistribute without rolling forward. Then the redistribute
operation can be performed again. Unfortunately, all the updates that occurred
during the original redistribute operation are lost.
The importance of this point cannot be overemphasized. In order to be certain that
there will be no lost updates during a redistribution operation, one of the
following must be true:
v The user avoids making updates during the operation of the REDISTRIBUTE
DATABASE PARTITION GROUP command, including the period after the
command finishes where the affected table spaces are being backed up.
v Updates that are applied during the redistribute operation come from a
repeatable source, meaning that they can be applied again at any time. For
example, if the source of updates is data that is stored in a file and the updates
are applied during batch processing, then clearly even in the event of a failure
requiring a database restore, the updates would not be lost since they could
simply be applied again at any time.
With respect to allowing updates to the database during the redistribution
operation, the user must decide whether such updates are appropriate or not for
their scenario based on whether or not the updates can be repeated after a
database restore, if necessary.
Note: Not every failure during operation of the REDISTRIBUTE DATABASE
PARTITION GROUP command results in this problem. In fact, most do not. The
REDISTRIBUTE DATABASE PARTITION GROUP command is fully restartable,
meaning that if the utility fails in the middle of its work, it can be easily continued
or aborted with the CONTINUE/ABORT options. The failures mentioned above
are failures that require the user to restore from the backup taken prior to the
redistribute operation.
146 Administrative Routines and Views
Examples
Redistribute database partition group DBPG_1 by providing the current data
distribution through a data distribution file, distfile_for_dbpg_1, and moving
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) ’)
Usage notes
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 based 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:
database-name.database-partition-group-name.timestamp.log.
– The time stamp value is the time when the command was issued.
For more information about the redistribute event log, refer to the
“Redistribution Error Recovery” topic.
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
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 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.
v Command execution status is returned in the SQLCA resulting from the CALL
statement.
v The file referenced in USING DISTFILE distfilename or USING TARGETMAP
targetmapfilename, must refer to a file on the server.
Chapter 3. Supported routines and views 147
v Before starting a redistribute operation, ensure there are no tables in the Load
Pending state. Table states can be checked by using the LOAD QUERY
command.
Compatibilities
For compatibility with versions earlier than Version 8:
v The keyword NODEGROUP can be substituted for DATABASE PARTITION
GROUP.
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. Alternatively, you have the option of
reorganizing specific indexes on a range partitioned table.
If you specify the CLEANUP ONLY option of the index clause, cleanup is
performed without rebuilding the indexes. This command cannot be used against
indexes on declared temporary tables (SQLSTATE 42995).
The table option reorganizes a table by reconstructing the rows to eliminate
fragmented data, and by compacting information.
Scope
This command affects all database partitions in the database partition group.
Authorization
One of the following:
v sysadm
v sysctrl
v sysmaint
v dbadm
v CONTROL privilege on the table.
Required connection
Database
Command syntax
REORG
TABLE table-name Table clause
INDEXES ALL FOR TABLE table-name Index clause
INDEX index-name
FOR TABLE table-name
148 Administrative Routines and Views
Database partition clause
Table clause:
INDEX index-name
KEEPDICTIONARY
ALLOW NO ACCESS USE tbspace-name INDEXSCAN LONGLOBDATA RESETDICTIONARY
ALLOW READ ACCESS USE longtbspace-name
ALLOW WRITE ACCESS START
INPLACE
ALLOW READ ACCESS NOTRUNCATE TABLE RESUME
STOP
PAUSE
Index clause:
ALLOW NO ACCESS ALL
ALLOW WRITE ACCESS CLEANUP ONLY
ALLOW READ ACCESS PAGES
CONVERT
Database partition clause:
ON DBPARTITIONNUM ( db-partition-number1 )
DBPARTITIONNUMS TO db-partition-number2
ALL DBPARTITIONNUMS
,
EXCEPT DBPARTITIONNUM ( db-partition-number1 )
DBPARTITIONNUMS TO db-partition-number2
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 partitioned table.
Reorganization of individual indexes are only supported for
non-partitioned indexes on a partitioned table. This parameter is not
supported for block indexes.
FOR TABLE table-name
Specifies the table name location of the individual index being reorganized
on a partitioned table. This parameter is optional, given that index names
are unique across the database.
ALLOW NO ACCESS
Specifies that no other users can access the table while the indexes
are being reorganized.
ALLOW READ ACCESS
Specifies that other users can have read-only access to the table
while the indexes are being reorganized. This access level is not
supported for REORG INDEXES of a partitioned table unless the
CLEANUP ONLY option is specified.
Chapter 3. Supported routines and views 149
ALLOW WRITE ACCESS
Specifies that other users can read from and write to the table
while the indexes are being reorganized. This access level is not
supported for multi-dimensionally clustered (MDC) tables,
partitioned tables, extended indexes, or tables containing a column
with the XML data type unless the CLEANUP ONLY option is
specified.
When no ACCESS mode is specified, one will be chosen for you in the
following way:
Table 58. Default table access chosen based on the command, table type and additional parameters specified for the
index clause:
Additional parameters
Command Table type specified for index clause Default access mode
REORG INDEXES non-partitioned table any ALLOW READ ACCESS
REORG INDEXES partitioned table none specified ALLOW NO ACCESS
REORG INDEXES partitioned table CLEANUP ONLY ALLOW READ ACCESS
specified
REORG INDEXES partitioned table any ALLOW READ ACCESS
CLEANUP ONLY
When CLEANUP ONLY is requested, a cleanup rather than a full
reorganization will be done. The indexes will not be rebuilt and
any pages freed up will be available for reuse by indexes defined
on this table only.
The CLEANUP ONLY 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.
The CLEANUP ONLY 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.
ALL Specifies that indexes should be cleaned up by removing
committed pseudo deleted keys and committed pseudo empty
pages.
PAGES
Specifies that committed pseudo empty pages should be removed
from the index tree. This will not clean up pseudo deleted keys on
150 Administrative Routines and Views
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.
CONVERT
If you are not sure whether the table you are operating on has a
type-1 or type-2 index, but want type-2 indexes, you can use the
CONVERT option. If the index is type 1, this option will convert it
into type 2. If the index is already type 2, this option has no effect.
All indexes created by DB2 prior to Version 8 are type-1 indexes.
All indexes created by Version 8 are Type 2 indexes, except when
you create an index on a table that already has a type 1 index. In
this case the new index will also be of type 1.
Using the INSPECT command to determine the index type can be
slow. CONVERT allows you to ensure that the new index will be
Type 2 without your needing to determine its original type.
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. While ALLOW READ ACCESS
and ALLOW WRITE ACCESS allow access to the table, during the period
in which the reorganized copies of the indexes are made available, no
access to the table is allowed.
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
schema is the user name under which the table was created. If you omit the
schema name, the default schema is assumed.
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) table. In place reorganization of tables cannot be used for
MDC tables.
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 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 table.
ALLOW NO ACCESS
Specifies that no other users can access the table while the table is
being reorganized. When reorganizing a partitioned table, this is
the default. Reorganization of a partitioned table occurs offline.
Chapter 3. Supported routines and views 151
ALLOW READ ACCESS
Allow only read access to the table during reorganization. This is
the default for a non-partitioned table.
INPLACE
Reorganizes the table while permitting user access.
In place table reorganization is allowed only on non-partitioned
and non-MDC tables with type-2 indexes, but without extended
indexes and with no indexes defined over XML columns in the
table. In place table reorganization can only be performed on tables
that are at least three pages in size.
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.
NOTRUNCATE TABLE
Do not truncate the table after in place reorganization.
During truncation, the table is S-locked.
START
Start the in place REORG processing. Because this is the
default, this keyword is optional.
STOP Stop the in place REORG processing at its current point.
PAUSE
Suspend or pause in place REORG for the time being.
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.
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 8KB, 16KB, or 32KB 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.
When you have two temporary table spaces of the same page size,
and you specify one of them in the USE clause, they will be used
in a round robin fashion if there is an index in the table being
reorganized. Say you have two table spaces, tempspace1 and
tempspace2, both of the same page size and you specify tempspace1
152 Administrative Routines and Views
in the REORG command with the USE option. When you perform
REORG the first time, tempspace1 is used. The second time,
tempspace2 is used. The third time, tempspace1 is used and so on.
To avoid this, you should drop one of the temporary table spaces.
For partitioned tables, the table space is used as temporary storage
for the reorganization of all the data partitions in the table.
Reorganization of a partitioned table reorganizes a single data
partition at a time. The amount of space required is equal to the
largest data partition in the table, and not the entire table.
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.
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.
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 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.
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
Chapter 3. Supported routines and views 153
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 non-compressed format. It is not
possible to compress long, LOB, index, or XML objects.
Table 59. REORG KEEPDICTIONARY
Compress Dictionary Exists Result; outcome
Y Y Preserve dictionary; rows
compressed
Y N Build dictionary; rows
compressed
N Y Preserve dictionary; all rows
uncompressed
N N No effect; all rows
uncompressed
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, 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 non-compressed format. It is not possible to compress long,
LOB, index, or XML objects.
Table 60. REORG RESETDICTIONARY
Compress Dictionary Exists Result; outcome
Y Y Build new dictionary*; rows
compressed
Y N Build new dictionary; rows
compressed
N Y Remove dictionary; all rows
uncompressed
N N 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.
154 Administrative Routines and Views
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:
v Command execution status is returned in the SQLCA resulting from the CALL
statement.
v The REORG utility issue 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 The REORG utility does not support the use of nicknames.
v The REORG TABLE command is not supported for declared 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.
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 For partitioned tables:
– REORG is supported at the table level. Reorganization of an individual data
partition can be achieved by detaching the data partition, reorganizing the
resulting non-partitioned table and then re-attaching the data partition.
– 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 an error occurs during table reorganization, the non-partitioned indexes of
the table will be marked invalid if the reorganization has reached or passed
the replace phase for the first data partition. Indexes will be rebuilt on the
next access to the table.
– If an error occurs during index reorganization when the ALLOW NONE
access mode is used, some non-partitioned indexes of the table may be left
invalid. For RID indexes on the table, only the index currently being
reorganized at the time of the error will be left invalid. For MDC tables, one
or more of the block indexes could be left invalid if an error occurs. Any
indexes marked invalid will be rebuilt on the next access to the table.
– If a table reorganization operation fails, some data partitions may be in a
reorganized state and others may not. When the REORG TABLE command is
reissued, all the data partitions will be reorganized regardless of the data
partition’s reorganization state.
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.
Chapter 3. Supported routines and views 155
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 in-place
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
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 can be used to
reorganize one or all of the indexes on a table. Index reorganization 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. 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.
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.
156 Administrative Routines and Views
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 roll-forward recovery following a table reorganization,
both regular and large table spaces must be enabled for roll-forward 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”.
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.
Authorization
One of the following:
v sysadm
v sysmaint
v sysctrl
Required connection
Database
Command syntax
RESET ALERT CONFIGURATION FOR
CONFIG
CFG
DATABASE MANAGER
DB MANAGER
DBM
CONTAINERS
DATABASES
TABLESPACES
CONTAINER container-name FOR tblspace-name ON database-alias
DATABASE USING health-indicator-name
TABLESPACE tblspace-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.
Chapter 3. Supported routines and views 157
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
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.
USING health-indicator-name
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
Command execution status is returned in the SQLCA resulting from the CALL
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.
158 Administrative Routines and Views
Scope
This command only affects the database partition that the application is connected
to.
Authorization
One of the following:
v sysadm
v sysctrl
v sysmaint
Required connection
Database
Command syntax
RESET DATABASE CONFIGURATION FOR database-alias
DB CONFIG
CFG
DBPARTITIONNUM db-partition-num
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.
DBPARTITIONNUM db-partition-num
If a database configuration reset is to be applied to a specific database
partition, this parameter may be used. If this parameter is not provided,
the reset will take effect on all database partitions.
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.
Chapter 3. Supported routines and views 159
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.
The RESET DATABASE CONFIGURATION command will reset the database
configuration parameters to the pre-database configuration values, where
AUTO_RUNSTATS will be ON. SELF_TUNING_MEMORY will be reset to ON on
non-partitioned database environments and to OFF on partitioned database
environments.
Command execution status is returned in the SQLCA resulting from the CALL
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 MANAGER 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.
Authorization
One of the following:
v sysadm
v sysctrl
v sysmaint
Required connection
Database
Command syntax
RESET DATABASE CONFIGURATION FOR database-alias
DB CONFIG
CFG
DBPARTITIONNUM db-partition-num
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.
DBPARTITIONNUM db-partition-num
If a database configuration reset is to be applied to a specific database
160 Administrative Routines and Views
partition, this parameter may be used. If this parameter is not provided,
the reset will take effect on all database partitions.
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.
The RESET DATABASE CONFIGURATION command will reset the database
configuration parameters to the pre-database configuration values, where
AUTO_RUNSTATS will be ON. SELF_TUNING_MEMORY will be reset to ON on
non-partitioned database environments and to OFF on partitioned database
environments.
Command execution status is returned in the SQLCA resulting from the CALL
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.
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
One of the following:
v sysadm
v sysctrl
v sysmaint
Required connection
Database
Chapter 3. Supported routines and views 161
Command syntax
REWIND TAPE
ON device
Command parameters
ON device
Specifies a valid tape device name. The default value is \\.\TAPE0.The
device specified must be relative to the server.
Example
Rewind the tape on the device named ’\\.\TAPE1’.
CALL SYSPROC.ADMIN_CMD( ’rewind tape on \\.\TAPE1’ )
Usage notes
Command execution status is returned in the SQLCA resulting from the CALL
statement.
RUNSTATS command using the ADMIN_CMD procedure
Updates statistics 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, this utility should be called when the table has had many updates, or
after reorganizing the table. For a statistical view, this utility should be called 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
using the ALTER VIEW command.
Scope
This 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:
v sysadm
v sysctrl
v sysmaint
v dbadm
v CONTROL privilege on the table
162 Administrative Routines and Views
v LOAD authority
You do not need any explicit privilege to use this command on any declared global
temporary table that exists within its connection.
For statistical views, one of the following:
v sysadm
v sysctrl
v sysmaint
v dbadm
v CONTROL privilege on the statistical view
In addition, you need to have appropriate privileges to access rows from the
statistical view. Specifically, for each table, statistical view or nickname referenced
in the statistical view definition, the user must have one of the following
privileges:
v sysadm or dbadm
v CONTROL
v SELECT
Required connection
Database
Command syntax
RUNSTATS ON TABLE object-name
USE PROFILE
UNSET PROFILE
Statistics Options
UTIL_IMPACT_PRIORITY
priority
Statistics Options:
ALLOW WRITE ACCESS
Table Object Options ALLOW READ ACCESS
Table Sampling Options Profile Options
Table Object Options:
FOR Index Clause
EXCLUDING XML COLUMNS
Column Stats Clause EXCLUDING XML COLUMNS AND Index Clause
Chapter 3. Supported routines and views 163
Table Sampling Options:
TABLESAMPLE BERNOULLI ( numeric-literal )
SYSTEM
REPEATABLE ( integer-literal )
Profile Options:
SET PROFILE NONE
SET PROFILE
UPDATE ONLY
Index Clause:
INDEXES index-name
DETAILED INDEX ALL
SAMPLED
Column Stats Clause:
ON Cols Clause
Distribution Clause
ON Cols Clause
Distribution Clause:
WITH DISTRIBUTION
On Dist Cols Clause
Default Dist Options
On Cols Clause:
ON ALL COLUMNS
,
ON COLUMNS ( Column Option )
ALL COLUMNS AND
KEY
ON KEY COLUMNS
On Dist Cols Clause:
164 Administrative Routines and Views
ON ALL COLUMNS
,
ON COLUMNS ( Column Option )
ALL COLUMNS AND Frequency Option
KEY Quantile Option
ON KEY COLUMNS
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.
It 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.
index-name
Identifies an existing index defined on the table. The fully qualified name
in the form schema.index-name must be used. This option cannot be used for
views.
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
Chapter 3. Supported routines and views 165
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.
AND INDEXES
Collects and updates statistics for both the table and the indexes. This
option cannot be used for views.
DETAILED
Calculates extended index statistics. These are the CLUSTERFACTOR and
PAGE_FETCH_PAIRS statistics that are gathered for relatively large indexes.
This option cannot be used for views.
SAMPLED
This option, when used with the DETAILED option, allows RUNSTATS to
employ a CPU sampling technique when compiling the extended index
statistics. If the option is not specified, every entry in the index is
examined to compute the extended index statistics. This option cannot be
used for views.
ON ALL COLUMNS
Statistics collection can be done on some columns and not on others.
Columns such as LONG VARCHAR or CLOB columns are ineligible. If it is
desired to collect statistics on all eligible columns, one can 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
This clause allows the user to specify a list of columns for which to collect
statistics. If you specify group of columns, the number of distinct values
for the group will be collected. When you run RUNSTATS on a table
without gathering index statistics, and specify a subset of columns for
which statistics are to be gathered, then:
1. Statistics for columns not specified in the RUNSTATS command but
which are the first column in an index are NOT reset.
2. 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 will be ignored for the purpose of collecting distinct values for the
group. However, basic XML column statistics will be collected for the XML
type columns in the column group.
166 Administrative Routines and Views
EXCLUDING XML COLUMNS
This clause allows you to omit all XML type columns from statistics
collection. 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.
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 non-existent
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).
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.
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
Chapter 3. Supported routines and views 167
LONG VARCHAR). If the ON COLUMNS clause is specified, distribution
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.
LIKE STATISTICS
When this option is specified additional column statistics are collected.
These statistics are the SUB_COUNT and the SUB_DELIM_LENGTH statistics in
SYSSTAT.COLUMNS. The statistics are 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. They are used by the query optimizer to
improve the selectivity estimates for predicates of the type "column LIKE
’%xyz’" and "column LIKE ’%xyz%’"
ALLOW WRITE ACCESS
Specifies that other users can read from and write to the table(s) 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 table(s) while
statistics are calculated. For statistical views, these are the base tables
referenced in the view definition.
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
168 Administrative Routines and Views
pages from the table(s). 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. On
statistical views, SYSTEM sampling is restricted to a specific class of views.
These are views that either access a single base table or nickname, or that
access multiple bases tables that are joined via referential-integrity
relationships. In either case, there must not be any local predicates in the
view definition. If SYSTEM sampling is specified on a view that cannot
support such sampling, an SQL20288N error is raised.
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.
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 by DB2 as
an error (SQL1197N).
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.
Chapter 3. Supported routines and views 169
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.
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. This option cannot be used for views.
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 db2user.employee
ON KEY COLUMNS and INDEXES ALL’)
Usage notes
1. 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 SYSDATAPARTITIONS table and look for the
value I (index cleanup) or D (detached with dependant MQT).
2. Command execution status is returned in the SQLCA resulting from the CALL
statement.
3. It is recommended to run the RUNSTATS command:
170 Administrative Routines and Views
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.
4. 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
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 there are many indexes on the table and DETAILED (extended)
information on the indexes might improve access plans, consider the
SAMPLED option to reduce the time it takes to collect statistics.
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.
Chapter 3. Supported routines and views 171
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.
5. 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.
6. 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 collected by the current command, or be replaced if statistics
on that XML column are collected by the current command.
7. 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.
8. 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.
172 Administrative Routines and Views
9. 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
10. Runstats sampling through TABLESAMPLE only occurs with table data pages
and not index pages. When index statistics as well as sampling is requested,
all the index pages are scanned for statistics collection. It is only in the
collection of table statistics where TABLESAMPLE is applicable. However, a
more efficient collection of detailed index statistics is available through the
SAMPLED DETAILED option. This is a different method of sampling than
that employed by TABLESAMPLE and only applies to the detailed set of
index statistics.
11. 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
SYSIBM.SYSTABLES system catalog table.
12. 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.
13. RUNSTATS acquires an IX table lock on SYSTABLES and a U lock on the row for
the table on which stats 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.
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
One of the following:
v sysadm
v sysctrl
v sysmaint
Required connection
Database
Command syntax
SET TAPE POSITION TO position
ON device
Chapter 3. Supported routines and views 173
Command parameters
ON device
Specifies a valid tape device name. The default value is \\.\TAPE0. The
device specified must be relative to the server.
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.
Example
Because DB2 writes 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
Command execution status is returned in the SQLCA resulting from the CALL
statement.
UNQUIESCE DATABASE command using the ADMIN_CMD
procedure
Restores user access to databases which have been quiesced for maintenance or
other reasons. UNQUIESCE restores user access without necessitating a shutdown
and database restart.
Unless specifically designated, no user except those with sysadm, sysmaint, or sysctrl
has access to a database while it is quiesced. Therefore an UNQUIESCE is required
to restore general access to a quiesced database.
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
One of the following:
For database level unquiesce:
v sysadm
v dbadm
Command syntax
UNQUIESCE DB
174 Administrative Routines and Views
Required connection
Database
Command parameters
DB Unquiesce the database. User access will be restored to all objects in the
database.
Examples
Unquiescing a Database
CALL SYSPROC.ADMIN_CMD( ’unquiesce db’ )
This command will unquiesce the database that had previously been quiesced.
Usage notes
Command execution status is returned in the SQLCA resulting from the CALL
statement.
UPDATE ALERT CONFIGURATION command using the
ADMIN_CMD procedure
Updates the alert configuration settings for health indicators.
Authorization
One of the following:
v sysadm
v sysmaint
v sysctrl
Required Connection
Database
Command Syntax
UPDATE ALERT CONFIGURATION FOR
CONFIG
CFG
DATABASE MANAGER USING health-indicator-name
DB MANAGER
DBM
DATABASES
CONTAINERS
TABLESPACES
DATABASE ON database-alias
TABLESPACE tblspace-name
CONTAINER container-name FOR tblspace-name
Chapter 3. Supported routines and views 175
,
SET parameter-name value
,
,
UPDATE ACTION SCRIPT pathname ON WARNING SET parameter-name value
TASK task-name ALARM
ALLALERT
ATTENTION state
,
DELETE ACTION SCRIPT pathname ON WARNING
TASK task-name ALARM
ALLALERT
ATTENTION state
,
ADD ACTION SCRIPT pathname Add Script Details ON State and User Details
TASK task-name
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 USER username USING password
ALARM ON hostname
ALLALERT
ATTENTION state
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
176 Administrative Routines and Views
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.
USING health-indicator-name
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
SET parameter-name value
Updates the alert configuration element, parameter-name, of the health
indicator to the specified value. parameter-name must be one of the
following:
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
pathname pathname will be updated according to the following clause:
SET parameter-name value
Updates the script attribute, parameter-name, to the specified value.
parameter-name must be one of the following:
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
Chapter 3. Supported routines and views 177
– Health indicator short name
– 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:
SET parameter-name value
Updates the task attribute, parameter-name, to the specified value.
parameter-name must be one of the following:
v USERID
v PASSWORD
v SYSTEM
DELETE ACTION SCRIPT pathname ON [WARNING | ALARM | ALLALERT |
ATTENTION state]
Removes the action script with absolute pathname 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 pathname 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 pathname, 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), the db2diag.log, trace files, dump file, snapshot
178 Administrative Routines and Views
monitor (dynamic SQL snapshot), system monitor snapshots, a
number of event monitors (such as statement, deadlock), Query
Patroller, explain tables, db2pd output (such as package cache and
lock timeout mechanisms) and db2 audit records.
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.
ATTENTION state
Valid numerical values for some of the database health indicator
states are given below 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 numerical 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 above health
indicator values, 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 tablespace 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.
Chapter 3. Supported routines and views 179
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
1 record(s) selected. ...
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 the network (username/password are passed over the wire unencrypted)
v db2diag.log
v trace files
v dump file
v snapshot monitor (dynamic SQL snapshot)
v system monitor snapshots
v a number of event monitors (statement, deadlock)
v query patroller
v explain tables
v db2pd output (package cache and lock timeout mechanisms, among others)
v DB2 audit records
Command execution status is returned in the SQLCA resulting from the CALL
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. To create a
180 Administrative Routines and Views
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
Database. The DAS must be running.
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 ’[email protected]’.
CALL SYSPROC.ADMIN_CMD( ’update contact test using address [email protected]’ )
Usage notes
The DAS must have been created and be running.
Command execution status is returned in the SQLCA resulting from the CALL
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
Chapter 3. Supported routines and views 181
Health Monitor. 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
UPDATE CONTACTGROUP name ( ADD CONTACT name )
DROP GROUP
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
The DAS must have been created and be running.
Command execution status is returned in the SQLCA resulting from the CALL
statement.
182 Administrative Routines and Views
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 by default, except when
DBPARTITIONNUM is specified to update only one database partition.
Authorization
One of the following:
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 CONFIGURATION
DB CONFIG FOR database-alias
CFG
DBPARTITIONNUM db-partition-num
IMMEDIATE
USING config-keyword value
value AUTOMATIC DEFERRED
AUTOMATIC
MANUAL
Command parameters
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.
Chapter 3. Supported routines and views 183
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.
DEFERRED
Make the changes only in the configuration file, so that the changes take
effect the next time you reactivate the database.
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:
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.
DBPARTITIONNUM db-partition-num
If a database configuration update is to be applied to a specific database
partition, this parameter may be used. If this parameter is not provided,
the update will take effect on all database partitions.
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.
MANUAL
Disables automatic tuning for the configuration parameter. The parameter
is set to its current internal value and is no longer updated automatically.
USING config-keyword value
config-keyword specifies the database configuration parameter to be
updated. value specifies the value to be assigned to the parameter.
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
Command execution status is returned in the SQLCA resulting from the CALL
statement.
The database-alias must be an alias name that is defined on the server.
The command affect all database partitions unless DBPARTITIONNUM is
specified.
184 Administrative Routines and Views
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 logretain recovery’)
To check that the logretain configuration parameter has changed, use:
SELECT * FROM SYSIBMADM.DBCFG WHERE NAME=’logretain’
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 DBPARTITIONNUM. For example, to update the logging mode to
only one specific partition (30) using DBPARTITIONNUM, use:
CALL SYSPROC.ADMIN_CMD (’update db cfg for zellmart dbpartitionnum 30 using
logretain recovery’)
For more information about DB2 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 on which parameters are configurable on-line
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.
UPDATE DATABASE MANAGER CONFIGURATION command
using the ADMIN_CMD procedure
Modifies individual entries in the database manager configuration file for the
instance that contains the currently connected database.
Chapter 3. Supported routines and views 185
Authorization
sysadm
Required connection
Database
Command syntax
UPDATE DATABASE MANAGER CONFIGURATION
DB MANAGER CONFIG
DBM CFG
DEFERRED
USING config-keyword value
value AUTOMATIC
AUTOMATIC
MANUAL
Command parameters
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.
DEFERRED
Make the changes only in the configuration file, so that the changes take
effect when the instance is restarted. This is the default.
MANUAL
Disables automatic tuning for the configuration parameter. The parameter
is set to its current internal value and is no longer updated automatically.
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.
Example
Update the diagnostic level to 1 for the database manager configuration.
CALL SYSPROC.ADMIN_CMD(’db2 update dbm cfg using DIAGLEVEL 1’)
186 Administrative Routines and Views
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 on which 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.
Command execution status is returned in the SQLCA resulting from the CALL
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.
UPDATE HEALTH NOTIFICATION CONTACT LIST command using
the ADMIN_CMD procedure
Updates the contact list for notification about health alerts issued by an instance.
Authorization
One of the following:
v sysadm
v sysctrl
v sysmaint
Chapter 3. Supported routines and views 187
Required Connection
Database
Command Syntax
UPDATE HEALTH NOTIFICATION CONTACT LIST
NOTIFICATION
ADD CONTACT name
DROP GROUP
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
Command execution status is returned in the SQLCA resulting from the CALL
statement.
UPDATE HISTORY command using the ADMIN_CMD procedure
Updates the location, device type, comment, or status in a history file entry on the
currently connected database partition.
Authorization
One of the following:
v sysadm
v sysctrl
v sysmaint
v dbadm
188 Administrative Routines and Views
Required connection
Database
Command syntax
UPDATE HISTORY FOR object-part WITH
EID eid
LOCATION new-location DEVICE TYPE new-device-type
COMMENT new-comment
STATUS new-status
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:
D Disk
K Diskette
T Tape
A Tivoli Storage Manager
F Snapshot backup
U User exit
P Pipe
N Null device
X XBSA
Q SQL statement
O 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.
Chapter 3. Supported routines and views 189
I Inactive. Backup images that no longer correspond to the current
log sequence, also called the current log chain, are flagged as
inactive.
E Expired. Backup images that are no longer required, because there
are more than NUM_DB_BACKUPS active images, are flagged as
expired.
D Deleted. Backup images that are no longer available for recovery
should be marked as having been deleted.
X Do not delete. Recovery history 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 history file 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 history file 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 file 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.
Command execution status is returned in the SQLCA resulting from the CALL
statement.
The object-part or eid must refer to the log history entries on the connected database
partition.
UPDATE STMM TUNING DBPARTITIONNUM command using the
ADMIN_CMD procedure
Update the user preferred self tuning memory manager (STMM) tuning database
partition.
Authorization
SYSADM or DBADM authority
190 Administrative Routines and Views
Required connection
Database
Command syntax
UPDATE STMM TUNING DBPARTITIONNUM partitionnum
Command parameter
partitionnum
partitionnum is an integer. If -1 or a non-existing database partition
number is used, the STMM tuning database partition will use the default
database partition as defined for the STMM feature. If -1 or a non-existing
database partition number is used, DB2 will automatically select an
appropriate database partition on which to run the STMM memory tuner.
Example
Update the user preferred self tuning memory manager (STMM) tuning database
partition to database partition 3.
CALL SYSPROC.ADMIN_CMD( ’update stmm tuning dbpartitionnum 3’ )
Usage notes
The STMM tuning process periodically checks for a change in the user preferred
STMM tuning database partition number value. The STMM tuning process will
move to the user preferred STMM tuning database partition if partitionnum exists
and is an active database partition. Once this command changes the STMM tuning
database partition number an immediate change is made to the current STMM
tuning database partition number.
Command execution status is returned in the SQLCA resulting from the CALL
statement.
This command commits its changes in the ADMIN_CMD procedure.
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.
The ADMIN_GET_DBP_MEM_USAGE table function takes an optional input
argument dbpartitionnum (INTEGER type), which specifies a valid database
partition number, and returns only statistics for that single database partition. If
the argument is omitted, statistics are returned for all active database partitions.
When using the Database Partitioning Feature (DPF), if you specify -1 or a NULL
value for dbpartitionnum, data is returned from the currently connected partition.
Syntax
ADMIN_GET_DBP_MEM_USAGE ( )
dbpartitionnum
Chapter 3. Supported routines and views 191
The schema is SYSPROC.
Table function parameters
dbpartitionnum
An optional input argument of type integer that specifies the database partition
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 partition.
Authorization
EXECUTE privilege on the ADMIN_GET_DBP_MEM_USAGE function.
Information returned
Table 61. The result set for ADMIN_GET_DBP_MEM_USAGE
Column Name Data Type Description
DBPARTITIONNUM SMALLINT The database partition number from which memory usage
statistics is retrieved.
MAX_PARTITION_MEM BIGINT The maximum amount of instance memory (in bytes) allowed
to be consumed in the database partition.
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 MAX_PARTITION_MEM CURRENT_PARTITION_MEM PEAK_PARTITION_MEM
-------------- ----------------- --------------------- ------------------
3 500000000 381000000 481000000
1 record(s) selected.
Example 2: Retrieve memory usage statistics from the currently connected partition
(assuming the user is connected to the database at partition 2.)
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_DBP_MEM_USAGE(-1)) AS T
DBPARTITIONNUM MAX_PARTITION_MEM CURRENT_PARTITION_MEM PEAK_PARTITION_MEM
-------------- ----------------- --------------------- ------------------
2 500000000 381000000 481000000
1 record(s) selected.
Example 3: Retrieve memory usage statistics from all partitions
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_DBP_MEM_USAGE()) AS T
DBPARTITIONNUM MAX_PARTITION_MEM CURRENT_PARTITION_MEM PEAK_PARTITION_MEM
-------------- ----------------- --------------------- ------------------
0 500000000 381000000 481000000
1 500000000 381000000 481000000
2 500000000 381000000 481000000
3 500000000 381000000 481000000
4 record(s) selected.
192 Administrative Routines and Views
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 )
The schema is SYSPROC.
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
ADMIN_CMD procedure.
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.
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 is an example of 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.
2 record(s) selected.
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.
Chapter 3. Supported routines and views 193
Information returned
Table 62. Information returned by the ADMIN_GET_MSGS table function
Column name Data type Description
DBPARTITIONNUM INTEGER Database partition number.
This value is only returned
for a distributed load and
indicates which database
partition the corresponding
message is for.
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.
ADMINTABCOMPRESSINFO view and
ADMIN_GET_TAB_COMPRESS_INFO
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.
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.
The schema is SYSIBMADM.
Refer to the ADMINTABCOMPRESSINFO administrative view and
ADMIN_GET_TAB_COMPRESS_INFO table function metadata table for a complete
list of information that can be returned.
Authorization
SELECT or CONTROL privilege on the ADMINTABCOMPRESSINFO
administrative view and EXECUTE privilege on the
ADMIN_GET_TAB_COMPRESS_INFO table function.
194 Administrative Routines and Views
Examples
Example 1: Retrieve all compression information for all tables
SELECT * FROM SYSIBMADM.ADMINTABCOMPRESSINFO
The following is an example of output from this query:
TABSCHEMA TABNAME DBPARTITIONNUM DATA_PARTITION_ID COMPRESS_ATTR DICT_BUILDER DICT_BUILD_TIMESTAMP
---------...- -----------...- -------------- ----------------- ------------- -------------...- --------------------------
SYSIBM SYSTABLES 0 0 N NOT BUILT -
SYSIBM SYSCOLUMNS 0 0 N NOT BUILT -
...
SIMAP2 STAFF 0 0 Y REORG 2006-08-27-19.07.36.000000
SIMAP2 PARTTAB 0 0 Y REORG 2006-08-27-22.07.17.000000
...
156 record(s) selected.
Output from this query (continued):
COMPRESS_DICT_SIZE EXPAND_DICT_SIZE ROWS_SAMPLED PAGES_SAVED_PERCENT BYTES_SAVED_PERCENT AVG_COMPRESS_REC_LENGTH
-------------------- -------------------- ------------ ------------------- ------------------- -----------------------
0 0 0 0 0 0
0 0 0 0 0 0
...
13312 5312 35 65 84 100
5760 4248 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
The following is an example of output from this query:
TABSCHEMA TABNAME DBPARTITIONNUM DATA_PARTITION_ID DICT_BUILDER DICT_BUILD_TIMESTAMP
--------------- --------------- -------------- ----------------- --------------------------- --------------------------
SYSIBM SYSTABLES 0 0 NOT BUILT -
SYSIBM SYSCOLUMNS 0 0 NOT BUILT -
...
SIMAP2 STAFF 0 0 REORG 2006-08-27-19.07.36.000000
SIMAP2 SALES 0 0 NOT BUILT -
SIMAP2 CATALOG 0 0 NOT BUILT -
...
156 record(s) selected.
ADMIN_GET_TAB_COMPRESS_INFO table function
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.
Refer to the AADMINTABCOMPRESSINFO administrative view and
ADMIN_GET_TAB_COMPRESS_INFO table function metadata table for a complete
list of information that can be returned.
Syntax
ADMIN_GET_TAB_COMPRESS_INFO ( tabschema , tabname , execmode )
The schema is SYSPROC.
Chapter 3. Supported routines and views 195
Table function 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
materialized query table name or a hierarchy table name.
execmode
An input argument of type VARCHAR(30) that specifies the execution mode.
The execution mode can be one of the following:
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.
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 DICT_BUILDER DICT_BUILD_TIMESTAMP
----------...- -------...- -------------- ----------------- ------------- ------------...- --------------------------
SIMAP2 STAFF 0 0 Y REORG 2006-08-27-19.07.36.000000
1 record(s) selected.
Output from this query (continued):
COMPRESS_DICT_SIZE EXPAND_DICT_SIZE ROWS_SAMPLED PAGES_SAVED_PERCENT BYTES_SAVED_PERCENT AVG_COMPRESS_REC_LENGTH
-------------------- -------------------- ------------ ------------------- ------------------- -----------------------
13312 5312 35 65 84 100
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
The following is an example from output of this query:
TABSCHEMA TABNAME DBPARTITIONNUM DATA_PARTITION_ID COMPRESS_ATTR DICT_BUILDER DICT_BUILD_TIMESTAMP
----------...- -------...- -------------- ----------------- ------------- ----------------...- --------------------------
SIMAP2 STAFF 0 0 Y TABLE FUNCTION 2006-08-28-19.18.13.000000
1 record(s) selected.
Output from this query (continued):
COMPRESS_DICT_SIZE EXPAND_DICT_SIZE ROWS_SAMPLED PAGES_SAVED_PERCENT BYTES_SAVED_PERCENT AVG_COMPRESS_REC_LENGTH
-------------------- -------------------- ------------ ------------------- ------------------- -----------------------
13508 6314 68 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
196 Administrative Routines and Views
Output from this query:
TABSCHEMA TABNAME DICT_BUILDER TOTAL_DICT_SIZE DBPARTITIONNUM DATA_PARTITION_ID
--------------- --------------- ------------------------------ -------------------- -------------- -----------------
SIMAP2 ACT NOT BUILT 0 0 0
SIMAP2 ADEFUSR NOT BUILT 0 0 0
...
SIMAP2 INVENTORY NOT BUILT 0 0 0
SIMAP2 ORG NOT BUILT 0 0 0
SIMAP2 PARTTAB REORG 10008 0 0
SIMAP2 PARTTAB REORG 5464 0 1
SIMAP2 PARTTAB REORG 8456 0 2
SIMAP2 PARTTAB REORG 6960 0 3
SIMAP2 PARTTAB REORG 7136 0 4
...
SIMAP2 STAFF REORG 18624 0 0
SIMAP2 SUPPLIERS NOT BUILT 0 0 0
SIMAP2 TESTTABLE NOT BUILT 0 0 0
28 record(s) selected.
Example 4: View a report of the dictionary information of tables migrated from a
previous version of DB2.
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_TAB_COMPRESS_INFO(’SIMAP2’, ’’, ’REPORT’))
AS T
Output from this query:
TABSCHEMA TABNAME DBPARTITIONNUM DATA_PARTITION_ID COMPRESS_ATTR DICT_BUILDER DICT_BUILD_TIMESTAMP
----------...- -------...- -------------- ----------------- ------------- ----------------...- --------------------------
SIMAP2 T1 0 0 Y NOT BUILT -
SIMAP2 T2 0 0 N REORG 2007-02-03-17.35.28.000000
SIMAP2 T3 0 0 Y INSPECT 2007-02-03-17.35.44.000000
SIMAP2 T4 0 0 N NOT BUILT -
4 record(s) selected.
Output from this query (continued):
COMPRESS_DICT_SIZE EXPAND_DICT_SIZE ROWS_SAMPLED PAGES_SAVED_PERCENT BYTES_SAVED_PERCENT AVG_COMPRESS_REC_LENGTH
-------------------- -------------------- ------------ ------------------- ------------------- -----------------------
0 0 0 0 0 0
1280 2562 - - - -
1340 2232 - - - -
0 0 0 0 0 0
Usage Notes
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), 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_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.
Chapter 3. Supported routines and views 197
ADMINTABCOMPRESSINFO administrative view and the
ADMIN_GET_TAB_COMPRESS_INFO table function metadata
Table 63. ADMINTABCOMPRESSINFO administrative view and the ADMIN_GET_TAB_COMPRESS_INFO table
function metadata
Column Name Data Type Description
TABSCHEMA VARCHAR(128) Schema name
TABNAME VARCHAR(128) Table name
DBPARTITIONNUM SMALLINT Database partition number
DATA_PARTITION_ID INTEGER Data partition number
COMPRESS_ATTR CHAR(1) The state of the COMPRESS attribute on the table which
can be one of the following:
v ’Y’ = Row compression is set to yes
v ’N’ = Row compression is set to no
DICT_BUILDER VARCHAR(30) Code path taken to build the dictionary which can be one
of the following:
v ’INSPECT’ = INSPECT ROWCOMPESTIMATE
v ’LOAD’ = LOAD INSERT/REPLACE
v ’NOT BUILT’ = no dictionary available
v ’REDISTRIBUTE’ = REDISTRIBUTE
v ’REORG’ = REORG RESETDICTIONARY
v ’TABLE FUNCTION’ =
ADMIN_GET_TAB_COMRESS_INFO
v ’TABLE GROWTH’ = INSERT
DICT_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.
COMPRESS_DICT_SIZE BIGINT Size of compression dictionary measured in bytes.
EXPAND_DICT_SIZE BIGINT Size of expansion dictionary measured in bytes.
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
will return NULL in this column.
BYTES_SAVED_PERCENT SMALLINT Percentage of bytes saved from compression. This
information is based on the record data in the sample
buffer only. Migrated tables with compression dictionaries
will return NULL in this column.
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.
198 Administrative Routines and Views
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
ADMIN_CMD procedure. The input parameter operation_id identifies the operation.
Syntax
ADMIN_REMOVE_MSGS ( operation_id )
The schema is SYSPROC.
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
ADMIN_CMD procedure.
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_CMD procedure.
ADMINTABINFO administrative view and
ADMIN_GET_TAB_INFO_V95 table function - Retrieve size and
state information for tables
The ADMINTABINFO administrative view and the ADMIN_GET_TAB_INFO_V95
table function provide methods to retrieve table size and state information that is
not currently available in the catalog views.
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
Chapter 3. Supported routines and views 199
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.
The schema is SYSIBMADM.
Refer to the ADMINTABINFO administrative view and
ADMIN_GET_TAB_INFO_V95 table function metadata table for a complete list of
information that can be returned.
Authorization
SELECT or CONTROL privilege on the ADMINTABINFO administrative view and
EXECUTE privilege on the ADMIN_GET_TAB_INFO_V95 table function.
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: Identify which tables are using type-1 indexes and require a
reorganization to convert to type-2 indexes.
SELECT TABSCHEMA, TABNAME FROM SYSIBMADM.ADMINTABINFO
WHERE INDEX_TYPE = 1
ADMIN_GET_TAB_INFO_V95 table function
The ADMIN_GET_TAB_INFO_V95 table function returns the same information as
the ADMINTABINFO administrative view, but allows you to specify a schema and
table name.
Refer to the ADMINTABINFO administrative view and
ADMIN_GET_TAB_INFO_V95 table function metadata table for a complete list of
information that can be returned.
Syntax
ADMIN_GET_TAB_INFO_V95 ( tabschema , tabname )
The schema is SYSPROC.
Table function parameters
tabschema
An input argument of type VARCHAR(128) that specifies a schema name.
200 Administrative Routines and Views
tabname
An input argument of type VARCHAR(128) that specifies a table name, a
materialized query table name or a hierarchy table name.
Authorization
EXECUTE privilege on the ADMIN_GET_TAB_INFO_V95 table function.
Examples
Example 1: Retrieve size and state information for the table DBUSER1.EMPLOYEE.
SELECT * FROM TABLE (SYSPROC.ADMIN_GET_TAB_INFO_V95(’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) as total_p_size
FROM TABLE( SYSPROC.ADMIN_GET_TAB_INFO_V95( ’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) as total_l_size
FROM TABLE( SYSPROC.ADMIN_GET_TAB_INFO_V95( ’DBUSER1’, ’EMPLOYEE’ )) AS T
Example 3: Check the current type of statistics information collected for table T1
db2 => 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
1 record(s) selected.
Usage notes
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), 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_V95 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).
Chapter 3. Supported routines and views 201
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.
v The logical size reported for LOB objects created before DB2 UDB Version 8
might be larger than the physical size if the objects have not yet been
reorganized.
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
ADMINTABINFO administrative view and the
ADMIN_GET_TAB_INFO_V95 table function metadata
Table 64. ADMINTABINFO administrative view and the ADMIN_GET_TAB_INFO_V95 table function metadata
Column name Data type Description
TABSCHEMA VARCHAR(128) Schema name.
TABNAME VARCHAR(128) Table name.
TABTYPE CHAR(1) Table type:
v ’H’ = hierarchy table
v ’S’ = materialized query table
v ’T’ = table
DBPARTITIONNUM SMALLINT Database partition number.
DATA_PARTITION_ID INTEGER Data partition number.
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.
202 Administrative Routines and Views
Table 64. ADMINTABINFO administrative view and the ADMIN_GET_TAB_INFO_V95 table function
metadata (continued)
Column name Data type Description
DATA_OBJECT_L_SIZE 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 multi-dimensional clustering (MDC)
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. 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.
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. Space consumed by
LOB data, Long Data, Indexes and XML objects are
reported by other columns.
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. This
value is only reported for non-partitioned tables. For
partitioned tables, this value will be 0.
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. This value
is only reported for non-partitioned tables. For partitioned
tables this value will be 0.
LONG_OBJECT_L_SIZE BIGINT Long object logical size. Amount of disk space logically
allocated for long field 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 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.
Chapter 3. Supported routines and views 203
Table 64. ADMINTABINFO administrative view and the ADMIN_GET_TAB_INFO_V95 table function
metadata (continued)
Column name Data type Description
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
allocated for LOB data in a table, reported in kilobytes.
The size includes space allocated for the LOB allocation
object. The size returned takes into account full extents
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.
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 XML 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 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
allocated for XML data in a table, reported in kilobytes.
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:
v 1 if type-1 indexes are being used.
v 2 if type-2 indexes are being 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.
INPLACE_REORG_STATUS VARCHAR(10) Current status of an inplace table reorganization on the
table. The status value can be one of the following:
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
204 Administrative Routines and Views
Table 64. ADMINTABINFO administrative view and the ADMIN_GET_TAB_INFO_V95 table function
metadata (continued)
Column name Data type Description
LOAD_STATUS VARCHAR(12) Current status of a load operation against the table. The
status value can be one of the following:
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) ’Y’ if any of the indexes defined on the table 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).
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.
DICTIONARY_SIZE BIGINT Size of the dictionary, in bytes, used for row compression
if a row compression dictionary exists for the table.
BLOCKS_PENDING_CLEANUP BIGINT For MDC tables, the number of blocks pending cleanup.
For non MDC tables this value will always be zero.
Chapter 3. Supported routines and views 205
Table 64. ADMINTABINFO administrative view and the ADMIN_GET_TAB_INFO_V95 table function
metadata (continued)
Column name Data type Description
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
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.
Syntax
AUDIT_ARCHIVE ( directory , dbpartitionnum )
The schema is SYSPROC.
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, NULL or -2 for an
aggregate of all database partitions.
206 Administrative Routines and Views
Authorization
Execute privilege on the AUDIT_ARCHIVE procedure or table function, and
SECADM authority on the database.
Examples
Example 1: Archive the audit log(s) for all database partitions to the default
directory using the procedure.
CALL SYSPROC.AUDIT_ARCHIVE(NULL, NULL)
Example 2: Archive the audit log(s) for all database partitions to the default
directory using the table function.
SELECT * FROM TABLE(SYSPROC.AUDIT_ARCHIVE(’’, -2)) AS T1
Information returned
Table 65. Information returned by the AUDIT_ARCHIVE procedure and table function
Column name Data type Description
DBPARTITIONNUM INTEGER Partition number of archived file.
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.
SQLERRMC VARCHAR(70) The sqlerrmc received while attempting
FOR BIT DATA archive file. If SQLSTATE is NULL, the value
is zero.
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 )
The schema is SYSPROC.
Procedure parameters
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.
Chapter 3. Supported routines and views 207
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
An optional input argument of type VARCHAR(1024) that specifies the
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 privileges on the AUDIT_DELIM_EXTRACT and AUDIT_LIST_LOGS
functions, and SECADM authority on the database.
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%’, ’CATEGORIES EXECUTE STATUS BOTH’)
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 )
The schema is SYSPROC.
Procedure parameters
directory
An optional 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, then the search default
directory is used.
208 Administrative Routines and Views
Authorization
EXECUTE privilege on AUDIT_LIST_LOGS table function and SECADM authority
on the database.
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 66. 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.
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 )
The schema is SYSPROC.
Procedure parameters
policy_type
An input argument of type VARCHAR(128) that specifies the type of automatic
maintenance policy to retrieve. The value can be one of the following:
AUTO_BACKUP
automatic backup
AUTO_REORG
automatic table and index reorganization
AUTO_RUNSTATS
automatic table runstats operations
MAINTENANCE_WINDOW
maintenance window
Chapter 3. Supported routines and views 209
policy
An output argument of type BLOB(2M) that specifies the automatic
maintenance settings for the given policy type, in XML format.
Authorization
EXECUTE privilege on the AUTOMAINT_GET_POLICY procedure.
Example
Here is an example of a call to the AUTOMAINT_GET_POLICY procedure from
within embedded SQL C source code.
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 )
The schema is SYSPROC.
Procedure parameters
policy_type
An input argument of type VARCHAR(128) that specifies the type of automatic
maintenance policy to retrieve. The value can be one of the following:
AUTO_BACKUP
automatic backup
AUTO_REORG
automatic table and index reorganization
AUTO_RUNSTATS
automatic table runstats operations
MAINTENANCE_WINDOW
maintenance window
210 Administrative Routines and Views
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. 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
EXECUTE privilege on the AUTOMAINT_GET_POLICYFILE procedure.
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.
Syntax
AUTOMAINT_SET_POLICY ( policy_type , policy )
The schema is SYSPROC.
Table function parameters
policy_type
An input argument of type VARCHAR(128) that specifies the type of automatic
maintenance policy to configure. The value can be one of the following:
AUTO_BACKUP
automatic backup
AUTO_REORG
automatic table and index reorganization
Chapter 3. Supported routines and views 211
AUTO_RUNSTATS
automatic table runstats operations
MAINTENANCE_WINDOW
maintenance window
policy
An input argument of type BLOB(2M) that specifies the automatic maintenance
policy in XML format.
Authorization
EXECUTE privilege on the SYSPROC.AUTOMAINT_SET_POLICY procedure.
Example
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 will replace 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.″
There are sample XML input files located in the SQLLIB/samples/automaintcfg
directory that you can modify to suit your requirements, and pass the XML content
inside BLOB() scalar function as given in the example above.
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 )
The schema is SYSPROC.
Table function parameters
policy_type
An input argument of type VARCHAR(128) that specifies the type of automatic
maintenance policy to configure. The value can be one of the following:
AUTO_BACKUP
automatic backup
212 Administrative Routines and Views
AUTO_REORG
automatic table and index reorganization
AUTO_RUNSTATS
automatic table runstats operations
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.
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
EXECUTE privilege on the SYSPROC.AUTOMAINT_SET_POLICYFILE procedure.
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 file.
Configuration routines and views
DB_PARTITIONS
The DB_PARTITIONS table function returns the contents of the db2nodes.cfg file in
table form.
Syntax
DB_PARTITIONS ( )
The schema is SYSPROC.
Chapter 3. Supported routines and views 213
Authorization
EXECUTE privilege on the DB_PARTITIONS table function.
Table function parameters
The function has no input parameters.
Example
Retrieve information from a 3 logical partition database.
SELECT * FROM TABLE(DB_PARTITIONS()) AS T
The following is an example of output from this query.
PARTITION_NUMBER HOST_NAME PORT_NUMBER SWITCH_NAME
---------------- --------------------...- ----------- -----------...-
0 jessicae.torolab.ibm.com 0 jessicae
1 jessicae.torolab.ibm.com 1 jessicae
2 jessicae.torolab.ibm.com 2 jessicae
3 record(s) selected.
Information returned
Table 67. Information returned by the DB_PARTITIONS table function
Column name Data type Description
PARTITION_NUMBER SMALLINT A unique number between 0
and 999 that identifies a
database partition server in a
partitioned database
environment.
HOST_NAME VARCHAR(128) The TCP/IP host name of the
database partition server.
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.
DBCFG administrative view - Retrieve database configuration
parameter information
The DBCFG administrative view retrieves database configuration parameter
information for the currently connected database for all database partitions.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the DBCFG administrative view and EXECUTE
privilege on the DB_GET_CFG table function.
214 Administrative Routines and Views
Examples
Example 1: Retrieve the automatic maintenance settings in the database
configuration that are stored in memory for all database partitions.
SELECT DBPARTITIONNUM, NAME, VALUE FROM SYSIBMADM.DBCFG WHERE NAME LIKE ’auto_%’
The following is an example of output for this query.
DBPARTITIONNUM NAME VALUE
-------------- -------------------------------- --------------...-------
0 auto_maint OFF
0 auto_db_backup OFF
0 auto_tbl_maint OFF
0 auto_runstats OFF
0 auto_stats_prof OFF
0 auto_prof_upd OFF
0 auto_reorg OFF
0 autorestart ON
8 record(s) selected.
Example 2: Retrieve all the database configuration parameters values stored on disk
for all database partitions.
SELECT NAME, DEFERRED_VALUE, DBPARTITIONNUM FROM SYSIBMADM.DBCFG
The following is an example of output for this query.
NAME DEFERRED_VALUE DBPARTITIONNUM
----------------...- ---------------...- --------------
app_ctl_heap_sz 128 0
appgroup_mem_sz 30000 0
applheapsz 256 0
archretrydelay 20 0
...
autorestart ON 0
avg_appls 1 0
blk_log_dsk_ful NO 0
catalogcache_sz -1 0
...
Information returned
Table 68. Information returned by the DBCFG administrative view
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
configuration parameter
has been set to automatic
Chapter 3. Supported routines and views 215
Table 68. Information returned by the DBCFG administrative view (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) Provides specific information
for the configuration
parameter deferred value.
Valid values are:
v NONE - no additional
information
v AUTOMATIC - the
configuration parameter
has been set to automatic
DATATYPE VARCHAR(128) Configuration parameter data
type.
DBPARTITIONNUM SMALLINT Database partition number.
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.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the DBMCFG administrative view and
EXECUTE privilege on the DBM_GET_CFG table function.
Examples
Example 1: Retrieve values for all the database manager configuration parameters
stored on disk:
SELECT NAME, DEFERRED_VALUE FROM SYSIBMADM.DBMCFG
The following is an example of output for this query.
NAME DEFERRED_VALUE
-------------------------------- -------------------...----
agent_stack_sz 0
216 Administrative Routines and Views
agentpri -1
aslheapsz 15
audit_buf_sz 0
authentication SERVER
catalog_noauth YES
clnt_krb_plugin
...
comm_bandwidth 0.000000e+00
conn_elapse 0
cpuspeed 4.000000e-05
dft_account_str
dft_mon_bufpool OFF
...
dft_mon_timestamp ON
dft_mon_uow OFF
...
jdk_path /wsdb/v91/bldsupp/AIX5L
...
Example 2: Retrieve all the database manager configuration parameters values.
SELECT * FROM SYSIBMADM.DBMCFG
The following is an example of output for this query.
NAME VALUE VALUE_FLAGS ...
-------------...- ---------...------------ ...
agent_stack_sz 0 NONE ...
agentpri -1 NONE ...
aslheapsz 15 NONE ...
audit_buf_sz 0 NONE ...
authentication SERVER NONE ...
catalog_noauth YES NONE ...
clnt_krb_plugin NONE ...
clnt_pw_plugin NONE ...
comm_bandwidth 0.000000e+00 NONE ...
conn_elapse 0 NONE ...
cpuspeed 4.000000e-05 NONE ...
dft_account_str NONE ...
dft_mon_bufpool OFF NONE ...
dft_mon_lock OFF NONE ...
dft_mon_sort OFF NONE ...
dft_mon_stmt OFF NONE ...
dft_mon_table OFF NONE ...
... ...
dir_cache YES NONE ...
discover SEARCH NONE ...
discover_inst ENABLE NONE ...
fcm_num_anchors 0 AUTOMATIC ...
fcm_num_buffers 0 AUTOMATIC ...
fcm_num_connect 0 AUTOMATIC ...
...
Output for this query (continued).
... DEFERRED_VALUE DEFERRED_VALUE_FLAGS DATATYPE
... --------------...- ------------------------- ---------...-
... 0 NONE INTEGER
... -1 NONE INTEGER
... 15 NONE BIGINT
... 0 NONE BIGINT
... SERVER NONE VARCHAR(32)
... YES NONE VARCHAR(3)
... NONE VARCHAR(32)
... NONE VARCHAR(32)
... 0.000000e+00 NONE REAL
... 0 NONE INTEGER
... 4.000000e-05 NONE REAL
Chapter 3. Supported routines and views 217
... NONE VARCHAR(25)
... OFF NONE VARCHAR(3)
... OFF NONE VARCHAR(3)
... OFF NONE VARCHAR(3)
... OFF NONE VARCHAR(3)
... OFF NONE VARCHAR(3)
...
... YES NONE VARCHAR(3)
... SEARCH NONE VARCHAR(8)
... ENABLE NONE VARCHAR(8)
... 0 AUTOMATIC BIGINT
... 512 AUTOMATIC BIGINT
... 0 AUTOMATIC BIGINT
...
Information returned
Table 69. Information returned by the DBMCFG administrative view
Column name Data type Description
NAME VARCHAR(32) Configuration parameter
name.
VALUE VARCHAR(256) 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
configuration parameter
has been set to automatic
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.
DEFERRED_VALUE_FLAGS VARCHAR(10) Provides specific information
for the configuration
parameter deferred value.
Valid values are:
v NONE - no additional
information
v AUTOMATIC - the
configuration parameter
has been set to automatic
DATATYPE VARCHAR(128) Configuration parameter data
type.
218 Administrative Routines and Views
REG_VARIABLES administrative view - Retrieve DB2 registry
settings in use
The REG_VARIABLES administrative view returns the DB2 registry settings from
all database partitions. 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.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the REG_VARIABLES administrative view and
EXECUTE privilege on the REG_LIST_VARIABLES table function.
Example
Request the DB2 registry settings that are currently being used.
SELECT * from SYSIBMADM.REG_VARIABLES
The following is an example of output from this query.
DBPARTITIONNUM REG_VAR_NAME REG_VAR_VALUE IS_AGGREGATE AGGREGATE_NAME
-------------- ---------------...- -------------...- ------------ --------------...-
0 DB2ADMINSERVER DB2DAS00 0 -
0 DB2INSTPROF D:\SQLLIB 0 -
0 DB2PATH D:\SQLLIB 0 -
0 DB2SYSTEM D570 0 -
0 DB2TEMPDIR D:\SQLLIB\ 0 -
0 DB2_EXTSECURITY YES 0 -
6 record(s) selected.
Information returned
Table 70. Information returned by the REG_VARIABLES administrative view
Column name Data type Description
DBPARTITIONNUM SMALLINT Logical partition number of
each database partition on
which the function operates.
REG_VAR_NAME VARCHAR(256) Name of the DB2 registry
variable.
REG_VAR_VALUE VARCHAR(2048) Current setting of the DB2
registry variable.
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.
Chapter 3. Supported routines and views 219
Table 70. Information returned by the REG_VARIABLES administrative view (continued)
Column name Data type Description
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.
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
Environment views
ENV_INST_INFO administrative view - Retrieve information
about the current instance
The ENV_INST_INFO administrative view returns information about the current
instance.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the ENV_INST_INFO administrative view and
EXECUTE privilege on the ENV_GET_INST_INFO table function.
Example
Request information about the current instance.
SELECT * FROM SYSIBMADM.ENV_INST_INFO
The following is an example of output for this query.
INST_NAME IS_INST_PARTITIONABLE NUM_DBPARTITIONS INST_PTR_SIZE ...
-----------...---- --------------------- ---------------- ------------- ...
DB2 0 1 32 ...
...
1 record(s) selected. ...
Output for this query (continued).
220 Administrative Routines and Views
... RELEASE_NUM SERVICE_LEVEL BLD_LEVEL PTF FIXPACK_NUM
... -----------...--- --------------...--- ----------...--- ----...--- -----------
... 01010107 DB2 v9.1.0.115 n051106 0
...
Information returned
Table 71. 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, as returned by
the db2level command; for
example, DB2 v8.1.1.80.
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.
ENV_PROD_INFO administrative view - Retrieve information
about installed DB2 products
The ENV_PROD_INFO administrative view returns information about installed
DB2 products.
The schema is SYSIBMADM.
Chapter 3. Supported routines and views 221
Authorization
SELECT or CONTROL privilege on the ENV_PROD_INFO administrative view
and EXECUTE privilege on the ENV_GET_PROD_INFO_V95 table function.
Example
Request the installed DB2 product information.
SELECT * FROM SYSIBMADM.ENV_PROD_INFO
The following is an example of output from this query.
INSTALLED_PROD INSTALLED_PROD_FULLNAME ...
-------------- ------------------------------ ...
ESE DB2_ENTERPRISE_SERVER_EDITION ...
WSE DB2_WORKGROUP_SERVER_EDITION ...
EXP DB2_EXPRESS_EDITION ...
Output from this query (continued).
... LICENSE_INSTALLED PROD_RELEASE LICENSE_TYPE
... ----------------- ------------ ----------------------
... Y 9.5 AUTHORIZED_USER_OPTION
... N 9.5 LICENSE_NOT_REGISTERED
... Y 9.5 RESTRICTED
ENV_PROD_INFO administrative view metadata
Table 72. 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.
PROD_RELEASE VARCHAR(26) Product release number.
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
222 Administrative Routines and Views
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.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the ENV_FEATURE_INFO administrative view
and EXECUTE privilege on the ENV_GET_FEATURE_INFO table function.
Example
Request the installed DB2 features license information.
SELECT * FROM SYSIBMADM.ENV_FEATURE_INFO
The following is an example of output from this query.
FEATURE_NAME FEATURE_FULLNAME ...
------------ -------------------------------------------- ...
DPF DB2_DATABASE_PARTITIONING_FEATURE ...
POESE DB2_PERFORMANCE_OPTIMIZATION_FEATURE_FOR_ESE ...
SO DB2_STORAGE_OPTIMIZATION_FEATURE ...
AAC DB2_ADVANCED_ACCESS_CONTROL_FEATURE ...
GEO DB2_GEODETIC_DATA_MANAGEMENT_FEATURE ...
HFESE IBM_HOMOGENEOUS_FEDERATION_FEATURE_FOR_ESE ...
XMLESE DB2_PUREXML_FEATURE_FOR_ESE ...
Output from this query (continued).
... LICENSE_INSTALLED PRODUCT_NAME FEATURE_USE_STATUS
... ----------------- ------------ ------------------
... Y ESE IN_COMPLIANCE
... Y ESE IN_COMPLIANCE
... Y ESE IN_COMPLIANCE
... Y ESE NOT_USED
... Y ESE NOT_USED
... Y ESE NOT_USED
... N ESE IN_VIOLATION
ENV_FEATURE_INFO administrative view metadata
Table 73. 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.
Chapter 3. Supported routines and views 223
Table 73. ENV_FEATURE_INFO administrative view metadata (continued)
Column name Data type Description
PRODUCT_NAME VARCHAR(26) Identifiers for DB2 server product on which the
feature is available. The possible return values are:
v ESE - DB2 Enterprise Server Edition
v WSE - DB2 Workgroup Server Edition
v EXP - DB2 Express Edition
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_SYS_INFO administrative view - Retrieve information
about the system
The ENV_SYS_INFO administrative view returns information about the system.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the ENV_SYS_INFO administrative view and
EXECUTE privilege on the ENV_GET_SYS_INFO table function.
Example
Request information about the system.
SELECT * from SYSIBMADM.ENV_SYS_INFO
The following is an example of output from this query.
OS_NAME OS_VERSION OS_RELEASE HOST_NAME
--------...- ----------...- --------------...- ---------...-
WIN32_NT 5.1 Service Pack 1 D570
1 record(s) selected.
Output from this query (continued).
... TOTAL_CPUS CONFIGURED_CPUS TOTAL_MEMORY
... ----------- --------------- ------------
... 1 2 1527
Information returned
Table 74. Information returned by the ENV_SYS_INFO administrative view
Column name Data type Description
OS_NAME VARCHAR(256) Name of the operating
system.
224 Administrative Routines and Views
Table 74. Information returned by the ENV_SYS_INFO administrative view (continued)
Column name Data type Description
OS_VERSION VARCHAR(256) Version number of the
operating system.
OS_RELEASE VARCHAR(256) Release number of the
operating system.
HOST_NAME VARCHAR(256) Name of the system.
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).
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.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the ENV_SYS_RESOURCES administrative
view and EXECUTE privilege on the ENV_GET_SYS_RESOURCES table function.
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’
The following is an example of output from this query.
NAME VALUE DATATYPE DBPARTITIONNUM
----------------------- ---------- ---------- --------------
CPU_LOAD_SHORT 0.044052 DECIMAL 0
CPU_LOAD_MEDIUM 0.087250 DECIMAL 0
CPU_LOAD_LONG 0.142059 DECIMAL 0
CPU_USAGE_TOTAL 7 SMALLINT 0
4 record(s) selected.
ENV_SYS_RESOURCES administrative view metadata
Table 75. ENV_SYS_RESOURCES administrative view metadata
Column name Data type Description
NAME VARCHAR(128) Name of the attribute. See Table 76 on page
226 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.
Chapter 3. Supported routines and views 225
Table 75. ENV_SYS_RESOURCES administrative view metadata (continued)
Column name Data type Description
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 76. Possible values for the NAME column
Platforms
that return
Information this
type Name Data Types Description information UNIT
Operating OS_NAME VARCHAR(256) Name of the All NULL
system operating system
software.
HOST_NAME VARCHAR(256) Host name of the All NULL
system.
OS_VERSION VARCHAR(256) Version of the All NULL
operating system.
For example, AIX:
4.3 version = 4.
OS_RELEASE VARCHAR(256) Release of the All NULL
operating system.
For example, AIX:
4.3 release = 3.
MACHINE_IDENTIFICATION VARCHAR(256) Machine hardware All NULL
identification.
OS_LEVEL VARCHAR(256) Maintenance level of Linux NULL
the current version
and release. For
example, LINUX:
2.4.9, level = 9.
226 Administrative Routines and Views
Table 76. Possible values for the NAME column (continued)
Platforms
that return
Information this
type Name Data Types Description information UNIT
CPU CPU_TOTAL BIGINT Total number of All NULL
CPUs.
CPU_ONLINE BIGINT Number of CPUs All NULL
online.
CPU_CONFIGURED BIGINT Number of CPUs All NULL
configured.
CPU_SPEED BIGINT Speed of CPUs. All MHz
CPU_TIMEBASE BIGINT Frequency of Linux Hz
timebase register PowerPC®
increment.
CPU_HMT_DEGREE BIGINT On systems that All NULL
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″.
CPU_CORES_PER_SOCKET BIGINT Number of CPU All NULL
cores per socket. On
single core systems
this value is 1.
Physical MEMORY_TOTAL BIGINT Total size of physical All MB
memory memory.
MEMORY_FREE BIGINT Amount of free All MB
physical memory.
MEMORY_SWAP_TOTAL BIGINT Total amount of All MB
swap space.
MEMORY_SWAP_FREE BIGINT Amount of free All MB
swap space.
Virtual memory VIRTUAL_MEM_TOTAL BIGINT Total amount of All MB
virtual memory on
the system.
VIRTUAL_MEM_RESERVED BIGINT Amount of reserved All MB
virtual memory.
VIRTUAL_MEM_FREE BIGINT Amount of virtual All MB
memory free.
Chapter 3. Supported routines and views 227
Table 76. Possible values for the NAME column (continued)
Platforms
that return
Information this
type Name Data Types Description information UNIT
CPU load CPU_LOAD_SHORT DECIMAL Shortest period All except NULL
duration. For Windows
example, load operating
samples over last 5 systems
minutes.
CPU_LOAD_MEDIUM DECIMAL Medium period All except NULL
duration. For Windows
example, load operating
samples over last 10 systems
minutes.
CPU_LOAD_LONG DECIMAL Long period All except NULL
duration. For Windows
example, load operating
samples over last 15 systems
minutes.
CPU_USAGE_TOTAL DECIMAL Percentage of overall All Percent
CPU usage of the
machine.
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.
Syntax
HEALTH_CONT_HI ( dbname , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
228 Administrative Routines and Views
Authorization
EXECUTE privilege on the HEALTH_CONT_HI table function.
Example
SELECT * FROM TABLE(HEALTH_CONT_HI(’’,-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP CONTAINER_NAME ...
-------------------------- -------------------------------------------...- ...
2006-02-13-12.30.40.759542 D:\DB2\NODE0000\SAMPLE\T0000000\C0000000.CAT ...
2006-02-13-12.30.40.759542 D:\DB2\NODE0000\SAMPLE\T0000003\C0000000.LRG ...
2006-02-13-12.30.40.759542 D:\DB2\NODE0000\SAMPLE\T0000004\C0000000.UTM ...
2006-02-13-12.30.40.759542 D:\DB2\NODE0000\SAMPLE\T0000001\C0000000.TMP ...
2006-02-13-12.30.40.759542 D:\DB2\NODE0000\SAMPLE\T0000002\C0000000.LRG ...
5 record(s) selected.
Output from this query (continued).
... 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 ...
Output from this query (continued).
... HI_ALERT_STATE HI_ALERT_STATE_DETAIL HI_FORMULA HI_ADDITIONAL_INFO
... -------------------- --------------------- -----------...- ------------------
... 1 Normal 1 -
... 1 Normal 1 -
... 1 Normal 1 -
... 1 Normal 1 -
... 1 Normal 1 -
Information returned
Table 77. Information returned by the HEALTH_CONT_HI table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
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 The date and time that the
alert was generated.
HI_ALERT_STATE BIGINT The severity of the alert.
Chapter 3. Supported routines and views 229
Table 77. Information returned by the HEALTH_CONT_HI table function (continued)
Description or
corresponding monitor
Column name Data type element
HI_ALERT_STATE_DETAIL VARCHAR(20) The text description of the
HI_ALERT_STATE column.
HI_FORMULA VARCHAR(2048) The formula used to calculate
the health indicator.
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 , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the HEALTH_CONT_HI_HIS table function.
Example
SELECT * FROM TABLE(HEALTH_CONT_HI_HIS(’’,-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP CONTAINER_NAME ...
-------------------------- ----------------------------------------...- ...
2006-02-13-12.30.41.915646 D:\DB2\NODE0000\SAMPLE\T0000000\C0000000.CAT ...
2006-02-13-12.30.41.915646 D:\DB2\NODE0000\SAMPLE\T0000000\C0000000.CAT ...
2006-02-13-12.30.41.915646 D:\DB2\NODE0000\SAMPLE\T0000003\C0000000.LRG ...
2006-02-13-12.30.41.915646 D:\DB2\NODE0000\SAMPLE\T0000003\C0000000.LRG ...
2006-02-13-12.30.41.915646 D:\DB2\NODE0000\SAMPLE\T0000004\C0000000.UTM ...
2006-02-13-12.30.41.915646 D:\DB2\NODE0000\SAMPLE\T0000004\C0000000.UTM ...
230 Administrative Routines and Views
2006-02-13-12.30.41.915646 D:\DB2\NODE0000\SAMPLE\T0000001\C0000000.TMP ...
2006-02-13-12.30.41.915646 D:\DB2\NODE0000\SAMPLE\T0000001\C0000000.TMP ...
2006-02-13-12.30.41.915646 D:\DB2\NODE0000\SAMPLE\T0000002\C0000000.LRG ...
2006-02-13-12.30.41.915646 D:\DB2\NODE0000\SAMPLE\T0000002\C0000000.LRG ...
10 record(s) selected.
Output from this query (continued).
... 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 ...
Output from this query (continued).
... HI_ALERT_STATE_DETAIL HI_FORMULA HI_ADDITIONAL_INFO
... --------------------- -----------...- ------------------
... Normal 1 -
... Normal 1 -
... Normal 1 -
... Normal 1 -
... Normal 1 -
... Normal 1 -
... Normal 1 -
... Normal 1 -
... Normal 1 -
... Normal 1 -
Information returned
Table 78. Information returned by the HEALTH_CONT_HI_HIS table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
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_TIMESTAMP TIMESTAMP The date and time that the
alert was generated.
HI_VALUE SMALLINT The value of the health
indicator.
HI_ALERT_STATE BIGINT The severity of the alert.
HI_ALERT_STATE_DETAIL VARCHAR(20) The text description of the
HI_ALERT_STATE column.
Chapter 3. Supported routines and views 231
Table 78. Information returned by the HEALTH_CONT_HI_HIS table function (continued)
Description or
corresponding monitor
Column name Data type element
HI_FORMULA VARCHAR(2048) The formula used to calculate
the health indicator.
HI_ADDITIONAL_INFO VARCHAR(4096) Additional information about
the health indicator.
HEALTH_CONT_INFO
The HEALTH_CONT_INFO table function returns container information from a
health snapshot of a database.
Syntax
HEALTH_CONT_INFO ( dbname , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the HEALTH_CONT_INFO table function.
Example
SELECT * FROM TABLE(HEALTH_CONT_INFO(’’,-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP CONTAINER_NAME ...
-------------------------- -----------------------------------------...- ...
2006-02-13-12.30.40.541209 D:\DB2\NODE0000\SAMPLE\T0000000\C0000000.CAT ...
2006-02-13-12.30.40.541209 D:\DB2\NODE0000\SAMPLE\T0000003\C0000000.LRG ...
2006-02-13-12.30.40.541209 D:\DB2\NODE0000\SAMPLE\T0000004\C0000000.UTM ...
2006-02-13-12.30.40.541209 D:\DB2\NODE0000\SAMPLE\T0000001\C0000000.TMP ...
2006-02-13-12.30.40.541209 D:\DB2\NODE0000\SAMPLE\T0000002\C0000000.LRG ...
5 record(s) selected.
232 Administrative Routines and Views
Output from this query (continued).
... TABLESPACE_NAME NODE_NUMBER ...
... ---------------...- ----------- ...
... SYSCATSPACE - ...
... SYSTOOLSPACE - ...
... SYSTOOLSTMPSPACE - ...
... TEMPSPACE1 - ...
... USERSPACE1 - ...
Output from this query (continued).
... ROLLED_UP_ALERT_STATE ROLLED_UP_ALERT_STATE_DETAIL
... --------------------- ----------------------------
... 1 Normal
... 1 Normal
... 1 Normal
... 1 Normal
... 1 Normal
Information returned
Table 79. Information returned by the HEALTH_CONT_INFO table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
CONTAINER_NAME VARCHAR(256) container_name - Container
name
TABLESPACE_NAME VARCHAR(128) tablespace_name - Table
space name
NODE_NUMBER INTEGER node_number - Node number
ROLLED_UP_ALERT_STATE BIGINT The most severe alert state
captured by this snapshot.
VARCHAR(20) The text description of the
ROLLED_UP_ALERT_ ROLLED_UP_ALERT_STATE
STATE_DETAIL column.
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 , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
this function. Specify a database name that has a directory entry type of either
Chapter 3. Supported routines and views 233
″Indirect″ or ″Home″, as returned by the LIST DATABASE DIRECTORY
command. Specify the null value to take the snapshot from all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the HEALTH_DB_HI table function.
Example
SELECT * FROM TABLE(HEALTH_DB_HI(’’,-1)) AS T
The following is an example of output from this query.
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 ...
11 record(s) selected.
Output from this query (continued).
... 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 ...
Output from this query (continued).
... HI_FORMULA ...
... ----------------------------------------...- ...
... 0 ...
... ((0 / 5000) * 100) ...
... ...
... ...
... ...
... ...
... ...
... ...
234 Administrative Routines and Views
... ...
... (((0 - 0) / ((118 - 0) + 1)) * 100) ...
... ...
... ...
... ...
... ...
... ...
... ((1170384 / (1170384 + 19229616)) * 100) ...
... ...
... ...
... ...
... ...
... ...
... ((11155116032 / 21138935808) * 100) ...
... ...
... ...
... ...
... ...
... ...
... ...
... ...
... ((5264 / (50 * 4096)) * 100) ...
... ((0 / 5) * 100) ...
... ((4587520 / 6160384) * 100) ...
... - ...
... ...
... ...
... ...
... ...
... ...
... - ...
... ...
... ...
... ...
... ...
... ...
... ...
... ...
... - ...
... ...
... ...
Output from this query (continued).
... 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".
Chapter 3. Supported routines and views 235
... The following are the related
... database configuration parameter
... settings: logprimary is "3",
... logsecond is "2", and logfilsiz
... is "1000", blk_log_dsk_ful is
... "NO", userexit is "NO",
... logarchmeth1 is "OFF" and
... logarchmeth2 is "OFF".
... -
... -
... -
... 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".
... The scope is "N\A". Automatic
... statistics collection (AUTO_RUNSTATS)
... is set to "OFF".
Information returned
Table 80. Information returned by the HEALTH_DB_HI table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
HI_ID BIGINT A number that uniquely
identifies the health indicator
in the snapshot data stream.
DB_NAME VARCHAR(128) db_name - Database name
HI_VALUE SMALLINT The value of the health
indicator.
HI_TIMESTAMP TIMESTAMP The date and time that the
alert was generated.
HI_ALERT_STATE BIGINT The severity of the alert.
HI_ALERT_STATE_DETAIL VARCHAR(20) The text description of the
HI_ALERT_STATE column.
HI_FORMULA VARCHAR(2048) The formula used to calculate
the health indicator.
HI_ADDITIONAL_INFO VARCHAR(4096) Additional information about
the health indicator.
HEALTH_DB_HI_HIS
The HEALTH_DB_HI_HIS table function returns health indicator history
information from a health snapshot of a database.
236 Administrative Routines and Views
Syntax
HEALTH_DB_HI_HIS ( dbname , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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 all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the HEALTH_DB_HI_HIS table function.
Example
SELECT * FROM TABLE(HEALTH_DB_HI_HIS(’’,-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP HI_ID DB_NAME HI_VALUE ...
-------------------------- -----...- -------...- -------- ...
2006-02-13-12.30.26.325627 1001 SAMPLE 0 ...
... ...
2006-02-13-12.30.26.325627 1002 SAMPLE 0 ...
... ...
2006-02-13-12.30.26.325627 1003 SAMPLE 0 ...
... ...
2006-02-13-12.30.26.325627 1005 SAMPLE 3 ...
... ...
2006-02-13-12.30.26.325627 1008 SAMPLE 2 ...
... ...
2006-02-13-12.30.26.325627 1010 SAMPLE 0 ...
... ...
2006-02-13-12.30.26.325627 1014 SAMPLE 73 ...
... ...
2006-02-13-12.30.26.325627 1015 SAMPLE 1 ...
... ...
2006-02-13-12.30.26.325627 1018 SAMPLE 1 ...
... ...
2006-02-13-12.30.26.325627 1022 SAMPLE 1 ...
...
Output from this query (continued).
... HI_TIMESTAMP HI_ALERT_STATE HI_ALERT_STATE_DETAIL ...
... -------------------------- -------------------- --------------------- ...
... 2006-02-13-12.21.25.649000 1 Normal ...
... ... ...
Chapter 3. Supported routines and views 237
... 2006-02-13-12.21.25.649000 1 Normal ...
... ... ...
... 2006-02-13-12.20.25.182000 1 Normal ...
... ... ...
... 2006-02-13-12.16.25.911000 1 Normal ...
... ... ...
... 2006-02-13-12.16.25.911000 1 Normal ...
... ... ...
... 2006-02-13-12.16.25.911000 1 Normal ...
... ... ...
... 2006-02-13-12.21.25.649000 1 Normal ...
... ... ...
... 2006-02-13-12.29.55.461000 2 Attention ...
... ... ...
... 2006-02-13-12.29.25.281000 2 Attention ...
... ... ...
... 2006-02-13-12.27.55.743000 2 Attention ...
... ...
Output from this query (continued).
... 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) ...
... ... ...
... - ...
... ...
... ...
... ...
... ...
... ...
... ...
... ...
... ... ...
... - ...
... ...
... ...
... ...
238 Administrative Routines and Views
... ...
... ...
... ...
... ...
... ... ...
... - ...
... ...
... ...
... ... ...
Output from this query (continued).
... 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
... 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 "15". 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".
...
... -
...
... -
...
... -
...
... 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".
...
... The scope is "N\A". Automatic
... statistics collection
... (AUTO_RUNSTATS) is set to "OFF".
...
Chapter 3. Supported routines and views 239
Information returned
Table 81. Information returned by the HEALTH_DB_HI_HIS table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
HI_ID BIGINT A number that uniquely
identifies the health indicator
in the snapshot data stream.
DB_NAME VARCHAR(128) db_name - Database name
HI_VALUE SMALLINT The value of the health
indicator.
HI_TIMESTAMP TIMESTAMP The date and time that the
alert was generated.
HI_ALERT_STATE BIGINT The severity of the alert.
HI_ALERT_STATE_DETAIL VARCHAR(20) The text description of the
HI_ALERT_STATE column.
HI_FORMULA VARCHAR(2048) The formula used to calculate
the health indicator.
HI_ADDITIONAL_INFO VARCHAR(4096) Additional information about
the health indicator.
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 , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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 all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
240 Administrative Routines and Views
Authorization
EXECUTE privilege on the HEALTH_DB_HIC table function.
Example
SELECT * FROM TABLE(HEALTH_DB_HIC(’’,-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP HI_ID DB_NAME ...
-------------------------- -----...- -------...- ...
2006-02-13-12.30.33.870959 1015 SAMPLE ...
2006-02-13-12.30.33.870959 1022 SAMPLE ...
2 record(s) selected.
Output from this query (continued).
... HI_OBJ_NAME HI_OBJ_DETAIL ...
... ---------------------------------...-- -------------...- ...
... "JESSICAE"."EMPLOYEE" REORG TABLE ...
... "SYSIBM"."SYSDATAPARTITIONEXPRESSION" RUNSTATS ...
Output from this query (continued).
... 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
Information returned
Table 82. Information returned by the HEALTH_DB_HIC table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
HI_ID BIGINT A number that uniquely
identifies the health indicator
in the snapshot data stream.
DB_NAME VARCHAR(128) db_name - Database name
HI_OBJ_NAME VARCHAR(256) A name that uniquely
identifies an object in the
collection.
HI_OBJ_DETAIL VARCHAR(4096) Text that describes why the
object was added to the
collection.
Chapter 3. Supported routines and views 241
Table 82. Information returned by the HEALTH_DB_HIC table function (continued)
Description or
corresponding monitor
Column name Data type element
HI_OBJ_STATE BIGINT 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).
Automation is enabled for
this health indicator; 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 The date and time that the
alert was generated.
HEALTH_DB_HIC_HIS
Returns collection health indicator history information from a health snapshot of a
database.
Syntax
HEALTH_DB_HIC_HIS ( dbname , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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 all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
242 Administrative Routines and Views
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the HEALTH_DB_HIC_HIS table function.
Example
SELECT * FROM TABLE(HEALTH_DB_HIC_HIS(’’,-1)) AS T
The following is an example of output from this query.
HI_HIS_ENTRY_NUM SNAPSHOT_TIMESTAMP HI_ID ...
---------------- -------------------------- -------------------- ...
1 2006-02-13-12.30.34.496720 1015 ...
2 2006-02-13-12.30.34.496720 1022 ...
3 2006-02-13-12.30.34.496720 1022 ...
4 2006-02-13-12.30.34.496720 1022 ...
5 2006-02-13-12.30.34.496720 1022 ...
6 2006-02-13-12.30.34.496720 1022 ...
7 2006-02-13-12.30.34.496720 1022 ...
8 2006-02-13-12.30.34.496720 1022 ...
9 2006-02-13-12.30.34.496720 1022 ...
10 2006-02-13-12.30.34.496720 1022 ...
10 record(s) selected.
Output from this query (continued).
... DB_NAME HI_OBJ_NAME HI_OBJ_STATE ...
... -------...- ----------------------------------...- ------------ ...
... SAMPLE "JESSICAE"."EMPLOYEE" 2 ...
... SAMPLE "SYSIBM"."SYSDATAPARTITIONEXPRESSION" 2 ...
... SAMPLE "SYSIBM"."SYSDATAPARTITIONEXPRESSION" 2 ...
... SAMPLE "SYSIBM"."SYSDATAPARTITIONEXPRESSION" 2 ...
... SAMPLE "SYSIBM"."SYSDATAPARTITIONEXPRESSION" 1 ...
... SAMPLE "SYSIBM"."SYSDATAPARTITIONEXPRESSION" 1 ...
... SAMPLE "SYSIBM"."SYSDATAPARTITIONEXPRESSION" 1 ...
... SAMPLE "SYSIBM"."SYSDATAPARTITIONEXPRESSION" 1 ...
... SAMPLE "SYSIBM"."SYSDATAPARTITIONEXPRESSION" 1 ...
... SAMPLE "SYSIBM"."SYSDATAPARTITIONEXPRESSION" 1 ...
Output from this query (continued).
... HI_OBJ_STATE_DETAIL HI_TIMESTAMP
... -------------------- --------------------------
... Attention 2006-02-10-09.04.57.000000
... Attention 2006-02-13-12.27.56.000000
... Attention 2006-02-13-12.26.27.000000
... Attention 2006-02-13-12.24.56.000000
... Normal 2006-02-13-12.23.28.000000
... Normal 2006-02-13-12.21.56.000000
... Normal 2006-02-13-12.20.26.000000
... Normal 2006-02-13-12.18.57.000000
... Normal 2006-02-13-12.17.27.000000
... Normal 2006-02-13-12.15.56.000000
Chapter 3. Supported routines and views 243
Information returned
Table 83. Information returned by the HEALTH_DB_HIC_HIS table function
Description or
corresponding monitor
Column name Data type element
HI_HIS_ENTRY_NUM INTEGER A number that uniquely
identifies the history entry.
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
HI_ID BIGINT A number that uniquely
identifies the health indicator
in the snapshot data stream.
DB_NAME VARCHAR(128) db_name - Database name
HI_OBJ_NAME VARCHAR(256) A name that uniquely
identifies an object in the
collection.
HI_OBJ_STATE BIGINT 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).
Automation is enabled for
this health indicator; 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 The date and time that the
alert was generated.
HEALTH_DB_INFO
The HEALTH_DB_INFO table function returns information from a health snapshot
of a database.
Syntax
HEALTH_DB_INFO ( dbname , dbpartitionnum )
244 Administrative Routines and Views
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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 all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the HEALTH_DB_INFO table function.
Example
SELECT * FROM TABLE(HEALTH_DB_INFO(’’,-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP DB_NAME INPUT_DB_ALIAS ...
-------------------------- -------...- ---------------...- ...
2006-02-13-12.30.23.340081 SAMPLE SAMPLE ...
1 record(s) selected.
Output from this query (continued).
... DB_PATH DB_LOCATION SERVER_PLATFORM ...
... ------------------------...- ----------- --------------- ...
... D:\DB2\NODE0000\SQL00003\ 1 5 ...
Output from this query (continued).
... ROLLED_UP_ALERT_STATE ROLLED_UP_ALERT_STATE_DETAIL
... --------------------- ----------------------------
... 4 Alarm
Information returned
Table 84. Information returned by the HEALTH_DB_INFO table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input
database alias
DB_PATH VARCHAR(1024) db_path - Database path
Chapter 3. Supported routines and views 245
Table 84. Information returned by the HEALTH_DB_INFO table function (continued)
Description or
corresponding monitor
Column name Data type element
DB_LOCATION INTEGER db_location - Database
location
SERVER_PLATFORM INTEGER server_platform - Server
operating system
ROLLED_UP_ALERT_STATE BIGINT The most severe alert state
captured by this snapshot.
VARCHAR(20) The text description of the
ROLLED_UP_ALERT_ ROLLED_UP_ALERT_STATE
STATE_DETAIL column.
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 ( dbpartitionnum )
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the HEALTH_DBM_HI table function.
Example
SELECT * FROM TABLE(HEALTH_DBM_HI(-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP HI_ID SERVER_INSTANCE_NAME ...
-------------------------- -----...- --------------------...- ...
2006-02-13-12.30.19.773632 1 DB2 ...
2006-02-13-12.30.19.773632 4 DB2 ...
2 record(s) selected.
Output from this query (continued).
... HI_VALUE HI_TIMESTAMP HI_ALERT_STATE HI_ALERT_STATE_DETAIL ...
... -------- -------------------------- -------------- --------------------- ...
... 0 2006-02-13-12.26.26.158000 1 Normal ...
... 100 2006-02-13-12.26.26.158000 4 Alarm ...
246 Administrative Routines and Views
Output from this query (continued).
... HI_FORMULA HI_ADDITIONAL_INFO
... ---------------------...- ------------------
... 0 -
... ((327680 / 327680) * 100) -
Table 85. Information returned by the HEALTH_DBM_HI table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
HI_ID BIGINT A number that uniquely
identifies the health indicator
in the snapshot data stream.
SERVER_INSTANCE_NAME VARCHAR(128) server_instance_name -
Server instance name
HI_VALUE SMALLINT The value of the health
indicator.
HI_TIMESTAMP TIMESTAMP The date and time that the
alert was generated.
HI_ALERT_STATE BIGINT The severity of the alert.
HI_ALERT_STATE_DETAIL VARCHAR(20) The text description of the
HI_ALERT_STATE column.
HI_FORMULA VARCHAR(2048) The formula used to calculate
the health indicator.
HI_ADDITIONAL_INFO VARCHAR(4096) Additional information about
the health indicator.
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.
Syntax
HEALTH_DBM_HI_HIS ( dbpartitionnum )
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the HEALTH_DBM_HI_HIS table function.
Chapter 3. Supported routines and views 247
Example
SELECT * FROM TABLE(HEALTH_DBM_HI_HIS(-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP HI_ID SERVER_INSTANCE_NAME HI_VALUE ...
-------------------------- -----...- --------------------...- -------- ...
2006-02-13-12.30.20.460905 1 DB2 0 ...
2006-02-13-12.30.20.460905 1 DB2 0 ...
2006-02-13-12.30.20.460905 1 DB2 0 ...
2006-02-13-12.30.20.460905 1 DB2 0 ...
2006-02-13-12.30.20.460905 1 DB2 0 ...
2006-02-13-12.30.20.460905 1 DB2 0 ...
2006-02-13-12.30.20.460905 1 DB2 0 ...
2006-02-13-12.30.20.460905 1 DB2 0 ...
2006-02-13-12.30.20.460905 1 DB2 0 ...
2006-02-13-12.30.20.460905 4 DB2 100 ...
2006-02-13-12.30.20.460905 4 DB2 100 ...
2006-02-13-12.30.20.460905 4 DB2 100 ...
2006-02-13-12.30.20.460905 4 DB2 100 ...
2006-02-13-12.30.20.460905 4 DB2 60 ...
2006-02-13-12.30.20.460905 4 DB2 60 ...
2006-02-13-12.30.20.460905 4 DB2 60 ...
2006-02-13-12.30.20.460905 4 DB2 60 ...
2006-02-13-12.30.20.460905 4 DB2 60 ...
18 record(s) selected.
Output for this query (continued).
... HI_TIMESTAMP HI_ALERT_STATE HI_ALERT_STATE_DETAIL ...
... -------------------------- -------------- --------------------- ...
... 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 ...
Output for this query (continued).
... HI_FORMULA HI_ADDITIONAL_INFO
... -------------------------...- ------------------
... 0 -
... 0 -
... 0 -
... 0 -
... 0 -
... 0 -
... 0 -
... 0 -
... 0 -
... ((327680 / 327680) * 100) -
... ((327680 / 327680) * 100) -
... ((327680 / 327680) * 100) -
248 Administrative Routines and Views
... ((327680 / 327680) * 100) -
... ((196608 / 327680) * 100) -
... ((196608 / 327680) * 100) -
... ((196608 / 327680) * 100) -
... ((196608 / 327680) * 100) -
... ((196608 / 327680) * 100) -
Information returned
Table 86. Information returned by the HEALTH_DBM_HI_HIS table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
HI_ID BIGINT A number that uniquely
identifies the health indicator
in the snapshot data stream.
SERVER_INSTANCE_NAME VARCHAR(128) server_instance_name -
Server instance name
HI_VALUE SMALLINT The value of the health
indicator.
HI_TIMESTAMP TIMESTAMP The date and time that the
alert was generated.
HI_ALERT_STATE BIGINT The severity of the alert.
HI_ALERT_STATE_DETAIL VARCHAR(20) The text description of the
HI_ALERT_STATE column.
HI_FORMULA VARCHAR(2048) The formula used to calculate
the health indicator.
HI_ADDITIONAL_INFO VARCHAR(4096) Additional information about
the health indicator.
HEALTH_DBM_INFO
The HEALTH_DBM_INFO function returns information from a health snapshot of
the DB2 database manager.
Syntax
HEALTH_DBM_INFO ( dbpartitionnum )
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Chapter 3. Supported routines and views 249
Authorization
EXECUTE privilege on the HEALTH_DBM_INFO table function.
Example
SELECT * FROM TABLE(HEALTH_DBM_INFO(-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP SERVER_INSTANCE_NAME ROLLED_UP_ALERT_STATE ...
-------------------------- --------------------...--- --------------------- ...
2006-02-13-12.30.19.663924 DB2 4 ...
1 record(s) selected.
Output from this query (continued).
... ROLLED_UP_ALERT_STATE_DETAIL DB2START_TIME ...
... ---------------------------- -------------------------- ...
... Alarm 2006-02-09-10.56.18.126182 ...
Output from this query (continued).
... LAST_RESET NUM_NODES_IN_DB2_INSTANCE
... -----------...--- -------------------------
... - 1
Information returned
Table 87. Information returned by the HEALTH_DBM_INFO table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
SERVER_INSTANCE_NAME VARCHAR(128) server_instance_name -
Server instance name
ROLLED_UP_ALERT_STATE BIGINT The most severe alert state
captured by this snapshot.
VARCHAR(20) The text description of the
ROLLED_UP_ALERT_ ROLLED_UP_ALERT_STATE
STATE_DETAIL column.
DB2START_TIME TIMESTAMP db2start_time - Start database
manager timestamp
LAST_RESET TIMESTAMP last_reset - Last reset
timestamp
INTEGER num_nodes_in_db2_instance -
NUM_NODES_IN_DB2_ Number of nodes in database
INSTANCE partition
HEALTH_GET_ALERT_ACTION_CFG table function -Retrieve
health alert action configuration settings
The HEALTH_GET_ALERT_ACTION_CFG table function 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).
250 Administrative Routines and Views
Syntax
HEALTH_GET_ALERT_ACTION_CFG ( objecttype , cfg_level , dbname ,
objectname )
The schema is SYSPROC.
Table function parameters
objecttype
An input argument of type VARCHAR(3) that indicates the object type. The
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
EXECUTE privilege on the HEALTH_GET_ALERT_ACTION_CFG table function.
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
Chapter 3. Supported routines and views 251
The following is an example of output for this query.
OBJECTTYPE CFG_LEVEL DBNAME OBJECTNAME ID IS_DEFAULT CONDITION
---------- --------- -------- ---------- --...---- ---------- ----------
DB O SAMPLE 1004 1 ALARM
DB O SAMPLE 1004 1 ALARM
2 record(s) selected.
Output for this query (continued).
... ACTIONTYPE ACTIONNAME USERID HOSTNAME
... ---------- ------------------------------ -------- ----------
... S ~/health_center/script/scrpn6 uid1 -
... T 00.0005 uid1 HOST3
Output for this query (continued).
... SCRIPT_TYPE WORKING_DIR TERMINATION_CHAR PARAMETERS
... ----------- ----------- ---------------- ----------
... O ~/health_c - -
... - - - -
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
The following is an example of output for this query.
CONDITION ACTIONTYPE ACTIONNAME ...
---------...--- ---------- -------------------------------- ...
ALARM S ~/health_center/script/scrpn6 ...
ALARM T 00.0005 ...
2 record(s) selected.
Output for this query (continued).
... USERID HOSTNAME SCRIPT_TYPE
... -------- ---------- -----------
... uid1 - O
... uid1 HOST3 -
Usage notes
The HEALTH_GET_IND_DEFINITION table function can be used to map health
indicator IDs to the health indicator names.
Information returned
Table 88. 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) Object name.
ID BIGINT Health indicator ID.
252 Administrative Routines and Views
Table 88. Information returned by the HEALTH_GET_ALERT_ACTION_CFG table
function (continued)
Column name Data type Description
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(512) 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) Host system name.
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.
HEALTH_GET_ALERT_CFG table function - Retrieve health
alert configuration settings
The HEALTH_GET_ALERT_CFG table function 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 )
The schema is SYSPROC.
Chapter 3. Supported routines and views 253
Table function parameters
objecttype
An input argument of type VARCHAR(3) that indicates the object type. The
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
EXECUTE privilege on the HEALTH_GET_ALERT_CFG table function.
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
The following is an example of output for this query.
OBJECTTYPE CFG_LEVEL DBNAME OBJECTNAME ...
---------- --------- --------...----- -------------...------ ...
DB O SAMPLE ...
DB O SAMPLE ...
DB O SAMPLE ...
DB O SAMPLE ...
DB O SAMPLE ...
DB O SAMPLE ...
DB O SAMPLE ...
DB O SAMPLE ...
DB O SAMPLE ...
DB O SAMPLE ...
DB O SAMPLE ...
DB O SAMPLE ...
254 Administrative Routines and Views
DB O SAMPLE ...
DB O SAMPLE ...
... ...
Output for this query (continued).
... 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 ...
Output for this query (continued).
... 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
... 50 0 1 0
... 30 0 1 0
... 85 0 1 0
... 85 0 1 0
... 10 0 1 0
... 85 0 1 0
... 10 0 1 0
... 70 0 1 0
... 70 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
The following is an example of output for this query.
WARNING_THRESHOLD ALARM_THRESHOLD
-------------------- --------------------
80 90
SQL22004N Cannot find the requested configuration for the given object.
Returning default configuration for "tablespaces".
1 record(s) selected with 1 warning messages printed.
Usage notes
The HEALTH_GET_IND_DEFINITION table function can be used to map health
indicator IDs to the health indicator names.
Chapter 3. Supported routines and views 255
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
The following is an example of output for this query.
WARNING_THRESHOLD ALARM_THRESHOLD
-------------------- --------------------
80 90
SQL22004N Cannot find the requested configuration for the given object.
Returning default configuration for "tablespaces".
1 record(s) selected with 1 warning messages printed.
Information returned
Table 89. Information returned by the HEALTH_GET_ALERT_CFG table function
Column name Data type Description
OBJECTTYPE VARCHAR(3) Object type.
CFG_LEVEL VARCHAR(1) Configuration level.
DBNAME VARCHAR(128) Database name.
OBJECTNAME VARCHAR(512) Object name.
ID BIGINT Health indicator ID.
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 table function - Retrieve
health indicator definitions
The HEALTH_GET_IND_DEFINITION table function returns the health indicator
definitions.
256 Administrative Routines and Views
Syntax
HEALTH_GET_IND_DEFINITION ( locale )
The schema is SYSPROC.
Table function parameter
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.
Authorization
EXECUTE privilege on the HEALTH_GET_IND_DEFINITION table function.
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’
The following is an example of output for this query.
TYPE SHORT_DESCRIPTION
---------------- ----------------------------------------...---------
STATE Etat opérationnel de la base de données
1 record(s) selected.
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
The following is an example of output for this query.
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
The following is an example of output for this query.
ID NAME
-------------------- ----------------------------
1 db2.db2_op_status
2 db2.sort_privmem_util
4 db2.mon_heap_util
1001 db.db_op_status
1002 db.sort_shrmem_util
...
2001 ts.ts_op_status
2002 ts.ts_util
Chapter 3. Supported routines and views 257
...
3002 tsc.tscont_util
1015 db.tb_reorg_req
...
Information returned
Table 90. Information returned by the HEALTH_GET_IND_DEFINITION table function
Column name Data type Description
ID BIGINT Health indicator ID.
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
HEALTH_HI_REC ( schema-version , indicator-id , dbname ,
object-type , object-name , dbpartitionnum , client-locale ,
recommendation-doc )
The schema is SYSPROC.
The HEALTH_HI_REC procedure 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. Any scripts
258 Administrative Routines and Views
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
An input argument of type VARCHAR(33) that specifies a client language
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
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
Chapter 3. Supported routines and views 259
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.
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 , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the HEALTH_TBS_HI table function.
Example
SELECT * FROM TABLE(HEALTH_TBS_HI(’’,-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP TABLESPACE_NAME HI_ID HI_VALUE ...
-------------------------- ---------------...- -----...- -------- ...
2006-02-13-12.30.35.229196 SYSCATSPACE 2001 0 ...
2006-02-13-12.30.35.229196 SYSCATSPACE 2002 99 ...
2006-02-13-12.30.35.229196 SYSCATSPACE 2003 0 ...
2006-02-13-12.30.35.229196 SYSTOOLSPACE 2001 0 ...
2006-02-13-12.30.35.229196 SYSTOOLSPACE 2002 62 ...
2006-02-13-12.30.35.229196 SYSTOOLSPACE 2003 0 ...
2006-02-13-12.30.35.229196 SYSTOOLSTMPSPACE 2001 0 ...
2006-02-13-12.30.35.229196 TEMPSPACE1 2001 0 ...
2006-02-13-12.30.35.229196 USERSPACE1 2001 0 ...
2006-02-13-12.30.35.229196 USERSPACE1 2002 100 ...
2006-02-13-12.30.35.229196 USERSPACE1 2003 0 ...
11 record(s) selected.
Output from this query (continued).
260 Administrative Routines and Views
... 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 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 ...
Output from this query (continued).
... HI_FORMULA HI_ADDITIONAL_INFO
... ---------------------...- ------------------------------------------------
... 0 -
... ((9376 / 9468) * 100) 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"
respectively. The table space is defined
with automatic storage set to "YES" and
automatic resize enabled set to "YES".
... 0 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".
... 0 -
... ((156 / 252) * 100) 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"
respectively. The table space is defined
with automatic storage set to "YES" and
automatic resize enabled set to "YES".
... 0 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
"1048576".
... 0 -
... 0 -
... 0 -
... ((1504 / 1504) * 100) 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
Chapter 3. Supported routines and views 261
per second. Time to fullness is projected
to be "N/A" and "N/A" respectively. The
table space is defined with automatic storage
set to "YES" and automatic resize enabled
set to "YES".
... 0 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
"6291456".
Information returned
Table 91. Information returned by the HEALTH_TBS_HI table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TABLESPACE_NAME VARCHAR(128) tablespace_name - Table
space name
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 The date and time that the
alert was generated.
HI_ALERT_STATE BIGINT The severity of the alert.
HI_ALERT_STATE_DETAIL VARCHAR(20) The text description of the
HI_ALERT_STATE column.
HI_FORMULA VARCHAR(2048) The formula used to calculate
the health indicator.
HI_ADDITIONAL_INFO VARCHAR(4096) Additional information about
the health indicator.
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 , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
262 Administrative Routines and Views
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the HEALTH_TBS_HI_HIS table function.
Example
SELECT * FROM TABLE(HEALTH_TBS_HI_HIS(’’,-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP TABLESPACE_NAME HI_ID ...
-------------------------- ---------------...- -----...- ...
2006-02-13-12.30.37.181478 SYSCATSPACE 2001 ...
2006-02-13-12.30.37.181478 SYSCATSPACE 2001 ...
2006-02-13-12.30.37.181478 SYSCATSPACE 2002 ...
2006-02-13-12.30.37.181478 SYSCATSPACE 2002 ...
2006-02-13-12.30.37.181478 SYSCATSPACE 2003 ...
2006-02-13-12.30.37.181478 SYSCATSPACE 2003 ...
2006-02-13-12.30.37.181478 SYSTOOLSPACE 2001 ...
2006-02-13-12.30.37.181478 SYSTOOLSPACE 2001 ...
2006-02-13-12.30.37.181478 SYSTOOLSPACE 2002 ...
2006-02-13-12.30.37.181478 SYSTOOLSPACE 2002 ...
2006-02-13-12.30.37.181478 SYSTOOLSPACE 2003 ...
2006-02-13-12.30.37.181478 SYSTOOLSPACE 2003 ...
2006-02-13-12.30.37.181478 SYSTOOLSTMPSPACE 2001 ...
2006-02-13-12.30.37.181478 SYSTOOLSTMPSPACE 2001 ...
2006-02-13-12.30.37.181478 TEMPSPACE1 2001 ...
2006-02-13-12.30.37.181478 TEMPSPACE1 2001 ...
2006-02-13-12.30.37.181478 USERSPACE1 2001 ...
2006-02-13-12.30.37.181478 USERSPACE1 2001 ...
2006-02-13-12.30.37.181478 USERSPACE1 2002 ...
2006-02-13-12.30.37.181478 USERSPACE1 2002 ...
2006-02-13-12.30.37.181478 USERSPACE1 2003 ...
2006-02-13-12.30.37.181478 USERSPACE1 2003 ...
22 record(s) selected.
Output from this query (continued).
... 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 ...
Chapter 3. Supported routines and views 263
... 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 0 1 Normal ...
... 2006-02-13-12.06.26.168000 0 1 Normal ...
... 2006-02-13-12.16.25.911000 100 4 Alarm ...
... 2006-02-13-12.06.26.168000 100 4 Alarm ...
... 2006-02-13-12.16.25.911000 0 1 Normal ...
... 2006-02-13-12.06.26.168000 0 1 Normal ...
Output from this query (continued).
... HI_FORMULA HI_ADDITIONAL_INFO
... --------------------...- -------------------...---
... 0 -
... 0 -
... ((9376 / 9468) * 100) 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
per second. Time to fullness is projected
to be "N/A" and "N/A" respectively. The
table space is defined with automatic
storage set to "YES" and automatic resize
enabled set to "YES".
... ((9376 / 9468) * 100) The short term table space growth rate from
"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
per second. Time to fullness is projected
to be "N/A" and "N/A" respectively. The
table space is defined with automatic
storage set to "YES" and automatic resize
enabled set to "YES".
... 0 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".
... 0 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".
... 0 -
... 0 -
... ((156 / 252) * 100) 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
per second. Time to fullness is projected
to be "N/A" and "N/A" respectively. The
table space is defined with automatic
storage set to "YES" and automatic resize
264 Administrative Routines and Views
enabled set to "YES".
... ((156 / 252) * 100) The short term table space growth rate from
"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
per second. Time to fullness is projected
to be "N/A" and "N/A" respectively. The
table space is defined with automatic
storage set to "YES" and automatic resize
enabled set to "YES".
... 0 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
"1048576".
... 0 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
"1048576".
... 0 -
... 0 -
... 0 -
... 0 -
... 0 -
... 0 -
... ((1504 / 1504) * 100) 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 per second. Time to fullness is
projected to be "N/A" and "N/A"
respectively. The table space is defined
with automatic storage set to "YES" and
automatic resize enabled set to "YES".
... ((1504 / 1504) * 100) The short term table space growth rate
from "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 per second. Time to fullness is
projected to be "N/A" and "N/A"
respectively. The table space is defined
with automatic storage set to "YES" and
automatic resize enabled set to "YES".
... 0 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 "6291456".
... 0 The table space is defined with automatic
storage set to "YES" and automatic
resize enabled set to "YES". The
Chapter 3. Supported routines and views 265
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".
Information returned
Table 92. Information returned by the HEALTH_TBS_HI_HIS table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TABLESPACE_NAME VARCHAR(128) tablespace_name - Table
space name
HI_ID BIGINT A number that uniquely
identifies the health indicator
in the snapshot data stream.
HI_TIMESTAMP TIMESTAMP The date and time that the
alert was generated.
HI_VALUE SMALLINT The value of the health
indicator.
HI_ALERT_STATE BIGINT The severity of the alert.
HI_ALERT_STATE_DETAIL VARCHAR(20) The text description of the
HI_ALERT_STATE column.
HI_FORMULA VARCHAR(2048) The formula used to calculate
the health indicator.
HI_ADDITIONAL_INFO VARCHAR(4096) Additional information about
the health indicator.
HEALTH_TBS_INFO
Returns table space information from a health snapshot of a database.
Syntax
HEALTH_TBS_INFO ( dbname , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
266 Administrative Routines and Views
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the HEALTH_TBS_INFO table function.
Example
SELECT * FROM TABLE(HEALTH_TBS_INFO(’’,-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP TABLESPACE_NAME ...
-------------------------- ----------------...- ...
2006-02-13-12.30.35.027383 SYSCATSPACE ...
2006-02-13-12.30.35.027383 SYSTOOLSPACE ...
2006-02-13-12.30.35.027383 SYSTOOLSTMPSPACE ...
2006-02-13-12.30.35.027383 TEMPSPACE1 ...
2006-02-13-12.30.35.027383 USERSPACE1 ...
5 record(s) selected.
Output from this query (continued).
... ROLLED_UP_ALERT_STATE ROLLED_UP_ALERT_STATE_DETAIL
... --------------------- ----------------------------
... 4 Alarm
... 1 Normal
... 1 Normal
... 1 Normal
... 4 Alarm
Information returned
Table 93. Information returned by the HEALTH_TBS_INFO table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TABLESPACE_NAME VARCHAR(128) tablespace_name - Table
space name
ROLLED_UP_ALERT_STATE BIGINT The most severe alert state
captured by this snapshot.
VARCHAR(20) The text description of the
ROLLED_UP_ALERT_ ROLLED_UP_ALERT_STATE
STATE_DETAIL column.
MQSeries routines
MQPUBLISH
The MQPUBLISH function publishes data to MQSeries. For more details, visit
http://www.ibm.com/software/MQSeries.
Chapter 3. Supported routines and views 267
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.
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″.
268 Administrative Routines and Views
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.
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’)
Example 3: This example publishes the string ″Testing 678″ to the publisher service
″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’)
Example 4: This example publishes the string ″Testing 901″ to the publisher service
″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
, service-policy
The schema is DB2MQ for non-transactional message queuing functions, and
DB2MQ1C for one-phase commit transactional MQ functions.
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
Chapter 3. Supported routines and views 269
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
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, then the default DB2.DEFAULT.POLICY will be used. The maximum
size of service-policy is 48 bytes.
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()
Example 2: This example reads the message at the head of the queue specified by
the service ″MYSERVICE″ using the default policy (DB2.DEFAULT.POLICY).
VALUES MQREAD(’MYSERVICE’)
Example 3: This example reads the message at the head of the queue specified by
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. Performing this operation does not remove
the messages from the queue associated with receive-service.
Syntax
MQREADALL ( )
receive-service num-rows
, service-policy
The schema is DB2MQ for non-transactional message queuing functions, and
DB2MQ1C for one-phase commit transactional MQ functions.
Table function parameters
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.
270 Administrative Routines and Views
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
options that should 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. The maximum
size of service-policy is 48 bytes.
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
EXECUTE privilege on the MQREADALL table function.
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
Information returned
Table 94. Information returned by the MQREADALL table function
Column name Data type Description
MSG VARCHAR(32000) Contains the contents of the
MQSeries message.
Chapter 3. Supported routines and views 271
Table 94. Information returned by the MQREADALL table function (continued)
Column name Data type Description
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.
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.
Table function parameters
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.
272 Administrative Routines and Views
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
options that should 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. The maximum
size of service-policy is 48 bytes.
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
EXECUTE privilege on the MQREADALLCLOB table function.
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 (MQREADALLCLOB()) 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 (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’
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 (MQREADALLCLOB(10)) AS T
Information returned
Table 95. Information returned by the MQREADALLCLOB table function
Column name Data type Description
MSG CLOB(1M) Contains the contents of the
MQSeries message.
Chapter 3. Supported routines and views 273
Table 95. Information returned by the MQREADALLCLOB table function (continued)
Column name Data type Description
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.
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
returned, the result is the null value.
Syntax
MQREADCLOB ( )
receive-service
, service-policy
The schema is DB2MQ.
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
274 Administrative Routines and Views
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
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, then the default DB2.DEFAULT.POLICY will be used. The maximum
size of service-policy is 48 bytes.
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 MQREADCLOB()
Example 2: This example reads the message at the head of the queue specified by
the service ″MYSERVICE″ using the default policy (DB2.DEFAULT.POLICY).
VALUES MQREADCLOB(’MYSERVICE’)
Example 3: This example reads the message at the head of the queue specified by
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
returned, the result is the null value.
Syntax
MQRECEIVE
( )
receive-service
, service-policy
, correl-id
The schema is DB2MQ for non-transactional message queuing functions, and
DB2MQ1C for one-phase commit transactional MQ functions.
Chapter 3. Supported routines and views 275
Function parameters
receive-service
A string containing the logical MQSeries destination from which the message is
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.
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
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 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.
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
(DB2.DEFAULT.POLICY).
VALUES MQRECEIVE()
Example 2: This example receives the message at the head of the queue specified
by the service ″MYSERVICE″ using the default policy (DB2.DEFAULT.POLICY).
VALUES MQRECEIVE(’MYSERVICE’)
Example 3: This example receives the message at the head of the queue specified
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.
Syntax
276 Administrative Routines and Views
MQRECEIVEALL (
receive-service
, service-policy
, correl-id
)
num-rows
,
The schema is DB2MQ for non-transactional message queuing functions, and
DB2MQ1C for one-phase commit transactional MQ functions.
Table function parameters
receive-service
A string containing the logical MQSeries destination from which the message is
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 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
options that should 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. The maximum
size of service-policy is 48 bytes.
correl-id
An optional string containing a correlation identifier 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 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
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
EXECUTE privilege on the MQRECEIVEALL table function.
Chapter 3. Supported routines and views 277
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 (MQRECEIVEALL()) 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 (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
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 (MQRECEIVEALL(10)) AS T
Information returned
Table 96. Information returned by the MQRECEIVEALL 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.
278 Administrative Routines and Views
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
,
The schema is DB2MQ.
Table function parameters
receive-service
A string containing the logical MQSeries destination from which the message is
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 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
options that should 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. The maximum
size of service-policy is 48 bytes.
correl-id
An optional string containing a correlation identifier 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 is specified.
The maximum size of correl-id is 24 bytes.
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
A positive integer containing the maximum number of messages to be returned
by the function.
Chapter 3. Supported routines and views 279
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 are returned.
Authorization
EXECUTE privilege on the MQRECEIVEALLCLOB table function.
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 (MQRECEIVEALLCLOB()) 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 (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
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 (MQRECEIVEALLCLOB(10)) AS T
Information returned
Table 97. Information returned by the MQRECEIVEALLCLOB table function
Column name Data type Description
MSG CLOB(1M) 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.
280 Administrative Routines and Views
Table 97. Information returned by the MQRECEIVEALLCLOB table function (continued)
Column name Data type Description
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.
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
returned, the result is the null value.
Syntax
MQRECEIVECLOB
( )
receive-service
, service-policy
, correl-id
The schema is DB2MQ.
Function paramters
receive-service
A string containing the logical MQSeries destination from which the message is
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.
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
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 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
Chapter 3. Supported routines and views 281
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 used.
The maximum size of correl-id is 24 bytes.
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
(DB2.DEFAULT.POLICY).
VALUES MQRECEIVECLOB()
Example 2: This example receives the message at the head of the queue specified
by the service ″MYSERVICE″ using the default policy (DB2.DEFAULT.POLICY).
VALUES MQRECEIVECLOB(’MYSERVICE’)
Example 3: This example receives the message at the head of the queue specified
by the service ″MYSERVICE″ using the policy ″MYPOLICY″.
VALUES MQRECEIVECLOB(’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 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.
The data type of the result is VARCHAR(1). The result of the function is ’1’ if
successful or ’0’ if unsuccessful.
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.
The schema is DB2MQ for non-transactional message queuing functions, and
DB2MQ1C for one-phase commit transactional MQ functions.
Function parameters
msg-data
A string expression containing the data to be sent via MQSeries. The maximum
282 Administrative Routines and Views
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
DB2MQ.MQSERVICE table. A service point is a logical end-point from which a
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.
correl-id
An optional string containing a correlation identifier 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 sent.
The maximum size of correl-id is 24 bytes.
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’)
Example 3: This example sends the string ″Testing 678″ to the service
″MYSERVICE″, using the policy ″MYPOLICY″, with correlation identifier ″TEST3″.
VALUES MQSEND(’MYSERVICE’,’MYPOLICY’,’Testing 678’,’TEST3’)
Example 4: This example sends the string ″Testing 901″ to the service
″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
Chapter 3. Supported routines and views 283
through a subsequent call to MQREAD, MQRECEIVE, MQREADALL, or
MQRECEIVEALL. For more details, visit http://www.ibm.com/software/MQSeries.
The data type of the result is VARCHAR(1). The result of the function is ’1’ if
successful or ’0’ if unsuccessful.
Syntax
MQSUBSCRIBE ( topic )
subscriber-service ,
service-policy ,
The schema is DB2MQ for non-transactional message queuing functions, and
DB2MQ1C for one-phase commit transactional MQ functions.
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
DB2MQ.MQPOLICY table. A Service Policy defines a set of quality of service
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
service-policy is 48 bytes.
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″.
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.
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’)
284 Administrative Routines and Views
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 canceled. 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.
The data type of the result is VARCHAR(1). The result of the function is ’1’ if
successful or ’0’ if unsuccessful.
Syntax
MQUNSUBSCRIBE
( topic )
subscriber-service ,
service-policy ,
The schema is DB2MQ for non-transactional message queuing functions, and
DB2MQ1C for one-phase commit transactional MQ functions.
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
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 to be applied to this messaging operation. If service-policy is not
specified, then the default DB2.DEFAULT.POLICY will be used. The maximum
size of service-policy is 48 bytes.
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″.
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’)
Chapter 3. Supported routines and views 285
Example 2: This example demonstrates a subscriber canceling an interest in
messages containing ″Stocks″. The subscriber is registered as ″PORTFOLIO-
UPDATES″ with policy ″BASIC-POLICY″.
VALUES MQUNSUBSCRIBE(’PORTFOLIO-UPDATES’,’BASIC-POLICY’,’Stocks’)
Security routines and views
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
AUTH_LIST_AUTHORITIES_FOR_AUTHID ( authid , authidtype )
The schema is SYSPROC.
Table function parameters
authid
An input argument of type VARCHAR(128) that specifies the authorization ID
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
An input argument of type VARCHAR(1) that specifies the authorization ID
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
EXECUTE privilege on the AUTH_LIST_AUTHORITIES_FOR_AUTHID function.
Information returned
Table 98. 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
286 Administrative Routines and Views
Table 98. The information returned for AUTH_LIST_AUTHORITIES_FOR_AUTHID (continued)
Column Name Data Type Description
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
v * = Not applicable
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
v * = Not applicable
ROLE_USER CHAR(1) Authority granted directly to a role granted 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
v * = Not applicable
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
v * = Not applicable
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
v * = Not applicable
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
v * = Not applicable
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
Chapter 3. Supported routines and views 287
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
AUTHORITY D_USER D_GROUP D_PUBLIC ROLE_USER ROLE_GROUP ROLE_PUBLIC D_ROLE
------------------------- ------ ------- -------- --------- ---------- ----------- ------
BINDADD N N Y N N N *
CONNECT N N Y N N N *
CREATE_EXTERNAL_ROUTINE N N N N N N *
CREATE_NOT_FENCED_ROUTINE N N N N Y N *
CREATETAB N N Y N N N *
DBADM Y Y N N N N *
IMPLICIT_SCHEMA N N Y N N N *
LOAD N N N Y N N *
QUIESCE_CONNECT N N N N N N *
SECADM Y N N N N N *
SYSADM * Y * * * * *
SYSCTRL * Y * * * * *
SYSMAINT * Y * * * * *
SYSMON * N * * * * *
Example 2: Retrieve all authorities group ADMIN1 has granted either directly to it
or indirectly through 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 (’ADMIN1’, ’G’) ) AS T
ORDER BY AUTHORITY
AUTHORITY D_USER D_GROUP D_PUBLIC ROLE_USER ROLE_GROUP ROLE_PUBLIC D_ROLE
------------------------- ------ ------- -------- --------- ---------- ----------- ------
BINDADD * N * * N * *
CONNECT * N * * N * *
CREATE_EXTERNAL_ROUTINE * N * * N * *
CREATE_NOT_FENCED_ROUTINE * N * * Y * *
CREATETAB * N * * N * *
DBADM * N * * N * *
IMPLICIT_SCHEMA * N * * N * *
LOAD * N * * N * *
QUIESCE_CONNECT * N * * N * *
SECADM * N * * N * *
SYSADM * Y * * * * *
SYSCTRL * Y * * * * *
SYSMAINT * Y * * * * *
SYSMON * N * * * * *
Example 3: Retrieve all authorities special group PUBLIC has granted either
directly to it or indirectly through 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 (’PUBLIC’, ’G’) ) AS T
ORDER BY AUTHORITY
1 D_USER D_GROUP D_PUBLIC ROLE_USER ROLE_GROUP ROLE_PUBLIC D_ROLE
------------------------- ------ ------- -------- --------- ---------- ----------- ------
BINDADD * * Y * * N *
CONNECT * * Y * * N *
CREATE_EXTERNAL_ROUTINE * * N * * N *
CREATE_NOT_FENCED_ROUTINE * * N * * N *
CREATETAB * * Y * * N *
DBADM * * N * * N *
IMPLICIT_SCHEMA * * Y * * N *
LOAD * * N * * N *
QUIESCE_CONNECT * * N * * N *
SECADM * * N * * N *
SYSADM * * * * * * *
SYSCTRL * * * * * * *
SYSMAINT * * * * * * *
SYSMON * * * * * * *
288 Administrative Routines and Views
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.
SELECT AUTHORITY, D_USER, D_GROUP, D_PUBLIC, ROLE_USER, ROLE_GROUP, ROLE_PUBLIC, D_ROLE
FROM TABLE (SYSPROC.AUTH_LIST_AUTHORITIES_FOR_AUTHID (’R1’, ’R’) ) AS T
ORDER BY AUTHORITY
AUTHORITY D_USER D_GROUP D_PUBLIC ROLE_USER ROLE_GROUP ROLE_PUBLIC D_ROLE
------------------------- ------ ------- -------- --------- ---------- ----------- ------
BINDADD * * * * * * N
CONNECT * * * * * * N
CREATE_EXTERNAL_ROUTINE * * * * * * N
CREATE_NOT_FENCED_ROUTINE * * * * * * Y
CREATETAB * * * * * * N
DBADM * * * * * * N
IMPLICIT_SCHEMA * * * * * * N
LOAD * * * * * * Y
QUIESCE_CONNECT * * * * * * N
SECADM * * * * * * N
SYSADM * * * * * * *
SYSCTRL * * * * * * *
SYSMAINT * * * * * * *
SYSMON * * * * * * *
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 )
The schema is SYSPROC.
Table function parameter
authid
An input argument of type VARCHAR(128) that specifies the authorization ID
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.
Authorization
EXECUTE privilege on the AUTH_LIST_GROUPS_FOR_AUTHID table function.
Example
Chapter 3. Supported routines and views 289
Retrieve all groups that AMY belongs to.
SELECT * FROM TABLE (SYSPROC.AUTH_LIST_GROUPS_FOR_AUTHID(’AMY’)) AS T
The following is an example of output for this query.
GROUP
-------------------------...-------------
BUILD
PDXDB2
2 record(s) selected.
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.
Information returned
Table 99. 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 )
The schema is SYSPROC.
Table function parameters
authid
An input argument of type VARCHAR(128) that specifies the authorization ID
290 Administrative Routines and Views
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
An input argument of type VARCHAR(1) that specifies the authorization ID
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
EXECUTE privilege on the AUTH_LIST_ROLES_FOR_AUTHID function.
Information returned
Table 100. The result sets for AUTH_LIST_ROLES_FOR_AUTHID
Column Name Data Type Description
GRANTOR VARCHAR(128) Grantor of the role.
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
The following is an example of output for this query.
GRANTOR GRANTORTYPE GRANTEE GRANTEETYPE ROLENAME CREATE_TIME ADMIN
------- ----------- ------- ----------- -------- -------------------------- -----
ZURBIE U DOCTOR R INTERN 2006-08-01-15.09.58.537399 N
ZURBIE U SPECIALIST R DOCTOR 2006-08-01-15.10.04.540660 N
ZURBIE U ALICE U SPECIALIST 2006-08-01-15.10.08.776218 N
Chapter 3. Supported routines and views 291
ZURBIE U HOSPITAL G EMPLOYEE 2006-08-01-15.10.14.277576 N
ZURBIE U PUBLIC G PATIENTS 2006-08-01-15.10.18.878609 N
5 record(s) selected.
Example 2: Retrieve all roles granted to group HOSPITAL.
SELECT GRANTOR, GRANTORTYPE, GRANTEE, GRANTEETYPE, ROLENAME,
CREATE_TIME, ADMIN
FROM TABLE (SYSPROC.AUTH_LIST_ROLES_FOR_AUTHID (’HOSPITAL’, ’G’) ) AS T
The following is an example of output for this query.
GRANTOR GRANTORTYPE GRANTEE GRANTEETYPE ROLENAME CREATE_TIME ADMIN
------- ----------- ------- ----------- -------- -------------------------- -----
ZURBIE U HOSPITAL G EMPLOYEE 2006-08-01-15.10.14.277576 N
1 record(s) selected.
Example 3: Retrieve all roles granted to role SPECIALIST.
SELECT GRANTOR, GRANTORTYPE, GRANTEE, GRANTEETYPE, ROLENAME,
CREATE_TIME, ADMIN
FROM TABLE (SYSPROC.AUTH_LIST_ROLES_FOR_AUTHID (’SPECIALIST’, ’R’) ) AS T
The following is an example of output for this query.
GRANTOR GRANTORTYPE GRANTEE GRANTEETYPE ROLENAME CREATE_TIME ADMIN
------- ----------- ------- ----------- -------- -------------------------- -----
ZURBIE U DOCTOR R INTERN 2006-08-01-15.09.58.537399 N
ZURBIE U SPECIALIST R DOCTOR 2006-08-01-15.10.04.540660 N
2 record(s) selected.
Example 4: Retrieve all roles granted to group PUBLIC
SELECT GRANTOR, GRANTORTYPE, GRANTEE, GRANTEETYPE, ROLENAME,
CREATE_TIME, ADMIN
FROM TABLE (SYSPROC.AUTH_LIST_ROLES_FOR_AUTHID (’PUBLIC’, ’G’) ) AS T
The following is an example of output for this query.
GRANTOR GRANTORTYPE GRANTEE GRANTEETYPE ROLENAME CREATE_TIME ADMIN
------- ----------- ------- ----------- -------- -------------------------- -----
ZURBIE U PUBLIC G PATIENTS 2006-08-01-15.10.18.878609 N
1 record(s) selected.
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 authorization IDs
that have been granted privileges or authorities, along with their types, for all
authorization IDs defined in the system catalogs from the currently connected
database. If privileges or authorities have been granted to groups or roles, only the
group or role names are returned.
292 Administrative Routines and Views
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the AUTHORIZATIONIDS administrative
view.
Example
Retrieve all authorization IDs that have been granted privileges or authorities,
along with their types.
SELECT * FROM SYSIBMADM.AUTHORIZATIONIDS
The following is an example of output for this query.
AUTHID AUTHIDTYPE
-------------------------...------- ----------
PUBLIC G
JESSICAE U
DOCTOR R
3 record(s) selected.
Information returned
Table 101. 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.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the OBJECTOWNERS administrative view.
Example
Retrieve all object ownership information for object schema ’THERESAX’.
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 OJECTSCHEMA=’THERESAX’
Chapter 3. Supported routines and views 293
The following is an example of output for this query.
OWNER OWNERTYPE OBJECTNAME OBJECTSCHEMA OBJECTTYPE
---------- --------- -----------------... ------------ ----------------
THERESAX U MIN_SALARY THERESAX TRIGGER
THERESAX U POLICY_IR SYSTOOLS TRIGGER
THERESAX U CUSTOMER THERESAX XML SCHEMA
THERESAX U DB2DETAILDEADLOCK EVENTMONITORS
THERESAX U SAMPSEQUENCE THERESAX SEQUENCE
THERESAX U SQLE0F00 NULLID PACKAGE
...
THERESAX U HI_OBJ_UNIQ SYSTOOLS TABLE CONSTRAINT
257 record(s) selected.
Information returned
Table 102. Information returned by the OBJECTOWNERS administrative view
Column name Data type Description
OWNER VARCHAR(128) Authorization ID that owns
this object.
OWNERTYPE VARCHAR(1) Authorization ID type:
v U: user
OBJECTNAME VARCHAR(128) Database object name.
OBJECTSCHEMA VARCHAR(128) Database object schema.
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.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the PRIVILEGES administrative view.
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
The following is an example of output for this query.
AUTHID PRIVILEGE OBJECTNAME OBJECTSCHEMA OBJECTTYPE
--------...- ----------- -------------------...- ------------...- ----------...-
JESSICAE EXECUTE SQLE0F00 NULLID PACKAGE
PUBLIC EXECUTE SYSSH201 NULLID PACKAGE
JESSICAE EXECUTE SYSSH202 NULLID PACKAGE
PUBLIC EXECUTE SYSSH202 NULLID PACKAGE
DOCTOR EXECUTE PKG0123 NULLID PACKAGE
...
PUBLIC EXECUTE SQL051109185227800 SYSPROC FUNCTION
294 Administrative Routines and Views
JESSICAE EXECUTE SQL051109185227801 SYSPROC FUNCTION
PUBLIC EXECUTE SQL051109185227801 SYSPROC FUNCTION
JESSICAE EXECUTE SQL051109185227838 SYSPROC FUNCTION
PUBLIC EXECUTE SQL051109185227838 SYSPROC FUNCTION
...
PUBLIC EXECUTE LIST_SRVR_TYPES SYSPROC PROCEDURE
PUBLIC EXECUTE LIST_SRVR_VERSIONS SYSPROC PROCEDURE
PUBLIC EXECUTE LIST_WRAP_OPTIONS SYSPROC PROCEDURE
PUBLIC EXECUTE LIST_SRVR_OPTIONS SYSPROC PROCEDURE
...
SYSTEM POLICY_UNQ SYSTOOLS INDEX
PUBLIC CREATEIN NULLID SCHEMA
PUBLIC UPDATE COLUMNS SYSSTAT VIEW
PUBLIC UPDATE COLGROUPS SYSSTAT VIEW
...
Information returned
Table 103. 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) Authorization ID type:
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) Database object name.
OBJECTSCHEMA VARCHAR(128) Database object schema.
OBJECTTYPE VARCHAR(24) Database object type.
Snapshot routines and views
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.
The schema is SYSIBMADM.
Chapter 3. Supported routines and views 295
Authorization
v SELECT or CONTROL privilege on the APPL_PERFORMANCE,
SNAPAPPL_INFO and SNAPAPPL administrative views.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority are also required to
access snapshot monitor data.
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
The following is an example of output for this query.
SNAPSHOT_TIMESTAMP AUTHID APPL_NAME ...
-------------------------- ---------- ---------- ...
2006-01-07-17.01.15.966668 JESSICAE db2bp.exe ...
2006-01-07-17.01.15.980278 JESSICAE db2taskd ...
2006-01-07-17.01.15.980278 JESSICAE db2bp.exe ...
...
3 record(s) selected. ...
Output for this query (continued).
... AGENT_ID PERCENT_ROWS_SELECTED DBPARTITIONNUM
... --------...-- --------------------- --------------
... 67 - 1
... 68 - 0
... 67 57.14 0
...
Information returned
Table 104. Information returned by the APPL_PERFORMANCE administrative view
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AUTHID VARCHAR(128) auth_id - Authorization ID
APPL_NAME VARCHAR(256) appl_name - Application name
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
PERCENT_ROWS_SELECTED DECIMAL(5,2) The percent of rows read from disk
that were actually returned to the
application.
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
APPLICATIONS administrative view - Retrieve connected
database application information
The APPLICATIONS administrative view returns information on connected
database applications. The view is an SQL interface for the LIST APPLICATIONS
296 Administrative Routines and Views
SHOW DETAIL CLP command, but only for the currently connected database. Its
information is based on the SNAPAPPL_INFO administrative view.
The schema is SYSIBMADM.
Authorization
v SELECT or CONTROL privilege on the APPLICATIONS and SNAPAPPL_INFO
administrative views.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority which is required to
access snapshot monitor data.
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’
The following is an example of output for this query.
AGENT_ID APPL_NAME AUTHID APPL_STATUS
-------------------- ---------- ---------- ---------------------
23 db2bp.exe JESSICAE UOWEXEC
1 record(s) selected.
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
The following is an example of output for this query.
APPL_NAME NUM
---------- -----------
db2bp.exe 3
javaw.exe 1
2 record(s) selected.
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.
Information returned
Table 105. Information returned by the APPLICATIONS administrative view
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
CLIENT_DB_ALIAS VARCHAR(128) client_db_alias - Database alias
used by application
DB_NAME VARCHAR(128) db_name - Database name
Chapter 3. Supported routines and views 297
Table 105. Information returned by the APPLICATIONS administrative view (continued)
Description or corresponding
Column name Data type monitor element
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
APPL_NAME VARCHAR(256) appl_name - Application name
AUTHID VARCHAR(128) auth_id - Authorization ID
APPL_ID VARCHAR(128) appl_id - Application ID
APPL_STATUS VARCHAR(22) appl_status - Application status.
This interface returns a text
identifier based on defines in
sqlmon.h, and is one of:
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
STATUS_CHANGE_TIME TIMESTAMP status_change_time - Application
status change time
SEQUENCE_NO VARCHAR(4) sequence_no - Sequence number
CLIENT_PRDID VARCHAR(128) client_prdid - Client
product/version ID
CLIENT_PID BIGINT client_pid - Client process ID
298 Administrative Routines and Views
Table 105. Information returned by the APPLICATIONS administrative view (continued)
Description or corresponding
Column name Data type monitor element
CLIENT_PLATFORM VARCHAR(12) client_platform - Client operating
platform. 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
v WINDOWS95
Chapter 3. Supported routines and views 299
Table 105. Information returned by the APPLICATIONS administrative view (continued)
Description or corresponding
Column name Data type monitor element
CLIENT_PROTOCOL VARCHAR(10) client_protocol - Client
communication protocol. This
interface returns a text identifier
based on the defines in sqlmon.h,
v CPIC
v LOCAL
v NETBIOS
v NPIPE
v TCPIP (for DB2 UDB)
v TCPIP4
v TCPIP6
CLIENT_NNAME VARCHAR(128) The client_nname monitor element
is deprecated. The value returned is
not a valid value.
COORD_NODE_NUM SMALLINT coord_node - Coordinating node
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 The database partition from which
the data was retrieved for this row.
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.
The schema is SYSIBMADM.
Authorization
v SELECT or CONTROL privilege on the BP_HITRATIO and SNAPBP
administrative views.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority is also required to
access snapshot monitor data.
300 Administrative Routines and Views
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
The following is an example of output for this query.
DB_NAME BP_NAME TOTAL_HIT_RATIO_PERCENT DATA_HIT_RATIO_PERCENT ...
-------- -------------- ----------------------- ---------------------- ...
TEST IBMDEFAULTBP 63.09 68.94 ...
TEST IBMSYSTEMBP4K - - ...
TEST IBMSYSTEMBP8K - - ...
TEST IBMSYSTEMBP16K - - ...
TEST IBMSYSTEMBP32K - - ...
Output for this query (continued).
... INDEX_HIT_RATIO_PERCENT XDA_HIT_RATIO_PERCENT DBPARTITIONNUM
... ----------------------- --------------------- --------------
... 43.20 - 0
... - - 0
... - - 0
... - - 0
... - - 0
Usage notes
The ratio of physical reads to logical 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.
Information returned
Table 106. Information returned by the BP_HITRATIO administrative view
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP Timestamp when the report was
requested.
DB_NAME VARCHAR(128) db_name - Database name
BP_NAME VARCHAR(128) bp_name - Buffer pool name
TOTAL_LOGICAL_READS BIGINT Total logical reads (index, XDA and
data) in the bufferpool.
TOTAL_PHYSICAL_READS 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).
DATA_LOGICAL_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
DATA_PHYSICAL_READS BIGINT pool_data_p_reads - Buffer pool
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
Chapter 3. Supported routines and views 301
Table 106. Information returned by the BP_HITRATIO administrative view (continued)
Description or corresponding
Column name Data type monitor element
INDEX_PHYSICAL_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
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
XDA_HIT_RATIO_PERCENT DECIMAL(5,2) Auxiliary storage objects hit ratio.
DBPARTITIONNUM SMALLINT The database partition from which
the data for the row was retrieved.
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.
The schema is SYSIBMADM.
Authorization
v SELECT or CONTROL privilege on the BP_READ_IO and SNAPBP
administrative views.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority are also required to
access snapshot monitor data.
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
The following is an example of output for this query.
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
10 record(s) selected.
302 Administrative Routines and Views
Information returned
Table 107. Information returned by the BP_READ_IO administrative view
Description or
corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP Date and time the
report was generated.
BP_NAME VARCHAR(128) bp_name - Buffer pool
name
TOTAL_PHYSICAL_READS 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.
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 The database partition
from which the data
was retrieved for this
row.
Chapter 3. Supported routines and views 303
BP_WRITE_IO administrative view - Retrieve bufferpool write
performance information
The BP_WRITE_IO administrative view returns bufferpool write performance
information per bufferpool.
The schema is SYSIBMADM.
Authorization
v SELECT or CONTROL privilege on the BP_WRITE_IO and SNAPBP
administrative views.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority is also required to
access snapshot monitor data.
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
The following is an example of output for this query.
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
11 record(s) selected.
Information returned
Table 108. Information returned by the BP_WRITE_IO administrative view
Description or
corresponding
Column name Data type monitor element
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.
304 Administrative Routines and Views
Table 108. Information returned by the BP_WRITE_IO administrative view (continued)
Description or
corresponding
Column name Data type monitor element
PERCENT_WRITES_ASYNC BIGINT Percent of writes that
are asynchronous.
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 The database partition
from which the data
for the row was
retrieved.
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. The view is an SQL interface for the
LIST TABLESPACE CONTAINERS CLP command. Its information is based on the
SNAPCONTAINER administrative view.
The schema is SYSIBMADM.
Authorization
v SELECT or CONTROL privilege on CONTAINER_UTILIZATION and
SNAPCONTAINER administrative views.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority (required to access
snapshot monitor data).
Example
Retrieve a list of all table spaces containers in the connected single partition
database, including information on 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
The following is an example of output for this query.
TBSP_NAME TBSP_ID CONTAINER_NAME ...
----------------...- ----------- -------------------------------------...-- ...
SYSCATSPACE 0 D:\DB2\NODE0000\SQL00001\SQLT0000.0 ...
TEMPSPACE1 1 D:\DB2\NODE0000\SQL00001\SQLT0001.0 ...
USERSPACE1 2 D:\DB2\NODE0000\SQL00001\SQLT0002.0 ...
Chapter 3. Supported routines and views 305
SYSTOOLSPACE 3 D:\DB2\NODE0000\SQL00001\SYSTOOLSPACE ...
SYSTOOLSTMPSPACE 4 D:\DB2\NODE0000\SQL00001\SYSTOOLSTMPSPACE ...
5 record(s) selected.
Output for this query (continued).
... 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
Information returned
The BUFFERPOOL snapshot monitor switch must be enabled at the database
manager configuration for the file system information to be returned.
Table 109. Information returned by the CONTAINER_UTILIZATION administrative view
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
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
CONTAINER_TYPE VARCHAR(16) container_type - Container type
This is a text identifer 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 container_stripe_set - Stripe set
FS_ID VARCHAR(22) fs_id - Unique file system
identification number
FS_TOTAL_SIZE_KB BIGINT fs_total_size - Total size of a file
system. This interface returns the
value in KB.
306 Administrative Routines and Views
Table 109. Information returned by the CONTAINER_UTILIZATION administrative
view (continued)
Description or corresponding
Column name Data type monitor element
FS_USED_SIZE_KB BIGINT fs_used_size - Amount of space
used on a file system. This interface
returns the value in KB.
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
LOCKS_HELD administrative view - Retrieve information on
locks held
The LOCKS_HELD administrative view returns information on current locks held.
The schema is SYSIBMADM.
Authorization
v SELECT or CONTROL privilege on the LOCKS_HELD, SNAPLOCK and
SNAPAPPL_INFO administrative views.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority is also required to
access snapshot monitor data.
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
The following is an example of output for this query.
TABSCHEMA TABNAME NUMBER_OF_LOCKS_HELD
----------...- ---------...- --------------------
JESSICAE EMPLOYEE 5
JESSICAE EMP_RESUME 1
JESSICAE 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
The following is an example of output for this query.
AGENT_ID TABSCHEMA TABNAME LOCK_OBJECT_TYPE LOCK_MODE LOCK_STATUS
--------...- ---------...- --------...- ------------------ ---------- -----------
680 JESSICAE EMPLOYEE INTERNALV_LOCK S GRNT
680 JESSICAE EMPLOYEE INTERNALP_LOCK S 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
Chapter 3. Supported routines and views 307
The following is an example of output for this query.
TABSCHEMA TABNAME LOCK_OBJECT_TYPE LOCK_MODE LOCK_STATUS
---------...- --------...- ------------------ ---------- -----------
JESSICAE EMP_RESUME TABLE_LOCK S GRNT
JESSICAE EMPLOYEE ROW_LOCK S GRNT
Information returned
Table 110. Information returned by the LOCKS_HELD administrative view
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP Date and time the report was
generated.
DB_NAME VARCHAR(128) db_name - Database name
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
APPL_NAME VARCHAR(256) appl_name - Application name
AUTHID VARCHAR(128) auth_id - Authorization ID
TBSP_NAME VARCHAR(128) tablespace_name - Table space
name
TABSCHEMA VARCHAR(128) table_schema - Table schema name
TABNAME VARCHAR(128) table_name - Table name
TAB_FILE_ID BIGINT table_file_id - Table file
identification
308 Administrative Routines and Views
Table 110. Information returned by the LOCKS_HELD administrative view (continued)
Description or corresponding
Column name Data type monitor element
LOCK_OBJECT_TYPE VARCHAR(18) lock_object_type - Lock object type
waited on. This interface returns a
text identifier based on the defines
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_NAME VARCHAR(32) lock_name - Lock name
LOCK_MODE VARCHAR(10) lock_mode - Lock mode. This
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
Chapter 3. Supported routines and views 309
Table 110. Information returned by the LOCKS_HELD administrative view (continued)
Description or corresponding
Column name Data type monitor element
LOCK_STATUS VARCHAR(10) lock_status - Lock status. This
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v CONV
v GRNT
LOCK_ESCALATION SMALLINT lock_escalation - Lock escalation
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
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.
The schema is SYSIBMADM.
Authorization
v SELECT or CONTROL privilege on the LOCKWAITS, SNAPAPPL_INFO and
SNAPLOCKWAIT administrative views.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority is also required to
access snapshot monitor data.
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
The following is an example of output for this query.
TABSCHEMA TABNAME LOCK_OBJECT_TYPE LOCK_MODE ...
--------- -------...- ---------------- ---------- ...
JESSICAE T1 ROW_LOCK X ...
1 record(s) selected.
Output for this query (continued).
... 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
310 Administrative Routines and Views
FROM SYSIBMADM.LOCKWAITS WHERE DB_NAME = ’SAMPLE’
GROUP BY TABSCHEMA, TABNAME, DBPARTITIONNUM
ORDER BY NUM_OF_LOCK_REQUESTS_WAITING DESC
The following is an example of output for this query.
TABSCHEMA TABNAME NUM_OF_LOCK_REQUESTS_WAITING DBPARTITIONNUM
--------- -------...- ---------------------------- --------------
JESSICAE T3 2 0
JESSICAE T1 1 0
JESSICAE T2 1 0
3 record(s) selected.
Information returned
Table 111. Information returned by the LOCKWAITS administrative view
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP Date and time the report was
generated.
DB_NAME VARCHAR(128) db_name - Database name
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
APPL_NAME VARCHAR(256) appl_name - Application name
AUTHID VARCHAR(128) auth_id - Authorization ID
TBSP_NAME VARCHAR(128) tablespace_name - Table space
name
TABSCHEMA VARCHAR(128) table_schema - Table schema name
TABNAME VARCHAR(128) table_name - Table name
SUBSECTION_NUMBER BIGINT ss_number - Subsection number
Chapter 3. Supported routines and views 311
Table 111. Information returned by the LOCKWAITS administrative view (continued)
Description or corresponding
Column name Data type monitor element
LOCK_OBJECT_TYPE VARCHAR(18) lock_object_type - Lock object type
waited on. This interface returns a
text identifier based on the defines
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_WAIT_START_TIME TIMESTAMP lock_wait_start_time - Lock wait
start timestamp
LOCK_NAME VARCHAR(32) lock_name - Lock name
312 Administrative Routines and Views
Table 111. Information returned by the LOCKWAITS administrative view (continued)
Description or corresponding
Column name Data type monitor element
LOCK_MODE VARCHAR(10) lock_mode - Lock mode. This
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
LOCK_MODE_REQUESTED VARCHAR(10) lock_mode_requested - Lock mode
requested. This interface returns a
text identifier based on the defines
in sqlmon.h and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
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
LOCK_ESCALATION SMALLINT lock_escalation - Lock escalation
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
Chapter 3. Supported routines and views 313
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.
The schema is SYSIBMADM.
Authorization
v SELECT or CONTROL privilege on the LOG_UTILIZATION and SNAPDB
administrative views.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority is also required to
access snapshot monitor data.
Example
List the log utilization for the currently connected database, SAMPLE.
SELECT * FROM SYSIBMADM.LOG_UTILIZATION
The following is an example of output for this query.
DB_NAME ... LOG_UTILIZATION_PERCENT TOTAL_LOG_USED_KB ...
-------- ... ----------------------- -------------------- ...
SAMPLE ... 9.75 1989 ...
...
1 record(s) selected. ...
Output for this query (continued).
... 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.
Information returned
Table 112. Information returned by the LOG_UTILIZATION administrative view
Description or corresponding
Column name Data type monitor element
DB_NAME VARCHAR(128) db_name - Database name
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.
314 Administrative Routines and Views
Table 112. Information returned by the LOG_UTILIZATION administrative view (continued)
Description or corresponding
Column name Data type monitor element
TOTAL_LOG_USED_TOP_KB BIGINT tot_log_used_top - Maximum total
log space used. This interface
returns the value in KB.
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
LONG_RUNNING_SQL administrative view
The LONG_RUNNING_SQL administrative view returns the longest running SQL
statements in the currently connected database.
The schema is SYSIBMADM.
Authorization
v SELECT or CONTROL privilege on the LONG_RUNNING_SQL, SNAPSTMT,
SNAPAPPL_INFO, and SNAPAPPL administrative views.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority is also required to
access snapshot monitor data.
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
The following is an example of output for this query.
STMT_TEXT AGENT_ID ...
-----------------------------...- --------...- ...
select * from dbuser.employee 228 ...
select * from dbuser.employee 228 ...
select * from dbuser.employee 228 ...
...
3 record(s) selected. ...
Output for this query (continued).
... 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
Chapter 3. Supported routines and views 315
waiting for the application to do something (like issue the next fetch or submit the
next SQL statement).
Information returned
Table 113. Information returned by the LONG_RUNNING_SQL administrative view
Description or corresponding
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 - Application handle
(agent ID)
APPL_NAME VARCHAR(256) appl_name - Application name
APPL_STATUS VARCHAR(22) appl_status - Application status.
This interface returns a text
identifier based on the defines in
sqlmon.h, and is one of:
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
AUTHID VARCHAR(128) auth_id - Authorization ID
INBOUND_COMM_ADDRESS VARCHAR(32) inbound_comm_address - Inbound
communication address
STMT_TEXT CLOB(16 M) stmt_text - SQL statement text
316 Administrative Routines and Views
Table 113. Information returned by the LONG_RUNNING_SQL administrative
view (continued)
Description or corresponding
Column name Data type monitor element
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
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.
The schema is SYSIBMADM.
Authorization
v SELECT or CONTROL privilege on the QUERY_PREP_COST and
SNAPDYN_SQL administrative views.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority is also required to
access snapshot monitor data.
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
The following is an example of output for this query.
NUM_EXECUTIONS AVERAGE_EXECUTION_TIME_S ...
--------------...- ------------------------ ...
1 25 ...
1 record(s) selected.
Output for this query (continued).
... 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.
Chapter 3. Supported routines and views 317
Information returned
Table 114. Information returned by the QUERY_PREP_COST administrative view
Description or corresponding
Column name Data type monitor element
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.
PREP_TIME_MS BIGINT prep_time_worst - Statement worst
preparation time
PREP_TIME_PERCENT DECIMAL(5,2) Percent of execution time spent on
preparation.
STMT_TEXT CLOB(2 M) stmt_text - SQL statement text
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPAGENT administrative view and SNAP_GET_AGENT
table function – Retrieve agent logical data group application
snapshot information
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.
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 SNAPAGENT_MEMORY_POOL, SNAPAPPL, SNAPAPPL_INFO,
SNAPSTMT 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 partitions.
The schema is SYSIBMADM.
Refer to Table 115 on page 320 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPAGENT administrative view and
EXECUTE privilege on the SNAP_GET_AGENT table function.
Example
Retrieve all application snapshot information for the currently connected database
from the agent logical data group.
SELECT * FROM SYSIBMADM.SNAPAGENT
318 Administrative Routines and Views
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP DB_NAME AGENT_ID ...
-------------------------- -------...- ---------...--- ...
2005-07-19-11.03.26.740423 SAMPLE 101 ...
2005-07-19-11.03.26.740423 SAMPLE 49 ...
...
2 record(s) selected. ...
Output from this query (continued).
... 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 partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_AGENT_MEMORY_POOL, SNAP_GET_APPL_V95,
SNAP_GET_APPL_INFO_V95, 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 partitions.
Refer to Table 115 on page 320 for a complete list of information that can be
returned.
Syntax
SNAP_GET_AGENT ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
Chapter 3. Supported routines and views 319
active database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
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_AGENT table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_AGENT table function.
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
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP DB_NAME AGENT_ID ...
-------------------------- -------...- --------...-- ...
2006-01-03-17.21.38.530785 SAMPLE 48 ...
2006-01-03-17.21.38.530785 SAMPLE 47 ...
2006-01-03-17.21.38.530785 SAMPLE 46 ...
2006-01-03-17.21.38.530785 TESTDB 30 ...
2006-01-03-17.21.38.530785 TESTDB 29 ...
2006-01-03-17.21.38.530785 TESTDB 28 ...
6 record(s) selected.
Output from this query (continued).
... AGENT_PID LOCK_TIMEOUT_VAL DBPARTITIONNUM
... ---------...---- -------------------- --------------
... 7696 -1 0
... 8536 -1 0
... 6672 -1 0
... 2332 -1 0
... 8360 -1 0
... 6736 -1 0
...
Information returned
Table 115. Information returned by the SNAPAGENT administrative view and the
SNAP_GET_AGENT table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
AGENT_PID BIGINT agent_pid - Engine dispatchable
unit (EDU)
320 Administrative Routines and Views
Table 115. Information returned by the SNAPAGENT administrative view and the
SNAP_GET_AGENT table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_TIMEOUT_VAL BIGINT lock_timeout_val - Lock timeout
(seconds)
DBPARTITIONNUM SMALLINT The database partition from which
the data for the row was retrieved.
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.
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
currently connected database.
Used with the SNAPAGENT, SNAPAPPL, SNAPAPPL_INFO, SNAPSTMT and
SNAPSUBSECTION administrative views, the SNAPAGENT_MEMORY_POOL
administrative view provides information equivalent to the GET SNAPSHOT FOR
APPLICATIONS ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 116 on page 323 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPAGENT_MEMORY_POOL
administrative view and EXECUTE privilege on the
SNAP_GET_AGENT_MEMORY_POOL table function.
Example
Retrieve a list of memory pools and their current size.
SELECT AGENT_ID, POOL_ID, POOL_CUR_SIZE FROM SYSIBMADM.SNAPAGENT_MEMORY_POOL
The following is an example of output from this query.
AGENT_ID POOL_ID POOL_ CUR_SIZE
--------...--- -------------- ---------...------
48 APPLICATION 65536
48 OTHER 65536
48 APPL_CONTROL 65536
47 APPLICATION 65536
47 OTHER 131072
47 APPL_CONTROL 65536
46 OTHER 327680
Chapter 3. Supported routines and views 321
46 APPLICATION 262144
46 APPL_CONTROL 65536
9 record(s) selected.
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
partition, aggregate of all database partitions or all database partitions.
Used with the SNAP_GET_AGENT, SNAP_GET_APPL_V95,
SNAP_GET_APPL_INFO_V95, 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.
Refer to Table 116 on page 323 for a complete list of information that can be
returned.
Syntax
SNAP_GET_AGENT_MEMORY_POOL ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_AGENT_MEMORY_POOL table function takes a snapshot for the
currently connected database and database partition number.
322 Administrative Routines and Views
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_AGENT_MEMORY_POOL table
function.
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
The following is an example of output from this query.
DB_NAME AGENT_ID POOL_ID POOL_CUR_SIZE
-------- --------...--- -------------- --------------------
SAMPLE 48 APPLICATION 65536
SAMPLE 48 OTHER 65536
SAMPLE 48 APPL_CONTROL 65536
SAMPLE 47 APPLICATION 65536
SAMPLE 47 OTHER 131072
SAMPLE 47 APPL_CONTROL 65536
SAMPLE 46 OTHER 327680
SAMPLE 46 APPLICATION 262144
SAMPLE 46 APPL_CONTROL 65536
TESTDB 30 APPLICATION 65536
TESTDB 30 OTHER 65536
TESTDB 30 APPL_CONTROL 65536
TESTDB 29 APPLICATION 65536
TESTDB 29 OTHER 131072
TESTDB 29 APPL_CONTROL 65536
TESTDB 28 OTHER 327680
TESTDB 28 APPLICATION 65536
TESTDB 28 APPL_CONTROL 65536
18 record(s) selected.
Information returned
Table 116. Information returned by the SNAPAGENT_MEMORY_POOL administrative view
and the SNAP_GET_AGENT_MEMORY_POOL table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
AGENT_PID BIGINT agent_pid - Engine dispatchable
unit (EDU)
Chapter 3. Supported routines and views 323
Table 116. Information returned by the SNAPAGENT_MEMORY_POOL administrative view
and the SNAP_GET_AGENT_MEMORY_POOL table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_ID VARCHAR(14) pool_id - Memory pool identifier.
This interface returns a text
identifier based on defines in
sqlmon.h, and is one of:
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
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPAPPL_INFO administrative view and
SNAP_GET_APPL_INFO_V95 table function - Retrieve
appl_info logical data group snapshot information
The SNAPAPPL_INFO administrative view and the SNAP_GET_APPL_INFO_V95
table function return information about applications from an application snapshot,
in particular, the appl_info logical data group.
SNAPAPPL_INFO administrative view
This administrative view allows you to retrieve appl_info logical data group
snapshot information for the currently connected database.
324 Administrative Routines and Views
Used with the SNAPAGENT, SNAPAGENT_MEMORY_POOL, SNAPAPPL,
SNAPSTMT 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 partitions.
The schema is SYSIBMADM.
Refer to Table 117 on page 327 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPAPPL_INFO administrative view
and EXECUTE privilege on the SNAP_GET_APPL_INFO_V95 table function.
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
The following is an example of output from this query.
AGENT_ID APPL_NAME APPL_STATUS
-------------------- ---------- ----------------------
101 db2bp.exe UOWEXEC
49 db2bp.exe CONNECTED
2 record(s) selected.
SNAP_GET_APPL_INFO_V95 table function
The SNAP_GET_APPL_INFO_V95 table function returns the same information as
the SNAPAPPL_INFO 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 with the SNAP_GET_AGENT, SNAP_GET_AGENT_MEMORY_POOL,
SNAP_GET_APPL_V95, SNAP_GET_STMT and SNAP_GET_SUBSECTION table
functions, the SNAP_GET_APPL_INFO_V95 table function provides information
equivalent to the GET SNAPSHOT FOR ALL APPLICATIONS CLP command, but
retrieves data from all database partitions.
Refer to Table 117 on page 327 for a complete list of information that can be
returned.
Syntax
SNAP_GET_APPL_INFO_V95 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Chapter 3. Supported routines and views 325
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_APPL_INFO_V95 table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_APPL_INFO_V95 table function.
Examples
Retrieve the status of all applications on the connected database partition.
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_V95(CAST(NULL AS VARCHAR(128)),-1)) AS T
The following is an example of output from this query.
DB_NAME AGENT_ID APPL_NAME APPL_STATUS
-------- -------------------- ---------- ----------------------
TOOLSDB 14 db2bp.exe CONNECTED
SAMPLE 15 db2bp.exe UOWEXEC
SAMPLE 8 javaw.exe CONNECTED
SAMPLE 7 db2bp.exe UOWWAIT
4 record(s) selected.
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
FROM TABLE(SNAP_GET_APPL_INFO_V95(CAST(NULL AS VARCHAR(128)),-1)) AS T
The following is an example of output from this query.
DB_NAME AUTHORITY_LVL
-------- -----------------------------------------------------....
TESTDB SYSADM(GROUP) + DBADM(USER) + CREATETAB(USER, GROUP) +
BINDADD(USER, GROUP) + CONNECT(USER, GROUP) +
326 Administrative Routines and Views
CREATE_NOT_FENC(USER) + IMPLICIT_SCHEMA(USER, GROUP) +
LOAD(USER) + CREATE_EXT_RT(USER) + QUIESCE_CONN(USER)
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 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)
3 record(s) selected.
Information returned
Table 117. Information returned by the SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO_V95 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
Chapter 3. Supported routines and views 327
Table 117. Information returned by the SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
APPL_STATUS VARCHAR(22) appl_status - Application status.
This interface returns a text
identifier based on the defines in
sqlmon.h, and is one of:
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
CODEPAGE_ID BIGINT codepage_id - ID of code page used
by application
NUM_ASSOC_AGENTS BIGINT num_assoc_agents - Number of
associated agents
COORD_NODE_NUM SMALLINT coord_node - Coordinating node
328 Administrative Routines and Views
Table 117. Information returned by the SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
AUTHORITY_LVL VARCHAR(512) authority_bitmap - User
Authorization Level monitor
element.
This interface returns a text
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 BINDADD
v CONNECT
v CREATE_EXT_RT
v CREATE_NOT_FENC
v CREATETAB
v DBADM
v IMPLICIT_SCHEMA
v LOAD
v LIBADM
v QUIESCE_CONN
v SECADM
v SYSADM
v SYSCTRL
v SYSMAINT
v SYSMON
v SYSQUIESCE
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 client_pid - Client process ID
COORD_AGENT_PID BIGINT coord_agent_pid - Coordinator
agent
STATUS_CHANGE_TIME TIMESTAMP status_change_time - Application
status change time
Chapter 3. Supported routines and views 329
Table 117. Information returned by the SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
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
330 Administrative Routines and Views
Table 117. Information returned by the SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
CLIENT_PROTOCOL VARCHAR(10) client_protocol - Client
communication protocol. This
interface returns a text identifier
based on the defines in sqlmon.h,
v CPIC
v LOCAL
v NETBIOS
v NPIPE
v TCPIP (for DB2 UDB)
v TCPIP4
v TCPIP6
TERRITORY_CODE SMALLINT territory_code - Database territory
code
APPL_NAME VARCHAR(256) appl_name - Application name
APPL_ID VARCHAR(128) appl_id - Application ID
SEQUENCE_NO VARCHAR(4) sequence_no - Sequence number
PRIMARY_AUTH_ID VARCHAR(128) auth_id - Authorization ID
SESSION_AUTH_ID VARCHAR(128) session_auth_id - Session
authorization ID
CLIENT_NNAME VARCHAR(128) The client_nname monitor element
is deprecated. The value returned is
not a valid value.
CLIENT_PRDID VARCHAR(128) client_prdid - Client
product/version ID
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input database
alias
CLIENT_DB_ALIAS VARCHAR(128) client_db_alias - Database alias
used by application
DB_NAME VARCHAR(128) db_name - Database name
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) 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 The database partition from which
the data for the row was retrieved.
WORKLOAD_ID INTEGER Current workload ID.
Chapter 3. Supported routines and views 331
Table 117. Information returned by the SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
IS_SYS_APPL SMALLINT The value of IS_SYS_APPL
indicates whether or not the
application is a DB2 internal
system application:
0 means it is a user application
1 means it is a system application.
An example of a DB2 system
application is a DB2 event monitor.
In general, the names of DB2
system applications begin with
″db2″. For example: db2stmm,
db2taskd.
SNAPAPPL administrative view and SNAP_GET_APPL_V95
table function - Retrieve appl logical data group snapshot
information
The “SNAPAPPL administrative view” and the “SNAP_GET_APPL_V95 table
function” on page 333 return information about applications from an application
snapshot, in particular, the appl logical data group.
SNAPAPPL administrative view
This administrative view allows you to retrieve appl logical data group snapshot
information for the currently connected database.
Used with the SNAPAGENT, SNAPAGENT_MEMORY_POOL, SNAPAPPL_INFO,
SNAPSTMT and SNAPSUBSECTION administrative views, the SNAPAPPL
administrative view provides information equivalent to the GET SNAPSHOT FOR
APPLICATIONS ON database-alias CLP command, but retrieves data from all
database partitions.
The schema is SYSIBMADM.
Refer to Table 118 on page 334 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPAPPL administrative view and
EXECUTE privilege on the SNAP_GET_APPL_V95 table function.
Example
Retrieve details on rows read and written for each application in the connected
database.
332 Administrative Routines and Views
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, AGENT_ID, ROWS_READ, ROWS_WRITTEN
FROM SYSIBMADM.SNAPAPPL
The following is an example of output from this query.
DB_NAME AGENT_ID ROWS_READ ROWS_WRITTEN
-------- -------------------- -------------------- --------------------
SAMPLE 7 25 0
1 record(s) selected.
SNAP_GET_APPL_V95 table function
The SNAP_GET_APPL_V95 table function returns the same information as the
SNAPAPPL 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 with the SNAP_GET_AGENT, SNAP_GET_AGENT_MEMORY_POOL,
SNAP_GET_APPL_INFO_V95, SNAP_GET_STMT and SNAP_GET_SUBSECTION
table functions, the SNAP_GET_APPL_V95 table function provides information
equivalent to the GET SNAPSHOT FOR ALL APPLICATIONS CLP command, but
retrieves data from all database partitions.
Refer to Table 118 on page 334 for a complete list of information that can be
returned.
Syntax
SNAP_GET_APPL_V95 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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
Chapter 3. Supported routines and views 333
SNAP_GET_APPL_V95 table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_APPL_V95 table function.
Example
Retrieve details on rows read and written for each application for all active
databases.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, AGENT_ID, ROWS_READ, ROWS_WRITTEN
FROM TABLE (SNAP_GET_APPL_V95(CAST(NULL AS VARCHAR(128)),-1)) AS T
The following is an example of output from this query.
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
Information returned
Table 118. Information returned by the SNAPAPPL administrative view and the
SNAP_GET_APPL_V95 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
UOW_LOG_SPACE_USED BIGINT uow_log_space_used - Unit of
work log space used
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
INACT_STMTHIST_SZ BIGINT stmt_history_list_size - Statement
history list size
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
334 Administrative Routines and Views
Table 118. Information returned by the SNAPAPPL administrative view and the
SNAP_GET_APPL_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index writes
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer
Pool Temporary XDA Data Physical
Reads monitor element
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool
XDA Data Logical Reads
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool
XDA Data Physical Reads
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
LOCKS_HELD BIGINT locks_held - Locks held
LOCK_WAITS BIGINT lock_waits - Lock waits
LOCK_WAIT_TIME BIGINT lock_wait_time - Time waited on
locks
Chapter 3. Supported routines and views 335
Table 118. Information returned by the SNAPAPPL administrative view and the
SNAP_GET_APPL_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_ESCALS BIGINT lock_escals - Number of lock
escalations
X_LOCK_ESCALS BIGINT x_lock_escals - Exclusive lock
escalations
DEADLOCKS BIGINT deadlocks - Deadlocks detected
TOTAL_SORTS BIGINT total_sorts - Total sorts
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
COMMIT_SQL_STMTS BIGINT commit_sql_stmts - Commit
statements attempted
ROLLBACK_SQL_STMTS BIGINT rollback_sql_stmts - Rollback
statements attempted
DYNAMIC_SQL_STMTS BIGINT dynamic_sql_stmts - Dynamic SQL
statements attempted
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
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_commits - Internal commits
INT_ROLLBACKS BIGINT int_rollbacks - Internal rollbacks
INT_DEADLOCK_ROLLBACKS BIGINT int_deadlock_rollbacks - Internal
rollbacks due to deadlock
ROWS_DELETED BIGINT rows_deleted - Rows deleted
ROWS_INSERTED BIGINT rows_inserted - Rows inserted
ROWS_UPDATED BIGINT rows_updated - Rows updated
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
336 Administrative Routines and Views
Table 118. Information returned by the SNAPAPPL administrative view and the
SNAP_GET_APPL_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
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
SQL_REQS_SINCE_COMMIT BIGINT sql_reqs_since_commit - SQL
requests since last commit
LOCK_TIMEOUTS BIGINT lock_timeouts - Number of lock
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
cursors with blocking
PKG_CACHE_LOOKUPS BIGINT pkg_cache_lookups - Package cache
lookups
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
ASSOCIATED_AGENTS_TOP 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 in
sqlmon.h, and is one of:
v DYNAMIC_PRIORITY
v FIXED_PRIORITY
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
Chapter 3. Supported routines and views 337
Table 118. Information returned by the SNAPAPPL administrative view and the
SNAP_GET_APPL_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
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
BIGINT hash_join_small_overflows - Hash
HASH_JOIN_SMALL_ join small overflows
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
UOW_COMP_STATUS VARCHAR(14) uow_comp_status - Unit of work
completion status. This interface
returns a text identifier, based on
defines in sqlmon.h, and is one of:
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
AGENT_USR_CPU_TIME_MS BIGINT agent_usr_cpu_time - User CPU
time used by agent
AGENT_SYS_CPU_TIME_S BIGINT agent_sys_cpu_time - System CPU
time used by agent
AGENT_SYS_CPU_TIME_MS BIGINT agent_sys_cpu_time - System CPU
time used by agent
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
338 Administrative Routines and Views
Table 118. Information returned by the SNAPAPPL administrative view and the
SNAP_GET_APPL_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
UOW_ELAPSED_TIME_MS BIGINT uow_elapsed_time - Most recent
unit of work elapsed time
ELAPSED_EXEC_TIME_S BIGINT elapsed_exec_time - Statement
execution elapsed time
ELAPSED_EXEC_TIME_MS BIGINT elapsed_exec_time - Statement
execution elapsed time
INBOUND_COMM_ADDRESS VARCHAR(32) inbound_comm_address - Inbound
communication address
LOCK_TIMEOUT_VAL BIGINT lock_timeout_val - Lock timeout
(seconds)
BIGINT priv_workspace_num_overflows -
PRIV_WORKSPACE_NUM_ Private workspace overflows
OVERFLOWS
BIGINT priv_workspace_section_inserts -
PRIV_WORKSPACE_SECTION_ Private workspace section inserts
INSERTS
BIGINT priv_workspace_section_lookups -
PRIV_WORKSPACE_SECTION_ Private workspace section lookups
LOOKUPS
BIGINT priv_workspace_size_top -
PRIV_WORKSPACE_SIZE_ Maximum private workspace size
TOP
BIGINT shr_workspace_num_overflows -
SHR_WORKSPACE_NUM_ Shared workspace overflows
OVERFLOWS
BIGINT shr_workspace_section_inserts -
SHR_WORKSPACE_SECTION_ Shared workspace section inserts
INSERTS
BIGINT shr_workspace_section_lookups -
SHR_WORKSPACE_SECTION_ Shared workspace section lookups
LOOKUPS
BIGINT shr_workspace_size_top -
SHR_WORKSPACE_SIZE_ Maximum shared workspace size
TOP
DBPARTITIONNUM SMALLINT The database partition from which
the data for the row was retrieved.
CAT_CACHE_SIZE_TOP BIGINT cat_cache_size_top - Catalog cache
high water mark
TOTAL_OLAP_FUNCS BIGINT The total number of OLAP
functions executed.
OLAP_FUNC_OVERFLOWS BIGINT The number of times that OLAP
function data exceeded the
available sort heap space.
Chapter 3. Supported routines and views 339
SNAPBP administrative view and SNAP_GET_BP_V95 table
function - Retrieve bufferpool logical group snapshot
information
The SNAPBP administrative view and the SNAP_GET_BP_V95 table function
return information about buffer pools from a bufferpool snapshot, in particular, the
bufferpool logical data group.
SNAPBP administrative view
This administrative view allows you to retrieve bufferpool logical group snapshot
information for the currently connected database.
Used with the SNAPBP_PART administrative view, the SNAPBP administrative
view provides the data equivalent to the GET SNAPSHOT FOR BUFFERPOOLS
ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 119 on page 342 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPBP administrative view and
EXECUTE privilege on the SNAP_GET_BP_V95 table function.
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
The following is an example of output from this query.
DB_NAME BP_NAME POOL_DATA_WRITES POOL_INDEX_WRITES
-------- --------------- -------------------- --------------------
TEST IBMDEFAULTBP 0 0
TEST IBMSYSTEMBP4K 0 0
TEST IBMSYSTEMBP8K 0 0
TEST IBMSYSTEMBP16K 0 0
TEST IBMSYSTEMBP32K 0 0
5 record(s) selected
SNAP_GET_BP_V95 table function
The SNAP_GET_BP_V95 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 partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_BP_PART table function, the SNAP_GET_BP_V95 table
function provides the data equivalent to the GET SNAPSHOT FOR ALL
BUFFERPOOLS CLP command.
340 Administrative Routines and Views
Refer to Table 119 on page 342 for a complete list of information that can be
returned.
Syntax
SNAP_GET_BP_V95 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_BP_V95 table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_BP_V95 table function.
Example
Retrieve total physical and logical reads for all bufferpools for all active databases
for the currently connected database partition.
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_V95(CAST(NULL AS VARCHAR(128)), -1)) AS T
The following is an example of output from this query.
DB_NAME BP_NAME TOTAL_LOGICAL_READS ...
---------- ------------...- -------------------- ...
SAMPLE IBMDEFAULTBP 0 ...
Chapter 3. Supported routines and views 341
TOOLSDB IBMDEFAULTBP 0 ...
TOOLSDB BP32K0000 0 ...
3 record(s) selected.
Output from this query (continued).
... TOTAL_PHYSICAL_READS DBPARTITIONNUM
... -------------------- --------------
... 0 0
... 0 0
... 0 0
Information returned
Table 119. Information returned by the SNAPBP administrative view and the
SNAP_GET_BP_V95 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
BP_NAME VARCHAR(128) bp_name - Buffer pool name
DB_NAME VARCHAR(128) db_name - Database name
DB_PATH VARCHAR(1024) db_path - Database path
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input database
alias
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index writes
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool
XDA Data Logical Reads
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool
XDA Data Physical Reads
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
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer
pool asynchronous data reads
POOL_ASYNC_DATA_WRITES BIGINT pool_async_data_writes - Buffer
pool asynchronous data writes
342 Administrative Routines and Views
Table 119. Information returned by the SNAPBP administrative view and the
SNAP_GET_BP_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_ASYNC_INDEX_READS BIGINT pool_async_index_reads - Buffer
pool asynchronous index reads
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_WRITES BIGINT pool_async_xda_writes - Buffer
Pool Asynchronous XDA Data
Writes
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
BIGINT pool_async_data_read_reqs - Buffer
POOL_ASYNC_DATA_ pool asynchronous read requests
READ_REQS
BIGINT pool_async_index_read_reqs -
POOL_ASYNC_INDEX_ Buffer pool asynchronous index
READ_REQS read requests
BIGINT pool_async_xda_read_reqs - Buffer
POOL_ASYNC_XDA_ Pool Asynchronous XDA Read
READ_REQS Requests
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
FILES_CLOSED BIGINT files_closed - Database files closed
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
Chapter 3. Supported routines and views 343
Table 119. Information returned by the SNAPBP administrative view and the
SNAP_GET_BP_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer
Pool Temporary XDA Data Physical
Reads monitor element
POOL_NO_VICTIM_BUFFER BIGINT pool_no_victim_buffer - Buffer pool
no victim buffers
PAGES_FROM_BLOCK_IOS BIGINT pages_from_block_ios - Total
number of pages read by block I/O
PAGES_FROM_VECTORED_IOS 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 The database partition from which
the data was retrieved for this row.
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.
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 SNAPBP administrative view, the SNAPBP_PART administrative
view provides the data equivalent to the GET SNAPSHOT FOR BUFFERPOOLS
ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 120 on page 347 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPBP_PART administrative view and
EXECUTE privilege on the SNAP_GET_BP_PART table function.
Example
Retrieve data for all bufferpools when connected to SAMPLE database.
344 Administrative Routines and Views
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, SUBSTR(BP_NAME,1,15) AS BP_NAME,
BP_CUR_BUFFSZ, BP_NEW_BUFFSZ, BP_PAGES_LEFT_TO_REMOVE, BP_TBSP_USE_COUNT
FROM SYSIBMADM.SNAPBP_PART
The following is an example of output from this query.
DB_NAME BP_NAME BP_CUR_BUFFSZ BP_NEW_BUFFSZ ...
-------- --------------- -------------------- -------------------- ...
SAMPLE IBMDEFAULTBP 1000 1000 ...
SAMPLE IBMSYSTEMBP4K 16 16 ...
SAMPLE IBMSYSTEMBP8K 16 16 ...
SAMPLE IBMSYSTEMBP16K 16 16 ...
...
4 record(s) selected.
Output from this query (continued).
... 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
a specific database on a specific database partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_BP_V95 table function, the SNAP_GET_BP_PART table
function provides the data equivalent to the GET SNAPSHOT FOR ALL
BUFFERPOOLS CLP command.
Refer to Table 120 on page 347 for a complete list of information that can be
returned.
Syntax
SNAP_GET_BP_PART ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 an empty
string to take the snapshot from the currently connected database. Specify a
NULL value to take the snapshot for all bufferpools in all databases within the
same instance as the currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
Chapter 3. Supported routines and views 345
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
database is available for connection and use by applications.
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_BP_PART table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_BP_PART table function.
Example
Retrieve data for all bufferpools for all active databases when connected to the
SAMPLE database.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, SUBSTR(BP_NAME,1,15) AS BP_NAME,
BP_CUR_BUFFSZ, BP_NEW_BUFFSZ, BP_PAGES_LEFT_TO_REMOVE, BP_TBSP_USE_COUNT
FROM TABLE(SNAP_GET_BP_PART(CAST(NULL AS VARCHAR(128)),-1)) AS T
The following is an example of output from this query.
DB_NAME BP_NAME BP_CUR_BUFFSZ BP_NEW_BUFFSZ ...
-------- --------------- -------------------- -------------------- ...
SAMPLE IBMDEFAULTBP 250 250 ...
SAMPLE IBMSYSTEMBP4K 16 16 ...
SAMPLE IBMSYSTEMBP8K 16 16 ...
SAMPLE IBMSYSTEMBP16K 16 16 ...
SAMPLE IBMSYSTEMBP32K 16 16 ...
TESTDB IBMDEFAULTBP 250 250 ...
TESTDB IBMSYSTEMBP4K 16 16 ...
TESTDB IBMSYSTEMBP8K 16 16 ...
TESTDB IBMSYSTEMBP16K 16 16 ...
TESTDB IBMSYSTEMBP32K 16 16 ...
...
Output from this query (continued).
... BP_PAGES_LEFT_TO_REMOVE BP_TBSP_USE_COUNT
... ----------------------- --------------------
... 0 3
... 0 0
... 0 0
... 0 0
... 0 0
... 0 3
... 0 0
... 0 0
... 0 0
... 0 0
...
346 Administrative Routines and Views
Information returned
Table 120. Information returned by the SNAPBP_PART administrative view and the
SNAP_GET_BP_PART table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
BP_NAME VARCHAR(128) bp_name - Buffer pool name
DB_NAME VARCHAR(128) db_name - Database name
BP_CUR_BUFFSZ BIGINT bp_cur_buffsz - Current size of
buffer pool
BP_NEW_BUFFSZ BIGINT bp_new_buffsz - New buffer pool
size
BP_PAGES_LEFT_TO_REMOVE 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 The database partition from which
the data was retrieved for this row.
SNAPCONTAINER administrative view and
SNAP_GET_CONTAINER_V91 table function - Retrieve
tablespace_container logical data group snapshot information
The SNAPCONTAINER administrative view and the
SNAP_GET_CONTAINER_V91 table function return table space snapshot
information from the tablespace_container logical data group.
SNAPCONTAINER administrative view
This administrative view allows you to retrieve tablespace_container logical data
group snapshot information for the currently connected database.
Used with the SNAPTBSP, SNAPTBSP_PART, SNAPTBSP_QUIESCER and
SNAPTBSP_RANGE administrative views, the SNAPCONTAINER administrative
view returns data equivalent to the GET SNAPSHOT FOR TABLESPACES ON
database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 121 on page 350 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPCONTAINER administrative view
and EXECUTE privilege on the SNAP_GET_CONTAINER_V91 table function.
Chapter 3. Supported routines and views 347
Example
Retrieve details for the table space containers for all database partitions for the
currently connected database.
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
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP TBSP_NAME TBSP_ID ...
-------------------------- --------------- -------...- ...
2006-01-08-16.49.24.639945 SYSCATSPACE 0 ...
2006-01-08-16.49.24.639945 TEMPSPACE1 1 ...
2006-01-08-16.49.24.639945 USERSPACE1 2 ...
2006-01-08-16.49.24.639945 SYSTOOLSPACE 3 ...
2006-01-08-16.49.24.640747 TEMPSPACE1 1 ...
2006-01-08-16.49.24.640747 USERSPACE1 2 ...
2006-01-08-16.49.24.639981 TEMPSPACE1 1 ...
2006-01-08-16.49.24.639981 USERSPACE1 2 ...
...
8 record(s) selected.
Output from this query (continued).
... CONTAINER_NAME CONTAINER_ID CONTAINER_TYPE ...
... -------------------- ------------...- ---------------- ...
... /home/swalkty/swalkt 0 FILE_EXTENT_TAG ...
... /home/swalkty/swalkt 0 PATH ...
... /home/swalkty/swalkt 0 FILE_EXTENT_TAG ...
... /home/swalkty/swalkt 0 FILE_EXTENT_TAG ...
... /home/swalkty/swalkt 0 PATH ...
... /home/swalkty/swalkt 0 FILE_EXTENT_TAG ...
... /home/swalkty/swalkt 0 PATH ...
... /home/swalkty/swalkt 0 FILE_EXTENT_TAG ...
Output from this query (continued).
... ACCESSIBLE DBPARTITIONNUM
... ---------- --------------
... 1 0
... 1 0
... 1 0
... 1 0
... 1 1
... 1 1
... 1 2
... 1 2
SNAP_GET_CONTAINER_V91 table function
The SNAP_GET_CONTAINER_V91 table function returns the same information as
the SNAPCONTAINER 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 with the SNAP_GET_TBSP_V91, SNAP_GET_TBSP_PART_V91,
SNAP_GET_TBSP_QUIESCER and SNAP_GET_TBSP_RANGE table functions, the
SNAP_GET_CONTAINER_V91 table function returns data equivalent to the GET
SNAPSHOT FOR TABLESPACES ON database-alias CLP command.
Refer to Table 121 on page 350 for a complete list of information that can be
returned.
348 Administrative Routines and Views
Syntax
SNAP_GET_CONTAINER_V91 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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 SYSMON authority
v EXECUTE privilege on the SNAP_GET_CONTAINER_V91 table function.
Example
Retrieve details for the table space containers on the currently connected database
on the currently connected database partition.
SELECT SNAPSHOT_TIMESTAMP, TBSP_NAME, TBSP_ID, CONTAINER_NAME,
CONTAINER_ID, CONTAINER_TYPE, ACCESSIBLE
FROM TABLE(SNAP_GET_CONTAINER_V91(’’,-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP TBSP_NAME TBSP_ID ...
-------------------------- -------------------- ------- ...
2005-04-25-14.42.10.899253 SYSCATSPACE 0 ...
2005-04-25-14.42.10.899253 TEMPSPACE1 1 ...
2005-04-25-14.42.10.899253 USERSPACE1 2 ...
2005-04-25-14.42.10.899253 SYSTOOLSPACE 3 ...
2005-04-25-14.42.10.899253 MYTEMP 4 ...
2005-04-25-14.42.10.899253 WHATSNEWTEMPSPACE 5 ...
Output from this query (continued).
Chapter 3. Supported routines and views 349
... CONTAINER_NAME CONTAINER_ID ...
... ---------------------------------------- ------------ ...
... D:\DB2\NODE0000\SQL00002\SQLT0000.0 0 ...
... D:\DB2\NODE0000\SQL00002\SQLT0001.0 0 ...
... D:\DB2\NODE0000\SQL00002\SQLT0002.0 0 ...
... D:\DB2\NODE0000\SQL00002\SYSTOOLSPACE 0 ...
... D:\DB2\NODE0000\SQL003 0 ...
... d:\DGTTsWhatsNewContainer 0 ...
Output from this query (continued).
... CONTAINER_TYPE ACCESSIBLE
... -------------- ----------
... CONT_PATH 1
... CONT_PATH 1
... CONT_PATH 1
... CONT_PATH 1
... CONT_PATH 1
... CONT_PATH 1
Information returned
NOTE: The BUFFERPOOL database manager monitor switch must be turned on in
order for the file system information to be returned.
Table 121. Information returned by the SNAPCONTAINER administrative view and the
SNAP_GET_CONTAINER_V91 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
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
CONTAINER_TYPE VARCHAR(16) container_type - Container type.
This is a text identifer 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 container_stripe_set - Stripe set
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
350 Administrative Routines and Views
Table 121. Information returned by the SNAPCONTAINER administrative view and the
SNAP_GET_CONTAINER_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
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
SNAPDB administrative view and SNAP_GET_DB_V95 table
function - Retrieve snapshot information from the dbase
logical group
The “SNAPDB administrative view” and the “SNAP_GET_DB_V95 table function”
on page 352 return snapshot information from the database (dbase) logical group.
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 the SNAPDB_MEMORY_POOL, SNAPDETAILLOG,
SNAPHADR and SNAPSTORAGE_PATHS administrative views, the SNAPDB
administrative view provides information equivalent to the GET SNAPSHOT FOR
DATABASE on database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 122 on page 354 for a complete list of information that is returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPDB administrative view and
EXECUTE privilege on the SNAP_GET_DB_V95 table function.
Examples
Retrieve the status, platform, location, and connect time for all database partitions
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
The following is an example of output from this query.
DB_NAME DB_STATUS SERVER_PLATFORM DB_LOCATION ...
-------...- ------------ --------------- ------------ ...
TEST ACTIVE AIX64 LOCAL ...
Chapter 3. Supported routines and views 351
TEST ACTIVE AIX64 LOCAL ...
TEST ACTIVE AIX64 LOCAL ...
3 record(s) selected.
Output from this query (continued).
... 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
1 record(s) selected.
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
FROM SYSIBMADM.SNAPDB
STATS_CACHE_SIZE STATS_FABRICATIONS SYNC_RUNSTATS ASYNC_RUNSTATS ...
---------------- ------------------ ------------- -------------- ...
128 2 1 0 ...
... STATS_FABRICATE_TIME SYNC_RUNSTATS_TIME
... -------------------- ------------------
... 10 100
1 record(s) selected.
SNAP_GET_DB_V95 table function
The SNAP_GET_DB_V95 table function returns the same information as the
SNAPDB administrative view.
Used in conjunction with the SNAP_GET_DB_MEMORY_POOL,
SNAP_GET_DETAILLOG_V91, SNAP_GET_HADR and
SNAP_GET_STORAGE_PATHS table functions, the SNAP_GET_DB_V95 table
function provides information equivalent to the GET SNAPSHOT FOR ALL
DATABASES CLP command.
Refer to Table 122 on page 354 for a complete list of information that is returned.
Syntax
SNAP_GET_DB_V95 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
352 Administrative Routines and Views
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_DB_V95 table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DB_V95 table function.
Examples
Example 1: Retrieve the status, platform, location, and connect time as an aggregate
view across all database partitions of the currently connected database.
SELECT SUBSTR(DB_NAME, 1, 20) AS DB_NAME, DB_STATUS, SERVER_PLATFORM,
DB_LOCATION, DB_CONN_TIME FROM TABLE(SNAP_GET_DB_V95(’’, -2)) AS T
The following is an example of output from this query.
DB_NAME DB_STATUS SERVER_PLATFORM ...
-------...- ------------ --------------- ...
SAMPLE ACTIVE AIX64 ...
1 record(s) selected.
Output from this query (continued).
... DB_LOCATION DB_CONN_TIME
... ------------ --------------------------
... LOCAL 2005-07-24-22.09.22.013196
Example 2: Retrieve the status, platform, location, and connect time as an aggregate
view across all database partitions for all active databases in the same instance that
contains the currently connected database.
SELECT SUBSTR(DB_NAME, 1, 20) AS DB_NAME, DB_STATUS, SERVER_PLATFORM,
DB_LOCATION, DB_CONN_TIME
FROM TABLE(SNAP_GET_DB_V95(CAST (NULL AS VARCHAR(128)), -2)) AS T
Chapter 3. Supported routines and views 353
The following is an example of output from this query.
DB_NAME DB_STATUS SERVER_PLATFORM ...
--------...- ------------ --------------- ...
TOOLSDB ACTIVE AIX64 ...
SAMPLE ACTIVE AIX64 ...
Output from this query (continued).
... DB_LOCATION DB_CONN_TIME
... ------------ --------------------------
... LOCAL 2005-07-24-22.26.54.396335
... LOCAL 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:
SELECT TOTAL_OLAP_FUNCS, OLAP_FUNC_OVERFLOWS, ACTIVE_OLAP_FUNCS
FROM TABLE (SNAP_GET_DB_V95(’’, 0)) AS T
The output will look like:
TOTAL_OLAP_FUNCS OLAP_FUNC_OVERFLOWS ACTIVE_OLAP_FUNCS
---------------- -------------------- --------------------
7 2 1
1 record(s) selected.
Example 4: After running a workload, a user can use the following query with the
table function.
SELECT STATS_CACHE_SIZE, STATS_FABRICATIONS, SYNC_RUNSTATS,
ASYNC_RUNSTATS, STATS_FABRICATE_TIME, SYNC_RUNSTATS_TIME
FROM TABLE (SNAP_GET_DB_V95(’mytestdb’, -1)) AS SNAPDB
STATS_CACHE_SIZE STATS_FABRICATIONS SYNC_RUNSTATS ASYNC_RUNSTATS ...
---------------- ------------------ ------------- -------------- ...
200 1 2 0 ...
Continued
...STATS_FABRICATE_TIME SYNC_RUNSTATS_TIME
...-------------------- ------------------
... 2 32
1 record(s) selected.
SNAPDB administrative view and SNAP_GET_DB_V95 table
function metadata
Table 122. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table function
Description or corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was
taken.
DB_NAME VARCHAR(128) db_name - Database name
DB_PATH VARCHAR(1024) db_path - Database path
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input database alias
354 Administrative Routines and Views
Table 122. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
DB_STATUS VARCHAR(12) db_status - Status of database. This interface
returns a text identifier based on defines in
sqlmon.h, and is one of:
v ACTIVE
v QUIESCE_PEND
v QUIESCED
v ROLLFWD
CATALOG_PARTITION SMALLINT catalog_node - Catalog node number
CATALOG_PARTITION_NAME VARCHAR(128) catalog_node_name - Catalog node network
name
Chapter 3. Supported routines and views 355
Table 122. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
SERVER_PLATFORM VARCHAR(12) 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 interface
returns a text identifier based on defines in
sqlmon.h, and is one of:
v LOCAL
v REMOTE
DB_CONN_TIME TIMESTAMP db_conn_time - Database activation
timestamp
LAST_RESET TIMESTAMP last_reset - Last reset timestamp
LAST_BACKUP TIMESTAMP last_backup - Last backup timestamp
356 Administrative Routines and Views
Table 122. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
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 locks_held - Locks held
LOCK_WAITS BIGINT lock_waits - Lock waits
LOCK_WAIT_TIME BIGINT lock_wait_time - Time waited on locks
LOCK_LIST_IN_USE BIGINT lock_list_in_use - Total lock list memory in
use
DEADLOCKS BIGINT deadlocks - Deadlocks detected
LOCK_ESCALS BIGINT lock_escals - Number of lock escalations
X_LOCK_ESCALS BIGINT x_lock_escals - Exclusive lock escalations
LOCKS_WAITING BIGINT locks_waiting - Current agents waiting on
locks
LOCK_TIMEOUTS BIGINT lock_timeouts - Number of lock timeouts
NUM_INDOUBT_TRANS BIGINT num_indoubt_trans - Number of indoubt
transactions
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
water mark
POST_SHRTHRESHOLD_SORTS BIGINT post_shrthreshold_sorts - Post shared
threshold sorts
TOTAL_SORTS BIGINT total_sorts - Total sorts
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
ACTIVE_SORTS BIGINT active_sorts - Active sorts
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool data logical
reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool data physical
reads
Chapter 3. Supported routines and views 357
Table 122. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer pool
temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer pool
temporary data physical reads
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer pool
asynchronous data reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data writes
POOL_ASYNC_DATA_WRITES BIGINT pool_async_data_writes - Buffer pool
asynchronous data writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool index logical
reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool index
physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer pool
temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer pool
temporary index physical reads
POOL_ASYNC_INDEX_READS BIGINT pool_async_index_reads - Buffer pool
asynchronous index reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool index writes
POOL_ASYNC_INDEX_WRITES BIGINT pool_async_index_writes - Buffer pool
asynchronous index writes
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool XDA Data
Physical Reads
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool XDA Data
Logical Reads
POOL_XDA_WRITES BIGINT pool_xda_writes - Buffer Pool XDA Data
Writes
POOL_ASYNC_XDA_READS BIGINT pool_async_xda_reads - Buffer Pool
Asynchronous XDA Data Reads
POOL_ASYNC_XDA_WRITES BIGINT pool_async_xda_writes - Buffer Pool
Asynchronous XDA Data Writes
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer Pool
Temporary XDA Data Physical Reads monitor
element
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer Pool
Temporary XDA Data Logical Reads
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
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
358 Administrative Routines and Views
Table 122. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
BIGINT pool_async_data_read_reqs - Buffer pool
POOL_ASYNC_DATA_ asynchronous read requests
READ_REQS
BIGINT pool_async_index_read_reqs - Buffer pool
POOL_ASYNC_INDEX_ asynchronous index read requests
READ_REQS
BIGINT pool_async_xda_read_reqs - Buffer Pool
POOL_ASYNC_XDA_ Asynchronous XDA Read Requests
READ_REQS
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
PREFETCH_WAIT_TIME BIGINT prefetch_wait_time - Time waited for prefetch
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread prefetch
pages
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write time
FILES_CLOSED BIGINT files_closed - Database files closed
ELAPSED_EXEC_TIME_S BIGINT elapsed_exec_time - Statement execution
elapsed time
ELAPSED_EXEC_TIME_MS BIGINT elapsed_exec_time - Statement execution
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 dynamic_sql_stmts - Dynamic SQL
statements attempted
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
Chapter 3. Supported routines and views 359
Table 122. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
DDL_SQL_STMTS BIGINT ddl_sql_stmts - Data definition language
(DDL) SQL statements
INT_AUTO_REBINDS BIGINT int_auto_rebinds - Internal automatic rebinds
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
INT_COMMITS BIGINT int_commits - Internal commits
INT_ROLLBACKS BIGINT int_rollbacks - Internal rollbacks
INT_DEADLOCK_ROLLBACKS BIGINT int_deadlock_rollbacks - Internal rollbacks
due to deadlock
ROWS_DELETED BIGINT rows_deleted - Rows deleted
ROWS_INSERTED BIGINT rows_inserted - Rows inserted
ROWS_UPDATED BIGINT rows_updated - Rows updated
ROWS_SELECTED BIGINT rows_selected - Rows selected
ROWS_READ BIGINT rows_read - Rows read
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_read_time - Log read time
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 log_write_time - Log write time
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
NUM_LOG_PART_PAGE_IO 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
BIGINT num_log_data_found_in_buffer - Number of
NUM_LOG_DATA_FOUND_ log data found in buffer
IN_BUFFER
APPL_ID_OLDEST_XACT BIGINT appl_id_oldest_xact - Application with oldest
transaction
360 Administrative Routines and Views
Table 122. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
BIGINT log_to_redo_for_recovery - Amount of log to
LOG_TO_REDO_FOR_ be redone for recovery
RECOVERY
LOG_HELD_BY_DIRTY_PAGES BIGINT log_held_by_dirty_pages - Amount of log
space accounted for by dirty pages
PKG_CACHE_LOOKUPS BIGINT pkg_cache_lookups - Package cache lookups
PKG_CACHE_INSERTS BIGINT pkg_cache_inserts - Package cache inserts
BIGINT pkg_cache_num_overflows - Package cache
PKG_CACHE_NUM_ overflows
OVERFLOWS
PKG_CACHE_SIZE_TOP BIGINT pkg_cache_size_top - Package cache high
water mark
APPL_SECTION_LOOKUPS BIGINT appl_section_lookups - Section lookups
APPL_SECTION_INSERTS BIGINT appl_section_inserts - Section 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
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
BIGINT priv_workspace_num_overflows - Private
PRIV_WORKSPACE_NUM_ workspace overflows
OVERFLOWS
BIGINT priv_workspace_section_inserts - Private
PRIV_WORKSPACE_SECTION_ workspace section inserts
INSERTS
BIGINT priv_workspace_section_lookups - Private
PRIV_WORKSPACE_SECTION_ workspace section lookups
LOOKUPS
SHR_WORKSPACE_SIZE_TOP BIGINT shr_workspace_size_top - Maximum shared
workspace size
BIGINT shr_workspace_num_overflows - Shared
SHR_WORKSPACE_NUM_ workspace overflows
OVERFLOWS
BIGINT shr_workspace_section_inserts - Shared
SHR_WORKSPACE_SECTION_ workspace section inserts
INSERTS
BIGINT shr_workspace_section_lookups - Shared
SHR_WORKSPACE_SECTION_ workspace section lookups
LOOKUPS
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
Chapter 3. Supported routines and views 361
Table 122. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
BIGINT hash_join_small_overflows - Hash join small
HASH_JOIN_SMALL_ overflows
OVERFLOWS
BIGINT post_shrthreshold_hash_joins - Post threshold
POST_SHRTHRESHOLD_ hash joins
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 The database partition from which the data
was retrieved for this row.
INTEGER smallest_log_avail_node - Node with least
SMALLEST_LOG_AVAIL_ available log space
NODE
TOTAL_OLAP_FUNCS BIGINT The total number of OLAP functions
executed.
OLAP_FUNC_OVERFLOWS BIGINT The number of times that OLAP function
data exceeded the available sort heap space.
ACTIVE_OLAP_FUNCS BIGINT The total number of OLAP functions that are
currently running and consuming sort heap
memory.
STATS_CACHE_SIZE BIGINT The size of the statistics cache in bytes
STATS_FABRICATIONS BIGINT Total number of statistics-collect activities for
creating statistics by the system without table
or index scan.
SYNC_RUNSTATS BIGINT Total number of synchronous statistics-collect
activities during query compilation.
ASYNC_RUNSTATS BIGINT We will change the output for this column to
total number of successful asynchronous
statistics-collect activities.
STATS_FABRICATE_TIME BIGINT Total time spent on creating statistics by
system without table or index scan during
query compilation in milliseconds.
SYNC_RUNSTATS_TIME BIGINT Total time spent on synchronous
statistics-collect activities in milliseconds.
NUM_THRESHOLD_VIOLATIONS BIGINT The number of threshold violations that have
occurred at the database.
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.
362 Administrative Routines and Views
SNAPDB_MEMORY_POOL administrative view
This administrative view allows you to retrieve database level memory usage
information for the currently connected database.
Used with the SNAPDB, SNAPDETAILLOG, SNAPHADR and
SNAPSTORAGE_PATHS administrative views, the SNAPDB_MEMORY_POOL
administrative view provides information equivalent to the GET SNAPSHOT FOR
DATABASE ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 123 on page 365 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPDB_MEMORY_POOL
administrative view and EXECUTE privilege on the
SNAP_GET_DB_MEMORY_POOL table function.
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
The following is an example of output from this query.
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
12 record(s) selected.
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 partition, aggregate of
all database partitions or all database partitions.
Used with the SNAP_GET_DB_V95, SNAP_GET_DETAILLOG_V91,
SNAP_GET_HADR and SNAP_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.
Refer to Table 123 on page 365 for a complete list of information that can be
returned.
Chapter 3. Supported routines and views 363
Syntax
SNAP_GET_DB_MEMORY_POOL ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_DB_MEMORY_POOL table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DB_MEMORY_POOL table function.
Example
Retrieve a list of memory pools and their current size for all databases.
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
The following is an example of output from this query.
DB_NAME POOL_ID POOL_CUR_SIZE
-------- -------------- --------------------
TESTDB UTILITY 65536
TESTDB PACKAGE_CACHE 851968
TESTDB CAT_CACHE 65536
TESTDB BP 35913728
TESTDB BP 589824
TESTDB BP 327680
TESTDB BP 196608
TESTDB BP 131072
TESTDB SHARED_SORT 65536
364 Administrative Routines and Views
TESTDB LOCK_MGR 10092544
TESTDB DATABASE 4980736
TESTDB OTHER 196608
SAMPLE UTILITY 65536
SAMPLE PACKAGE_CACHE 655360
SAMPLE CAT_CACHE 131072
SAMPLE BP 4325376
SAMPLE BP 589824
SAMPLE BP 327680
SAMPLE BP 196608
SAMPLE BP 131072
SAMPLE SHARED_SORT 0
SAMPLE LOCK_MGR 655360
SAMPLE DATABASE 4653056
SAMPLE OTHER 196608
24 record(s) selected.
Information returned
Table 123. Information returned by the SNAPDB_MEMORY_POOL administrative view and
the SNAP_GET_DB_MEMORY_POOL table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
POOL_ID VARCHAR(14) pool_id - Memory pool identifier.
This interface returns a text
identifier based on defines in
sqlmon.h, and is one of:
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 pool_cur_size - Current size of
memory pool
Chapter 3. Supported routines and views 365
Table 123. Information returned by the SNAPDB_MEMORY_POOL administrative view and
the SNAP_GET_DB_MEMORY_POOL table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_WATERMARK BIGINT pool_watermark - Memory pool
watermark
POOL_CONFIG_SIZE BIGINT pool_config_size - Configured size
of memory pool
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPDBM administrative view and SNAP_GET_DBM_V95
table function - Retrieve the dbm logical grouping snapshot
information
The SNAPDBM administrative view and the SNAP_GET_DBM_V95 table function
return the snapshot monitor DB2 database manager (dbm) logical grouping
information.
SNAPDBM administrative view
Used with the SNAPDBM_MEMORY_POOL, SNAPFCM, SNAPFCM_PART and
SNAPSWITCHES administrative views, the SNAPDBM administrative view
provides the data equivalent to the GET SNAPSHOT FOR DBM command.
The schema is SYSIBMADM.
Refer to Table 124 on page 368 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPDBM administrative view and
EXECUTE privilege on the SNAP_GET_DBM_V95 table function.
Example
Retrieve database manager status and connection information for all database
partitions.
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
The following is an example of output from this query.
DB2_STATUS DB2START_TIME LAST_RESET ...
------------ -------------------------- ----------...- ...
ACTIVE 2006-01-06-14.59.59.059879 - ...
ACTIVE 2006-01-06-14.59.59.097605 - ...
ACTIVE 2006-01-06-14.59.59.062798 - ...
3 record(s) selected. ...
Output from this query (continued).
366 Administrative Routines and Views
... LOCAL_CONS REM_CONS_IN AGENT_USAGE DBPARTITIONNUM
... ----------...- -----------...- -----------...- --------------
... 1 1 0 0
... 0 0 0 1
... 0 0 0 2
SNAP_GET_DBM_V95 table function
The SNAP_GET_DBM_V95 table function returns the same information as the
SNAPDBM administrative view, but allows you to retrieve the information for a
specific database partition, aggregate of all database partitions or all database
partitions.
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_V95 table function provides the data equivalent to the GET
SNAPSHOT FOR DBM command.
Refer to Table 124 on page 368 for a complete list of information that can be
returned.
Syntax
SNAP_GET_DBM_V95 ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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_DBM_V95 table function calls the snapshot from memory.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DBM_V95 table function.
Example
Retrieve the start time and current status of database partition number 2.
SELECT DB2START_TIME, DB2_STATUS FROM TABLE(SNAP_GET_DBM_V95(2)) AS T
The following is an example of output from this query.
Chapter 3. Supported routines and views 367
DB2START_TIME DB2_STATUS
-------------------------- ------------
2006-01-06-14.59.59.062798 ACTIVE
Information returned
Table 124. Information returned by the SNAPDBM administrative view and the SNAP_GET_DBM_V95 table function
Description or corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was
taken.
SORT_HEAP_ALLOCATED BIGINT sort_heap_allocated - Total sort heap
allocated
POST_THRESHOLD_SORTS BIGINT post_threshold_sorts - Post threshold sorts
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
Executing in the Database Manager monitor
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
This interface returns a text identifier based
on defines in sqlmon.h, and is one of:
v ACTIVE
v QUIESCE_PEND
v QUIESCED
AGENTS_REGISTERED_TOP BIGINT agents_registered_top - Maximum number
of agents registered
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 coord_agents_top - Maximum number of
coordinating agents
368 Administrative Routines and Views
Table 124. Information returned by the SNAPDBM administrative view and the SNAP_GET_DBM_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
MAX_AGENT_OVERFLOWS BIGINT max_agent_overflows - Maximum agent
overflows
AGENTS_STOLEN BIGINT agents_stolen - Stolen agents
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
connections for DB2 Connect
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 last_reset - 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 The database partition from which the data
was retrieved for this row.
POST_THRESHOLD_OLAP_FUNCS BIGINT The number of OLAP functions which have
requested a sort heap after the sort heap
threshold has been exceeded.
Sorts, hash joins, and OLAP functions are
examples of operations which utilize a sort
heap. Under normal conditions, the
database manager will allocate sort heap
using the value specified by the sortheap
configuration parameter. If the amount of
memory allocated to sort heaps exceeds the
sort heap threshold (sheapthres
configuration parameter), the database
manager will allocate subsequent sort heaps
using a value less than that specified by the
sortheap configuration parameter.
OLAP functions which start after the sort
heap threshold has been reached may not
receive an optimum amount of memory to
execute.
Chapter 3. Supported routines and views 369
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.
SNAPDBM_MEMORY_POOL administrative view
Used with the SNAPDBM, SNAPFCM, SNAPFCM_PART and SNAPSWITCHES
administrative views, the SNAPDBM_MEMORY_POOL administrative view
provides the data equivalent to the GET SNAPSHOT FOR DBM command.
The schema is SYSIBMADM.
Refer to Table 125 on page 372 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPDBM_MEMORY_POOL
administrative view and EXECUTE privilege on the
SNAP_GET_DBM_MEMORY_POOL table function.
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
The following is an example of output from this query.
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 partition, aggregate of all
database partitions or all database partitions.
Used with the SNAP_GET_DBM_V95, 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.
Refer to Table 125 on page 372 for a complete list of information that can be
returned.
370 Administrative Routines and Views
Syntax
SNAP_GET_DBM_MEMORY_POOL ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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_DBM_MEMORY_POOL table function takes a snapshot for the
currently connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DBM_MEMORY_POOL table function.
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
The following is an example of output from this query.
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
Chapter 3. Supported routines and views 371
Information returned
Table 125. Information returned by the SNAPDBM_MEMORY_POOL administrative view and
the SNAP_GET_DBM_MEMORY_POOL table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
POOL_ID VARCHAR(14) pool_id - Memory pool identifier.
This interface returns a text
identifier based on defines in
sqlmon.h, and is one of:
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
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPDETAILLOG administrative view and
SNAP_GET_DETAILLOG_V91 table function - Retrieve
snapshot information from the detail_log logical data group
The SNAPDETAILLOG administrative view and the SNAP_GET_DETAILLOG_V91
table function return snapshot information from the detail_log logical data group.
372 Administrative Routines and Views
SNAPDETAILLOG administrative view
This administrative view allows you to retrieve snapshot information from the
detail_log logical data group for the currently connected database.
Used in conjunction with the SNAPDB, SNAPDB_MEMORY_POOL, SNAPHADR
and SNAPSTORAGE_PATHS administrative views, the SNAPDETAILLOG
administrative view provides information equivalent to the GET SNAPSHOT FOR
DATABASE on database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 126 on page 375 for a complete list of information that is returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPDETAILLOG administrative view
and EXECUTE privilege on the SNAP_GET_DETAILLOG_V91 table function.
Example
Retrieve log information for all database partitions 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
The following is an example of output from this query.
DB_NAME FIRST_ACTIVE_LOG LAST_ACTIVE_LOG ...
-------- -------------------- -------------------- ...
TEST 0 8 ...
TEST 0 8 ...
TEST 0 8 ...
...
3 record(s) selected. ...
Output from this query (continued).
... CURRENT_ACTIVE_LOG CURRENT_ARCHIVE_LOG DBPARTITIONNUM
... -------------------- -------------------- --------------
... 0 - 0
... 0 - 1
... 0 - 2
SNAP_GET_DETAILLOG_V91 table function
The SNAP_GET_DETAILLOG_V91 table function returns the same information as
the SNAPDETAILLOG administrative view.
Used in conjunction with the SNAP_GET_DB_V95,
SNAP_GET_DB_MEMORY_POOL, SNAP_GET_HADR and
SNAP_GET_STORAGE_PATHS table functions, the SNAP_GET_DETAILLOG table
function provides information equivalent to the GET SNAPSHOT FOR ALL
DATABASES CLP command.
Refer to Table 126 on page 375 for a complete list of information that is returned.
Chapter 3. Supported routines and views 373
Syntax
SNAP_GET_DETAILLOG_V91 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_DETAILLOG_V91 table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DETAILLOG_V91 table function.
Example
Retrieve log information for database partition 1 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
FROM TABLE(SNAP_GET_DETAILLOG_V91(’’, 1)) AS T
The following is an example of output from this query.
DB_NAME FIRST_ACTIVE_LOG LAST_ACTIVE_LOG ...
-------- -------------------- -------------------- ...
TEST 0 8 ...
...
1 record(s) selected. ...
Output from this query (continued).
374 Administrative Routines and Views
... CURRENT_ACTIVE_LOG CURRENT_ARCHIVE_LOG
... -------------------- --------------------
... 0 -
...
...
SNAPDETAILLOG administrative view and
SNAP_GET_DETAILLOG_V91 table function metadata
Table 126. Information returned by the SNAPDETAILLOG administrative view and
SNAP_GET_DETAILLOG_V91 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
FIRST_ACTIVE_LOG BIGINT first_active_log - First active log file
number
LAST_ACTIVE_LOG BIGINT last_active_log - Last active log file
number
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 The database partition from which
the data was retrieved for this row.
SNAPDYN_SQL administrative view and
SNAP_GET_DYN_SQL_V95 table function - Retrieve dynsql
logical group snapshot information
The “SNAPDYN_SQL administrative view” and the “SNAP_GET_DYN_SQL_V95
table function” on page 376 return snapshot information from the dynsql logical
data group.
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.
The schema is SYSIBMADM.
Refer to Table 127 on page 378 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPDYN_SQL administrative view
and EXECUTE privilege on the SNAP_GET_DYN_SQL_V95 table function.
Chapter 3. Supported routines and views 375
Example
Retrieve a list of dynamic SQL run on all database partitions of 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
The following is an example of output from this query.
PREP_TIME_WORST NUM_COMPILATIONS ...
-------------------- -------------------- ...
98 1 ...
9 1 ...
0 0 ...
0 1 ...
0 1 ...
0 1 ...
0 1 ...
0 1 ...
40 1 ...
...
9 record(s) selected.
Output from this query (continued).
... 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, ...
... select prep_time_worst, num_compilations, substr(stmt_text, ...
... select * from dbuser.employee ...
... insert into dbuser.employee values(1) ...
... select * from dbuser.employee ...
... insert into dbuser.employee values(1) ...
Output from this query (continued).
... DBPARTITIONNUM
... --------------
... 0
... 0
... 0
... 2
... 1
... 2
... 2
... 1
... 0
SNAP_GET_DYN_SQL_V95 table function
The SNAP_GET_DYN_SQL_V95 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 partition, aggregate of all database
partitions or all database partitions.
This table function returns information equivalent to the GET SNAPSHOT FOR
DYNAMIC SQL ON database-alias CLP command.
Refer to Table 127 on page 378 for a complete list of information that can be
returned.
376 Administrative Routines and Views
Syntax
SNAP_GET_DYN_SQL_V95 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_DYN_SQL_V95 table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DYN_SQL_V95 table function.
Example
Retrieve a list of dynamic SQL run on the currently connected database partition of
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 FROM TABLE(SNAP_GET_DYN_SQL_V95(’’,-1)) as T
ORDER BY ROWS_READ
The following is an example of output from this query.
PREP_TIME_WORST ...
-------------------- ...
0 ...
3 ...
...
4 ...
...
4 ...
...
4 ...
...
Chapter 3. Supported routines and views 377
3 ...
...
4 ...
...
Output from this query (continued).
... NUM_COMPILATIONS STMT_TEXT
... -------------------- ---------------------------------------...-
... 0 SET CURRENT LOCALE LC_CTYPE = ’en_US’
... 1 select rows_read, rows_written,
... substr(stmt_text, 1, 40) as
... 1 select * from table
... (snap_get_dyn_sqlv9(’’,-1)) as t
... 1 select * from table
... (snap_getdetaillog9(’’,-1)) as t
... 1 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,
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_V95(’mytestdb’, -1))
AS SNAPDB
STATS_FABRICATE_TIME SYNC_RUNSTATS_TIME
---------------------- ------------------
2 12
1 30
For the view based on this table function:
SELECT STATS_FABRICATE_TIME,SYNC_RUNSTATS_TIME
FROM SYSIBMADM.SNAPDYN_SQL
STATS_FABRICATE_TIME SYNC_RUNSTATS_TIME
---------------------- ------------------
5 10
3 20
2 record(s) selected.
Information returned
Table 127. Information returned by the SNAPDYN_SQL administrative view and the SNAP_GET_DYN_SQL_V95 table
function
Description or corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was
taken.
NUM_EXECUTIONS BIGINT num_executions - Statement executions
NUM_COMPILATIONS BIGINT num_compilations - Statement compilations
PREP_TIME_WORST BIGINT prep_time_worst - Statement worst
preparation time
PREP_TIME_BEST BIGINT prep_time_best - Statement best preparation
time
INT_ROWS_DELETED BIGINT int_rows_deleted - Internal rows deleted
378 Administrative Routines and Views
Table 127. Information returned by the SNAPDYN_SQL administrative view and the SNAP_GET_DYN_SQL_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
INT_ROWS_INSERTED BIGINT int_rows_inserted - Internal rows inserted
INT_ROWS_UPDATED BIGINT int_rows_updated - Internal rows updated
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
STMT_SORTS BIGINT stmt_sorts - Statement sorts
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool data logical
reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool data physical
reads
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer pool
temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer pool
temporary data physical reads
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool index logical
reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool index
physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer pool
temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer pool
temporary index physical reads
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool XDA Data
Logical Reads
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool XDA Data
Physical Reads
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer Pool
Temporary XDA Data Logical Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer Pool
Temporary XDA Data Physical Reads monitor
element
TOTAL_EXEC_TIME BIGINT total_exec_time - Elapsed statement execution
time
TOTAL_EXEC_TIME_MS BIGINT total_exec_time - Elapsed statement execution
time
TOTAL_USR_CPU_TIME BIGINT total_usr_cpu_time - Total user CPU for a
statement
TOTAL_USR_CPU_TIME_MS BIGINT total_usr_cpu_time - Total user CPU for a
statement
TOTAL_SYS_CPU_TIME BIGINT total_sys_cpu_time - Total system CPU for a
statement
TOTAL_SYS_CPU_TIME_MS BIGINT total_sys_cpu_time - Total system CPU for a
statement
Chapter 3. Supported routines and views 379
Table 127. Information returned by the SNAPDYN_SQL administrative view and the SNAP_GET_DYN_SQL_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
STMT_TEXT CLOB(2 M) stmt_text - SQL statement text
DBPARTITIONNUM SMALLINT The database partition from which the data
was retrieved for this row.
STATS_FABRICATE_TIME 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.
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.
SNAPFCM administrative view
Used with the SNAPDBM, SNAPDBM_MEMORY_POOL, SNAPFCM_PART and
SNAPSWITCHES administrative views, the SNAPFCM administrative view
provides the data equivalent to the GET SNAPSHOT FOR DBM command.
The schema is SYSIBMADM.
Refer to Table 128 on page 382 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPFCM administrative view and
EXECUTE privilege on the SNAP_GET_FCM table function.
Example
Retrieve information about the fast communication manager’s message buffers on
all database partitions.
SELECT BUFF_FREE, BUFF_FREE_BOTTOM, DBPARTITIONNUM
FROM SYSIBMADM.SNAPFCM ORDER BY DBPARTITIONNUM
The following is an example of output from this query.
BUFF_FREE BUFF_FREE_BOTTOM DBPARTITIONNUM
---------...---- -------------------- --------------
5120 5100 0
5120 5100 1
5120 5100 2
380 Administrative Routines and Views
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
specific database partition, aggregate of all database partitions or all database
partitions.
Used with the SNAP_GET_DBM_V95, SNAP_GET_DBM_MEMORY_POOL,
SNAP_GET_FCM_PART and SNAP_GET_SWITCHES table functions, the
SNAP_GET_FCM table function provides the data equivalent to the GET
SNAPSHOT FOR DBM command.
Refer to Table 128 on page 382 for a complete list of information that can be
returned.
Syntax
SNAP_GET_FCM ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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_FCM table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_FCM table function.
Example
Retrieve information about the fast communication manager’s message buffers on
database partition 1.
SELECT BUFF_FREE, BUFF_FREE_BOTTOM, DBPARTITIONNUM
FROM TABLE(SYSPROC.SNAP_GET_FCM( 1 )) AS T
The following is an example of output from this query.
BUFF_FREE BUFF_FREE_BOTTOM DBPARTITIONNUM
-------------------- -------------------- --------------
5120 5100 1
Chapter 3. Supported routines and views 381
Information returned
Table 128. Information returned by the SNAPFCM administrative view and the
SNAP_GET_FCM table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
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 The database partition from which
the data was retrieved for this row.
SNAPFCM_PART administrative view and
SNAP_GET_FCM_PART table function – Retrieve the
fcm_node logical data group snapshot information
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.
SNAPFCM_PART administrative view
Used with the SNAPDBM, SNAPDBM_MEMORY_POOL, SNAPFCM and
SNAPSWITCHES administrative views, the SNAPFCM_PART administrative view
provides the data equivalent to the GET SNAPSHOT FOR DBM command.
The schema is SYSIBMADM.
Refer to Table 129 on page 384 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPFCM_PART administrative view
and EXECUTE privilege on the SNAP_GET_FCM_PART table function.
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 DBPARTITIONNUM = 0
The following is an example of output from this query.
382 Administrative Routines and Views
CONNECTION_STATUS TOTAL_BUFFERS_SENT TOTAL_BUFFERS_RCVD
-------------------- -------------------- --------------------
INACTIVE 2 1
1 record(s) selected.
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
for a specific database partition, aggregate of all database partitions or all database
partitions.
Used with the SNAP_GET_DBM_V95, SNAP_GET_DBM_MEMORY_POOL,
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.
Refer to Table 129 on page 384 for a complete list of information that can be
returned.
Syntax
SNAP_GET_FCM_PART ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current partition, or -2 for an aggregate of
all active database partitions. If this input option is not used, data will be
returned from all active database partitions. An active database partition is a
partition where the database is available for connection and use by
applications.
If dbpartitionnum 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_FCM_PART table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_FCM_PART table function.
Example
Retrieve buffers sent and received information for the fast communication manager
for all database partitions.
SELECT FCM_DBPARTITIONNUM, TOTAL_BUFFERS_SENT, TOTAL_BUFFERS_RCVD,
DBPARTITIONNUM FROM TABLE(SNAP_GET_FCM_PART()) AS T
ORDER BY DBPARTITIONNUM
Chapter 3. Supported routines and views 383
The following is an example of output from this query.
FCM_DBPARTITIONNUM TOTAL_BUFFERS_SENT TOTAL_BUFFERS_RCVD DBPARTITIONNUM
------------------ -------------------- -------------------- --------------
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
Information returned
Table 129. Information returned by the SNAPFCM_PART administrative view and the
SNAP_GET_FCM_PART table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
CONNECTION_STATUS VARCHAR(10) connection_status - Connection
status. This interface returns a text
identifier based on the defines in
sqlmon.h and is one of:
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 The database partition from which
the data was retrieved for this row.
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).
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.
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.
384 Administrative Routines and Views
Used with the SNAPDB, SNAPDB_MEMORY_POOL, SNAPDETAILLOG and
SNAPSTORAGE_PATHS administrative views, the SNAPHADR administrative
view provides information equivalent to the GET SNAPSHOT FOR DATABASE
ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 130 on page 386 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPHADR administrative view and
EXECUTE privilege on the SNAP_GET_HADR table function.
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
The following is an example of output from this query.
DBNAME HADR_ROLE HADR_STATE HADR_SYNCMODE HADR_CONNECT_STATUS
-------- --------- -------------- ------------- -------------------
SAMPLE PRIMARY PEER SYNC CONNECTED
1 record(s) selected.
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
specific database on a specific database partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_DB_V95, SNAP_GET_DB_MEMORY_POOL,
SNAP_GET_DETAILLOG_V91 and SNAP_GET_STORAGE_PATHS table functions,
the SNAP_GET_HADR table function provides information equivalent to the GET
SNAPSHOT FOR ALL DATABASES CLP command.
Refer to Table 130 on page 386 for a complete list of information that can be
returned.
Syntax
SNAP_GET_HADR ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
Chapter 3. Supported routines and views 385
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_HADR table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_HADR table function.
Example
Retrieve the configuration and status information for HADR for all databases.
SELECT SUBSTR(DB_NAME, 1, 8) AS DBNAME, HADR_ROLE, HADR_STATE,
HADR_SYNCMODE, HADR_CONNECT_STATUS
FROM TABLE (SNAP_GET_HADR (CAST (NULL as VARCHAR(128)), 0)) as T
The following is an example of output from this query.
DBNAME HADR_ROLE HADR_STATE HADR_SYNCMODE HADR_CONNECT_STATUS
-------- --------- -------------- ------------- -------------------
SAMPLE PRIMARY PEER SYNC CONNECTED
TESTDB PRIMARY DISCONNECTED NEARSYNC DISCONNECTED
2 record(s) selected.
Information returned
Table 130. Information returned by the SNAPHADR administrative view and the
SNAP_GET_HADR table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
386 Administrative Routines and Views
Table 130. Information returned by the SNAPHADR administrative view and the
SNAP_GET_HADR table function (continued)
Description or corresponding
Column name Data type monitor element
HADR_ROLE VARCHAR(10) hadr_role - HADR role. This
interface returns a text identifier
based on the defines in sqlmon.h,
and is one of:
v PRIMARY
v STANDARD
v STANDBY
HADR_STATE VARCHAR(14) hadr_state - HADR state. This
interface returns a text identifier
based on the defines in sqlmon.h,
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
interface returns a text identifier
based on the defines in sqlmon.h,
and is one of:
v ASYNC
v NEARSYNC
v SYNC
HADR_CONNECT_STATUS VARCHAR(12) 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
Chapter 3. Supported routines and views 387
Table 130. Information returned by the SNAPHADR administrative view and the
SNAP_GET_HADR table function (continued)
Description or corresponding
Column name Data type monitor element
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 The database partition from which
the data was retrieved for this row.
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.
SNAPLOCK administrative view
This administrative view allows you to retrieve lock logical data group snapshot
information for the currently connected database.
Used with the SNAPLOCKWAIT administrative view, the SNAPLOCK
administrative view provides information equivalent to the GET SNAPSHOT FOR
LOCKS ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 131 on page 390 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPLOCK administrative view and
EXECUTE privilege on the SNAP_GET_LOCK table function.
Example
Retrieve lock information for the database partition 0 of the currently connected
database.
SELECT AGENT_ID, LOCK_OBJECT_TYPE, LOCK_MODE, LOCK_STATUS
FROM SYSIBMADM.SNAPLOCK WHERE DBPARTITIONNUM = 0
388 Administrative Routines and Views
The following is an example of output from this query.
AGENT_ID LOCK_OBJECT_TYPE LOCK_MODE LOCK_STATUS
-------------------- ---------------- --------- -----------
7 TABLE IX GRNT
1 record(s) selected.
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
specific database on a specific database partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_LOCKWAIT table function, the SNAP_GET_LOCK table
function provides information equivalent to the GET SNAPSHOT FOR LOCKS ON
database-alias CLP command.
Refer to Table 131 on page 390 for a complete list of information that can be
returned.
Syntax
SNAP_GET_LOCK ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 a null
value or empty string to take the snapshot from the currently connected
database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_LOCK table function takes a snapshot for the currently connected
database and database partition number.
Chapter 3. Supported routines and views 389
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_LOCK table function.
Example
Retrieve lock information for the current database partition of the currently
connected database.
SELECT AGENT_ID, LOCK_OBJECT_TYPE, LOCK_MODE, LOCK_STATUS
FROM TABLE(SNAP_GET_LOCK(’’,-1)) as T
The following is an example of output from this query.
AGENT_ID LOCK_OBJECT_TYPE LOCK_MODE LOCK_STATUS
--------...--- ------------------ ---------- -----------
680 INTERNALV_LOCK S GRNT
680 INTERNALP_LOCK S GRNT
2 record(s) selected.
Information returned
Table 131. Information returned by the SNAPLOCK administrative view and the
SNAP_GET_LOCK table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
TAB_FILE_ID BIGINT table_file_id - Table file
identification
390 Administrative Routines and Views
Table 131. Information returned by the SNAPLOCK administrative view and the
SNAP_GET_LOCK table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_OBJECT_TYPE VARCHAR(18) lock_object_type - Lock object type
waited on. This interface returns a
text identifier based on the defines
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
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
Chapter 3. Supported routines and views 391
Table 131. Information returned by the SNAPLOCK administrative view and the
SNAP_GET_LOCK table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_STATUS VARCHAR(10) lock_status - Lock status. This
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v CONV
v GRNT
LOCK_ESCALATION SMALLINT lock_escalation - Lock escalation
TABNAME VARCHAR(128) table_name - Table name
TABSCHEMA VARCHAR(128) table_schema - Table schema name
TBSP_NAME VARCHAR(128) tablespace_name - Table space
name
LOCK_ATTRIBUTES VARCHAR(128) lock_attributes - Lock attributes.
This interface returns a text
identifier based on the defines in
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
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
392 Administrative Routines and Views
Table 131. Information returned by the SNAPLOCK administrative view and the
SNAP_GET_LOCK table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_HOLD_COUNT BIGINT lock_hold_count - Lock hold count
LOCK_NAME VARCHAR(32) lock_name - Lock name
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 The database partition from which
the data was retrieved for this row.
SNAPLOCKWAIT administrative view and
SNAP_GET_LOCKWAIT table function – Retrieve lockwait
logical data group snapshot information
The SNAPLOCKWAIT administrative view and the SNAP_GET_LOCKWAIT table
function return snapshot information about lock waits, in particular, the lockwait
logical data group.
SNAPLOCKWAIT administrative view
This administrative view allows you to retrieve lockwait logical data group
snapshot information for the currently connected database.
Used with the SNAPLOCK administrative view, the SNAPLOCKWAIT
administrative view provides information equivalent to the GET SNAPSHOT FOR
LOCKS ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 132 on page 395 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPLOCKWAIT administrative view
and EXECUTE privilege on the SNAP_GET_LOCKWAIT table function.
Example
Retrieve lock wait information on database partition 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
The following is an example of output from this query.
Chapter 3. Supported routines and views 393
AGENT_ID LOCK_MODE LOCK_OBJECT_TYPE ...
--------...- --------- ---------------- ...
7 IX TABLE ...
1 record(s) selected.
Output from this query (continued).
... 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
for a specific database on a specific database partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_LOCK table function, the SNAP_GET_LOCKWAIT table
function provides information equivalent to the GET SNAPSHOT FOR LOCKS ON
database-alias CLP command.
Refer to Table 132 on page 395 for a complete list of information that can be
returned.
Syntax
SNAP_GET_LOCKWAIT ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 a null
value or empty string to take the snapshot from the currently connected
database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_LOCKWAIT table function takes a snapshot for the currently
connected database and database partition number.
394 Administrative Routines and Views
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_LOCKWAIT table function.
Example
Retrieve lock wait information on current database partition for the currently
connected database.
SELECT AGENT_ID, LOCK_MODE, LOCK_OBJECT_TYPE, AGENT_ID_HOLDING_LK,
LOCK_MODE_REQUESTED FROM TABLE(SNAP_GET_LOCKWAIT(’’,-1)) AS T
The following is an example of output from this query.
AGENT_ID LOCK_MODE LOCK_OBJECT_TYPE ...
--------...-- ---------- ------------------ ...
12 X ROW_LOCK ...
1 record(s) selected.
Output from this query (continued).
... AGENT_ID_HOLDING_LK LOCK_MODE_REQUESTED
... -------------------- -------------------
... 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.
Information returned
Table 132. Information returned by the SNAPLOCKWAIT administrative view and the
SNAP_GET_LOCKWAIT table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
SUBSECTION_NUMBER BIGINT ss_number - Subsection number
Chapter 3. Supported routines and views 395
Table 132. Information returned by the SNAPLOCKWAIT administrative view and the
SNAP_GET_LOCKWAIT table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_MODE VARCHAR(10) lock_mode - Lock mode. This
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
LOCK_OBJECT_TYPE VARCHAR(18) lock_object_type - Lock object type
waited on. This interface returns a
text identifier based on the defines
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
396 Administrative Routines and Views
Table 132. Information returned by the SNAPLOCKWAIT administrative view and the
SNAP_GET_LOCKWAIT table function (continued)
Description or corresponding
Column name Data type monitor element
AGENT_ID_HOLDING_LK BIGINT agent_id_holding_lock - Agent ID
holding lock
LOCK_WAIT_START_TIME TIMESTAMP lock_wait_start_time - Lock wait
start timestamp
LOCK_MODE_REQUESTED VARCHAR(10) lock_mode_requested - Lock mode
requested. This interface returns a
text identifier based on the defines
in sqlmon.h and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
LOCK_ESCALATION SMALLINT lock_escalation - Lock escalation
TABNAME VARCHAR(128) table_name - Table name
TABSCHEMA VARCHAR(128) table_schema - Table schema name
TBSP_NAME VARCHAR(128) tablespace_name - Table space
name
APPL_ID_HOLDING_LK VARCHAR(128) appl_id_holding_lk - Application
ID holding lock
LOCK_ATTRIBUTES VARCHAR(128) lock_attributes - Lock attributes.
This interface returns a text
identifier based on the defines in
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
Chapter 3. Supported routines and views 397
Table 132. Information returned by the SNAPLOCKWAIT administrative view and the
SNAP_GET_LOCKWAIT table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_CURRENT_MODE VARCHAR(10) lock_current_mode - Original lock
mode before conversion. This
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
LOCK_NAME VARCHAR(32) lock_name - Lock name
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 The database partition from which
the data was retrieved for this row.
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.
SNAPSTMT administrative view
This administrative view allows you to retrieve statement snapshot information for
the currently connected database.
Used with the SNAPAGENT, SNAPAGENT_MEMORY_POOL, SNAPAPPL,
SNAPAPPL_INFO and SNAPSUBSECTION administrative views, the SNAPSTMT
administrative view provides information equivalent to the GET SNAPSHOT FOR
APPLICATIONS on database-alias CLP command, but retrieves data from all
database partitions.
The schema is SYSIBMADM.
Refer to Table 133 on page 400 for a complete list of information that can be
returned.
398 Administrative Routines and Views
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPSTMT administrative view and
EXECUTE privilege on the SNAP_GET_STMT table function.
Example
Retrieve rows read, written and operation performed for statements executed on
the currently connected single-partition database.
SELECT SUBSTR(STMT_TEXT,1,30) AS STMT_TEXT, ROWS_READ, ROWS_WRITTEN,
STMT_OPERATION FROM SYSIBMADM.SNAPSTMT
The following is an example of output from this query.
STMT_TEXT ROWS_READ ROWS_WRITTEN STMT_OPERATION
---------...- ---------...- ------------...- --------------------
- 0 0 FETCH
- 0 0 STATIC_COMMIT
2 record(s) selected.
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
specific database on a specific database partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_AGENT, SNAP_GET_AGENT_MEMORY_POOL,
SNAP_GET_APPL_V95, SNAP_GET_APPL_INFO_V95 and
SNAP_GET_SUBSECTION table functions, the SNAP_GET_STMT table function
provides information equivalent to the GET SNAPSHOT FOR ALL
APPLICATIONS CLP command, but retrieves data from all database partitions.
Refer to Table 133 on page 400 for a complete list of information that can be
returned.
Syntax
SNAP_GET_STMT ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
Chapter 3. Supported routines and views 399
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
database is available for connection and use by applications.
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_STMT table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_STMT table function.
Example
Retrieve rows read, written and operation performed for statements executed on
current database partition 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
The following is an example of output from this query.
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 ...
...
5 record(s) selected. ...
Output from this query (continued).
... ROWS_WRITTEN STMT_OPERATION
... ------------...- --------------------
... 0 EXECUTE_IMMEDIATE
... 0 FETCH
... 0 NONE
... 0 NONE
... 1 EXECUTE_IMMEDIATE
...
Information returned
Table 133. Information returned by the SNAPSTMT administrative view and the
SNAP_GET_STMT table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
400 Administrative Routines and Views
Table 133. Information returned by the SNAPSTMT administrative view and the
SNAP_GET_STMT table function (continued)
Description or corresponding
Column name Data type monitor element
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
NUM_AGENTS BIGINT num_agents - Number of agents
working on a statement
AGENTS_TOP BIGINT agents_top - Number of agents
created
STMT_TYPE VARCHAR(20) stmt_type - Statement type. This
interface returns a text identifier
based on defines in sqlmon.h and
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
returns a text identifier based on
defines in sqlmon.h and is one of:
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 section_number - Section number
Chapter 3. Supported routines and views 401
Table 133. Information returned by the SNAPSTMT administrative view and the
SNAP_GET_STMT table function (continued)
Description or corresponding
Column name Data type monitor element
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 stmt_sorts - Statement sorts
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
INT_ROWS_DELETED BIGINT int_rows_deleted - Internal rows
deleted
INT_ROWS_UPDATED BIGINT int_rows_updated - Internal rows
updated
INT_ROWS_INSERTED BIGINT int_rows_inserted - Internal rows
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
STMT_USR_CPU_TIME_MS BIGINT stmt_usr_cpu_time - User CPU
time used by statement
STMT_SYS_CPU_TIME_S BIGINT stmt_sys_cpu_time - System CPU
time used by statement
STMT_SYS_CPU_TIME_MS BIGINT stmt_sys_cpu_time - System CPU
time used by statement
STMT_ELAPSED_TIME_S BIGINT stmt_elapsed_time - Most recent
statement elapsed time
STMT_ELAPSED_TIME_MS BIGINT stmt_elapsed_time - Most recent
statement elapsed time
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) package_name - Package name
STMT_TEXT CLOB(16 M) stmt_text - SQL statement text
CONSISTENCY_TOKEN VARCHAR(128) consistency_token - Package
consistency token
PACKAGE_VERSION_ID VARCHAR(128) package_version_id - Package
version
402 Administrative Routines and Views
Table 133. Information returned by the SNAPSTMT administrative view and the
SNAP_GET_STMT table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool
XDA Data Logical Reads monitor
element
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool
XDA Data Physical Reads monitor
element
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer
Pool Temporary XDA Data Physical
Reads monitor element
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPSTORAGE_PATHS administrative view and
SNAP_GET_STORAGE_PATHS table function - Retrieve
automatic storage path information
The SNAPSTORAGE_PATHS administrative view and the
SNAP_GET_STORAGE_PATHS 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.
SNAPSTORAGE_PATHS administrative view
This administrative view allows you to retrieve automatic storage path information
for the currently connected database.
Chapter 3. Supported routines and views 403
Used with the SNAPDB, SNAPDETAILLOG, SNAPHADR and
SNAPDB_MEMORY_POOL administrative views, the SNAPSTORAGE_PATHS
administrative view provides information equivalent to the GET SNAPSHOT FOR
DATABASE ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 134 on page 405 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPSTORAGE_PATHS administrative
view and EXECUTE privilege on the SNAP_GET_STORAGE_PATHS table
function.
Example
Retrieve the storage path for the currently connected single-partition 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
The following is an example of output from this query.
DB_NAME DB_STORAGE_PATH HOSTNAME
-------- --------------- ----------
STOPATH d: JESSICAE
1 record(s) selected.
SNAP_GET_STORAGE_PATHS table function
The SNAP_GET_STORAGE_PATHS table function returns the same information as
the SNAPSTORAGE_PATHS 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 with the SNAP_GET_DB_V95, SNAP_GET_DETAILLOG_V91,
SNAP_GET_HADR and SNAP_GET_DB_MEMORY_POOL table functions, the
SNAP_GET_STORAGE_PATHS table function provides information equivalent to
the GET SNAPSHOT FOR ALL DATABASES CLP command.
Refer to Table 134 on page 405 for a complete list of information that can be
returned.
Syntax
SNAP_GET_STORAGE_PATHS ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
404 Administrative Routines and Views
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_STORAGE_PATHS table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_STORAGE_PATHS table function.
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(CAST (NULL AS VARCHAR(128)), -1)) AS T
The following is an example of output from this query.
DB_NAME DB_STORAGE_PATH
-------- -------------------...
STOPATH /home/jessicae/sdb
MYDB /home/jessicae/mdb
2 record(s) selected
Information returned
The BUFFERPOOL monitor switch must be turned on in order for the file system
information to be returned.
Table 134. Information returned by the SNAPSTORAGE_PATHS administrative view and the
SNAP_GET_STORAGE_PATHS table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
DB_STORAGE_PATH VARCHAR(256) db_storage_path - Automatic
storage path
Chapter 3. Supported routines and views 405
Table 134. Information returned by the SNAPSTORAGE_PATHS administrative view and the
SNAP_GET_STORAGE_PATHS table function (continued)
Description or corresponding
Column name Data type monitor element
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
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_sz - Automatic
storage path free space
SNAPSUBSECTION administrative view and
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.
SNAPSUBSECTION administrative view
This administrative view allows you to retrieve subsection logical monitor group
snapshot information for the currently connected database.
Used with the SNAPAGENT, SNAPAGENT_MEMORY_POOL, SNAPAPPL,
SNAPAPPL_INFO and SNAPSTMT administrative views, the SNAPSUBSECTION
administrative view provides information equivalent to the GET SNAPSHOT FOR
APPLICATIONS on database-alias CLP command, but retrieves data from all
database partitions.
The schema is SYSIBMADM.
Refer to Table 135 on page 408 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPSUBSECTION administrative view
and EXECUTE privilege on the SNAP_GET_SUBSECTION table function.
Example
Get status for subsections executing on all database partitions.
SELECT DB_NAME, STMT_TEXT, SS_STATUS, DBPARTITIONNUM
FROM SYSIBMADM.SNAPSUBSECTION
ORDER BY DB_NAME, SS_STATUS, DBPARTITIONNUM
The following is an example of output from this query.
406 Administrative Routines and Views
DB_NAME STMT_TEXT SS_STATUS DBPARTITIONNUM
-------...- ----------------------...- ---------...- --------------
SAMPLE select * from EMPLOYEE EXEC 0
SAMPLE select * from EMPLOYEE EXEC 1
SNAP_GET_SUBSECTION table function
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 partition, aggregate of all
database partitions or all database partitions.
Refer to Table 135 on page 408 for a complete list of information that can be
returned.
Used with the SNAP_GET_AGENT, SNAP_GET_AGENT_MEMORY_POOL,
SNAP_GET_APPL_V95, SNAP_GET_APPL_INFO_V95 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 partitions.
Syntax
SNAP_GET_SUBSECTION ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_SUBSECTION table function takes a snapshot for the currently
connected database and database partition number.
Chapter 3. Supported routines and views 407
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_SUBSECTION table function.
Example
Get status for subsections executing on all database partitions.
SELECT DB_NAME, STMT_TEXT, SS_STATUS, DBPARTITIONNUM
FROM TABLE(SYSPROC.SNAP_GET_SUBSECTION( ’’, 0 )) as T
ORDER BY DB_NAME, SS_STATUS, DBPARTITIONNUM
The following is an example of output from this query.
DB_NAME STMT_TEXT SS_STATUS DBPARTITIONNUM
-------...- ----------------------...- ---------...- --------------
SAMPLE select * from EMPLOYEE EXEC 0
SAMPLE select * from EMPLOYEE EXEC 1
Information returned
Table 135. Information returned by the SNAPSUBSECTION administrative view and the
SNAP_GET_SUBSECTION table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
STMT_TEXT CLOB(16 M) stmt_text - SQL statement text
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 - Current
number 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_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
SS_USR_CPU_TIME_S BIGINT ss_usr_cpu_time - User CPU time
used by subsection
SS_USR_CPU_TIME_MS BIGINT ss_usr_cpu_time - User CPU time
used by subsection
SS_SYS_CPU_TIME_S BIGINT ss_sys_cpu_time - System CPU
time used by subsection
SS_SYS_CPU_TIME_MS BIGINT ss_sys_cpu_time - System CPU
time used by subsection
408 Administrative Routines and Views
Table 135. Information returned by the SNAPSUBSECTION administrative view and the
SNAP_GET_SUBSECTION table function (continued)
Description or corresponding
Column name Data type monitor element
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 The database partition from which
the data was retrieved for this row.
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.
SNAPSWITCHES administrative view
This view provides the data equivalent to the GET DBM MONITOR SWITCHES
CLP command.
The schema is SYSIBMADM.
Refer to Table 136 on page 411 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPSWITCHES administrative view
and EXECUTE privilege on the SNAP_GET_SWITCHES table function.
Example
Retrieve DBM monitor switches state information for all database partitions.
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
Chapter 3. Supported routines and views 409
The following is an example of output from this query.
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.
Output from this query (continued).
... LOCK_SW_STATE SORT_SW_STATE TIMESTAMP_SW_STATE DBPARTITIONNUM
... ------------- ------------- ------------------ --------------
... 1 0 1 0
... 1 0 1 1
... 1 0 1 2
SNAP_GET_SWITCHES table function
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 partition, aggregate of all database partitions or all database
partitions.
This table function provides the data equivalent to the GET DBM MONITOR
SWITCHES CLP command.
Refer to Table 136 on page 411 for a complete list of information that can be
returned.
Syntax
SNAP_GET_SWITCHES ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_SWITCHES table function.
410 Administrative Routines and Views
Examples
Retrieve DBM monitor switches state information for the current database
partition.
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
The following is an example of output from this query.
UOW_SW_STATE STATEMENT_SW_STATE TABLE_SW_STATE...
------------ ------------------ --------------...
1 1 1...
...
1 record(s) selected. ...
Output from this query (continued).
... BUFFPOOL_SW_STATE LOCK_SW_STATE SORT_SW_STATE TIMESTAMP_SW_STATE
... ----------------- ------------- ------------- ------------------
... 1 1 0 1
Information returned
Table 136. Information returned by the SNAPSWITCHES administrative view and the
SNAP_GET_SWITCHES table function
Column name Data type Description
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
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
recording switch (0 or 1).
STATEMENT_SW_TIME TIMESTAMP If the SQL statement monitor
recording switch is on, the date and
time that this switch was turned
on.
TABLE_SW_STATE SMALLINT State of the table activity monitor
recording switch (0 or 1).
TABLE_SW_TIME TIMESTAMP If the table activity monitor
recording switch is on, the date and
time that this switch was 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
recording switch is on, the date and
time that this switch was turned
on.
LOCK_SW_STATE SMALLINT State of the lock monitor recording
switch (0 or 1).
Chapter 3. Supported routines and views 411
Table 136. Information returned by the SNAPSWITCHES administrative view and the
SNAP_GET_SWITCHES table function (continued)
Column name Data type Description
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
recording switch (0 or 1).
SORT_SW_TIME TIMESTAMP If the sorting monitor recording
switch is on, the date and time that
this switch was turned on.
TIMESTAMP_SW_STATE SMALLINT State of the timestamp monitor
recording switch (0 or 1)
TIMESTAMP_SW_TIME TIMESTAMP If the timestamp monitor recording
switch is on, the date and time that
this switch was turned on.
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPTAB administrative view and SNAP_GET_TAB_V91 table
function - Retrieve table logical data group snapshot
information
The SNAPTAB administrative view and the SNAP_GET_TAB_V91 table function
return snapshot information from the table logical data group.
SNAPTAB administrative view
This administrative view allows you to retrieve table logical data group snapshot
information for the currently connected database.
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.
The schema is SYSIBMADM.
Refer to Table 137 on page 414 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPTAB administrative view and
EXECUTE privilege on the SNAP_GET_TAB_V91 table function.
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
The following is an example of output from this query.
412 Administrative Routines and Views
TABSCHEMA TABNAME TAB_TYPE DBPARTITIONNUM
--------- --------------- ------------ --------------
SYSTOOLS HMON_ATM_INFO USER_TABLE 0
1 record selected.
SNAP_GET_TAB_V91 table function
The SNAP_GET_TAB_V91 table function returns the same information as the
SNAPTAB 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_TAB_REORG table function, the
SNAP_GET_TAB_V91 table function returns equivalent information to the GET
SNAPSHOT FOR TABLES ON database-alias CLP command.
Refer to Table 137 on page 414 for a complete list of information that can be
returned.
Syntax
SNAP_GET_TAB_V91 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_TAB_V91 table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_TAB_V91 table function.
Chapter 3. Supported routines and views 413
Example
Retrieve a list of active tables as an aggregate view for the currently connected
database.
SELECT SUBSTR(TABSCHEMA,1,8) AS TABSCHEMA, SUBSTR(TABNAME,1,15) AS TABNAME,
TAB_TYPE, DBPARTITIONNUM FROM TABLE(SNAP_GET_TAB(’’,-2)) AS T
The following is an example of output from this query.
TABSCHEMA TABNAME TAB_TYPE DBPARTITIONNUM
--------- --------------- ------------- --------------
SYSTOOLS HMON_ATM_INFO USER_TABLE -
JESSICAE EMPLOYEE USER_TABLE -
Information returned
Table 137. Information returned by the SNAPTAB administrative view and the
SNAP_GET_TAB_V91 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TABSCHEMA VARCHAR(128) table_schema - Table schema name
TABNAME VARCHAR(128) table_name - Table name
TAB_FILE_ID BIGINT table_file_id - Table file
identification
TAB_TYPE VARCHAR(14) table_type - Table type. This
interface returns a text identifier
based on defines in sqlmon.h, and
is one of:
v USER_TABLE
v DROPPED_TABLE
v TEMP_TABLE
v CATALOG_TABLE
v REORG_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
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
OVERFLOW_ACCESSES BIGINT overflow_accesses - Accesses to
overflowed records
PAGE_REORGS BIGINT page_reorgs - Page reorganizations
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
414 Administrative Routines and Views
Table 137. Information returned by the SNAPTAB administrative view and the
SNAP_GET_TAB_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
TBSP_ID BIGINT tablespace_id - Table space
identification
DATA_PARTITION_ID INTEGER data_partition_id - Data Partition
identifier. For a non-partitioned
table, this element will be NULL.
SNAPTAB_REORG administrative view and
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.
SNAPTAB_REORG administrative view
This administrative view allows you to retrieve table reorganization snapshot
information for the currently connected database.
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.
The schema is SYSIBMADM.
Refer to Table 138 on page 417 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPTAB_REORG administrative view
and EXECUTE privilege on the SNAP_GET_TAB_REORG table function.
Example
Select details on reorganization operations for all database partitions on the
currently connected database.
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
The following is an example of output from this query.
TAB_NAME TAB_SCHEMA REORG_PHASE ...
--------...- ----------...- ---------------- ...
EMPLOYEE DBUSER REPLACE ...
EMPLOYEE DBUSER REPLACE ...
EMPLOYEE DBUSER REPLACE ...
...
3 record(s) selected.
Chapter 3. Supported routines and views 415
Output from this query (continued).
... REORG_TYPE REORG_STATUS REORG_COMPLETION DBPARTITIONNUM
... -------------------- ------------ ---------------- --------------
... RECLAIM+OFFLINE+ALLO COMPLETED SUCCESS 0
... RECLAIM+OFFLINE+ALLO COMPLETED SUCCESS 1
... RECLAIM+OFFLINE+ALLO COMPLETED SUCCESS 2
SNAP_GET_TAB_REORG table function
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 partition, aggregate of all database
partitions or all database partitions.
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
database-alias CLP command.
Refer to Table 138 on page 417 for a complete list of information that can be
returned.
Syntax
SNAP_GET_TAB_REORG ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_TAB_REORG table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_TAB_REORG table function.
416 Administrative Routines and Views
Example
Select details on reorganization operations for database partition 1 on the currently
connected database.
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 TABLE( SNAP_GET_TAB_REORG(’’, 1)) AS T
The following is an example of output from this query.
TAB_NAME TAB_SCHEMA REORG_PHASE REORG_TYPE ...
--------...- ----------...- -----------...- -------------------- ...
EMPLOYEE DBUSER REPLACE RECLAIM+OFFLINE+ALLO ...
...
1 record(s) selected. ...
Output from this query (continued).
... REORG_STATUS REORG_COMPLETION DBPARTITIONNUM
... ------------ ---------------- --------------
... COMPLETED SUCCESS 1
...
Information returned
Table 138. Information returned by the SNAPTAB_REORG administrative view and the
SNAP_GET_TAB_REORG table function
Description or corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was
taken.
TABNAME VARCHAR table_name - Table name
(128)
TABSCHEMA VARCHAR table_schema - Table schema name
(128)
PAGE_REORGS BIGINT page_reorgs - Page reorganizations
REORG_PHASE VARCHAR reorg_phase - Table reorganize phase. This
(16) 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
or SORT+DICT_SAMPLE.
REORG_MAX_PHASE INTEGER reorg_max_phase - Maximum table
reorganize phase
BIGINT reorg_current_counter - Table reorganize
REORG_CURRENT_ progress
COUNTER
REORG_MAX_COUNTER BIGINT reorg_max_counter - Total amount of table
reorganization
Chapter 3. Supported routines and views 417
Table 138. Information returned by the SNAPTAB_REORG administrative view and the
SNAP_GET_TAB_REORG table function (continued)
Description or corresponding monitor
Column name Data type element
REORG_TYPE VARCHAR reorg_type - Table reorganize attributes. This
(128) interface returns a text identifier using a
combination of the following identifiers
separated by ’+’:
Either:
v RECLAIM
v RECLUSTER
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
Example 2: If a REORG TABLE
TEST.EMPLOYEE INDEX EMPIDX
INDEXSCAN was run, then the following
would be displayed:
RECLUSTER+OFFLINE+ALLOW_READ+INDEXSCAN
+DATAONLY+KEEPDICTIONARY
418 Administrative Routines and Views
Table 138. Information returned by the SNAPTAB_REORG administrative view and the
SNAP_GET_TAB_REORG table function (continued)
Description or corresponding monitor
Column name Data type element
REORG_STATUS VARCHAR reorg_status - Table reorganize status. This
(10) interface returns a text identifier based on
defines in sqlmon.h and is one of:
v COMPLETED
v PAUSED
v STARTED
v STOPPED
v TRUNCATE
REORG_COMPLETION VARCHAR reorg_completion - Table reorganization
(10) 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 The database partition from which the data
was retrieved for this row.
DATA_PARTITION_ID INTEGER data_partition_id - Data Partition identifier.
For a non-partitioned table, this element will
be NULL.
BIGINT reorg_rows_compressed - Rows compressed
REORG_
ROWSCOMPRESSED
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
SNAPTBSP administrative view and SNAP_GET_TBSP_V91
table function - Retrieve table space logical data group
snapshot information
The SNAPTBSP administrative view and the SNAP_GET_TBSP_V91 table function
return snapshot information from the table space logical data group.
SNAPTBSP administrative view
This administrative view allows you to retrieve table space logical data group
snapshot information for the currently connected database.
Chapter 3. Supported routines and views 419
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.
The schema is SYSIBMADM.
Refer to Table 139 on page 421 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPTBSP administrative view and
EXECUTE privilege on the SNAP_GET_TBSP_V91 table function.
Example
Retrieve a list of table spaces on the catalog database partition 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
The following is an example of output from this query.
TBSP_NAME TBSP_ID TBSP_TYPE TBSP_CONTENT_TYPE
---------- -------...- ---------- -----------------
TEMPSPACE1 1 SMS SYSTEMP
USERSPACE1 2 DMS LONG
2 record(s) selected.
SNAP_GET_TBSP_V91 table function
The SNAP_GET_TBSP_V91 table function returns the same information as the
SNAPTBSP 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_PART_V91,
SNAP_GET_TBSP_QUIESCER, SNAP_GET_TBSP_RANGE,
SNAP_GET_CONTAINER_V91 table functions, the SNAP_GET_TBSP_V91 table
function returns information equivalent to the GET SNAPSHOT FOR
TABLESPACES ON database-alias CLP command.
Refer to Table 139 on page 421 for a complete list of information that can be
returned.
Syntax
SNAP_GET_TBSP_V91 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
420 Administrative Routines and Views
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_TBSP_V91 table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_TBSP_V91 table function.
Example
Retrieve a list of table spaces for all database partitions for the currently connected
database.
SELECT SUBSTR(TBSP_NAME,1,10) AS TBSP_NAME, TBSP_ID, TBSP_TYPE,
TBSP_CONTENT_TYPE, DBPARTITIONNUM FROM TABLE(SNAP_GET_TBSP_V91(’’)) AS T
The following is an example of output from this query.
TBSP_NAME TBSP_ID TBSP_TYPE TBSP_CONTENT_TYPE DBPARTITIONNUM
-----–---- -------...- ---------- ----------------- --------------
TEMPSPACE1 1 SMS SYSTEMP 1
USERSPACE1 2 DMS LONG 1
SYSCATSPAC 0 DMS ANY 0
TEMPSPACE1 1 SMS SYSTEMP 0
USERSPACE1 2 DMS LONG 0
SYSTOOLSPA 3 DMS LONG 0
TEMPSPACE1 1 SMS SYSTEMP 2
USERSPACE1 2 DMS LONG 2
8 record(s) selected.
Information returned
Table 139. Information returned by the SNAPTBSP administrative view and the
SNAP_GET_TBSP_V91 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
Chapter 3. Supported routines and views 421
Table 139. Information returned by the SNAPTBSP administrative view and the
SNAP_GET_TBSP_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
TBSP_NAME VARCHAR(128) tablespace_name - Table space
name
TBSP_ID BIGINT tablespace_id - Table space
identification
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 contents 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
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
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer
pool asynchronous data reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_ASYNC_DATA_WRITES BIGINT pool_async_data_writes - Buffer
pool asynchronous data writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
422 Administrative Routines and Views
Table 139. Information returned by the SNAPTBSP administrative view and the
SNAP_GET_TBSP_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
POOL_ASYNC_INDEX_READS BIGINT pool_async_index_reads - Buffer
pool asynchronous index reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index writes
POOL_ASYNC_INDEX_WRITES BIGINT pool_async_index_writes - Buffer
pool asynchronous index writes
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool
XDA Data Logical Reads
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool
XDA Data Physical Reads
POOL_XDA_WRITES BIGINT pool_xda_writes - Buffer Pool XDA
Data Writes
POOL_ASYNC_XDA_READS BIGINT pool_async_xda_reads - Buffer Pool
Asynchronous XDA Data Reads
POOL_ASYNC_XDA_WRITES BIGINT pool_async_xda_writes - Buffer
Pool Asynchronous XDA Data
Writes
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer
Pool Temporary XDA Data Physical
Reads monitor element
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
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
BIGINT pool_async_data_read_reqs - Buffer
POOL_ASYNC_DATA_ pool asynchronous read requests
READ_REQS
BIGINT pool_async_index_read_reqs -
POOL_ASYNC_INDEX_ Buffer pool asynchronous index
READ_REQS read requests
BIGINT pool_async_xda_read_reqs - Buffer
POOL_ASYNC_XDA_ Pool Asynchronous XDA Read
READ_REQS Requests
Chapter 3. Supported routines and views 423
Table 139. Information returned by the SNAPTBSP administrative view and the
SNAP_GET_TBSP_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_NO_VICTIM_BUFFER BIGINT pool_no_victim_buffer - Buffer pool
no victim buffers
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
FILES_CLOSED BIGINT files_closed - Database files closed
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
TBSP_REBALANCER_MODE VARCHAR(10) tablespace_rebalancer_mode -
Rebalancer mode. This interface
returns a text identifier based on
defines in sqlmon.h, and is one of:
v NO_REBAL
v FWD_REBAL
v REV_REBAL
TBSP_USING_AUTO_STORAGE SMALLINT tablespace_using_auto_storage -
Using automatic storage
TBSP_AUTO_RESIZE_ENABLED SMALLINT tablespace_auto_resize_enabled -
Auto-resize enabled
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPTBSP_PART administrative view and
SNAP_GET_TBSP_PART_V91 table function - Retrieve
tablespace_nodeinfo logical data group snapshot information
The SNAPTBSP_PART administrative view and the SNAP_GET_TBSP_PART_V91
table function return snapshot information from the tablespace_nodeinfo logical
data group.
SNAPTBSP_PART administrative view
This administrative view allows you to retrieve tablespace_nodeinfo logical data
group snapshot information for the currently connected database.
Used in conjunction with the SNAPTBSP, SNAPTBSP_QUIESCER,
SNAPTBSP_RANGE, SNAPCONTAINER administrative views, the
424 Administrative Routines and Views
SNAPTBSP_PART administrative view returns information equivalent to the GET
SNAPSHOT FOR TABLESPACES ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 140 on page 426 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPTBSP_PART administrative view
and EXECUTE privilege on the SNAP_GET_TBSP_PART_V91 table function.
Example
Retrieve a list of table spaces and their state for all database partitions of the
currently connected database.
SELECT SUBSTR(TBSP_NAME,1,30) AS TBSP_NAME, TBSP_ID,
SUBSTR(TBSP_STATE,1,30) AS TBSP_STATE, DBPARTITIONNUM
FROM SYSIBMADM.SNAPTBSP_PART
The following is an example of output from this query.
TBSP_NAME TBSP_ID TBSP_STATE DBPARTITIONNUM
-----------...- -------...- ----------...- --------------
SYSCATSPACE 0 NORMAL 0
TEMPSPACE1 1 NORMAL 0
USERSPACE1 2 NORMAL 0
TEMPSPACE1 1 NORMAL 1
USERSPACE1 2 NORMAL 1
5 record(s) selected.
SNAP_GET_TBSP_PART_V91 table function
The SNAP_GET_TBSP_PART_V91 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_V91,
SNAP_GET_TBSP_QUIESCER, SNAP_GET_TBSP_RANGE,
SNAP_GET_CONTAINER_V91 table functions, the SNAP_GET_TBSP_PART_V91
table function returns information equivalent to the GET SNAPSHOT FOR
TABLESPACES ON database-alias CLP command.
Refer to Table 140 on page 426 for a complete list of information that can be
returned.
Syntax
SNAP_GET_TBSP_PART_V91 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Chapter 3. Supported routines and views 425
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_TBSP_PART_V91 table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_TBSP_PART_V91 table function.
Example
Retrieve a list of table spaces and their state for the connected database partition of
the connected database.
SELECT SUBSTR(TBSP_NAME,1,30) AS TBSP_NAME, TBSP_ID,
SUBSTR(TBSP_STATE,1,30) AS TBSP_STATE
FROM TABLE(SNAP_GET_TBSP_PART_V91(CAST(NULL AS VARCHAR(128)),-1)) AS T
The following is an example of output from this query.
TBSP_NAME TBSP_ID TBSP_STATE
------------------------------ -------------------- ------------...-
SYSCATSPACE 0 NORMAL
TEMPSPACE1 1 NORMAL
USERSPACE1 2 NORMAL
SYSTOOLSPACE 3 NORMAL
SYSTOOLSTMPSPACE 4 NORMAL
5 record(s) selected.
Information returned
Table 140. Information returned by the SNAPTBSP_PART administrative view and the
SNAP_GET_TBSP_PART_V91 table function
Description or corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was
taken.
426 Administrative Routines and Views
Table 140. Information returned by the SNAPTBSP_PART administrative view and the
SNAP_GET_TBSP_PART_V91 table function (continued)
Description or corresponding monitor
Column name Data type element
TBSP_NAME VARCHAR tablespace_name - Table space name
(128)
TBSP_ID BIGINT tablespace_id - Table space identification
TBSP_STATE VARCHAR tablespace_state - Table space state. This
(256) interface returns a text identifier based on
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
TBSP_PREFETCH_SIZE BIGINT tablespace_prefetch_size - Table space
prefetch size
TBSP_NUM_QUIESCERS BIGINT tablespace_num_quiescers - Number of
quiescers
BIGINT tablespace_state_change_object_id - State
TBSP_STATE_CHANGE_ change object identification
OBJECT_ID
BIGINT tablespace_state_change_ts_id - State change
TBSP_STATE_CHANGE_ table space identification
TBSP_ID
TIMESTAMP tablespace_min_recovery_time - Minimum
TBSP_MIN_RECOVERY_ recovery time for rollforward
TIME
Chapter 3. Supported routines and views 427
Table 140. Information returned by the SNAPTBSP_PART administrative view and the
SNAP_GET_TBSP_PART_V91 table function (continued)
Description or corresponding monitor
Column name Data type element
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
TBSP_FREE_PAGES BIGINT tablespace_free_pages - Free pages in table
space
BIGINT tablespace_pending_free_pages - Pending
TBSP_PENDING_FREE_ free pages in table space
PAGES
TBSP_PAGE_TOP BIGINT tablespace_page_top - Table space high
water mark
REBALANCER_MODE VARCHAR tablespace_rebalancer_mode - Rebalancer
(10) 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
BIGINT tablespace_rebalancer_extents_remaining -
REBALANCER_EXTENTS_ Total number of extents to be processed by
REMAINING the rebalancer
BIGINT tablespace_rebalancer_extents_processed -
REBALANCER_EXTENTS_ Number of extents the rebalancer has
PROCESSED processed
REBALANCER_PRIORITY BIGINT tablespace_rebalancer_priority - Current
rebalancer priority
TIMESTAMP tablespace_rebalancer_start_time -
REBALANCER_START_ Rebalancer start time
TIME
TIMESTAMP tablespace_rebalancer_restart_time -
REBALANCER_RESTART_ Rebalancer restart time
TIME
BIGINT tablespace_rebalancer_last_extent_moved -
REBALANCER_LAST_ Last extent moved by the rebalancer
EXTENT_MOVED
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
428 Administrative Routines and Views
Table 140. Information returned by the SNAPTBSP_PART administrative view and the
SNAP_GET_TBSP_PART_V91 table function (continued)
Description or corresponding monitor
Column name Data type element
TBSP_INCREASE_SIZE BIGINT tablespace_increase_size - Increase size in
bytes
SMALLINT tablespace_increase_size_percent - Increase
TBSP_INCREASE_SIZE_ size by percent
PERCENT
TBSP_LAST_RESIZE_TIME TIMESTAMP tablespace_last_resize_time - Time of last
successful resize
SMALLINT tablespace_last_resize_failed - Last resize
TBSP_LAST_RESIZE_ attempt failed
FAILED
DBPARTITIONNUM SMALLINT The database partition from which the data
was retrieved for this row.
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.
SNAPTBSP_QUIESCER administrative view
This administrative view allows you to retrieve quiescer table space snapshot
information for the currently connected database.
Used with the SNAPTBSP, SNAPTBSP_PART, SNAPTBSP_RANGE,
SNAPCONTAINER administrative views, the SNAPTBSP_QUIESCER
administrative view provides information equivalent to the GET SNAPSHOT FOR
TABLESPACES ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 141 on page 431 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPTBSP_QUIESCER administrative
view and EXECUTE privilege on the SNAP_GET_TBSP_QUIESCER table
function.
Example
Retrieve information on quiesced table spaces for all database partitions for the
currently connected database.
Chapter 3. Supported routines and views 429
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
The following is an example of output from this query.
TBSP_NAME QUIESCER_TS_ID QUIESCER_OBJ_ID QUIESCER_AUTH_ID ..
---------- --------------...- ---------------...- ----------------...- ..
USERSPACE1 2 5 SWALKTY ..
USERSPACE1 2 5 SWALKTY ..
..
2 record(s) selected.
Output from this query (continued).
... QUIESCER_AGENT_ID QUIESCER_STATE DBPARTITIONNUM
... -------------------- -------------- --------------
... 0 EXCLUSIVE 0
... 65983 EXCLUSIVE 1
...
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
information for a specific database on a specific database partition, aggregate of all
database partitions or all database partitions.
Used with the SNAP_GET_TBSP_V91, SNAP_GET_TBSP_PART_V91,
SNAP_GET_TBSP_RANGE, SNAP_GET_CONTAINER_V91 table functions, the
SNAP_GET_TBSP_QUIESCER table function provides information equivalent to
the GET SNAPSHOT FOR TABLESPACES ON database-alias CLP command.
Refer to Table 141 on page 431 for a complete list of information that can be
returned.
Syntax
SNAP_GET_TBSP_QUIESCER ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
430 Administrative Routines and Views
active database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
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_TBSP_QUIESCER table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_TBSP_QUIESCER table function.
Example
Retrieve information on quiesced table spaces for database partition 1 for the
currently connected database.
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 TABLE( SYSPROC.SNAP_GET_TBSP_QUIESCER( ’’, 1)) AS T
The following is an example of output from this query.
TBSP_NAME QUIESCER_TS_ID QUIESCER_OBJ_ID QUIESCER_AUTH_ID ...
---------- --------------...- ---------------...- ----------------...- ...
USERSPACE1 2 5 SWALKTY ...
...
1 record(s) selected.
Output from this query (continued).
... QUIESCER_AGENT_ID QUIESCER_STATE DBPARTITIONNUM
... -------------------- -------------- --------------
... 65983 EXCLUSIVE 1
...
Information returned
Table 141. Information returned by the SNAPTBSP_QUIESCER administrative view and the
SNAP_GET_TBSP_QUIESCER table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
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
QUIESCER_AUTH_ID VARCHAR(128) quiescer_auth_id - Quiescer user
authorization identification
QUIESCER_AGENT_ID BIGINT quiescer_agent_id - Quiescer agent
identification
Chapter 3. Supported routines and views 431
Table 141. Information returned by the SNAPTBSP_QUIESCER administrative view and the
SNAP_GET_TBSP_QUIESCER table function (continued)
Description or corresponding
Column name Data type monitor element
QUIESCER_STATE VARCHAR(14) quiescer_state - Quiescer state. This
interface returns a text identifier
based on defines in sqlutil.h and is
one of:
v EXCLUSIVE
v UPDATE
v SHARE
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPTBSP_RANGE administrative view and
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.
SNAPTBSP_RANGE administrative view
This administrative view allows you to retrieve range snapshot information for the
currently connected database.
Used with the SNAPTBSP, SNAPTBSP_PART, SNAPTBSP_QUIESCER and
SNAPCONTAINER administrative views, the SNAPTBSP_RANGE administrative
view provides information equivalent to the GET SNAPSHOT FOR TABLESPACES
ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 142 on page 435 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPTBSP_RANGE administrative view
and EXECUTE privilege on the SNAP_GET_TBSP_RANGE table function.
Example
Select information about table space ranges for all database partitions for the
currently connected database.
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
ORDER BY DBPARTITIONNUM
The following is an example of output from this query.
432 Administrative Routines and Views
TBSP_ID TBSP_NAME RANGE_NUMBER RANGE_STRIPE_SET_NUMBER ...
-------...- --------------- ------------...- ----------------------- ...
0 SYSCATSPACE 0 0 ...
2 USERSPACE1 0 0 ...
3 SYSTOOLSPACE 0 0 ...
2 USERSPACE1 0 0 ...
2 USERSPACE1 0 0 ...
...
5 record(s) selected. ...
Output from this query (continued).
... RANGE_OFFSET RANGE_MAX_PAGE RANGE_MAX_EXTENT ...
... ------------...- -------------------- -------------------- ...
... 0 11515 2878 ...
... 0 479 14 ...
... 0 251 62 ...
... 0 479 14 ...
... 0 479 14 ...
Output from this query (continued).
... RANGE_START_STRIPE RANGE_END_STRIPE RANGE_ADJUSTMENT ...
... -------------------- -------------------- -------------------- ...
... 0 2878 0 ...
... 0 14 0 ...
... 0 62 0 ...
... 0 14 0 ...
... 0 14 0 ...
Output from this query (continued).
... RANGE_NUM_CONTAINER RANGE_CONTAINER_ID DBPARTITIONNUM
... -------------------- -------------------- --------------
... 1 0 0
... 1 0 0
... 1 0 0
... 1 0 1
... 1 0 2
SNAP_GET_TBSP_RANGE table function
The SNAP_GET_TBSP_RANGE table function returns the same information as the
SNAPTBSP_RANGE 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 with the SNAP_GET_TBSP_V91, SNAP_GET_TBSP_PART_V91,
SNAP_GET_TBSP_QUIESCER and SNAP_GET_CONTAINER_V91 table functions,
the SNAP_GET_TBSP_RANGE table function provides information equivalent to
the GET SNAPSHOT FOR TABLESPACES ON database-alias CLP command.
Refer to Table 142 on page 435 for a complete list of information that can be
returned.
Syntax
SNAP_GET_TBSP_RANGE ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Chapter 3. Supported routines and views 433
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_TBSP_RANGE table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_TBSP_RANGE table function.
Examples
Select information on the table space range for the table space with tbsp_id = 2 on
the currently connected database partition.
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
FROM TABLE(SNAP_GET_TBSP_RANGE(’’,-1)) AS T WHERE TBSP_ID = 2
The following is an example of output from this query.
TBSP_ID TBSP_NAME RANGE_NUMBER ...
-------...- --------------- ------------...- ...
2 USERSPACE1 0 ...
...
1 record(s) selected. ...
Output from this query (continued).
... RANGE_STRIPE_SET_NUMBER RANGE_OFFSET RANGE_MAX_PAGE ...
... ----------------------- ------------...- --------------...---- ...
... 0 0 3967 ...
... ...
Output from this query (continued).
... RANGE_MAX_EXTENT RANGE_START_STRIPE RANGE_END_STRIPE ...
... -------------------- -------------------- -------------------- ...
... 123 0 123 ...
... ...
434 Administrative Routines and Views
Output from this query (continued).
... RANGE_ADJUSTMENT RANGE_NUM_CONTAINER RANGE_CONTAINER_ID
... -------------------- -------------------- --------------------
... 0 1 0
...
Information returned
Table 142. Information returned by the SNAPTBSP_RANGE administrative view and the
SNAP_GET_TBSP_RANGE table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TBSP_ID BIGINT tablespace_id - Table space
identification
TBSP_NAME VARCHAR(128) tablespace_name - Table space
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 The database partition from which
the data was retrieved for this row.
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 on utilities from the utility_info logical data group.
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.
The schema is SYSIBMADM.
Chapter 3. Supported routines and views 435
Refer to Table 143 on page 437 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPUTIL administrative view and
EXECUTE privilege on the SNAP_GET_UTIL table function.
Example
Retrieve a list of utilities and their states on all database partitions 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
The following is an example of output from this query.
UTILITY_TYPE UTILITY_PRIORITY ...
------------...- ---------------- ...
LOAD - ...
LOAD - ...
LOAD - ...
3 record(s) selected.
Output from this query (continued).
... UTILITY_DESCRIPTION ...
... -----------------------------------------------------------------...
... ONLINE LOAD DEL AUTOMATIC INDEXING INSERT COPY NO TEST .LOADTEST ...
... ONLINE LOAD DEL AUTOMATIC INDEXING INSERT COPY NO TEST .LOADTEST ...
... ONLINE LOAD DEL AUTOMATIC INDEXING INSERT COPY NO TEST .LOADTEST ...
Output from this query (continued).
... UTILITY_DBNAME UTILITY_STATE UTILITY_INVOKER_TYPE DBPARTITIONNUM
... ----------------- ------------- -------------------- --------------
... SAMPLE EXECUTE USER 0
... SAMPLE EXECUTE USER 1
... SAMPLE EXECUTE 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
specific database partition, aggregate of all database partitions or all database
partitions.
Used in conjunction with the SNAP_GET_UTIL_PROGRESS table function, the
SNAP_GET_UTIL table function provides the same information as the LIST
UTILITIES SHOW DETAIL CLP command.
Refer to Table 143 on page 437 for a complete list of information that can be
returned.
Syntax
436 Administrative Routines and Views
SNAP_GET_UTIL ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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_UTIL table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_UTIL table function.
Example
Retrieve a list of utility ids with their type and state for the currently connected
database partition on database SAMPLE.
SELECT UTILITY_ID, UTILITY_TYPE, STATE
FROM TABLE(SNAP_GET_UTIL(-1)) AS T WHERE UTILITY_DBNAME=’SAMPLE’
The following is an example of output from this query.
UTILITY_ID UTILITY_TYPE STATE
-------------------- -------------------------- --------
1 BACKUP EXECUTE
1 record(s) selected.
Information returned
Table 143. Information returned by the SNAPUTIL administrative view and the
SNAP_GET_UTIL table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
UTILITY_ID INTEGER utility_id - Utility ID. Unique to a
database partition.
Chapter 3. Supported routines and views 437
Table 143. Information returned by the SNAPUTIL administrative view and the
SNAP_GET_UTIL table function (continued)
Description or corresponding
Column name Data type monitor element
UTILITY_TYPE VARCHAR(26) 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 REORG
v RESTART_RECREATE_INDEX
v RESTORE
v ROLLFORWARD_RECOVERY
v RUNSTATS
UTILITY_PRIORITY INTEGER utility_priority - Utility priority.
Priority if utility supports
throttling, otherwise null.
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 utility_start_time - Utility start time
UTILITY_STATE VARCHAR(10) utility_state - Utility state. This
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v ERROR
v EXECUTE
v WAIT
UTILITY_INVOKER_TYPE VARCHAR(10) utility_invoker_type - Utility
invoker type. This interface returns
a text identifier based on the
defines in sqlmon.h and is one of:
v AUTO
v USER
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
PROGRESS_LIST_ATTR VARCHAR(10) progress_list_attr - Current progress
list attributes
PROGRESS_LIST_CUR_SEQ_NUM INTEGER progress_list_current_seq_num -
Current progress list sequence
number
438 Administrative Routines and Views
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.
SNAPUTIL_PROGRESS administrative view
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.
The schema is SYSIBMADM.
Refer to Table 144 on page 440 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPUTIL_PROGRESS administrative
view and EXECUTE privilege on the SNAP_GET_UTIL_PROGRESS table
function.
Example
Retrieve details on total and completed units of progress by utility ID.
SELECT SELECT UTILITY_ID, PROGRESS_TOTAL_UNITS, PROGRESS_COMPLETED_UNITS,
DBPARTITIONNUM FROM SYSIBMADM.SNAPUTIL_PROGRESS
The following is an example of output from this query.
UTILITY_ID PROGRESS_TOTAL_UNITS PROGRESS_COMPLETED_UNITS DBPARTITIONNU
---------- -------------------- ------------------------ -----------–-
7 10 5 0
9 10 5 1
1 record(s) selected.
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
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_UTIL table function, the
SNAP_GET_UTIL_PROGRESS table function provides the same information as the
LIST UTILITIES SHOW DETAIL CLP command.
Refer to Table 144 on page 440 for a complete list of information that can be
returned.
Chapter 3. Supported routines and views 439
Syntax
SNAP_GET_UTIL_PROGRESS ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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_UTIL_PROGRESS table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_UTIL_PROGRESS table function.
Example
Retrieve details on the progress of utilities on the currently connect partition.
SELECT UTILITY_ID, PROGRESS_TOTAL_UNITS, PROGRESS_COMPLETED_UNITS,
DBPARTITIONNUM FROM TABLE(SNAP_GET_UTIL_PROGRESS(-1)) as T
The following is an example of output from this query.
UTILITY_ID PROGRESS_TOTAL_UNITS PROGRESS_COMPLETED_UNITS DBPARTITIONNUM
---------- -------------------- ------------------------ --------------
7 10 5 0
1 record(s) selected.
Information returned
Table 144. Information returned by the SNAPUTIL_PROGRESS administrative view and the
SNAP_GET_UTIL_PROGRESS table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
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.
440 Administrative Routines and Views
Table 144. Information returned by the SNAPUTIL_PROGRESS administrative view and the
SNAP_GET_UTIL_PROGRESS table function (continued)
Description or corresponding
Column name Data type monitor element
UTILITY_STATE VARCHAR(16) utility_state - Utility state. This
interface returns a text identifier
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
defines in sqlmon.h and is one of:
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 The database partition from which
the data was retrieved for this row.
SNAP_WRITE_FILE procedure
The SNAP_WRITE_FILE procedure writes system snapshot data to a file in the tmp
subdirectory of the instance directory.
Syntax
SNAP_WRITE_FILE ( requestType , dbname , dbpartitionnum )
The schema is SYSPROC.
Procedure parameters
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:
Chapter 3. Supported routines and views 441
v APPL_ALL
v BUFFERPOOLS_ALL
v DB2
v DBASE_ALL
v DBASE_LOCKS
v DBASE_TABLES
v DBASE_TABLESPACES
v DYNAMIC_SQL
dbname
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. 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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If a null value is specified, -1 is set implicitly.
Authorization
To execute the procedure, a user must have SYSADM, SYSCTRL, SYSMAINT, or
SYSMON authority. The saved snapshot can be read by users who do not have
SYSADM, SYSCTRL, SYSMAINT, or SYSMON authority by passing null values as
the inputs to snapshot table 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
snapshot information
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.
442 Administrative Routines and Views
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 SNAPAGENT_MEMORY_POOL, SNAPAPPL, SNAPAPPL_INFO,
SNAPSTMT 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 partitions.
The schema is SYSIBMADM.
Refer to Table 115 on page 320 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPAGENT administrative view and
EXECUTE privilege on the SNAP_GET_AGENT table function.
Example
Retrieve all application snapshot information for the currently connected database
from the agent logical data group.
SELECT * FROM SYSIBMADM.SNAPAGENT
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP DB_NAME AGENT_ID ...
-------------------------- -------...- ---------...--- ...
2005-07-19-11.03.26.740423 SAMPLE 101 ...
2005-07-19-11.03.26.740423 SAMPLE 49 ...
...
2 record(s) selected. ...
Output from this query (continued).
... 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 partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_AGENT_MEMORY_POOL, SNAP_GET_APPL_V95,
SNAP_GET_APPL_INFO_V95, 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 partitions.
Chapter 3. Supported routines and views 443
Refer to Table 115 on page 320 for a complete list of information that can be
returned.
Syntax
SNAP_GET_AGENT ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_AGENT table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_AGENT table function.
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
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP DB_NAME AGENT_ID ...
-------------------------- -------...- --------...-- ...
2006-01-03-17.21.38.530785 SAMPLE 48 ...
2006-01-03-17.21.38.530785 SAMPLE 47 ...
2006-01-03-17.21.38.530785 SAMPLE 46 ...
2006-01-03-17.21.38.530785 TESTDB 30 ...
444 Administrative Routines and Views
2006-01-03-17.21.38.530785 TESTDB 29 ...
2006-01-03-17.21.38.530785 TESTDB 28 ...
6 record(s) selected.
Output from this query (continued).
... AGENT_PID LOCK_TIMEOUT_VAL DBPARTITIONNUM
... ---------...---- -------------------- --------------
... 7696 -1 0
... 8536 -1 0
... 6672 -1 0
... 2332 -1 0
... 8360 -1 0
... 6736 -1 0
...
Information returned
Table 145. Information returned by the SNAPAGENT administrative view and the
SNAP_GET_AGENT table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
AGENT_PID BIGINT agent_pid - Engine dispatchable
unit (EDU)
LOCK_TIMEOUT_VAL BIGINT lock_timeout_val - Lock timeout
(seconds)
DBPARTITIONNUM SMALLINT The database partition from which
the data for the row was retrieved.
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.
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
currently connected database.
Used with the SNAPAGENT, SNAPAPPL, SNAPAPPL_INFO, SNAPSTMT and
SNAPSUBSECTION administrative views, the SNAPAGENT_MEMORY_POOL
administrative view provides information equivalent to the GET SNAPSHOT FOR
APPLICATIONS ON database-alias CLP command.
The schema is SYSIBMADM.
Chapter 3. Supported routines and views 445
Refer to Table 116 on page 323 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPAGENT_MEMORY_POOL
administrative view and EXECUTE privilege on the
SNAP_GET_AGENT_MEMORY_POOL table function.
Example
Retrieve a list of memory pools and their current size.
SELECT AGENT_ID, POOL_ID, POOL_CUR_SIZE FROM SYSIBMADM.SNAPAGENT_MEMORY_POOL
The following is an example of output from this query.
AGENT_ID POOL_ID POOL_ CUR_SIZE
--------...--- -------------- ---------...------
48 APPLICATION 65536
48 OTHER 65536
48 APPL_CONTROL 65536
47 APPLICATION 65536
47 OTHER 131072
47 APPL_CONTROL 65536
46 OTHER 327680
46 APPLICATION 262144
46 APPL_CONTROL 65536
9 record(s) selected.
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
partition, aggregate of all database partitions or all database partitions.
Used with the SNAP_GET_AGENT, SNAP_GET_APPL_V95,
SNAP_GET_APPL_INFO_V95, 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.
Refer to Table 116 on page 323 for a complete list of information that can be
returned.
Syntax
SNAP_GET_AGENT_MEMORY_POOL ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
name in the same instance as the currently connected database. Specify a
446 Administrative Routines and Views
database name that has a directory entry type of either ″Indirect″ or ″Home″,
as 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_AGENT_MEMORY_POOL table function takes a snapshot for the
currently connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_AGENT_MEMORY_POOL table
function.
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
The following is an example of output from this query.
DB_NAME AGENT_ID POOL_ID POOL_CUR_SIZE
-------- --------...--- -------------- --------------------
SAMPLE 48 APPLICATION 65536
SAMPLE 48 OTHER 65536
SAMPLE 48 APPL_CONTROL 65536
SAMPLE 47 APPLICATION 65536
SAMPLE 47 OTHER 131072
SAMPLE 47 APPL_CONTROL 65536
SAMPLE 46 OTHER 327680
SAMPLE 46 APPLICATION 262144
SAMPLE 46 APPL_CONTROL 65536
TESTDB 30 APPLICATION 65536
TESTDB 30 OTHER 65536
TESTDB 30 APPL_CONTROL 65536
TESTDB 29 APPLICATION 65536
TESTDB 29 OTHER 131072
TESTDB 29 APPL_CONTROL 65536
TESTDB 28 OTHER 327680
TESTDB 28 APPLICATION 65536
TESTDB 28 APPL_CONTROL 65536
18 record(s) selected.
Chapter 3. Supported routines and views 447
Information returned
Table 146. Information returned by the SNAPAGENT_MEMORY_POOL administrative view
and the SNAP_GET_AGENT_MEMORY_POOL table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
AGENT_PID BIGINT agent_pid - Engine dispatchable
unit (EDU)
POOL_ID VARCHAR(14) pool_id - Memory pool identifier.
This interface returns a text
identifier based on defines in
sqlmon.h, and is one of:
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
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
448 Administrative Routines and Views
SNAPAPPL_INFO administrative view and
SNAP_GET_APPL_INFO_V95 table function - Retrieve
appl_info logical data group snapshot information
The SNAPAPPL_INFO administrative view and the SNAP_GET_APPL_INFO_V95
table function return information about applications from an application snapshot,
in particular, the appl_info logical data group.
SNAPAPPL_INFO administrative view
This administrative view allows you to retrieve appl_info logical data group
snapshot information for the currently connected database.
Used with the SNAPAGENT, SNAPAGENT_MEMORY_POOL, SNAPAPPL,
SNAPSTMT 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 partitions.
The schema is SYSIBMADM.
Refer to Table 117 on page 327 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPAPPL_INFO administrative view
and EXECUTE privilege on the SNAP_GET_APPL_INFO_V95 table function.
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
The following is an example of output from this query.
AGENT_ID APPL_NAME APPL_STATUS
-------------------- ---------- ----------------------
101 db2bp.exe UOWEXEC
49 db2bp.exe CONNECTED
2 record(s) selected.
SNAP_GET_APPL_INFO_V95 table function
The SNAP_GET_APPL_INFO_V95 table function returns the same information as
the SNAPAPPL_INFO 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 with the SNAP_GET_AGENT, SNAP_GET_AGENT_MEMORY_POOL,
SNAP_GET_APPL_V95, SNAP_GET_STMT and SNAP_GET_SUBSECTION table
functions, the SNAP_GET_APPL_INFO_V95 table function provides information
equivalent to the GET SNAPSHOT FOR ALL APPLICATIONS CLP command, but
retrieves data from all database partitions.
Chapter 3. Supported routines and views 449
Refer to Table 117 on page 327 for a complete list of information that can be
returned.
Syntax
SNAP_GET_APPL_INFO_V95 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_APPL_INFO_V95 table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_APPL_INFO_V95 table function.
Examples
Retrieve the status of all applications on the connected database partition.
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_V95(CAST(NULL AS VARCHAR(128)),-1)) AS T
The following is an example of output from this query.
DB_NAME AGENT_ID APPL_NAME APPL_STATUS
-------- -------------------- ---------- ----------------------
TOOLSDB 14 db2bp.exe CONNECTED
SAMPLE 15 db2bp.exe UOWEXEC
SAMPLE 8 javaw.exe CONNECTED
SAMPLE 7 db2bp.exe UOWWAIT
4 record(s) selected.
450 Administrative Routines and Views
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
FROM TABLE(SNAP_GET_APPL_INFO_V95(CAST(NULL AS VARCHAR(128)),-1)) AS T
The following is an example of output from this query.
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 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 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)
3 record(s) selected.
Information returned
Table 147. Information returned by the SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO_V95 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
Chapter 3. Supported routines and views 451
Table 147. Information returned by the SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
APPL_STATUS VARCHAR(22) appl_status - Application status.
This interface returns a text
identifier based on the defines in
sqlmon.h, and is one of:
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
CODEPAGE_ID BIGINT codepage_id - ID of code page used
by application
NUM_ASSOC_AGENTS BIGINT num_assoc_agents - Number of
associated agents
COORD_NODE_NUM SMALLINT coord_node - Coordinating node
452 Administrative Routines and Views
Table 147. Information returned by the SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
AUTHORITY_LVL VARCHAR(512) authority_bitmap - User
Authorization Level monitor
element.
This interface returns a text
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 BINDADD
v CONNECT
v CREATE_EXT_RT
v CREATE_NOT_FENC
v CREATETAB
v DBADM
v IMPLICIT_SCHEMA
v LOAD
v LIBADM
v QUIESCE_CONN
v SECADM
v SYSADM
v SYSCTRL
v SYSMAINT
v SYSMON
v SYSQUIESCE
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 client_pid - Client process ID
COORD_AGENT_PID BIGINT coord_agent_pid - Coordinator
agent
STATUS_CHANGE_TIME TIMESTAMP status_change_time - Application
status change time
Chapter 3. Supported routines and views 453
Table 147. Information returned by the SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
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
454 Administrative Routines and Views
Table 147. Information returned by the SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
CLIENT_PROTOCOL VARCHAR(10) client_protocol - Client
communication protocol. This
interface returns a text identifier
based on the defines in sqlmon.h,
v CPIC
v LOCAL
v NETBIOS
v NPIPE
v TCPIP (for DB2 UDB)
v TCPIP4
v TCPIP6
TERRITORY_CODE SMALLINT territory_code - Database territory
code
APPL_NAME VARCHAR(256) appl_name - Application name
APPL_ID VARCHAR(128) appl_id - Application ID
SEQUENCE_NO VARCHAR(4) sequence_no - Sequence number
PRIMARY_AUTH_ID VARCHAR(128) auth_id - Authorization ID
SESSION_AUTH_ID VARCHAR(128) session_auth_id - Session
authorization ID
CLIENT_NNAME VARCHAR(128) The client_nname monitor element
is deprecated. The value returned is
not a valid value.
CLIENT_PRDID VARCHAR(128) client_prdid - Client
product/version ID
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input database
alias
CLIENT_DB_ALIAS VARCHAR(128) client_db_alias - Database alias
used by application
DB_NAME VARCHAR(128) db_name - Database name
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) 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 The database partition from which
the data for the row was retrieved.
WORKLOAD_ID INTEGER Current workload ID.
Chapter 3. Supported routines and views 455
Table 147. Information returned by the SNAPAPPL_INFO administrative view and the
SNAP_GET_APPL_INFO_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
IS_SYS_APPL SMALLINT The value of IS_SYS_APPL
indicates whether or not the
application is a DB2 internal
system application:
0 means it is a user application
1 means it is a system application.
An example of a DB2 system
application is a DB2 event monitor.
In general, the names of DB2
system applications begin with
″db2″. For example: db2stmm,
db2taskd.
SNAPAPPL administrative view and SNAP_GET_APPL_V95
table function - Retrieve appl logical data group snapshot
information
The “SNAPAPPL administrative view” on page 332 and the
“SNAP_GET_APPL_V95 table function” on page 333 return information about
applications from an application snapshot, in particular, the appl logical data
group.
SNAPAPPL administrative view
This administrative view allows you to retrieve appl logical data group snapshot
information for the currently connected database.
Used with the SNAPAGENT, SNAPAGENT_MEMORY_POOL, SNAPAPPL_INFO,
SNAPSTMT and SNAPSUBSECTION administrative views, the SNAPAPPL
administrative view provides information equivalent to the GET SNAPSHOT FOR
APPLICATIONS ON database-alias CLP command, but retrieves data from all
database partitions.
The schema is SYSIBMADM.
Refer to Table 118 on page 334 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPAPPL administrative view and
EXECUTE privilege on the SNAP_GET_APPL_V95 table function.
Example
Retrieve details on rows read and written for each application in the connected
database.
456 Administrative Routines and Views
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, AGENT_ID, ROWS_READ, ROWS_WRITTEN
FROM SYSIBMADM.SNAPAPPL
The following is an example of output from this query.
DB_NAME AGENT_ID ROWS_READ ROWS_WRITTEN
-------- -------------------- -------------------- --------------------
SAMPLE 7 25 0
1 record(s) selected.
SNAP_GET_APPL_V95 table function
The SNAP_GET_APPL_V95 table function returns the same information as the
SNAPAPPL 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 with the SNAP_GET_AGENT, SNAP_GET_AGENT_MEMORY_POOL,
SNAP_GET_APPL_INFO_V95, SNAP_GET_STMT and SNAP_GET_SUBSECTION
table functions, the SNAP_GET_APPL_V95 table function provides information
equivalent to the GET SNAPSHOT FOR ALL APPLICATIONS CLP command, but
retrieves data from all database partitions.
Refer to Table 118 on page 334 for a complete list of information that can be
returned.
Syntax
SNAP_GET_APPL_V95 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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
Chapter 3. Supported routines and views 457
SNAP_GET_APPL_V95 table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_APPL_V95 table function.
Example
Retrieve details on rows read and written for each application for all active
databases.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, AGENT_ID, ROWS_READ, ROWS_WRITTEN
FROM TABLE (SNAP_GET_APPL_V95(CAST(NULL AS VARCHAR(128)),-1)) AS T
The following is an example of output from this query.
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
Information returned
Table 148. Information returned by the SNAPAPPL administrative view and the
SNAP_GET_APPL_V95 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
UOW_LOG_SPACE_USED BIGINT uow_log_space_used - Unit of
work log space used
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
INACT_STMTHIST_SZ BIGINT stmt_history_list_size - Statement
history list size
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
458 Administrative Routines and Views
Table 148. Information returned by the SNAPAPPL administrative view and the
SNAP_GET_APPL_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index writes
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer
Pool Temporary XDA Data Physical
Reads monitor element
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool
XDA Data Logical Reads
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool
XDA Data Physical Reads
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
LOCKS_HELD BIGINT locks_held - Locks held
LOCK_WAITS BIGINT lock_waits - Lock waits
LOCK_WAIT_TIME BIGINT lock_wait_time - Time waited on
locks
Chapter 3. Supported routines and views 459
Table 148. Information returned by the SNAPAPPL administrative view and the
SNAP_GET_APPL_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_ESCALS BIGINT lock_escals - Number of lock
escalations
X_LOCK_ESCALS BIGINT x_lock_escals - Exclusive lock
escalations
DEADLOCKS BIGINT deadlocks - Deadlocks detected
TOTAL_SORTS BIGINT total_sorts - Total sorts
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
COMMIT_SQL_STMTS BIGINT commit_sql_stmts - Commit
statements attempted
ROLLBACK_SQL_STMTS BIGINT rollback_sql_stmts - Rollback
statements attempted
DYNAMIC_SQL_STMTS BIGINT dynamic_sql_stmts - Dynamic SQL
statements attempted
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
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_commits - Internal commits
INT_ROLLBACKS BIGINT int_rollbacks - Internal rollbacks
INT_DEADLOCK_ROLLBACKS BIGINT int_deadlock_rollbacks - Internal
rollbacks due to deadlock
ROWS_DELETED BIGINT rows_deleted - Rows deleted
ROWS_INSERTED BIGINT rows_inserted - Rows inserted
ROWS_UPDATED BIGINT rows_updated - Rows updated
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
460 Administrative Routines and Views
Table 148. Information returned by the SNAPAPPL administrative view and the
SNAP_GET_APPL_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
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
SQL_REQS_SINCE_COMMIT BIGINT sql_reqs_since_commit - SQL
requests since last commit
LOCK_TIMEOUTS BIGINT lock_timeouts - Number of lock
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
cursors with blocking
PKG_CACHE_LOOKUPS BIGINT pkg_cache_lookups - Package cache
lookups
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
ASSOCIATED_AGENTS_TOP 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 in
sqlmon.h, and is one of:
v DYNAMIC_PRIORITY
v FIXED_PRIORITY
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
Chapter 3. Supported routines and views 461
Table 148. Information returned by the SNAPAPPL administrative view and the
SNAP_GET_APPL_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
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
BIGINT hash_join_small_overflows - Hash
HASH_JOIN_SMALL_ join small overflows
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
UOW_COMP_STATUS VARCHAR(14) uow_comp_status - Unit of work
completion status. This interface
returns a text identifier, based on
defines in sqlmon.h, and is one of:
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
AGENT_USR_CPU_TIME_MS BIGINT agent_usr_cpu_time - User CPU
time used by agent
AGENT_SYS_CPU_TIME_S BIGINT agent_sys_cpu_time - System CPU
time used by agent
AGENT_SYS_CPU_TIME_MS BIGINT agent_sys_cpu_time - System CPU
time used by agent
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
462 Administrative Routines and Views
Table 148. Information returned by the SNAPAPPL administrative view and the
SNAP_GET_APPL_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
UOW_ELAPSED_TIME_MS BIGINT uow_elapsed_time - Most recent
unit of work elapsed time
ELAPSED_EXEC_TIME_S BIGINT elapsed_exec_time - Statement
execution elapsed time
ELAPSED_EXEC_TIME_MS BIGINT elapsed_exec_time - Statement
execution elapsed time
INBOUND_COMM_ADDRESS VARCHAR(32) inbound_comm_address - Inbound
communication address
LOCK_TIMEOUT_VAL BIGINT lock_timeout_val - Lock timeout
(seconds)
BIGINT priv_workspace_num_overflows -
PRIV_WORKSPACE_NUM_ Private workspace overflows
OVERFLOWS
BIGINT priv_workspace_section_inserts -
PRIV_WORKSPACE_SECTION_ Private workspace section inserts
INSERTS
BIGINT priv_workspace_section_lookups -
PRIV_WORKSPACE_SECTION_ Private workspace section lookups
LOOKUPS
BIGINT priv_workspace_size_top -
PRIV_WORKSPACE_SIZE_ Maximum private workspace size
TOP
BIGINT shr_workspace_num_overflows -
SHR_WORKSPACE_NUM_ Shared workspace overflows
OVERFLOWS
BIGINT shr_workspace_section_inserts -
SHR_WORKSPACE_SECTION_ Shared workspace section inserts
INSERTS
BIGINT shr_workspace_section_lookups -
SHR_WORKSPACE_SECTION_ Shared workspace section lookups
LOOKUPS
BIGINT shr_workspace_size_top -
SHR_WORKSPACE_SIZE_ Maximum shared workspace size
TOP
DBPARTITIONNUM SMALLINT The database partition from which
the data for the row was retrieved.
CAT_CACHE_SIZE_TOP BIGINT cat_cache_size_top - Catalog cache
high water mark
TOTAL_OLAP_FUNCS BIGINT The total number of OLAP
functions executed.
OLAP_FUNC_OVERFLOWS BIGINT The number of times that OLAP
function data exceeded the
available sort heap space.
Chapter 3. Supported routines and views 463
SNAPBP administrative view and SNAP_GET_BP_V95 table
function - Retrieve bufferpool logical group snapshot
information
The SNAPBP administrative view and the SNAP_GET_BP_V95 table function
return information about buffer pools from a bufferpool snapshot, in particular, the
bufferpool logical data group.
SNAPBP administrative view
This administrative view allows you to retrieve bufferpool logical group snapshot
information for the currently connected database.
Used with the SNAPBP_PART administrative view, the SNAPBP administrative
view provides the data equivalent to the GET SNAPSHOT FOR BUFFERPOOLS
ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 119 on page 342 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPBP administrative view and
EXECUTE privilege on the SNAP_GET_BP_V95 table function.
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
The following is an example of output from this query.
DB_NAME BP_NAME POOL_DATA_WRITES POOL_INDEX_WRITES
-------- --------------- -------------------- --------------------
TEST IBMDEFAULTBP 0 0
TEST IBMSYSTEMBP4K 0 0
TEST IBMSYSTEMBP8K 0 0
TEST IBMSYSTEMBP16K 0 0
TEST IBMSYSTEMBP32K 0 0
5 record(s) selected
SNAP_GET_BP_V95 table function
The SNAP_GET_BP_V95 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 partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_BP_PART table function, the SNAP_GET_BP_V95 table
function provides the data equivalent to the GET SNAPSHOT FOR ALL
BUFFERPOOLS CLP command.
464 Administrative Routines and Views
Refer to Table 119 on page 342 for a complete list of information that can be
returned.
Syntax
SNAP_GET_BP_V95 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_BP_V95 table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_BP_V95 table function.
Example
Retrieve total physical and logical reads for all bufferpools for all active databases
for the currently connected database partition.
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_V95(CAST(NULL AS VARCHAR(128)), -1)) AS T
The following is an example of output from this query.
DB_NAME BP_NAME TOTAL_LOGICAL_READS ...
---------- ------------...- -------------------- ...
SAMPLE IBMDEFAULTBP 0 ...
Chapter 3. Supported routines and views 465
TOOLSDB IBMDEFAULTBP 0 ...
TOOLSDB BP32K0000 0 ...
3 record(s) selected.
Output from this query (continued).
... TOTAL_PHYSICAL_READS DBPARTITIONNUM
... -------------------- --------------
... 0 0
... 0 0
... 0 0
Information returned
Table 149. Information returned by the SNAPBP administrative view and the
SNAP_GET_BP_V95 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
BP_NAME VARCHAR(128) bp_name - Buffer pool name
DB_NAME VARCHAR(128) db_name - Database name
DB_PATH VARCHAR(1024) db_path - Database path
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input database
alias
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index writes
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool
XDA Data Logical Reads
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool
XDA Data Physical Reads
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
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer
pool asynchronous data reads
POOL_ASYNC_DATA_WRITES BIGINT pool_async_data_writes - Buffer
pool asynchronous data writes
466 Administrative Routines and Views
Table 149. Information returned by the SNAPBP administrative view and the
SNAP_GET_BP_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_ASYNC_INDEX_READS BIGINT pool_async_index_reads - Buffer
pool asynchronous index reads
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_WRITES BIGINT pool_async_xda_writes - Buffer
Pool Asynchronous XDA Data
Writes
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
BIGINT pool_async_data_read_reqs - Buffer
POOL_ASYNC_DATA_ pool asynchronous read requests
READ_REQS
BIGINT pool_async_index_read_reqs -
POOL_ASYNC_INDEX_ Buffer pool asynchronous index
READ_REQS read requests
BIGINT pool_async_xda_read_reqs - Buffer
POOL_ASYNC_XDA_ Pool Asynchronous XDA Read
READ_REQS Requests
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
FILES_CLOSED BIGINT files_closed - Database files closed
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
Chapter 3. Supported routines and views 467
Table 149. Information returned by the SNAPBP administrative view and the
SNAP_GET_BP_V95 table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer
Pool Temporary XDA Data Physical
Reads monitor element
POOL_NO_VICTIM_BUFFER BIGINT pool_no_victim_buffer - Buffer pool
no victim buffers
PAGES_FROM_BLOCK_IOS BIGINT pages_from_block_ios - Total
number of pages read by block I/O
PAGES_FROM_VECTORED_IOS 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 The database partition from which
the data was retrieved for this row.
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.
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 SNAPBP administrative view, the SNAPBP_PART administrative
view provides the data equivalent to the GET SNAPSHOT FOR BUFFERPOOLS
ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 120 on page 347 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPBP_PART administrative view and
EXECUTE privilege on the SNAP_GET_BP_PART table function.
Example
Retrieve data for all bufferpools when connected to SAMPLE database.
468 Administrative Routines and Views
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, SUBSTR(BP_NAME,1,15) AS BP_NAME,
BP_CUR_BUFFSZ, BP_NEW_BUFFSZ, BP_PAGES_LEFT_TO_REMOVE, BP_TBSP_USE_COUNT
FROM SYSIBMADM.SNAPBP_PART
The following is an example of output from this query.
DB_NAME BP_NAME BP_CUR_BUFFSZ BP_NEW_BUFFSZ ...
-------- --------------- -------------------- -------------------- ...
SAMPLE IBMDEFAULTBP 1000 1000 ...
SAMPLE IBMSYSTEMBP4K 16 16 ...
SAMPLE IBMSYSTEMBP8K 16 16 ...
SAMPLE IBMSYSTEMBP16K 16 16 ...
...
4 record(s) selected.
Output from this query (continued).
... 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
a specific database on a specific database partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_BP_V95 table function, the SNAP_GET_BP_PART table
function provides the data equivalent to the GET SNAPSHOT FOR ALL
BUFFERPOOLS CLP command.
Refer to Table 120 on page 347 for a complete list of information that can be
returned.
Syntax
SNAP_GET_BP_PART ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 an empty
string to take the snapshot from the currently connected database. Specify a
NULL value to take the snapshot for all bufferpools in all databases within the
same instance as the currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
Chapter 3. Supported routines and views 469
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
database is available for connection and use by applications.
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_BP_PART table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_BP_PART table function.
Example
Retrieve data for all bufferpools for all active databases when connected to the
SAMPLE database.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, SUBSTR(BP_NAME,1,15) AS BP_NAME,
BP_CUR_BUFFSZ, BP_NEW_BUFFSZ, BP_PAGES_LEFT_TO_REMOVE, BP_TBSP_USE_COUNT
FROM TABLE(SNAP_GET_BP_PART(CAST(NULL AS VARCHAR(128)),-1)) AS T
The following is an example of output from this query.
DB_NAME BP_NAME BP_CUR_BUFFSZ BP_NEW_BUFFSZ ...
-------- --------------- -------------------- -------------------- ...
SAMPLE IBMDEFAULTBP 250 250 ...
SAMPLE IBMSYSTEMBP4K 16 16 ...
SAMPLE IBMSYSTEMBP8K 16 16 ...
SAMPLE IBMSYSTEMBP16K 16 16 ...
SAMPLE IBMSYSTEMBP32K 16 16 ...
TESTDB IBMDEFAULTBP 250 250 ...
TESTDB IBMSYSTEMBP4K 16 16 ...
TESTDB IBMSYSTEMBP8K 16 16 ...
TESTDB IBMSYSTEMBP16K 16 16 ...
TESTDB IBMSYSTEMBP32K 16 16 ...
...
Output from this query (continued).
... BP_PAGES_LEFT_TO_REMOVE BP_TBSP_USE_COUNT
... ----------------------- --------------------
... 0 3
... 0 0
... 0 0
... 0 0
... 0 0
... 0 3
... 0 0
... 0 0
... 0 0
... 0 0
...
470 Administrative Routines and Views
Information returned
Table 150. Information returned by the SNAPBP_PART administrative view and the
SNAP_GET_BP_PART table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
BP_NAME VARCHAR(128) bp_name - Buffer pool name
DB_NAME VARCHAR(128) db_name - Database name
BP_CUR_BUFFSZ BIGINT bp_cur_buffsz - Current size of
buffer pool
BP_NEW_BUFFSZ BIGINT bp_new_buffsz - New buffer pool
size
BP_PAGES_LEFT_TO_REMOVE 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 The database partition from which
the data was retrieved for this row.
SNAPCONTAINER administrative view and
SNAP_GET_CONTAINER_V91 table function - Retrieve
tablespace_container logical data group snapshot information
The SNAPCONTAINER administrative view and the
SNAP_GET_CONTAINER_V91 table function return table space snapshot
information from the tablespace_container logical data group.
SNAPCONTAINER administrative view
This administrative view allows you to retrieve tablespace_container logical data
group snapshot information for the currently connected database.
Used with the SNAPTBSP, SNAPTBSP_PART, SNAPTBSP_QUIESCER and
SNAPTBSP_RANGE administrative views, the SNAPCONTAINER administrative
view returns data equivalent to the GET SNAPSHOT FOR TABLESPACES ON
database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 121 on page 350 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPCONTAINER administrative view
and EXECUTE privilege on the SNAP_GET_CONTAINER_V91 table function.
Chapter 3. Supported routines and views 471
Example
Retrieve details for the table space containers for all database partitions for the
currently connected database.
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
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP TBSP_NAME TBSP_ID ...
-------------------------- --------------- -------...- ...
2006-01-08-16.49.24.639945 SYSCATSPACE 0 ...
2006-01-08-16.49.24.639945 TEMPSPACE1 1 ...
2006-01-08-16.49.24.639945 USERSPACE1 2 ...
2006-01-08-16.49.24.639945 SYSTOOLSPACE 3 ...
2006-01-08-16.49.24.640747 TEMPSPACE1 1 ...
2006-01-08-16.49.24.640747 USERSPACE1 2 ...
2006-01-08-16.49.24.639981 TEMPSPACE1 1 ...
2006-01-08-16.49.24.639981 USERSPACE1 2 ...
...
8 record(s) selected.
Output from this query (continued).
... CONTAINER_NAME CONTAINER_ID CONTAINER_TYPE ...
... -------------------- ------------...- ---------------- ...
... /home/swalkty/swalkt 0 FILE_EXTENT_TAG ...
... /home/swalkty/swalkt 0 PATH ...
... /home/swalkty/swalkt 0 FILE_EXTENT_TAG ...
... /home/swalkty/swalkt 0 FILE_EXTENT_TAG ...
... /home/swalkty/swalkt 0 PATH ...
... /home/swalkty/swalkt 0 FILE_EXTENT_TAG ...
... /home/swalkty/swalkt 0 PATH ...
... /home/swalkty/swalkt 0 FILE_EXTENT_TAG ...
Output from this query (continued).
... ACCESSIBLE DBPARTITIONNUM
... ---------- --------------
... 1 0
... 1 0
... 1 0
... 1 0
... 1 1
... 1 1
... 1 2
... 1 2
SNAP_GET_CONTAINER_V91 table function
The SNAP_GET_CONTAINER_V91 table function returns the same information as
the SNAPCONTAINER 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 with the SNAP_GET_TBSP_V91, SNAP_GET_TBSP_PART_V91,
SNAP_GET_TBSP_QUIESCER and SNAP_GET_TBSP_RANGE table functions, the
SNAP_GET_CONTAINER_V91 table function returns data equivalent to the GET
SNAPSHOT FOR TABLESPACES ON database-alias CLP command.
Refer to Table 121 on page 350 for a complete list of information that can be
returned.
472 Administrative Routines and Views
Syntax
SNAP_GET_CONTAINER_V91 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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 SYSMON authority
v EXECUTE privilege on the SNAP_GET_CONTAINER_V91 table function.
Example
Retrieve details for the table space containers on the currently connected database
on the currently connected database partition.
SELECT SNAPSHOT_TIMESTAMP, TBSP_NAME, TBSP_ID, CONTAINER_NAME,
CONTAINER_ID, CONTAINER_TYPE, ACCESSIBLE
FROM TABLE(SNAP_GET_CONTAINER_V91(’’,-1)) AS T
The following is an example of output from this query.
SNAPSHOT_TIMESTAMP TBSP_NAME TBSP_ID ...
-------------------------- -------------------- ------- ...
2005-04-25-14.42.10.899253 SYSCATSPACE 0 ...
2005-04-25-14.42.10.899253 TEMPSPACE1 1 ...
2005-04-25-14.42.10.899253 USERSPACE1 2 ...
2005-04-25-14.42.10.899253 SYSTOOLSPACE 3 ...
2005-04-25-14.42.10.899253 MYTEMP 4 ...
2005-04-25-14.42.10.899253 WHATSNEWTEMPSPACE 5 ...
Output from this query (continued).
Chapter 3. Supported routines and views 473
... CONTAINER_NAME CONTAINER_ID ...
... ---------------------------------------- ------------ ...
... D:\DB2\NODE0000\SQL00002\SQLT0000.0 0 ...
... D:\DB2\NODE0000\SQL00002\SQLT0001.0 0 ...
... D:\DB2\NODE0000\SQL00002\SQLT0002.0 0 ...
... D:\DB2\NODE0000\SQL00002\SYSTOOLSPACE 0 ...
... D:\DB2\NODE0000\SQL003 0 ...
... d:\DGTTsWhatsNewContainer 0 ...
Output from this query (continued).
... CONTAINER_TYPE ACCESSIBLE
... -------------- ----------
... CONT_PATH 1
... CONT_PATH 1
... CONT_PATH 1
... CONT_PATH 1
... CONT_PATH 1
... CONT_PATH 1
Information returned
NOTE: The BUFFERPOOL database manager monitor switch must be turned on in
order for the file system information to be returned.
Table 151. Information returned by the SNAPCONTAINER administrative view and the
SNAP_GET_CONTAINER_V91 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
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
CONTAINER_TYPE VARCHAR(16) container_type - Container type.
This is a text identifer 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 container_stripe_set - Stripe set
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
474 Administrative Routines and Views
Table 151. Information returned by the SNAPCONTAINER administrative view and the
SNAP_GET_CONTAINER_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
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
SNAPDB administrative view and SNAP_GET_DB_V95 table
function - Retrieve snapshot information from the dbase
logical group
The “SNAPDB administrative view” on page 351 and the “SNAP_GET_DB_V95
table function” on page 352 return snapshot information from the database (dbase)
logical group.
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 the SNAPDB_MEMORY_POOL, SNAPDETAILLOG,
SNAPHADR and SNAPSTORAGE_PATHS administrative views, the SNAPDB
administrative view provides information equivalent to the GET SNAPSHOT FOR
DATABASE on database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 122 on page 354 for a complete list of information that is returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPDB administrative view and
EXECUTE privilege on the SNAP_GET_DB_V95 table function.
Examples
Retrieve the status, platform, location, and connect time for all database partitions
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
The following is an example of output from this query.
DB_NAME DB_STATUS SERVER_PLATFORM DB_LOCATION ...
-------...- ------------ --------------- ------------ ...
TEST ACTIVE AIX64 LOCAL ...
Chapter 3. Supported routines and views 475
TEST ACTIVE AIX64 LOCAL ...
TEST ACTIVE AIX64 LOCAL ...
3 record(s) selected.
Output from this query (continued).
... 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
1 record(s) selected.
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
FROM SYSIBMADM.SNAPDB
STATS_CACHE_SIZE STATS_FABRICATIONS SYNC_RUNSTATS ASYNC_RUNSTATS ...
---------------- ------------------ ------------- -------------- ...
128 2 1 0 ...
... STATS_FABRICATE_TIME SYNC_RUNSTATS_TIME
... -------------------- ------------------
... 10 100
1 record(s) selected.
SNAP_GET_DB_V95 table function
The SNAP_GET_DB_V95 table function returns the same information as the
SNAPDB administrative view.
Used in conjunction with the SNAP_GET_DB_MEMORY_POOL,
SNAP_GET_DETAILLOG_V91, SNAP_GET_HADR and
SNAP_GET_STORAGE_PATHS table functions, the SNAP_GET_DB_V95 table
function provides information equivalent to the GET SNAPSHOT FOR ALL
DATABASES CLP command.
Refer to Table 122 on page 354 for a complete list of information that is returned.
Syntax
SNAP_GET_DB_V95 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
476 Administrative Routines and Views
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_DB_V95 table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DB_V95 table function.
Examples
Example 1: Retrieve the status, platform, location, and connect time as an aggregate
view across all database partitions of the currently connected database.
SELECT SUBSTR(DB_NAME, 1, 20) AS DB_NAME, DB_STATUS, SERVER_PLATFORM,
DB_LOCATION, DB_CONN_TIME FROM TABLE(SNAP_GET_DB_V95(’’, -2)) AS T
The following is an example of output from this query.
DB_NAME DB_STATUS SERVER_PLATFORM ...
-------...- ------------ --------------- ...
SAMPLE ACTIVE AIX64 ...
1 record(s) selected.
Output from this query (continued).
... DB_LOCATION DB_CONN_TIME
... ------------ --------------------------
... LOCAL 2005-07-24-22.09.22.013196
Example 2: Retrieve the status, platform, location, and connect time as an aggregate
view across all database partitions for all active databases in the same instance that
contains the currently connected database.
SELECT SUBSTR(DB_NAME, 1, 20) AS DB_NAME, DB_STATUS, SERVER_PLATFORM,
DB_LOCATION, DB_CONN_TIME
FROM TABLE(SNAP_GET_DB_V95(CAST (NULL AS VARCHAR(128)), -2)) AS T
Chapter 3. Supported routines and views 477
The following is an example of output from this query.
DB_NAME DB_STATUS SERVER_PLATFORM ...
--------...- ------------ --------------- ...
TOOLSDB ACTIVE AIX64 ...
SAMPLE ACTIVE AIX64 ...
Output from this query (continued).
... DB_LOCATION DB_CONN_TIME
... ------------ --------------------------
... LOCAL 2005-07-24-22.26.54.396335
... LOCAL 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:
SELECT TOTAL_OLAP_FUNCS, OLAP_FUNC_OVERFLOWS, ACTIVE_OLAP_FUNCS
FROM TABLE (SNAP_GET_DB_V95(’’, 0)) AS T
The output will look like:
TOTAL_OLAP_FUNCS OLAP_FUNC_OVERFLOWS ACTIVE_OLAP_FUNCS
---------------- -------------------- --------------------
7 2 1
1 record(s) selected.
Example 4: After running a workload, a user can use the following query with the
table function.
SELECT STATS_CACHE_SIZE, STATS_FABRICATIONS, SYNC_RUNSTATS,
ASYNC_RUNSTATS, STATS_FABRICATE_TIME, SYNC_RUNSTATS_TIME
FROM TABLE (SNAP_GET_DB_V95(’mytestdb’, -1)) AS SNAPDB
STATS_CACHE_SIZE STATS_FABRICATIONS SYNC_RUNSTATS ASYNC_RUNSTATS ...
---------------- ------------------ ------------- -------------- ...
200 1 2 0 ...
Continued
...STATS_FABRICATE_TIME SYNC_RUNSTATS_TIME
...-------------------- ------------------
... 2 32
1 record(s) selected.
SNAPDB administrative view and SNAP_GET_DB_V95 table
function metadata
Table 152. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table function
Description or corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was
taken.
DB_NAME VARCHAR(128) db_name - Database name
DB_PATH VARCHAR(1024) db_path - Database path
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input database alias
478 Administrative Routines and Views
Table 152. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
DB_STATUS VARCHAR(12) db_status - Status of database. This interface
returns a text identifier based on defines in
sqlmon.h, and is one of:
v ACTIVE
v QUIESCE_PEND
v QUIESCED
v ROLLFWD
CATALOG_PARTITION SMALLINT catalog_node - Catalog node number
CATALOG_PARTITION_NAME VARCHAR(128) catalog_node_name - Catalog node network
name
Chapter 3. Supported routines and views 479
Table 152. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
SERVER_PLATFORM VARCHAR(12) 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 interface
returns a text identifier based on defines in
sqlmon.h, and is one of:
v LOCAL
v REMOTE
DB_CONN_TIME TIMESTAMP db_conn_time - Database activation
timestamp
LAST_RESET TIMESTAMP last_reset - Last reset timestamp
LAST_BACKUP TIMESTAMP last_backup - Last backup timestamp
480 Administrative Routines and Views
Table 152. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
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 locks_held - Locks held
LOCK_WAITS BIGINT lock_waits - Lock waits
LOCK_WAIT_TIME BIGINT lock_wait_time - Time waited on locks
LOCK_LIST_IN_USE BIGINT lock_list_in_use - Total lock list memory in
use
DEADLOCKS BIGINT deadlocks - Deadlocks detected
LOCK_ESCALS BIGINT lock_escals - Number of lock escalations
X_LOCK_ESCALS BIGINT x_lock_escals - Exclusive lock escalations
LOCKS_WAITING BIGINT locks_waiting - Current agents waiting on
locks
LOCK_TIMEOUTS BIGINT lock_timeouts - Number of lock timeouts
NUM_INDOUBT_TRANS BIGINT num_indoubt_trans - Number of indoubt
transactions
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
water mark
POST_SHRTHRESHOLD_SORTS BIGINT post_shrthreshold_sorts - Post shared
threshold sorts
TOTAL_SORTS BIGINT total_sorts - Total sorts
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
ACTIVE_SORTS BIGINT active_sorts - Active sorts
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool data logical
reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool data physical
reads
Chapter 3. Supported routines and views 481
Table 152. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer pool
temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer pool
temporary data physical reads
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer pool
asynchronous data reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data writes
POOL_ASYNC_DATA_WRITES BIGINT pool_async_data_writes - Buffer pool
asynchronous data writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool index logical
reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool index
physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer pool
temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer pool
temporary index physical reads
POOL_ASYNC_INDEX_READS BIGINT pool_async_index_reads - Buffer pool
asynchronous index reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool index writes
POOL_ASYNC_INDEX_WRITES BIGINT pool_async_index_writes - Buffer pool
asynchronous index writes
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool XDA Data
Physical Reads
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool XDA Data
Logical Reads
POOL_XDA_WRITES BIGINT pool_xda_writes - Buffer Pool XDA Data
Writes
POOL_ASYNC_XDA_READS BIGINT pool_async_xda_reads - Buffer Pool
Asynchronous XDA Data Reads
POOL_ASYNC_XDA_WRITES BIGINT pool_async_xda_writes - Buffer Pool
Asynchronous XDA Data Writes
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer Pool
Temporary XDA Data Physical Reads monitor
element
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer Pool
Temporary XDA Data Logical Reads
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
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
482 Administrative Routines and Views
Table 152. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
BIGINT pool_async_data_read_reqs - Buffer pool
POOL_ASYNC_DATA_ asynchronous read requests
READ_REQS
BIGINT pool_async_index_read_reqs - Buffer pool
POOL_ASYNC_INDEX_ asynchronous index read requests
READ_REQS
BIGINT pool_async_xda_read_reqs - Buffer Pool
POOL_ASYNC_XDA_ Asynchronous XDA Read Requests
READ_REQS
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
PREFETCH_WAIT_TIME BIGINT prefetch_wait_time - Time waited for prefetch
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread prefetch
pages
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write time
FILES_CLOSED BIGINT files_closed - Database files closed
ELAPSED_EXEC_TIME_S BIGINT elapsed_exec_time - Statement execution
elapsed time
ELAPSED_EXEC_TIME_MS BIGINT elapsed_exec_time - Statement execution
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 dynamic_sql_stmts - Dynamic SQL
statements attempted
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
Chapter 3. Supported routines and views 483
Table 152. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
DDL_SQL_STMTS BIGINT ddl_sql_stmts - Data definition language
(DDL) SQL statements
INT_AUTO_REBINDS BIGINT int_auto_rebinds - Internal automatic rebinds
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
INT_COMMITS BIGINT int_commits - Internal commits
INT_ROLLBACKS BIGINT int_rollbacks - Internal rollbacks
INT_DEADLOCK_ROLLBACKS BIGINT int_deadlock_rollbacks - Internal rollbacks
due to deadlock
ROWS_DELETED BIGINT rows_deleted - Rows deleted
ROWS_INSERTED BIGINT rows_inserted - Rows inserted
ROWS_UPDATED BIGINT rows_updated - Rows updated
ROWS_SELECTED BIGINT rows_selected - Rows selected
ROWS_READ BIGINT rows_read - Rows read
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_read_time - Log read time
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 log_write_time - Log write time
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
NUM_LOG_PART_PAGE_IO 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
BIGINT num_log_data_found_in_buffer - Number of
NUM_LOG_DATA_FOUND_ log data found in buffer
IN_BUFFER
APPL_ID_OLDEST_XACT BIGINT appl_id_oldest_xact - Application with oldest
transaction
484 Administrative Routines and Views
Table 152. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
BIGINT log_to_redo_for_recovery - Amount of log to
LOG_TO_REDO_FOR_ be redone for recovery
RECOVERY
LOG_HELD_BY_DIRTY_PAGES BIGINT log_held_by_dirty_pages - Amount of log
space accounted for by dirty pages
PKG_CACHE_LOOKUPS BIGINT pkg_cache_lookups - Package cache lookups
PKG_CACHE_INSERTS BIGINT pkg_cache_inserts - Package cache inserts
BIGINT pkg_cache_num_overflows - Package cache
PKG_CACHE_NUM_ overflows
OVERFLOWS
PKG_CACHE_SIZE_TOP BIGINT pkg_cache_size_top - Package cache high
water mark
APPL_SECTION_LOOKUPS BIGINT appl_section_lookups - Section lookups
APPL_SECTION_INSERTS BIGINT appl_section_inserts - Section 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
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
BIGINT priv_workspace_num_overflows - Private
PRIV_WORKSPACE_NUM_ workspace overflows
OVERFLOWS
BIGINT priv_workspace_section_inserts - Private
PRIV_WORKSPACE_SECTION_ workspace section inserts
INSERTS
BIGINT priv_workspace_section_lookups - Private
PRIV_WORKSPACE_SECTION_ workspace section lookups
LOOKUPS
SHR_WORKSPACE_SIZE_TOP BIGINT shr_workspace_size_top - Maximum shared
workspace size
BIGINT shr_workspace_num_overflows - Shared
SHR_WORKSPACE_NUM_ workspace overflows
OVERFLOWS
BIGINT shr_workspace_section_inserts - Shared
SHR_WORKSPACE_SECTION_ workspace section inserts
INSERTS
BIGINT shr_workspace_section_lookups - Shared
SHR_WORKSPACE_SECTION_ workspace section lookups
LOOKUPS
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
Chapter 3. Supported routines and views 485
Table 152. Information returned by the SNAPDB administrative view and SNAP_GET_DB_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
BIGINT hash_join_small_overflows - Hash join small
HASH_JOIN_SMALL_ overflows
OVERFLOWS
BIGINT post_shrthreshold_hash_joins - Post threshold
POST_SHRTHRESHOLD_ hash joins
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 The database partition from which the data
was retrieved for this row.
INTEGER smallest_log_avail_node - Node with least
SMALLEST_LOG_AVAIL_ available log space
NODE
TOTAL_OLAP_FUNCS BIGINT The total number of OLAP functions
executed.
OLAP_FUNC_OVERFLOWS BIGINT The number of times that OLAP function
data exceeded the available sort heap space.
ACTIVE_OLAP_FUNCS BIGINT The total number of OLAP functions that are
currently running and consuming sort heap
memory.
STATS_CACHE_SIZE BIGINT The size of the statistics cache in bytes
STATS_FABRICATIONS BIGINT Total number of statistics-collect activities for
creating statistics by the system without table
or index scan.
SYNC_RUNSTATS BIGINT Total number of synchronous statistics-collect
activities during query compilation.
ASYNC_RUNSTATS BIGINT We will change the output for this column to
total number of successful asynchronous
statistics-collect activities.
STATS_FABRICATE_TIME BIGINT Total time spent on creating statistics by
system without table or index scan during
query compilation in milliseconds.
SYNC_RUNSTATS_TIME BIGINT Total time spent on synchronous
statistics-collect activities in milliseconds.
NUM_THRESHOLD_VIOLATIONS BIGINT The number of threshold violations that have
occurred at the database.
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.
486 Administrative Routines and Views
SNAPDB_MEMORY_POOL administrative view
This administrative view allows you to retrieve database level memory usage
information for the currently connected database.
Used with the SNAPDB, SNAPDETAILLOG, SNAPHADR and
SNAPSTORAGE_PATHS administrative views, the SNAPDB_MEMORY_POOL
administrative view provides information equivalent to the GET SNAPSHOT FOR
DATABASE ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 123 on page 365 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPDB_MEMORY_POOL
administrative view and EXECUTE privilege on the
SNAP_GET_DB_MEMORY_POOL table function.
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
The following is an example of output from this query.
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
12 record(s) selected.
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 partition, aggregate of
all database partitions or all database partitions.
Used with the SNAP_GET_DB_V95, SNAP_GET_DETAILLOG_V91,
SNAP_GET_HADR and SNAP_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.
Chapter 3. Supported routines and views 487
Refer to Table 123 on page 365 for a complete list of information that can be
returned.
Syntax
SNAP_GET_DB_MEMORY_POOL ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_DB_MEMORY_POOL table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DB_MEMORY_POOL table function.
Example
Retrieve a list of memory pools and their current size for all databases.
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
The following is an example of output from this query.
DB_NAME POOL_ID POOL_CUR_SIZE
-------- -------------- --------------------
TESTDB UTILITY 65536
TESTDB PACKAGE_CACHE 851968
TESTDB CAT_CACHE 65536
TESTDB BP 35913728
TESTDB BP 589824
TESTDB BP 327680
488 Administrative Routines and Views
TESTDB BP 196608
TESTDB BP 131072
TESTDB SHARED_SORT 65536
TESTDB LOCK_MGR 10092544
TESTDB DATABASE 4980736
TESTDB OTHER 196608
SAMPLE UTILITY 65536
SAMPLE PACKAGE_CACHE 655360
SAMPLE CAT_CACHE 131072
SAMPLE BP 4325376
SAMPLE BP 589824
SAMPLE BP 327680
SAMPLE BP 196608
SAMPLE BP 131072
SAMPLE SHARED_SORT 0
SAMPLE LOCK_MGR 655360
SAMPLE DATABASE 4653056
SAMPLE OTHER 196608
24 record(s) selected.
Information returned
Table 153. Information returned by the SNAPDB_MEMORY_POOL administrative view and
the SNAP_GET_DB_MEMORY_POOL table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
POOL_ID VARCHAR(14) pool_id - Memory pool identifier.
This interface returns a text
identifier based on defines in
sqlmon.h, and is one of:
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
Chapter 3. Supported routines and views 489
Table 153. Information returned by the SNAPDB_MEMORY_POOL administrative view and
the SNAP_GET_DB_MEMORY_POOL table function (continued)
Description or corresponding
Column name Data type monitor element
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
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPDBM administrative view and SNAP_GET_DBM_V95
table function - Retrieve the dbm logical grouping snapshot
information
The SNAPDBM administrative view and the SNAP_GET_DBM_V95 table function
return the snapshot monitor DB2 database manager (dbm) logical grouping
information.
SNAPDBM administrative view
Used with the SNAPDBM_MEMORY_POOL, SNAPFCM, SNAPFCM_PART and
SNAPSWITCHES administrative views, the SNAPDBM administrative view
provides the data equivalent to the GET SNAPSHOT FOR DBM command.
The schema is SYSIBMADM.
Refer to Table 124 on page 368 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPDBM administrative view and
EXECUTE privilege on the SNAP_GET_DBM_V95 table function.
Example
Retrieve database manager status and connection information for all database
partitions.
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
The following is an example of output from this query.
DB2_STATUS DB2START_TIME LAST_RESET ...
------------ -------------------------- ----------...- ...
ACTIVE 2006-01-06-14.59.59.059879 - ...
ACTIVE 2006-01-06-14.59.59.097605 - ...
ACTIVE 2006-01-06-14.59.59.062798 - ...
3 record(s) selected. ...
490 Administrative Routines and Views
Output from this query (continued).
... LOCAL_CONS REM_CONS_IN AGENT_USAGE DBPARTITIONNUM
... ----------...- -----------...- -----------...- --------------
... 1 1 0 0
... 0 0 0 1
... 0 0 0 2
SNAP_GET_DBM_V95 table function
The SNAP_GET_DBM_V95 table function returns the same information as the
SNAPDBM administrative view, but allows you to retrieve the information for a
specific database partition, aggregate of all database partitions or all database
partitions.
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_V95 table function provides the data equivalent to the GET
SNAPSHOT FOR DBM command.
Refer to Table 124 on page 368 for a complete list of information that can be
returned.
Syntax
SNAP_GET_DBM_V95 ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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_DBM_V95 table function calls the snapshot from memory.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DBM_V95 table function.
Example
Retrieve the start time and current status of database partition number 2.
SELECT DB2START_TIME, DB2_STATUS FROM TABLE(SNAP_GET_DBM_V95(2)) AS T
The following is an example of output from this query.
Chapter 3. Supported routines and views 491
DB2START_TIME DB2_STATUS
-------------------------- ------------
2006-01-06-14.59.59.062798 ACTIVE
Information returned
Table 154. Information returned by the SNAPDBM administrative view and the SNAP_GET_DBM_V95 table function
Description or corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was
taken.
SORT_HEAP_ALLOCATED BIGINT sort_heap_allocated - Total sort heap
allocated
POST_THRESHOLD_SORTS BIGINT post_threshold_sorts - Post threshold sorts
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
Executing in the Database Manager monitor
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
This interface returns a text identifier based
on defines in sqlmon.h, and is one of:
v ACTIVE
v QUIESCE_PEND
v QUIESCED
AGENTS_REGISTERED_TOP BIGINT agents_registered_top - Maximum number
of agents registered
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 coord_agents_top - Maximum number of
coordinating agents
492 Administrative Routines and Views
Table 154. Information returned by the SNAPDBM administrative view and the SNAP_GET_DBM_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
MAX_AGENT_OVERFLOWS BIGINT max_agent_overflows - Maximum agent
overflows
AGENTS_STOLEN BIGINT agents_stolen - Stolen agents
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
connections for DB2 Connect
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 last_reset - 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 The database partition from which the data
was retrieved for this row.
POST_THRESHOLD_OLAP_FUNCS BIGINT The number of OLAP functions which have
requested a sort heap after the sort heap
threshold has been exceeded.
Sorts, hash joins, and OLAP functions are
examples of operations which utilize a sort
heap. Under normal conditions, the
database manager will allocate sort heap
using the value specified by the sortheap
configuration parameter. If the amount of
memory allocated to sort heaps exceeds the
sort heap threshold (sheapthres
configuration parameter), the database
manager will allocate subsequent sort heaps
using a value less than that specified by the
sortheap configuration parameter.
OLAP functions which start after the sort
heap threshold has been reached may not
receive an optimum amount of memory to
execute.
Chapter 3. Supported routines and views 493
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.
SNAPDBM_MEMORY_POOL administrative view
Used with the SNAPDBM, SNAPFCM, SNAPFCM_PART and SNAPSWITCHES
administrative views, the SNAPDBM_MEMORY_POOL administrative view
provides the data equivalent to the GET SNAPSHOT FOR DBM command.
The schema is SYSIBMADM.
Refer to Table 125 on page 372 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPDBM_MEMORY_POOL
administrative view and EXECUTE privilege on the
SNAP_GET_DBM_MEMORY_POOL table function.
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
The following is an example of output from this query.
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 partition, aggregate of all
database partitions or all database partitions.
Used with the SNAP_GET_DBM_V95, 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.
Refer to Table 125 on page 372 for a complete list of information that can be
returned.
494 Administrative Routines and Views
Syntax
SNAP_GET_DBM_MEMORY_POOL ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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_DBM_MEMORY_POOL table function takes a snapshot for the
currently connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DBM_MEMORY_POOL table function.
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
The following is an example of output from this query.
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
Chapter 3. Supported routines and views 495
Information returned
Table 155. Information returned by the SNAPDBM_MEMORY_POOL administrative view and
the SNAP_GET_DBM_MEMORY_POOL table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
POOL_ID VARCHAR(14) pool_id - Memory pool identifier.
This interface returns a text
identifier based on defines in
sqlmon.h, and is one of:
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
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPDETAILLOG administrative view and
SNAP_GET_DETAILLOG_V91 table function - Retrieve
snapshot information from the detail_log logical data group
The SNAPDETAILLOG administrative view and the SNAP_GET_DETAILLOG_V91
table function return snapshot information from the detail_log logical data group.
496 Administrative Routines and Views
SNAPDETAILLOG administrative view
This administrative view allows you to retrieve snapshot information from the
detail_log logical data group for the currently connected database.
Used in conjunction with the SNAPDB, SNAPDB_MEMORY_POOL, SNAPHADR
and SNAPSTORAGE_PATHS administrative views, the SNAPDETAILLOG
administrative view provides information equivalent to the GET SNAPSHOT FOR
DATABASE on database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 126 on page 375 for a complete list of information that is returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPDETAILLOG administrative view
and EXECUTE privilege on the SNAP_GET_DETAILLOG_V91 table function.
Example
Retrieve log information for all database partitions 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
The following is an example of output from this query.
DB_NAME FIRST_ACTIVE_LOG LAST_ACTIVE_LOG ...
-------- -------------------- -------------------- ...
TEST 0 8 ...
TEST 0 8 ...
TEST 0 8 ...
...
3 record(s) selected. ...
Output from this query (continued).
... CURRENT_ACTIVE_LOG CURRENT_ARCHIVE_LOG DBPARTITIONNUM
... -------------------- -------------------- --------------
... 0 - 0
... 0 - 1
... 0 - 2
SNAP_GET_DETAILLOG_V91 table function
The SNAP_GET_DETAILLOG_V91 table function returns the same information as
the SNAPDETAILLOG administrative view.
Used in conjunction with the SNAP_GET_DB_V95,
SNAP_GET_DB_MEMORY_POOL, SNAP_GET_HADR and
SNAP_GET_STORAGE_PATHS table functions, the SNAP_GET_DETAILLOG table
function provides information equivalent to the GET SNAPSHOT FOR ALL
DATABASES CLP command.
Refer to Table 126 on page 375 for a complete list of information that is returned.
Chapter 3. Supported routines and views 497
Syntax
SNAP_GET_DETAILLOG_V91 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_DETAILLOG_V91 table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DETAILLOG_V91 table function.
Example
Retrieve log information for database partition 1 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
FROM TABLE(SNAP_GET_DETAILLOG_V91(’’, 1)) AS T
The following is an example of output from this query.
DB_NAME FIRST_ACTIVE_LOG LAST_ACTIVE_LOG ...
-------- -------------------- -------------------- ...
TEST 0 8 ...
...
1 record(s) selected. ...
Output from this query (continued).
498 Administrative Routines and Views
... CURRENT_ACTIVE_LOG CURRENT_ARCHIVE_LOG
... -------------------- --------------------
... 0 -
...
...
SNAPDETAILLOG administrative view and
SNAP_GET_DETAILLOG_V91 table function metadata
Table 156. Information returned by the SNAPDETAILLOG administrative view and
SNAP_GET_DETAILLOG_V91 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
FIRST_ACTIVE_LOG BIGINT first_active_log - First active log file
number
LAST_ACTIVE_LOG BIGINT last_active_log - Last active log file
number
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 The database partition from which
the data was retrieved for this row.
SNAPDYN_SQL administrative view and
SNAP_GET_DYN_SQL_V95 table function - Retrieve dynsql
logical group snapshot information
The “SNAPDYN_SQL administrative view” on page 375 and the
“SNAP_GET_DYN_SQL_V95 table function” on page 376 return snapshot
information from the dynsql logical data group.
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.
The schema is SYSIBMADM.
Refer to Table 127 on page 378 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPDYN_SQL administrative view
and EXECUTE privilege on the SNAP_GET_DYN_SQL_V95 table function.
Chapter 3. Supported routines and views 499
Example
Retrieve a list of dynamic SQL run on all database partitions of 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
The following is an example of output from this query.
PREP_TIME_WORST NUM_COMPILATIONS ...
-------------------- -------------------- ...
98 1 ...
9 1 ...
0 0 ...
0 1 ...
0 1 ...
0 1 ...
0 1 ...
0 1 ...
40 1 ...
...
9 record(s) selected.
Output from this query (continued).
... 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, ...
... select prep_time_worst, num_compilations, substr(stmt_text, ...
... select * from dbuser.employee ...
... insert into dbuser.employee values(1) ...
... select * from dbuser.employee ...
... insert into dbuser.employee values(1) ...
Output from this query (continued).
... DBPARTITIONNUM
... --------------
... 0
... 0
... 0
... 2
... 1
... 2
... 2
... 1
... 0
SNAP_GET_DYN_SQL_V95 table function
The SNAP_GET_DYN_SQL_V95 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 partition, aggregate of all database
partitions or all database partitions.
This table function returns information equivalent to the GET SNAPSHOT FOR
DYNAMIC SQL ON database-alias CLP command.
Refer to Table 127 on page 378 for a complete list of information that can be
returned.
500 Administrative Routines and Views
Syntax
SNAP_GET_DYN_SQL_V95 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_DYN_SQL_V95 table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DYN_SQL_V95 table function.
Example
Retrieve a list of dynamic SQL run on the currently connected database partition of
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 FROM TABLE(SNAP_GET_DYN_SQL_V95(’’,-1)) as T
ORDER BY ROWS_READ
The following is an example of output from this query.
PREP_TIME_WORST ...
-------------------- ...
0 ...
3 ...
...
4 ...
...
4 ...
...
4 ...
...
Chapter 3. Supported routines and views 501
3 ...
...
4 ...
...
Output from this query (continued).
... NUM_COMPILATIONS STMT_TEXT
... -------------------- ---------------------------------------...-
... 0 SET CURRENT LOCALE LC_CTYPE = ’en_US’
... 1 select rows_read, rows_written,
... substr(stmt_text, 1, 40) as
... 1 select * from table
... (snap_get_dyn_sqlv9(’’,-1)) as t
... 1 select * from table
... (snap_getdetaillog9(’’,-1)) as t
... 1 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,
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_V95(’mytestdb’, -1))
AS SNAPDB
STATS_FABRICATE_TIME SYNC_RUNSTATS_TIME
---------------------- ------------------
2 12
1 30
For the view based on this table function:
SELECT STATS_FABRICATE_TIME,SYNC_RUNSTATS_TIME
FROM SYSIBMADM.SNAPDYN_SQL
STATS_FABRICATE_TIME SYNC_RUNSTATS_TIME
---------------------- ------------------
5 10
3 20
2 record(s) selected.
Information returned
Table 157. Information returned by the SNAPDYN_SQL administrative view and the SNAP_GET_DYN_SQL_V95 table
function
Description or corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was
taken.
NUM_EXECUTIONS BIGINT num_executions - Statement executions
NUM_COMPILATIONS BIGINT num_compilations - Statement compilations
PREP_TIME_WORST BIGINT prep_time_worst - Statement worst
preparation time
PREP_TIME_BEST BIGINT prep_time_best - Statement best preparation
time
INT_ROWS_DELETED BIGINT int_rows_deleted - Internal rows deleted
502 Administrative Routines and Views
Table 157. Information returned by the SNAPDYN_SQL administrative view and the SNAP_GET_DYN_SQL_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
INT_ROWS_INSERTED BIGINT int_rows_inserted - Internal rows inserted
INT_ROWS_UPDATED BIGINT int_rows_updated - Internal rows updated
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
STMT_SORTS BIGINT stmt_sorts - Statement sorts
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool data logical
reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool data physical
reads
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer pool
temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer pool
temporary data physical reads
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool index logical
reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool index
physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer pool
temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer pool
temporary index physical reads
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool XDA Data
Logical Reads
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool XDA Data
Physical Reads
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer Pool
Temporary XDA Data Logical Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer Pool
Temporary XDA Data Physical Reads monitor
element
TOTAL_EXEC_TIME BIGINT total_exec_time - Elapsed statement execution
time
TOTAL_EXEC_TIME_MS BIGINT total_exec_time - Elapsed statement execution
time
TOTAL_USR_CPU_TIME BIGINT total_usr_cpu_time - Total user CPU for a
statement
TOTAL_USR_CPU_TIME_MS BIGINT total_usr_cpu_time - Total user CPU for a
statement
TOTAL_SYS_CPU_TIME BIGINT total_sys_cpu_time - Total system CPU for a
statement
TOTAL_SYS_CPU_TIME_MS BIGINT total_sys_cpu_time - Total system CPU for a
statement
Chapter 3. Supported routines and views 503
Table 157. Information returned by the SNAPDYN_SQL administrative view and the SNAP_GET_DYN_SQL_V95 table
function (continued)
Description or corresponding monitor
Column name Data type element
STMT_TEXT CLOB(2 M) stmt_text - SQL statement text
DBPARTITIONNUM SMALLINT The database partition from which the data
was retrieved for this row.
STATS_FABRICATE_TIME 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.
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.
SNAPFCM administrative view
Used with the SNAPDBM, SNAPDBM_MEMORY_POOL, SNAPFCM_PART and
SNAPSWITCHES administrative views, the SNAPFCM administrative view
provides the data equivalent to the GET SNAPSHOT FOR DBM command.
The schema is SYSIBMADM.
Refer to Table 128 on page 382 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPFCM administrative view and
EXECUTE privilege on the SNAP_GET_FCM table function.
Example
Retrieve information about the fast communication manager’s message buffers on
all database partitions.
SELECT BUFF_FREE, BUFF_FREE_BOTTOM, DBPARTITIONNUM
FROM SYSIBMADM.SNAPFCM ORDER BY DBPARTITIONNUM
The following is an example of output from this query.
BUFF_FREE BUFF_FREE_BOTTOM DBPARTITIONNUM
---------...---- -------------------- --------------
5120 5100 0
5120 5100 1
5120 5100 2
504 Administrative Routines and Views
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
specific database partition, aggregate of all database partitions or all database
partitions.
Used with the SNAP_GET_DBM_V95, SNAP_GET_DBM_MEMORY_POOL,
SNAP_GET_FCM_PART and SNAP_GET_SWITCHES table functions, the
SNAP_GET_FCM table function provides the data equivalent to the GET
SNAPSHOT FOR DBM command.
Refer to Table 128 on page 382 for a complete list of information that can be
returned.
Syntax
SNAP_GET_FCM ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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_FCM table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_FCM table function.
Example
Retrieve information about the fast communication manager’s message buffers on
database partition 1.
SELECT BUFF_FREE, BUFF_FREE_BOTTOM, DBPARTITIONNUM
FROM TABLE(SYSPROC.SNAP_GET_FCM( 1 )) AS T
The following is an example of output from this query.
BUFF_FREE BUFF_FREE_BOTTOM DBPARTITIONNUM
-------------------- -------------------- --------------
5120 5100 1
Chapter 3. Supported routines and views 505
Information returned
Table 158. Information returned by the SNAPFCM administrative view and the
SNAP_GET_FCM table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
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 The database partition from which
the data was retrieved for this row.
SNAPFCM_PART administrative view and
SNAP_GET_FCM_PART table function – Retrieve the
fcm_node logical data group snapshot information
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.
SNAPFCM_PART administrative view
Used with the SNAPDBM, SNAPDBM_MEMORY_POOL, SNAPFCM and
SNAPSWITCHES administrative views, the SNAPFCM_PART administrative view
provides the data equivalent to the GET SNAPSHOT FOR DBM command.
The schema is SYSIBMADM.
Refer to Table 129 on page 384 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPFCM_PART administrative view
and EXECUTE privilege on the SNAP_GET_FCM_PART table function.
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 DBPARTITIONNUM = 0
The following is an example of output from this query.
506 Administrative Routines and Views
CONNECTION_STATUS TOTAL_BUFFERS_SENT TOTAL_BUFFERS_RCVD
-------------------- -------------------- --------------------
INACTIVE 2 1
1 record(s) selected.
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
for a specific database partition, aggregate of all database partitions or all database
partitions.
Used with the SNAP_GET_DBM_V95, SNAP_GET_DBM_MEMORY_POOL,
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.
Refer to Table 129 on page 384 for a complete list of information that can be
returned.
Syntax
SNAP_GET_FCM_PART ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current partition, or -2 for an aggregate of
all active database partitions. If this input option is not used, data will be
returned from all active database partitions. An active database partition is a
partition where the database is available for connection and use by
applications.
If dbpartitionnum 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_FCM_PART table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_FCM_PART table function.
Example
Retrieve buffers sent and received information for the fast communication manager
for all database partitions.
SELECT FCM_DBPARTITIONNUM, TOTAL_BUFFERS_SENT, TOTAL_BUFFERS_RCVD,
DBPARTITIONNUM FROM TABLE(SNAP_GET_FCM_PART()) AS T
ORDER BY DBPARTITIONNUM
Chapter 3. Supported routines and views 507
The following is an example of output from this query.
FCM_DBPARTITIONNUM TOTAL_BUFFERS_SENT TOTAL_BUFFERS_RCVD DBPARTITIONNUM
------------------ -------------------- -------------------- --------------
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
Information returned
Table 159. Information returned by the SNAPFCM_PART administrative view and the
SNAP_GET_FCM_PART table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
CONNECTION_STATUS VARCHAR(10) connection_status - Connection
status. This interface returns a text
identifier based on the defines in
sqlmon.h and is one of:
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 The database partition from which
the data was retrieved for this row.
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).
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.
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.
508 Administrative Routines and Views
Used with the SNAPDB, SNAPDB_MEMORY_POOL, SNAPDETAILLOG and
SNAPSTORAGE_PATHS administrative views, the SNAPHADR administrative
view provides information equivalent to the GET SNAPSHOT FOR DATABASE
ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 130 on page 386 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPHADR administrative view and
EXECUTE privilege on the SNAP_GET_HADR table function.
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
The following is an example of output from this query.
DBNAME HADR_ROLE HADR_STATE HADR_SYNCMODE HADR_CONNECT_STATUS
-------- --------- -------------- ------------- -------------------
SAMPLE PRIMARY PEER SYNC CONNECTED
1 record(s) selected.
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
specific database on a specific database partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_DB_V95, SNAP_GET_DB_MEMORY_POOL,
SNAP_GET_DETAILLOG_V91 and SNAP_GET_STORAGE_PATHS table functions,
the SNAP_GET_HADR table function provides information equivalent to the GET
SNAPSHOT FOR ALL DATABASES CLP command.
Refer to Table 130 on page 386 for a complete list of information that can be
returned.
Syntax
SNAP_GET_HADR ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
Chapter 3. Supported routines and views 509
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_HADR table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_HADR table function.
Example
Retrieve the configuration and status information for HADR for all databases.
SELECT SUBSTR(DB_NAME, 1, 8) AS DBNAME, HADR_ROLE, HADR_STATE,
HADR_SYNCMODE, HADR_CONNECT_STATUS
FROM TABLE (SNAP_GET_HADR (CAST (NULL as VARCHAR(128)), 0)) as T
The following is an example of output from this query.
DBNAME HADR_ROLE HADR_STATE HADR_SYNCMODE HADR_CONNECT_STATUS
-------- --------- -------------- ------------- -------------------
SAMPLE PRIMARY PEER SYNC CONNECTED
TESTDB PRIMARY DISCONNECTED NEARSYNC DISCONNECTED
2 record(s) selected.
Information returned
Table 160. Information returned by the SNAPHADR administrative view and the
SNAP_GET_HADR table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
510 Administrative Routines and Views
Table 160. Information returned by the SNAPHADR administrative view and the
SNAP_GET_HADR table function (continued)
Description or corresponding
Column name Data type monitor element
HADR_ROLE VARCHAR(10) hadr_role - HADR role. This
interface returns a text identifier
based on the defines in sqlmon.h,
and is one of:
v PRIMARY
v STANDARD
v STANDBY
HADR_STATE VARCHAR(14) hadr_state - HADR state. This
interface returns a text identifier
based on the defines in sqlmon.h,
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
interface returns a text identifier
based on the defines in sqlmon.h,
and is one of:
v ASYNC
v NEARSYNC
v SYNC
HADR_CONNECT_STATUS VARCHAR(12) 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
Chapter 3. Supported routines and views 511
Table 160. Information returned by the SNAPHADR administrative view and the
SNAP_GET_HADR table function (continued)
Description or corresponding
Column name Data type monitor element
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 The database partition from which
the data was retrieved for this row.
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.
SNAPLOCK administrative view
This administrative view allows you to retrieve lock logical data group snapshot
information for the currently connected database.
Used with the SNAPLOCKWAIT administrative view, the SNAPLOCK
administrative view provides information equivalent to the GET SNAPSHOT FOR
LOCKS ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 131 on page 390 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPLOCK administrative view and
EXECUTE privilege on the SNAP_GET_LOCK table function.
Example
Retrieve lock information for the database partition 0 of the currently connected
database.
512 Administrative Routines and Views
SELECT AGENT_ID, LOCK_OBJECT_TYPE, LOCK_MODE, LOCK_STATUS
FROM SYSIBMADM.SNAPLOCK WHERE DBPARTITIONNUM = 0
The following is an example of output from this query.
AGENT_ID LOCK_OBJECT_TYPE LOCK_MODE LOCK_STATUS
-------------------- ---------------- --------- -----------
7 TABLE IX GRNT
1 record(s) selected.
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
specific database on a specific database partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_LOCKWAIT table function, the SNAP_GET_LOCK table
function provides information equivalent to the GET SNAPSHOT FOR LOCKS ON
database-alias CLP command.
Refer to Table 131 on page 390 for a complete list of information that can be
returned.
Syntax
SNAP_GET_LOCK ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 a null
value or empty string to take the snapshot from the currently connected
database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_LOCK table function takes a snapshot for the currently connected
database and database partition number.
Chapter 3. Supported routines and views 513
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_LOCK table function.
Example
Retrieve lock information for the current database partition of the currently
connected database.
SELECT AGENT_ID, LOCK_OBJECT_TYPE, LOCK_MODE, LOCK_STATUS
FROM TABLE(SNAP_GET_LOCK(’’,-1)) as T
The following is an example of output from this query.
AGENT_ID LOCK_OBJECT_TYPE LOCK_MODE LOCK_STATUS
--------...--- ------------------ ---------- -----------
680 INTERNALV_LOCK S GRNT
680 INTERNALP_LOCK S GRNT
2 record(s) selected.
Information returned
Table 161. Information returned by the SNAPLOCK administrative view and the
SNAP_GET_LOCK table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
TAB_FILE_ID BIGINT table_file_id - Table file
identification
514 Administrative Routines and Views
Table 161. Information returned by the SNAPLOCK administrative view and the
SNAP_GET_LOCK table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_OBJECT_TYPE VARCHAR(18) lock_object_type - Lock object type
waited on. This interface returns a
text identifier based on the defines
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
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
Chapter 3. Supported routines and views 515
Table 161. Information returned by the SNAPLOCK administrative view and the
SNAP_GET_LOCK table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_STATUS VARCHAR(10) lock_status - Lock status. This
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v CONV
v GRNT
LOCK_ESCALATION SMALLINT lock_escalation - Lock escalation
TABNAME VARCHAR(128) table_name - Table name
TABSCHEMA VARCHAR(128) table_schema - Table schema name
TBSP_NAME VARCHAR(128) tablespace_name - Table space
name
LOCK_ATTRIBUTES VARCHAR(128) lock_attributes - Lock attributes.
This interface returns a text
identifier based on the defines in
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
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
516 Administrative Routines and Views
Table 161. Information returned by the SNAPLOCK administrative view and the
SNAP_GET_LOCK table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_HOLD_COUNT BIGINT lock_hold_count - Lock hold count
LOCK_NAME VARCHAR(32) lock_name - Lock name
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 The database partition from which
the data was retrieved for this row.
SNAPLOCKWAIT administrative view and
SNAP_GET_LOCKWAIT table function – Retrieve lockwait
logical data group snapshot information
The SNAPLOCKWAIT administrative view and the SNAP_GET_LOCKWAIT table
function return snapshot information about lock waits, in particular, the lockwait
logical data group.
SNAPLOCKWAIT administrative view
This administrative view allows you to retrieve lockwait logical data group
snapshot information for the currently connected database.
Used with the SNAPLOCK administrative view, the SNAPLOCKWAIT
administrative view provides information equivalent to the GET SNAPSHOT FOR
LOCKS ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 132 on page 395 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPLOCKWAIT administrative view
and EXECUTE privilege on the SNAP_GET_LOCKWAIT table function.
Example
Retrieve lock wait information on database partition 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
The following is an example of output from this query.
Chapter 3. Supported routines and views 517
AGENT_ID LOCK_MODE LOCK_OBJECT_TYPE ...
--------...- --------- ---------------- ...
7 IX TABLE ...
1 record(s) selected.
Output from this query (continued).
... 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
for a specific database on a specific database partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_LOCK table function, the SNAP_GET_LOCKWAIT table
function provides information equivalent to the GET SNAPSHOT FOR LOCKS ON
database-alias CLP command.
Refer to Table 132 on page 395 for a complete list of information that can be
returned.
Syntax
SNAP_GET_LOCKWAIT ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 a null
value or empty string to take the snapshot from the currently connected
database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_LOCKWAIT table function takes a snapshot for the currently
connected database and database partition number.
518 Administrative Routines and Views
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_LOCKWAIT table function.
Example
Retrieve lock wait information on current database partition for the currently
connected database.
SELECT AGENT_ID, LOCK_MODE, LOCK_OBJECT_TYPE, AGENT_ID_HOLDING_LK,
LOCK_MODE_REQUESTED FROM TABLE(SNAP_GET_LOCKWAIT(’’,-1)) AS T
The following is an example of output from this query.
AGENT_ID LOCK_MODE LOCK_OBJECT_TYPE ...
--------...-- ---------- ------------------ ...
12 X ROW_LOCK ...
1 record(s) selected.
Output from this query (continued).
... AGENT_ID_HOLDING_LK LOCK_MODE_REQUESTED
... -------------------- -------------------
... 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.
Information returned
Table 162. Information returned by the SNAPLOCKWAIT administrative view and the
SNAP_GET_LOCKWAIT table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
SUBSECTION_NUMBER BIGINT ss_number - Subsection number
Chapter 3. Supported routines and views 519
Table 162. Information returned by the SNAPLOCKWAIT administrative view and the
SNAP_GET_LOCKWAIT table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_MODE VARCHAR(10) lock_mode - Lock mode. This
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
LOCK_OBJECT_TYPE VARCHAR(18) lock_object_type - Lock object type
waited on. This interface returns a
text identifier based on the defines
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
520 Administrative Routines and Views
Table 162. Information returned by the SNAPLOCKWAIT administrative view and the
SNAP_GET_LOCKWAIT table function (continued)
Description or corresponding
Column name Data type monitor element
AGENT_ID_HOLDING_LK BIGINT agent_id_holding_lock - Agent ID
holding lock
LOCK_WAIT_START_TIME TIMESTAMP lock_wait_start_time - Lock wait
start timestamp
LOCK_MODE_REQUESTED VARCHAR(10) lock_mode_requested - Lock mode
requested. This interface returns a
text identifier based on the defines
in sqlmon.h and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
LOCK_ESCALATION SMALLINT lock_escalation - Lock escalation
TABNAME VARCHAR(128) table_name - Table name
TABSCHEMA VARCHAR(128) table_schema - Table schema name
TBSP_NAME VARCHAR(128) tablespace_name - Table space
name
APPL_ID_HOLDING_LK VARCHAR(128) appl_id_holding_lk - Application
ID holding lock
LOCK_ATTRIBUTES VARCHAR(128) lock_attributes - Lock attributes.
This interface returns a text
identifier based on the defines in
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
Chapter 3. Supported routines and views 521
Table 162. Information returned by the SNAPLOCKWAIT administrative view and the
SNAP_GET_LOCKWAIT table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_CURRENT_MODE VARCHAR(10) lock_current_mode - Original lock
mode before conversion. This
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v IN
v IS
v IX
v NON (if no lock)
v NS
v NW
v NX
v S
v SIX
v U
v W
v X
v Z
LOCK_NAME VARCHAR(32) lock_name - Lock name
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 The database partition from which
the data was retrieved for this row.
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.
SNAPSTMT administrative view
This administrative view allows you to retrieve statement snapshot information for
the currently connected database.
Used with the SNAPAGENT, SNAPAGENT_MEMORY_POOL, SNAPAPPL,
SNAPAPPL_INFO and SNAPSUBSECTION administrative views, the SNAPSTMT
administrative view provides information equivalent to the GET SNAPSHOT FOR
APPLICATIONS on database-alias CLP command, but retrieves data from all
database partitions.
The schema is SYSIBMADM.
522 Administrative Routines and Views
Refer to Table 133 on page 400 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPSTMT administrative view and
EXECUTE privilege on the SNAP_GET_STMT table function.
Example
Retrieve rows read, written and operation performed for statements executed on
the currently connected single-partition database.
SELECT SUBSTR(STMT_TEXT,1,30) AS STMT_TEXT, ROWS_READ, ROWS_WRITTEN,
STMT_OPERATION FROM SYSIBMADM.SNAPSTMT
The following is an example of output from this query.
STMT_TEXT ROWS_READ ROWS_WRITTEN STMT_OPERATION
---------...- ---------...- ------------...- --------------------
- 0 0 FETCH
- 0 0 STATIC_COMMIT
2 record(s) selected.
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
specific database on a specific database partition, aggregate of all database
partitions or all database partitions.
Used with the SNAP_GET_AGENT, SNAP_GET_AGENT_MEMORY_POOL,
SNAP_GET_APPL_V95, SNAP_GET_APPL_INFO_V95 and
SNAP_GET_SUBSECTION table functions, the SNAP_GET_STMT table function
provides information equivalent to the GET SNAPSHOT FOR ALL
APPLICATIONS CLP command, but retrieves data from all database partitions.
Refer to Table 133 on page 400 for a complete list of information that can be
returned.
Syntax
SNAP_GET_STMT ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
Chapter 3. Supported routines and views 523
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_STMT table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_STMT table function.
Example
Retrieve rows read, written and operation performed for statements executed on
current database partition 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
The following is an example of output from this query.
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 ...
...
5 record(s) selected. ...
Output from this query (continued).
... ROWS_WRITTEN STMT_OPERATION
... ------------...- --------------------
... 0 EXECUTE_IMMEDIATE
... 0 FETCH
... 0 NONE
... 0 NONE
... 1 EXECUTE_IMMEDIATE
...
Information returned
Table 163. Information returned by the SNAPSTMT administrative view and the
SNAP_GET_STMT table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
524 Administrative Routines and Views
Table 163. Information returned by the SNAPSTMT administrative view and the
SNAP_GET_STMT table function (continued)
Description or corresponding
Column name Data type monitor element
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
NUM_AGENTS BIGINT num_agents - Number of agents
working on a statement
AGENTS_TOP BIGINT agents_top - Number of agents
created
STMT_TYPE VARCHAR(20) stmt_type - Statement type. This
interface returns a text identifier
based on defines in sqlmon.h and
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
returns a text identifier based on
defines in sqlmon.h and is one of:
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
Chapter 3. Supported routines and views 525
Table 163. Information returned by the SNAPSTMT administrative view and the
SNAP_GET_STMT table function (continued)
Description or corresponding
Column name Data type monitor element
SECTION_NUMBER BIGINT section_number - Section number
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 stmt_sorts - Statement sorts
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
INT_ROWS_DELETED BIGINT int_rows_deleted - Internal rows
deleted
INT_ROWS_UPDATED BIGINT int_rows_updated - Internal rows
updated
INT_ROWS_INSERTED BIGINT int_rows_inserted - Internal rows
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
STMT_USR_CPU_TIME_MS BIGINT stmt_usr_cpu_time - User CPU
time used by statement
STMT_SYS_CPU_TIME_S BIGINT stmt_sys_cpu_time - System CPU
time used by statement
STMT_SYS_CPU_TIME_MS BIGINT stmt_sys_cpu_time - System CPU
time used by statement
STMT_ELAPSED_TIME_S BIGINT stmt_elapsed_time - Most recent
statement elapsed time
STMT_ELAPSED_TIME_MS BIGINT stmt_elapsed_time - Most recent
statement elapsed time
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) package_name - Package name
STMT_TEXT CLOB(16 M) stmt_text - SQL statement text
CONSISTENCY_TOKEN VARCHAR(128) consistency_token - Package
consistency token
526 Administrative Routines and Views
Table 163. Information returned by the SNAPSTMT administrative view and the
SNAP_GET_STMT table function (continued)
Description or corresponding
Column name Data type monitor element
PACKAGE_VERSION_ID VARCHAR(128) package_version_id - Package
version
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool
XDA Data Logical Reads monitor
element
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool
XDA Data Physical Reads monitor
element
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer
Pool Temporary XDA Data Physical
Reads monitor element
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPSTORAGE_PATHS administrative view and
SNAP_GET_STORAGE_PATHS table function - Retrieve
automatic storage path information
The SNAPSTORAGE_PATHS administrative view and the
SNAP_GET_STORAGE_PATHS 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.
SNAPSTORAGE_PATHS administrative view
This administrative view allows you to retrieve automatic storage path information
for the currently connected database.
Chapter 3. Supported routines and views 527
Used with the SNAPDB, SNAPDETAILLOG, SNAPHADR and
SNAPDB_MEMORY_POOL administrative views, the SNAPSTORAGE_PATHS
administrative view provides information equivalent to the GET SNAPSHOT FOR
DATABASE ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 134 on page 405 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPSTORAGE_PATHS administrative
view and EXECUTE privilege on the SNAP_GET_STORAGE_PATHS table
function.
Example
Retrieve the storage path for the currently connected single-partition 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
The following is an example of output from this query.
DB_NAME DB_STORAGE_PATH HOSTNAME
-------- --------------- ----------
STOPATH d: JESSICAE
1 record(s) selected.
SNAP_GET_STORAGE_PATHS table function
The SNAP_GET_STORAGE_PATHS table function returns the same information as
the SNAPSTORAGE_PATHS 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 with the SNAP_GET_DB_V95, SNAP_GET_DETAILLOG_V91,
SNAP_GET_HADR and SNAP_GET_DB_MEMORY_POOL table functions, the
SNAP_GET_STORAGE_PATHS table function provides information equivalent to
the GET SNAPSHOT FOR ALL DATABASES CLP command.
Refer to Table 134 on page 405 for a complete list of information that can be
returned.
Syntax
SNAP_GET_STORAGE_PATHS ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
528 Administrative Routines and Views
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_STORAGE_PATHS table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_STORAGE_PATHS table function.
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(CAST (NULL AS VARCHAR(128)), -1)) AS T
The following is an example of output from this query.
DB_NAME DB_STORAGE_PATH
-------- -------------------...
STOPATH /home/jessicae/sdb
MYDB /home/jessicae/mdb
2 record(s) selected
Information returned
The BUFFERPOOL monitor switch must be turned on in order for the file system
information to be returned.
Table 164. Information returned by the SNAPSTORAGE_PATHS administrative view and the
SNAP_GET_STORAGE_PATHS table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
DB_STORAGE_PATH VARCHAR(256) db_storage_path - Automatic
storage path
Chapter 3. Supported routines and views 529
Table 164. Information returned by the SNAPSTORAGE_PATHS administrative view and the
SNAP_GET_STORAGE_PATHS table function (continued)
Description or corresponding
Column name Data type monitor element
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
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_sz - Automatic
storage path free space
SNAPSUBSECTION administrative view and
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.
SNAPSUBSECTION administrative view
This administrative view allows you to retrieve subsection logical monitor group
snapshot information for the currently connected database.
Used with the SNAPAGENT, SNAPAGENT_MEMORY_POOL, SNAPAPPL,
SNAPAPPL_INFO and SNAPSTMT administrative views, the SNAPSUBSECTION
administrative view provides information equivalent to the GET SNAPSHOT FOR
APPLICATIONS on database-alias CLP command, but retrieves data from all
database partitions.
The schema is SYSIBMADM.
Refer to Table 135 on page 408 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPSUBSECTION administrative view
and EXECUTE privilege on the SNAP_GET_SUBSECTION table function.
Example
Get status for subsections executing on all database partitions.
SELECT DB_NAME, STMT_TEXT, SS_STATUS, DBPARTITIONNUM
FROM SYSIBMADM.SNAPSUBSECTION
ORDER BY DB_NAME, SS_STATUS, DBPARTITIONNUM
The following is an example of output from this query.
530 Administrative Routines and Views
DB_NAME STMT_TEXT SS_STATUS DBPARTITIONNUM
-------...- ----------------------...- ---------...- --------------
SAMPLE select * from EMPLOYEE EXEC 0
SAMPLE select * from EMPLOYEE EXEC 1
SNAP_GET_SUBSECTION table function
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 partition, aggregate of all
database partitions or all database partitions.
Refer to Table 135 on page 408 for a complete list of information that can be
returned.
Used with the SNAP_GET_AGENT, SNAP_GET_AGENT_MEMORY_POOL,
SNAP_GET_APPL_V95, SNAP_GET_APPL_INFO_V95 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 partitions.
Syntax
SNAP_GET_SUBSECTION ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_SUBSECTION table function takes a snapshot for the currently
connected database and database partition number.
Chapter 3. Supported routines and views 531
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_SUBSECTION table function.
Example
Get status for subsections executing on all database partitions.
SELECT DB_NAME, STMT_TEXT, SS_STATUS, DBPARTITIONNUM
FROM TABLE(SYSPROC.SNAP_GET_SUBSECTION( ’’, 0 )) as T
ORDER BY DB_NAME, SS_STATUS, DBPARTITIONNUM
The following is an example of output from this query.
DB_NAME STMT_TEXT SS_STATUS DBPARTITIONNUM
-------...- ----------------------...- ---------...- --------------
SAMPLE select * from EMPLOYEE EXEC 0
SAMPLE select * from EMPLOYEE EXEC 1
Information returned
Table 165. Information returned by the SNAPSUBSECTION administrative view and the
SNAP_GET_SUBSECTION table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
STMT_TEXT CLOB(16 M) stmt_text - SQL statement text
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 - Current
number 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_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
SS_USR_CPU_TIME_S BIGINT ss_usr_cpu_time - User CPU time
used by subsection
SS_USR_CPU_TIME_MS BIGINT ss_usr_cpu_time - User CPU time
used by subsection
SS_SYS_CPU_TIME_S BIGINT ss_sys_cpu_time - System CPU
time used by subsection
SS_SYS_CPU_TIME_MS BIGINT ss_sys_cpu_time - System CPU
time used by subsection
532 Administrative Routines and Views
Table 165. Information returned by the SNAPSUBSECTION administrative view and the
SNAP_GET_SUBSECTION table function (continued)
Description or corresponding
Column name Data type monitor element
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 The database partition from which
the data was retrieved for this row.
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.
SNAPSWITCHES administrative view
This view provides the data equivalent to the GET DBM MONITOR SWITCHES
CLP command.
The schema is SYSIBMADM.
Refer to Table 136 on page 411 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPSWITCHES administrative view
and EXECUTE privilege on the SNAP_GET_SWITCHES table function.
Example
Retrieve DBM monitor switches state information for all database partitions.
Chapter 3. Supported routines and views 533
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
The following is an example of output from this query.
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.
Output from this query (continued).
... LOCK_SW_STATE SORT_SW_STATE TIMESTAMP_SW_STATE DBPARTITIONNUM
... ------------- ------------- ------------------ --------------
... 1 0 1 0
... 1 0 1 1
... 1 0 1 2
SNAP_GET_SWITCHES table function
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 partition, aggregate of all database partitions or all database
partitions.
This table function provides the data equivalent to the GET DBM MONITOR
SWITCHES CLP command.
Refer to Table 136 on page 411 for a complete list of information that can be
returned.
Syntax
SNAP_GET_SWITCHES ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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
database and database partition number.
534 Administrative Routines and Views
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_SWITCHES table function.
Examples
Retrieve DBM monitor switches state information for the current database
partition.
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
The following is an example of output from this query.
UOW_SW_STATE STATEMENT_SW_STATE TABLE_SW_STATE...
------------ ------------------ --------------...
1 1 1...
...
1 record(s) selected. ...
Output from this query (continued).
... BUFFPOOL_SW_STATE LOCK_SW_STATE SORT_SW_STATE TIMESTAMP_SW_STATE
... ----------------- ------------- ------------- ------------------
... 1 1 0 1
Information returned
Table 166. Information returned by the SNAPSWITCHES administrative view and the
SNAP_GET_SWITCHES table function
Column name Data type Description
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
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
recording switch (0 or 1).
STATEMENT_SW_TIME TIMESTAMP If the SQL statement monitor
recording switch is on, the date and
time that this switch was turned
on.
TABLE_SW_STATE SMALLINT State of the table activity monitor
recording switch (0 or 1).
TABLE_SW_TIME TIMESTAMP If the table activity monitor
recording switch is on, the date and
time that this switch was turned
on.
BUFFPOOL_SW_STATE SMALLINT State of the buffer pool activity
monitor recording switch (0 or 1).
Chapter 3. Supported routines and views 535
Table 166. Information returned by the SNAPSWITCHES administrative view and the
SNAP_GET_SWITCHES table function (continued)
Column name Data type Description
BUFFPOOL_SW_TIME TIMESTAMP If the buffer pool activity monitor
recording switch is on, the date and
time that this switch was 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
recording switch (0 or 1).
SORT_SW_TIME TIMESTAMP If the sorting monitor recording
switch is on, the date and time that
this switch was turned on.
TIMESTAMP_SW_STATE SMALLINT State of the timestamp monitor
recording switch (0 or 1)
TIMESTAMP_SW_TIME TIMESTAMP If the timestamp monitor recording
switch is on, the date and time that
this switch was turned on.
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPTAB administrative view and SNAP_GET_TAB_V91 table
function - Retrieve table logical data group snapshot
information
The SNAPTAB administrative view and the SNAP_GET_TAB_V91 table function
return snapshot information from the table logical data group.
SNAPTAB administrative view
This administrative view allows you to retrieve table logical data group snapshot
information for the currently connected database.
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.
The schema is SYSIBMADM.
Refer to Table 137 on page 414 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPTAB administrative view and
EXECUTE privilege on the SNAP_GET_TAB_V91 table function.
536 Administrative Routines and Views
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
The following is an example of output from this query.
TABSCHEMA TABNAME TAB_TYPE DBPARTITIONNUM
--------- --------------- ------------ --------------
SYSTOOLS HMON_ATM_INFO USER_TABLE 0
1 record selected.
SNAP_GET_TAB_V91 table function
The SNAP_GET_TAB_V91 table function returns the same information as the
SNAPTAB 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_TAB_REORG table function, the
SNAP_GET_TAB_V91 table function returns equivalent information to the GET
SNAPSHOT FOR TABLES ON database-alias CLP command.
Refer to Table 137 on page 414 for a complete list of information that can be
returned.
Syntax
SNAP_GET_TAB_V91 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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
Chapter 3. Supported routines and views 537
SNAP_GET_TAB_V91 table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_TAB_V91 table function.
Example
Retrieve a list of active tables as an aggregate view for the currently connected
database.
SELECT SUBSTR(TABSCHEMA,1,8) AS TABSCHEMA, SUBSTR(TABNAME,1,15) AS TABNAME,
TAB_TYPE, DBPARTITIONNUM FROM TABLE(SNAP_GET_TAB(’’,-2)) AS T
The following is an example of output from this query.
TABSCHEMA TABNAME TAB_TYPE DBPARTITIONNUM
--------- --------------- ------------- --------------
SYSTOOLS HMON_ATM_INFO USER_TABLE -
JESSICAE EMPLOYEE USER_TABLE -
Information returned
Table 167. Information returned by the SNAPTAB administrative view and the
SNAP_GET_TAB_V91 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TABSCHEMA VARCHAR(128) table_schema - Table schema name
TABNAME VARCHAR(128) table_name - Table name
TAB_FILE_ID BIGINT table_file_id - Table file
identification
TAB_TYPE VARCHAR(14) table_type - Table type. This
interface returns a text identifier
based on defines in sqlmon.h, and
is one of:
v USER_TABLE
v DROPPED_TABLE
v TEMP_TABLE
v CATALOG_TABLE
v REORG_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
ROWS_READ BIGINT rows_read - Rows read
538 Administrative Routines and Views
Table 167. Information returned by the SNAPTAB administrative view and the
SNAP_GET_TAB_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
ROWS_WRITTEN BIGINT rows_written - Rows written
OVERFLOW_ACCESSES BIGINT overflow_accesses - Accesses to
overflowed records
PAGE_REORGS BIGINT page_reorgs - Page reorganizations
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
TBSP_ID BIGINT tablespace_id - Table space
identification
DATA_PARTITION_ID INTEGER data_partition_id - Data Partition
identifier. For a non-partitioned
table, this element will be NULL.
SNAPTAB_REORG administrative view and
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.
SNAPTAB_REORG administrative view
This administrative view allows you to retrieve table reorganization snapshot
information for the currently connected database.
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.
The schema is SYSIBMADM.
Refer to Table 138 on page 417 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPTAB_REORG administrative view
and EXECUTE privilege on the SNAP_GET_TAB_REORG table function.
Example
Select details on reorganization operations for all database partitions on the
currently connected database.
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
Chapter 3. Supported routines and views 539
The following is an example of output from this query.
TAB_NAME TAB_SCHEMA REORG_PHASE ...
--------...- ----------...- ---------------- ...
EMPLOYEE DBUSER REPLACE ...
EMPLOYEE DBUSER REPLACE ...
EMPLOYEE DBUSER REPLACE ...
...
3 record(s) selected.
Output from this query (continued).
... REORG_TYPE REORG_STATUS REORG_COMPLETION DBPARTITIONNUM
... -------------------- ------------ ---------------- --------------
... RECLAIM+OFFLINE+ALLO COMPLETED SUCCESS 0
... RECLAIM+OFFLINE+ALLO COMPLETED SUCCESS 1
... RECLAIM+OFFLINE+ALLO COMPLETED SUCCESS 2
SNAP_GET_TAB_REORG table function
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 partition, aggregate of all database
partitions or all database partitions.
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
database-alias CLP command.
Refer to Table 138 on page 417 for a complete list of information that can be
returned.
Syntax
SNAP_GET_TAB_REORG ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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
540 Administrative Routines and Views
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_TAB_REORG table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_TAB_REORG table function.
Example
Select details on reorganization operations for database partition 1 on the currently
connected database.
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 TABLE( SNAP_GET_TAB_REORG(’’, 1)) AS T
The following is an example of output from this query.
TAB_NAME TAB_SCHEMA REORG_PHASE REORG_TYPE ...
--------...- ----------...- -----------...- -------------------- ...
EMPLOYEE DBUSER REPLACE RECLAIM+OFFLINE+ALLO ...
...
1 record(s) selected. ...
Output from this query (continued).
... REORG_STATUS REORG_COMPLETION DBPARTITIONNUM
... ------------ ---------------- --------------
... COMPLETED SUCCESS 1
...
Information returned
Table 168. Information returned by the SNAPTAB_REORG administrative view and the
SNAP_GET_TAB_REORG table function
Description or corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was
taken.
TABNAME VARCHAR table_name - Table name
(128)
TABSCHEMA VARCHAR table_schema - Table schema name
(128)
PAGE_REORGS BIGINT page_reorgs - Page reorganizations
REORG_PHASE VARCHAR reorg_phase - Table reorganize phase. This
(16) 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
or SORT+DICT_SAMPLE.
Chapter 3. Supported routines and views 541
Table 168. Information returned by the SNAPTAB_REORG administrative view and the
SNAP_GET_TAB_REORG table function (continued)
Description or corresponding monitor
Column name Data type element
REORG_MAX_PHASE INTEGER reorg_max_phase - Maximum table
reorganize phase
BIGINT reorg_current_counter - Table reorganize
REORG_CURRENT_ progress
COUNTER
REORG_MAX_COUNTER BIGINT reorg_max_counter - Total amount of table
reorganization
REORG_TYPE VARCHAR reorg_type - Table reorganize attributes. This
(128) interface returns a text identifier using a
combination of the following identifiers
separated by ’+’:
Either:
v RECLAIM
v RECLUSTER
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
Example 2: If a REORG TABLE
TEST.EMPLOYEE INDEX EMPIDX
INDEXSCAN was run, then the following
would be displayed:
RECLUSTER+OFFLINE+ALLOW_READ+INDEXSCAN
+DATAONLY+KEEPDICTIONARY
542 Administrative Routines and Views
Table 168. Information returned by the SNAPTAB_REORG administrative view and the
SNAP_GET_TAB_REORG table function (continued)
Description or corresponding monitor
Column name Data type element
REORG_STATUS VARCHAR reorg_status - Table reorganize status. This
(10) interface returns a text identifier based on
defines in sqlmon.h and is one of:
v COMPLETED
v PAUSED
v STARTED
v STOPPED
v TRUNCATE
REORG_COMPLETION VARCHAR reorg_completion - Table reorganization
(10) 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 The database partition from which the data
was retrieved for this row.
DATA_PARTITION_ID INTEGER data_partition_id - Data Partition identifier.
For a non-partitioned table, this element will
be NULL.
BIGINT reorg_rows_compressed - Rows compressed
REORG_
ROWSCOMPRESSED
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
SNAPTBSP administrative view and SNAP_GET_TBSP_V91
table function - Retrieve table space logical data group
snapshot information
The SNAPTBSP administrative view and the SNAP_GET_TBSP_V91 table function
return snapshot information from the table space logical data group.
SNAPTBSP administrative view
This administrative view allows you to retrieve table space logical data group
snapshot information for the currently connected database.
Chapter 3. Supported routines and views 543
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.
The schema is SYSIBMADM.
Refer to Table 139 on page 421 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPTBSP administrative view and
EXECUTE privilege on the SNAP_GET_TBSP_V91 table function.
Example
Retrieve a list of table spaces on the catalog database partition 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
The following is an example of output from this query.
TBSP_NAME TBSP_ID TBSP_TYPE TBSP_CONTENT_TYPE
---------- -------...- ---------- -----------------
TEMPSPACE1 1 SMS SYSTEMP
USERSPACE1 2 DMS LONG
2 record(s) selected.
SNAP_GET_TBSP_V91 table function
The SNAP_GET_TBSP_V91 table function returns the same information as the
SNAPTBSP 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_PART_V91,
SNAP_GET_TBSP_QUIESCER, SNAP_GET_TBSP_RANGE,
SNAP_GET_CONTAINER_V91 table functions, the SNAP_GET_TBSP_V91 table
function returns information equivalent to the GET SNAPSHOT FOR
TABLESPACES ON database-alias CLP command.
Refer to Table 139 on page 421 for a complete list of information that can be
returned.
Syntax
SNAP_GET_TBSP_V91 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
544 Administrative Routines and Views
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_TBSP_V91 table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_TBSP_V91 table function.
Example
Retrieve a list of table spaces for all database partitions for the currently connected
database.
SELECT SUBSTR(TBSP_NAME,1,10) AS TBSP_NAME, TBSP_ID, TBSP_TYPE,
TBSP_CONTENT_TYPE, DBPARTITIONNUM FROM TABLE(SNAP_GET_TBSP_V91(’’)) AS T
The following is an example of output from this query.
TBSP_NAME TBSP_ID TBSP_TYPE TBSP_CONTENT_TYPE DBPARTITIONNUM
-----–---- -------...- ---------- ----------------- --------------
TEMPSPACE1 1 SMS SYSTEMP 1
USERSPACE1 2 DMS LONG 1
SYSCATSPAC 0 DMS ANY 0
TEMPSPACE1 1 SMS SYSTEMP 0
USERSPACE1 2 DMS LONG 0
SYSTOOLSPA 3 DMS LONG 0
TEMPSPACE1 1 SMS SYSTEMP 2
USERSPACE1 2 DMS LONG 2
8 record(s) selected.
Information returned
Table 169. Information returned by the SNAPTBSP administrative view and the
SNAP_GET_TBSP_V91 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
Chapter 3. Supported routines and views 545
Table 169. Information returned by the SNAPTBSP administrative view and the
SNAP_GET_TBSP_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
TBSP_NAME VARCHAR(128) tablespace_name - Table space
name
TBSP_ID BIGINT tablespace_id - Table space
identification
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 contents 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
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
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer
pool asynchronous data reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_ASYNC_DATA_WRITES BIGINT pool_async_data_writes - Buffer
pool asynchronous data writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
546 Administrative Routines and Views
Table 169. Information returned by the SNAPTBSP administrative view and the
SNAP_GET_TBSP_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
POOL_ASYNC_INDEX_READS BIGINT pool_async_index_reads - Buffer
pool asynchronous index reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index writes
POOL_ASYNC_INDEX_WRITES BIGINT pool_async_index_writes - Buffer
pool asynchronous index writes
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool
XDA Data Logical Reads
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool
XDA Data Physical Reads
POOL_XDA_WRITES BIGINT pool_xda_writes - Buffer Pool XDA
Data Writes
POOL_ASYNC_XDA_READS BIGINT pool_async_xda_reads - Buffer Pool
Asynchronous XDA Data Reads
POOL_ASYNC_XDA_WRITES BIGINT pool_async_xda_writes - Buffer
Pool Asynchronous XDA Data
Writes
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer
Pool Temporary XDA Data Physical
Reads monitor element
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
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
BIGINT pool_async_data_read_reqs - Buffer
POOL_ASYNC_DATA_ pool asynchronous read requests
READ_REQS
BIGINT pool_async_index_read_reqs -
POOL_ASYNC_INDEX_ Buffer pool asynchronous index
READ_REQS read requests
BIGINT pool_async_xda_read_reqs - Buffer
POOL_ASYNC_XDA_ Pool Asynchronous XDA Read
READ_REQS Requests
Chapter 3. Supported routines and views 547
Table 169. Information returned by the SNAPTBSP administrative view and the
SNAP_GET_TBSP_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_NO_VICTIM_BUFFER BIGINT pool_no_victim_buffer - Buffer pool
no victim buffers
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
FILES_CLOSED BIGINT files_closed - Database files closed
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
TBSP_REBALANCER_MODE VARCHAR(10) tablespace_rebalancer_mode -
Rebalancer mode. This interface
returns a text identifier based on
defines in sqlmon.h, and is one of:
v NO_REBAL
v FWD_REBAL
v REV_REBAL
TBSP_USING_AUTO_STORAGE SMALLINT tablespace_using_auto_storage -
Using automatic storage
TBSP_AUTO_RESIZE_ENABLED SMALLINT tablespace_auto_resize_enabled -
Auto-resize enabled
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPTBSP_PART administrative view and
SNAP_GET_TBSP_PART_V91 table function - Retrieve
tablespace_nodeinfo logical data group snapshot information
The SNAPTBSP_PART administrative view and the SNAP_GET_TBSP_PART_V91
table function return snapshot information from the tablespace_nodeinfo logical
data group.
SNAPTBSP_PART administrative view
This administrative view allows you to retrieve tablespace_nodeinfo logical data
group snapshot information for the currently connected database.
Used in conjunction with the SNAPTBSP, SNAPTBSP_QUIESCER,
SNAPTBSP_RANGE, SNAPCONTAINER administrative views, the
548 Administrative Routines and Views
SNAPTBSP_PART administrative view returns information equivalent to the GET
SNAPSHOT FOR TABLESPACES ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 140 on page 426 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPTBSP_PART administrative view
and EXECUTE privilege on the SNAP_GET_TBSP_PART_V91 table function.
Example
Retrieve a list of table spaces and their state for all database partitions of the
currently connected database.
SELECT SUBSTR(TBSP_NAME,1,30) AS TBSP_NAME, TBSP_ID,
SUBSTR(TBSP_STATE,1,30) AS TBSP_STATE, DBPARTITIONNUM
FROM SYSIBMADM.SNAPTBSP_PART
The following is an example of output from this query.
TBSP_NAME TBSP_ID TBSP_STATE DBPARTITIONNUM
-----------...- -------...- ----------...- --------------
SYSCATSPACE 0 NORMAL 0
TEMPSPACE1 1 NORMAL 0
USERSPACE1 2 NORMAL 0
TEMPSPACE1 1 NORMAL 1
USERSPACE1 2 NORMAL 1
5 record(s) selected.
SNAP_GET_TBSP_PART_V91 table function
The SNAP_GET_TBSP_PART_V91 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_V91,
SNAP_GET_TBSP_QUIESCER, SNAP_GET_TBSP_RANGE,
SNAP_GET_CONTAINER_V91 table functions, the SNAP_GET_TBSP_PART_V91
table function returns information equivalent to the GET SNAPSHOT FOR
TABLESPACES ON database-alias CLP command.
Refer to Table 140 on page 426 for a complete list of information that can be
returned.
Syntax
SNAP_GET_TBSP_PART_V91 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Chapter 3. Supported routines and views 549
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_TBSP_PART_V91 table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_TBSP_PART_V91 table function.
Example
Retrieve a list of table spaces and their state for the connected database partition of
the connected database.
SELECT SUBSTR(TBSP_NAME,1,30) AS TBSP_NAME, TBSP_ID,
SUBSTR(TBSP_STATE,1,30) AS TBSP_STATE
FROM TABLE(SNAP_GET_TBSP_PART_V91(CAST(NULL AS VARCHAR(128)),-1)) AS T
The following is an example of output from this query.
TBSP_NAME TBSP_ID TBSP_STATE
------------------------------ -------------------- ------------...-
SYSCATSPACE 0 NORMAL
TEMPSPACE1 1 NORMAL
USERSPACE1 2 NORMAL
SYSTOOLSPACE 3 NORMAL
SYSTOOLSTMPSPACE 4 NORMAL
5 record(s) selected.
Information returned
Table 170. Information returned by the SNAPTBSP_PART administrative view and the
SNAP_GET_TBSP_PART_V91 table function
Description or corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was
taken.
550 Administrative Routines and Views
Table 170. Information returned by the SNAPTBSP_PART administrative view and the
SNAP_GET_TBSP_PART_V91 table function (continued)
Description or corresponding monitor
Column name Data type element
TBSP_NAME VARCHAR tablespace_name - Table space name
(128)
TBSP_ID BIGINT tablespace_id - Table space identification
TBSP_STATE VARCHAR tablespace_state - Table space state. This
(256) interface returns a text identifier based on
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
TBSP_PREFETCH_SIZE BIGINT tablespace_prefetch_size - Table space
prefetch size
TBSP_NUM_QUIESCERS BIGINT tablespace_num_quiescers - Number of
quiescers
BIGINT tablespace_state_change_object_id - State
TBSP_STATE_CHANGE_ change object identification
OBJECT_ID
BIGINT tablespace_state_change_ts_id - State change
TBSP_STATE_CHANGE_ table space identification
TBSP_ID
TIMESTAMP tablespace_min_recovery_time - Minimum
TBSP_MIN_RECOVERY_ recovery time for rollforward
TIME
Chapter 3. Supported routines and views 551
Table 170. Information returned by the SNAPTBSP_PART administrative view and the
SNAP_GET_TBSP_PART_V91 table function (continued)
Description or corresponding monitor
Column name Data type element
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
TBSP_FREE_PAGES BIGINT tablespace_free_pages - Free pages in table
space
BIGINT tablespace_pending_free_pages - Pending
TBSP_PENDING_FREE_ free pages in table space
PAGES
TBSP_PAGE_TOP BIGINT tablespace_page_top - Table space high
water mark
REBALANCER_MODE VARCHAR tablespace_rebalancer_mode - Rebalancer
(10) 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
BIGINT tablespace_rebalancer_extents_remaining -
REBALANCER_EXTENTS_ Total number of extents to be processed by
REMAINING the rebalancer
BIGINT tablespace_rebalancer_extents_processed -
REBALANCER_EXTENTS_ Number of extents the rebalancer has
PROCESSED processed
REBALANCER_PRIORITY BIGINT tablespace_rebalancer_priority - Current
rebalancer priority
TIMESTAMP tablespace_rebalancer_start_time -
REBALANCER_START_ Rebalancer start time
TIME
TIMESTAMP tablespace_rebalancer_restart_time -
REBALANCER_RESTART_ Rebalancer restart time
TIME
BIGINT tablespace_rebalancer_last_extent_moved -
REBALANCER_LAST_ Last extent moved by the rebalancer
EXTENT_MOVED
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
552 Administrative Routines and Views
Table 170. Information returned by the SNAPTBSP_PART administrative view and the
SNAP_GET_TBSP_PART_V91 table function (continued)
Description or corresponding monitor
Column name Data type element
TBSP_INCREASE_SIZE BIGINT tablespace_increase_size - Increase size in
bytes
SMALLINT tablespace_increase_size_percent - Increase
TBSP_INCREASE_SIZE_ size by percent
PERCENT
TBSP_LAST_RESIZE_TIME TIMESTAMP tablespace_last_resize_time - Time of last
successful resize
SMALLINT tablespace_last_resize_failed - Last resize
TBSP_LAST_RESIZE_ attempt failed
FAILED
DBPARTITIONNUM SMALLINT The database partition from which the data
was retrieved for this row.
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.
SNAPTBSP_QUIESCER administrative view
This administrative view allows you to retrieve quiescer table space snapshot
information for the currently connected database.
Used with the SNAPTBSP, SNAPTBSP_PART, SNAPTBSP_RANGE,
SNAPCONTAINER administrative views, the SNAPTBSP_QUIESCER
administrative view provides information equivalent to the GET SNAPSHOT FOR
TABLESPACES ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 141 on page 431 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPTBSP_QUIESCER administrative
view and EXECUTE privilege on the SNAP_GET_TBSP_QUIESCER table
function.
Example
Retrieve information on quiesced table spaces for all database partitions for the
currently connected database.
Chapter 3. Supported routines and views 553
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
The following is an example of output from this query.
TBSP_NAME QUIESCER_TS_ID QUIESCER_OBJ_ID QUIESCER_AUTH_ID ..
---------- --------------...- ---------------...- ----------------...- ..
USERSPACE1 2 5 SWALKTY ..
USERSPACE1 2 5 SWALKTY ..
..
2 record(s) selected.
Output from this query (continued).
... QUIESCER_AGENT_ID QUIESCER_STATE DBPARTITIONNUM
... -------------------- -------------- --------------
... 0 EXCLUSIVE 0
... 65983 EXCLUSIVE 1
...
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
information for a specific database on a specific database partition, aggregate of all
database partitions or all database partitions.
Used with the SNAP_GET_TBSP_V91, SNAP_GET_TBSP_PART_V91,
SNAP_GET_TBSP_RANGE, SNAP_GET_CONTAINER_V91 table functions, the
SNAP_GET_TBSP_QUIESCER table function provides information equivalent to
the GET SNAPSHOT FOR TABLESPACES ON database-alias CLP command.
Refer to Table 141 on page 431 for a complete list of information that can be
returned.
Syntax
SNAP_GET_TBSP_QUIESCER ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
554 Administrative Routines and Views
active database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
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_TBSP_QUIESCER table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_TBSP_QUIESCER table function.
Example
Retrieve information on quiesced table spaces for database partition 1 for the
currently connected database.
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 TABLE( SYSPROC.SNAP_GET_TBSP_QUIESCER( ’’, 1)) AS T
The following is an example of output from this query.
TBSP_NAME QUIESCER_TS_ID QUIESCER_OBJ_ID QUIESCER_AUTH_ID ...
---------- --------------...- ---------------...- ----------------...- ...
USERSPACE1 2 5 SWALKTY ...
...
1 record(s) selected.
Output from this query (continued).
... QUIESCER_AGENT_ID QUIESCER_STATE DBPARTITIONNUM
... -------------------- -------------- --------------
... 65983 EXCLUSIVE 1
...
Information returned
Table 171. Information returned by the SNAPTBSP_QUIESCER administrative view and the
SNAP_GET_TBSP_QUIESCER table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
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
QUIESCER_AUTH_ID VARCHAR(128) quiescer_auth_id - Quiescer user
authorization identification
QUIESCER_AGENT_ID BIGINT quiescer_agent_id - Quiescer agent
identification
Chapter 3. Supported routines and views 555
Table 171. Information returned by the SNAPTBSP_QUIESCER administrative view and the
SNAP_GET_TBSP_QUIESCER table function (continued)
Description or corresponding
Column name Data type monitor element
QUIESCER_STATE VARCHAR(14) quiescer_state - Quiescer state. This
interface returns a text identifier
based on defines in sqlutil.h and is
one of:
v EXCLUSIVE
v UPDATE
v SHARE
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAPTBSP_RANGE administrative view and
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.
SNAPTBSP_RANGE administrative view
This administrative view allows you to retrieve range snapshot information for the
currently connected database.
Used with the SNAPTBSP, SNAPTBSP_PART, SNAPTBSP_QUIESCER and
SNAPCONTAINER administrative views, the SNAPTBSP_RANGE administrative
view provides information equivalent to the GET SNAPSHOT FOR TABLESPACES
ON database-alias CLP command.
The schema is SYSIBMADM.
Refer to Table 142 on page 435 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPTBSP_RANGE administrative view
and EXECUTE privilege on the SNAP_GET_TBSP_RANGE table function.
Example
Select information about table space ranges for all database partitions for the
currently connected database.
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
ORDER BY DBPARTITIONNUM
The following is an example of output from this query.
556 Administrative Routines and Views
TBSP_ID TBSP_NAME RANGE_NUMBER RANGE_STRIPE_SET_NUMBER ...
-------...- --------------- ------------...- ----------------------- ...
0 SYSCATSPACE 0 0 ...
2 USERSPACE1 0 0 ...
3 SYSTOOLSPACE 0 0 ...
2 USERSPACE1 0 0 ...
2 USERSPACE1 0 0 ...
...
5 record(s) selected. ...
Output from this query (continued).
... RANGE_OFFSET RANGE_MAX_PAGE RANGE_MAX_EXTENT ...
... ------------...- -------------------- -------------------- ...
... 0 11515 2878 ...
... 0 479 14 ...
... 0 251 62 ...
... 0 479 14 ...
... 0 479 14 ...
Output from this query (continued).
... RANGE_START_STRIPE RANGE_END_STRIPE RANGE_ADJUSTMENT ...
... -------------------- -------------------- -------------------- ...
... 0 2878 0 ...
... 0 14 0 ...
... 0 62 0 ...
... 0 14 0 ...
... 0 14 0 ...
Output from this query (continued).
... RANGE_NUM_CONTAINER RANGE_CONTAINER_ID DBPARTITIONNUM
... -------------------- -------------------- --------------
... 1 0 0
... 1 0 0
... 1 0 0
... 1 0 1
... 1 0 2
SNAP_GET_TBSP_RANGE table function
The SNAP_GET_TBSP_RANGE table function returns the same information as the
SNAPTBSP_RANGE 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 with the SNAP_GET_TBSP_V91, SNAP_GET_TBSP_PART_V91,
SNAP_GET_TBSP_QUIESCER and SNAP_GET_CONTAINER_V91 table functions,
the SNAP_GET_TBSP_RANGE table function provides information equivalent to
the GET SNAPSHOT FOR TABLESPACES ON database-alias CLP command.
Refer to Table 142 on page 435 for a complete list of information that can be
returned.
Syntax
SNAP_GET_TBSP_RANGE ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Chapter 3. Supported routines and views 557
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_TBSP_RANGE table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_TBSP_RANGE table function.
Examples
Select information on the table space range for the table space with tbsp_id = 2 on
the currently connected database partition.
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
FROM TABLE(SNAP_GET_TBSP_RANGE(’’,-1)) AS T WHERE TBSP_ID = 2
The following is an example of output from this query.
TBSP_ID TBSP_NAME RANGE_NUMBER ...
-------...- --------------- ------------...- ...
2 USERSPACE1 0 ...
...
1 record(s) selected. ...
Output from this query (continued).
... RANGE_STRIPE_SET_NUMBER RANGE_OFFSET RANGE_MAX_PAGE ...
... ----------------------- ------------...- --------------...---- ...
... 0 0 3967 ...
... ...
Output from this query (continued).
... RANGE_MAX_EXTENT RANGE_START_STRIPE RANGE_END_STRIPE ...
... -------------------- -------------------- -------------------- ...
... 123 0 123 ...
... ...
558 Administrative Routines and Views
Output from this query (continued).
... RANGE_ADJUSTMENT RANGE_NUM_CONTAINER RANGE_CONTAINER_ID
... -------------------- -------------------- --------------------
... 0 1 0
...
Information returned
Table 172. Information returned by the SNAPTBSP_RANGE administrative view and the
SNAP_GET_TBSP_RANGE table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TBSP_ID BIGINT tablespace_id - Table space
identification
TBSP_NAME VARCHAR(128) tablespace_name - Table space
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 The database partition from which
the data was retrieved for this row.
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 on utilities from the utility_info logical data group.
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.
The schema is SYSIBMADM.
Chapter 3. Supported routines and views 559
Refer to Table 143 on page 437 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPUTIL administrative view and
EXECUTE privilege on the SNAP_GET_UTIL table function.
Example
Retrieve a list of utilities and their states on all database partitions 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
The following is an example of output from this query.
UTILITY_TYPE UTILITY_PRIORITY ...
------------...- ---------------- ...
LOAD - ...
LOAD - ...
LOAD - ...
3 record(s) selected.
Output from this query (continued).
... UTILITY_DESCRIPTION ...
... -----------------------------------------------------------------...
... ONLINE LOAD DEL AUTOMATIC INDEXING INSERT COPY NO TEST .LOADTEST ...
... ONLINE LOAD DEL AUTOMATIC INDEXING INSERT COPY NO TEST .LOADTEST ...
... ONLINE LOAD DEL AUTOMATIC INDEXING INSERT COPY NO TEST .LOADTEST ...
Output from this query (continued).
... UTILITY_DBNAME UTILITY_STATE UTILITY_INVOKER_TYPE DBPARTITIONNUM
... ----------------- ------------- -------------------- --------------
... SAMPLE EXECUTE USER 0
... SAMPLE EXECUTE USER 1
... SAMPLE EXECUTE 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
specific database partition, aggregate of all database partitions or all database
partitions.
Used in conjunction with the SNAP_GET_UTIL_PROGRESS table function, the
SNAP_GET_UTIL table function provides the same information as the LIST
UTILITIES SHOW DETAIL CLP command.
Refer to Table 143 on page 437 for a complete list of information that can be
returned.
Syntax
560 Administrative Routines and Views
SNAP_GET_UTIL ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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_UTIL table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_UTIL table function.
Example
Retrieve a list of utility ids with their type and state for the currently connected
database partition on database SAMPLE.
SELECT UTILITY_ID, UTILITY_TYPE, STATE
FROM TABLE(SNAP_GET_UTIL(-1)) AS T WHERE UTILITY_DBNAME=’SAMPLE’
The following is an example of output from this query.
UTILITY_ID UTILITY_TYPE STATE
-------------------- -------------------------- --------
1 BACKUP EXECUTE
1 record(s) selected.
Information returned
Table 173. Information returned by the SNAPUTIL administrative view and the
SNAP_GET_UTIL table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
UTILITY_ID INTEGER utility_id - Utility ID. Unique to a
database partition.
Chapter 3. Supported routines and views 561
Table 173. Information returned by the SNAPUTIL administrative view and the
SNAP_GET_UTIL table function (continued)
Description or corresponding
Column name Data type monitor element
UTILITY_TYPE VARCHAR(26) 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 REORG
v RESTART_RECREATE_INDEX
v RESTORE
v ROLLFORWARD_RECOVERY
v RUNSTATS
UTILITY_PRIORITY INTEGER utility_priority - Utility priority.
Priority if utility supports
throttling, otherwise null.
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 utility_start_time - Utility start time
UTILITY_STATE VARCHAR(10) utility_state - Utility state. This
interface returns a text identifier
based on the defines in sqlmon.h
and is one of:
v ERROR
v EXECUTE
v WAIT
UTILITY_INVOKER_TYPE VARCHAR(10) utility_invoker_type - Utility
invoker type. This interface returns
a text identifier based on the
defines in sqlmon.h and is one of:
v AUTO
v USER
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
PROGRESS_LIST_ATTR VARCHAR(10) progress_list_attr - Current progress
list attributes
PROGRESS_LIST_CUR_SEQ_NUM INTEGER progress_list_current_seq_num -
Current progress list sequence
number
562 Administrative Routines and Views
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.
SNAPUTIL_PROGRESS administrative view
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.
The schema is SYSIBMADM.
Refer to Table 144 on page 440 for a complete list of information that can be
returned.
Authorization
v SYSMON authority
v SELECT or CONTROL privilege on the SNAPUTIL_PROGRESS administrative
view and EXECUTE privilege on the SNAP_GET_UTIL_PROGRESS table
function.
Example
Retrieve details on total and completed units of progress by utility ID.
SELECT SELECT UTILITY_ID, PROGRESS_TOTAL_UNITS, PROGRESS_COMPLETED_UNITS,
DBPARTITIONNUM FROM SYSIBMADM.SNAPUTIL_PROGRESS
The following is an example of output from this query.
UTILITY_ID PROGRESS_TOTAL_UNITS PROGRESS_COMPLETED_UNITS DBPARTITIONNU
---------- -------------------- ------------------------ -----------–-
7 10 5 0
9 10 5 1
1 record(s) selected.
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
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_UTIL table function, the
SNAP_GET_UTIL_PROGRESS table function provides the same information as the
LIST UTILITIES SHOW DETAIL CLP command.
Refer to Table 144 on page 440 for a complete list of information that can be
returned.
Chapter 3. Supported routines and views 563
Syntax
SNAP_GET_UTIL_PROGRESS ( )
dbpartitionnum
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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_UTIL_PROGRESS table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_UTIL_PROGRESS table function.
Example
Retrieve details on the progress of utilities on the currently connect partition.
SELECT UTILITY_ID, PROGRESS_TOTAL_UNITS, PROGRESS_COMPLETED_UNITS,
DBPARTITIONNUM FROM TABLE(SNAP_GET_UTIL_PROGRESS(-1)) as T
The following is an example of output from this query.
UTILITY_ID PROGRESS_TOTAL_UNITS PROGRESS_COMPLETED_UNITS DBPARTITIONNUM
---------- -------------------- ------------------------ --------------
7 10 5 0
1 record(s) selected.
Information returned
Table 174. Information returned by the SNAPUTIL_PROGRESS administrative view and the
SNAP_GET_UTIL_PROGRESS table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
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.
564 Administrative Routines and Views
Table 174. Information returned by the SNAPUTIL_PROGRESS administrative view and the
SNAP_GET_UTIL_PROGRESS table function (continued)
Description or corresponding
Column name Data type monitor element
UTILITY_STATE VARCHAR(16) utility_state - Utility state. This
interface returns a text identifier
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
defines in sqlmon.h and is one of:
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 The database partition from which
the data was retrieved for this row.
SNAP_WRITE_FILE procedure
The SNAP_WRITE_FILE procedure writes system snapshot data to a file in the tmp
subdirectory of the instance directory.
Syntax
SNAP_WRITE_FILE ( requestType , dbname , dbpartitionnum )
The schema is SYSPROC.
Procedure parameters
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:
Chapter 3. Supported routines and views 565
v APPL_ALL
v BUFFERPOOLS_ALL
v DB2
v DBASE_ALL
v DBASE_LOCKS
v DBASE_TABLES
v DBASE_TABLESPACES
v DYNAMIC_SQL
dbname
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. 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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for an aggregate of
all active database partitions. An active database partition is a partition where
the database is available for connection and use by applications.
If a null value is specified, -1 is set implicitly.
Authorization
To execute the procedure, a user must have SYSADM, SYSCTRL, SYSMAINT, or
SYSMON authority. The saved snapshot can be read by users who do not have
SYSADM, SYSCTRL, SYSMAINT, or SYSMON authority by passing null values as
the inputs to snapshot table 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.
TBSP_UTILIZATION administrative view - Retrieve table space
configuration and utilization information
The TBSP_UTILIZATION administrative view returns table space configuration
and utilization information. The view is an SQL interface for the LIST
TABLESPACES CLP command. Its information is based on the SNAPTBSP,
SNAPTBSP_PART administrative views and TABLESPACES catalog view.
566 Administrative Routines and Views
The schema is SYSIBMADM.
Authorization
v SELECT or CONTROL privilege on the TBSP_UTILIZATION, SNAPTBSP,
SNAPTBSP_PART administrative views and the SYSCAT.TABLESPACES catalog
view.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority is also required to
access snapshot monitor data.
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
The following is an example of output for this query.
TBSP_ID TBSP_NAME TBSP_TYPE ...
-------...- -------------------- ---------- ...
0 SYSCATSPACE SMS ...
1 TEMPSPACE1 SMS ...
2 USERSPACE1 SMS ...
3 SYSTOOLSPACE SMS ...
4 SYSTOOLSTMPSPACE SMS ...
Output for this query (continued).
... TBSP_CONTENT_TYPE TBSP_STATE
... ----------------- -----------
... ANY NORMAL
... SYSTEMP NORMAL
... ANY NORMAL
... ANY NORMAL
... USRTEMP NORMAL
Information returned
Table 175. Information returned by the TBSP_UTILIZATION administrative view
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TBSP_ID BIGINT tablespace_id - Table space
identification
TBSP_NAME VARCHAR(128) tablespace_name - Table space
name
TBSP_TYPE VARCHAR(10) tablespace_type - Table space type.
This interface returns a text
identifier based on the defines in
sqlutil.h and is one of:
v DMS
v SMS
Chapter 3. Supported routines and views 567
Table 175. Information returned by the TBSP_UTILIZATION administrative view (continued)
Description or corresponding
Column name Data type monitor element
TBSP_CONTENT_TYPE VARCHAR(10) tablespace_content_type - Table
space contents type . This interface
returns a text identifier based on
the defines in sqlutil.h and is one
of:
v ANY
v LONG
v SYSTEMP
v USRTEMP
TBSP_CREATE_TIME TIMESTAMP Creation time of the table space.
TBSP_STATE VARCHAR(256) tablespace_state - Table space state.
This interface returns a text
identifier based on 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
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.
568 Administrative Routines and Views
Table 175. Information returned by the TBSP_UTILIZATION administrative view (continued)
Description or corresponding
Column name Data type monitor element
TBSP_USED_SIZE_KB BIGINT The total used size of the table
space in KB, calculated as
used_pages*pagesize/1024.
TBSP_FREE_SIZE_KB BIGINT The total available size of the table
space in KB, calculated as
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
pages in table space
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_PAGE_TOP BIGINT tablespace_page_top - Table space
high water mark
TBSP_PAGE_SIZE INTEGER tablespace_page_size - Table space
page size
TBSP_EXTENT_SIZE INTEGER tablespace_extent_size - Table space
extent size
TBSP_PREFETCH_SIZE BIGINT tablespace_prefetch_size - Table
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
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
TBSP_USING_AUTO_STORAGE SMALLINT tablespace_using_auto_storage -
Using automatic storage
TBSP_AUTO_RESIZE_ENABLED SMALLINT tablespace_auto_resize_enabled -
Auto-resize 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.
Chapter 3. Supported routines and views 569
Table 175. Information returned by the TBSP_UTILIZATION administrative view (continued)
Description or corresponding
Column name Data type monitor element
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
TOP_DYNAMIC_SQL administrative view - Retrieve
information on 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.
The schema is SYSIBMADM.
Authorization
v SELECT or CONTROL privilege on the TOP_DYNAMIC_SQL and
SNAPDYN_SQL administrative views.
v SYSMON, SYSCTRL, SYSMAINT, or SYSADM authority is also required to
access snapshot monitor data.
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
The following is an example of output for this query.
NUM_EXECUTIONS AVERAGE_EXECUTION_TIME_S STMT_SORTS ...
-------------------- ------------------------ -------------------- ...
148 0 0 ...
123 0 0 ...
2 0 0 ...
1 0 0 ...
1 0 0 ...
5 record(s) selected.
Output for this query (continued).
... SORTS_PER_EXECUTION ...
... -------------------- ...
... 0 ...
... 0 ...
... 0 ...
... 0 ...
... 0 ...
Output for this query (continued).
... STMT_TEXT
... ------------------------------------------------------------
... SELECT A.ID, B.EMPNO, B.FIRSTNME, B.LASTNAME, A.DEPT FROM E
570 Administrative Routines and Views
... 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
Information returned
Table 176. Information returned by the TOP_DYNAMIC_SQL administrative view
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP Timestamp for the report.
NUM_EXECUTIONS BIGINT num_compilations - Statement
compilations
AVERAGE_EXECUTION_TIME_S BIGINT Average execution time.
STMT_SORTS BIGINT stmt_sorts - Statement sorts
SORTS_PER_EXECUTION BIGINT Number of sorts per statement
execution.
STMT_TEXT CLOB(2 M) stmt_text - SQL statement text
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SQL procedures routines
GET_ROUTINE_OPTS
GET_ROUTINE_OPTS ( )
The schema is SYSPROC.
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.
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
GET_ROUTINE_SAR
( sarblob , type , routine-name-string )
, hide-body-flag
The schema is SYSFUN.
Chapter 3. Supported routines and views 571
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. The invoker of the GET_ROUTINE_SAR
procedure must have DBADM 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 ’P ’ for a procedure
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.
1 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 desired 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
PUT_ROUTINE_SAR ( sarblob )
, new-owner , use-register-flag
The schema is SYSFUN.
The PUT_ROUTINE_SAR procedure passes the necessary file to create an SQL
routine at the server and then defines the routine. The invoker of the
PUT_ROUTINE_SAR procedure must have DBADM authority.
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
572 Administrative Routines and Views
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
1 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
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″ and ″42704″ are the SQLCODE and SQLSTATE, respectively, 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
REBIND_ROUTINE_PACKAGE ( type , routine-name-string , resolve )
Chapter 3. Supported routines and views 573
The schema is SYSPROC.
The REBIND_ROUTINE_PACKAGE procedure rebinds the package associated with
an SQL procedure. 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.
type
An input argument of type CHAR(2) that specifies the type of routine, using
one of the following values:
v ’P ’ for a procedure
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 value of the
CURRENT SCHEMA special register when the routine is processed. The
routine-name-string cannot include double quotation marks (″).
resolve
An input argument of type VARCHAR(12) that specifies which binding
semantics should be used. A value of ’ANY’ indicates that all possible matches
in the SQL path are considered for resolving references to any objects that use
the SQL path for object resolution. A value of ’CONSERVATIVE’ indicates that
only those objects that were defined before the last explicit bind time stamp are
considered for resolution.
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 desired routine must be used.
SET_ROUTINE_OPTS
SET_ROUTINE_OPTS ( character-expression )
The schema is SYSPROC.
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.
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”.
Example:
574 Administrative Routines and Views
CALL SYSPROC.SET_ROUTINE_OPTS(CAST (NULL AS VARCHAR(1)))
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 , inMainTbSchema , inMainTable ,
analysisType , inStmgTime , addDropOption , addDropList , pNumber ,
pWeight )
The schema is SYSPROC.
Procedure parameters
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.
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.
Chapter 3. Supported routines and views 575
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 wights 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
respective 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 respective 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.
Information returned
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
576 Administrative Routines and Views
partitions of the given database partition group.
Table 177. 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 desired 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.
Syntax
GENERATE_DISTFILE ( inTbSchema , inTbName , fileName )
The schema is SYSPROC.
Procedure parameters
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.
Chapter 3. Supported routines and views 577
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
The redistribute stored procedures and functions work only in partitioned database
environments, where a distribution key has been defined for each table.
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 ( dbpgName , matchingSpec , redistMethod ,
pMapFile , distFile , stepSize , totalSteps , stageSize ,
nextStep , processState , pNumber , pWeight )
The schema is SYSPROC.
Procedure parameters
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
indentifier(s) from Table 178, 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 rest of the
output parameters can be null.
Table 178. Bitwise field indentifiers
Field Name Hexadecimal value Decimal value
REDIST_METHOD 0x0001<<0 1
REDIST_PMAP_FILE 0x0001<<1 2
REDIST_DIST_FILE 0x0001<<2 4
REDIST_STEP_SIZE 0x0001<<3 8
REDIST_NUM_STEPS 0x0001<<4 16
578 Administrative Routines and Views
Table 178. Bitwise field indentifiers (continued)
Field Name Hexadecimal value Decimal value
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.
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.
Chapter 3. Supported routines and views 579
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
EXECUTE privilege on the GET_SWRD_SETTINGS procedure.
Example
Report the content of the step wise redistribution plan for the given database
partition group.
CALL SYSPROC.GET_SWRD_SETTINGS
(’IBMDEFAULTGROUP’, 255, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
Usage note
The redistribute stored procedures and functions work only in partitioned database
environments, where a distribution key has been defined for each table.
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 , redistMethod ,
pMapFile , distFile , stepSize , totalSteps , stageSize ,
nextStep , processState , pNumber , pWeight )
The schema is SYSPROC.
Procedure parameters
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 indentifier(s) from Table 179 indicating the target fields to be
written or overwritten into the redistribute settings registry.
Table 179. Bitwise field indentifiers
Field Name Hexadecimal value Decimal value
REDIST_METHOD 0x0001<<0 1
REDIST_PMAP_FILE 0x0001<<1 2
580 Administrative Routines and Views
Table 179. Bitwise field indentifiers (continued)
Field Name Hexadecimal value Decimal value
REDIST_DIST_FILE 0x0001<<2 4
REDIST_STEP_SIZE 0x0001<<3 8
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:
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
Chapter 3. Supported routines and views 581
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
EXECUTE privilege on the SET_SWRD_SETTINGS procedure.
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
The redistribute stored procedures and functions work only in partitioned database
environments, where a distribution key has been defined for each table.
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 )
The schema is SYSPROC.
Procedure parameters
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.
582 Administrative Routines and Views
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
thestageSize value specified in the setting file. This is a useful option when you
want to rerun the STEPWISE_REDISTRIBUTE_DBPG procedure with a
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
STEPWISE_REDISTRIBUTE_DBPG procedure
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.
Since SQL COMMIT statement is called by the redistribute process, running the
redistribute process under a Type-2 connection is not supported.
Chapter 3. Supported routines and views 583
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.
Table 180. STMG_OBJECT_TYPE table
Column name Data type Nullable Description
OBJ_TYPE INTEGER N 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 N 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
Syntax
CAPTURE_STORAGEMGMT_INFO ( in_rootType , in_rootSchema ,
in_rootName )
The schema is SYSPROC.
Procedure parameters
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
The input argument cannot be null. If a null value is specified, an SQL0443
error with SQLSTATE 38553, and token DBA7617 is returned.
584 Administrative Routines and Views
in_rootSchema
An input argument of type VARCHAR (128) that specifies the schema name of
the storage snapshot root object.
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.
Authorization
v EXECUTE privilege on the CAPTURE_STORAGEMGMT_INFO procedure.
v EXECUTE privilege on the SYSPROC.DB_PARTITIONS,
SYSPROC.SNAP_GET_CONTAINER, SYSPROC.SNAPSHOT_CNTRFS table
functions.
v SELECT privilege on SYSCAT.TABLES, SYSCAT.TABLESPACES,
SYSCAT.NODEGROUPDEF, SYSCAT.DATABASEPARTITIONS,
SYSCAT.DATAPARTITIONEXPRESSION, SYSCAT.INDEXES, and
SYSCAT.COLUMNS.
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.
Syntax
CREATE_STORAGEMGMT_TABLES ( in_tbspace )
The schema is SYSPROC.
Procedure parameters
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 either:
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 SYSADM or DBADM authority
Chapter 3. Supported routines and views 585
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 STMG_HIST_THRESHOLD
v STMG_INDEX
v STMG_OBJECT
v STMG_OBJECT_TYPE
v 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.
Syntax
DROP_STORAGEMGMT_TABLES ( dropSpec )
The schema is SYSPROC.
Procedure parameters
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 SYSADM or DBADM authority
v DROPIN privilege on the schema for these tables
v CONTROL privilege on these tables
586 Administrative Routines and Views
Text Search routines
SYSTS_ADMIN_CMD stored 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.
Syntax
SYSTS_ADMIN_CMD ( command-string , message-locale , message )
The schema is SYSPROC.
Procedure parameter
command-string
An input argument of type VARCHAR (32K) that specifies a single text search
index administration command that is to be executed. The command syntax is
the same as the DB2 Text Search command with the exception of the
connection options. Connection options are not supported through this
procedure. Commands that are run through this procedure use the current
connection.
message-locale
An input argument of type VARCHAR (33) that specifies the desired language
for any error message text 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.
Authorization
EXECUTE privilege on the SYSTS_ADMIN_CMD procedure.
The procedure currently supports the following DB2 Text Search commands:
v ALTER INDEX
v CLEAR COMMAND LOCKS
v CLEAR EVENTS
v CREATE INDEX
v DISABLE DATABASE
v DROP INDEX
v ENABLE DATABASE
v UPDATE INDEX
Example
Update text search index MYTEXTINDEX in schema DB2TS and return any error
messages in English.
CALL SYSPROC.SYSTS_ADMIN_CMD
(’UPDATE INDEX DB2TS.MYTEXTINDEX FOR TEXT’,’en_US’, ?)";
Chapter 3. Supported routines and views 587
The following is an example of output from this query.
Value of output parameters
--------------------------
Parameter Name : MESSAGE
Parameter Value : CIE00001 Operation completed successfully.
Return Status = 0
Usage notes
v If the execution of the command is not successful, SQLCODE -20427 and
SQLSTATE 38H14 is returned with the text search specific error message. For
example, if index MYTEXTINDEX already exists and the following statement is
issued:
CALL SYSPROC.SYSTS_ADMIN_CMD (’CREATE INDEX MYTEXTINDEX FOR TEXT
ON DB2TS.TEXTBOOKS (STORY)’, ’en_US’, ?)
the index creation will fail 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
v If an SQLCODE is returned by the procedure, the message might be truncated.
Full message information can be found in the db2diag.log file.
SYSTS_ALTER procedure - Change the update characteristics
of an index
This procedure changes the update characteristics of an index.
The procedure issues an ALTER INDEX text search administration command on
the database server.
Syntax
SYSTS_ALTER ( index_schema , index_name , update characteristics
, message_locale , message )
update characteristics:
UPDATE FREQUENCY NONE
update frequency
UPDATE MINIMUM minchanges
update frequency:
D ( * ) H ( * ) M ( integer3 )
, ,
integer1 integer2
588 Administrative Routines and Views
The schema is SYSPROC.
Procedure parameters
index_schema
An input argument of type VARCHAR(128) that specifies the schema of the
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
CURRENT SCHEMA is used. The index_schema is case-sensitive.
index_name
An input argument of type VARCHAR(128) that specifies the name of the
index. Together with index_schema, it uniquely identifies a text search index in
a database. The index_name is case-sensitive.
update characteristics
An input argument of type VARCHAR(32K) that specifies the alter options.
The alter options allowed are as follows:
UPDATE FREQUENCY
Specifies the frequency with which index updates are made. The index will
be updated, if the number of changes is at least the value set for UPDATE
MINIMUM. The update frequency NONE indicates that no further index
updates will be made. This can be useful for a text column in a table with
data that will not change. It is also useful when the user intends to
manually update the index (using the UPDATE INDEX command).
Automatic updates can only be done if the START FOR TEXT command
has been run and the DB2 Text Search instance services are running.
The default frequency value is taken from the view
SYSIBMTS.TSDEFAULTS, where
DEFAULTNAME=’UPDATEFREQUENCY’.
NONE
No automatic updates will be applied to the text index. Any further
index update will have to be started manually.
D The day(s) of the week when the index is updated.
* Every day of the week.
integer1
Specific days of the week, from Sunday to Saturday: 0 to 6
H The hour(s) of the specified day(s) when the index is updated.
* Every hour of the day.
integer2
Specific hours of the day, from midnight to 11 pm: 0 to 23
M The minute(s) of the specified hour(s) when the index is updated.
integer3
Specified as top of the hour (0), or in multiples of 5 minute
increments after the hour: 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50 or 55
If you do not specify the UPDATE FREQUENCY option, the frequency
settings are left unchanged.
UPDATE MINIMUM minchanges
Specifies the minimum number of changes to text documents that must
occur before the index is incrementally updated. Multiple changes to the
Chapter 3. Supported routines and views 589
same text document are treated as separate changes. If you do not specify
the UPDATE MINIMUM option, the setting is left unchanged.
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
An output argument of type VARCHAR(32K) that specifies a warning or
informational message for a successfully completed operation.
Authorization
EXECUTE privilege on the SYSTS_ALTER procedure.
The authorization-name for the database connection must have the CONTROL
privilege on the table the text search index was created for.
Examples
Example 1: In the following example, the update-characteristics of a text search
index is 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 succeeds, the output
parameter message indicative of the successful operation is returned to the caller.
CALL SYSPROC.SYSTS_ALTER(’db2ts’, ’myTextIndex’,
’UPDATE FREQUENCY NONE’, ’en_US’, ?)
The following is an example of output from this query.
Value of output parameters
--------------------------
Parameter Name : MESSAGE
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 ’myTextIndex’. The intention is to ensure that updates to the index
occur every hour on the hour. However, this index does not exist and results in an
error.
CALL SYSPROC.SYSTS_ALTER(’db2ts’, ’myTextIndex’,
’update frequency D(*) H(*) M(0)’, ’en_US’, ?)
The following is an example of output from this query.
SQL20427N An error occurred during a text search administration
procedure or command. The error message is "CIE00316 Text search
index "db2ts"."myTextIndex" does not exist. ". SQLSTATE 38H14
Usage notes
v Text search administration 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
590 Administrative Routines and Views
transaction changes to avoid any unexpected impact from such a commit or
rollback. One way to achieve this is to turn on AUTOCOMMIT.
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_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
– STOP FOR TEXT 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 this procedure is run,
– the content of the DB2 Text Search view SYSIBMTS.TSLOCKS is updated.
– the index entry in the Text Search Index Data file is updated. The file contains
a persistent representation of update schedules (also empty ones) for each
index in the instance.
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.
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.
A cleanup is done automatically of all locks associated with processes that are no
longer alive. This is done to make a text search index accessible to a new search
request. 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 ,
message_locale , message )
The schema is SYSPROC.
Procedure parameters
index_schema
An input argument of type VARCHAR(128) that specifies the schema of the
text index. The index_schema must follow the naming restriction for DB2
Chapter 3. Supported routines and views 591
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
An input argument of type VARCHAR(128) that specifies the name of the
index. Together with index_schema, it uniquely identifies a text search index in
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
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
An output argument of type VARCHAR(32K) that specifies a warning or
informational message for a successfully completed operation.
Authorization
EXECUTE privilege on the SYSTS_CLEAR_COMMANDLOCKS procedure.
The authorization-name for the database connection must have DBADM or
SYSADM authority when index_name is not specified as an argument.
The authorization-name for the database connection must have CONTROL
privilege on the table for which the text search index was created (according to
DB2 catalog views) when index_name is specified as an argument.
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’, ?)
The following is an example of output from this query.
Value of output parameters
--------------------------
Parameter Name : MESSAGE
Parameter Value : Operation completed successfully.
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 ’myTextIndex’. This index does not exist and the procedure returns an
error message.
CALL SYSPROC.SYSTS_CLEAR_COMMANDLOCKS(’db2ts’, ’myTextIndex’, ’en_US’, ?)
The following is an example of output from this query.
SQL20427N An error occurred during a text search administration
procedure or command. The error message is "CIE00316 Text search
index "db2ts"."myTextIndex" does not exist. ". SQLSTATE 38H14
592 Administrative Routines and Views
Usage notes
v Text search administration 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.
v The process and thread information in the view SYSIBMTS.TSLOCKS can be
used to check if the thread or process that holds the lock still exists. The locks
for existing processes belonging to running text search administration procedure
or command (for example, SYSTS_UPDATE or UPDATE INDEX) should not be
cleared.
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 wish to re-execute the SYSTS_DROP procedure. In
another example, the process executing the SYSTS_CREATE procedure dies
suddenly. It has created some index catalog and collection information, but not
all. The command lock is left intact. After clearing the command lock, you can
execute the SYSTS_DROP and SYSTS_CREATE procedures.
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 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
command on the database server.
Syntax
SYSTS_CLEAR_EVENTS ( index_schema , index_name ,
message_locale , message )
The schema is SYSPROC.
Procedure parameters
index_schema
An input argument of type VARCHAR(128) that specifies the schema of the
text search index. The index_schema must follow the naming restriction for DB2
Chapter 3. Supported routines and views 593
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
An input argument of type VARCHAR(128) that specifies the name of the
index. Together with index_schema, it uniquely identifies a text search index in
a database. The index_name is case-sensitive.
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
An output argument of type VARCHAR(32K) that specifies a warning or
informational message for a successfully completed operation.
Authorization
EXECUTE privilege on the SYSTS_CLEAR_EVENTS procedure.
The authorization-name for the database connection must have CONTROL
privileges on the table for which the text search index was created.
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’, ?)
The following is an example of output from this query.
Value of output parameters
--------------------------
Parameter Name : MESSAGE
Parameter Value : Operation completed successfully.
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 ’myTextIndex’. This index does not exist and results in an error.
CALL SYSPROC.SYSTS_CLEAR_EVENTS(’db2ts’, ’myTextIndex’, ’en_US’, ?)
The following is an example of output from this query.
SQL20427N An error occurred during a text search administration
procedure or command. The error message is "CIE00316 Text search
index "db2ts"."myTextIndex" does not exist. ". SQLSTATE 38H14
Usage notes
v Text search administration 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.
594 Administrative Routines and Views
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
– STOP FOR TEXT 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 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_CREATE procedure - Create a text search index on a
column
This procedure creates a text search index for a text column which allows the
column data to be searched using text search functions.
Once the text search index is created, the column can be searched using text search
functions in queries. The index will not contain any data until the text search
UPDATE INDEX command or SYSTS_UPDATE procedure is explicitly executed by
the user, or implicitly executed by the text search instance level services, according
to the defined update frequency for the index.
The procedure issues a CREATE INDEX text search administration command on
the database server.
Syntax
SYSTS_CREATE ( index_schema , index_name , text source ,
options , message_locale , message )
text source:
table-name ( text column name ) ,
Chapter 3. Supported routines and views 595
text column name:
column-name
function-name (column-name)
options:
text default information
update characteristics
storage options
index configuration 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:
UPDATE MINIMUM minchanges
storage options:
COLLECTION DIRECTORY directory
ADMINISTRATION TABLES IN tablespace-name
596 Administrative Routines and Views
index configuration options:
INDEX CONFIGURATION ( option-value )
The schema is SYSPROC.
Procedure parameters
index_schema
An input argument of type VARCHAR(128) that specifies the schema of the
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
CURRENT SCHEMA is used. The index_schema is case-sensitive.
index_name
An input argument of type VARCHAR(128) that specifies the name of the
index. Together with index_schema, it uniquely identifies a text search index in
a database. The index_name is case-sensitive.
text source
An input argument of type VARCHAR(1024) that specifies the name of the
column to be indexed. The options are:
table-name
The table name containing the text column. Text search indexes cannot be
created on the following tables:
v range-partitioned tables
v federated tables
v materialized query tables
v views
The table-name is case-sensitive.
text column name
The column name of the column to be indexed.
column-name
The column must be of one of the following data types: CHAR,
VARCHAR, LONG VARCHAR, CLOB, DBCLOB, BLOB, GRAPHIC,
VARGRAPHIC, LONG VARGRAPHIC, or XML. If the data type of the
column is not one of these, use a transformation function specified
with function-schema.function-name to convert the column type to one of
the valid types. Refer to the function-name (column-name) for syntax and
details. Alternatively, you can specify a user-defined external function
that accesses the text documents to be indexed. Only a single text
search index can be created for a column. The column-name is
case-sensitive.
function-name (column-name)
Specifies the schema qualified name, that conforms to DB2 naming
conventions, of an external scalar function that accesses text documents
in a column that is not of a supported type for text searching. Performs
a data type conversion of that value, and returns the value as one of
the supported data types for text searching. Its task is to perform a
Chapter 3. Supported routines and views 597
column type conversion. This function must take only one parameter
and return only one value. The function-name (column-name) is
case-sensitive.
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.
The available options are:
CODEPAGE code-page
Specifies the DB2 code page (CODEPAGE) to be used when indexing text
documents. The default value is specified by the value in the view
SYSIBMTS.TSDEFAULTS, where DEFAULTNAME=’CODEPAGE’ (which
happens to be the database code page). This argument only applies to
binary data types, i.e., 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 will be used to determine the default setting for
LANGUAGE. If you would like to have your documents automatically
scanned to determine the locale, specify locale as AUTO.
FORMAT format
Specifies the format of text documents in the column. The supported
formats include: TEXT, XML, and HTML. DB2 Text Search needs this
information when indexing documents. If the format is not specified, the
default value is used. The default value is in the view
SYSIBMTS.TSDEFAULTS, where DEFAULTNAME=’FORMAT’. For
columns of data type XML, the default format ‘XML’ is used, regardless of
the value of DEFAULTNAME.
UPDATE FREQUENCY
Specifies the frequency with which index updates are made. The index will
be updated, if the number of changes is at least the value set for UPDATE
MINIMUM. The update frequency NONE indicates that no further index
updates will be made. This can be useful for a text column in a table with
data that will not change. It is also useful when the user intends to
manually update the index (using the UPDATE INDEX command).
Automatic updates can only be done if the START FOR TEXT command
has been run and the DB2 Text Search instance services are running.
The default frequency value is taken from the view
SYSIBMTS.TSDEFAULTS, where
DEFAULTNAME=’UPDATEFREQUENCY’.
NONE
No further index updates are made. The update has to be started
manually.
D The day(s) of the week when the index is updated.
* Every day of the week.
integer1
Specific days of the week, from Sunday to Saturday: 0 to 6
H The hour(s) of the specified day(s) when the index is updated.
* Every hour of the day.
598 Administrative Routines and Views
integer2
Specific hours of the day, from midnight to 11 pm: 0 to 23
M The minute(s) of the specified hour(s) when the index is updated.
integer3
Specified as top of the hour (0), or in multiples of 5 minute
increments after the hour: 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50 or 55
UPDATE MINIMUM minchanges
Specifies the minimum number of changes to text documents before the
index is updated incrementally at the time specified in UPDATE
FREQUENCY. Positive integer values only are allowed. The default value
is taken from the view SYSIBMTS.TSDEFAULTS, where
DEFAULTNAME=’UPDATEMINIMUM’.
Note: This value is ignored during an UPDATE INDEX command (unless
the USING UPDATE MINIMUM option is used there). A small value
increases consistency between the table column and the text search index.
However, it also causes higher performance overhead.
COLLECTION DIRECTORY directory
The directory in which the text search index is stored. By default, the
collection data will be located in DBPATH/NODExxxx/SQLxxxx/
db2collections/index identifier/data. You must specify the absolute path.
The maximum length of the absolute path name is 215 characters.
ADMINISTRATION TABLES IN tablespace-name
Specifies the name of an existing regular table space for the administration
tables created for the index. If not specified, the table space of the base
table for which the index is being created is used.
INDEX CONFIGURATION (option-value)
Specifies additional index related values as option value string pairs. These
values must be enclosed in single quotes.
Note: A single quote character within a string value must be represented
by two consecutive single quotes. The following values are supported:
Table 181. Specifications for option-value
Allowed values
Option (Default) Meaning
COMMENT String value shorter Adds a string comment value to the REMARKS
than 512 bytes. column in the DB2 Text Search catalog view
TSINDEXES. It also adds the string comment value
as the description of the collection.
Example:
INDEX CONFIGURATION (COMMENT ’Index on User’’s Guide column’)
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
An output argument of type VARCHAR(32K) that specifies a warning or
informational message for a successfully completed operation.
Chapter 3. Supported routines and views 599
Authorization
EXECUTE privilege on the SYSTS_CREATE procedure.
The authorization-name for the database connection must have CONTROL
privilege on the table in which the text search index is to be created.
Examples
Example 1: In the following example, a text search index with index_schema ’db2ts’
and index_name ’myTextIndex’ is created using the SYSTS_CREATE procedure. The
option ’UPDATE MINIMUM 10’ specifies that at least 10 changes should be made to
the text documents associated with the index before an incremental update of the
index should be performed. Any error messages are requested to be returned in
English. When the underlying text search command runs successfully, the output
parameter message is set to indicate the status of the command execution.
CALL SYSPROC.SYSTS_CREATE(’db2ts’, ’myTextIndex’,
’myUserSchema.myBaseTable (myTextColumn)’, ’UPDATE MINIMUM 10’,
’en_US’, ?)
The following is an example of output from this query.
Value of output parameters
--------------------------
Parameter Name : MESSAGE
Parameter Value : Operation completed successfully.
Return Status = 0
Example 2: In the following example, SYSTS_CREATE is called to create a text
search index with index_schema ’db2ts’ and index_name ’myTextIndex’. No options
are specified. In this example, the index already exists which results in an error
message being returned to the caller.
CALL SYSPROC.SYSTS_CREATE(’db2ts’, ’myTextIndex’,
’myUserSchema.myBaseTable (myTextColumn)’, ’’, ’en_US’, ?)
The following is an example of output from this query.
SQL20427N An error occurred during a text search administration
procedure or command. The error message is "CIE00201 Text search
index "db2ts"."myTextIndex" already exists. ".
Usage notes
v Text search administration 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.
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:
– 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
– STOP FOR TEXT db2ts command
– SYSTS_UPDATE procedure or UPDATE INDEX db2ts command
600 Administrative Routines and Views
If there is a conflict, the procedure returns an SQLCODE -20426 and SQLSTATE
38H13.
v With the successful execution of the CREATE INDEX command:
– DB2 Text Search server data is updated. A collection of name
instance_database-name_index-identifier_number is created, as in the following
example:
tigertail_MYTSDB_TS250517_0000
The collection name can be retrieved from the
SYSIBMTS.TSCOLLECTIONNAMES view (column COLLECTIONNAME).
– DB2 Text Search catalog information is updated. An index staging table is
created in the specified table space with appropriate DB2 indexes. In addition,
an index event table is created in the specified table space.
– The newly created text search index is not automatically populated. The
SYSTS_UPDATE procedure or UPDATE INDEX command must be executed
either manually or automatically (as a result of an update schedule having
been defined for the index through the specification of the UPDATE
FREQUENCY option) for the text search index to be populated.
– The Text Search index data file on the DB2 database server is updated.
Scheduled update information is recorded for each index in the instance.
Usage restrictions:
v A primary key must be defined for the table. In DB2 Text Search, a multi-column
DB2 primary key can be used without type limitations. The number of primary
key columns is limited to 2 columns less than the number of primary key
columns allowed by DB2.
v The total length of all primary key columns for a table with DB2 Text Search
indexes is limited to 15 bytes less than the maximum total primary key length
allowed by DB2. Refer to the DB2 restrictions of DB2 CREATE INDEX statement.
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
command on the database server.
Syntax
SYSTS_DISABLE ( options , message_locale , message )
The schema is SYSPROC.
Procedure parameters
options
An input argument of type VARCHAR(128) that specifies the options to be
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
Chapter 3. Supported routines and views 601
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
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
An output argument of type VARCHAR(32K) that specifies a warning or
informational message for a successfully completed operation.
Authorization
EXECUTE privilege on the SYSTS_DISABLE procedure.
The authorization-name for the database connection must have DBADM or
SYSADM authority.
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 requested to be returned in English. The message
output parameter is set to an informational message string.
CALL SYSPROC.SYSTS_DISABLE(’FORCE’, ’en_US’, ?)
The following is an example of output from this query.
Value of output parameters
--------------------------
Parameter Name : MESSAGE
Parameter Value : Operation completed successfully.
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 prior to disabling the Text Search
feature or alternatively to specify the FORCE option for the options input parameter
value.
CALL SYSPROC.SYSTS_DISABLE(’’, ’en_US’, ?)
The following is an example of output from this query.
SQL20427N An error occurred during a text search administration
procedure or command. The error message is "CIE00326 Text search
index active in specified or default database. ". SQLSTATE 38H14
Usage notes
v Text search administration 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.
602 Administrative Routines and Views
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:
– 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
– STOP FOR TEXT 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 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. In addition, the text
service is updated to remove any remaining update schedule information. 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 db2diag.log. If the text search index procedure
SYSTS_DISABLE or the command DISABLE DATABASE FOR TEXT is not
executed before the CLP command DROP DATABASE, the text search index
services must also be cleaned up using the CLEANUP FOR TEXT command. See
the SYSTS_DROP procedure or DROP INDEX command for more about
dropping indexes, and the CLEANUP FOR TEXT command for information
about text search collections and their relationship to text search indexes.
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 cause orphaned collections:
– When a DROP DATABASE CLP command or DROP TABLE statement is
executed without running the SYSTS_DISABLE procedure or 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.
– Some other error conditions. The CLEANUP FOR TEXT command can be
used in some scenarios.
SYSTS_DROP procedure - Drop a text search index
This procedure drops an existing text search index associated with any table
column.
Chapter 3. Supported routines and views 603
After successful execution of this procedure, text search queries cannot be run on
that column.
The procedure issues a DROP INDEX text search administration command on the
database server.
Syntax
SYSTS_DROP ( index_schema , index_name ,
message_locale , message )
The schema is SYSPROC.
Procedure parameters
index_schema
An input argument of type VARCHAR(128) that specifies the schema of the
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
CURRENT SCHEMA is used. The index_schema is case-sensitive.
index_name
An input argument of type VARCHAR(128) that specifies the name of the
index. Together with index_schema, it uniquely identifies a text search index in
a database. The index_name is case-sensitive.
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
An output argument of type VARCHAR(32K) that specifies a warning or
informational message for a successfully completed operation.
Authorization
EXECUTE privilege on the SYSTS_DROP procedure.
The authorization-name for the database connection must have one of the
following:
v CONTROL privileges on the table for which the text search index was created.
v DBADM or SYSADM authority. This authorization is used to drop a text index
as part of the DISABLE DATABASE FOR TEXT command with the FORCE
option.
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
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’, ?)
604 Administrative Routines and Views
The following is an example of output from this query.
Value of output parameters
--------------------------
Parameter Name : MESSAGE
Parameter Value : Operation completed successfully.
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 ’myTextIndex’. This index does
not exist and results in an error.
CALL SYSPROC.SYSTS_DROP(’db2ts’, ’myTextIndex’, ’en_US’, ?)
The following is an example of output from this query.
SQL20427N An error occurred during a text search administration
procedure or command. The error message is "CIE00316 Text search
index "db2ts"."myTextIndex" does not exist. ". SQLSTATE 38H14
Usage notes
v Text search administration 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.
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:
– 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
– STOP FOR TEXT 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 Dropping the user table in DB2 does not trigger dropping of indexes, they must
be dropped manually before or after dropping the table.
v When this procedure is run,
– the text search catalog information is updated. The index staging and event
tables are dropped. Triggers on the user table are deleted.
– the index entry in the Text Search Index Data file is deleted. The file contains
a persistent representation of update schedules (also empty ones) for each
index in the instance.
– the collection associated with the text search index definition is removed.
v If, after dropping a text search index, you plan to create a new one on the same
text column, you must first disconnect from and then reconnect to the database
before creating the new text search index.
SYSTS_ENABLE procedure - Enable current database for text
search
This procedure enables DB2 Text Search for the current database.
Chapter 3. Supported routines and views 605
This procedure must be issued successfully before text search indexes on columns
in tables within the database can be created.
This procedure issues the ENABLE DATABASE FOR TEXT text search
administration command on the database server.
Syntax
SYSTS_ENABLE ( message_locale , message )
The schema is SYSPROC.
Procedure parameters
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
An output argument of type VARCHAR(32K) that specifies a warning or
informational message for a successfully completed operation.
Authorization
EXECUTE privilege on the SYSTS_ENABLE procedure.
The authorization-name for the database connection must have SYSADM authority.
Examples
Example 1: Enable the database for text search and return any error messages in
English.
CALL SYSPROC.SYSTS_ENABLE(’en_US’, ?)
The following is an example of output for this query.
Value of output parameters
--------------------------
Parameter Name : MESSAGE
Parameter Value : Operation completed successfully.
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’, ?)
The following is an example of output for this query.
SQL20427N An error occurred during a text search administration
procedure or command. The error message from the text search
product is "CIE00322 Specified or default database already
enabled for text. ". SQLSTATE 38H14
606 Administrative Routines and Views
Usage notes
v Text search administration 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.
v When this procedure is run,
– this procedure creates database objects, such as text search administration
catalog tables and views, in the schema SYSIBMTS. These objects are placed
in the default table space of the database (IBMDEFAULTGROUP).
– the established database defaults for text search index are available in view
SYSIBMTS.TSDEFAULTS.
– and when the command has successfully completed, the text search catalog
tables and views are created and are available.
SYSTS_UPDATE procedure - Update the text search index
This 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 performed, 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.
Syntax
SYSTS_UPDATE ( index_schema , index_name ,
update_options , message_locale , message )
The schema is SYSPROC.
Procedure parameters
index_schema
An input argument of type VARCHAR(128) that specifies the schema of the
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
CURRENT SCHEMA is used. The index_schema is case-sensitive.
index_name
An input argument of type VARCHAR(128) that specifies the name of the
index. Together with index_schema, it uniquely identifies a text search index in
a database. The index_name is case-sensitive.
update_options
An input argument of type VARCHAR(32K) that specifies update options. The
possible values are:
v USING UPDATE MINIMUM: this setting respects the UPDATE MINIMUM
settings from the CREATE INDEX text search administration command and
the SYSTS_CREATE procedure.
v NULL or an empty string (″): the update is unconditionally started when the
procedure is called.
Chapter 3. Supported routines and views 607
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
An output argument of type VARCHAR(32K) that specifies a warning or
informational message for a successfully completed operation.
Authorization
EXECUTE privilege on the SYSTS_UPDATE procedure.
The authorization-name for the database connection must have CONTROL
privilege on the table in which the text search index was created.
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. When the procedure succeeds, the output parameter
message indicative of the successful operation is returned to the caller.
CALL SYSPROC.SYSTS_UPDATE(’db2ts’, ’myTextIndex’, ’’, ’en_US’, ?)
The following is an example of output from this query.
Value of output parameters
--------------------------
Parameter Name : MESSAGE
Parameter Value : Operation completed successfully.
Return Status = 0
Example 2: In the following example, SYSTS_UPDATE is called to update a text
search index with index_schema ’db2ts’ and index_name ’myTextIndex’. This index
does not exist and results in an error.
CALL SYSPROC.SYSTS_UPDATE(’db2ts’, ’myTextIndex’, ’USING UPDATE MINIMUM’,
’en_US’, ?)
The following is an example of output from this query.
SQL20427N An error occurred during a text search administration
procedure or command. The error message is "CIE00316 Text search
index "db2ts"."myTextIndex" does not exist. ". SQLSTATE 38H14
Usage notes
v Text search administration 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.
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
608 Administrative Routines and Views
– 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
– STOP FOR TEXT 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 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 (column
COLLECTIONNAME).
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 will reprocess these documents.
v When this procedure is run,
– 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, it creates triggers on the user table.
– the collection is updated: new or changed documents are parsed and indexed
and deleted documents are discarded from the index.
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 )
The schema is SYSPROC.
Procedure parameters
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
Chapter 3. Supported routines and views 609
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
EXECUTE privilege on the WLM_CANCEL_ACTIVITY procedure.
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 for the activity.
WLM_CAPTURE_ACTIVITY_IN_PROGRESS - Collect activity
information for activities event monitor
This procedure causes information on a given activity to be gathered and written
to the active activities event monitor. When applied to an activity that has child
activities, this procedure recursively generates a record for each child activity all
the way down to the lowest level. This information is collected and sent at the
instant this procedure is called. It does not wait until the activity completes
execution. The record of the activity in the event monitor is marked as a partial
record.
Syntax
WLM_CAPTURE_ACTIVITY_IN_PROGRESS ( application_handle ,
uow_id , activity_id )
The schema is SYSPROC.
Procedure parameters
application_handle
An input argument of type BIGINT that specifies the application handle whose
activity is to be captured. 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
610 Administrative Routines and Views
activity that is to be captured. 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 captured. If
the argument is null, no activity will be found and an SQL4702N with
SQLSTATE 5U035 is returned.
Authorization
EXECUTE privilege on the WLM_CAPTURE_ACTIVITY_IN_PROGRESS
procedure.
Example
A particular procedure MYSCHEMA.MYSLOWSTP might be running more slowly
than usual. A user complains and the administrator wants to investigate the cause
of the slowdown. Investigating while the stored procedure is executing can be
impractical, so the administrator has the ability to capture the stored procedure
activity and any of the activities nested within it.
Assuming that an event monitor for DB2 activities named DB2ACTIVITIES exists
and has been activated, the administrator can use the
WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES 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 WLM_CAPTURE_ACTIVITY_IN_PROGRESS as follows:
CALL WLM_CAPTURE_ACTIVITY_IN_PROGRESS(1,2,3)
Once the procedure has completed, for an activity event monitor named
DB2ACTIVITIES, the administrator can use the following table function to find out
where the activity spent its time:
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
Chapter 3. Supported routines and views 611
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
An example of a query to use the table function is:
SELECT * FROM TABLE(SHOWCAPTUREDACTIVITY(1, 2, 3))
AS ACTS ORDER BY UOW_ID, ACTIVITY_ID
Usage notes
If there is no active activities event monitor, an SQL1633W with SQLSTATE 01H53
is returned.
If you are using this procedure to collect activity information, input data values
will not be collected.
WLM_COLLECT_STATS - Collect and reset workload
management statistics
This procedure causes statistics for service classes, workloads, work classes and
threshold queues to be gathered and written to the statistics event monitor. The
statistics for service classes, workloads, work classes and threshold queues are also
reset. If there is no active statistics event monitor, then the statistics are only reset.
Syntax
WLM_COLLECT_STATS ( )
The schema is SYSPROC.
Authorization
EXECUTE privilege on the WLM_COLLECT_STATS procedure.
Examples
Example 1: Call WLM_COLLECT_STATS to collect and reset statistics.
CALL WLM_COLLECT_STATS()
The following is an example of output from this query.
Return Status = 0
Example 2: Call WLM_COLLECT_STATS to collect and reset statistics while another
call is in progress.
CALL WLM_COLLECT_STATS()
The following is an example of output from this query.
SQL1632W The collect and reset statistics request was ignored because
another collect and reset statistics request is already in progress.
612 Administrative Routines and Views
Usage notes
The WLM_COLLECT_STATS procedure is used to manually collect statistics. It
performs the same collect (send statistics to the active statistics event monitor) and
reset operations that occur automatically on the interval defined by the
WLM_COLLECT_INT database configuration parameter. If the procedure is
invoked at the same time as another collect and reset request is in progress (for
example, the procedure is invoked at same time as another invocation of the
procedure is running, or at the same time an automated collection occurs) a
warning, SQL1632W with SQLSTATE 01H53 is returned and the request is ignored.
The WLM_COLLECT_STATS procedure only starts the collection and reset process.
It might return before the process has completed, that is, 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 occurs,
the call to the WLM_COLLECT_STATS procedure (which is itself an activity and
will be counted in activity statistics) might be counted in either the prior collection
interval or the new collection interval that has just started.
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.
Syntax
WLM_GET_ACTIVITY_DETAILS ( application_handle , uow_id ,
activity_id , dbpartitionnum )
The schema is SYSPROC.
Table function 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. 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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid partition number in
the same instance as the currently connected database when calling this
function. Specify a -1 for the current database partition, or -2 for all database
partitions. If a null value is specified, -1 is set implicitly.
Chapter 3. Supported routines and views 613
Authorization
EXECUTE privilege on the WLM_GET_ACTIVITY_DETAILS function.
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 partition. This example is restricted to
showing only an eleven member subset of the name-value pairs for each partition
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 183 on page
615 and Table 184 on page 617.
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’,
’NESTING_LEVEL’,
’INVOCATION_ID’,
’ROUTINE_ID’)
ORDER BY PART
The following is an example of output from this query.
PART NAME VALUE
---- -------------------- ------------------------------
0 APPLICATION_HANDLE 1
0 COORD_PARTITION_NUM 0
0 LOCAL_START_TIME 2005-11-25-18.52.49.343000
0 UOW_ID 1
0 ACTIVITY_ID 5
0 PARENT_UOW_ID 1
0 PARENT_ACTIVITY_ID 3
0 ACTIVITY_TYPE READ_DML
0 NESTING_LEVEL 0
0 INVOCATION_ID 1
0 ROUTINE_ID 0
1 APPLICATION_HANDLE 1
1 COORD_PARTITION_NUM 0
1 LOCAL_START_TIME 2005-11-25-18.52.49.598000
1 UOW_ID 1
1 ACTIVITY_ID 5
1 PARENT_UOW_ID
1 PARENT_ACTIVITY_ID
1 ACTIVITY_TYPE READ_DML
1 NESTING_LEVEL 0
1 INVOCATION_ID 1
1 ROUTINE_ID 0
Usage note
An ACTIVITY_STATE of QUEUED means that the coordinator activity has made a
RPC to the catalog partition 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
614 Administrative Routines and Views
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 partition has a value of
WLM_QUEUE.
Information returned
Table 182. Information returned for WLM_GET_ACTIVITY_DETAILS
Column Name Data Type Description
DBPARTITIONNUM SMALLINT Partition number from which this record was collected.
NAME VARCHAR(256) Element name. See Table 183 and Table 184 on page 617
for possible values.
VALUE VARCHAR(1024) Element values. See Table 183 and Table 184 on page 617
for possible values.
Table 183. Elements returned
Element Name Description
APPLICATION_HANDLE A system-wide unique ID for the application. On a
single-partitioned database, this identifier consists of a 16
bit counter. On a multi-partitioned database, this
identifier consists of the coordinating partition number
concatenated with a 16 bit counter. In addition, this
identifier will be the same on every partition where the
application may make a secondary connection.
COORD_PARTITION_NUM The coordinator partition of the activity.
UOW_ID Unique unit of work identifier within an application.
Refers to the original unit of work this activity started in.
ACTIVITY_ID Unique activity identifier within an application.
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 partition.
PARENT_ACTIVITY_ID Unique activity identifier within a unit of work for the
parent of the activity whose ID is ACTIVITY_ID. Returns
an empty string if the activity has no parent activity.
ACTIVITY_STATE Possible values include:
v CANCEL_PENDING
v EXECUTING
v IDLE
v INITIALIZING
v QP_CANCEL_PENDING
v QP_QUEUED
v QUEUED
v TERMINATING
v UNKNOWN
Chapter 3. Supported routines and views 615
Table 183. Elements returned (continued)
Element Name Description
ACTIVITY_TYPE Possible values include:
v CALL
v DDL
v LOAD
v OTHER
v READ_DML
v WRITE_DML
NESTING_LEVEL This represents the nesting level of this activity. Nesting
level is the depth to which this activity is nested within
its top-most parent activity.
INVOCATION_ID This distinguishes one particular invocation of this
activity from others at the same nesting level. Returns
zero if the activity is not nested.
ROUTINE_ID Routine unique identifier. Returns zero if the activity is
not part of a routine.
UTILITY_ID If the activity is a utility, this is its utility ID. Otherwise,
this field is 0.
SERVICE_CLASS_ID Unique identifier of the service class to which this
activity belongs.
DATABASE_WORK_ACTION_SET_ID 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.
DATABASE_WORK_CLASS_ID 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 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.
SERVICE_CLASS_WORK_ACTION_SET_ID If this activity has been mapped to a work action set that
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.
SERVICE_CLASS_WORK_CLASS_ID If this activity has been mapped to a work action set that
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.
ENTRY_TIME The time that this activity arrived into the system.
LOCAL_START_TIME The time that this activity began doing work on the
partition. It is in local time. This field can be an empty
string when an activity has entered the system but is in a
queue and has not started executing.
LAST_REFERENCE_TIME Every time a request occurs in this activity, this field is
updated.
PACKAGE_NAME If the activity is a SQL statement, this represents the
name of its package.
PACKAGE_SCHEMA If the activity is a SQL statement, this represents the
schema name of its package.
616 Administrative Routines and Views
Table 183. Elements returned (continued)
Element Name Description
PACKAGE_VERSION_ID If the activity is a SQL statement, this represents the
version of its package.
SECTION_NUMBER If the activity is a SQL statement, this represents its
section number.
STMT_PKG_CACHE_ID Statement package cache identifier.
STMT_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. It is an
empty string otherwise.
EFFECTIVE_ISOLATION The effective isolation level for this activity.
EFFECTIVE_LOCK_TIMEOUT The effective lock timeout value for this activity.
EFFECTIVE_QUERY_DEGREE The effective value of query degree for this activity.
QUERY_COST_ESTIMATE Estimated cost, in timerons, for a query, as determined
by the SQL compiler.
ROWS_FETCHED This is the number of rows read from the table. This
reports only those values for the database partition for
which this record is recorded. On DPF systems, these
values may not reflect the correct totals for the whole
activity. When the statement monitor switch is not
turned on, this element is not collected and -1 is written
instead.
ROWS_MODIFIED This is the number of rows inserted, updated, or deleted.
This reports only those values for the database partition
for which this record is recorded. On DPF systems, these
values may not reflect the correct totals for the whole
activity. When the statement monitor switch is not
turned on, this element is not collected and -1 is written
instead.
SYSTEM_CPU_TIME The total system CPU time (in seconds and
microseconds) used by the database manager agent
process, the unit of work, or the statement. When either
the statement monitor switch or the timestamp switch is
not turned on, this element is not collected and -1 is
written instead.
USER_CPU_TIME The total user CPU time (in seconds and microseconds)
used by the database manager agent process, the unit of
work, or the statement. When either the statement
monitor switch or the timestamp switch is not turned on,
this element is not collected and -1 is written instead.
QP_QUERY_ID The query ID assigned to this activity by Query Patroller
if the activity is a query. A query ID of 0 indicates that
Query Patroller did not assign a query ID to this activity.
The following are returned only if the corresponding thresholds apply to the
activity.
Table 184. Elements returned if applicable
Element Name Description
CONCURRENTWORKLOADACTIVITIES_THRESHOLD_ID The ID of the threshold.
Chapter 3. Supported routines and views 617
Table 184. Elements returned if applicable (continued)
Element Name Description
CONCURRENTWORKLOADACTIVITIES_THRESHOLD_VALUE The value that, when exceeded, will
trigger the threshold.
CONCURRENTWORKLOADACTIVITIES_THRESHOLD_VIOLATED Yes indicates that this activity violated
the threshold. No indicates that this
activity has not violated the threshold.
CONCURRENTDBCOORDACTIVITIES_DB_THRESHOLD_ID The ID of the threshold.
CONCURRENTDBCOORDACTIVITIES_DB_THRESHOLD_VALUE The value that, when exceeded, will
trigger the threshold.
CONCURRENTDBCOORDACTIVITIES_DB_THRESHOLD_QUEUED Whether the activity was queued by this
threshold.
CONCURRENTDBCOORDACTIVITIES_DB_THRESHOLD_VIOLATED ’Yes’ indicates that the threshold has
been violated. ’No’ indicates that the
threshold has not yet been violated.
CONCURRENTDBCOORDACTIVITIES_WORK_ACTION_SET The ID of the threshold.
_THRESHOLD_ID
CONCURRENTDBCOORDACTIVITIES_WORK_ACTION_SET The value that, when exceeded, will
_THRESHOLD_VALUE trigger the threshold.
CONCURRENTDBCOORDACTIVITIES_WORK_ACTION_SET ’Yes’ indicates that the activity was
_THRESHOLD_QUEUED queued by this threshold. ’No’ indicates
that the activity was not queued.
CONCURRENTDBCOORDACTIVITIES_WORK_ACTION_SET ’Yes’ indicates that the threshold has
_THRESHOLD_VIOLATED been violated. ’No’ indicates that the
threshold has not yet been violated.
CONCURRENTDBCOORDACTIVITIES_SUPERCLASS The ID of the threshold.
_THRESHOLD_ID
CONCURRENTDBCOORDACTIVITIES_SUPERCLASS The value that, when exceeded, will
_THRESHOLD_VALUE trigger the threshold.
CONCURRENTDBCOORDACTIVITIES_SUPERCLASS ’Yes’ indicates that the activity was
_THRESHOLD_QUEUED queued by this threshold. ’No’ indicates
that the activity was not queued.
CONCURRENTDBCOORDACTIVITIES_SUPERCLASS ’Yes’ indicates that the threshold has
_THRESHOLD_VIOLATED been violated. ’No’ indicates that the
threshold has not yet been violated.
CONCURRENTDBCOORDACTIVITIES_SUBCLASS The ID of the threshold.
_THRESHOLD_ID
CONCURRENTDBCOORDACTIVITIES_SUBCLASS The value that, when exceeded, will
_THRESHOLD_VALUE trigger the threshold.
CONCURRENTDBCOORDACTIVITIES_SUBCLASS Whether the activity was queued by this
_THRESHOLD_QUEUED threshold.
CONCURRENTDBCOORDACTIVITIES_SUBCLASS ’Yes’ indicates that the threshold has
_THRESHOLD_VIOLATED been violated. ’No’ indicates that the
threshold has not yet been violated.
ESTIMATEDSQLCOST_THRESHOLD_ID The ID of the threshold.
ESTIMATEDSQLCOST_THRESHOLD_VALUE The value that, when exceeded, will
trigger the threshold.
ESTIMATEDSQLCOST_THRESHOLD_VIOLATED ’Yes’ indicates that the threshold has
been violated. ’No’ indicates that the
threshold has not yet been violated.
618 Administrative Routines and Views
Table 184. Elements returned if applicable (continued)
Element Name Description
SQLTEMPSPACE_THRESHOLD_ID The ID of the threshold.
SQLTEMPSPACE_THRESHOLD_VALUE The value that, when exceeded, will
trigger the threshold.
SQLTEMPSPACE_THRESHOLD_VIOLATED ’Yes’ indicates that the threshold has
been violated. ’No’ indicates that the
threshold has not yet been violated.
SQLROWSRETURNED_THRESHOLD_ID The ID of the threshold.
SQLROWSRETURNED_THRESHOLD_VALUE The value that, when exceeded, will
trigger the threshold.
SQLROWSRETURNED_THRESHOLD_VIOLATED ’Yes’ indicates that the threshold has
been violated. ’No’ indicates that the
threshold has not yet been violated.
ACTIVITYTOTALTIME_THRESHOLD_ID The ID of the threshold.
ACTIVITYTOTALTIME_THRESHOLD_VALUE A timestamp that is computed by
adding the ACTIVITYTOTALTIME
threshold duration to the activity entry
time. If the activity is still executing
when this timestamp is reached, the
threshold will be violated.
ACTIVITYTOTALTIME_THRESHOLD_VIOLATED ’Yes’ indicates that the threshold has
been violated. ’No’ indicates that the
threshold has not yet been violated.
WLM_GET_QUEUE_STATS table function - Return threshold
queue statistics
This function returns basic statistics for one or more threshold queues.
This function returns one row of statistics for each threshold queue. Statistics are
returned for queues on all active partitions.
Syntax
WLM_GET_QUEUE_STATS ( threshold_predicate , threshold_domain ,
threshold_name , threshold_id )
The schema is SYSPROC.
Table function parameters
threshold_predicate
An input argument of type VARCHAR(27) that specifies a valid threshold
predicate. The possible values are:
v CONCDBC: concurrent database coordinator activities threshold
v DBCONN: total database partition connections threshold
v SCCONN: total service class partition connections threshold
Chapter 3. Supported routines and views 619
v NULL or an empty string: data is returned for all possible threshold
predicates. 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 valid threshold
domain. The possible values are:
v DB: database
v SB: service subclass
v SP: service superclass
v WA: work action set
v NULL or an empty string: data is returned for all possible threshold
domains. 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 valid 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 valid 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.
Authorization
EXECUTE privilege on the WLM_GET_QUEUE_STATS function.
Example
To see all the basic statistics for all the queues on the system, across all partitions:
SELECT substr(THRESHOLD_NAME, 1, 6) THRESHNAME,
THRESHOLD_PREDICATE,
THRESHOLD_DOMAIN,
DBPARTITIONNUM PART,
QUEUE_SIZE_TOP,
QUEUE_TIME_TOTAL,
QUEUE_ASSIGNMENTS_TOTAL QUEUE_ASSIGN
FROM table(WLM_GET_QUEUE_STATS(’’, ’’, ’’, -1)) as QSTATS
The following is an example of output from this query.
THRESHNAME THRESHOLD_PREDICATE THRESHOLD_DOMAIN ...
---------- --------------------------- ------------------ ...
LIMIT1 CONCDBC DB ...
LIMIT2 SCCONN SP ...
LIMIT3 DBCONN DB ...
Output from this query (continued).
... PART QUEUE_SIZE_TOP QUEUE_TIME_TOTAL QUEUE_ASSIGN
... ---- -------------- ---------------- ------------
... 0 12 1238540 734
... 0 4 741249 24
... 0 7 412785 128
620 Administrative Routines and Views
Usage note
No aggregation across queues (on a partition), or across partitions (for a queue or
more) is performed, however this type of aggregation can be achieved using SQL
queries as shown in the example above.
Information returned
Table 185. Information returned for WLM_GET_QUEUE_STATS
Column Name Data Type Description
THRESHOLD_PREDICATE VARCHAR(27) Threshold predicate of the threshold
responsible for this queue. The
possible values are:
v CONCDBC: concurrent database
coordinator activities threshold
v DBCONN: total database partition
connections threshold
v SCCONN: total service class
partition connections threshold
The threshold predicate values match
those of the THRESHOLDPREDICATE
column in the SYSCAT.THRESHOLDS
view.
THRESHOLD_DOMAIN VARCHAR(18) Domain of the threshold responsible
for this queue. The possible values are:
v DB: database
v SB: service subclass
v SP: service superclass
v WA: work action set
The threshold domain values match
those of the DOMAIN column in the
SYSCAT.THRESHOLDS view.
THRESHOLD_NAME VARCHAR(128) The unique name of the threshold
responsible for this queue. The
threshold name value matches that of
the THRESHOLDNAME column in the
SYSCAT.THRESHOLDS view.
THRESHOLD_ID INTEGER The unique ID of the threshold
responsible for this queue. The
threshold ID value matches that of the
THRESHOLDID column in the
SYSCAT.THRESHOLDS view.
DBPARTITIONNUM SMALLINT Partition number from which this
record was collected.
SERVICE_SUPERCLASS_NAME VARCHAR(128) Name of the service superclass that is
the domain for the threshold
responsible for this queue. Null if the
domain of the threshold is not a
service superclass or service subclass.
SERVICE_SUBCLASS_NAME VARCHAR(128) Name of the service subclass that is
the domain for the threshold
responsible for this queue. Null if the
domain of the threshold is not a
service subclass.
Chapter 3. Supported routines and views 621
Table 185. Information returned for WLM_GET_QUEUE_STATS (continued)
Column Name Data Type Description
WORK_ACTION_SET_NAME VARCHAR(128) Name of the work action set that is the
domain for the threshold responsible
for this queue. Null if the domain of
the threshold is not a work action set.
WORK_CLASS_NAME VARCHAR(128) Name of the work class whose work
action belongs to the work action set
that is the domain for the threshold
responsible for this queue. Null if the
domain of the threshold is not a work
action set.
WORKLOAD_NAME VARCHAR(128) Name of the workload that is the
domain for the threshold responsible
for this queue. Null if the domain of
the threshold is not a workload.
LAST_RESET TIMESTAMP Time when statistics were last reset.
There are four events that can occur
that will trigger a reset of statistics,
which will update this timestamp:
v The WLM_COLLECT_STATS
procedure is called.
v The periodic collection and reset
process controlled by the
WLM_COLLECT_INT configuration
parameter causes a collection and
reset.
v The database is reactivated.
v The threshold for which queue
statistics are being reported was
modified and the change was
committed.
The LAST_RESET timestamp is in local
time.
QUEUE_SIZE_TOP INTEGER Highest number of connections or
activities in the queue that has been
reached since the last reset.
QUEUE_TIME_TOTAL BIGINT Sum of the times spent in the queue
for all connections or activities placed
in this queue since the last reset. Units
are milliseconds.
QUEUE_ASSIGNMENTS_TOTAL BIGINT Number of connections or activities
that were assigned to this queue since
the last reset.
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. This is measured in
milliseconds.
QUEUE_EXIT_TIME_LATEST TIMESTAMP Time that the last connection or
activity left the queue.
622 Administrative Routines and Views
Table 185. Information returned for WLM_GET_QUEUE_STATS (continued)
Column Name Data Type Description
THRESHOLD_CURRENT_CONCURRENCY INTEGER Number of connections or activities
that are currently executing according
to the threshold.
THRESHOLD_MAX_CONCURRENCY INTEGER Maximum number of connections or
activities that the threshold allows to
be concurrently executing.
WLM_GET_SERVICE_CLASS_AGENTS - List agents executing
in a service class
This function returns the list of agents, fenced mode processes (db2fmps) and
system entities on the given partition that are executing in the given service class
or on behalf of the given application. The system entities are non-agent threads
and processes, such as page cleaners and prefetchers.
Syntax
WLM_GET_SERVICE_CLASS_AGENTS ( service_superclass_name ,
service_subclass_name , application_handle , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
service_superclass_name
An input argument of type VARCHAR(128) that specifies a valid service
superclass name in the same database as the one currently connected to when
calling this function. If the argument is null or an empty string, data is
retrieved for all the superclasses in the database for which the other
parameters match.
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 for which the other parameters
match.
application_handle
An input argument of type BIGINT that specifies the application handle for
which agent information should be returned. If the argument is null, data is
retrieved for all applications in the database for which the other parameters
match. An application handle of 0 will return the system entities only.
dbpartitionnum
An input argument of type INTEGER that specifies a valid partition number in
the same instance as the currently connected database when calling this
function. Specify a -1 for the current database partition, or -2 for all database
partitions. If a null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the WLM_GET_SERVICE_CLASS_AGENTS function.
Chapter 3. Supported routines and views 623
Example
Return a list of agents that are associated with application handle 1 for all database
partitions. The application handle could have been determined using the LIST
APPLICATIONS command or the
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES 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(CAST(NULL AS VARCHAR(128)),
CAST(NULL AS VARCHAR(128)), 1, -2)) AS SCDETAILS
ORDER BY APPHANDLE, PART, AGENT_TID
The following is an example of output from this query.
APPHANDLE PART AGENT_TID AGENTTYPE AGENTSTATE REQTYPE UOW_ID ACT_ID
--------- ---- --------- ----------- ---------- -------------- ------ ------
1 0 3 COORDINATOR ACTIVE FETCH 1 5
1 0 4 SUBAGENT ACTIVE SUBSECTION:1 1 5
1 1 2 SUBAGENT ACTIVE SUBSECTION:2 1 5
Here we see a coordinator agent and a subagent on partition 0 as well as a
subagent on partition 1 operating on behalf of an activity with UOW id 1 and
activity id 5. The coordinator agent tells us that the request is a fetch request.
Usage note
The parameters have the effect of being ANDed together. That is, if one were to
specify conflicting records such as a service superclass SUP_A and subclass SUB_B
such that SUB_B is not a subclass of SUP_A, no rows would be returned.
Information returned
Table 186. Information returned by WLM_GET_SERVICE_CLASS_AGENTS
Column Name Data Type Description
SERVICE_SUPERCLASS_NAME VARCHAR(128) Name of the service superclass from which this record was
collected.
SERVICE_SUBCLASS_NAME VARCHAR(128) Name of the service subclass from which this record was
collected.
APPLICATION_HANDLE BIGINT A system-wide unique ID for the application. On a
single-partitioned database, this identifier consists of a 16 bit
counter. On a multi-partitioned database, this identifier
consists of the coordinating partition number concatenated
with a 16 bit counter. In addition, this identifier will be the
same on every partition where the application may make a
secondary connection.
DBPARTITIONNUM SMALLINT Partition number from which this record was collected.
ENTITY VARCHAR(32) If the type of entity in this row is an agent, this field shows
″db2agent″. If the type of entity in this row is a fenced mode
process, this field shows ″db2fmp (pid)″ where pid is the
process ID of the fenced mode process. Otherwise, the name
of the system entity is shown.
WORKLOAD_NAME VARCHAR(128) Name of the workload from which this record was collected.
624 Administrative Routines and Views
Table 186. Information returned by WLM_GET_SERVICE_CLASS_AGENTS (continued)
Column Name Data Type Description
WORKLOAD_OCCURRENCE_ID INTEGER The ID of the workload occurrence. This does not uniquely
identify the workload occurrence unless it is coupled with
the coordinator database partition number and the workload
name. Alternatively, the application handle can be used
instead of the coordinator database partition number.
UOW_ID INTEGER Unique unit of work identifier within an application. Refers
to the original unit of work this activity started in.
ACTIVITY_ID INTEGER Unique activity identifier within a unit of work.
PARENT_UOW_ID INTEGER Unique unit of work identifier within an application. Refers
to the original unit of work this activity’s parent activity
started in. Returns null if this activity has no parent.
PARENT_ACTIVITY_ID INTEGER Unique activity identifier within a unit of work for the
parent of the activity whose ID is activity_id. Returns null if
this activity has no parent.
AGENT_TID BIGINT Thread ID of the agent or system entity. If this ID is
unavailable, this field is null.
AGENT_TYPE VARCHAR(32) Coordinator or subagent. If coordinator, the agent ID may
change in concentrator environments. The agent types are
represented by:
v COORDINATOR
v OTHER
v PDBSUBAGENT
v SMPSUBAGENT
SMP_COORDINATOR INTEGER Whether or not the agent is an smp coordinator: 1 for yes
and 0 for no.
AGENT_SUBTYPE VARCHAR(32) Possible subtypes include:
v DSS
v OTHER
v RPC
v SMP
AGENT_STATE VARCHAR(32) Whether an agent is associated or active. The possible values
are:
v ACTIVE
v ASSOCIATED
EVENT_TYPE VARCHAR(32) The type of event last processed by this agent. The possible
values are:
v ACQUIRE
v PROCESS
v WAIT
Chapter 3. Supported routines and views 625
Table 186. Information returned by WLM_GET_SERVICE_CLASS_AGENTS (continued)
Column Name Data Type Description
EVENT_OBJECT VARCHAR(32) The object of the event last processed by this agent. The
possible values are:
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) The state of the event last processed by this agent. The
possible values are:
v EXECUTING
v IDLE
REQUEST_ID VARCHAR(64) Unique only in combination with application_handle. This
can be used for distinguishing between having one request
take a long time versus having multiple requests. For
examples, distinguishing multiple fetches from one long
fetch.
REQUEST_TYPE VARCHAR(32) The type of request. The possible values are:
v For coordinator agents:
– CLOSE
– COMMIT
– COMPILE
– DESCRIBE
– EXCSQLSET
– EXECIMMD
– EXECUTE
– FETCH
– INTERNAL <number>
– OPEN
– PREPARE
– REBIND
– REDISTRIBUTE
– REORG
– ROLLBACK
– RUNSTATS
v For subagents (DSS and SMP):
– displays the subsection number in the form
″SUBSECTION:<subsection number>″ if the subsection
number is non-zero. Otherwise, returns NULL.
626 Administrative Routines and Views
Table 186. Information returned by WLM_GET_SERVICE_CLASS_AGENTS (continued)
Column Name Data Type Description
REQUEST_TYPE (continued) VARCHAR(32) v For subagents (RPC):
– ABP
– CATALOG
– INTERNAL
– REORG
– RUNSTATS
– WLM
v For subagents (OTHER):
– ABP
– APP_RBSVPT
– APP_RELSVPT
– BACKUP
– CLOSE
– EXTERNAL_RBSVPT
– EVMON
– FORCE
– FORCE_ALL
– INTERNAL <number>
– INTERRUPT
– NOOP: if there is no request
– QP
– REDISTRIBUTE
– STMT_RBSVPT
– STOP_USING
– UPDATE_DBM_CFG
– WLM
If the request type is one of the internal types, the value is
displayed as ’INTERNAL’ followed by the actual value of
the internal constant.
NESTING_LEVEL INTEGER This represents the nesting level of the activity whose ID is
activity_id. Nesting level is the depth to which this activity
is nested within its top-most parent activity.
INVOCATION_ID INTEGER This distinguishes one particular invocation of an activity
from others at the same nesting level.
ROUTINE_ID INTEGER Routine unique identifier. Null if not part of a routine.
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES -
List of workload occurrences
This function returns the list of all workload occurrences executing in a given
service class on a particular partition. 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.
Chapter 3. Supported routines and views 627
Syntax
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES ( service_superclass_name ,
service_subclass_name , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
service_superclass_name
An input argument of type VARCHAR(128) that specifies a valid service
superclass name in the currently connected database. If the argument is null or
an empty string, the data is retrieved for all the superclasses in the database
for which the other parameters match.
service_subclass_name
An input argument of type VARCHAR(128) that specifies a valid service
superclass name in the currently connected database. If the argument is null or
an empty string, the data is retrieved for all the subclasses in the database for
which the other parameters match.
dbpartitionnum
An input argument of type INTEGER that specifies a valid partition number in
the same instance as the currently connected database. Indicate -1 for the
current database partition, or -2 for all database partitions. If the null value is
specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES function.
Example
If an administrator would like to see what workload occurrences are running on
the system as a whole, the
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES function can be
called with a null value or an empty string for service_superclass_name and
service_subclass_name, and -2 for dbpartitionnum.
SELECT SUBSTR(SERVICE_SUPERCLASS_NAME,1,19) AS SUPERCLASS_NAME,
SUBSTR(SERVICE_SUBCLASS_NAME,1,18) AS SUBCLASS_NAME,
SUBSTR(CHAR(DBPARTITIONNUM),1,4) AS PART,
SUBSTR(CHAR(COORD_PARTITION_NUM),1,4) AS COORDPART,
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, PART, APPHNDL,
WORKLOAD_NAME, WLO_ID
Assuming that the system has four database partitions and is running two
workloads at this time, the above query would produce a result like the following:
SUPERCLASS_NAME SUBCLASS_NAME PART COORDPART ...
------------------- ------------------ ---- --------- ...
SYSDEFAULTMAINTENAN SYSDEFAULTSUBCLASS 0 0 ...
SYSDEFAULTSYSTEMCLA SYSDEFAULTSUBCLASS 0 0 ...
628 Administrative Routines and Views
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 0 0 ...
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 0 0 ...
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 1 0 ...
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 1 0 ...
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 2 0 ...
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 2 0 ...
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 3 0 ...
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 3 0 ...
Output from this query (continued).
... APPHNDL WORKLOAD_NAME WLO_ID
... ------- ---------------------- ------
... - - -
... - - -
... 1 SYSDEFAULTUSERWORKLOAD 1
... 2 SYSDEFAULTUSERWORKLOAD 2
... 1 SYSDEFAULTUSERWORKLOAD 1
... 2 SYSDEFAULTUSERWORKLOAD 2
... 1 SYSDEFAULTUSERWORKLOAD 1
... 2 SYSDEFAULTUSERWORKLOAD 2
... 1 SYSDEFAULTUSERWORKLOAD 1
... 2 SYSDEFAULTUSERWORKLOAD 2
Usage note
The parameters have the effect of being ANDed together. That is, if one were to
specify conflicting records such as a service superclass SUP_A and subclass SUB_B
such that SUB_B is not a subclass of SUP_A, no rows would be returned.
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.
Information returned
Table 187. Information returned for WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES
Column Name Data Type Description
SERVICE_SUPERCLASS_NAME VARCHAR(128) Name of the service superclass from which this
record was collected.
SERVICE_SUBCLASS_NAME VARCHAR(128) Name of the service subclass from which this
record was collected.
DBPARTITIONNUM SMALLINT Partition number from which this record was
collected.
COORD_PARTITION_NUM SMALLINT Partition number of the coordinator partition of
the given workload occurrence.
APPLICATION_HANDLE BIGINT A system-wide unique ID for the application.
On a single-partitioned database, this identifier
consists of a 16 bit counter. On a
multi-partitioned database, this identifier
consists of the coordinating partition number
concatenated with a 16 bit counter. In addition,
this identifier will be the same on every
partition where the application may make a
secondary connection.
WORKLOAD_NAME VARCHAR(128) Name of the workload from which this record
was collected.
Chapter 3. Supported routines and views 629
Table 187. Information returned for WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES (continued)
Column Name Data Type Description
WORKLOAD_OCCURRENCE_ID INTEGER The ID of the workload occurrence. This does
not uniquely identify the workload occurrence
unless it is coupled with the coordinator
database partition number and the workload
name. Alternatively, the application handle can
be used instead of the coordinator database
partition number.
WORKLOAD_OCCURRENCE_STATE VARCHAR(32) Possible values include:
v DECOUPLED - Workload occurrence does not
have a coordinator agent assigned
(concentrator case).
v DISCONNECTPEND - Workload occurrence
is disconnecting from the database
v FORCED - Workload occurrence has been
forced.
v INTERRUPTED - Workload occurrence has
been interrupted.
v QUEUED - Workload occurrence coordinator
agent is queued by Query Patroller or a
workload management queuing threshold. In
a database partitioning feature (DPF)
environment, this state may indicate that the
coordinator agent has made an RPC to the
catalog partition to obtain threshold tickets
and has not yet received a response.
v TRANSIENT - Workload occurrence has not
yet been mapped to a service superclass.
v UOWEXEC - Workload occurrence is
processing a request.
v UOWWAIT - Workload occurrence is waiting
for a request from the client.
UOW_ID INTEGER Unique unit of work identifier within an
application. Refers to the original unit of work
this workload occurrence started in.
SYSTEM_AUTH_ID VARCHAR(128) System authorization ID under which the
workload occurrence was injected into the
system.
SESSION_AUTH_ID VARCHAR(128) Session authorization ID under which the
workload occurrence was injected into the
system.
APPLICATION_NAME VARCHAR(128) The name of the application that created this
workload occurrence.
CLIENT_WRKSTNNAME VARCHAR(255) The current value of the
CLIENT_WRKSTNNAME special register for
this workload occurrence.
CLIENT_ACCTNG VARCHAR(255) The current value of the CLIENT_ACCTNG
special register for this workload occurrence.
CLIENT_USER VARCHAR(255) The current value of the CLIENT_USER special
register for this workload occurrence.
CLIENT_APPLNAME VARCHAR(255) The current value of the CLIENT_APPLNAME
special register for this workload occurrence.
630 Administrative Routines and Views
Table 187. Information returned for WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES (continued)
Column Name Data Type Description
COORD_ACT_COMPLETED_TOTAL INTEGER The number of coordinator activities at any
nesting level completed so far in the current
unit of work of this workload occurrence. This
statistic is updated every time an activity in this
workload occurrence completes and is reset at
the beginning of each unit of work.
COORD_ACT_ABORTED_TOTAL INTEGER The number of coordinator activities aborted so
far in the current unit of work of this workload
occurrence. This statistic is updated every time
an activity in this workload occurrence is
aborted and is reset at the beginning of each
unit of work.
COORD_ACT_REJECTED_TOTAL INTEGER The number of coordinator activities rejected so
far in the current unit of work of this workload
occurrence. Activities are counted as rejected
when they are prevented from executing by
either a prevent execution work action, or a
predictive threshold. This statistic is updated
every time an activity in this workload
occurrence is rejected and is reset at the
beginning of each unit of work.
CONCURRENT_ACT_TOP INTEGER Highest number of concurrent activities at any
nesting level in either executing (which includes
idle and waiting) or queued state that has been
reached for this workload occurrence in the
current unit of work. This statistic is reset at the
beginning of each unit of work.
WLM_GET_SERVICE_SUBCLASS_STATS - Return statistics of
service subclasses
This function returns basic statistics of one or more service subclasses.
Syntax
WLM_GET_SERVICE_SUBCLASS_STATS ( service_superclass_name ,
service_subclass_name , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
service_superclass_name
An input argument of type VARCHAR(128) that specifies a valid service
superclass name in the same database as the one currently connected to when
calling this function. If the argument is null or an empty string, the data is
retrieved for all the superclasses in the database.
service_subclass_name
An input argument of type VARCHAR(128) that specifies a valid service
subclass name in the same database as the one currently connected to when
Chapter 3. Supported routines and views 631
calling this function. If the argument is null or an empty string, the data is
retrieved for all the subclasses in the database.
dbpartitionnum
An input argument of type INTEGER that specifies a valid partition number in
the same instance as the currently connected database when calling this
function. Specify a -1 for the current database partition, or -2 for all database
partitions. If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the WLM_GET_SERVICE_SUBCLASS_STATS function.
Examples
Example 1: Since every activity has to be mapped to a DB2 Service Class prior to
being executed, the global state of the system can be regularly monitored using the
service class statistics table functions and querying all the service classes on all the
partitions (note that passing a null value for an argument is saying to not restrict
the result by that argument, except for the last argument, dbpartitionnum, where
-2 means that data from all database partitions are to be returned). The following
statement returns service class statistics such as average activity lifetime and
standard deviation in seconds:
SELECT SUBSTR(SERVICE_SUPERCLASS_NAME,1,19) AS SUPERCLASS_NAME,
SUBSTR(SERVICE_SUBCLASS_NAME,1,18) AS SUBCLASS_NAME,
SUBSTR(CHAR(DBPARTITIONNUM),1,4) AS PART,
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(CAST(NULL AS VARCHAR(128)),
CAST(NULL AS VARCHAR(128)), -2)) AS SCSTATS
ORDER BY SUPERCLASS_NAME, SUBCLASS_NAME, PART
The following is an example of output from this query.
SUPERCLASS_NAME SUBCLASS_NAME PART ...
------------------- ------------------ ---- ...
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 0 ...
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 1 ...
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 2 ...
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 3 ...
Output from this query (continued).
... 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.
SELECT SUBSTR(SERVICE_SUPERCLASS_NAME,1,19) AS SUPERCLASS_NAME,
SUBSTR(SERVICE_SUBCLASS_NAME,1,18) AS SUBCLASS_NAME,
SUBSTR(CHAR(DBPARTITIONNUM),1,4) AS PART,
CONCURRENT_ACT_TOP AS ACTTOP,
CONCURRENT_WLO_TOP AS CONNTOP
632 Administrative Routines and Views
FROM TABLE(WLM_GET_SERVICE_SUBCLASS_STATS(CAST(NULL AS VARCHAR(128)),
CAST(NULL AS VARCHAR(128)), -2)) AS SCSTATS
ORDER BY SUPERCLASS_NAME, SUBCLASS_NAME, PART
The following is an example of output from this query.
SUPERCLASS_NAME SUBCLASS_NAME PART ACTTOP CONNTOP
------------------- ------------------ ---- --------- ---------
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 0 10 7
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 1 0 0
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 2 0 0
SYSDEFAULTUSERCLASS SYSDEFAULTSUBCLASS 3 0 0
The output of this table function will give the administrator a good high level view
of the ″load″ on each partition for a specific database by checking the average
execution times and numbers of activities. Any significant variations of the high
level gauges returned by these table functions may indicate a change in the load
on the system.
Usage notes
Some statistics will only be returned if the COLLECT AGGREGATE ACTIVITY
DATA and COLLECT AGGREGATE REQUEST DATA settings for the
corresponding service subclass are set to a value other than NONE.
The WLM_GET_SERVICE_SUBCLASS_STATS table function returns one row of
data per service subclass and per partition. No aggregation across service classes
(on a partition), or across partitions (for a service class or more) is performed.
However, aggregation can be achieved through SQL queries as shown in the
examples above.
The parameters have the effect of being ANDed together. That is, if one were to
specify conflicting records such as a superclass name SUPA and subclass name
SUBB such that SUBB is not a subclass of SUPA, no rows would be returned.
Information returned
Table 188. Information returned for WLM_GET_SERVICE_SUBCLASS_STATS
Column Name Data Type Description
SERVICE_SUPERCLASS_NAME VARCHAR(128) Name of the service superclass from which
this record was collected.
SERVICE_SUBCLASS_NAME VARCHAR(128) Name of the service subclass from which this
record was collected.
DBPARTITIONNUM SMALLINT Partition number from which this record was
collected.
Chapter 3. Supported routines and views 633
Table 188. Information returned for WLM_GET_SERVICE_SUBCLASS_STATS (continued)
Column Name Data Type Description
LAST_RESET TIMESTAMP Time when statistics were last reset. There are
four events that can occur that will trigger a
reset of statistics, which will update this
timestamp:
v The WLM_COLLECT_STATS procedure is
called.
v The periodic collection and reset process
controlled by the WLM_COLLECT_INT
configuration parameter causes a collection
and reset.
v The database is reactivated.
v The service subclass for which statistics are
being reported was modified and the
change was committed.
The LAST_RESET timestamp is in local time.
COORD_ACT_COMPLETED_TOTAL BIGINT The total number of coordinator activities that
users have submitted since the last reset and
completed successfully. This count is updated
as each activity completes.
COORD_ACT_ABORTED_TOTAL BIGINT The total number of coordinator activities that
users have submitted since the last reset and
completed with errors. This count is updated
as each activity aborts.
COORD_ACT_REJECTED_TOTAL BIGINT The total number of coordinator activities that
users have submitted since the last reset and
were rejected prior to execution instead of
being allowed to execute. Activities are
counted as rejected when they are prevented
from executing by either a prevent execution
work action, or a predictive threshold. This
count is updated as each activity gets
rejected.
CONCURRENT_ACT_TOP INTEGER Highest number of concurrent activities at
any nesting level in either executing (which
includes idle and waiting) or queued state
that has been reached for this service
subclass.
COORD_ACT_LIFETIME_TOP BIGINT High watermark for coordinator activity
lifetime, counted at all nesting levels. Null
when COLLECT AGGREGATE ACTIVITY
DATA of service class is NONE. Units are
milliseconds.
COORD_ACT_LIFETIME_AVG DOUBLE Arithmetic mean of lifetime for coordinator
activities at nesting level 0 associated with
this service subclass since the last reset. If the
internally tracked average has overflowed,
the value -2 is returned. Null when
COLLECT AGGREGATE ACTIVITY DATA of
service class is NONE. Units are milliseconds.
634 Administrative Routines and Views
Table 188. Information returned for WLM_GET_SERVICE_SUBCLASS_STATS (continued)
Column Name Data Type Description
COORD_ACT_LIFETIME_STDDEV DOUBLE Standard deviation of lifetime for coordinator
activities at nesting level 0 associated with
this service subclass since the last reset. Null
when COLLECT AGGREGATE ACTIVITY
DATA of service class is NONE. Units are
milliseconds. This standard deviation is
computed from the coordinator activity
lifetime histogram and may be inaccurate if
the histogram has not been properly sized to
fit the data. The value of -1 will be returned if
any values fall into the last histogram bin.
COORD_ACT_EXEC_TIME_AVG DOUBLE Arithmetic mean of the execution times for
coordinator activities at nesting level 0
associated with this service subclass since the
last reset. If the internally tracked average has
overflowed, the value -2 is returned. Null
when COLLECT AGGREGATE ACTIVITY
DATA of service class is NONE. Units are
milliseconds.
COORD_ACT_EXEC_TIME_STDDEV DOUBLE Standard deviation of the execution times for
coordinator activities at nesting level 0
associated with this service subclass since the
last reset. Units are milliseconds. This
standard deviation is computed from the
coordinator activity executetime histogram
and might be inaccurate if the histogram has
not been properly sized to fit the data. The
value of -1 will be returned if any values fall
into the last histogram bin.
COORD_ACT_QUEUE_TIME_AVG DOUBLE Arithmetic mean of the queue time for
coordinator activities at nesting level 0
associated with this service subclass since the
last reset. If the internally tracked average has
overflowed, the value -2 is returned. Null
when COLLECT AGGREGATE ACTIVITY
DATA of service class is NONE. Units are
milliseconds.
COORD_ACT_QUEUE_TIME_STDDEV DOUBLE Standard deviation of the queue time for
coordinator activities at nesting level 0
associated with this service subclass since the
last reset. Null when COLLECT
AGGREGATE ACTIVITY DATA of service
class is NONE. Units are milliseconds. This
standard deviation is computed from the
coordinator activity queuetime histogram and
may be inaccurate if the histogram has not
been properly sized to fit the data. The value
of -1 will be returned if any values fall into
the last histogram bin.
NUM_REQUESTS_ACTIVE BIGINT The number of requests that are executing in
the service subclass at the time this table
function is executed.
Chapter 3. Supported routines and views 635
Table 188. Information returned for WLM_GET_SERVICE_SUBCLASS_STATS (continued)
Column Name Data Type Description
NUM_REQUESTS_TOTAL BIGINT The number of requests to finish executing in
this service subclass since the last reset. This
applies to any request regardless of its
membership in an activity. If COLLECT
AGGREGATE REQUEST DATA on this
service subclass is set to NONE, the value of
this column is NULL.
REQUEST_EXEC_TIME_AVG DOUBLE Arithmetic mean of the execution times for
requests associated with this service subclass
since the last reset. Units are milliseconds. If
the internally tracked average has
overflowed, the value -2 is returned. If
COLLECT AGGREGATE REQUEST DATA on
this service class is set to NONE, the value of
this column is NULL.
REQUEST_EXEC_TIME_STDDEV DOUBLE Standard deviation of the execution times for
requests associated with this service subclass
since the last reset. Units are milliseconds. If
COLLECT AGGREGATE REQUEST DATA on
this service class is set to NONE, the value of
this column is NULL. This standard deviation
is computed from the request executetime
histogram and may be inaccurate if the
histogram has not been properly sized to fit
the data. The value of -1 will be returned if
any values fall into the last histogram bin.
REQUEST_EXEC_TIME__TOTAL BIGINT Sum of the execution times for requests
associated with this service subclass since the
last reset. Units are milliseconds. If COLLECT
AGGREGATE REQUEST DATA on this
service class is set to NONE, the value of this
column is NULL.
WLM_GET_SERVICE_SUPERCLASS_STATS - Return statistics
of service superclasses
This function returns basic statistics of one or more service superclasses.
Syntax
WLM_GET_SERVICE_SUPERCLASS_STATS ( service_superclass_name ,
dbpartitionnum )
The schema is SYSPROC.
Table function parameters
service_superclass_name
An input argument of type VARCHAR(128) that specifies a valid service
superclass name in the same database as the one currently connected to when
calling this function. If the argument is null or an empty string, the data is
retrieved for all the superclasses in the database.
636 Administrative Routines and Views
dbpartitionnum
An input argument of type INTEGER that specifies a valid partition number in
the same instance as the currently connected database when calling this
function. Specify a -1 for the current database partition, or -2 for all database
partitions. If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the WLM_GET_SERVICE_SUPERCLASS_STATS function.
Example
To see all the basic statistics for all the service superclasses on the system, across
all database partitions:
SELECT SUBSTR(SERVICE_SUPERCLASS_NAME, 1, 26) SERVICE_SUPERCLASS_NAME,
DBPARTITIONNUM,
LAST_RESET,
CONCURRENT_CONNECTION_TOP CONCURRENT_CONN_TOP
FROM TABLE(WLM_GET_SERVICE_SUPERCLASS_STATS(’’, -2)) as SCSTATS
The following is an example of output from this query.
SERVICE_SUPERCLASS_NAME DBPARTITIONNUM ...
-------------------------- -------------- ...
SYSDEFAULTSYSTEMCLASS 0 ...
SYSDEFAULTMAINTENANCECLASS 0 ...
SYSDEFAULTUSERCLASS 0 ...
Output from this query (continued).
... 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
Usage note
The WLM_GET_SERVICE_SUPERCLASS_STATS table function returns one row of
data per service superclass and per partition. No aggregation across service
superclasses (on a partition), or across partitions (for a service superclass or more)
is performed. However, aggregation can be achieved through SQL queries as
shown in the example above.
Information returned
Table 189. Information returned for WLM_GET_SERVICE_SUPERCLASS_STATS
Column Name Data Type Description
SERVICE_SUPERCLASS_NAME VARCHAR(128) Name of the service superclass from which this
record was collected.
DBPARTITIONNUM SMALLINT Partition number from which this record was
collected.
Chapter 3. Supported routines and views 637
Table 189. Information returned for WLM_GET_SERVICE_SUPERCLASS_STATS (continued)
Column Name Data Type Description
LAST_RESET TIMESTAMP Time when statistics were last reset. There are four
events that can occur that will trigger a reset of
statistics, which will update this timestamp:
v The WLM_COLLECT_STATS procedure is
called.
v The periodic collection and reset process
controlled by the WLM_COLLECT_INT
configuration parameter causes a collection and
reset.
v The database is reactivated.
v The service superclass for which statistics are
being reported was modified and the change
was committed.
The LAST_RESET timestamp is in local time.
CONCURRENT_CONNECTION_TOP INTEGER Highest number of concurrent coordinator
connections that has been reached in this class
since the last reset.
WLM_GET_WORK_ACTION_SET_STATS - Return work action
set statistics
This function returns the statistics for a work action set.
Syntax
WLM_GET_WORK_ACTION_SET_STATS ( work_action_set_name ,
dbpartitionnum )
The schema is SYSPROC.
Table function parameters
work_action_set_name
An input argument of type VARCHAR(128) that specifies the specific work
action set to return statistics for. If the argument is null or an empty string,
statistics are returned for all work action sets.
dbpartitionnum
An input argument of type INTEGER that specifies a valid partition number in
the same instance as the currently connected database when calling this
function. Specify a -1 for the current database partition, or -2 for all database
partitions. If the null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the WLM_GET_WORK_ACTION_SET_STATS function.
638 Administrative Routines and Views
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
partition 0, there are 8 activities currently executing (or queued) in the ReadClass,
4 activities currently executing (or queued) in the WriteClass, 2 activities currently
executing (or queued) in the LoadClass, and 3 activities currently executing (or
queued) that have not been assigned to any work class. Because there is no work
action associated with the WriteClass work class, the 4 activities to which it applies
are counted in the artificial “*” class along with the 3 activities that were not
assigned to any work class.
SELECT SUBSTR(WORK_ACTION_SET_NAME,1,18) AS WORK_ACTION_SET_NAME,
SUBSTR(CHAR(DBPARTITIONNUM),1,4) AS PART,
SUBSTR(WORK_CLASS_NAME,1,15) AS WORK_CLASS_NAME,
LAST_RESET,
SUBSTR(CHAR(WLO_ACT_TOTAL),1,14) AS TOTAL_WLO_ACTS
FROM TABLE(WLM_GET_WORK_ACTION_SET_STATS
(CAST(NULL AS VARCHAR(128)), -2)) AS WASSTATS
ORDER BY WORK_ACTION_SET_NAME, WORK_CLASS_NAME, PART
The following in an example of output from this query.
WORK_ACTION_SET_NAME PART WORK_CLASS_NAME LAST_RESET TOTAL_WLO_ACTS
-------------------- ---- --------------- -------------------------- --------------
AdminActionSet 0 ReadClass 2005-11-25-18.52.49.343000 8
AdminActionSet 1 ReadClass 2005-11-25-18.52.50.478000 0
AdminActionSet 0 LoadClass 2005-11-25-18.52.49.343000 2
AdminActionSet 1 LoadClass 2005-11-25-18.52.50.478000 0
AdminActionSet 0 * 2005-11-25-18.52.49.343000 7
AdminActionSet 1 * 2005-11-25-18.52.50.478000 0
Information returned
Table 190. Information returned for WLM_GET_WORK_ACTION_SET_STATS
Column Name Data Type Description
WORK_ACTION_SET_NAME VARCHAR(128) The name of the work action set.
DBPARTITIONNUM SMALLINT Partition number from which this record was collected.
LAST_RESET TIMESTAMP Time when statistics were last reset. There are four events
that can occur that will trigger a reset of statistics, which
will update this timestamp:
v The WLM_COLLECT_STATS procedure is called.
v The periodic collection and reset process controlled by
the WLM_COLLECT_INT configuration parameter
causes a collection and reset.
v The database is reactivated.
v The work action set for which statistics are being
reported was modified and the change was committed.
The LAST_RESET timestamp is in local time.
WORK_CLASS_NAME VARCHAR(128) The name of the work class related to the given work
action set. There must be a work action associated with
this work class for it to appear in this table. “*” represents
an artificial work class created to count all those activities
that did not belong to the other work classes for which
the user associated one or more work actions.
Chapter 3. Supported routines and views 639
Table 190. Information returned for WLM_GET_WORK_ACTION_SET_STATS (continued)
Column Name Data Type Description
ACT_TOTAL BIGINT The number of activities of any nesting level that were
assigned to the work class given by
WORK_CLASS_NAME.
WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES - Return
a list of activities
This function returns the list of all activities that were submitted through the given
application on the specified partition and have not yet completed.
Syntax
WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES ( application_handle ,
dbpartitionnum )
The schema is SYSPROC.
Table function parameters
application_handle
An input argument of type BIGINT that specifies an application handle for
which a list of activities is returned. If the argument is null, the data is
retrieved for all the applications in the database for which the other parameters
match.
dbpartitionnum
An input argument of type INTEGER that specifies a valid partition number in
the same instance as the currently connected database when calling this
function. Specify a -1 for the current database partition, or -2 for all database
partitions. If the nullvalue is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES
function.
Example
Once an application handle is identified, it is possible to look up all the activities
currently running in this application. For example, suppose an administrator
wishes to list the activities of an application whose application handle, determined
using the list applications command, was found to be 1:
SELECT SUBSTR(CHAR(COORD_PARTITION_NUM),1,5) AS COORD,
SUBSTR(CHAR(DBPARTITIONNUM),1,4) AS PART,
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(1, -2)) AS WLOACTS
ORDER BY PART, UOWID, ACTID
640 Administrative Routines and Views
The following is an example of output from this query.
COORD PART UOWID ACTID PARUOWID PARACTID ACTTYPE NESTING
----- ---- ----- ----- -------- -------- -------- -------
0 0 2 3 - - CALL 0
0 0 2 5 2 3 READ_DML 1
Information returned
Table 191. Information returned by WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES
Column Name Data Type Description
APPLICATION_HANDLE BIGINT A system-wide unique ID for the
application. On a single-partitioned
database, this identifier consists of a 16 bit
counter. On a multi-partitioned database,
this identifier consists of the coordinating
partition number concatenated with a 16 bit
counter. In addition, this identifier will be
the same on every partition where the
application may make a secondary
connection.
DBPARTITIONNUM SMALLINT Partition number from which this record
was collected.
COORD_PARTITION_NUM SMALLINT The coordinator partition of the activity.
LOCAL_START_TIME TIMESTAMP The time that this activity began doing work
on the partition. It is in local time. This field
can be null when an activity has entered the
system but is in a queue and has not started
executing.
UOW_ID INTEGER Unique unit of work identifier within an
application. Refers to the original unit of
work that the activity started in.
ACTIVITY_ID INTEGER Unique activity ID within a unit of work.
PARENT_UOW_ID INTEGER Unique unit of work identifier within an
application. Refers to the original unit of
work that the activity’s parent activity
started in. Returns null if the activity has no
parent activity or at remote partition.
PARENT_ACTIVITY_ID INTEGER Unique activity identifier within a unit of
work for the parent of the activity whose ID
is ACTIVITY_ID. Returns null if the activity
has no parent activity or at remote partition.
Chapter 3. Supported routines and views 641
Table 191. Information returned by WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES (continued)
Column Name Data Type Description
ACTIVITY_STATE VARCHAR(32) Possible values are:
v CANCEL_PENDING - Activity was
cancelled when there was no agent
actively working on a request for the
activity. The next time a request is
submitted as part of the activity, the
activity will be cancelled and the user
who submitted the activity will receive an
SQL4725N error.
v EXECUTING - Agents are actively
working on a request for the activity.
v IDLE - There is no agent actively
processing a request for the activity.
v INITIALIZING - Activity has been
submitted, but has not yet started
executing. During the initializing state,
predictive thresholds are applied to the
activity to determine whether or not the
activity will be allowed to execute.
v QP_CANCEL_PENDING - Same as the
CANCEL_PENDING state, but the activity
was cancelled by query patroller rather
than by the WLM_CANCEL_ACTIVITY
procedure.
v QP_QUEUED - Activity is queued by
Query Patroller.
v QUEUED - Activity is queued by a
workload management queuing threshold.
In a database partitioning feature (DPF)
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. Seeing this state might indicate
that the activity has been queued by a
workload management queuing threshold
or, over short periods of time, can 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 and find out whether this agent’s
EVENT_OBJECT at the catalog partition
has a value of WLM_QUEUE.
v TERMINATING - Activity has completed
execution and is being removed from the
system.
642 Administrative Routines and Views
Table 191. Information returned by WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES (continued)
Column Name Data Type Description
ACTIVITY_TYPE VARCHAR(32) Possible values are:
v CALL
v DDL
v LOAD
v OTHER
v READ_DML
v WRITE_DML
Refer to “Work class work types and SQL
statements” in Workload Manager Guide and
Reference for a description of the different
types of SQL statements that are associated
with each activity type.
NESTING_LEVEL INTEGER This represents the nesting level of this
activity. Nesting level is the depth to which
this activity is nested within its top-most
parent activity.
INVOCATION_ID INTEGER This distinguishes one particular invocation
of this activity from others at the same
nesting level.
ROUTINE_ID INTEGER Routine unique identifier.
UTILITY_ID INTEGER If the activity is a utility, this is its utility ID.
Otherwise, this field is null.
SERVICE_CLASS_ID INTEGER Unique identifier of the service class to
which this activity belongs.
DATABASE_WORK_ACTION_SET_ID INTEGER If this activity has been categorized into a
work class of database scope, this column
contains the ID of the work class set of
which this work class is a member. This
column contains null if the activity has not
been categorized into a work class of
database scope.
DATABASE_WORK_CLASS_ID INTEGER If this activity has been categorized into a
work class of database scope, this column
contains the ID of the work class. This
column contains null if the activity has not
been categorized into a work class of
database scope.
SERVICE_CLASS_WORK_ACTION_SET_ID INTEGER If this activity has been categorized into a
work class of service class scope, this
column contains the ID of the work action
set associated with the work class set to
which the work class belongs. This column
contains null if the activity has not been
categorized into a work class of service class
scope.
Chapter 3. Supported routines and views 643
Table 191. Information returned by WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES (continued)
Column Name Data Type Description
SERVICE_CLASS_WORK_CLASS_ID INTEGER If this activity has been categorized into a
work class of service class scope, this
column contains the ID of the work class
assigned to this activity. This column
contains null if the activity has not been
categorized into a work class of service class
scope.
WLM_GET_WORKLOAD_STATS - Return workload statistics
This function returns workload statistics for every combination of workload name
and database partition number.
Syntax
WLM_GET_WORKLOAD_STATS ( workload_name , dbpartitionnum )
The schema is SYSPROC.
Table function parameters
workload_name
An input augment of type VARCHAR(128) that specifies a specific workload
for which the statistics are to be returned. If the argument is NULL or an
empty string, statistics are returned for all workloads.
dbpartitionnum
An input argument of type INTEGER that specifies a valid partition number in
the same instance as the currently connected database when calling this
function. Specify a -1 for the current database partition, or -2 for all database
partitions. If a null value is specified, -1 is set implicitly.
Authorization
EXECUTE privilege on the WLM_GET_WORKLOAD_STATS function.
Example
An administrator may want to look at the statistics for workloads. She could do so
using the following query:
SELECT SUBSTR(WORKLOAD_NAME,1,22) AS WL_DEF_NAME,
SUBSTR(CHAR(DBPARTITIONNUM),1,4) AS PART,
CONCURRENT_WLO_TOP AS WLO_TOP,
CONCURRENT_WLO_ACT_TOP AS WLO_ACT_TOP
FROM TABLE(WLM_GET_WORKLOAD_STATS(CAST(NULL AS VARCHAR(128)), -2))
AS WLSTATS
ORDER BY WL_DEF_NAME, PART
The following is an example of output from this query.
WL_DEF_NAME PART WLO_TOP WLO_ACT_TOP
---------------------- ---- --------------- -------------------
MYUSERWORKLOAD 0 2 8
644 Administrative Routines and Views
MYUSERWORKLOAD 1 0 0
SYSDEFAULTUSERWORKLOAD 0 1 1
SYSDEFAULTUSERWORKLOAD 1 0 0
Here we see that on partition 0, the highest number of concurrent occurrences of
the MYUSERWORKLOAD workload was 2 and that the highest number of
concurrent activities in either of these workload occurrences was 8.
Usage note
This function returns one row for every combination of workload name and
database partition number. No aggregation across workloads or across partitions or
across service classes is performed. However, aggregation can be achieved through
SQL queries.
Information returned
Table 192. Information returned by WLM_GET_WORKLOAD_STATS
Column Name Data Type Description
WORKLOAD_NAME BIGINT Name of the workload from which this record was
collected.
DBPARTITIONNUM SMALLINT Partition number from which this record was
collected
LAST_RESET TIMESTAMP Time when statistics were last reset. There are four
events that can occur that will trigger a reset of
statistics, which will update this timestamp:
v The WLM_COLLECT_STATS procedure is called.
v The periodic collection and reset process controlled
by the WLM_COLLECT_INT configuration
parameter causes a collection and reset.
v The database is reactivated.
v The workload for which statistics are being
reported was modified and the change was
committed.
The LAST_RESET timestamp is in local time.
CONCURRENT_WLO_TOP INTEGER Highest number of concurrent occurrences of the
given workload on this partition since the last reset.
CONCURRENT_WLO_ACT_TOP INTEGER Highest number of concurrent activities (including
both coordinator and nested) in either executing
(which includes idle and waiting) or queued state that
has been reached in any occurrence of this workload
since last reset. Updated by each workload occurrence
at the end of its unit of work.
COORD_ACT_COMPLETED_TOTAL BIGINT The total number of coordinator activities at any
nesting level assigned to any occurrence of this
workload that completed since the last reset. Updated
by each workload occurrence at the end of its unit of
work.
COORD_ACT_ABORTED_TOTAL BIGINT The total number of coordinator activities at any
nesting level assigned to any occurrence of this
workload that were aborted prior to completion since
the last reset. Updated by each workload occurrence
at the end of its unit of work.
Chapter 3. Supported routines and views 645
Table 192. Information returned by WLM_GET_WORKLOAD_STATS (continued)
Column Name Data Type Description
COORD_ACT_REJECTED_TOTAL BIGINT The total number of coordinator activities at any
nesting level assigned to any occurrence of this
workload that were rejected prior to execution since
the last reset. Updated by each workload occurrence
at the end of its unit of work. Activities are counted
as rejected when they are prevented from executing
by either a prevent execution work action, or a
predictive threshold. Note that unlike the column of
the same name in the
WLM_GET_SERVICE_SUBCLASS_STATS function,
this also counts rejections that occur before an activity
can be assigned to a service class. An example of such
a rejection occurs when an activity violates the
ConcurrentWorkloadOccurrences threshold.
WLO_COMPLETED_TOTAL BIGINT The number of workload occurrences to complete
since last reset.
WLM_SET_CLIENT_INFO procedure - Set client information
This procedure sets client information associated with the current connection at the
DB2 server.
By using this procedure, the application can set the client’s user ID, application
name, workstation name, accounting, or workload information at the DB2 server.
Invoking this procedure results in changes at the DB2 server to the values stored
for this connection of the relevant transaction processor (TP) monitor client
information fields and special register settings.
The client information fields are used at the DB2 server for determining the
identity of the application or end-user currently using the connection. The client
information fields for a connection are considered during DB2 workload evaluation
and also appear in any DB2 audit records or application snapshot generated for
this connection.
Unlike the sqleseti API, this procedure does not set client information at the client
but sets the corresponding client attributes at the DB2 server. Therefore, the sqleqry
API cannot be used to query the client information that is set at the DB2 server
using this procedure.
The data values provided with the procedure are converted to the database code
page before being stored in the related TP Monitor fields or special registers. Any
data value that exceeds the maximum supported size after conversion to the
database code page will be truncated before being stored at the server. These
truncated values will be returned by both the TP Monitor fields and the special
registers.
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, either a COMMIT or a
ROLLBACK statement must be issued in order to make client information changes
effective.
646 Administrative Routines and Views
If your applications must be portable across IBM data servers, you should use one
of the supported database application programming interfaces to set client
information at the server instead of using the WLM_SET_CLIENT_INFO
procedure, which is available only to DB2 for Linux, UNIX, and Windows.
Syntax
WLM_SET_CLIENT_INFO ( client_userid , client_wrkstnname ,
client_applname , client_acctstr , client_workload )
The schema is SYSPROC.
Procedure parameters
client_userid
An input argument of type VARCHAR(255) that specifies the user ID for the
client. If NULL is specified, the value remains unchanged. If an empty string
(″) is specified, 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 NULL is specified, the value remains unchanged. If an
empty string (″) is specified, 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 NULL is specified, the value remains unchanged. If an empty
string (″) is specified, the application name for the client is reset to the default
value, which is blank.
client_acctstr
An input argument of type VARCHAR(255) that specifies the accounting string
for the client. If NULL is specified, the value remains unchanged. If an empty
string (″) is specified, the accounting string for the client is reset to the default
value, which is blank.
client_workload
An input argument of type VARCHAR(255) that specifies the workload
assignment mode for the client. If NULL is specified, the value remains
unchanged. The valid values are:
v SYSDEFAULTADMWORKLOAD: Specifies that the database connection will
be assigned to the SYSDEFAULTADMWORKLOAD, allowing users with
DBADM or SYSADM authority to bypass the normal workload evaluation.
v 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: Client workload is case sensitive.
Note: For client_userid, client_wrkstnname, client_applname, client_acctstr, the default
value is an empty string.
Chapter 3. Supported routines and views 647
Authorization
EXECUTE privilege on the WLM_SET_CLIENT_INFO procedure.
Examples
Set 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’)
Set 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)
Reset 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)
Miscellaneous routines and views
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 , targetschema , copymode ,
objectowner , sourcetbsp , targettbsp , errortabschema , errortab )
The schema is SYSPROC.
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 prior to 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.
648 Administrative Routines and Views
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.
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 on 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
Chapter 3. Supported routines and views 649
SYSTOOLSPACE.
Table 193. ADMIN_COPY_SCHEMA errortab format
Column name Data type Description
OBJECT_SCHEMA VARCHAR(128) Schema name of the object
for which the copy command
failed.
OBJECT_NAME VARCHAR(128) Name of the object for which
the copy command failed.
OBJECT_TYPE VARCHAR(30) Type of object.
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 ID calling this procedure
must have the appropriate object creation authorities including both the authority
to select from the source tables, and the authority to perform a load. 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.
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 on how to resolve this problem, see “Copying a schema”.
650 Administrative Routines and Views
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
– user-defined structured types (and their transform functions)
– typed views
– jars (Java™ routine archives)
– staging tables
v If one of the above 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 recreated 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.
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
Chapter 3. Supported routines and views 651
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
database partition group.
Transactional considerations
v If the ADMIN_COPY_SCHEMA procedure is forced to rollback 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 )
The schema is SYSPROC.
Procedure parameters
schema
An input argument of type VARCHAR(128) that specifies the name of the
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.
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.
652 Administrative Routines and Views
Table 194. ADMIN_DROP_SCHEMA errortab format
Column name Data type Description
OBJECT_SCHEMA VARCHAR(128) Schema name of the object
for which the drop command
failed.
OBJECT_NAME VARCHAR(128) Name of the object for which
the drop command failed.
OBJECT_TYPE VARCHAR(30) Type of object.
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
Drop authority is needed on all objects being removed for the user calling this
procedure.
EXECUTE privilege on the ADMIN_DROP_SCHEMA procedure is also needed.
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!
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
Chapter 3. Supported routines and views 653
– user-defined structured types (and their transform functions)
– typed views
– jars (Java routine archives)
– staging tables
v If one of the above 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.
ALTOBJ
The ALTOBJ procedure parses an input CREATE TABLE statement serving as the
target data definition language (DDL) for an existing table that is to be altered.
This procedure supports the following alter table operations and maintains
recoverable dependencies:
v Renaming a column
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 )
The schema is SYSPROC.
Procedure parameters
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.
654 Administrative Routines and Views
’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
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
EXECUTE privilege on the ALTOBJ procedure.
DBADM with LOAD authority, and SETSESSIONUSER are also required.
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
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 Altering typed tables is not supported.
v Altering a remote table using a nickname is not supported.
Chapter 3. Supported routines and views 655
v Column sequence cannot be reordered.
v 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.
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.
APPLICATION_ID
The APPLICATION_ID function returns the application ID of the current
connection. The data type of the result is VARCHAR(128).
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.
Syntax
APPLICATION_ID ( )
The schema is SYSFUN.
656 Administrative Routines and Views
Example
SELECT APPLICATION_ID() AS APPL_ID FROM SYSIBM.SYSDUMMY1
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 )
The schema is SYSPROC.
Table function parameter
compilation-env
An input argument of type BLOB(2 M)that contains a compilation environment
provided by a deadlock event monitor.
The function returns a table of two columns (see Table 195 on page 658): NAME
VARCHAR(256) and VALUE VARCHAR(1024). The possible values for the
compilation environment element names are described in Table 196 on page 658.
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’
Chapter 3. Supported routines and views 657
Information returned
Table 195. Information returned by the COMPILATION_ENV table function
Column name Data type Description
NAME VARCHAR(256) Element of compilation
environment. See Table 196
for more details.
VALUE VARCHAR(1024) Value of the element.
Table 196. Elements of a compilation environment returned by the COMPILATION_ENV table
function
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.
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.
658 Administrative Routines and Views
Table 196. Elements of a compilation environment returned by the COMPILATION_ENV table
function (continued)
Element name Description
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. The setting of the
Database Administration Server (DAS) CONTACT_HOST configuration parameter
determines whether the list is local or global.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the CONTACTGROUPS administrative view
and EXECUTE privilege on the ADMIN_GET_CONTACTGROUPS table function.
Example
Retrieve all contact group lists.
SELECT * FROM SYSIBMADM.CONTACTGROUPS
The following is an example of output for this query.
NAME DESCRIPTION MEMBERNAME MEMBERTYPE
-------...--- ------------------------...--- -----------...--- ----------
group1 DBA Group1 Contact List name1 CONTACT
group1 DBA Group1 Contact List name9 CONTACT
group2 DBA Group2 List name2 CONTACT
group3 group2 GROUP
group5 DBA Group5 group2 GROUP
group6 DBA Group6 group3 GROUP
group7 name1 CONTACT
7 record(s) selected.
Usage note
The DAS must have been created and be running.
Chapter 3. Supported routines and views 659
Information returned
Table 197. 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. The setting of the Database Administration Server (DAS)
CONTACT_HOST configuration parameter determines whether the list is local or
global.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the CONTACTS administrative view and
EXECUTE privilege on the ADMIN_GET_CONTACTS table function.
Example
Retrieve all contacts.
SELECT * FROM SYSIBMADM.CONTACTS
The following is an example of output for this query.
NAME TYPE ADDRESS MAX_PAGE_LENGTH DESCRIPTION
-----...- ----- ----------------...- --------------- ------------------...-
user1 EMAIL [email protected] - DBA Extraordinaire
user2 EMAIL [email protected] - DBA on Email
user3 PAGE [email protected] 128 DBA on Page
user5 EMAIL [email protected] - DBA Extraordinaire
4 record(s) selected.
Usage note
The DAS must have been created and be running.
Information returned
Table 198. Information returned by the CONTACTS administrative view
Column name Data type Description
NAME VARCHAR(128) Name of contact.
660 Administrative Routines and Views
Table 198. Information returned by the CONTACTS administrative view (continued)
Column name Data type Description
TYPE VARCHAR(5) Type of contact:
v ’EMAIL’
v ’PAGE’
ADDRESS VARCHAR(128) SMTP mailbox address of the
recipient. For example,
[email protected].
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.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the DB_HISTORY administrative view and
EXECUTE privilege on the ADMIN_LIST_HIST table function.
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
The following is an example of output for this query.
DBPARTITIONNUM EID OPERATION START_TIME ENTRY_STATUS
-------------- -------------------- --------- -------------- ------------
0 1 A 20051109185510 A
1 record(s) selected.
Information returned
Table 199. Information returned by the DB_HISTORY administrative view
Column name Data type Description
DBPARTITIONNUM SMALLINT Database partition number.
EID BIGINT Number that uniquely
identifies an entry in the
history file.
START_TIME VARCHAR(14) Timestamp marking the start
of a logged event.
Chapter 3. Supported routines and views 661
Table 199. Information returned by the DB_HISTORY administrative view (continued)
Column name Data type Description
SEQNUM SMALLINT Sequence number.
END_TIME VARCHAR(14) Timestamp marking the end
of a logged event.
FIRSTLOG VARCHAR(254) Name of the earliest
transaction log associated
with an event.
LASTLOG VARCHAR(254) Name of the latest transaction
log associated with an event.
BACKUP_ID VARCHAR(24) Backup identifier or unique
table identifier.
TABSCHEMA VARCHAR(128) Table schema.
TABNAME VARCHAR(128) Table name.
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 Number of table spaces
associated with a logged
event.
TBSPNAMES CLOB(5 M) Names of the table spaces
associated with a logged
event.
OPERATION CHAR(1) Operation identifier. See
Table 200 on page 664 for
possible values.
OPERATIONTYPE CHAR(1) Action identifier for an
operation. See Table 200 on
page 664 for possible values.
OBJECTTYPE CHAR(1) Identifier for the target object
of an operation. The possible
values are: D for full
database, P for table space,
and T for table.
LOCATION VARCHAR(255) Full path name for files, such
as backup images or load
input file, that are associated
with logged events.
662 Administrative Routines and Views
Table 199. Information returned by the DB_HISTORY administrative view (continued)
Column name Data type Description
DEVICETYPE CHAR(1) Identifier for the device type
associated with a logged
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.
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.
Chapter 3. Supported routines and views 663
Table 199. Information returned by the DB_HISTORY administrative view (continued)
Column name Data type Description
SQLERRP VARCHAR(8) A three-letter identifier
indicating the product,
followed by five digits
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).
SQLERRD2 INTEGER See SQLCA (SQL
communications area).
SQLERRD3 INTEGER See SQLCA (SQL
communications area).
SQLERRD4 INTEGER See SQLCA (SQL
communications area).
SQLERRD5 INTEGER See SQLCA (SQL
communications area).
SQLERRD6 INTEGER See SQLCA (SQL
communications area).
SQLWARN VARCHAR(11) A set of warning indicators,
each containing a blank or
’W’. See SQLCA (SQL
communications area).
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 200. OPERATION and OPERATIONTYPE values
Operation value Operation value description Operation type
A Add table space None
B 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
C Load copy None
D Dropped table None
F Rollforward Operation types are:
v E = end of logs
v P = point in time
664 Administrative Routines and Views
Table 200. OPERATION and OPERATIONTYPE values (continued)
Operation value Operation value description Operation type
G Reorganize table Operation types are:
v F = offline
v N = online
L Load Operation types are:
v I = insert
v R = replace
N Rename table space None
O Drop table space None
Q Quiesce Operation types are:
v S = quiesce share
v U = quiesce update
v X = quiesce exclusive
v Z = quiesce reset
R Restore Operation types are:
v F = offline
v I = incremental offline
v N = online
v O = incremental online
v R = rebuild
T Alter table space Operation types are:
v C = add containers
v R = rebalance
U Unload None
X Archive logs Operation types are:
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 - Retrieve database paths
The DBPATHS administrative view returns the values for database paths required
for tasks such as split mirror backups.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the DBPATHS administrative view and
EXECUTE privilege on ADMIN_LIST_DB_PATHS table function.
Chapter 3. Supported routines and views 665
Example
Retrieve all database paths.
SELECT * FROM SYSIBMADM.DBPATHS
The following is an example of output for this query.
DBPARTITIONNUM TYPE ...
-------------- ------------------------...
0 LOGPATH ...
0 MIRRORLOGPATH ...
0 DB_STORAGE_PATH ...
0 DB_STORAGE_PATH ...
0 TBSP_CONTAINER ...
0 TBSP_CONTAINER ...
0 TBSP_CONTAINER ...
0 TBSP_DIRECTORY ...
0 TBSP_DIRECTORY ...
0 LOCAL_DB_DIRECTORY ...
0 DBPATH ...
11 record(s) selected.
Output for this query (continued).
... PATH
... ------------------------------------------------
... S:\dbfiles\INST5\NODE0000\SQL00001\SQLOGDIR\
... S:\mirrorlogs\NODE0000\
... S:\dbfiles\
... S:\dbfile2\
... S:\dbfiles\INST5\NODE0000\SQL00001\TS3
... S:\dbfiles\INST5\NODE0000\SQL00001\long3
... S:\dbfiles\INST5\NODE0000\SQL00001\regular05
... S:\dbfiles\INST5\NODE0000\SQL00001\usertemp3\
... S:\dbfiles\INST5\NODE0000\SQL00001\systemp3\
... S:\dbfiles\INST5\NODE0000\SQLDBDIR\
... S:\dbfiles\INST5\NODE0000\SQL00001\
Information returned
Table 201. Information returned by the DBPATHS administrative view
Column name Data type Description
DBPARTITIONNUM SMALLINT Database partition number.
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
database configuration
parameter would be shown
in this column as LOGPATH.
See Table 202 on page 667 for
a list of possible return
values.
666 Administrative Routines and Views
Table 201. Information returned by the DBPATHS administrative view (continued)
Column name Data type Description
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 202. 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.
Chapter 3. Supported routines and views 667
Table 202. TYPE column values (continued)
Type value Description
v For table spaces using automatic storage, both used and unused storage paths are
returned. The unused automatic storage paths are needed in case the split mirror backup
is restored. Consider the following example: A split mirror backup is taken on a
production system. After the backup completes, 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 split mirror backup. At this point, it is necessary to roll forward the logs
from the production database. In order to roll forward the logs, all of the automatic
storage paths are required since all automatic storage paths are now in use.
v Table space containers 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 LOGPATH and MIRRORLOGPATH are the values stored in
memory. Changed values stored on disk, which are only applicable after a database
restart, are not returned.
v If output from SELECT * FROM SYSIBMADM.DBPATHS is being used to create a db2relocatedb
configuration file (a file containing the configuration information necessary for relocating
a database), the DBPATH output must be modified appropriately before it can be used in
the configuration file.
For example, the following DBPATH output:
/storage/svtdbm3/svtdbm3/NODE0000/SQL00001/
can be used to specify the DB_PATH parameter in a db2relocatedb 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 the sqldbdir is not separated for multiple databases created in the
same directory, ensure that the target system to which files will be copied does not have
any databases already existing 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 were not intended to be split.
Restriction
This administrative view cannot be called when the database is in WRITE
SUSPEND mode. The database administrator must ensure that the physical layout
of the database does not change in the time between the invocation of the view
and the activation of the WRITE SUSPEND mode, which is needed to perform the
split mirror operation. The split mirror backup image might not be restored
successfully if, for example, the table space layout changed in that time.
EXPLAIN_FORMAT_STATS
This new scalar function is used to display formatted statistics information which
is parsed and extracted from explain snapshot captured for a given query. The data
type of the result is CLOB(50M).
Syntax
EXPLAIN_FORMAT_STATS ( snapshot )
668 Administrative Routines and Views
The schema is SYSPROC.
Scaler 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
EXECUTE privilege on the EXPLAIN_FORMAT_STATS function.
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
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: USERSPACE1
Overhead: 7.500000
Transfer Rate: 0.060000
Prefetch Size: 32
Extent Size: 32
Type: Database managed
Partition Group Name: NULLP
Buffer Pool Identifier: 0
Base Table Statistics:
----------------------
Name : T1
Schema: DB2USER2
Number of Columns: 3
Number of Pages with Rows: 1
Number of Pages: 1
Number of Rows: 5
Table Overflow Record Count: 0
Width of Rows: 26
Time of Creation: 2006-06-16-11.46.53.041085
Last Statistics Update: 2006-06-26-12.23.44.814201
Statistics Type Fabrication
Primary Tablespace: USERSPACE1
Tablespace for Indexes: USERSPACE1
Tablespace for Long Data: NULLP
Number of Referenced Columns: 2
Number of Indexes: 1
Volatile Table: No
Table Active Blocks: -1
Number of Column Groups: 0
Number of Data Partitions: 1
Average Row Compression Ratio: -9.000000
Percent Rows Compressed: -9.000000
Average Compressed Row Size: -9
Statistics Type: U
Chapter 3. Supported routines and views 669
Column Information:
--------------------
Number: 1
Name: C1
Statistics Available: Yes
Column Statistics:
------------------
Schema name of the column type: SYSIBM
Name of column type: INTEGER
Maximum column length: 4
Scale for decimal column: 0
Number of distinct column values: 4
Average column length: 5
Number of most frequent values: 1
Number of quantiles: 5
Second highest data value: 3
Second lowest data value: 2
Column sequence in partition key: 0
Average number of sub-elements: -1
Average length of delimiters: -1
Column Distribution Statistics:
-------------------------------
Frequency Statistics:
Valcount Value
----------------------
2 1
Quantile Statistics:
Valcount Distcount Value
----------------------------------
0 1 1
2 1 1
3 2 2
4 3 3
5 4 4
Column Information:
--------------------
Number: 2
Name: C2
Statistics Available: Yes
Column Statistics:
------------------
Schema name of the column type: SYSIBM
Name of column type: INTEGER
Maximum column length: 4
Scale for decimal column: 0
Number of distinct column values: 4
Average column length: 5
Number of most frequent values: 1
Number of quantiles: 5
Second highest data value: 3
Second lowest data value: 2
Column sequence in partition key: 0
Average number of sub-elements: -1
Average length of delimiters: -1
Column Distribution Statistics:
-------------------------------
Frequency Statistics:
Valcount Value
----------------------
2 1
670 Administrative Routines and Views
Quantile Statistics:
Valcount Distcount Value
----------------------------------
0 0 1
2 0 1
3 0 2
4 0 4
5 0 4
Indexes defined on the table:
-----------------------------
Name :IDX_T1C1C2
Schema:DB2USER2
Unique Rule: Duplicate index
Used in Operator: Yes
Page Fetch Pairs: Not Available
Number of Columns: 2
Index Leaf Pages: 1
Index Tree Levels: 1
Index First Key Cardinality: 4
Index Full Key Cardinality: 4
Index Cluster Ratio: 100
Index Cluster Factor: -1.000000
Time of Creation: 2006-06-16-11.46.53.596717
Last Statistics Update: 2006-06-26-12.23.44.814201
Index Sequential Pages: 0
Index First 2 Keys Cardinality: 4
Index First 3 Keys Cardinality: -1
Index First 4 Keys Cardinality: -1
Index Avg Gap between Sequences: 0.000000
Fetch Avg Gap between Sequences: -1.000000
Index Avg Sequential Pages: 0.000000
Fetch Avg Sequential Pages: -1.000000
Index Avg Random Pages: 1.000000
Fetch Avg Random Pages: -1.000000
Index RID Count: 5
Index Deleted RID Count: 0
Index Empty Leaf Pages: 0
Avg Partition Cluster Ratio: -1
Avg Partition Cluster Factor: -1.000000
Data Partition Cluster Factor: 1.000000
Data Partition Page Fetch Pairs: Not Available
Base Table Statistics:
----------------------
Name : T2
Schema: DB2USER2
Number of Columns: 3
Number of Pages with Rows: 1
Number of Pages: 1
Number of Rows: 2
Table Overflow Record Count: 0
Width of Rows: 26
Time of Creation: 2006-06-16-11.46.53.398092
Last Statistics Update: 2006-06-26-12.23.45.157028
Statistics Type Synchronous
Primary Tablespace: USERSPACE1
Tablespace for Indexes: USERSPACE1
Tablespace for Long Data: NULLP
Number of Referenced Columns: 2
Number of Indexes: 1
Volatile Table: No
Table Active Blocks: -1
Number of Column Groups: 0
Number of Data Partitions: 1
Column Information:
Chapter 3. Supported routines and views 671
--------------------
Number: 1
Name: C1
Statistics Available: Yes
Column Statistics:
------------------
Schema name of the column type: SYSIBM
Name of column type: INTEGER
Maximum column length: 4
Scale for decimal column: 0
Number of distinct column values: 2
Average column length: 5
Number of most frequent values: -1
Number of quantiles: 2
Second highest data value: 2
Second lowest data value: 1
Column sequence in partition key: 0
Average number of sub-elements: -1
Average length of delimiters: -1
Column Distribution Statistics:
-------------------------------
Quantile Statistics:
Valcount Distcount Value
----------------------------------
1 1 1
2 2 2
Column Information:
--------------------
Number: 2
Name: C2
Statistics Available: Yes
Column Statistics:
------------------
Schema name of the column type: SYSIBM
Name of column type: INTEGER
Maximum column length: 4
Scale for decimal column: 0
Number of distinct column values: 2
Average column length: 5
Number of most frequent values: -1
Number of quantiles: 2
Second highest data value: 2
Second lowest data value: 1
Column sequence in partition key: 0
Average number of sub-elements: -1
Average length of delimiters: -1
Column Distribution Statistics:
-------------------------------
Quantile Statistics:
Valcount Distcount Value
----------------------------------
1 0 1
2 0 2
Indexes defined on the table:
-----------------------------
Name :IDX_T2C1
Schema:DB2USER2
Unique Rule: Duplicate index
Used in Operator: No
Page Fetch Pairs: Not Available
Number of Columns: 1
672 Administrative Routines and Views
Index Leaf Pages: 1
Index Tree Levels: 1
Index First Key Cardinality: 2
Index Full Key Cardinality: 2
Index Cluster Ratio: 100
Index Cluster Factor: -1.000000
Time of Creation: 2006-06-16-11.46.53.857520
Last Statistics Update: 2006-06-26-12.23.45.157028
Index Sequential Pages: 0
Index First 2 Keys Cardinality: -1
Index First 3 Keys Cardinality: -1
Index First 4 Keys Cardinality: -1
Index Avg Gap between Sequences: 0.000000
Fetch Avg Gap between Sequences: -1.000000
Index Avg Sequential Pages: 0.000000
Fetch Avg Sequential Pages: -1.000000
Index Avg Random Pages: 1.000000
Fetch Avg Random Pages: -1.000000
Index RID Count: 2
Index Deleted RID Count: 0
Index Empty Leaf Pages: 0
Avg Partition Cluster Ratio: -1
Avg Partition Cluster Factor: -1.000000
Data Partition Cluster Factor: 1.000000
Data Partition Page Fetch Pairs: Not Available
EXPLAIN_GET_MSGS
EXPLAIN_GET_MSGS ( explain-requester , explain-time , source-name ,
source-schema , source-version , explain-level , stmtno , sectno ,
locale )
The schema is the same as the Explain table schema.
The EXPLAIN_GET_MSGS table function queries the EXPLAIN_DIAGNOSTIC and
EXPLAIN_DIAGNOSTIC_DATA Explain tables, and returns formatted messages.
Any of the following input arguments can be null. If an argument is null, it is not
used to limit the query.
explain-requester
An input argument of type VARCHAR(128) that specifies the authorization ID
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
An input argument of type VARCHAR(128) that specifies the 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. 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
Chapter 3. Supported routines and views 673
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.
The function returns a table as shown below.
Table 203. 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.
674 Administrative Routines and Views
Table 203. Information returned by the EXPLAIN_GET_MSGS table function (continued)
Column name Data type Description
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.
Example
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),
’en_US’))
AS REGISTRYINFO
WHERE EXPLAIN_TIME >= (CURRENT TIMESTAMP - 1 HOUR)
ORDER BY DIAGNOSTIC_ID
The following is an example of output from this query.
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".
GET_DBSIZE_INFO
The GET_DBSIZE_INFO procedure calculates the database size and maximum
capacity.
Syntax
GET_DBSIZE_INFO ( snapshot-timestamp , dbsize , dbcapacity ,
refresh-window )
The schema is SYSPROC.
Procedure parameters
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
Chapter 3. Supported routines and views 675
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.
Authorization
v SYSMON authority
v EXECUTE privilege on the GET_DBSIZE_INFO procedure
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:
Value of output parameters
--------------------------
Parameter Name : SNAPSHOTTIMESTAMP
Parameter Value : 2004-02-29-18.31.55.178000
Parameter Name : DATABASESIZE
Parameter Value : 22302720
Parameter Name : DATABASECAPACITY
Parameter Value : 4684793856
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)
The procedure returns:
Value of output parameters
--------------------------
Parameter Name : SNAPSHOTTIMESTAMP
Parameter Value : 2004-02-29-18.33.34.561000
Parameter Name : DATABASESIZE
Parameter Value : 22302720
676 Administrative Routines and Views
Parameter Name : DATABASECAPACITY
Parameter Value : 4684859392
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)
The procedure returns:
Value of output parameters
--------------------------
Parameter Name : SNAPSHOTTIMESTAMP
Parameter Value : 2004-02-29-18.33.34.561000
Parameter Name : DATABASESIZE
Parameter Value : 22302720
Parameter Name : DATABASECAPACITY
Parameter Value : 4684859392
Return Status = 0
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.
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.
The schema is SYSIBMADM.
Authorization
SELECT or CONTROL privilege on the NOTIFICATIONLIST administrative view
and EXECUTE privilege on the HEALTH_GET_NOTIFICATION_LIST table
function.
Example
Chapter 3. Supported routines and views 677
Retrieve all contacts that will receive notification of health alerts.
SELECT * FROM SYSIBMADM.NOTIFICATIONLIST
The following is an example of output for this query.
NAME TYPE
------------...------- -------
group3 GROUP
user4 CONTACT
group3 GROUP
3 record(s) selected.
Information returned
Table 204. 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
PD_GET_DIAG_HIST ( facility , rectype , impact , start_time , end_time )
The schema is SYSPROC.
Table function parameters
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 db2diag.log, admin notification log and 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.
678 Administrative Routines and Views
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 ’UNLIKELY’
v ’POTENTIAL’
v ’IMMEDIATE’
v ’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 or an empty string (’’), records are returned
regardless of how old they are.
end_time
An optional input argument of type TIMESTAMP that specifies a valid
timestamp. Entries are returned if their timestamp is older than this value. If
this parameter is null or an empty string (’’), records are returned regardless of
how recent they are.
Authorization
EXECUTE privilege on the PD_GET_DIAG_HIST table function.
Example
SELECT 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) ) ) AS T
WHERE T.PROCESS_NAME = ’db2star2’ OR T.PROCESS_NAME = ’db2stop2’
The following is an example of output from this query.
FACILITY RECTYPE TIMESTAMP ...
-------------------- ------- -------------------------- ...
MAIN EX 2007-06-25-11.34.05.756171 ...
MAIN EX 2007-06-25-11.34.25.946646 ...
...
2 record(s) selected. ...
Output from this query (continued).
Chapter 3. Supported routines and views 679
... IMPACT MSG
... ------------------ --------------------------------------------------
... - ADM7514W Database manager has stopped.
... - ADM7513W Database manager has started.
...
...
Information returned
Table 205. 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 db2diag.log,
admin notification log and 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.
DBPARTITIONNUM SMALLINT The partition number where the message was created.
For non-partitioned database, 0 is returned.
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 The Engine Dispatched Unit identifier that created this
message.
680 Administrative Routines and Views
Table 205. Information returned by the PD_GET_DIAG_HIST table function (continued)
Column Name Data Type Description
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 numerical 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) The application identifier that initiated the connection if
available. For example: ’G91A3955.F33A.02DD18143340’
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 partition number and a 16-bit counter
separated by a ’-’. The format is as follows: ’nnn-xxxxx’
AUTH_ID VARCHAR(30) The system authorization identifier of the process.
PRODUCT VARCHAR(50) The name of the product that created the message. For
example ’DB2 Common’ and ’DB2 UDB’.
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
message was created.
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
message was created.
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
message was created.
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
numerical 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(16KB) 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’.
Chapter 3. Supported routines and views 681
Table 205. Information returned by the PD_GET_DIAG_HIST table function (continued)
Column Name Data Type Description
OBJTYPE VARCHAR(64) The type of object the event applies to, if it is available.
The possible values are:
v ’APM’
v ’CATALOG CACHE ENTRY’
v ’CFG’
v ’CLI’
v ’CLP’
v ’CONTAINER’
v ’COUNTER’
v ’DAS’
v ’DB2AGENT’
v ’DB PART MAP ID’
v ’DB PART NUM’
v ’DBA’
v ’DBM’
v ’DMS’
v ’DPS’
v ’EDU’
v ’EVALUATION’
v ’EXTENDER’
v ’FCM’
v ’HISTOGRAM TEMPLATE’
v ’INDEX STATS’
v ’INITIAL SAMPLING’
v ’REDIST DB PART GROUP’
v ’REDIST TABLE’
v ’RDS’
v ’SAMPLING TEST’
v ’SERVICE CLASS’
v ’STATS’
v ’STATS DAEMON’
v ’TABLE’
v ’TABLE STATS’
v ’TABLE AND INDEX STATS’
v ’THRESHOLD’
v ’UDF’
v ’WORK ACTION SET’
v ’WORK CLASS SET’
v ’WORKLOAD’
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.
682 Administrative Routines and Views
Table 205. Information returned by the PD_GET_DIAG_HIST table function (continued)
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.
Chapter 3. Supported routines and views 683
Table 205. Information returned by the PD_GET_DIAG_HIST table function (continued)
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
possible values are:
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 CLOB(16K) The second qualifier for the event. If facility is
OPTSTATS, the possible values are:
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 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.
684 Administrative Routines and Views
Table 205. Information returned by the PD_GET_DIAG_HIST table function (continued)
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.
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.
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.
The schema is SYSIBMADM.
Refer to Table 206 on page 690 for a complete list of information that can be
returned.
Chapter 3. Supported routines and views 685
Authorization
SELECT or CONTROL privilege on the PDLOGMSGS_LAST24HOURS
administrative view and EXECUTE privilege on the PD_GET_LOG_MSGS table
function.
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
The following is an example of output from this query.
TIMESTAMP TIMEZONE INSTANCENAME ...
-------------------------- ----------- ----------------- ...
2005-11-23-21.56.41.240066 -300 svtdbm4 ...
...
...
...
...
...
...
2005-11-23-21.56.39.150597 -300 svtdbm4 ...
2005-11-23-21.56.37.363384 -300 svtdbm4 ...
...
...
...
2005-11-23-21.56.35.880314 -300 svtdbm4 ...
...
4 record(s) selected.
Output from this query (continued).
... DBPARTITIONNUM DBNAME PID PROCESSNAME ...
... -------------- ------------- ---...----- -------------------- ...
... 0 CAPTAIN 4239374 db2agent (CAPTAIN) 0 ...
... ...
... ...
... ...
... ...
... ...
... ...
... 0 CAPTAIN 4239374 db2agent (CAPTAIN) 0 ...
... 0 CAPTAIN 4239374 db2agent (CAPTAIN) 0 ...
... ...
... ...
... ...
... 0 CAPTAIN 4239374 db2agent (CAPTAIN) 0 ...
... ...
... ...
Output from this query (continued).
...TID APPL_ID COMPONENT ...
...--- ------------------------------- --------------------- ...
... 1 9.26.15.148.36942.051124025612 oper system services ...
... ...
... ...
... ...
... ...
... ...
... ...
... 1 9.26.15.148.36942.051124025612 base sys utilities ...
686 Administrative Routines and Views
... 1 9.26.15.148.36942.051124025612 relation data serv ...
... ...
... ...
... ...
... 1 9.26.15.148.36942.051124025612 relation data serv ...
... ...
... ...
Output from this query (continued).
... FUNCTION PROBE MSGNUM MSGTYPE ...
... ------------------ ------ ----------- ------- ...
... sqloSleepInstance 38 504 ADM ...
... ...
... ...
... ...
... ...
... ...
... ...
... sqleMarkDBad 10 7518 ADM ...
... sqlrr_dump_ffdc 10 1 ADM ...
... ...
... ...
... ...
... sqlrr_dump_ffdc 10 1 ADM ...
... ...
Output from this query (continued).
... 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.
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.
Refer to Table 206 on page 690 for a complete list of information that can be
returned.
Syntax
PD_GET_LOG_MSGS ( oldest_timestamp )
The schema is SYSPROC.
Chapter 3. Supported routines and views 687
Table function parameter
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.
Authorization
EXECUTE privilege on the PD_GET_LOG_MSGS table function.
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.
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
The following is an example of output from this query.
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 ...
...
...
...
Output from this query (continued).
... 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
688 Administrative Routines and Views
... 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
The following is an example of output from this query.
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
information has been
recorded. Contact IBM
Support for further
assistance.
2004-11-04-11.32.26.760000 SAMPLE ADM0503C An unexpected
internal processing error
has occurred. ALL DB2
PROCESSES ASSOCIATED WITH
THIS INSTANCE HAVE BEEN
SHUTDOWN. Diagnostic
information has been
recorded. Contact IBM
Support for further
assistance.
2 record(s) selected.
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’
The following is an example of output from this query.
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
configuration parameter.
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
configuration parameter.
2005-06-27-12.51.37.772001 ADM5502W The escalation of "143" locks
on table "SYSIBM .SYSINDEXAUTH" to
Chapter 3. Supported routines and views 689
lock intent "X" was successful.
2005-06-27-12.51.37.772000 ADM5502W The escalation of "144" locks
on table "SYSIBM .SYSINDEXES" to lock
intent "X" was successful.
2005-06-27-12.51.37.761001 ADM5502W The escalation of "416" locks
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, DBPARTITOINNUM, DBNAME, MSG
FROM TABLE (PD_GET_LOG_MSGS(CAST(NULL AS TIMESTAMP))) AS T
WHERE MSGNUM = 504 AND MSGTYPE = ’ADM’ AND MSGSEVERITY = ’C’
The following is an example of output from this query.
TIMESTAMP DBPARTITIONNUM DBNAME ...
-------------------------- -------------- -------------...
2005-11-23-21.56.41.240066 0 CAPTAIN ...
...
...
...
...
...
...
...
...
...
Output from this query (continued).
... APPL_ID MSG
... --------------------------------- -------------------------
... 9.26.15.148.36942.051124025612 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.
Information returned
Note: In a partitioned database 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.
Table 206. Information returned by the PDLOGMSGS_LAST24HOURS administrative view
and the PD_GET_LOG_MSGS table function
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.
690 Administrative Routines and Views
Table 206. Information returned by the PDLOGMSGS_LAST24HOURS administrative view
and the PD_GET_LOG_MSGS table function (continued)
Column name Data type Description
INSTANCENAME VARCHAR(128) Name of the instance that
generated the message.
DBPARTITIONNUM SMALLINT The database partition that
generated the message. For a
non partitioned database
environment, 0 is returned.
DBNAME VARCHAR(128) The database on which the
error or event occurred.
PID BIGINT Process ID of the process that
generated the message.
PROCESSNAME VARCHAR(255) Name of process that
generated the message.
TID BIGINT ID of the thread within the
process that generated the
message.
APPL_ID VARCHAR(64) ID of the application for
which the process is working.
COMPONENT VARCHAR(255) The name of the DB2
component that wrote 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.
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.
Chapter 3. Supported routines and views 691
Table 206. Information returned by the PDLOGMSGS_LAST24HOURS administrative view
and the PD_GET_LOG_MSGS table function (continued)
Column name Data type Description
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(16 KB) Notification log message text.
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 )
The schema is SYSPROC.
Procedure parameters
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.
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.
692 Administrative Routines and Views
Information returned
Table 207. Information returned by the REORGCHK_IX_STATS procedure
Column name Data type Description
TABLE_SCHEMA VARCHAR(128) Schema name.
TABLE_NAME VARCHAR(128) Table name.
INDEX_SCHEMA VARCHAR(128) Index schema name.
INDEX_NAME VARCHAR(128) Index name.
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 Total number of index leaf pages.
NUM_EMPTY_LEAFS BIGINT Number of pseudo-empty index
leaf pages.
NLEVELS INTEGER Number of index levels.
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.
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
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.
Chapter 3. Supported routines and views 693
Table 207. Information returned by the REORGCHK_IX_STATS procedure (continued)
Column name Data type Description
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 )
The schema is SYSPROC.
Procedure parameters
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_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.
694 Administrative Routines and Views
Information returned
Table 208. Information returned by the REORGCHK_TB_STATS procedure
Column name Data type Description
TABLE_SCHEMA VARCHAR(128) Schema name.
TABLE_NAME VARCHAR(128) Table name.
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)
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.
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
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.
SQLERRM scalar function
This SQLERRM scalar function takes a message identifier, locale and token input
and returns the short or long message of type VARCHAR(32672) in the specified
Chapter 3. Supported routines and views 695
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
)
The schema is SYSPROC.
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).
Authorization
EXECUTE privilege on the SQLERRM scalar function.
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.
696 Administrative Routines and Views
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))
The following is an example of output returned.
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))
The following is an example of output returned.
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:
Resubmit the command with the correct database name.
sqlcode : -1001
sqlstate : 2E000
SQLERRM scalar function
This SQLERRM scalar function takes an SQLCODE as the only input and returns
the short message of type VARCHAR(32672) for the specified SQLCODE in
English.
Syntax
SQLERRM ( sqlcode )
The schema is SYSPROC.
Scalar function parameter
sqlcode
An input argument of type INTEGER that represents an SQLCODE.
Authorization
EXECUTE privilege on the SQLERRM scalar function.
Chapter 3. Supported routines and views 697
Example
Retrieve the short message for SQLCODE SQL0551N.
VALUES (SYSPROC.SQLERRM (551))
The following is an example of output returned.
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.
Syntax
SYSINSTALLOBJECTS ( tool-name , action , tablespace-name ,
schema-name )
The schema is SYSPROC.
Procedure parameters
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 ’AM’ for creating activity monitor objects
v ’DB2AC’ for autonomous computing (health monitor)
v ’STMG_DBSIZE_INFO’ for storage management
v ’OPT_PROFILES’ for creating the optimization profile table
v ’POLICY’ for policy (tables and triggers)
v ’EXPLAIN’ for creating explain tables
action
An input argument of type CHAR(1) that specifies the action that is to be
taken. Valid values are:
’C’ Create objects.
’D’ Drop objects.
’V’ Verify objects.
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 will be used if the tool
name is AM. Otherwise, the SYSTOOLSPACE table space will be 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.
698 Administrative Routines and Views
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.
Example
CALL SYSPROC.SYSINSTALLOBJECTS(’AM’, ’C’, CAST (NULL AS VARCHAR(128)),
CAST (NULL AS VARCHAR(128)))
Chapter 3. Supported routines and views 699
700 Administrative Routines and Views
Chapter 4. Deprecated SQL administrative routines and their
replacement routines or views
In order to provide expanded support in DB2 Version 9.5 for the existing
administrative routines, some of the DB2 Version 9.1 routines have been replaced
with new, more comprehensive routines or views.
Applications that use the DB2 Version 9.1 table functions should be modified to
use the new functions or administrative views. The new table functions have the
same base names as the original functions but are suffixed with ’_Vxx’ for the
version of the product in which they were added (for example, _V95). In most
cases, the new table functions and administrative views return additional
information. The administrative views will always be based on the most current
version of the table functions, and therefore allow for more application portability.
Since the columns might vary from one release to the next (that is, some are added
and some are deleted), it is recommended that specific columns be selected from
the administrative views, or that the result set be described if a SELECT *
statement is used by an application.
Table 209. Deprecated SQL administrative routines and their replacement routines or views
for DB2 Version 9.5
DB2 Version 9.1 deprecated
function New DB2 Version 9.5 function or view
“ADMIN_GET_TAB_INFO table “ADMINTABINFO administrative view and
function - Retrieve size and state ADMIN_GET_TAB_INFO_V95 table function -
information for tables” on page 704 Retrieve size and state information for tables” on
page 199
“SNAP_GET_APPL table function – “SNAPAPPL administrative view and
Retrieve appl logical data group SNAP_GET_APPL_V95 table function - Retrieve appl
snapshot information” on page 715 logical data group snapshot information” on page
332
“SNAP_GET_APPL_INFO table “SNAPAPPL_INFO administrative view and
function – Retrieve appl_info logical SNAP_GET_APPL_INFO_V95 table function -
data group snapshot information” Retrieve appl_info logical data group snapshot
on page 721 information” on page 324
“SNAP_GET_BP table function – “SNAPBP administrative view and
Retrieve bufferpool logical group SNAP_GET_BP_V95 table function - Retrieve
snapshot information” on page 728 bufferpool logical group snapshot information” on
page 340
“SNAP_GET_DB_V91 table function “SNAPDB administrative view and
- Retrieve snapshot information SNAP_GET_DB_V95 table function - Retrieve
from the dbase logical group” on snapshot information from the dbase logical group”
page 742 on page 351
“SNAP_GET_DBM table function – “SNAPDBM administrative view and
Retrieve the dbm logical grouping SNAP_GET_DBM_V95 table function - Retrieve the
snapshot information” on page 739 dbm logical grouping snapshot information” on page
366
“SNAP_GET_DYN_SQL_V91 table “SNAPDYN_SQL administrative view and
function - Retrieve dynsql logical SNAP_GET_DYN_SQL_V95 table function - Retrieve
group snapshot information” on dynsql logical group snapshot information” on page
page 752 375
© Copyright IBM Corp. 2006, 2008 701
In the previous release, DB2 Version 9.1, there were also new functions that
replaced DB2 UDB for Linux, UNIX, and Windows Version 8 functions.
Table 210. Deprecated SQL administrative routines and their replacement routines or views
for DB2 Version 9.1
DB2 UDB for Linux, UNIX, and
Windows Version 8 deprecated
function New DB2 Version 9.1 function or view
“GET_DB_CONFIG” on page 713 “DBCFG administrative view - Retrieve database
configuration parameter information” on page 214
“GET_DBM_CONFIG” on page 714 “DBMCFG administrative view - Retrieve database
manager configuration parameter information” on
page 216
“SNAP_GET_CONTAINER” on “SNAPCONTAINER administrative view and
page 731 SNAP_GET_CONTAINER_V91 table function -
Retrieve tablespace_container logical data group
snapshot information” on page 347
“SNAP_GET_DB” on page 732 “SNAP_GET_DB_V91 table function - Retrieve
snapshot information from the dbase logical group”
on page 742
SNAP_GET_DETAILLOG (1) “SNAPDETAILLOG administrative view and
SNAP_GET_DETAILLOG_V91 table function -
Retrieve snapshot information from the detail_log
logical data group” on page 372
“SNAP_GET_DYN_SQL” on page “SNAP_GET_DYN_SQL_V91 table function - Retrieve
755 dynsql logical group snapshot information” on page
752
“SNAP_GET_STO_PATHS” on page “SNAPSTORAGE_PATHS administrative view and
757 SNAP_GET_STORAGE_PATHS table function -
Retrieve automatic storage path information” on page
403
“SNAP_GET_TAB” on page 758 “SNAPTAB administrative view and
SNAP_GET_TAB_V91 table function - Retrieve table
logical data group snapshot information” on page 412
“SNAP_GET_TBSP” on page 759 “SNAPTBSP administrative view and
SNAP_GET_TBSP_V91 table function - Retrieve table
space logical data group snapshot information” on
page 419
“SNAP_GET_TBSP_PART” on page “SNAPTBSP_PART administrative view and
762 SNAP_GET_TBSP_PART_V91 table function -
Retrieve tablespace_nodeinfo logical data group
snapshot information” on page 424
“SNAPSHOT_AGENT” on page “SNAPAGENT administrative view and
764 SNAP_GET_AGENT table function – Retrieve agent
logical data group application snapshot information”
on page 318
“SNAPSHOT_APPL” on page 765 “SNAP_GET_APPL table function – Retrieve appl
logical data group snapshot information” on page 715
“SNAPSHOT_APPL_INFO” on “SNAP_GET_APPL_INFO table function – Retrieve
page 770 appl_info logical data group snapshot information”
on page 721
“SNAPSHOT_BP” on page 772 “SNAP_GET_BP table function – Retrieve bufferpool
logical group snapshot information” on page 728
702 Administrative Routines and Views
Table 210. Deprecated SQL administrative routines and their replacement routines or views
for DB2 Version 9.1 (continued)
DB2 UDB for Linux, UNIX, and
Windows Version 8 deprecated
function New DB2 Version 9.1 function or view
“SNAPSHOT_CONTAINER” on “SNAPCONTAINER administrative view and
page 774 SNAP_GET_CONTAINER_V91 table function -
Retrieve tablespace_container logical data group
snapshot information” on page 347
“SNAPSHOT_DATABASE” on page “SNAP_GET_DB_V91 table function - Retrieve
775 snapshot information from the dbase logical group”
on page 742
“SNAPSHOT_DBM” on page 781 “SNAP_GET_DBM table function – Retrieve the dbm
logical grouping snapshot information” on page 739
“SNAPSHOT_DYN_SQL” on page “SNAP_GET_DYN_SQL_V91 table function - Retrieve
783 dynsql logical group snapshot information” on page
752
“SNAPSHOT_FCM” on page 784 “SNAPFCM administrative view and
SNAP_GET_FCM table function – Retrieve the fcm
logical data group snapshot information” on page 380
“SNAPSHOT_FCMNODE” on page “SNAPFCM_PART administrative view and
785 SNAP_GET_FCM_PART table function – Retrieve the
fcm_node logical data group snapshot information”
on page 382
“SNAPSHOT_FILEW” on page 786 “SNAP_WRITE_FILE procedure” on page 441
“SNAPSHOT_LOCK” on page 787 “SNAPLOCK administrative view and
SNAP_GET_LOCK table function – Retrieve lock
logical data group snapshot information” on page 388
“SNAPSHOT_LOCKWAIT” on “SNAPLOCKWAIT administrative view and
page 788 SNAP_GET_LOCKWAIT table function – Retrieve
lockwait logical data group snapshot information” on
page 393
“SNAPSHOT_QUIESCERS” on “SNAPTBSP_QUIESCER administrative view and
page 789 SNAP_GET_TBSP_QUIESCER table function -
Retrieve quiescer table space snapshot information”
on page 429
“SNAPSHOT_RANGES” on page “SNAPTBSP_RANGE administrative view and
790 SNAP_GET_TBSP_RANGE table function - Retrieve
range snapshot information” on page 432
“SNAPSHOT_STATEMENT” on “SNAPSTMT administrative view and
page 791 SNAP_GET_STMT table function – Retrieve statement
snapshot information” on page 398
“SNAPSHOT_SUBSECT” on page “SNAPSUBSECTION administrative view and
793 SNAP_GET_SUBSECTION table function – Retrieve
subsection logical monitor group snapshot
information” on page 406
“SNAPSHOT_SWITCHES” on page “SNAPSWITCHES administrative view and
795 SNAP_GET_SWITCHES table function – Retrieve
database snapshot switch state information” on page
409
“SNAPSHOT_TABLE” on page 796 “SNAPTAB administrative view and
SNAP_GET_TAB_V91 table function - Retrieve table
logical data group snapshot information” on page 412
Chapter 4. Deprecated routines 703
Table 210. Deprecated SQL administrative routines and their replacement routines or views
for DB2 Version 9.1 (continued)
DB2 UDB for Linux, UNIX, and
Windows Version 8 deprecated
function New DB2 Version 9.1 function or view
“SNAPSHOT_TBREORG” on page “SNAPTAB_REORG administrative view and
797 SNAP_GET_TAB_REORG table function - Retrieve
table reorganization snapshot information” on page
415
“SNAPSHOT_TBS” on page 799 “SNAPTBSP administrative view and
SNAP_GET_TBSP_V91 table function - Retrieve table
space logical data group snapshot information” on
page 419
“SNAPSHOT_TBS_CFG” on page “SNAPTBSP_PART administrative view and
801 SNAP_GET_TBSP_PART_V91 table function -
Retrieve tablespace_nodeinfo logical data group
snapshot information” on page 424
SNAPSHOT_UTIL (1) “SNAPUTIL administrative view and
SNAP_GET_UTIL table function - Retrieve
utility_info logical data group snapshot information”
on page 435
SNAPSHOT_UTIL_PROG (1) “SNAPUTIL_PROGRESS administrative view and
SNAP_GET_UTIL_PROGRESS table function -
Retrieve progress logical data group snapshot
information” on page 439
“SQLCACHE_SNAPSHOT” on “SNAP_GET_DYN_SQL_V91 table function - Retrieve
page 803 dynsql logical group snapshot information” on page
752. Information returned by the
SQLCACHE_SNAPSHOT table function is now
included in this new view and table function.
SYSFUN.GROUPS (1) This procedure has been deprecated.
SYSFUN.GROUPS_FOR_USER (1) “AUTH_LIST_GROUPS_FOR_AUTHID table function
- Retrieve group membership list for a given
authorization ID” on page 289
SYSFUN.USER_GROUPS (1) This procedure has been deprecated.
SYSFUN.USERS (1) This procedure has been deprecated.
“SYSINSTALLROUTINES” on page This procedure has been deprecated.
804
Note: (1) These functions were present in DB2 UDB for Linux, UNIX, and
Windows Version 8, but were omitted from the documentation.
ADMIN_GET_TAB_INFO table function - Retrieve size and state
information for tables
Note: This table function has been deprecated and replaced by the
“ADMINTABINFO administrative view and ADMIN_GET_TAB_INFO_V95 table
function - Retrieve size and state information for tables” on page 199.
The ADMIN_GET_TAB_INFO table function provides methods to retrieve table
size and state information that is not currently available in the catalog views.
704 Administrative Routines and Views
Refer to the ADMIN_GET_TAB_INFO table function metadata table for a complete
list of information that can be returned.
Syntax
ADMIN_GET_TAB_INFO ( tabschema , tabname )
The schema is SYSPROC.
Table function 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
materialized query table name or a hierarchy table name.
Authorization
EXECUTE privilege on the ADMIN_GET_TAB_INFO table function.
Example
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) 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) as total_l_size
FROM TABLE( SYSPROC.ADMIN_GET_TAB_INFO( ’DBUSER1’, ’EMPLOYEE’ )) AS T
Usage notes
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), a materialized query table name (type S) or a hierarchy table
name (type H), an empty result set is returned.
Chapter 4. Deprecated routines 705
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.
v The logical size reported for LOB objects created before DB2 UDB Version 8
might be larger than the physical size if the objects have not yet been
reorganized.
ADMIN_GET_TAB_INFO table function metadata
Table 211. ADMIN_GET_TAB_INFO table function metadata
Column name Data type Description
TABSCHEMA VARCHAR(128) Schema name.
TABNAME VARCHAR(128) Table name.
TABTYPE CHAR(1) Table type:
v ’H’ = hierarchy table
v ’S’ = materialized query
table
v ’T’ = table
DBPARTITIONNUM SMALLINT Database partition number.
DATA_PARTITION_ID INTEGER Data partition number.
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.
706 Administrative Routines and Views
Table 211. ADMIN_GET_TAB_INFO table function metadata (continued)
Column name Data type Description
DATA_OBJECT_L_SIZE 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 multi-dimensional
clustering (MDC) 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.
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. 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. Space consumed
by LOB data, Long Data,
Indexes and XML objects are
reported by other columns.
Chapter 4. Deprecated routines 707
Table 211. ADMIN_GET_TAB_INFO table function metadata (continued)
Column name Data type Description
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. This value is only
reported for non-partitioned
tables. For partitioned tables,
this value will be 0.
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.
This value is only reported
for non-partitioned tables.
For partitioned tables this
value will be 0.
LONG_OBJECT_L_SIZE BIGINT Long object logical size.
Amount of disk space
logically allocated for long
field 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 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.
708 Administrative Routines and Views
Table 211. ADMIN_GET_TAB_INFO table function metadata (continued)
Column name Data type Description
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 allocated for LOB
data in a table, reported in
kilobytes. The size includes
space allocated for the LOB
allocation object. The size
returned takes into account
full extents allocated for LOB
data and includes the EMP
extents for LOB data created
in DMS table spaces.
Chapter 4. Deprecated routines 709
Table 211. ADMIN_GET_TAB_INFO table function metadata (continued)
Column name Data type Description
XML_OBJECT_L_SIZE BIGINT XML object logical size.
Amount of disk space
logically allocated for XML
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 XML 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 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 allocated for XML
data in a table, reported in
kilobytes. 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:
v 1 if type-1 indexes are
being used.
v 2 if type-2 indexes are
being 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.
710 Administrative Routines and Views
Table 211. ADMIN_GET_TAB_INFO table function metadata (continued)
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:
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:
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.
Chapter 4. Deprecated routines 711
Table 211. ADMIN_GET_TAB_INFO table function metadata (continued)
Column name Data type Description
CHAR(1) ’Y’ if any of the indexes
INDEXES_REQUIRE_ defined on the table require a
REBUILD rebuild, and ’N’ otherwise. If
no indexes are defined on the
table, ’N’ will also be
returned, since there are no
indexes that require a
rebuild.
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).
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.
DICTIONARY_SIZE BIGINT Size of the dictionary, in
bytes, used for row
compression if a row
compression dictionary exists
for the table.
712 Administrative Routines and Views
GET_DB_CONFIG
Note: This procedure has been deprecated and replaced by the “DBCFG
administrative view - Retrieve database configuration parameter information” on
page 214.
GET_DB_CONFIG ( )
The schema is SYSPROC.
The GET_DB_CONFIG procedure returns database configuration information. The
procedure does not take any arguments.
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 below.
Table 212. 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. The
row with a value of 1 in this column
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.
Example
Using the command line processor (CLP), change the value of the logretain and the
userexit database configuration parameters. 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 LOGRETAIN RECOVERY USEREXIT ON
CALL SYSPROC.GET_DB_CONFIG()
SELECT DBCONFIG_TYPE, LOGRETAIN, USEREXIT
FROM SESSION.DB_CONFIG
CONNECT RESET
The following is an example of output from this query.
Chapter 4. Deprecated routines 713
DBCONFIG_TYPE LOGRETAIN USEREXIT
------------- ----------- -----------
0 1 1
1 0 0
2 record(s) selected.
GET_DBM_CONFIG
Note: This table function has been deprecated and replaced by the “DBMCFG
administrative view - Retrieve database manager configuration parameter
information” on page 216.
GET_DBM_CONFIG ( )
The schema is SYSFUN.
The GET_DBM_CONFIG table function returns database manager configuration
information. The function does not take any arguments.
The function returns a table with two rows containing a column for each
parameter. The first column is named DBMCONFIG_TYPE, as shown below.
Table 213. Information returned by the GET_DBM_CONFIG table function
Column name Data type Description
DBMCONFIG_TYPE INTEGER The row with a value of 0 in this column
contains the values of the database manager
configuration parameters stored on disk. The
row with a value of 1 in this column
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
The following is an example of output from this query.
DBMCONFIG_TYPE NUMDB DIAGLEVEL
-------------- ----------- -----------
0 32 4
1 8 3
2 record(s) selected.
714 Administrative Routines and Views
SNAP_GET_APPL table function – Retrieve appl logical data group
snapshot information
Note: This table function has been deprecated and replaced by the “SNAPAPPL
administrative view and SNAP_GET_APPL_V95 table function - Retrieve appl
logical data group snapshot information” on page 332.
The SNAP_GET_APPL table function returns information about applications from
an application snapshot, in particular, the appl logical data group.
Used with the SNAP_GET_AGENT, SNAP_GET_AGENT_MEMORY_POOL,
SNAP_GET_APPL_INFO, SNAP_GET_STMT and SNAP_GET_SUBSECTION table
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 partitions.
Refer to Table 214 on page 716 for a complete list of information that can be
returned.
Syntax
SNAP_GET_APPL ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_APPL table function takes a snapshot for the currently connected
database and database partition number.
Chapter 4. Deprecated routines 715
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_APPL table function.
Example
Retrieve details on rows read and written for each application for all active
databases.
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, AGENT_ID, ROWS_READ, ROWS_WRITTEN
FROM TABLE (SNAP_GET_APPL(CAST(NULL AS VARCHAR(128)),-1)) AS T
The following is an example of output from this query.
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
Information returned
Table 214. Information returned by the SNAP_GET_APPL table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
UOW_LOG_SPACE_USED BIGINT uow_log_space_used - Unit of
work log space used
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
INACT_STMTHIST_SZ BIGINT stmt_history_list_size - Statement
history list size
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index writes
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
716 Administrative Routines and Views
Table 214. Information returned by the SNAP_GET_APPL table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer
Pool Temporary XDA Data Physical
Reads monitor element
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool
XDA Data Logical Reads
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool
XDA Data Physical Reads
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
LOCKS_HELD BIGINT locks_held - Locks held
LOCK_WAITS BIGINT lock_waits - Lock waits
LOCK_WAIT_TIME BIGINT lock_wait_time - Time waited on
locks
LOCK_ESCALS BIGINT lock_escals - Number of lock
escalations
X_LOCK_ESCALS BIGINT x_lock_escals - Exclusive lock
escalations
DEADLOCKS BIGINT deadlocks - Deadlocks detected
TOTAL_SORTS BIGINT total_sorts - Total sorts
Chapter 4. Deprecated routines 717
Table 214. Information returned by the SNAP_GET_APPL table function (continued)
Description or corresponding
Column name Data type monitor element
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
COMMIT_SQL_STMTS BIGINT commit_sql_stmts - Commit
statements attempted
ROLLBACK_SQL_STMTS BIGINT rollback_sql_stmts - Rollback
statements attempted
DYNAMIC_SQL_STMTS BIGINT dynamic_sql_stmts - Dynamic SQL
statements attempted
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
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_commits - Internal commits
INT_ROLLBACKS BIGINT int_rollbacks - Internal rollbacks
INT_DEADLOCK_ROLLBACKS BIGINT int_deadlock_rollbacks - Internal
rollbacks due to deadlock
ROWS_DELETED BIGINT rows_deleted - Rows deleted
ROWS_INSERTED BIGINT rows_inserted - Rows inserted
ROWS_UPDATED BIGINT rows_updated - Rows updated
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
SQL_REQS_SINCE_COMMIT BIGINT sql_reqs_since_commit - SQL
requests since last commit
718 Administrative Routines and Views
Table 214. Information returned by the SNAP_GET_APPL table function (continued)
Description or corresponding
Column name Data type monitor element
LOCK_TIMEOUTS BIGINT lock_timeouts - Number of lock
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
cursors with blocking
PKG_CACHE_LOOKUPS BIGINT pkg_cache_lookups - Package cache
lookups
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
ASSOCIATED_AGENTS_TOP 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 in
sqlmon.h, and is one of:
v DYNAMIC_PRIORITY
v FIXED_PRIORITY
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
BIGINT hash_join_small_overflows - Hash
HASH_JOIN_SMALL_ join small overflows
OVERFLOWS
Chapter 4. Deprecated routines 719
Table 214. Information returned by the SNAP_GET_APPL table function (continued)
Description or corresponding
Column name Data type monitor element
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
UOW_COMP_STATUS VARCHAR(14) uow_comp_status - Unit of work
completion status. This interface
returns a text identifier, based on
defines in sqlmon.h, and is one of:
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
AGENT_USR_CPU_TIME_MS BIGINT agent_usr_cpu_time - User CPU
time used by agent
AGENT_SYS_CPU_TIME_S BIGINT agent_sys_cpu_time - System CPU
time used by agent
AGENT_SYS_CPU_TIME_MS BIGINT agent_sys_cpu_time - System CPU
time used by agent
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
UOW_ELAPSED_TIME_MS BIGINT uow_elapsed_time - Most recent
unit of work elapsed time
ELAPSED_EXEC_TIME_S BIGINT elapsed_exec_time - Statement
execution elapsed time
ELAPSED_EXEC_TIME_MS BIGINT elapsed_exec_time - Statement
execution elapsed time
INBOUND_COMM_ADDRESS VARCHAR(32) inbound_comm_address - Inbound
communication address
LOCK_TIMEOUT_VAL BIGINT lock_timeout_val - Lock timeout
(seconds)
720 Administrative Routines and Views
Table 214. Information returned by the SNAP_GET_APPL table function (continued)
Description or corresponding
Column name Data type monitor element
BIGINT priv_workspace_num_overflows -
PRIV_WORKSPACE_NUM_ Private workspace overflows
OVERFLOWS
BIGINT priv_workspace_section_inserts -
PRIV_WORKSPACE_SECTION_ Private workspace section inserts
INSERTS
BIGINT priv_workspace_section_lookups -
PRIV_WORKSPACE_SECTION_ Private workspace section lookups
LOOKUPS
BIGINT priv_workspace_size_top -
PRIV_WORKSPACE_SIZE_ Maximum private workspace size
TOP
BIGINT shr_workspace_num_overflows -
SHR_WORKSPACE_NUM_ Shared workspace overflows
OVERFLOWS
BIGINT shr_workspace_section_inserts -
SHR_WORKSPACE_SECTION_ Shared workspace section inserts
INSERTS
BIGINT shr_workspace_section_lookups -
SHR_WORKSPACE_SECTION_ Shared workspace section lookups
LOOKUPS
BIGINT shr_workspace_size_top -
SHR_WORKSPACE_SIZE_ Maximum shared workspace size
TOP
DBPARTITIONNUM SMALLINT The database partition from which
the data for the row was retrieved.
CAT_CACHE_SIZE_TOP BIGINT cat_cache_size_top - Catalog cache
high water mark
SNAP_GET_APPL_INFO table function – Retrieve appl_info logical
data group snapshot information
Note: This table function has been deprecated and replaced by the
“SNAPAPPL_INFO administrative view and SNAP_GET_APPL_INFO_V95 table
function - Retrieve appl_info logical data group snapshot information” on page
324.
The SNAP_GET_APPL_INFO table function returns information about applications
from an application snapshot, in particular, the appl_info logical data group.
Used with the SNAP_GET_AGENT, SNAP_GET_AGENT_MEMORY_POOL,
SNAP_GET_APPL, SNAP_GET_APPL_INFO, SNAP_GET_STMT and
SNAP_GET_SUBSECTION table functions, the SNAP_GET_APPL_INFO table
function provides information equivalent to the GET SNAPSHOT FOR ALL
APPLICATIONS CLP command, but retrieves data from all database partitions.
Refer to Table 215 on page 723 for a complete list of information that can be
returned.
Chapter 4. Deprecated routines 721
Syntax
SNAP_GET_APPL_INFO ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_APPL_INFO table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_APPL_INFO table function.
Examples
Retrieve the status of all applications on the connected database partition.
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
The following is an example of output from this query.
DB_NAME AGENT_ID APPL_NAME APPL_STATUS
-------- -------------------- ---------- ----------------------
TOOLSDB 14 db2bp.exe CONNECTED
SAMPLE 15 db2bp.exe UOWEXEC
SAMPLE 8 javaw.exe CONNECTED
SAMPLE 7 db2bp.exe UOWWAIT
4 record(s) selected.
The following shows what you obtain when you SELECT from the result of the
table function.
722 Administrative Routines and Views
SELECT SUBSTR(DB_NAME,1,8) AS DB_NAME, AUTHORITY_LVL
FROM TABLE(SNAP_GET_APPL_INFO_V95(CAST(NULL AS VARCHAR(128)),-1)) AS T
The following is an example of output from this query.
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 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 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)
3 record(s) selected.
Information returned
Table 215. Information returned by the SNAP_GET_APPL_INFO table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
Chapter 4. Deprecated routines 723
Table 215. Information returned by the SNAP_GET_APPL_INFO table function (continued)
Description or corresponding
Column name Data type monitor element
APPL_STATUS VARCHAR(22) appl_status - Application status.
This interface returns a text
identifier based on the defines in
sqlmon.h, and is one of:
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
CODEPAGE_ID BIGINT codepage_id - ID of code page used
by application
NUM_ASSOC_AGENTS BIGINT num_assoc_agents - Number of
associated agents
COORD_NODE_NUM SMALLINT coord_node - Coordinating node
724 Administrative Routines and Views
Table 215. Information returned by the SNAP_GET_APPL_INFO table function (continued)
Description or corresponding
Column name Data type monitor element
AUTHORITY_LVL VARCHAR(512) authority_lvl - User authorization
level.
This interface returns a text
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 BINDADD
v CONNECT
v CREATE_EXT_RT
v CREATE_NOT_FENC
v CREATETAB
v DBADM
v IMPLICIT_SCHEMA
v LOAD
v LIBADM
v QUIESCE_CONN
v SECADM
v SYSADM
v SYSCTRL
v SYSMAINT
v SYSMON
v SYSQUIESCE
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 client_pid - Client process ID
COORD_AGENT_PID BIGINT coord_agent_pid - Coordinator
agent
STATUS_CHANGE_TIME TIMESTAMP status_change_time - Application
status change time
Chapter 4. Deprecated routines 725
Table 215. Information returned by the SNAP_GET_APPL_INFO table function (continued)
Description or corresponding
Column name Data type monitor element
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
726 Administrative Routines and Views
Table 215. Information returned by the SNAP_GET_APPL_INFO table function (continued)
Description or corresponding
Column name Data type monitor element
CLIENT_PROTOCOL VARCHAR(10) client_protocol - Client
communication protocol. This
interface returns a text identifier
based on the defines in sqlmon.h,
v CPIC
v LOCAL
v NETBIOS
v NPIPE
v TCPIP (for DB2 UDB)
v TCPIP4
v TCPIP6
TERRITORY_CODE SMALLINT territory_code - Database territory
code
APPL_NAME VARCHAR(256) appl_name - Application name
APPL_ID VARCHAR(128) appl_id - Application ID
SEQUENCE_NO VARCHAR(4) sequence_no - Sequence number
PRIMARY_AUTH_ID VARCHAR(128) auth_id - Authorization ID
SESSION_AUTH_ID VARCHAR(128) session_auth_id - Session
authorization ID
CLIENT_NNAME VARCHAR(128) The client_nname monitor element
is deprecated. The value returned is
not a valid value.
CLIENT_PRDID VARCHAR(128) client_prdid - Client
product/version ID
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input database
alias
CLIENT_DB_ALIAS VARCHAR(128) client_db_alias - Database alias
used by application
DB_NAME VARCHAR(128) db_name - Database name
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) 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 The database partition from which
the data for the row was retrieved.
Chapter 4. Deprecated routines 727
SNAP_GET_BP table function – Retrieve bufferpool logical group
snapshot information
Note: This table function has been deprecated and replaced by the “SNAPBP
administrative view and SNAP_GET_BP_V95 table function - Retrieve bufferpool
logical group snapshot information” on page 340.
The SNAP_GET_BP table function returns information about buffer pools from a
bufferpool snapshot, in particular, the bufferpool logical data group.
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.
Refer to Table 216 on page 729 for a complete list of information that can be
returned.
Syntax
SNAP_GET_BP ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_BP table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_BP table function.
728 Administrative Routines and Views
Example
Retrieve total physical and logical reads for all bufferpools for all active databases
for the currently connected database partition.
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
The following is an example of output from this query.
DB_NAME BP_NAME TOTAL_LOGICAL_READS ...
---------- ------------...- -------------------- ...
SAMPLE IBMDEFAULTBP 0 ...
TOOLSDB IBMDEFAULTBP 0 ...
TOOLSDB BP32K0000 0 ...
3 record(s) selected.
Output from this query (continued).
... TOTAL_PHYSICAL_READS DBPARTITIONNUM
... -------------------- --------------
... 0 0
... 0 0
... 0 0
Information returned
Table 216. Information returned by the SNAP_GET_BP table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
BP_NAME VARCHAR(128) bp_name - Buffer pool name
DB_NAME VARCHAR(128) db_name - Database name
DB_PATH VARCHAR(1024) db_path - Database path
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input database
alias
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index writes
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool
XDA Data Logical Reads
Chapter 4. Deprecated routines 729
Table 216. Information returned by the SNAP_GET_BP table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool
XDA Data Physical Reads
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
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer
pool asynchronous data reads
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_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_WRITES BIGINT pool_async_xda_writes - Buffer
Pool Asynchronous XDA Data
Writes
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
BIGINT pool_async_data_read_reqs - Buffer
POOL_ASYNC_DATA_ pool asynchronous read requests
READ_REQS
BIGINT pool_async_index_read_reqs -
POOL_ASYNC_INDEX_ Buffer pool asynchronous index
READ_REQS read requests
BIGINT pool_async_xda_read_reqs - Buffer
POOL_ASYNC_XDA_ Pool Asynchronous XDA Read
READ_REQS Requests
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
730 Administrative Routines and Views
Table 216. Information returned by the SNAP_GET_BP table function (continued)
Description or corresponding
Column name Data type monitor element
FILES_CLOSED BIGINT files_closed - Database files closed
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer
Pool Temporary XDA Data Physical
Reads monitor element
POOL_NO_VICTIM_BUFFER BIGINT pool_no_victim_buffer - Buffer pool
no victim buffers
PAGES_FROM_BLOCK_IOS BIGINT pages_from_block_ios - Total
number of pages read by block I/O
BIGINT pages_from_vectored_ios - Total
PAGES_FROM_VECTORED_IOS pages read by vectored I/O
PHYSICAL_PAGE_MAPS BIGINT The physical_page_maps monitor
element is discontinued. A NULL
value is returned for the
discontinued monitor element.
VECTORED_IOS BIGINT vectored_ios - Number of vectored
I/O requests
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAP_GET_CONTAINER
Note: This table function has been deprecated and replaced by the
“SNAPCONTAINER administrative view and SNAP_GET_CONTAINER_V91 table
function - Retrieve tablespace_container logical data group snapshot information”
on page 347
SNAP_GET_CONTAINER ( dbname , dbpartitionnum )
The schema is SYSPROC.
The SNAP_GET_CONTAINER table function returns snapshot information from
the tablespace_container logical data group.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
Chapter 4. Deprecated routines 731
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition. If the null value is
specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has
not previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 217. Information returned by the SNAP_GET_CONTAINER table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
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
CONTAINER_TYPE SMALLINT container_type - Container
type
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 container_stripe_set - Stripe
set
DBPARTITIONNUM SMALLINT node_number - Node number
SNAP_GET_DB
Note: This table function has been deprecated and replaced by the
“SNAP_GET_DB_V91 table function - Retrieve snapshot information from the
dbase logical group” on page 742
SNAP_GET_DB ( dbname , dbpartitionnum )
732 Administrative Routines and Views
The schema is SYSPROC.
The SNAP_GET_DB table function returns snapshot information from the database.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 218. Information returned by the SNAP_GET_DB table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
DB_PATH VARCHAR(1024) db_path - Database path
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input database
alias
DB_STATUS BIGINT db_status - Status of database
CATALOG_PARTITION SMALLINT catalog_node - Catalog node
number
CATALOG_PARTITION_NAME VARCHAR(128) catalog_node_name - Catalog node
network name
SERVER_PLATFORM INTEGER server_platform - Server operating
system
DB_LOCATION INTEGER db_location - Database location
DB_CONN_TIME TIMESTAMP db_conn_time - Database activation
timestamp
LAST_RESET TIMESTAMP last_reset - Last reset timestamp
LAST_BACKUP TIMESTAMP last_backup - Last backup
timestamp
CONNECTIONS_TOP BIGINT connections_top - Maximum
number of concurrent connections
TOTAL_CONS BIGINT total_cons - Connects since
database activation
Chapter 4. Deprecated routines 733
Table 218. Information returned by the SNAP_GET_DB table function (continued)
Description or corresponding
Column name Data type monitor element
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 locks_held - Locks held
LOCK_WAITS BIGINT lock_waits - Lock waits
LOCK_WAIT_TIME BIGINT lock_wait_time - Time waited on
locks
LOCK_LIST_IN_USE BIGINT lock_list_in_use - Total lock list
memory in use
DEADLOCKS BIGINT deadlocks - Deadlocks detected
LOCK_ESCALS BIGINT lock_escals - Number of lock
escalations
X_LOCK_ESCALS BIGINT x_lock_escals - Exclusive lock
escalations
LOCKS_WAITING BIGINT locks_waiting - Current agents
waiting on locks
LOCK_TIMEOUTS BIGINT lock_timeouts - Number of lock
timeouts
NUM_INDOUBT_TRANS BIGINT num_indoubt_trans - Number of
indoubt transactions
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 water mark
TOTAL_SORTS BIGINT total_sorts - Total sorts
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
ACTIVE_SORTS BIGINT active_sorts - Active sorts
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
734 Administrative Routines and Views
Table 218. Information returned by the SNAP_GET_DB table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer
pool asynchronous data reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_ASYNC_DATA_WRITES BIGINT pool_async_data_writes - Buffer
pool asynchronous data writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index writes
POOL_ASYNC_INDEX_READS BIGINT pool_async_index_reads - Buffer
pool asynchronous index reads
POOL_ASYNC_INDEX_WRITES BIGINT pool_async_index_writes - Buffer
pool asynchronous index 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
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
BIGINT pool_async_data_read_reqs - Buffer
POOL_ASYNC_DATA_ pool asynchronous read requests
READ_REQS
BIGINT pool_async_index_read_reqs -
POOL_ASYNC_INDEX_ Buffer pool asynchronous index
READ_REQS read requests
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
PREFETCH_WAIT_TIME BIGINT prefetch_wait_time - Time waited
for prefetch
Chapter 4. Deprecated routines 735
Table 218. Information returned by the SNAP_GET_DB table function (continued)
Description or corresponding
Column name Data type monitor element
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
FILES_CLOSED BIGINT files_closed - Database files closed
POOL_DATA_TO_ESTORE BIGINT The pool_data_to_estore ESTORE
monitor element is discontinued. A
NULL value is returned for the
discontinued monitor element.
POOL_INDEX_TO_ESTORE BIGINT The pool_index_to_estore ESTORE
monitor element is discontinued. A
NULL value is returned for the
discontinued monitor element.
POOL_INDEX_FROM_ESTORE BIGINT The pool_index_from_estore
ESTORE monitor element is
discontinued. A NULL value is
returned for the discontinued
monitor element.
POOL_DATA_FROM_ESTORE BIGINT The pool_data_from_estore
ESTORE monitor element is
discontinued. A NULL value is
returned for the discontinued
monitor element.
ELAPSED_EXEC_TIME_S BIGINT elapsed_exec_time - Statement
execution elapsed time
ELAPSED_EXEC_TIME_MS BIGINT elapsed_exec_time - Statement
execution 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 dynamic_sql_stmts - Dynamic SQL
statements attempted
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
736 Administrative Routines and Views
Table 218. Information returned by the SNAP_GET_DB table function (continued)
Description or corresponding
Column name Data type monitor element
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
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
INT_COMMITS BIGINT int_commits - Internal commits
INT_ROLLBACKS BIGINT int_rollbacks - Internal rollbacks
INT_DEADLOCK_ROLLBACKS BIGINT int_deadlock_rollbacks - Internal
rollbacks due to deadlock
ROWS_DELETED BIGINT rows_deleted - Rows deleted
ROWS_INSERTED BIGINT rows_inserted - Rows inserted
ROWS_UPDATED BIGINT rows_updated - Rows updated
ROWS_SELECTED BIGINT rows_selected - Rows selected
ROWS_READ BIGINT rows_read - Rows read
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_read_time - Log read time
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 log_write_time - Log write time
NUM_LOG_WRITE_IO BIGINT num_log_write_io - Number of log
writes
Chapter 4. Deprecated routines 737
Table 218. Information returned by the SNAP_GET_DB table function (continued)
Description or corresponding
Column name Data type monitor element
NUM_LOG_READ_IO BIGINT num_log_read_io - Number of log
reads
NUM_LOG_PART_PAGE_IO 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
BIGINT num_log_data_found_in_buffer -
NUM_LOG_DATA_FOUND_ Number of log data found in buffer
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
PKG_CACHE_LOOKUPS BIGINT pkg_cache_lookups - Package
cache lookups
PKG_CACHE_INSERTS BIGINT pkg_cache_inserts - Package cache
inserts
BIGINT pkg_cache_num_overflows -
PKG_CACHE_NUM_ Package cache overflows
OVERFLOWS
PKG_CACHE_SIZE_TOP BIGINT pkg_cache_size_top - Package
cache high water mark
APPL_SECTION_LOOKUPS BIGINT appl_section_lookups - Section
lookups
APPL_SECTION_INSERTS BIGINT appl_section_inserts - Section
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
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
BIGINT priv_workspace_num_overflows -
PRIV_WORKSPACE_NUM_ Private workspace overflows
OVERFLOWS
BIGINT priv_workspace_section_inserts -
PRIV_WORKSPACE_SECTION_ Private workspace section inserts
INSERTS
738 Administrative Routines and Views
Table 218. Information returned by the SNAP_GET_DB table function (continued)
Description or corresponding
Column name Data type monitor element
BIGINT priv_workspace_section_lookups -
PRIV_WORKSPACE_SECTION_ Private workspace section lookups
LOOKUPS
SHR_WORKSPACE_SIZE_TOP BIGINT shr_workspace_size_top -
Maximum shared workspace size
BIGINT shr_workspace_num_overflows -
SHR_WORKSPACE_NUM_ Shared workspace overflows
OVERFLOWS
BIGINT shr_workspace_section_inserts -
SHR_WORKSPACE_SECTION_ Shared workspace section inserts
INSERTS
BIGINT shr_workspace_section_lookups -
SHR_WORKSPACE_SECTION_ Shared workspace section lookups
LOOKUPS
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
BIGINT hash_join_small_overflows - Hash
HASH_JOIN_SMALL_ join small overflows
OVERFLOWS
NUM_DB_STORAGE_PATHS BIGINT num_db_storage_paths - Number
of automatic storage paths
DBPARTITIONNUM SMALLINT node_number - Node number
SNAP_GET_DBM table function – Retrieve the dbm logical grouping
snapshot information
Note: This table function has been deprecated and replaced by the “SNAPDBM
administrative view and SNAP_GET_DBM_V95 table function - Retrieve the dbm
logical grouping snapshot information” on page 366.
The SNAP_GET_DBM table function returns the snapshot monitor DB2 database
manager (dbm) logical grouping information.
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.
Refer to Table 219 on page 740 for a complete list of information that can be
returned.
Syntax
SNAP_GET_DBM ( )
dbpartitionnum
Chapter 4. Deprecated routines 739
The schema is SYSPROC.
Table function parameter
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
partition number. Specify -1 for the current database partition, or -2 for an
aggregate of all active database partitions. If this input option is not used, data
will be returned from all active database partitions. An active database
partition is a partition where the database is available for connection and use
by applications.
If dbpartitionnum 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_DBM table function calls the snapshot from memory.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DBM table function.
Example
Retrieve the start time and current status of database partition number 2.
SELECT DB2START_TIME, DB2_STATUS FROM TABLE(SNAP_GET_DBM(2)) AS T
The following is an example of output from this query.
DB2START_TIME DB2_STATUS
-------------------------- ------------
2006-01-06-14.59.59.062798 ACTIVE
Information returned
Table 219. Information returned by the SNAP_GET_DBM table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
SORT_HEAP_ALLOCATED BIGINT sort_heap_allocated - Total sort
heap allocated
POST_THRESHOLD_SORTS BIGINT post_threshold_sorts - Post
threshold sorts
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
740 Administrative Routines and Views
Table 219. Information returned by the SNAP_GET_DBM table function (continued)
Description or corresponding
Column name Data type monitor element
LOCAL_CONS_IN_EXEC BIGINT local_cons_in_exec - Local
Connections Executing in the
Database Manager monitor 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.
This interface returns a text
identifier based on defines in
sqlmon.h, and is one of:
v ACTIVE
v QUIESCE_PEND
v QUIESCED
AGENTS_REGISTERED_TOP BIGINT agents_registered_top - Maximum
number of agents registered
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
BIGINT agents_created_empty_pool -
AGENTS_CREATED_ Agents created due to empty agent
EMPTY_POOL pool
COORD_AGENTS_TOP BIGINT coord_agents_top - Maximum
number of coordinating agents
MAX_AGENT_OVERFLOWS BIGINT max_agent_overflows - Maximum
agent overflows
AGENTS_STOLEN BIGINT agents_stolen - Stolen agents
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
connections for DB2 Connect
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
BIGINT post_threshold_hash_joins - Hash
POST_THRESHOLD_ join threshold
HASH_JOINS
Chapter 4. Deprecated routines 741
Table 219. Information returned by the SNAP_GET_DBM table function (continued)
Description or corresponding
Column name Data type monitor element
NUM_GW_CONN_SWITCHES BIGINT num_gw_conn_switches -
Connection switches
DB2START_TIME TIMESTAMP db2start_time - Start database
manager timestamp
LAST_RESET TIMESTAMP last_reset - Last reset timestamp
INTEGER num_nodes_in_db2_instance -
NUM_NODES_IN_ Number of nodes in database
DB2_INSTANCE 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 The database partition from which
the data was retrieved for this row.
SNAP_GET_DB_V91 table function - Retrieve snapshot information
from the dbase logical group
Note: This table function has been deprecated and replaced by the “SNAPDB
administrative view and SNAP_GET_DB_V95 table function - Retrieve snapshot
information from the dbase logical group” on page 351.
The SNAP_GET_DB_V91 table function returns snapshot information from the
database (dbase) logical group.
Used in conjunction with the SNAP_GET_DB_MEMORY_POOL,
SNAP_GET_DETAILLOG_V91, SNAP_GET_HADR and
SNAP_GET_STORAGE_PATHS table functions, the SNAP_GET_DB_V91 table
function provides information equivalent to the GET SNAPSHOT FOR ALL
DATABASES CLP command.
Refer to Table 220 on page 744 for a complete list of information that is returned.
Syntax
SNAP_GET_DB_V91 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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 an empty
742 Administrative Routines and Views
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 currently connected database.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_DB_V91 table function takes a snapshot for the currently connected
database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DB_V91 table function.
Examples
Example 1: Retrieve the status, platform, location, and connect time as an aggregate
view across all database partitions of the currently connected database.
SELECT SUBSTR(DB_NAME, 1, 20) AS DB_NAME, DB_STATUS, SERVER_PLATFORM,
DB_LOCATION, DB_CONN_TIME FROM TABLE(SNAP_GET_DB_V91(’’, -2)) AS T
The following is an example of output from this query.
DB_NAME DB_STATUS SERVER_PLATFORM ...
-------...- ------------ --------------- ...
SAMPLE ACTIVE AIX64 ...
1 record(s) selected.
Output from this query (continued).
... DB_LOCATION DB_CONN_TIME
... ------------ --------------------------
... LOCAL 2005-07-24-22.09.22.013196
Example 2: Retrieve the status, platform, location, and connect time as an aggregate
view across all database partitions for all active databases in the same instance that
contains the currently connected database.
SELECT SUBSTR(DB_NAME, 1, 20) AS DB_NAME, DB_STATUS, SERVER_PLATFORM,
DB_LOCATION, DB_CONN_TIME
FROM TABLE(SNAP_GET_DB_V91(CAST (NULL AS VARCHAR(128)), -2)) AS T
The following is an example of output from this query.
DB_NAME DB_STATUS SERVER_PLATFORM ...
--------...- ------------ --------------- ...
TOOLSDB ACTIVE AIX64 ...
SAMPLE ACTIVE AIX64 ...
Output from this query (continued).
Chapter 4. Deprecated routines 743
... DB_LOCATION DB_CONN_TIME
... ------------ --------------------------
... LOCAL 2005-07-24-22.26.54.396335
... LOCAL 2005-07-24-22.09.22.013196
SNAP_GET_DB_V91 table function metadata
Table 220. Information returned by the SNAP_GET_DB_V91 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
DB_PATH VARCHAR(1024) db_path - Database path
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input database
alias
DB_STATUS VARCHAR(12) db_status - Status of database. This
interface returns a text identifier
based on defines in sqlmon.h, and
is one of:
v ACTIVE
v QUIESCE_PEND
v QUIESCED
v ROLLFWD
CATALOG_PARTITION SMALLINT catalog_node - Catalog node
number
CATALOG_PARTITION_NAME VARCHAR(128) catalog_node_name - Catalog node
network name
744 Administrative Routines and Views
Table 220. Information returned by the SNAP_GET_DB_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
SERVER_PLATFORM VARCHAR(12) 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
v WINDOWS95
DB_LOCATION VARCHAR(12) db_location - Database location.
This interface returns a text
identifier based on defines in
sqlmon.h, and is one of:
v LOCAL
v REMOTE
DB_CONN_TIME TIMESTAMP db_conn_time - Database activation
timestamp
LAST_RESET TIMESTAMP last_reset - Last reset timestamp
Chapter 4. Deprecated routines 745
Table 220. Information returned by the SNAP_GET_DB_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
LAST_BACKUP TIMESTAMP last_backup - Last backup
timestamp
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 locks_held - Locks held
LOCK_WAITS BIGINT lock_waits - Lock waits
LOCK_WAIT_TIME BIGINT lock_wait_time - Time waited on
locks
LOCK_LIST_IN_USE BIGINT lock_list_in_use - Total lock list
memory in use
DEADLOCKS BIGINT deadlocks - Deadlocks detected
LOCK_ESCALS BIGINT lock_escals - Number of lock
escalations
X_LOCK_ESCALS BIGINT x_lock_escals - Exclusive lock
escalations
LOCKS_WAITING BIGINT locks_waiting - Current agents
waiting on locks
LOCK_TIMEOUTS BIGINT lock_timeouts - Number of lock
timeouts
NUM_INDOUBT_TRANS BIGINT num_indoubt_trans - Number of
indoubt transactions
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 water mark
POST_SHRTHRESHOLD_SORTS BIGINT post_shrthreshold_sorts - Post
shared threshold sorts
TOTAL_SORTS BIGINT total_sorts - Total sorts
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
746 Administrative Routines and Views
Table 220. Information returned by the SNAP_GET_DB_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
ACTIVE_SORTS BIGINT active_sorts - Active sorts
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer
pool asynchronous data reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_ASYNC_DATA_WRITES BIGINT pool_async_data_writes - Buffer
pool asynchronous data writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
POOL_ASYNC_INDEX_READS BIGINT pool_async_index_reads - Buffer
pool asynchronous index reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index writes
POOL_ASYNC_INDEX_WRITES BIGINT pool_async_index_writes - Buffer
pool asynchronous index writes
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool
XDA Data Physical Reads
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool
XDA Data Logical Reads
POOL_XDA_WRITES BIGINT pool_xda_writes - Buffer Pool XDA
Data Writes
POOL_ASYNC_XDA_READS BIGINT pool_async_xda_reads - Buffer Pool
Asynchronous XDA Data Reads
POOL_ASYNC_XDA_WRITES BIGINT pool_async_xda_writes - Buffer
Pool Asynchronous XDA Data
Writes
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer
Pool Temporary XDA Data Physical
Reads monitor element
Chapter 4. Deprecated routines 747
Table 220. Information returned by the SNAP_GET_DB_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
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
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
BIGINT pool_async_data_read_reqs - Buffer
POOL_ASYNC_DATA_ pool asynchronous read requests
READ_REQS
BIGINT pool_async_index_read_reqs -
POOL_ASYNC_INDEX_ Buffer pool asynchronous index
READ_REQS read requests
BIGINT pool_async_xda_read_reqs - Buffer
POOL_ASYNC_XDA_ Pool Asynchronous XDA Read
READ_REQS Requests
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
PREFETCH_WAIT_TIME BIGINT prefetch_wait_time - Time waited
for prefetch
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
FILES_CLOSED BIGINT files_closed - Database files closed
ELAPSED_EXEC_TIME_S BIGINT elapsed_exec_time - Statement
execution elapsed time
748 Administrative Routines and Views
Table 220. Information returned by the SNAP_GET_DB_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
ELAPSED_EXEC_TIME_MS BIGINT elapsed_exec_time - Statement
execution 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 dynamic_sql_stmts - Dynamic SQL
statements attempted
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
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
INT_COMMITS BIGINT int_commits - Internal commits
INT_ROLLBACKS BIGINT int_rollbacks - Internal rollbacks
INT_DEADLOCK_ROLLBACKS BIGINT int_deadlock_rollbacks - Internal
rollbacks due to deadlock
ROWS_DELETED BIGINT rows_deleted - Rows deleted
ROWS_INSERTED BIGINT rows_inserted - Rows inserted
ROWS_UPDATED BIGINT rows_updated - Rows updated
ROWS_SELECTED BIGINT rows_selected - Rows selected
ROWS_READ BIGINT rows_read - Rows read
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
Chapter 4. Deprecated routines 749
Table 220. Information returned by the SNAP_GET_DB_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
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_read_time - Log read time
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 log_write_time - Log write time
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
NUM_LOG_PART_PAGE_IO 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
BIGINT num_log_data_found_in_buffer -
NUM_LOG_DATA_FOUND_ Number of log data found in buffer
IN_BUFFER
APPL_ID_OLDEST_XACT BIGINT appl_id_oldest_xact - Application
with oldest transaction
BIGINT log_to_redo_for_recovery - Amount
LOG_TO_REDO_FOR_ of log to be redone for recovery
RECOVERY
LOG_HELD_BY_DIRTY_PAGES BIGINT log_held_by_dirty_pages - Amount
of log space accounted for by dirty
pages
PKG_CACHE_LOOKUPS BIGINT pkg_cache_lookups - Package cache
lookups
PKG_CACHE_INSERTS BIGINT pkg_cache_inserts - Package cache
inserts
BIGINT pkg_cache_num_overflows -
PKG_CACHE_NUM_ Package cache overflows
OVERFLOWS
PKG_CACHE_SIZE_TOP BIGINT pkg_cache_size_top - Package cache
high water mark
APPL_SECTION_LOOKUPS BIGINT appl_section_lookups - Section
lookups
APPL_SECTION_INSERTS BIGINT appl_section_inserts - Section
inserts
CAT_CACHE_LOOKUPS BIGINT cat_cache_lookups - Catalog cache
lookups
750 Administrative Routines and Views
Table 220. Information returned by the SNAP_GET_DB_V91 table function (continued)
Description or corresponding
Column name Data type monitor element
CAT_CACHE_INSERTS BIGINT cat_cache_inserts - Catalog cache
inserts
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
BIGINT priv_workspace_num_overflows -
PRIV_WORKSPACE_NUM_ Private workspace overflows
OVERFLOWS
BIGINT priv_workspace_section_inserts -
PRIV_WORKSPACE_SECTION_ Private workspace section inserts
INSERTS
BIGINT priv_workspace_section_lookups -
PRIV_WORKSPACE_SECTION_ Private workspace section lookups
LOOKUPS
SHR_WORKSPACE_SIZE_TOP BIGINT shr_workspace_size_top -
Maximum shared workspace size
BIGINT shr_workspace_num_overflows -
SHR_WORKSPACE_NUM_ Shared workspace overflows
OVERFLOWS
BIGINT shr_workspace_section_inserts -
SHR_WORKSPACE_SECTION_ Shared workspace section inserts
INSERTS
BIGINT shr_workspace_section_lookups -
SHR_WORKSPACE_SECTION_ Shared workspace section lookups
LOOKUPS
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
BIGINT hash_join_small_overflows - Hash
HASH_JOIN_SMALL_ join small overflows
OVERFLOWS
BIGINT post_shrthreshold_hash_joins - Post
POST_SHRTHRESHOLD_ threshold hash joins
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 The database partition from which
the data was retrieved for this row.
INTEGER smallest_log_avail_node - Node
SMALLEST_LOG_AVAIL_ with least available log space
NODE
Chapter 4. Deprecated routines 751
SNAP_GET_DYN_SQL_V91 table function - Retrieve dynsql logical
group snapshot information
Note: This table function has been deprecated and replaced by the
“SNAPDYN_SQL administrative view and SNAP_GET_DYN_SQL_V95 table
function - Retrieve dynsql logical group snapshot information” on page 375.
The SNAP_GET_DYN_SQL_V91 table function returns snapshot information from
the dynsql logical data group.
This table function returns information equivalent to the GET SNAPSHOT FOR
DYNAMIC SQL ON database-alias CLP command.
Refer to Table 221 on page 753 for a complete list of information that can be
returned.
Syntax
SNAP_GET_DYN_SQL_V91 ( dbname )
, dbpartitionnum
The schema is SYSPROC.
Table function parameters
dbname
An input argument of type VARCHAR(128) that specifies a valid database
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.
dbpartitionnum
An optional input argument of type INTEGER that specifies a valid database
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
database is available for connection and use by applications.
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_DYN_SQL_V91 table function takes a snapshot for the currently
connected database and database partition number.
Authorization
v SYSMON authority
v EXECUTE privilege on the SNAP_GET_DYN_SQL_V91 table function.
752 Administrative Routines and Views
Example
Retrieve a list of dynamic SQL run on the currently connected database partition of
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 FROM TABLE(SNAP_GET_DYN_SQL_V91(’’,-1)) as T
ORDER BY ROWS_READ
The following is an example of output from this query.
PREP_TIME_WORST ...
-------------------- ...
0 ...
3 ...
...
4 ...
...
4 ...
...
4 ...
...
3 ...
...
4 ...
...
Output from this query (continued).
... NUM_COMPILATIONS STMT_TEXT
... -------------------- ---------------------------------------...-
... 0 SET CURRENT LOCALE LC_CTYPE = ’en_US’
... 1 select rows_read, rows_written,
... substr(stmt_text, 1, 40) as
... 1 select * from table
... (snap_get_dyn_sqlv9(’’,-1)) as t
... 1 select * from table
... (snap_getdetaillog9(’’,-1)) as t
... 1 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,
Information returned
Table 221. Information returned by the SNAP_GET_DYN_SQL_V91 table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
NUM_EXECUTIONS BIGINT num_executions - Statement
executions
NUM_COMPILATIONS BIGINT num_compilations - Statement
compilations
PREP_TIME_WORST BIGINT prep_time_worst - Statement worst
preparation time
PREP_TIME_BEST BIGINT prep_time_best - Statement best
preparation time
INT_ROWS_DELETED BIGINT int_rows_deleted - Internal rows
deleted
Chapter 4. Deprecated routines 753
Table 221. Information returned by the SNAP_GET_DYN_SQL_V91 table
function (continued)
Description or corresponding
Column name Data type monitor element
INT_ROWS_INSERTED BIGINT int_rows_inserted - Internal rows
inserted
INT_ROWS_UPDATED BIGINT int_rows_updated - Internal rows
updated
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
STMT_SORTS BIGINT stmt_sorts - Statement sorts
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
POOL_XDA_L_READS BIGINT pool_xda_l_reads - Buffer Pool
XDA Data Logical Reads
POOL_XDA_P_READS BIGINT pool_xda_p_reads - Buffer Pool
XDA Data Physical Reads
POOL_TEMP_XDA_L_READS BIGINT pool_temp_xda_l_reads - Buffer
Pool Temporary XDA Data Logical
Reads
POOL_TEMP_XDA_P_READS BIGINT pool_temp_xda_p_reads - Buffer
Pool Temporary XDA Data Physical
Reads monitor element
TOTAL_EXEC_TIME BIGINT total_exec_time - Elapsed statement
execution time
TOTAL_EXEC_TIME_MS BIGINT total_exec_time - Elapsed statement
execution time
TOTAL_USR_CPU_TIME BIGINT total_usr_cpu_time - Total user
CPU for a statement
TOTAL_USR_CPU_TIME_MS BIGINT total_usr_cpu_time - Total user
CPU for a statement
754 Administrative Routines and Views
Table 221. Information returned by the SNAP_GET_DYN_SQL_V91 table
function (continued)
Description or corresponding
Column name Data type monitor element
TOTAL_SYS_CPU_TIME BIGINT total_sys_cpu_time - Total system
CPU for a statement
TOTAL_SYS_CPU_TIME_MS BIGINT total_sys_cpu_time - Total system
CPU for a statement
STMT_TEXT CLOB(2 M) stmt_text - SQL statement text
DBPARTITIONNUM SMALLINT The database partition from which
the data was retrieved for this row.
SNAP_GET_DYN_SQL
Note: This table function has been deprecated and replaced by the
“SNAP_GET_DYN_SQL_V91 table function - Retrieve dynsql logical group
snapshot information” on page 752
SNAP_GET_DYN_SQL ( dbname , dbpartitionnum )
The schema is SYSPROC.
The SNAP_GET_DYN_SQL table function returns snapshot information from the
dynsql logical data group.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 222. Information returned by the SNAP_GET_DYN_SQL table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
Chapter 4. Deprecated routines 755
Table 222. Information returned by the SNAP_GET_DYN_SQL table function (continued)
Description or corresponding
Column name Data type monitor element
NUM_EXECUTIONS BIGINT num_executions - Statement
executions
NUM_COMPILATIONS BIGINT num_compilations - Statement
compilations
PREP_TIME_WORST BIGINT prep_time_worst - Statement worst
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_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
STMT_SORTS BIGINT stmt_sorts - Statement sorts
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
TOTAL_EXEC_TIME BIGINT total_exec_time - Elapsed statement
execution time
TOTAL_EXEC_TIME_MS BIGINT total_exec_time - Elapsed statement
execution time
TOTAL_USR_TIME BIGINT total_usr_cpu_time - Total user
CPU for a statement
TOTAL_USR_TIME_MS BIGINT total_usr_cpu_time - Total user
CPU for a statement
TOTAL_SYS_TIME BIGINT total_sys_cpu_time - Total system
CPU for a statement
756 Administrative Routines and Views
Table 222. Information returned by the SNAP_GET_DYN_SQL table function (continued)
Description or corresponding
Column name Data type monitor element
TOTAL_SYS_TIME_MS BIGINT total_sys_cpu_time - Total system
CPU for a statement
STMT_TEXT CLOB stmt_text - SQL statement text
SNAP_GET_STO_PATHS
Note: This table function has been deprecated and replaced by the
“SNAPSTORAGE_PATHS administrative view and SNAP_GET_STORAGE_PATHS
table function - Retrieve automatic storage path information” on page 403
SNAP_GET_STO_PATHS ( dbname , dbpartitionnum )
The schema is SYSPROC.
The SNAP_GET_STO_PATHS table function returns snapshot information from the
storage_paths logical data group.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 223. Information returned by the SNAP_GET_STO_PATHS table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
DB_NAME VARCHAR(128) db_name - Database name
DB_STORAGE_PATH VARCHAR(256) db_storage_path - Automatic
storage path
Chapter 4. Deprecated routines 757
SNAP_GET_TAB
Note: This table function has been deprecated and replaced by the “SNAPTAB
administrative view and SNAP_GET_TAB_V91 table function - Retrieve table
logical data group snapshot information” on page 412
SNAP_GET_TAB ( dbname , dbpartitionnum )
The schema is SYSPROC.
The SNAP_GET_TAB table function returns snapshot information from the table
logical data group.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 224. Information returned by the SNAP_GET_TAB table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TABSCHEMA VARCHAR(128) table_schema - Table schema
name
TABNAME VARCHAR(128) table_name - Table name
TAB_FILE_ID BIGINT table_file_id - Table file
identification
TAB_TYPE BIGINT table_type - Table type
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
758 Administrative Routines and Views
Table 224. Information returned by the SNAP_GET_TAB table function (continued)
Description or
corresponding monitor
Column name Data type element
LONG_OBJECT_PAGES BIGINT long_object_pages - Long
object pages
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
OVERFLOW_ACCESSES BIGINT overflow_accesses - Accesses
to overflowed records
PAGE_REORGS BIGINT page_reorgs - Page
reorganizations
DBPARTITIONNUM SMALLINT node_number - Node number
SNAP_GET_TBSP
Note: This table function has been deprecated and replaced by the “SNAPTBSP
administrative view and SNAP_GET_TBSP_V91 table function - Retrieve table
space logical data group snapshot information” on page 419
SNAP_GET_TBSP ( dbname , dbpartitionnum )
The schema is SYSPROC.
The SNAP_GET_TBSP table function returns snapshot information from the table
space logical data group.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition. If the null value is
specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has
not previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 225. Information returned by the SNAP_GET_TBSP table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
Chapter 4. Deprecated routines 759
Table 225. Information returned by the SNAP_GET_TBSP table function (continued)
Description or corresponding
Column name Data type monitor element
TBSP_NAME VARCHAR(128) tablespace_name - Table space
name
TBSP_ID BIGINT tablespace_id - Table space
identification
TBSP_TYPE SMALLINT tablespace_type - Table space type
TBSP_CONTENT_TYPE SMALLINT tablespace_content_type - Table
space contents type
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_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_CACHING1 SMALLINT fs_caching - File system caching
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_TEMP_DATA_L_READS BIGINT pool_temp_data_l_reads - Buffer
pool temporary data logical reads
POOL_TEMP_DATA_P_READS BIGINT pool_temp_data_p_reads - Buffer
pool temporary data physical reads
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer
pool asynchronous data reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_ASYNC_DATA_WRITES BIGINT pool_async_data_writes - Buffer
pool asynchronous data writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_TEMP_INDEX_L_READS BIGINT pool_temp_index_l_reads - Buffer
pool temporary index logical reads
POOL_TEMP_INDEX_P_READS BIGINT pool_temp_index_p_reads - Buffer
pool temporary index physical
reads
POOL_ASYNC_INDEX_READS BIGINT pool_async_index_reads - Buffer
pool asynchronous index reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index writes
760 Administrative Routines and Views
Table 225. Information returned by the SNAP_GET_TBSP table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_ASYNC_INDEX_WRITES BIGINT pool_async_index_writes - Buffer
pool asynchronous index 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
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
BIGINT pool_async_data_read_reqs - Buffer
POOL_ASYNC_DATA_ pool asynchronous read requests
READ_REQS
BIGINT pool_async_index_read_reqs -
POOL_ASYNC_INDEX_ Buffer pool asynchronous index
READ_REQS read requests
POOL_NO_VICTIM_BUFFER BIGINT pool_no_victim_buffer - Buffer pool
no victim buffers
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
FILES_CLOSED BIGINT files_closed - Database files closed
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
POOL_DATA_TO_ESTORE BIGINT The pool_data_to_estore ESTORE
monitor element is discontinued. A
NULL value is returned for the
discontinued monitor element.
POOL_INDEX_TO_ESTORE BIGINT The pool_index_to_estore ESTORE
monitor element is discontinued. A
NULL value is returned for the
discontinued monitor element.
POOL_INDEX_FROM_ESTORE BIGINT The pool_index_from_estore
ESTORE monitor element is
discontinued. A NULL value is
returned for the discontinued
monitor element.
Chapter 4. Deprecated routines 761
Table 225. Information returned by the SNAP_GET_TBSP table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_DATA_FROM_ESTORE BIGINT The pool_data_from_estore
ESTORE monitor element is
discontinued. A NULL value is
returned for the discontinued
monitor element.
TBSP_REBALANCER_MODE BIGINT tablespace_rebalancer_mode -
Rebalancer mode
TBSP_USING_AUTO_STORAGE SMALLINT tablespace_using_auto_storage -
Using automatic storage
TBSP_AUTO_RESIZE_ENABLED SMALLINT tablespace_auto_resize_enabled -
Auto-resize enabled
1
If FS_CACHING is 0, file system caching is enabled, and if FS_CACHING is 1, file system
caching is disabled.
SNAP_GET_TBSP_PART
Note: This table function has been deprecated and replaced by the
“SNAPTBSP_PART administrative view and SNAP_GET_TBSP_PART_V91 table
function - Retrieve tablespace_nodeinfo logical data group snapshot information”
on page 424
SNAP_GET_TBSP_PART ( dbname , dbpartitionnum )
The schema is SYSPROC.
The SNAP_GET_TBSP_PART table function returns snapshot information from the
tablespace_nodeinfo logical data group.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition. If the null value is
specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has
not previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
762 Administrative Routines and Views
The function returns a table as shown below.
Table 226. Information returned by the SNAP_GET_TBSP_PART table function
Description or corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was
taken.
TBSP_NAME VARCHAR tablespace_name - Table space name
(128)
TBSP_ID BIGINT tablespace_id - Table space identification
TBSP_STATE BIGINT tablespace_state - Table space state
TBSP_PREFETCH_SIZE BIGINT tablespace_prefetch_size - Table space
prefetch size
TBSP_NUM_QUIESCERS BIGINT tablespace_num_quiescers - Number of
quiescers
BIGINT tablespace_state_change_object_id - State
TBSP_STATE_CHANGE_ change object identification
OBJECT_ID
BIGINT tablespace_state_change_ts_id - State change
TBSP_STATE_CHANGE_ table space identification
TBSP_ID
TIMESTAMP tablespace_min_recovery_time - Minimum
TBSP_MIN_RECOVERY_ recovery time for rollforward
TIME
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
TBSP_FREE_PAGES BIGINT tablespace_free_pages - Free pages in table
space
BIGINT tablespace_pending_free_pages - Pending
TBSP_PENDING_FREE_ free pages in table space
PAGES
TBSP_PAGE_TOP BIGINT tablespace_page_top - Table space high
water mark
REBALANCER_MODE BIGINT tablespace_rebalancer_mode - Rebalancer
mode
BIGINT tablespace_rebalancer_extents_remaining -
REBALANCER_EXTENTS_ Total number of extents to be processed by
REMAINING the rebalancer
BIGINT tablespace_rebalancer_extents_processed -
REBALANCER_EXTENTS_ Number of extents the rebalancer has
PROCESSED processed
REBALANCER_PRIORITY BIGINT tablespace_rebalancer_priority - Current
rebalancer priority
TIMESTAMP tablespace_rebalancer_start_time -
REBALANCER_START_ Rebalancer start time
TIME
Chapter 4. Deprecated routines 763
Table 226. Information returned by the SNAP_GET_TBSP_PART table function (continued)
Description or corresponding monitor
Column name Data type element
TIMESTAMP tablespace_rebalancer_restart_time -
REBALANCER_RESTART_ Rebalancer restart time
TIME
BIGINT tablespace_rebalancer_last_extent_moved -
REBALANCER_LAST_ Last extent moved by the rebalancer
EXTENT_MOVED
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
SMALLINT tablespace_increase_size_percent - Increase
TBSP_INCREASE_SIZE_ size by percent
PERCENT
TIMESTAMP tablespace_last_resize_time - Time of last
TBSP_LAST_RESIZE_ successful resize
TIME
SMALLINT tablespace_last_resize_failed - Last resize
TBSP_LAST_RESIZE_ attempt failed
FAILED
DBPARTITIONNUM SMALLINT node_number - Node number
SNAPSHOT_AGENT
Note: This table function has been deprecated and replaced by the “SNAPAGENT
administrative view and SNAP_GET_AGENT table function – Retrieve agent
logical data group application snapshot information” on page 318.
SNAPSHOT_AGENT ( dbname , dbpartitionnum )
The schema is SYSPROC.
The SNAPSHOT_AGENT function returns information about agents from an
application snapshot.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
this function. Specify a database name that has a directory entry type of either
764 Administrative Routines and Views
″Indirect″ or ″Home″, as returned by the LIST DATABASE DIRECTORY
command. Specify the null value to take the snapshot from all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 227. Information returned by the SNAPSHOT_AGENT table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
AGENT_PID BIGINT agent_pid - Engine
dispatchable unit (EDU)
SNAPSHOT_APPL
Returns general information from an application snapshot.
Note: This table function has been deprecated and replaced by the
“SNAP_GET_APPL table function – Retrieve appl logical data group snapshot
information” on page 715.
SNAPSHOT_APPL ( dbname , dbpartitionnum )
The schema is SYSPROC.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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 all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Chapter 4. Deprecated routines 765
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 228. Information returned by the SNAPSHOT_APPL table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
UOW_LOG_SPACE_USED BIGINT uow_log_space_used - Unit of
work log space used
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index 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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
POOL_DATA_TO_ESTORE BIGINT The pool_data_to_estore ESTORE
monitor element is discontinued. A
NULL value is returned for the
discontinued monitor element.
766 Administrative Routines and Views
Table 228. Information returned by the SNAPSHOT_APPL table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_INDEX_TO_ESTORE BIGINT The pool_index_to_estore ESTORE
monitor element is discontinued. A
NULL value is returned for the
discontinued monitor element.
POOL_INDEX_FROM_ESTORE BIGINT The pool_index_from_estore
ESTORE monitor element is
discontinued. A NULL value is
returned for the discontinued
monitor element.
POOL_DATA_FROM_ESTORE BIGINT The pool_data_from_estore
ESTORE monitor element is
discontinued. A NULL value is
returned for the discontinued
monitor element.
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
LOCKS_HELD BIGINT locks_held - Locks held
LOCK_WAITS BIGINT lock_waits - Lock waits
LOCK_WAIT_TIME BIGINT lock_wait_time - Time waited on
locks
LOCK_ESCALS BIGINT lock_escals - Number of lock
escalations
X_LOCK_ESCALS BIGINT x_lock_escals - Exclusive lock
escalations
DEADLOCKS BIGINT deadlocks - Deadlocks detected
TOTAL_SORTS BIGINT total_sorts - Total sorts
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
COMMIT_SQL_STMTS BIGINT commit_sql_stmts - Commit
statements attempted
ROLLBACK_SQL_STMTS BIGINT rollback_sql_stmts - Rollback
statements attempted
DYNAMIC_SQL_STMTS BIGINT dynamic_sql_stmts - Dynamic SQL
statements attempted
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
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
Chapter 4. Deprecated routines 767
Table 228. Information returned by the SNAPSHOT_APPL table function (continued)
Description or corresponding
Column name Data type monitor element
INT_ROWS_DELETED BIGINT int_rows_deleted - Internal rows
deleted
INT_ROWS_UPDATED BIGINT int_rows_updated - Internal rows
updated
INT_COMMITS BIGINT int_commits - Internal commits
INT_ROLLBACKS BIGINT int_rollbacks - Internal rollbacks
INT_DEADLOCK_ROLLBACKS BIGINT int_deadlock_rollbacks - Internal
rollbacks due to deadlock
ROWS_DELETED BIGINT rows_deleted - Rows deleted
ROWS_INSERTED BIGINT rows_inserted - Rows inserted
ROWS_UPDATED BIGINT rows_updated - Rows updated
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
SQL_REQS_SINCE_COMMIT BIGINT sql_reqs_since_commit - SQL
requests since last commit
LOCK_TIMEOUTS BIGINT lock_timeouts - Number of lock
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
cursors with blocking
PKG_CACHE_LOOKUPS BIGINT pkg_cache_lookups - Package
cache lookups
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
CAT_CACHE_HEAP_FULL BIGINT cat_cache_overflows - Catalog
cache overflows
NUM_AGENTS BIGINT num_agents - Number of agents
working on a statement
768 Administrative Routines and Views
Table 228. Information returned by the SNAPSHOT_APPL table function (continued)
Description or corresponding
Column name Data type monitor element
AGENTS_STOLEN BIGINT agents_stolen - Stolen agents
ASSOCIATED_AGENTS_TOP BIGINT associated_agents_top - Maximum
number of associated agents
APPL_PRIORITY BIGINT appl_priority - Application agent
priority
APPL_PRIORITY_TYPE BIGINT appl_priority_type - Application
priority type
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 - 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
BIGINT hash_join_small_overflows - Hash
HASH_JOIN_SMALL_ join small overflows
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
UOW_COMP_STATUS BIGINT uow_comp_status - Unit of work
completion status
AGENT_USR_CPU_TIME_S BIGINT agent_usr_cpu_time - User CPU
time used by agent
AGENT_USR_CPU_TIME_MS BIGINT agent_usr_cpu_time - User CPU
time used by agent
AGENT_SYS_CPU_TIME_S BIGINT agent_sys_cpu_time - System CPU
time used by agent
AGENT_SYS_CPU_TIME_MS BIGINT agent_sys_cpu_time - System CPU
time used by agent
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
Chapter 4. Deprecated routines 769
Table 228. Information returned by the SNAPSHOT_APPL table function (continued)
Description or corresponding
Column name Data type monitor element
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
UOW_ELAPSED_TIME_MS BIGINT uow_elapsed_time - Most recent
unit of work elapsed time
ELAPSED_EXEC_TIME_S BIGINT elapsed_exec_time - Statement
execution elapsed time
ELAPSED_EXEC_TIME_MS BIGINT elapsed_exec_time - Statement
execution elapsed time
INBOUND_COMM_ADDRESS VARCHAR(32) inbound_comm_address - Inbound
communication address
SNAPSHOT_APPL_INFO
Returns general information from an application snapshot.
Note: This table function has been deprecated and replaced by the
“SNAP_GET_APPL_INFO table function – Retrieve appl_info logical data group
snapshot information” on page 721.
SNAPSHOT_APPL_INFO ( dbname , dbpartitionnum )
The schema is SYSPROC.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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 all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
770 Administrative Routines and Views
The function returns a table as shown below.
Table 229. Information returned by the SNAPSHOT_APPL_INFO table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
APPL_STATUS BIGINT appl_status - Application
status
CODEPAGE_ID BIGINT codepage_id - ID of code
page used by application
NUM_ASSOC_AGENTS BIGINT num_assoc_agents - Number
of associated agents
COORD_PARTITION_NUM BIGINT coord_node - Coordinating
node
AUTHORITY_LVL BIGINT authority_lvl - User
authorization level
CLIENT_PID BIGINT client_pid - Client process ID
COORD_AGENT_PID BIGINT coord_agent_pid -
Coordinator agent
STATUS_CHANGE_TIME TIMESTAMP status_change_time -
Application status change
time
CLIENT_PLATFORM SMALLINT client_platform - Client
operating platform
CLIENT_PROTOCOL SMALLINT client_protocol - Client
communication protocol
COUNTRY_CODE SMALLINT territory_code - Database
territory code
APPL_NAME VARCHAR(256) appl_name - Application
name
APPL_ID VARCHAR(128) appl_id - Application ID
SEQUENCE_NO VARCHAR(4) sequence_no - Sequence
number
AUTH_ID VARCHAR(128) auth_id - Authorization ID
CLIENT_NNAME VARCHAR(128) The client_nname monitor
element is deprecated. The
value returned is not a valid
value.
CLIENT_PRDID VARCHAR(128) client_prdid - Client
product/version ID
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input
database alias
CLIENT_DB_ALIAS VARCHAR(128) client_db_alias - Database
alias used by application
DB_NAME VARCHAR(128) db_name - Database name
DB_PATH VARCHAR(1024) db_path - Database path
Chapter 4. Deprecated routines 771
Table 229. Information returned by the SNAPSHOT_APPL_INFO table function (continued)
Description or
corresponding monitor
Column name Data type element
EXECUTION_ID VARCHAR(128) execution_id - User login ID
CORR_TOKEN VARCHAR(128) corr_token - DRDA
correlation token
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
SNAPSHOT_BP
Returns information from a buffer pool snapshot.
Note: This table function has been deprecated and replaced by the
“SNAP_GET_BP table function – Retrieve bufferpool logical group snapshot
information” on page 728.
SNAPSHOT_BP ( dbname , dbpartitionnum )
The schema is SYSPROC.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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 all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
772 Administrative Routines and Views
The function returns a table as shown below.
Table 230. Information returned by the SNAPSHOT_BP table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index 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
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer
pool asynchronous data reads
POOL_ASYNC_DATA_WRITES BIGINT pool_async_data_writes - Buffer
pool asynchronous data writes
POOL_ASYNC_INDEX_WRITES BIGINT pool_async_index_writes - Buffer
pool asynchronous index writes
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
BIGINT pool_async_data_read_reqs - Buffer
POOL_ASYNC_DATA_ pool asynchronous read requests
READ_REQS
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
POOL_ASYNC_INDEX_READS BIGINT pool_async_index_reads - Buffer
pool asynchronous index reads
Chapter 4. Deprecated routines 773
Table 230. Information returned by the SNAPSHOT_BP table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_DATA_TO_ESTORE BIGINT The pool_data_to_estore ESTORE
monitor element is discontinued. A
NULL value is returned for the
discontinued monitor element.
POOL_INDEX_TO_ESTORE BIGINT The pool_index_to_estore ESTORE
monitor element is discontinued. A
NULL value is returned for the
discontinued monitor element.
POOL_INDEX_FROM_ESTORE BIGINT The pool_index_from_estore
ESTORE monitor element is
discontinued. A NULL value is
returned for the discontinued
monitor element.
POOL_DATA_FROM_ESTORE BIGINT The pool_data_from_estore
ESTORE monitor element is
discontinued. A NULL value is
returned for the discontinued
monitor element.
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
FILES_CLOSED BIGINT files_closed - Database files closed
BP_NAME VARCHAR(128) bp_name - Buffer pool name
DB_NAME VARCHAR(128) db_name - Database name
DB_PATH VARCHAR(1024) db_path - Database path
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input database
alias
SNAPSHOT_CONTAINER
Returns container configuration information from a table space snapshot.
Note: This table function has been deprecated and replaced by the
“SNAPCONTAINER administrative view and SNAP_GET_CONTAINER_V91 table
function - Retrieve tablespace_container logical data group snapshot information”
on page 347
SNAPSHOT_CONTAINER ( dbname , dbpartitionnum )
The schema is SYSPROC.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
774 Administrative Routines and Views
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 231. Information returned by the SNAPSHOT_CONTAINER table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TABLESPACE_ID BIGINT tablespace_id - Table space
identification
TABLESPACE_NAME VARCHAR(128) tablespace_name - Table
space name
CONTAINER_ID BIGINT container_id - Container
identification
CONTAINER_NAME VARCHAR(256) container_name - Container
name
CONTAINER_TYPE SMALLINT container_type - Container
type
TOTAL_PAGES BIGINT container_total_pages - Total
pages in container
USABLE_PAGES BIGINT container_usable_pages -
Usable pages in container
ACCESSIBLE BIGINT container_accessible -
Accessibility of container
STRIPE_SET BIGINT container_stripe_set - Stripe
set
SNAPSHOT_DATABASE
Returns information from a database snapshot.
Note: This table function has been deprecated and replaced by the
“SNAP_GET_DB_V91 table function - Retrieve snapshot information from the
dbase logical group” on page 742
SNAPSHOT_DATABASE ( dbname , dbpartitionnum )
The schema is SYSPROC.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
this function. Specify a database name that has a directory entry type of either
Chapter 4. Deprecated routines 775
″Indirect″ or ″Home″, as returned by the LIST DATABASE DIRECTORY
command. Specify the null value to take the snapshot from all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 232. Information returned by the SNAPSHOT_DATABASE table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
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
TOTAL_LOG_USED BIGINT total_log_used - Total log space
used
TOTAL_LOG_AVAILABLE BIGINT total_log_available - Total log
available
ROWS_READ BIGINT rows_read - Rows read
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index 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
POOL_ASYNC_INDEX_READS BIGINT pool_async_index_reads - Buffer
pool asynchronous index reads
776 Administrative Routines and Views
Table 232. Information returned by the SNAPSHOT_DATABASE table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_DATA_TO_ESTORE BIGINT The pool_data_to_estore ESTORE
monitor element is discontinued. A
NULL value is returned for the
discontinued monitor element.
POOL_INDEX_TO_ESTORE BIGINT The pool_index_to_estore ESTORE
monitor element is discontinued. A
NULL value is returned for the
discontinued monitor element.
POOL_INDEX_FROM_ESTORE BIGINT The pool_index_from_estore
ESTORE monitor element is
discontinued. A NULL value is
returned for the discontinued
monitor element.
POOL_DATA_FROM_ESTORE BIGINT The pool_data_from_estore
ESTORE monitor element is
discontinued. A NULL value is
returned for the discontinued
monitor element.
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer
pool asynchronous data reads
POOL_ASYNC_DATA_WRITES BIGINT pool_async_data_writes - Buffer
pool asynchronous data writes
POOL_ASYNC_INDEX_WRITES BIGINT pool_async_index_writes - Buffer
pool asynchronous index writes
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
BIGINT pool_async_data_read_reqs - Buffer
POOL_ASYNC_DATA_ pool asynchronous read requests
READ_REQS
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
FILES_CLOSED BIGINT files_closed - Database files closed
POOL_LSN_GAP_CLNS BIGINT pool_lsn_gap_clns - Buffer pool log
space cleaners triggered
Chapter 4. Deprecated routines 777
Table 232. Information returned by the SNAPSHOT_DATABASE table function (continued)
Description or corresponding
Column name Data type monitor element
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
LOCKS_HELD BIGINT locks_held - Locks held
LOCK_WAITS BIGINT lock_waits - Lock waits
LOCK_WAIT_TIME BIGINT lock_wait_time - Time waited on
locks
LOCK_LIST_IN_USE BIGINT lock_list_in_use - Total lock list
memory in use
DEADLOCKS BIGINT deadlocks - Deadlocks detected
LOCK_ESCALS BIGINT lock_escals - Number of lock
escalations
X_LOCK_ESCALS BIGINT x_lock_escals - Exclusive lock
escalations
LOCKS_WAITING BIGINT locks_waiting - agents waiting on
locks
SORT_HEAP_ALLOCATED BIGINT sort_heap_allocated - Total sort
heap allocated
TOTAL_SORTS BIGINT total_sorts - Total sorts
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
ACTIVE_SORTS BIGINT active_sorts - Active sorts
COMMIT_SQL_STMTS BIGINT commit_sql_stmts - Commit
statements attempted
ROLLBACK_SQL_STMTS BIGINT rollback_sql_stmts - Rollback
statements attempted
DYNAMIC_SQL_STMTS BIGINT dynamic_sql_stmts - Dynamic SQL
statements attempted
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
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
778 Administrative Routines and Views
Table 232. Information returned by the SNAPSHOT_DATABASE table function (continued)
Description or corresponding
Column name Data type monitor element
INT_ROWS_UPDATED BIGINT int_rows_updated - Internal rows
updated
INT_COMMITS BIGINT int_commits - Internal commits
INT_ROLLBACKS BIGINT int_rollbacks - Internal rollbacks
INT_DEADLOCK_ROLLBACKS BIGINT int_deadlock_rollbacks - Internal
rollbacks due to deadlock
ROWS_DELETED BIGINT rows_deleted - Rows deleted
ROWS_INSERTED BIGINT rows_inserted - Rows inserted
ROWS_UPDATED BIGINT rows_updated - Rows updated
ROWS_SELECTED BIGINT rows_selected - Rows selected
BINDS_PRECOMPILES BIGINT binds_precompiles -
Binds/precompiles attempted
TOTAL_CONS BIGINT total_cons - Connects since
database activation
APPLS_CUR_CONS BIGINT appls_cur_cons - Applications
connected currently
APPLS_IN_DB2 BIGINT appls_in_db2 - Applications
executing in the database currently
SEC_LOGS_ALLOCATED BIGINT sec_logs_allocated - Secondary logs
allocated currently
DB_STATUS BIGINT db_status - Status of database
LOCK_TIMEOUTS BIGINT lock_timeouts - Number of lock
timeouts
CONNECTIONS_TOP BIGINT connections_top - Maximum
number of concurrent connections
DB_HEAP_TOP BIGINT db_heap_top - Maximum database
heap allocated
INT_ROWS_INSERTED BIGINT int_rows_inserted - Internal rows
inserted
LOG_READS BIGINT log_reads - Number of log pages
read
LOG_WRITES BIGINT log_writes - Number of log pages
written
PKG_CACHE_LOOKUPS BIGINT pkg_cache_lookups - Package
cache lookups
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
CAT_CACHE_HEAP_FULL BIGINT cat_cache_overflows - Catalog
cache overflows
Chapter 4. Deprecated routines 779
Table 232. Information returned by the SNAPSHOT_DATABASE table function (continued)
Description or corresponding
Column name Data type monitor element
CATALOG_PARTITION SMALLINT catalog_node - Catalog node
number
TOTAL_SEC_CONS BIGINT total_sec_cons - Secondary
connections
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
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
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
BIGINT hash_join_small_overflows - Hash
HASH_JOIN_SMALL_ join small overflows
OVERFLOWS
BIGINT pkg_cache_num_overflows -
PKG_CACHE_NUM_ Package cache overflows
OVERFLOWS
PKG_CACHE_SIZE_TOP BIGINT pkg_cache_size_top - Package
cache high water mark
DB_CONN_TIME TIMESTAMP db_conn_time - Database activation
timestamp
SQLM_ELM_LAST_RESET TIMESTAMP last_reset - Last reset timestamp
SQLM_ELM_LAST_BACKUP TIMESTAMP last_backup - Last backup
timestamp
APPL_CON_TIME TIMESTAMP appl_con_time - Connection
request start timestamp
DB_LOCATION INTEGER db_location - Database location
SERVER_PLATFORM INTEGER server_platform - Server operating
system
APPL_ID_OLDEST_XACT BIGINT appl_id_oldest_xact - Application
with oldest transaction
CATALOG_PARTITION_NAME VARCHAR(128) catalog_node_name - Catalog node
network name
INPUT_DB_ALIAS VARCHAR(128) input_db_alias - Input database
alias
DB_NAME VARCHAR(128) db_name - Database name
780 Administrative Routines and Views
Table 232. Information returned by the SNAPSHOT_DATABASE table function (continued)
Description or corresponding
Column name Data type monitor element
DB_PATH VARCHAR(1024) db_path - Database path
SNAPSHOT_DBM
Returns information from a snapshot of the DB2 database manager.
Note: This table function has been deprecated and replaced by the
“SNAP_GET_DBM table function – Retrieve the dbm logical grouping snapshot
information” on page 739.
SNAPSHOT_DBM ( dbpartitionnum )
The schema is SYSPROC.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If the null value is specified, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 233. Information returned by the SNAPSHOT_DBM table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
SORT_HEAP_ALLOCATED BIGINT sort_heap_allocated - Total sort
heap allocated
POST_THRESHOLD_SORTS BIGINT post_threshold_sorts - Post
threshold sorts
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
Chapter 4. Deprecated routines 781
Table 233. Information returned by the SNAPSHOT_DBM table function (continued)
Description or corresponding
Column name Data type monitor element
LOCAL_CONS_IN_EXEC BIGINT local_cons_in_exec - Local
Connections Executing in the
Database Manager monitor 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 BIGINT db_status - Status of database
AGENTS_REGISTERED_TOP BIGINT agents_registered_top - Maximum
number of agents registered
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
BIGINT agents_created_empty_pool -
AGENTS_CREATED_ Agents created due to empty agent
EMPTY_POOL pool
COORD_AGENTS_TOP BIGINT coord_agents_top - Maximum
number of coordinating agents
MAX_AGENT_OVERFLOWS BIGINT max_agent_overflows - Maximum
agent overflows
AGENTS_STOLEN BIGINT agents_stolen - Stolen agents
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
connections for DB2 Connect
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
BIGINT post_threshold_hash_joins - Hash
POST_THRESHOLD_ join threshold
HASH_JOINS
INACTIVE_GW_AGENTS BIGINT idle_agents - Number of idle
agents
NUM_GW_CONN_SWITCHES BIGINT num_gw_conn_switches -
Connection switches
782 Administrative Routines and Views
Table 233. Information returned by the SNAPSHOT_DBM table function (continued)
Description or corresponding
Column name Data type monitor element
DB2START_TIME TIMESTAMP db2start_time - Start database
manager timestamp
LAST_RESET TIMESTAMP last_reset - Last reset timestamp
SNAPSHOT_DYN_SQL
Returns information from a dynamic SQL snapshot. It replaces the
SQLCACHE_SNAPSHOT function, which is still available for compatibility
reasons.
Note: This table function has been deprecated and replaced by the
“SNAP_GET_DYN_SQL_V91 table function - Retrieve dynsql logical group
snapshot information” on page 752
SNAPSHOT_DYN_SQL ( dbname , dbpartitionnum )
The schema is SYSPROC.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 234. Information returned by the SNAPSHOT_DYN_SQL table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
NUM_EXECUTIONS BIGINT num_executions - Statement
executions
Chapter 4. Deprecated routines 783
Table 234. Information returned by the SNAPSHOT_DYN_SQL table function (continued)
Description or
corresponding monitor
Column name Data type element
NUM_COMPILATIONS BIGINT num_compilations -
Statement compilations
PREP_TIME_WORST BIGINT prep_time_worst - Statement
worst 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
STMT_SORTS BIGINT stmt_sorts - Statement sorts
TOTAL_EXEC_TIME BIGINT total_exec_time - Elapsed
statement execution time
TOTAL_SYS_CPU_TIME BIGINT total_sys_cpu_time - Total
system CPU for a statement
TOTAL_USR_CPU_TIME BIGINT total_usr_cpu_time - Total
user CPU for a statement
STMT_TEXT CLOB(16M)1 stmt_text - SQL statement
text
1
STMT_TEXT is defined as CLOB(16M) to allow for future expansion only. Actual output of
the statement text is truncated at 64K.
SNAPSHOT_FCM
Note: This table function has been deprecated and replaced by the “SNAPFCM
administrative view and SNAP_GET_FCM table function – Retrieve the fcm logical
data group snapshot information” on page 380.
SNAPSHOT_FCM ( dbpartitionnum )
The schema is SYSPROC.
The SNAPSHOT_FCM function returns database manager level information
regarding the fast communication manager (FCM).
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
784 Administrative Routines and Views
The function returns a table as shown below.
Table 235. Information returned by the SNAPSHOT_FCM table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
BUFF_FREE BIGINT buff_free - FCM buffers
currently free
BUFF_FREE_BOTTOM BIGINT buff_free_bottom - Minimum
FCM Buffers Free
MA_FREE BIGINT The ma_free monitor element
is discontinued. A null value
is returned for the
discontinued monitor
element.
MA_FREE_BOTTOM BIGINT The ma_free_bottom monitor
element is discontinued. A
null value is returned for the
discontinued monitor
element.
CE_FREE BIGINT The ce_free monitor element
is discontinued. A null value
is returned for the
discontinued monitor
element.
CE_FREE_BOTTOM BIGINT The ce_free_bottom monitor
element is discontinued. A
null value is returned for the
discontinued monitor
element.
RB_FREE BIGINT The rb_free monitor element
is discontinued. A null value
is returned for the
discontinued monitor
element.
RB_FREE_BOTTOM BIGINT The rb_free_bottom monitor
element is discontinued. A
null value is returned for the
discontinued monitor
element.
PARTITION_NUMBER SMALLINT node_number - Node
number
SNAPSHOT_FCMNODE
Returns information from a snapshot of the fast communication manager in the
database manager.
Note: This table function has been deprecated and replaced by the
“SNAPFCM_PART administrative view and SNAP_GET_FCM_PART table function
– Retrieve the fcm_node logical data group snapshot information” on page 382.
Chapter 4. Deprecated routines 785
SNAPSHOT_FCMNODE ( dbpartitionnum )
The schema is SYSPROC.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If the null value is specified, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 236. Information returned by the SNAPSHOT_FCMNODE table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
CONNECTION_STATUS BIGINT 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
PARTITION_NUMBER SMALLINT node_number - Node
number
SNAPSHOT_FILEW
Note: This procedure has been deprecated and replaced by the
“SNAP_WRITE_FILE procedure” on page 441.
SNAPSHOT_FILEW ( requestType , dbname , dbpartitionnum )
The schema is SYSPROC.
The SNAPSHOT_FILEW procedure writes system snapshot data to a file located in
the tmp subdirectory of the instance directory. To execute the SNAPSHOT_FILEW
procedure, a user must have SYSADM, SYSCTRL, or SYSMAINT authority. The
saved snapshot can be read by users who do not have SYSADM, SYSCTRL, or
SYSMAINT authority by passing null values as the inputs to snapshot functions.
requestType
An input argument of type SMALLINT that specifies a valid snapshot request
type, as defined in sqlmon.h.
786 Administrative Routines and Views
dbname
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 procedure. Specify the null value to take the snapshot from the currently
connected database.
dbpartitionnum
An input argument of type SMALLINT that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
Example: Take a snapshot of database manager information by specifying a request
type of 1 (which corresponds to SQLMA_DB2), and defaulting to the currently
connected database and current database partition.
CALL SNAPSHOT_FILEW (1, CAST (NULL AS VARCHAR(128)), CAST (NULL AS SMALLINT))
This will result in snapshot data being written to /tmp/SQLMA_DB2.dat in the
instance directory on UNIX operating systems or to \tmp\SQLMA_DB2.dat in the
instance directory on a Windows operating system.
SNAPSHOT_LOCK
Returns information from a lock snapshot.
Note: This table function has been deprecated and replaced by the “SNAPLOCK
administrative view and SNAP_GET_LOCK table function – Retrieve lock logical
data group snapshot information” on page 388.
SNAPSHOT_LOCK ( dbname , dbpartitionnum )
The schema is SYSPROC.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
Chapter 4. Deprecated routines 787
The function returns a table as shown below.
Table 237. Information returned by the SNAPSHOT_LOCK table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
TABLE_FILE_ID BIGINT table_file_id - Table file
identification
LOCK_OBJECT_TYPE BIGINT lock_object_type - Lock
object type waited on
LOCK_MODE BIGINT lock_mode - Lock mode
LOCK_STATUS BIGINT lock_status - Lock status
LOCK_OBJECT_NAME BIGINT lock_object_name - Lock
object name
PARTITION_NUMBER SMALLINT node_number - Node
number
LOCK_ESCALATION SMALLINT lock_escalation - Lock
escalation
TABLE_NAME VARCHAR(128) table_name - Table name
TABLE_SCHEMA VARCHAR(128) table_schema - Table schema
name
TABLESPACE_NAME VARCHAR(128) tablespace_name - Table
space name
SNAPSHOT_LOCKWAIT
Returns lock waits information from an application snapshot.
Note: This table function has been deprecated and replaced by the
“SNAPLOCKWAIT administrative view and SNAP_GET_LOCKWAIT table
function – Retrieve lockwait logical data group snapshot information” on page 393.
SNAPSHOT_LOCKWAIT ( dbname , dbpartitionnum )
The schema is SYSPROC.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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 all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
788 Administrative Routines and Views
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 238. Information returned by the SNAPSHOT_LOCKWAIT table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
SUBSECTION_NUMBER BIGINT ss_number - Subsection
number
LOCK_MODE BIGINT lock_mode - Lock mode
LOCK_OBJECT_TYPE BIGINT lock_object_type - Lock
object type waited on
AGENT_ID_HOLDING_LK BIGINT agent_id_holding_lock -
Agent ID holding lock
LOCK_WAIT_START_TIME TIMESTAMP lock_wait_start_time - Lock
wait start timestamp
LOCK_MODE_REQUESTED BIGINT lock_mode_requested - Lock
mode requested
PARTITION_NUMBER SMALLINT node_number - Node
number
LOCK_ESCALLATION SMALLINT lock_escalation - Lock
escalation
TABLE_NAME VARCHAR(128) table_name - Table name
TABLE_SCHEMA VARCHAR(128) table_schema - Table schema
name
TABLESPACE_NAME VARCHAR(128) tablespace_name - Table
space name
APPL_ID_HOLDING_LK VARCHAR(128) appl_id_holding_lk -
Application ID holding lock
SNAPSHOT_QUIESCERS
Note: This table function has been deprecated and replaced by the
“SNAPTBSP_QUIESCER administrative view and SNAP_GET_TBSP_QUIESCER
table function - Retrieve quiescer table space snapshot information” on page 429.
SNAPSHOT_QUIESCERS ( dbname , dbpartitionnum )
Chapter 4. Deprecated routines 789
The schema is SYSPROC.
The SNAPSHOT_QUIESCERS function returns information about quiescers from a
table space snapshot.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
The function returns a table as shown below.
Table 239. Information returned by the SNAPSHOT_QUIESCERS table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TABLESPACE_NAME VARCHAR(128) tablespace_name - Table
space name
QUIESCER_TBS_ID BIGINT quiescer_ts_id - Quiescer
table space identification
QUIESCER_OBJ_ID BIGINT quiescer_obj_id - Quiescer
object identification
QUIESCER_AUTH_ID BIGINT quiescer_auth_id - Quiescer
user authorization
identification
QUIESCER_AGENT_ID BIGINT quiescer_agent_id - Quiescer
agent identification
QUIESCER_STATE BIGINT quiescer_state - Quiescer
state
SNAPSHOT_RANGES
Note: This table function has been deprecated and replaced by the
“SNAPTBSP_RANGE administrative view and SNAP_GET_TBSP_RANGE table
function - Retrieve range snapshot information” on page 432.
SNAPSHOT_RANGES ( dbname , dbpartitionnum )
The schema is SYSPROC.
790 Administrative Routines and Views
The SNAPSHOT_RANGES function returns information from a range snapshot.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
The function returns a table as shown below.
Table 240. Information returned by the SNAPSHOT_RANGES table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TABLESPACE_ID BIGINT tablespace_id - Table space
identification
TABLESPACE_NAME VARCHAR(128) tablespace_name - Table space
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
SNAPSHOT_STATEMENT
Returns information about statements from an application snapshot.
Note: This table function has been deprecated and replaced by the “SNAPSTMT
administrative view and SNAP_GET_STMT table function – Retrieve statement
snapshot information” on page 398.
Chapter 4. Deprecated routines 791
SNAPSHOT_STATEMENT ( dbname , dbpartitionnum )
The schema is SYSPROC.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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 all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 241. Information returned by the SNAPSHOT_STATEMENT table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
AGENT_ID BIGINT agent_id - Application handle
(agent ID)
ROWS_READ BIGINT rows_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
NUM_AGENTS BIGINT num_agents - Number of agents
working on a statement
AGENTS_TOP BIGINT agents_top - Number of agents
created
STMT_TYPE BIGINT stmt_type - Statement type
STMT_OPERATION BIGINT stmt_operation/operation -
Statement operation
SECTION_NUMBER BIGINT section_number - Section number
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 stmt_sorts - Statement sorts
TOTAL_SORT_TIME BIGINT total_sort_time - Total sort time
SORT_OVERFLOWS BIGINT sort_overflows - Sort overflows
792 Administrative Routines and Views
Table 241. Information returned by the SNAPSHOT_STATEMENT table function (continued)
Description or corresponding
Column name Data type monitor element
INT_ROWS_DELETED BIGINT int_rows_deleted - Internal rows
deleted
INT_ROWS_UPDATED BIGINT int_rows_updated - Internal rows
updated
INT_ROWS_INSERTED BIGINT int_rows_inserted - Internal rows
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
STMT_USR_CPU_TIME_MS BIGINT stmt_usr_cpu_time - User CPU
time used by statement
STMT_SYS_CPU_TIME_S BIGINT stmt_sys_cpu_time - System CPU
time used by statement
STMT_SYS_CPU_TIME_MS BIGINT stmt_sys_cpu_time - System CPU
time used by statement
STMT_ELAPSED_TIME_S BIGINT stmt_elapsed_time - Most recent
statement elapsed time
STMT_ELAPSED_TIME_MS BIGINT stmt_elapsed_time - Most recent
statement elapsed time
BLOCKING_CURSOR SMALLINT blocking_cursor - Blocking cursor
STMT_PARTITION_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) package_name - Package name
STMT_TEXT CLOB(16M)1 stmt_text - SQL statement text
1
STMT_TEXT is defined as CLOB(16M) to allow for future expansion only. Actual output of
the statement text is truncated at 64K.
SNAPSHOT_SUBSECT
Returns information about subsections of access plans from an application
snapshot.
Note: This table function has been deprecated and replaced by the
“SNAPSUBSECTION administrative view and SNAP_GET_SUBSECTION table
function – Retrieve subsection logical monitor group snapshot information” on
page 406.
SNAPSHOT_SUBSECT ( dbname , dbpartitionnum )
Chapter 4. Deprecated routines 793
The schema is SYSPROC.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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 all databases under
the database instance.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 242. Information returned by the SNAPSHOT_SUBSECT table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
STMT_TEXT CLOB(16M)1 stmt_text - SQL statement text
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 - Current
number 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_read - Rows read
ROWS_WRITTEN BIGINT rows_written - Rows written
SS_USR_CPU_TIME BIGINT ss_usr_cpu_time - User CPU time
used by subsection
SS_SYS_CPU_TIME BIGINT ss_sys_cpu_time - System CPU
time used by subsection
SS_NUMBER INTEGER ss_number - Subsection number
SS_STATUS INTEGER ss_status - Subsection status
794 Administrative Routines and Views
Table 242. Information returned by the SNAPSHOT_SUBSECT table function (continued)
Description or corresponding
Column name Data type monitor element
SS_PARTITION_NUMBER SMALLINT ss_node_number - Subsection node
number
TQ_PARTITION_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
1
STMT_TEXT is defined as CLOB(16M) to allow for future expansion only. Actual output of
the statement text is truncated at 64K.
SNAPSHOT_SWITCHES
Returns information about the database snapshot switch state.
Note: This table function has been deprecated and replaced by the
“SNAPSWITCHES administrative view and SNAP_GET_SWITCHES table function
– Retrieve database snapshot switch state information” on page 409.
SNAPSHOT_SWITCHES ( dbpartitionnum )
The schema is SYSPROC.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
The function returns a table as shown below.
Table 243. Information returned by the SNAPSHOT_SWITCHES table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
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 recording switch (0
or 1).
Chapter 4. Deprecated routines 795
Table 243. Information returned by the SNAPSHOT_SWITCHES table function (continued)
Description or
corresponding monitor
Column name Data type element
STATEMENT_SW_TIME TIMESTAMP If the SQL statement monitor
recording switch is on, the
date and time that this switch
was turned on.
TABLE_SW_STATE SMALLINT State of the table activity
monitor recording switch (0
or 1).
TABLE_SW_TIME TIMESTAMP If the table activity monitor
recording switch is on, the
date and time that this switch
was 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 recording switch is
on, the date and time that
this switch was 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
recording switch (0 or 1).
SORT_SW_TIME TIMESTAMP If the sorting monitor
recording switch is on, the
date and time that this switch
was turned on.
PARTITION_NUMBER SMALLINT node_number - Node
number
SNAPSHOT_TABLE
Returns activity information from a table snapshot.
Note: This table function has been deprecated and replaced by the “SNAPTAB
administrative view and SNAP_GET_TAB_V91 table function - Retrieve table
logical data group snapshot information” on page 412
SNAPSHOT_TABLE ( dbname , dbpartitionnum )
The schema is SYSPROC.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
this function. Specify a database name that has a directory entry type of either
796 Administrative Routines and Views
″Indirect″ or ″Home″, as returned by the LIST DATABASE DIRECTORY
command. Specify the null value to take the snapshot from the currently
connected database.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 244. Information returned by the SNAPSHOT_TABLE table function
Description or
corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
ROWS_WRITTEN BIGINT rows_written - Rows written
ROWS_READ BIGINT rows_read - Rows read
OVERFLOW_ACCESSES BIGINT overflow_accesses - Accesses
to overflowed records
TABLE_FILE_ID BIGINT table_file_id - Table file
identification
TABLE_TYPE BIGINT table_type - Table type
PAGE_REORGS BIGINT page_reorgs - Page
reorganizations
TABLE_NAME VARCHAR(128) table_name - Table name
TABLE_SCHEMA VARCHAR(128) table_schema - Table schema
name
SNAPSHOT_TBREORG
Note: This table function has been deprecated and replaced by the
“SNAPTAB_REORG administrative view and SNAP_GET_TAB_REORG table
function - Retrieve table reorganization snapshot information” on page 415.
SNAPSHOT_TBREORG ( dbname , dbpartitionnum )
The schema is SYSPROC.
The SNAPSHOT_TBREORG function returns table reorganization information in
the form of a result set. If no tables have been reorganized, 0 rows are returned. To
obtain real-time snapshot information, the user must have SYSADM, SYSCTRL, or
SYSMAINT authority.
Chapter 4. Deprecated routines 797
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 245. Information returned by the SNAPSHOT_TBREORG table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
TABLE_NAME VARCHAR(128) table_name - Table name
TABLE_SCHEMA VARCHAR(128) table_schema - Table schema name
PAGE_REORGS BIGINT page_reorgs - Page reorganizations
REORG_PHASE BIGINT reorg_phase - Table reorganize
phase
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 INTEGER reorg_type - Table reorganize
attributes
REORG_STATUS BIGINT reorg_status - Table reorganize
status
REORG_COMPLETION INTEGER reorg_completion - Table
reorganization completion flag
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
798 Administrative Routines and Views
Table 245. Information returned by the SNAPSHOT_TBREORG table function (continued)
Description or corresponding
Column name Data type monitor element
REORG_TBSPC_ID BIGINT reorg_tbspc_id - Table space where
table is reorganized
PARTITION_NUMBER SMALLINT node_number - Node number
SNAPSHOT_TBS
Returns activity information from a table space snapshot.
Note: This table function has been deprecated and replaced by the “SNAPTBSP
administrative view and SNAP_GET_TBSP_V91 table function - Retrieve table
space logical data group snapshot information” on page 419
SNAPSHOT_TBS ( dbname , dbpartitionnum )
The schema is SYSPROC.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
The function returns a table as shown below.
Table 246. Information returned by the SNAPSHOT_TBS table function
Description or corresponding
Column name Data type monitor element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the
snapshot was taken.
POOL_DATA_L_READS BIGINT pool_data_l_reads - Buffer pool
data logical reads
POOL_DATA_P_READS BIGINT pool_data_p_reads - Buffer pool
data physical reads
POOL_ASYNC_DATA_READS BIGINT pool_async_data_reads - Buffer
pool asynchronous data reads
Chapter 4. Deprecated routines 799
Table 246. Information returned by the SNAPSHOT_TBS table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_DATA_WRITES BIGINT pool_data_writes - Buffer pool data
writes
POOL_ASYNC_DATA_WRITES BIGINT pool_async_data_writes - Buffer
pool asynchronous data writes
POOL_INDEX_L_READS BIGINT pool_index_l_reads - Buffer pool
index logical reads
POOL_INDEX_P_READS BIGINT pool_index_p_reads - Buffer pool
index physical reads
POOL_INDEX_WRITES BIGINT pool_index_writes - Buffer pool
index writes
POOL_ASYNC_INDEX_WRITES BIGINT pool_async_index_writes - Buffer
pool asynchronous index 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
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
BIGINT pool_async_data_read_reqs - Buffer
POOL_ASYNC_DATA_ pool asynchronous read requests
READ_REQS
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_read_time - Direct read time
DIRECT_WRITE_TIME BIGINT direct_write_time - Direct write
time
UNREAD_PREFETCH_PAGES BIGINT unread_prefetch_pages - Unread
prefetch pages
POOL_ASYNC_INDEX_READS BIGINT pool_async_index_reads - Buffer
pool asynchronous index reads
POOL_DATA_TO_ESTORE BIGINT The pool_data_to_estore ESTORE
monitor element is discontinued. A
NULL value is returned for the
discontinued monitor element.
POOL_INDEX_TO_ESTORE BIGINT The pool_index_to_estore ESTORE
monitor element is discontinued. A
NULL value is returned for the
discontinued monitor element.
800 Administrative Routines and Views
Table 246. Information returned by the SNAPSHOT_TBS table function (continued)
Description or corresponding
Column name Data type monitor element
POOL_INDEX_FROM_ESTORE BIGINT The pool_index_from_estore
ESTORE monitor element is
discontinued. A NULL value is
returned for the discontinued
monitor element.
POOL_DATA_FROM_ESTORE BIGINT The pool_data_from_estore
ESTORE monitor element is
discontinued. A NULL value is
returned for the discontinued
monitor element.
FILES_CLOSED BIGINT files_closed - Database files closed
TABLESPACE_NAME VARCHAR(128) tablespace_name - Table space
name
SNAPSHOT_TBS_CFG
Note: This table function has been deprecated and replaced by the
“SNAPTBSP_PART administrative view and SNAP_GET_TBSP_PART_V91 table
function - Retrieve tablespace_nodeinfo logical data group snapshot information”
on page 424
SNAPSHOT_TBS_CFG ( dbname , dbpartitionnum )
The schema is SYSPROC.
The SNAPSHOT_TBS_CFG function returns configuration information from a table
space snapshot.
dbname
An input argument of type VARCHAR(255) that specifies a valid database
name in the same instance as the currently connected database when calling
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.
dbpartitionnum
An input argument of type INTEGER that specifies a valid database partition
number. Specify -1 for the current database partition, or -2 for all active
database partitions. An active database partition is a partition where the
database is available for connection and use by applications.
If the null value is specified, -1 is set implicitly.
If both parameters are set to NULL, the snapshot will be taken only if a file has not
previously been created by the SNAPSHOT_FILEW stored procedure for the
corresponding snapshot API request type.
Chapter 4. Deprecated routines 801
The function returns a table as shown below.
Table 247. Information returned by the SNAPSHOT_TBS_CFG table function
Description or corresponding monitor
Column name Data type element
SNAPSHOT_TIMESTAMP TIMESTAMP The date and time that the snapshot was
taken.
TABLESPACE_ID BIGINT tablespace_id - Table space identification
TABLESPACE_NAME VARCHAR tablespace_name - Table space name
(128)
TABLESPACE_TYPE SMALLINT tablespace_type - Table space type
TABLESPACE_STATE BIGINT tablespace_state - Table space state
NUM_QUIESCERS BIGINT tablespace_num_quiescers - Number of
quiescers
STATE_CHANGE_OBJ_ID BIGINT tablespace_state_change_object_id - State
change object identification
STATE_CHANGE_TBS_ID BIGINT tablespace_state_change_ts_id - State
change table space identification
MIN_RECOVERY_TIME TIMESTAMP tablespace_min_recovery_time - Minimum
recovery time for rollforward
TBS_CONTENTS_TYPE SMALLINT tablespace_content_type - Table space
contents type
BUFFERPOOL_ID BIGINT tablespace_cur_pool_id - Buffer pool
currently being used
NEXT_BUFFERPOOL_ID BIGINT tablespace_next_pool_id - Buffer pool that
will be used at next startup
PAGE_SIZE BIGINT tablespace_page_size - Table space page
size
EXTENT_SIZE BIGINT tablespace_extent_size - Table space extent
size
PREFETCH_SIZE BIGINT tablespace_prefetch_size - Table space
prefetch size
TOTAL_PAGES BIGINT tablespace_total_pages - Total pages in table
space
USABLE_PAGES BIGINT tablespace_usable_pages - Usable pages in
table space
USED_PAGES BIGINT tablespace_used_pages - Used pages in
table space
FREE_PAGES BIGINT tablespace_free_pages - Free pages in table
space
PENDING_FREE_PAGES BIGINT tablespace_pending_free_pages - Pending
free pages in table space
HIGH_WATER_MARK BIGINT pool_watermark - Memory pool watermark
REBALANCER_MODE BIGINT tablespace_rebalancer_mode - Rebalancer
mode
BIGINT tablespace_rebalancer_extents_remaining -
REBALANCER_EXTENTS_ Total number of extents to be processed by
REMAINING the rebalancer
802 Administrative Routines and Views
Table 247. Information returned by the SNAPSHOT_TBS_CFG table function (continued)
Description or corresponding monitor
Column name Data type element
BIGINT tablespace_rebalancer_extents_processed -
REBALANCER_EXTENTS_ Number of extents the rebalancer has
PROCESSED processed
REBALANCER_PRIORITY BIGINT tablespace_rebalancer_priority - Current
rebalancer priority
TIMESTAMP tablespace_rebalancer_start_time -
REBALANCER_START_ Rebalancer start time
TIME
TIMESTAMP tablespace_rebalancer_restart_time -
REBALANCER_RESTART_ Rebalancer restart time
TIME
LAST_EXTENT_MOVED BIGINT tablespace_rebalancer_last_extent_moved -
Last extent moved by the rebalancer
NUM_RANGES BIGINT tablespace_num_ranges - Number of ranges
in the table space map
NUM_CONTAINERS BIGINT tablespace_num_containers - Number of
containers in table space
SQLCACHE_SNAPSHOT
Note: This table function has been deprecated and replaced by the
“SNAP_GET_DYN_SQL_V91 table function - Retrieve dynsql logical group
snapshot information” on page 752
SQLCACHE_SNAPSHOT ( )
The schema is SYSFUN.
The SQLCACHE_SNAPSHOT function returns the results of a snapshot of the DB2
dynamic SQL statement cache.
The function does not take any arguments. It returns a table, as shown below.
Table 248. Information returned by SQLCACHE_SNAPSHOT table function
Description or
corresponding monitor
Column name Data type element
NUM_EXECUTIONS INTEGER num_executions - Statement
executions
NUM_COMPILATIONS INTEGER num_compilations -
Statement compilations
PREP_TIME_WORST INTEGER prep_time_worst - Statement
worst preparation time
PREP_TIME_BEST INTEGER prep_time_best - Statement
best preparation time
INT_ROWS_DELETED INTEGER int_rows_deleted - Internal
rows deleted
Chapter 4. Deprecated routines 803
Table 248. Information returned by SQLCACHE_SNAPSHOT table function (continued)
Description or
corresponding monitor
Column name Data type element
INT_ROWS_INSERTED INTEGER int_rows_inserted - Internal
rows inserted
ROWS_READ INTEGER rows_read - Rows read
INT_ROWS_UPDATED INTEGER int_rows_updated - Internal
rows updated
ROWS_WRITE INTEGER rows_written - Rows written
STMT_SORTS INTEGER stmt_sorts - Statement sorts
TOTAL_EXEC_TIME_S INTEGER total_exec_time - Elapsed
statement execution time
TOTAL_EXEC_TIME_MS INTEGER total_exec_time - Elapsed
statement execution time
TOT_U_CPU_TIME_S INTEGER total_usr_cpu_time - Total
user CPU for a statement
TOT_U_CPU_TIME_MS INTEGER total_usr_cpu_time - Total
user CPU for a statement
TOT_S_CPU_TIME_S INTEGER total_sys_cpu_time - Total
system CPU for a statement
TOT_S_CPU_TIME_MS INTEGER total_sys_cpu_time - Total
system CPU for a statement
DB_NAME VARCHAR(128) db_name - Database name
1
STMT_TEXT CLOB(16M) stmt_text - SQL statement
text
1
STMT_TEXT is defined as CLOB(16M) to allow for future expansion only. Actual output of
the statement text is truncated at 64K.
SYSINSTALLROUTINES
Note: This procedure has been deprecated. The procedure was used to create new
procedures and functions in DB2 UDB for Linux, UNIX, and Windows Version 8.
SYSINSTALLROUTINES ( )
The schema is SYSPROC.
804 Administrative Routines and Views
Part 2. Appendixes
© Copyright IBM Corp. 2006, 2008 805
806 Administrative Routines and Views
Appendix A. Overview of the DB2 technical information
DB2 technical information is available through the following tools and methods:
v DB2 Information Center
– Topics (Task, concept and reference topics)
– Help for DB2 tools
– 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 hard-copy 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 [email protected].
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/shop/publications/order. English DB2 Version 9.5
manuals in PDF format and translated versions can be downloaded from
www.ibm.com/support/docview.wss?rs=71&uid=swg2700947.
Although the tables identify books available in print, the books might not be
available in your country or region.
© IBM Corporation 1993, 2008 807
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 249. DB2 technical information
Name Form Number Available in print
Administrative API Reference SC23-5842-01 Yes
Administrative Routines and SC23-5843-01 No
Views
Call Level Interface Guide and SC23-5844-01 Yes
Reference, Volume 1
Call Level Interface Guide and SC23-5845-01 Yes
Reference, Volume 2
Command Reference SC23-5846-01 Yes
Data Movement Utilities Guide SC23-5847-01 Yes
and Reference
Data Recovery and High SC23-5848-01 Yes
Availability Guide and Reference
Data Servers, Databases, and SC23-5849-01 Yes
Database Objects Guide
Database Security Guide SC23-5850-01 Yes
Developing ADO.NET and OLE SC23-5851-01 Yes
DB Applications
Developing Embedded SQL SC23-5852-01 Yes
Applications
Developing Java Applications SC23-5853-01 Yes
Developing Perl and PHP SC23-5854-01 No
Applications
Developing User-defined Routines SC23-5855-01 Yes
(SQL and External)
Getting Started with Database GC23-5856-01 Yes
Application Development
Getting Started with DB2 GC23-5857-01 Yes
installation and administration on
Linux and Windows
Internationalization Guide SC23-5858-01 Yes
Message Reference, Volume 1 GI11-7855-00 No
Message Reference, Volume 2 GI11-7856-00 No
Migration Guide GC23-5859-01 Yes
Net Search Extender SC23-8509-01 Yes
Administration and User’s Guide
Partitioning and Clustering Guide SC23-5860-01 Yes
Query Patroller Administration SC23-8507-00 Yes
and User’s Guide
Quick Beginnings for IBM Data GC23-5863-01 No
Server Clients
808 Administrative Routines and Views
Table 249. DB2 technical information (continued)
Name Form Number Available in print
Quick Beginnings for DB2 GC23-5864-01 Yes
Servers
Spatial Extender and Geodetic SC23-8508-01 Yes
Data Management Feature User’s
Guide and Reference
SQL Reference, Volume 1 SC23-5861-01 Yes
SQL Reference, Volume 2 SC23-5862-01 Yes
System Monitor Guide and SC23-5865-01 Yes
Reference
Troubleshooting Guide GI11-7857-01 No
Tuning Database Performance SC23-5867-01 Yes
Visual Explain Tutorial SC23-5868-00 No
What’s New SC23-5869-01 Yes
Workload Manager Guide and SC23-5870-01 Yes
Reference
pureXML Guide SC23-5871-01 Yes
XQuery Reference SC23-5872-01 No
Table 250. DB2 Connect-specific technical information
Name Form Number Available in print
Quick Beginnings for DB2 GC23-5839-01 Yes
Connect Personal Edition
Quick Beginnings for DB2 GC23-5840-01 Yes
Connect Servers
DB2 Connect User’s Guide SC23-5841-01 Yes
Table 251. Information Integration technical information
Name Form Number Available in print
Information Integration: SC19-1020-01 Yes
Administration Guide for
Federated Systems
Information Integration: ASNCLP SC19-1018-02 Yes
Program Reference for Replication
and Event Publishing
Information Integration: SC19-1034-01 No
Configuration Guide for Federated
Data Sources
Information Integration: SQL SC19-1030-01 Yes
Replication Guide and Reference
Information Integration: SC19-1028-01 Yes
Introduction to Replication and
Event Publishing
Appendix A. Overview of the DB2 technical information 809
Ordering printed DB2 books
If you require printed DB2 books, you can buy them online in many but not all
countries or regions. You can always order printed DB2 books from your local IBM
representative. Keep in mind that some softcopy books on the DB2 PDF
Documentation DVD are unavailable in print. For example, neither volume of the
DB2 Message Reference is available as a printed book.
Printed versions of many of the DB2 books available on the DB2 PDF
Documentation DVD can be ordered for a fee from IBM. Depending on where you
are placing your order from, you may be able to order books online, from the IBM
Publications Center. If online ordering is not available in your country or region,
you can always order printed DB2 books from your local IBM representative. Note
that not all books on the DB2 PDF Documentation DVD are available in print.
Note: The most up-to-date and complete DB2 documentation is maintained in the
DB2 Information Center at http://publib.boulder.ibm.com/infocenter/db2luw/
v9r5.
To order printed DB2 books:
v To find out whether you can order printed DB2 books online in your country or
region, check the IBM Publications Center at http://www.ibm.com/shop/
publications/order. You must select a country, region, or language to access
publication ordering information and then follow the ordering instructions for
your location.
v To order printed DB2 books from your local IBM representative:
1. Locate the contact information for your local representative from one of the
following Web sites:
– The IBM directory of world wide contacts at www.ibm.com/planetwide
– The IBM Publications Web site at http://www.ibm.com/shop/
publications/order. You will need to select your country, region, or
language to the access appropriate publications home page for your
location. From this page, follow the ″About this site″ link.
2. When you call, specify that you want to order a DB2 publication.
3. Provide your representative with the titles and form numbers of the books
that you want to order. For titles and form numbers, see “DB2 technical
library in hardcopy or PDF format” on page 807.
Displaying SQL state help from the command line processor
DB2 returns an SQLSTATE value for conditions that could be the result of an SQL
statement. SQLSTATE help explains the meanings of SQL states and SQL state class
codes.
To invoke 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.
810 Administrative Routines and Views
Accessing different versions of the DB2 Information Center
For DB2 Version 9.5 topics, the DB2 Information Center URL is
http://publib.boulder.ibm.com/infocenter/db2luw/v9r5/
For DB2 Version 9 topics, the DB2 Information Center URL is http://
publib.boulder.ibm.com/infocenter/db2luw/v9/
For DB2 Version 8 topics, go to the Version 8 Information Center URL at:
http://publib.boulder.ibm.com/infocenter/db2luw/v8/
Displaying topics in your preferred language in the DB2 Information
Center
The DB2 Information Center attempts to display topics in the language specified in
your browser preferences. If a topic has not been translated into your preferred
language, the DB2 Information Center displays the topic in English.
v To display topics in your preferred language in the Internet Explorer browser:
1. In Internet Explorer, click the Tools —> Internet Options —> Languages...
button. The Language Preferences window opens.
2. Ensure your preferred language is specified as the first entry in the list of
languages.
– To add a new language to the list, click the Add... button.
Note: Adding a language does not guarantee that the computer has the
fonts required to display the topics in the preferred language.
– To move a language to the top of the list, select the language and click the
Move Up button until the language is first in the list of languages.
3. Clear the browser cache and then refresh the page to display the DB2
Information Center in your preferred language.
v To display topics in your preferred language in a Firefox or Mozilla browser:
1. Select the button in the Languages section of the Tools —> Options —>
Advanced dialog. The Languages panel is displayed in the Preferences
window.
2. Ensure your preferred language is specified as the first entry in the list of
languages.
– To add a new language to the list, click the Add... button to select a
language from the Add Languages window.
– To move a language to the top of the list, select the language and click the
Move Up button until the language is first in the list of languages.
3. Clear the browser cache and then refresh the page to display the DB2
Information Center in your preferred language.
On some browser and operating system combinations, you might have to also
change the regional settings of your operating system to the locale and language of
your choice.
Appendix A. Overview of the DB2 technical information 811
Updating the DB2 Information Center installed on your computer or
intranet server
If you have installed the DB2 Information Center locally, you can obtain and install
documentation updates from IBM.
Updating your locally-installed DB2 Information Center requires that you:
1. Stop the DB2 Information Center on your computer, and restart the Information
Center in stand-alone mode. Running the Information Center in stand-alone
mode prevents other users on your network from accessing the Information
Center, and allows you to apply updates. Non-Administrative and Non-Root
DB2 Information Centers always run in stand-alone mode. .
2. Use the Update feature to see what updates are available. If there are updates
that you would like to install, you can use the Update feature to obtain and
install them
Note: If your environment requires installing the DB2 Information Center
updates on a machine that is not connected to the internet, you have to mirror
the update site to a local file system using a machine that is connected to the
internet and has the DB2 Information Center installed. If many users on your
network will be installing the documentation updates, you can reduce the time
required for individuals to perform the updates by also mirroring the update
site locally and creating a proxy for the update site.
If update packages are available, use the Update feature to get the packages.
However, the Update feature is only available in stand-alone mode.
3. Stop the stand-alone Information Center, and restart the DB2 Information
Center on your computer.
Note: On Windows Vista, the commands listed below must be run as an
administrator. To launch a command prompt or graphical tool with full
administrator privileges, right-click on the shortcut and then select Run as
administrator.
To update the DB2 Information Center installed on your computer or intranet
server:
1. Stop the DB2 Information Center.
v On Windows, click Start → Control Panel → Administrative Tools → Services.
Then right-click on DB2 Information Center service and select Stop.
v On Linux, enter the following command:
/etc/init.d/db2icdv95 stop
2. Start the Information Center in stand-alone mode.
v On Windows:
a. Open a command window.
b. Navigate to the path where the Information Center is installed. By
default, the DB2 Information Center is installed in the <Program
Files>\IBM\DB2 Information Center\Version 9.5 directory, where
<Program Files> represents the location of the Program Files directory.
c. Navigate from the installation directory to the doc\bin directory.
d. Run the help_start.bat file:
help_start.bat
v On Linux:
812 Administrative Routines and Views
a. Navigate to the path where the Information Center is installed. By
default, the DB2 Information Center is installed in the
/opt/ibm/db2ic/V9.5 directory.
b. Navigate from the installation directory to the doc/bin directory.
c. Run the help_start script:
help_start
The systems default Web browser launches to display the stand-alone
Information Center.
3. Click the Update button ( ). On the right hand panel of the Information
Center, click Find Updates. A list of updates for existing documentation
displays.
4. To initiate the installation process, check the selections you want to install, then
click Install Updates.
5. After the installation process has completed, click Finish.
6. Stop the stand-alone Information Center:
v On Windows, navigate to the installation directory’s doc\bin directory, and
run the help_end.bat file:
help_end.bat
Note: The help_end batch file contains the commands required to safely
terminate the processes that were started with the help_start batch file. Do
not use Ctrl-C or any other method to terminate help_start.bat.
v On Linux, navigate to the installation directory’s doc/bin directory, and run
the help_end script:
help_end
Note: The help_end script contains the commands required to safely
terminate the processes that were started with the help_start script. Do not
use any other method to terminate the help_start script.
7. Restart the DB2 Information Center.
v On Windows, click Start → Control Panel → Administrative Tools → Services.
Then right-click on DB2 Information Center service and select Start.
v On Linux, enter the following command:
/etc/init.d/db2icdv95 start
The updated DB2 Information Center displays the new and updated topics.
DB2 tutorials
The DB2 tutorials help you learn about various aspects of DB2 products. Lessons
provide step-by-step instructions.
Before you begin
You can view the XHTML version of the tutorial from the Information Center at
http://publib.boulder.ibm.com/infocenter/db2help/.
Some lessons use sample data or code. See the tutorial for a description of any
prerequisites for its specific tasks.
Appendix A. Overview of the DB2 technical information 813
DB2 tutorials
To view the tutorial, click on the title.
“pureXML™” in pureXML Guide
Set up a DB2 database to store XML data and to perform basic operations
with the native XML data store.
“Visual Explain” in Visual Explain Tutorial
Analyze, optimize, and tune SQL statements for better performance using
Visual Explain.
DB2 troubleshooting information
A wide variety of troubleshooting and problem determination information is
available to assist you in using DB2 products.
DB2 documentation
Troubleshooting information can be found in the DB2 Troubleshooting
Guide or the Support and Troubleshooting section of the DB2 Information
Center. There you will find information on how to isolate and identify
problems using DB2 diagnostic tools and utilities, solutions to some of the
most common problems, and other advice on how to solve problems you
might encounter with your DB2 products.
DB2 Technical Support Web site
Refer to the DB2 Technical Support Web site if you are experiencing
problems and want help finding possible causes and solutions. The
Technical Support site has links to the latest DB2 publications, TechNotes,
Authorized Program Analysis Reports (APARs or bug fixes), fix packs, and
other resources. You can search through this knowledge base to find
possible solutions to your problems.
Access the DB2 Technical Support Web site at http://www.ibm.com/
software/data/db2/udb/support.html
Terms and Conditions
Permissions for the use of these publications is granted subject to the following
terms and conditions.
Personal use: You may reproduce these Publications for your personal, non
commercial 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.
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.
814 Administrative Routines and Views
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 above 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.
Appendix A. Overview of the DB2 technical information 815
816 Administrative Routines and Views
Appendix B. Notices
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on 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 give 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 (DBCS) information, contact the IBM
Intellectual Property Department in your country/region or send inquiries, in
writing, to:
IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106, 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
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
This document may provide links or references to non-IBM Web sites and
resources. IBM makes no representations, warranties, or other commitments
whatsoever about any non-IBM Web sites or third-party resources that may be
referenced, accessible from, or linked from this document. A link to a non-IBM
Web site does not mean that IBM endorses the content or use of such Web site or
© IBM Corporation 1993, 2008 817
its owner. In addition, IBM is not a party to or responsible for any transactions you
may enter into with third parties, even if you learn of such parties (or use a link to
such parties) from an IBM site. Accordingly, you acknowledge and agree that IBM
is not responsible for the availability of such external sites or resources, and is not
responsible or liable for any content, services, products, or other materials on or
available from those sites or resources. Any software provided by third parties is
subject to the terms and conditions of the license that accompanies that software.
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
Office of the Lab Director
8200 Warden Avenue
Markham, Ontario
L6G 1C7
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:
818 Administrative Routines and Views
This information may contain 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 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.
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
The following terms are trademarks or registered trademarks of the International
Business Machines Corporation in the United States, other countries, or both.
pureXML OS/390
DB2 Connect DB2 Universal Database
1-2-3 MQSeries
Redbooks PowerPC
IBM DB2
AIX Lotus
DRDA OS/400
DYNIX ibm.com
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 are trademarks of Sun Microsystems, Inc. in
the United States, other countries, or both.
v UNIX is a registered trademark of The Open Group in the United States and
other countries.
v Windows is a registered trademark 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 819
820 Administrative Routines and Views
Index
A administrative views
ADMINTABINFO 199
ADD CONTACT command APPL_PERFORMANCE 295
syntax using ADMIN_CMD 35 APPLICATIONS 296
ADD CONTACTGROUP command authorization 3
sytnax using ADMIN_CMD 36 AUTHORIZATIONIDS 292
ADMIN_CMD procedure 33 BP_HITRATIO 300
removing messages 199 BP_READ_IO 302
retrieving messages 193 BP_WRITE_IO 304
supported commands CONTACTGROUPS 659
ADD CONTACT 35 CONTACTS 660
ADD CONTACTGROUP 36 CONTAINER_UTILIZATION 305
AUTOCONFIGURE 38 DB_HISTORY 661
BACKUP DATABASE 41 DBCFG 214
DESCRIBE 49 DBMCFG 216
DROP CONTACT 58 DBPATHS 665
DROP CONTACTGROUP 58 ENV_FEATURE_INFO 223
EXPORT 59 ENV_INST_INFO 220
FORCE APPLICATION 70 ENV_PROD_INFO 221
GET STMM TUNING DBPARTITIONNUM 71 ENV_SYS_INFO 224
IMPORT 72 ENV_SYS_RESOURCES 225
INITIALIZE TAPE 97 LOCKS_HELD 307
LOAD 98 LOCKWAIT 310
PRUNE HISTORY/LOGFILE 134 LOG_UTILIZATION 314
QUIESCE DATABASE 136 LONG_RUNNING_SQL 315
QUIESCE TABLESPACES FOR TABLE 138 NOTIFICATIONLIST 677
REDISTRIBUTE DATABASE PARTITION GROUP 140 OBJECTOWNERS 293
REORG INDEXES/TABLE 148 overview 1
RESET ALERT CONFIGURATION 157 PDLOGMSGS_LAST24HOURS 685
RESET DATABASE CONFIGURATION 158 PRIVILEGES 294
RESET DATABASE MANAGER QUERY_PREP_COST 317
CONFIGURATION 160 REG_VARIABLES 219
REWIND TAPE 161 SNAPAGENT 318, 442
RUNSTATS 162 SNAPAGENT_MEMORY_POOL 321, 445
SET TAPE POSITION 173 SNAPAPPL 332, 456
UNQUIESCE DATABASE 174 SNAPAPPL_INFO 324, 449
UPDATE ALERT CONFIGURATION 175 SNAPBP 340, 464
UPDATE CONTACT 180 SNAPBP_PART 344, 468
UPDATE CONTACTGROUP 181 SNAPCONTAINER 347, 471
UPDATE DATABASE CONFIGURATION 183 SNAPDB 351, 475
UPDATE DATABASE MANAGER SNAPDB_MEMORY_POOL 362, 486
CONFIGURATION 185 SNAPDBM 366, 490
UPDATE HEALTH NOTIFICATION CONTACT SNAPDBM_MEMORY_POOL 370, 494
LIST 187 SNAPDETAILLOG 372, 496
UPDATE HISTORY 188 SNAPDYN_SQL 375, 499
UPDATE STMM TUNING DBPARTITIONNUM 190 SNAPFCM 380, 504
ADMIN_COPY_SCHEMA procedure 648 SNAPFCM_PART 382, 506
ADMIN_DROP_SCHEMA procedure 652 SNAPHADR 384, 508
admin_get_dbp_mem_usage SNAPLOCK 388, 512
table function 191 SNAPLOCKWAIT 393, 517
ADMIN_GET_MSGS table function 193 SNAPSTMT 398, 522
ADMIN_GET_TAB_COMPRESS_INFO table function 194 SNAPSTORAGE_PATHS 403, 527
ADMIN_GET_TAB_INFO table function 704 SNAPSUBSECTION 406, 530
ADMIN_GET_TAB_INFO_V95 table function 199 SNAPSWITCHES 409, 533
ADMIN_REMOVE_MSGS procedure 199 SNAPTAB 412, 536
administrative routine SNAPTAB_REORG 415, 539
AUTOMAINT_SET_POLICY procedure 211 SNAPTBSP 419, 543
administrative routines SNAPTBSP_QUIESCER 429, 553
AUTH_LIST_ROLES_FOR_AUTHID 290 SNAPTBSP_RANGE 432, 556
administrative SQL routines SNAPTBSPPART 424, 548
supported 7 SNAPUTIL 435, 559
© Copyright IBM Corp. 2006, 2008 821
administrative views (continued) commands (continued)
SNAPUTIL_PROGRESS 439, 563 IMPORT 72
supported 7 INITIALIZE TAPE 97
TBSP_UTILIZATION 566 LOAD 98
TOP_DYNAMIC_SQL 570 PRUNE HISTORY/LOGFILE 134
versus table functions 5 QUIESCE DATABASE 136
ADMINTABCOMPRESSINFO 194 QUIESCE TABLESPACES FOR TABLE 138
ADMINTABINFO administrative view 199 REDISTRIBUTE DATABASE PARTITION GROUP 140
ALTOBJ procedure 654 REORG INDEXES/TABLE 148
AM_BASE_RPT_RECOMS table function 19 RESET ALERT CONFIGURATION 157
AM_BASE_RPTS table function 20 RESET DATABASE CONFIGURATION 158
AM_DROP_TASK procedure 21 RESET DATABASE MANAGER CONFIGURATION 160
AM_GET_LOCK_CHN_TB procedure 22 REWIND TAPE 161
AM_GET_LOCK_CHNS procedure 23 RUNSTATS 162
AM_GET_LOCK_RPT procedure 24 SET TAPE POSITION 173
AM_GET_RPT procedure 31 UNQUIESCE DATABASE 174
AM_SAVE_TASK procedure 32 UPDATE ALERT CONFIGURATION 175
ANALYZE_LOG_SPACE procedure 575 UPDATE CONTACT 180
APPL_PERFORMANCE administrative view 295 UPDATE CONTACTGROUP 181
APPLICATION_ID scalar function 656 UPDATE DATABASE CONFIGURATION 183
APPLICATIONS administrative view 296 UPDATE DATABASE MANAGER CONFIGURATION 185
AUDIT_ARCHIVE 206 UPDATE HEALTH NOTIFICATION CONTACT LIST 187
AUDIT_DELIM_EXTRACT 207 UPDATE HISTORY 188
AUDIT_LIST_LOGS 208 UPDATE STMM TUNING DBPARTITIONNUM 190
AUTH_LIST_AUTHORITIES_FOR_AUTHID table COMPILATION_ENV table function 657
function 286 contact lists
AUTH_LIST_GROUPS_FOR_AUTHID table function 289 retrieving contact groups lists 659
AUTH_LIST_ROLES_FOR_AUTHID 290 retrieving contacts 660
AUTHORIZATIONIDS administrative view 292 CONTACTGROUPS administrative view 659
authorizations contacts
for administrative views 3 retrieving contact groups 659
retrieving authorization IDs 292 retrieving contact lists 660
retrieving group membership 289 CONTACTS administrative view 660
AUTOCONFIGURE command CONTAINER_UTILIZATION administrative view 305
using ADMIN_CMD 38 copying
AUTOMAINT_GET_POLICY stored procedure 209 schemas and objects 648
AUTOMAINT_GET_POLICYFILE stored procedure 210 CREATE_STORAGEMGMT_TABLES procedure 585
AUTOMAINT_SET_POLICY stored procedure 211
AUTOMAINT_SET_POLICYFILE stored procedure 212
D
database configuration parameters
B retrieving 214
BACKUP DATABASE command database manager configuration parameters
using ADMIN_CMD 41 retrieving values 216
books database paths
printed retrieving 665
ordering 810 DB_HISTORY administrative view
BP_HITRATIO administrative view 300 description 661
BP_READ_IO administrative view 302 DB_PARTITIONS table function 213
BP_WRITE_IO administrative view 304 DB2 Information Center
languages 811
updating 812
C versions 811
viewing in different languages 811
CAPTURE_STORAGEMGMT_INFO procedure 584
DBCFG administrative view 214
commands
DBMCFG administrative view 216
ADD CONTACT 35
DBPATHS administrative view 665
ADD CONTACTGROUP 36
deprecated functionality
AUTOCONFIGURE 38
procedures
BACKUP DATABASE 41
GET_DB_CONFIG 713
calling from a procedure 33, 587
SNAPSHOT_FILEW 786
DESCRIBE 49
SYSINSTALLROUTINES 804
DROP CONTACT 58
SQL administrative routines 701
DROP CONTACTGROUP 58
table functions
EXPORT 59
GET_DBM_CONFIG 714
FORCE APPLICATION 70
SNAP_GET_APP 715
GET STMM TUNING DBPARTITIONNUM 71
SNAP_GET_BP 728
822 Administrative Routines and Views
deprecated functionality (continued)
table functions (continued)
F
SNAP_GET_CONTAINER 731 FORCE APPLICATION command
SNAP_GET_DB 732 using ADMIN_CMD 70
SNAP_GET_DB_V91 742 functions
SNAP_GET_DBM 739 AUDIT_LIST_LOGS 208
SNAP_GET_DYN_SQL 755 scalar
SNAP_GET_STO_PATHS 757 APPLICATION_ID 656
SNAP_GET_TAB 758 GET_ROUTINE_OPTS 571
SNAP_GET_TBSP 759 MQPUBLISH 267
SNAP_GET_TBSP_PART 762 MQREAD 269
SNAPSHOT_AGENT 764 MQREADCLOB 274
SNAPSHOT_APPL 765 MQRECEIVE 275
SNAPSHOT_APPL_INFO 770 MQRECEIVECLOB 281
SNAPSHOT_BP 772 MQSEND 282
SNAPSHOT_CONTAINER 774 MQSUBSCRIBE 283
SNAPSHOT_DATABASE 775 MQUNSUBSCRIBE 285
SNAPSHOT_DBM 781 SQLERRM 695
SNAPSHOT_DYN_SQL 783 scaler functions
SNAPSHOT_FCM 784 EXPLAIN_FORMAT_STATS 668
SNAPSHOT_FCMNODE 785 stored procedures
SNAPSHOT_LOCK 787 SYSTS_ALTER 588
SNAPSHOT_LOCKWAIT 788 SYSTS_CLEAR_COMMANDLOCKS 591
SNAPSHOT_QUIESCERS 789 SYSTS_CLEAR_EVENTS 593
SNAPSHOT_RANGES 790 SYSTS_DROP 604
SNAPSHOT_STATEMENT 791 SYSTS_ENABLE 606
SNAPSHOT_SUBSECT 793 SYSTS_UPDATE 607
SNAPSHOT_SWITCHES 795 supported 7
SNAPSHOT_TABLE 796 table functions 1
SNAPSHOT_TBREORG 797 ADMIN_GET_MSGS 193
SNAPSHOT_TBS 799 ADMIN_GET_TAB_COMPRESS_INFO 194
SNAPSHOT_TBS_CFG 801 ADMIN_GET_TAB_INFO 704
SQLCACHE_SNAPSHOT 803 ADMIN_GET_TAB_INFO_V95 199
DESCRIBE command AM_BASE_RPT_RECOMS 19
description AM_BASE_RPTS 20
with ADMIN_CMD procedure 49 AUDIT_ARCHIVE 206
documentation AUTH_LIST_AUTHORITIES_FOR_AUTHID 286
overview 807 AUTH_LIST_GROUPS_FOR_AUTHID 289
PDF 807 COMPILATION_ENV 657
printed 807 DB_PARTITIONS 213
terms and conditions of use 814 deprecated 701
DROP CONTACT command EXPLAIN_GET_MSGS 673
using ADMIN_CMD 58 GET_DB_CONFIG 713
DROP CONTACTGROUP command GET_DBM_CONFIG 714
using ADMIN_CMD 58 HEALTH_CONT_HI 228
DROP_STORAGEMGMT_TABLES procedure 586 HEALTH_CONT_HI_HIS 230
dropping HEALTH_CONT_INFO 232
schemas and their objects 652 HEALTH_DB_HI 233
HEALTH_DB_HI_HIS 237
HEALTH_DB_HIC 240
HEALTH_DB_HIC_HIS 242
E HEALTH_DB_INFO 244
ENV_FEATURE_INFO administrative view HEALTH_DBM_HI 246
description 223 HEALTH_DBM_HI_HIS 247
ENV_INST_INFO administrative view 220 HEALTH_DBM_INFO 249
ENV_PROD_INFO administrative view 221 HEALTH_GET_ALERT_ACTION_CFG 250
ENV_SYS_INFO administrative view 224 HEALTH_GET_ALERT_CFG 253
ENV_SYS_RESOURCES administrative view 225 HEALTH_GET_IND_DEFINITION 256
error messages HEALTH_TBS_HI 260
retrieving HEALTH_TBS_HI_HIS 262
SQLERRM scalar functions 695 HEALTH_TBS_INFO 266
EXPLAIN_FORMAT_STATS scalar function 668 MQREADALL 270
EXPLAIN_GET_MSGS table function 673 MQREADALLCLOB 272
EXPORT command MQRECEIVEALL 276
description MQRECEIVEALLCLOB 279
with ADMIN_CMD procedure 59 PD_GET_DIAG_HIST 678
PD_GET_LOG_MSGS 685
SNAP_GET_AGENT 318, 442
Index 823
functions (continued) functions (continued)
table functions (continued) table functions (continued)
SNAP_GET_AGENT_MEMORY_POOL 321, 445 versus administrative views 5
SNAP_GET_APPL 715 WLM_GET_ACTIVITY_DETAILS 613
SNAP_GET_APPL_INFO 721 WLM_GET_QUEUE_STATS 619
SNAP_GET_APPL_INFO_V95 324, 449 WLM_GET_SERVICE_CLASS_
SNAP_GET_APPL_V95 332, 456 WORKLOAD_OCCURRENCESWLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES 627
SNAP_GET_BP 728 WLM_GET_SERVICE_CLASS_AGENTS 623
SNAP_GET_BP_PART 344, 468 WLM_GET_SERVICE_SUBCLASS_STATS 631
SNAP_GET_BP_V95 340, 464 WLM_GET_SERVICE_SUPERCLASS_STATS 636
SNAP_GET_CONTAINER (deprecated) 731 WLM_GET_WORK_ACTION_SET_STATS 638
SNAP_GET_CONTAINER_V91 347, 471 WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIESWLM_GET_WORKLOAD_
SNAP_GET_DB (deprecated) 732 OCCURRENCE_ACTIVITIES 640
SNAP_GET_DB_MEMORY_POOL 362, 486 WLM_GET_WORKLOAD_STATS 644
SNAP_GET_DB_V91 742
SNAP_GET_DB_V95 351, 475
SNAP_GET_DBM 739
SNAP_GET_DBM_MEMORY_POOL 370, 494
G
GENERATE_DISTFILE procedure 577
SNAP_GET_DBM_V95 366, 490
GET STMM TUNING DBPARTITIONNUM command
SNAP_GET_DETAIL_LOG_V91 372, 496
using ADMIN_CMD 71
SNAP_GET_DYN_SQL (deprecated) 755
GET_DB_CONFIG table function 713
SNAP_GET_DYN_SQL_V91 752
GET_DBM_CONFIG table function 714
SNAP_GET_DYN_SQL_V95 375, 499
GET_DBSIZE_INFO procedure 675
SNAP_GET_FCM 380, 504
GET_ROUTINE_OPTS scalar function 571
SNAP_GET_FCM_PART 382, 506
GET_ROUTINE_SAR procedure 571
SNAP_GET_HADR 384, 508
GET_SWRD_SETTINGS procedure 578
SNAP_GET_LOCK 388, 512
groups
SNAP_GET_LOCKWAIT 393, 517
retrieving group membership 289
SNAP_GET_STMT 398, 522
SNAP_GET_STO_PATHS (deprecated) 757
SNAP_GET_STORAGE_PATHS 403, 527
SNAP_GET_SUBSECTION 406, 530 H
SNAP_GET_SWITCHES 409, 533 health alerts
SNAP_GET_TAB (deprecated) 758 alert action configuration 250
SNAP_GET_TAB_REORG 415, 539 alert configuration 253
SNAP_GET_TAB_V91 412, 536 health indicators
SNAP_GET_TBSP (deprecated) 759 retrieve health indicator definition 256
SNAP_GET_TBSP_PART (deprecated) 762 HEALTH_CONT_HI table function 228
SNAP_GET_TBSP_PART_V91 424, 548 HEALTH_CONT_HI_HIS table function 230
SNAP_GET_TBSP_QUIESCER 429, 553 HEALTH_CONT_INFO table function 232
SNAP_GET_TBSP_RANGE 432, 556 HEALTH_DB_HI table function 233
SNAP_GET_TBSP_V91 419, 543 HEALTH_DB_HI_HIS table function 237
SNAP_GET_UTIL 435, 559 HEALTH_DB_HIC table function 240
SNAP_GET_UTIL_PROGRESS 439, 563 HEALTH_DB_HIC_HIS table function 242
SNAPSHOT_AGENT (deprecated) 764 HEALTH_DB_INFO table function 244
SNAPSHOT_APPL (deprecated) 765 HEALTH_DBM_HI table function 246
SNAPSHOT_APPL_INFO (deprecated) 770 HEALTH_DBM_HI_HIS table function 247
SNAPSHOT_BP (deprecated) 772 HEALTH_DBM_INFO table function 249
SNAPSHOT_CONTAINER (deprecated) 774 HEALTH_GET_ALERT_ACTION_CFG table function 250
SNAPSHOT_DATABASE (deprecated) 775 HEALTH_GET_ALERT_CFG table function 253
SNAPSHOT_DBM (deprecated) 781 HEALTH_GET_IND_DEFINITION table function 256
SNAPSHOT_DYN_SQL (deprecated) 783 HEALTH_HI_REC procedure 258
SNAPSHOT_FCM (deprecated) 784 HEALTH_TBS_HI table function 260
SNAPSHOT_FCMNODE (deprecated) 785 HEALTH_TBS_HI_HIS table function 262
SNAPSHOT_LOCK (deprecated) 787 HEALTH_TBS_INFO table function 266
SNAPSHOT_LOCKWAIT (deprecated) 788 help
SNAPSHOT_QUIESCERS (deprecated) 789 configuring language 811
SNAPSHOT_RANGES (deprecated) 790 SQL statements 810
SNAPSHOT_STATEMENT (deprecated) 791 history file
SNAPSHOT_SUBSECT (deprecated) 793 retrieving information 661
SNAPSHOT_SWITCHES (deprecated) 795
SNAPSHOT_TABLE (deprecated) 796
SNAPSHOT_TBREORG (deprecated) 797
SNAPSHOT_TBS (deprecated) 799
I
IMPORT command
SNAPSHOT_TBS_CFG (deprecated) 801
using ADMIN_CMD 72
SQLCACHE_SNAPSHOT (deprecated) 803
INITIALIZE TAPE command
supported 7
using ADMIN_CMD 97
824 Administrative Routines and Views
installing procedures (continued)
retrieving DB2 product information 221 ADMIN_COPY_SCHEMA 648
returning DB2 product license information 223, 225 ADMIN_DROP_SCHEMA 652
instances ADMIN_REMOVE_MSGS 199
retrieving current instance information 220 ALTOBJ 654
AM_DROP_TASK 21
AM_GET_LOCK_CHN_TB 22
L AM_GET_LOCK_CHNS 23
AM_GET_LOCK_RPT 24
LOAD command
AM_GET_RPT 31
using ADMIN_CMD 98
AM_SAVE_TASK 32
LOCKS_HELD administrative view 307
ANALYZE_LOG_SPACE 575
LOCKWAIT administrative view 310
AUDIT_ARCHIVE 206
LOG_UTILIZATION administrative view 314
AUDIT_DELIM_EXTRACT 207
LONG_RUNNING_SQL administrative view 315
AUTOMAINT_GET_POLICY 209
AUTOMAINT_GET_POLICYFILE 210
AUTOMAINT_SET_POLICYFILE 212
M CAPTURE_STORAGEMGMT_INFO 584
MQPUBLISH scalar function 267 CREATE_STORAGEMGMT_TABLES 585
MQREAD scalar function 269 deprecated functionality 701
MQREADALL table function 270 DROP_STORAGEMGMT_TABLES 586
MQREADALLCLOB table function 272 GENERATE_DISTFILE 577
MQREADCLOB scalar function 274 GET_DBSIZE_INFO 675
MQRECEIVE scalar function 275 GET_ROUTINE_SAR 571
MQRECEIVEALL table function 276 GET_SWRD_SETTINGS 578
MQRECEIVEALLCLOB table function 279 HEALTH_HI_REC 258
MQRECEIVECLOB scalar function 281 PUT_ROUTINE_SAR 572
MQSEND scalar function 282 REBIND_ROUTINE_PACKAGE 573
MQSUBSCRIBE scalar function 283 REORGCHK_IX_STATS 692
MQUNSUBSCRIBE scalar function 285 REORGCHK_TB_STATS 694
SET_ROUTINE_OPTS 574
SET_SWRD_SETTINGS 580
N SNAP_WRITE_FILE 441, 565
SNAPSHOT_FILEW 786
notices 817
STEPWISE_REDISTRIBUTE_DBPG 582
notification lists
summary 7
retrieving contact list 677
SYSINSTALLOBJECTS 698
notification log messages
SYSINSTALLROUTINES 804
retrieving 685
SYSTS_ADMIN_CMD 587
NOTIFICATIONLIST administrative view 677
WLM_CANCEL_ACTIVITY 609
WLM_CAPTURE_ACTIVITY_IN_PROGRESS 610
WLM_COLLECT_STATS 612
O WLM_SET_CLIENT_INFO 646
OBJECTOWNERS administrative view 293 PRUNE HISTORY/LOGFILE command
objects with ADMIN_CMD procedure 134
retrieving object ownership 293 PUT_ROUTINE_SAR procedure 572
ordering DB2 books 810
Q
P QUERY_PREP_COST administrative view 317
PD_GET_DIAG_HIST table function QUIESCE DATABASE command
description 678 using ADMIN_CMD 136
PD_GET_LOG_MSGS table function QUIESCE TABLESPACES FOR TABLE command
description 685 using ADMIN_CMD 138
PDLOGMSGS_LAST24HOURS administrative view
description 685
privileges
information about granted
R
REBIND_ROUTINE_PACKAGE procedure 573
PRIVILEGES administrative view 294
REDISTRIBUTE DATABASE PARTITION GROUP command
PRIVILEGES administrative view 294
using ADMIN_CMD 140
problem determination
redistributing data
information available 814
procedures 575, 577, 578, 580, 582
notification log messages 685
REG_VARIABLES administrative view 219
tutorials 814
registry variables
procedures
retrieving settings in use 219
ADMIN_CMD
description 33
Index 825
REORG INDEXES/TABLE command SNAP_GET_UTIL table function 435, 559
using ADMIN_CMD 148 SNAP_GET_UTIL_PROGRESS table function 439, 563
REORGCHK_IX_STATS procedure 692 SNAP_WRITE_FILE procedure 441, 565
REORGCHK_TB_STATS procedure 694 SNAPAGENT administrative view 318, 442
RESET ALERT CONFIGURATION command SNAPAGENT_MEMORY_POOL administrative view 321, 445
using ADMIN_CMD 157 SNAPAPPL administrative view 332, 456
RESET DATABASE CONFIGURATION command SNAPAPPL_INFO administrative view 324, 449
using ADMIN_CMD 158 SNAPBP administrative view 340, 464
RESET DATABASE MANAGER CONFIGURATION command SNAPBP_PART administrative view 344, 468
using ADMIN_CMD 160 SNAPCONTAINER administrative view 347, 471
REWIND TAPE command SNAPDB administrative view 351, 475
using ADMIN_CMD 161 SNAPDB_MEMORY_POOL administrative view 362, 486
routines SNAPDBM administrative view 366, 490
SQL administrative 701 SNAPDBM_MEMORY_POOL administrative view 370, 494
supported 7 SNAPDETAILLOG administrative view 372, 496
RUNSTATS command SNAPDYN_SQL administrative view 375, 499
using ADMIN_CMD 162 SNAPFCM administrative view 380, 504
SNAPFCM_PART administrative view 382, 506
SNAPHADR administrative view 384, 508
S SNAPLOCK administrative view 388, 512
SNAPLOCKWAIT administrative view 393, 517
scalar functions
SNAPSHOT_AGENT deprecated table function 764
SQLERRM 695
SNAPSHOT_APPL deprecated table function 765
schemas
SNAPSHOT_APPL_INFO deprecated table function 770
copying schemas and objects 648
SNAPSHOT_BP deprecated table function 772
dropping objects 652
SNAPSHOT_CONTAINER deprecated table function 774
SET TAPE POSITION command
SNAPSHOT_DATABASE deprecated table function 775
using ADMIN_CMD 173
SNAPSHOT_DBM deprecated table function 781
SET_ROUTINE_OPTS procedure 574
SNAPSHOT_DYN_SQL deprecated table function 783
SET_SWRD_SETTINGS procedure 580
SNAPSHOT_FCM deprecated table function 784
SNAP_GET_AGENT table function 318, 442
SNAPSHOT_FCMNODE deprecated table function 785
SNAP_GET_AGENT_MEMORY_POOL table function 321,
SNAPSHOT_FILEW deprecated procedure 786
445
SNAPSHOT_LOCK deprecated table function 787
SNAP_GET_APPL_INFO table function 721
SNAPSHOT_LOCKWAIT deprecated table function 788
SNAP_GET_APPL_INFO_V95 table function 324, 449
SNAPSHOT_QUIESCERS deprecated table function 789
SNAP_GET_APPL_V95 table function 332, 456
SNAPSHOT_RANGES deprecated table function 790
SNAP_GET_BP_PART table function 344, 468
SNAPSHOT_STATEMENT deprecated table function 791
SNAP_GET_BP_V95 table function 340, 464
SNAPSHOT_SUBSECT deprecated table function 793
SNAP_GET_CONTAINER deprecated table function 731
SNAPSHOT_SWITCHES deprecated table function 795
SNAP_GET_CONTAINER_V91 table function 347, 471
SNAPSHOT_TABLE deprecated table function 796
SNAP_GET_DB deprecated table function 732
SNAPSHOT_TBREORG deprecated table function 797
SNAP_GET_DB_MEMORY_POOL table function 362, 486
SNAPSHOT_TBS deprecated table function 799
SNAP_GET_DB_V95 table function 351, 475
SNAPSHOT_TBS_CFG deprecated table function 801
SNAP_GET_DBM_MEMORY_POOL table function 370, 494
SNAPSTMT administrative view 398, 522
SNAP_GET_DBM_V95 table function 366, 490
SNAPSTORAGE_PATHS administrative view 403, 527
SNAP_GET_DETAIL_LOG_V91 table function 372, 496
SNAPSUBSECTION administrative view 406, 530
SNAP_GET_DYN_SQL deprecated table function 755
SNAPSWITCHES administrative view 409, 533
SNAP_GET_DYN_SQL_V91 table function 752
SNAPTAB administrative view 412, 536
SNAP_GET_DYN_SQL_V95 table function 375, 499
SNAPTAB_REORG administrative view 415, 539
SNAP_GET_FCM table function 380, 504
SNAPTBSP administrative view 419, 543
SNAP_GET_FCM_PART table function 382, 506
SNAPTBSP_QUIESCER administrative view 429, 553
SNAP_GET_HADR table function 384, 508
SNAPTBSP_RANGE administrative view 432, 556
SNAP_GET_LOCK table function 388, 512
SNAPTBSPPART administrative view 424, 548
SNAP_GET_LOCKWAIT table function 393, 517
SNAPUTIL administrative view 435, 559
SNAP_GET_STMT table function 398, 522
SNAPUTIL_PROGRESS administrative view 439, 563
SNAP_GET_STO_PATHS deprecated table function 757
split mirror
SNAP_GET_STORAGE_PATHS table function 403, 527
retrieving database paths 665
SNAP_GET_SUBSECTION table function 406, 530
SQL administrative routines 595
SNAP_GET_SWITCHES table function 409, 533
deprecated routines 701
SNAP_GET_TAB deprecated table function 758
SQL statements
SNAP_GET_TAB_REORG table function 415, 539
displaying help 810
SNAP_GET_TAB_V91 table function 412, 536
SQLCACHE_SNAPSHOT deprecated table function 803
SNAP_GET_TBSP deprecated table function 759
SQLERRM scalar function 695
SNAP_GET_TBSP_PART deprecated table function 762
STEPWISE_REDISTRIBUTE_DBPG procedure 582
SNAP_GET_TBSP_PART_V91 table function 424, 548
storage management tool
SNAP_GET_TBSP_QUIESCER table function 429, 553
stored procedures 584, 585, 586
SNAP_GET_TBSP_RANGE table function 432, 556
SNAP_GET_TBSP_V91 table function 419, 543
826 Administrative Routines and Views
stored procedures table functions (continued)
AUDIT_ARCHIVE 206 SNAP_GET_TBSP_V91 419, 543
AUDIT_DELIM_EXTRACT 207 SNAP_GET_UTIL 435, 559
supported functions 7 SNAP_GET_UTIL_PROGRESS 439, 563
SYSINSTALLOBJECTS procedure 698 supported 7
SYSINSTALLROUTINES deprecated procedure 804 versus administrative views 5
system information WLM_GET_QUEUE_STATS 619
retrieving 224 tables
SYSTS_ADMIN_CMD procedure 587 retrieving size and state 199, 704
SYSTS_ALTER stored procedure 588 TBSP_UTILIZATION administrative view 566
SYSTS_CLEAR_COMMANDLOCKS stored procedure 591 terms and conditions
SYSTS_CLEAR_EVENTS stored procedure 593 use of publications 814
SYSTS_CREATE 595 TOP_DYNAMIC_SQL administrative view 570
SYSTS_CREATE procedure 595 troubleshooting
SYSTS_DISABLE 601 online information 814
SYSTS_DISABLE procedure 601 tutorials 814
SYSTS_DROP stored procedure 604 tutorials
SYSTS_ENABLE stored procedure 606 problem determination 814
SYSTS_UPDATE stored procedure 607 troubleshooting 814
Visual Explain 813
T
table functions U
admin_get_dbp_mem_usage 191 UNQUIESCE DATABASE command
ADMIN_GET_MSGS 193 using ADMIN_CMD 174
ADMIN_GET_TAB_INFO_V95 199 UPDATE ALERT CONFIGURATION command
AUDIT_ARCHIVE 206 using ADMIN_CMD 175
AUTH_LIST_GROUPS_FOR_AUTHID 289 UPDATE CONTACT command
deprecated functionality 701 using ADMIN_CMD 180
ADMIN_GET_TAB_INFO 704 UPDATE CONTACTGROUP command
SNAP_GET_APPL_INFO 721 using ADMIN_CMD 181
SNAP_GET_BP 728 UPDATE DATABASE CONFIGURATION command
SNAP_GET_DB_V91 742 using ADMIN_CMD 183
SNAP_GET_DBM 739 UPDATE DATABASE MANAGER CONFIGURATION
SNAP_GET_DYN_SQL_V91 752 command
HEALTH_GET_ALERT_ACTION_CFG 250 using ADMIN_CMD 185
HEALTH_GET_ALERT_CFG 253 UPDATE HEALTH NOTIFICATION CONTACT LIST
HEALTH_GET_IND_DEFINITION 256 command
PD_GET_DIAG_HIST 678 using ADMIN_CMD 187
PD_GET_LOG_MSGS 685 UPDATE HISTORY command
SNAP_GET_AGENT 318, 442 using ADMIN_CMD 188
SNAP_GET_AGENT_MEMORY_POOL 321, 445 UPDATE STMM TUNING DBPARTITIONNUM Command
SNAP_GET_APPL_INFO_V95 324, 449 using ADMIN_CMD 190
SNAP_GET_APPL_V95 332, 456 updates
SNAP_GET_BP_PART 344, 468 DB2 Information Center 812
SNAP_GET_BP_V95 340, 464
SNAP_GET_CONTAINER_V91 347, 471
SNAP_GET_DB_MEMORY_POOL 362, 486
SNAP_GET_DB_V95 351, 475
V
views
SNAP_GET_DBM_MEMORY_POOL 370, 494
administrative views
SNAP_GET_DBM_V95 366, 490
ADMINTABCOMPRESSINFO 194
SNAP_GET_DETAIL_LOG_V91 372, 496
ADMINTABINFO 199
SNAP_GET_DYN_SQL_V95 375, 499
APPL_PERFORMANCE 295
SNAP_GET_FCM 380, 504
APPLICATIONS 296
SNAP_GET_FCM_PART 382, 506
AUTHORIZATIONIDS 292
SNAP_GET_HADR 384, 508
BP_HITRATIO 300
SNAP_GET_LOCK 388, 512
BP_READ_IO 302
SNAP_GET_LOCKWAIT 393, 517
BP_WRITE_IO 304
SNAP_GET_STMT 398, 522
CONTACTGROUPS 659
SNAP_GET_STORAGE_PATHS 403, 527
CONTACTS 660
SNAP_GET_SUBSECTION 406, 530
CONTAINER_UTILIZATION 305
SNAP_GET_SWITCHES 409, 533
DB_HISTORY 661
SNAP_GET_TAB_REORG 415, 539
DBCFG 214
SNAP_GET_TAB_V91 412, 536
DBMCFG 216
SNAP_GET_TBSP_PART_V91 424, 548
DBPATHS 665
SNAP_GET_TBSP_QUIESCER 429, 553
ENV_FEATURE_INFO 223
SNAP_GET_TBSP_RANGE 432, 556
Index 827
views (continued) WLM_GET_SERVICE_SUBCLASS_STATS table function
administrative views (continued) description 631
ENV_INST_INFO 220 WLM_GET_SERVICE_SUPERCLASS_STATS table function
ENV_PROD_INFO 221 description 636
ENV_SYS_INFO 224 WLM_GET_WORK_ACTION_SET_STATS table function
ENV_SYS_RESOURCES 225 description 638
LOCKS_HELD 307 WLM_GET_WORKLOAD_OCCURRENCE_ACTIVITIES table
LOCKWAIT 310 function
LOG_UTILIZATION 314 description 640
LONG_RUNNING_SQL 315 WLM_GET_WORKLOAD_STATS table function
NOTIFICATIONLIST 677 description 644
OBJECTOWNERS 293 WLM_SET_CLIENT_INFO procedure 646
PDLOGMSGS_LAST24HOURS 685
PRIVILEGES 294
QUERY_PREP_COST 317
REG_VARIABLES 219
SNAPAGENT 318, 442
SNAPAGENT_MEMORY_POOL 321, 445
SNAPAPPL 332, 456
SNAPAPPL_INFO 324, 449
SNAPBP 340, 464
SNAPBP_PART 344, 468
SNAPCONTAINER 347, 471
SNAPDB 351, 475
SNAPDB_MEMORY_POOL 362, 486
SNAPDBM 366, 490
SNAPDBM_MEMORY_POOL 370, 494
SNAPDETAILLOG 372, 496
SNAPDYN_SQL 375, 499
SNAPFCM 380, 504
SNAPFCM_PART 382, 506
SNAPHADR 384, 508
SNAPLOCK 388, 512
SNAPLOCKWAIT 393, 517
SNAPSTMT 398, 522
SNAPSTORAGE_PATHS 403, 527
SNAPSUBSECTION 406, 530
SNAPSWITCHES 409, 533
SNAPTAB 412, 536
SNAPTAB_REORG 415, 539
SNAPTBSP 419, 543
SNAPTBSP_QUIESCER 429, 553
SNAPTBSP_RANGE 432, 556
SNAPTBSPPART 424, 548
SNAPUTIL 435, 559
SNAPUTIL_PROGRESS 439, 563
TBSP_UTILIZATION 566
TOP_DYNAMIC_SQL 570
Visual Explain
tutorial 813
W
WLM_CANCEL_ACTIVITY procedure 609
WLM_CAPTURE_ACTIVITY_IN_PROGRESS procedure 610
WLM_COLLECT_STATS procedure
description 612
WLM_GET_ACTIVITY_DETAILS table function
description 613
WLM_GET_QUEUE_STATS table function
description 619
WLM_GET_SERVICE_CLASS_AGENTS table function
description 623
WLM_GET_SERVICE_CLASS_WORKLOAD_OCCURRENCES
table function
description 627
828 Administrative Routines and Views
Printed in USA
SC23-5843-01
Spine information:
DB2 Version 9.5 for Linux, UNIX, and Windows Administrative Routines and Views
You might also like
- Sqlbase: Database Administrator'S GuideNo ratings yetSqlbase: Database Administrator'S Guide384 pages
- IBM DB2 10.5 For Linux, UNIX, and Windows - Administrative Routines and ViewsNo ratings yetIBM DB2 10.5 For Linux, UNIX, and Windows - Administrative Routines and Views1,607 pages
- DB2 Administration Guide ImplementationNo ratings yetDB2 Administration Guide Implementation487 pages
- Tivoli Monitoring for Databases DB2 AgentNo ratings yetTivoli Monitoring for Databases DB2 Agent232 pages
- IBM DB2 10.5 For Linux, UNIX, and Windows - Administrative API ReferenceNo ratings yetIBM DB2 10.5 For Linux, UNIX, and Windows - Administrative API Reference765 pages
- For Linux, Unix, and Windows: Command ReferenceNo ratings yetFor Linux, Unix, and Windows: Command Reference865 pages
- IBM DB2 Universal Database V8.1 System Administration: Student ManualNo ratings yetIBM DB2 Universal Database V8.1 System Administration: Student Manual546 pages
- DB2 9 DBA Certification Exam 731 Prep, Part 1:: Server ManagementNo ratings yetDB2 9 DBA Certification Exam 731 Prep, Part 1:: Server Management44 pages
- DB2 v11.1 - Database Security Guide - SecbookNo ratings yetDB2 v11.1 - Database Security Guide - Secbook400 pages
- Farmers Query Monitor: IBM Software GroupNo ratings yetFarmers Query Monitor: IBM Software Group36 pages
- DB2 For OS390 v.5 Data Sharing - Planning and AdministrationNo ratings yetDB2 For OS390 v.5 Data Sharing - Planning and Administration306 pages
- DB2 Universal Database For OS/390 and z/OSNo ratings yetDB2 Universal Database For OS/390 and z/OS572 pages
- Database Interface Designer: Websphere Transformation ExtenderNo ratings yetDatabase Interface Designer: Websphere Transformation Extender110 pages
- Troubleshooting Guide: IBM DB2 Universal DatabaseNo ratings yetTroubleshooting Guide: IBM DB2 Universal Database223 pages
- Monitoring Your DB2 LUW Database With Just SQLNo ratings yetMonitoring Your DB2 LUW Database With Just SQL56 pages
- Lab 01. Instance Exploration: A. DB2 Operating System Directories and FilesNo ratings yetLab 01. Instance Exploration: A. DB2 Operating System Directories and Files20 pages
- Tivoli Monitoring for Databases Microsoft SQL Server AgentNo ratings yetTivoli Monitoring for Databases Microsoft SQL Server Agent168 pages
- Installation Guide: DB2 Universal Database For OS/390No ratings yetInstallation Guide: DB2 Universal Database For OS/390576 pages
- 1.4 - Working With Databases and Database Objects - OdpNo ratings yet1.4 - Working With Databases and Database Objects - Odp57 pages
- Sybase® Adaptive Server™ Enterprise System Admin GuideNo ratings yetSybase® Adaptive Server™ Enterprise System Admin Guide954 pages
- Tivoli Monitoring for Databases Oracle AgentNo ratings yetTivoli Monitoring for Databases Oracle Agent232 pages
- 70-431 Exam Objectives: Skills Being MeasuredNo ratings yet70-431 Exam Objectives: Skills Being Measured6 pages
- Microsoft SC-300: Identity and Access Administrator - Certification Exam PrepFrom EverandMicrosoft SC-300: Identity and Access Administrator - Certification Exam PrepNo ratings yet
- Cybersecurity for Executives: A Guide to Protecting Your BusinessFrom EverandCybersecurity for Executives: A Guide to Protecting Your BusinessNo ratings yet
- Microsoft SC-300: Identity and Access Administrator - Study NotesFrom EverandMicrosoft SC-300: Identity and Access Administrator - Study NotesNo ratings yet
- ISA Automation Project Management (APM) Specialist Practice Exam PrepFrom EverandISA Automation Project Management (APM) Specialist Practice Exam PrepNo ratings yet
- DB2 9.5 For Linux, Unix, and Windows: Developing User-Defined Routines (SQL and External) Updated March, 2008No ratings yetDB2 9.5 For Linux, Unix, and Windows: Developing User-Defined Routines (SQL and External) Updated March, 2008393 pages
- Linux Journal - Drupal Special Edition 2012No ratings yetLinux Journal - Drupal Special Edition 2012167 pages
- Job Control Overview: Controlling ProcessesNo ratings yetJob Control Overview: Controlling Processes16 pages
- How To Set Up A Load-Balanced MySQL ClusterNo ratings yetHow To Set Up A Load-Balanced MySQL Cluster17 pages
- Aim: 1. Create:: Implement Data Definition Language Commands - Create, Alter, Drop, Truncate, and RenameNo ratings yetAim: 1. Create:: Implement Data Definition Language Commands - Create, Alter, Drop, Truncate, and Rename4 pages
- Applies To:: EBS Data Model Comparison Report Overview (VIDEO) (Doc ID 1290886.1)No ratings yetApplies To:: EBS Data Model Comparison Report Overview (VIDEO) (Doc ID 1290886.1)10 pages
- PIVOT and UNPIVOT - Optimization and Execution Strategies in An RDBMSNo ratings yetPIVOT and UNPIVOT - Optimization and Execution Strategies in An RDBMS12 pages
- Assignment Problems To Groups CSI SS ZG518 2019 UploadDocNo ratings yetAssignment Problems To Groups CSI SS ZG518 2019 UploadDoc27 pages
- Que# Question Text Correct Answer: EnglishNo ratings yetQue# Question Text Correct Answer: English6 pages
- BigData - Sem 4 - Elective 1 - Module 2 - PPTNo ratings yetBigData - Sem 4 - Elective 1 - Module 2 - PPT29 pages
- PL-300 Exam - Free Actual Q&As, Page 5 - ExamTopics5No ratings yetPL-300 Exam - Free Actual Q&As, Page 5 - ExamTopics55 pages
