DB2 Version 9.

1 for z/OS



Command Reference

SC18-9844-04
DB2 Version 9.1 for z/OS



Command Reference

SC18-9844-04
 Note
Before using this information and the product it supports, be sure to read the general information under “Notices” at the
end of this information.

Fifth edition (October 2009)

This edition applies to DB2 Version 9.1 for z/OS (DB2 V9.1 for z/OS), product number 5635-DB2, and to any
subsequent releases until otherwise indicated in new editions. Make sure you are using the correct edition for the
level of the product.
Specific changes are indicated by a vertical bar to the left of a change. A vertical bar to the left of a figure caption
indicates that the figure has changed. Editorial changes that have no technical significance are not noted.
© Copyright International Business Machines Corporation 1983, 2009.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
 Contents
About this information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Who should read this information . . . . . . . . . . . . . ix . . . . . . . . . . . . . . .
DB2 Utilities Suite . . . . . . . . . . . . . . . . . . ix . . . . . . . . . . . . . . .
Terminology and citations. . . . . . . . . . . . . . . . ix . . . . . . . . . . . . . . .
Accessibility features for DB2 Version 9.1 for z/OS . . . . . . . . . . . . . . . . . . . . . . x
How to send your comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
How to read syntax diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Part 1. Privileges, authorization IDs, and the bind process . . . . . . . . . . . 1

Chapter 1. Privileges and authorization IDs . . . . . . . . . . . . . . . . . . . . 3

Chapter 2. The bind process . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Part 2. Description of DB2 and related commands . . . . . . . . . . . . . . . 7

| Chapter 3. Types of commands. . . . . . . . . . . . . . . . . . . . . . . . . . 9

| The DSN command and its subcommands . . . . . . . . . . . . . . . . . . . . . . . . . 9
| DB2 commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
| IMS commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
| CICS attachment facility commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
| Administrative task scheduler commands . . . . . . . . . . . . . . . . . . . . . . . . . 12
| z/OS IRLM commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
| TSO CLISTs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Chapter 4. DB2 command parsing . . . . . . . . . . . . . . . . . . . . . . . . 15

Characters with special meanings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Examples of keyword entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 5. DSN subcommand parsing . . . . . . . . . . . . . . . . . . . . . . 19

Chapter 6. Scope of DB2 and related commands . . . . . . . . . . . . . . . . . 21

Chapter 7. Output from DB2 commands . . . . . . . . . . . . . . . . . . . . . 23

Chapter 8. Issuing commands to DB2 from IFI. . . . . . . . . . . . . . . . . . . 25

Chapter 9. Command Line Processor . . . . . . . . . . . . . . . . . . . . . . 27

Part 3. DB2 and related commands . . . . . . . . . . . . . . . . . . . . . . 45

Chapter 10. -ACCESS DATABASE (DB2) . . . . . . . . . . . . . . . . . . . . . 47

Chapter 11. -ALTER BUFFERPOOL (DB2) . . . . . . . . . . . . . . . . . . . . . 51

Chapter 12. -ALTER GROUPBUFFERPOOL (DB2) . . . . . . . . . . . . . . . . . 57

Chapter 13. -ALTER UTILITY (DB2) . . . . . . . . . . . . . . . . . . . . . . . . 61

Chapter 14. -ARCHIVE LOG (DB2) . . . . . . . . . . . . . . . . . . . . . . . . 65

© Copyright IBM Corp. 1983, 2009 iii

Chapter 15. BIND PACKAGE (DSN). . . . . . . . . . . . . . . . . . . . . . . . 71

Chapter 16. BIND PLAN (DSN). . . . . . . . . . . . . . . . . . . . . . . . . . 79

Chapter 17. BIND and REBIND options . . . . . . . . . . . . . . . . . . . . . . 85

Chapter 18. -CANCEL THREAD (DB2) . . . . . . . . . . . . . . . . . . . . . . 129

Chapter 19. /CHANGE (IMS) . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Chapter 20. DCLGEN (DECLARATIONS GENERATOR) (DSN) . . . . . . . . . . . . 137

Chapter 21. /DISPLAY (IMS) . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Chapter 22. -DISPLAY ARCHIVE (DB2). . . . . . . . . . . . . . . . . . . . . . 151

Chapter 23. -DISPLAY BUFFERPOOL (DB2) . . . . . . . . . . . . . . . . . . . 153

Chapter 24. -DISPLAY DATABASE (DB2) . . . . . . . . . . . . . . . . . . . . . 161

Chapter 25. -DISPLAY DDF (DB2) . . . . . . . . . . . . . . . . . . . . . . . . 181

Chapter 26. -DISPLAY FUNCTION SPECIFIC (DB2) . . . . . . . . . . . . . . . . 185

Chapter 27. -DISPLAY GROUP (DB2) . . . . . . . . . . . . . . . . . . . . . . 189

Chapter 28. -DISPLAY GROUPBUFFERPOOL (DB2) . . . . . . . . . . . . . . . . 195

Chapter 29. -DISPLAY LOCATION (DB2) . . . . . . . . . . . . . . . . . . . . . 209

Chapter 30. -DISPLAY LOG (DB2) . . . . . . . . . . . . . . . . . . . . . . . . 213

Chapter 31. -DISPLAY PROCEDURE (DB2) . . . . . . . . . . . . . . . . . . . . 215

Chapter 32. -DISPLAY PROFILE (DB2) . . . . . . . . . . . . . . . . . . . . . . 221

Chapter 33. -DISPLAY RLIMIT (DB2) . . . . . . . . . . . . . . . . . . . . . . . 223

Chapter 34. -DISPLAY THREAD (DB2) . . . . . . . . . . . . . . . . . . . . . . 225

Chapter 35. -DISPLAY TRACE (DB2). . . . . . . . . . . . . . . . . . . . . . . 241

Chapter 36. -DISPLAY UTILITY (DB2) . . . . . . . . . . . . . . . . . . . . . . 251

Chapter 37. DSN (TSO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

Chapter 38. DSNC (CICS attachment facility) . . . . . . . . . . . . . . . . . . . 261

Chapter 39. DSNC DISCONNECT (CICS attachment facility) . . . . . . . . . . . . 263

Chapter 40. DSNC DISPLAY (CICS attachment facility) . . . . . . . . . . . . . . . 265

Chapter 41. DSNC MODIFY (CICS attachment facility) . . . . . . . . . . . . . . . 269

iv Command Reference
Chapter 42. DSNC STOP (CICS attachment facility) . . . . . . . . . . . . . . . . 271

Chapter 43. DSNC STRT (CICS attachment facility) . . . . . . . . . . . . . . . . 273

Chapter 44. DSNH (TSO CLIST). . . . . . . . . . . . . . . . . . . . . . . . . 275

Chapter 45. END (DSN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

Chapter 46. FREE PACKAGE (DSN) . . . . . . . . . . . . . . . . . . . . . . . 305

Chapter 47. FREE PLAN (DSN) . . . . . . . . . . . . . . . . . . . . . . . . . 309

Chapter 48. MODIFY admtproc,APPL=SHUTDOWN . . . . . . . . . . . . . . . . 311

Chapter 49. MODIFY admtproc,APPL=TRACE . . . . . . . . . . . . . . . . . . 313

Chapter 50. MODIFY irlmproc,ABEND (z/OS IRLM) . . . . . . . . . . . . . . . . 315

Chapter 51. MODIFY irlmproc,DIAG (z/OS IRLM) . . . . . . . . . . . . . . . . . 317

Chapter 52. MODIFY irlmproc,PURGE (z/OS IRLM) . . . . . . . . . . . . . . . . 319

Chapter 53. MODIFY irlmproc,SET (z/OS IRLM) . . . . . . . . . . . . . . . . . . 321

Chapter 54. MODIFY irlmproc,STATUS (z/OS IRLM) . . . . . . . . . . . . . . . . 325

Chapter 55. -MODIFY TRACE (DB2) . . . . . . . . . . . . . . . . . . . . . . . 333

Chapter 56. REBIND PACKAGE (DSN) . . . . . . . . . . . . . . . . . . . . . . 337

Chapter 57. REBIND PLAN (DSN) . . . . . . . . . . . . . . . . . . . . . . . . 341

Chapter 58. REBIND TRIGGER PACKAGE (DSN) . . . . . . . . . . . . . . . . . 345

Chapter 59. -RECOVER BSDS (DB2) . . . . . . . . . . . . . . . . . . . . . . 349

Chapter 60. -RECOVER INDOUBT (DB2) . . . . . . . . . . . . . . . . . . . . . 351

Chapter 61. -RECOVER POSTPONED (DB2) . . . . . . . . . . . . . . . . . . . 355

Chapter 62. -REFRESH DB2,EARLY (DB2) . . . . . . . . . . . . . . . . . . . . 359

Chapter 63. -RESET GENERICLU (DB2) . . . . . . . . . . . . . . . . . . . . . 361

Chapter 64. -RESET INDOUBT (DB2) . . . . . . . . . . . . . . . . . . . . . . 363

Chapter 65. RUN (DSN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

Chapter 66. -SET ARCHIVE (DB2) . . . . . . . . . . . . . . . . . . . . . . . . 371

Chapter 67. -SET LOG (DB2) . . . . . . . . . . . . . . . . . . . . . . . . . . 375

Chapter 68. -SET SYSPARM (DB2) . . . . . . . . . . . . . . . . . . . . . . . 379

Contents v
Chapter 69. SPUFI (DSN) . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

Chapter 70. /SSR (IMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

Chapter 71. START admtproc . . . . . . . . . . . . . . . . . . . . . . . . . 385

Chapter 72. /START (IMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

Chapter 73. -START DATABASE (DB2) . . . . . . . . . . . . . . . . . . . . . . 389

Chapter 74. -START DB2 (DB2) . . . . . . . . . . . . . . . . . . . . . . . . . 399

Chapter 75. -START DDF (DB2) . . . . . . . . . . . . . . . . . . . . . . . . . 403

Chapter 76. -START FUNCTION SPECIFIC (DB2) . . . . . . . . . . . . . . . . . 405

Chapter 77. START irlmproc (z/OS IRLM) . . . . . . . . . . . . . . . . . . . . 409

Chapter 78. -START PROCEDURE (DB2) . . . . . . . . . . . . . . . . . . . . . 415

Chapter 79. -START PROFILE (DB2) . . . . . . . . . . . . . . . . . . . . . . . 419

Chapter 80. -START RLIMIT (DB2). . . . . . . . . . . . . . . . . . . . . . . . 421

Chapter 81. -START TRACE (DB2) . . . . . . . . . . . . . . . . . . . . . . . 423

Chapter 82. STOP admtproc (z/OS ) . . . . . . . . . . . . . . . . . . . . . . . 439

Chapter 83. /STOP (IMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

Chapter 84. -STOP DATABASE (DB2) . . . . . . . . . . . . . . . . . . . . . . 443

Chapter 85. -STOP DB2 (DB2) . . . . . . . . . . . . . . . . . . . . . . . . . 451

Chapter 86. -STOP DDF (DB2) . . . . . . . . . . . . . . . . . . . . . . . . . 455

Chapter 87. -STOP FUNCTION SPECIFIC (DB2) . . . . . . . . . . . . . . . . . . 459

Chapter 88. STOP irlmproc (z/OS IRLM) . . . . . . . . . . . . . . . . . . . . . 463

Chapter 89. -STOP PROCEDURE (DB2) . . . . . . . . . . . . . . . . . . . . . 465

Chapter 90. STOP PROFILE (DB2) . . . . . . . . . . . . . . . . . . . . . . . 469

Chapter 91. -STOP RLIMIT (DB2) . . . . . . . . . . . . . . . . . . . . . . . . 471

Chapter 92. -STOP TRACE (DB2) . . . . . . . . . . . . . . . . . . . . . . . . 473

Chapter 93. -TERM UTILITY (DB2). . . . . . . . . . . . . . . . . . . . . . . . 483

Chapter 94. /TRACE (IMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . 487

Chapter 95. TRACE CT (z/OS IRLM) . . . . . . . . . . . . . . . . . . . . . . . 489

vi Command Reference
Part 4. Appendixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493

Appendix. Directory of subsystem parameters and DSNHDECP values . . . . . . . 495

Information resources for DB2 for z/OS and related products . . . . . . . . . . . 501

How to obtain DB2 information. . . . . . . . . . . . . . . . . . . . . . . . . 507

How to use the DB2 library . . . . . . . . . . . . . . . . . . . . . . . . . . 511

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
Programming Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
Product-sensitive Programming Interface and Associated Guidance Information . . . . . . . . . . . 517
Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563

Contents vii
viii Command Reference
About this information
This information describes numerous commands that system administrators,
database administrators, and application programmers use. The commands are in
alphabetical order for quick retrieval.

This information assumes that your DB2® subsystem is running in Version 9.1
new-function mode. Generally, new functions that are described, including changes
to existing functions, statements, and limits, are available only in new-function
mode. Two exceptions to this general statement are new and changed utilities and
optimization enhancements, which are also available in conversion mode unless
stated otherwise.

Who should read this information

This information presents reference information for people involved in system
administration, database administration, and operation. It presents detailed
information on commands, including syntax, option descriptions, and examples for
each command.

DB2 Utilities Suite

Important: In this version of DB2 for z/OS®, the DB2 Utilities Suite is available as
an optional product. You must separately order and purchase a license to such
utilities, and discussion of those utility functions in this publication is not intended
to otherwise imply that you have a license to them.

The DB2 Utilities Suite is designed to work with the DFSORT™ program, which
you are licensed to use in support of the DB2 utilities even if you do not otherwise
license DFSORT for general use. If your primary sort product is not DFSORT,
consider the following informational APARs mandatory reading:
v II14047/II14213: USE OF DFSORT BY DB2 UTILITIES
v II13495: HOW DFSORT TAKES ADVANTAGE OF 64-BIT REAL
ARCHITECTURE
These informational APARs are periodically updated.
Related information
DB2 utilities packaging (Utility Guide)

Terminology and citations

In this information, DB2 Version 9.1 for z/OS is referred to as ″DB2 for z/OS.″ In
cases where the context makes the meaning clear, DB2 for z/OS is referred to as
″DB2.″ When this information refers to titles of DB2 for z/OS books, a short title is
used. (For example, ″See DB2 SQL Reference″ is a citation to IBM® DB2 Version 9.1
for z/OS SQL Reference.)

When referring to a DB2 product other than DB2 for z/OS, this information uses
the product’s full name to avoid ambiguity.

The following terms are used as indicated:

© Copyright IBM Corp. 1983, 2009 ix

 DB2 Represents either the DB2 licensed program or a particular DB2 subsystem.
OMEGAMON®
Refers to any of the following products:
v IBM Tivoli® OMEGAMON XE for DB2 Performance Expert on z/OS
v IBM Tivoli OMEGAMON XE for DB2 Performance Monitor on z/OS
v IBM DB2 Performance Expert for Multiplatforms and Workgroups
v IBM DB2 Buffer Pool Analyzer for z/OS
C, C++, and C language
Represent the C or C++ programming language.
| CICS® Represents CICS Transaction Server for z/OS.
IMS™ Represents the IMS Database Manager or IMS Transaction Manager.
MVS™ Represents the MVS element of the z/OS operating system, which is
equivalent to the Base Control Program (BCP) component of the z/OS
operating system.
RACF®
Represents the functions that are provided by the RACF component of the
z/OS Security Server.

Accessibility features for DB2 Version 9.1 for z/OS

Accessibility features help a user who has a physical disability, such as restricted
mobility or limited vision, to use information technology products successfully.

Accessibility features

The following list includes the major accessibility features in z/OS products,
including DB2 Version 9.1 for z/OS. These features support:
v Keyboard-only operation.
v Interfaces that are commonly used by screen readers and screen magnifiers.
v Customization of display attributes such as color, contrast, and font size

Tip: The Information Management Software for z/OS Solutions Information

Center (which includes information for DB2 Version 9.1 for z/OS) and its related
publications are accessibility-enabled for the IBM Home Page Reader. You can
operate all features using the keyboard instead of the mouse.

Keyboard navigation

You can access DB2 Version 9.1 for z/OS ISPF panel functions by using a keyboard
or keyboard shortcut keys.

For information about navigating the DB2 Version 9.1 for z/OS ISPF panels using
TSO/E or ISPF, refer to the z/OS TSO/E Primer, the z/OS TSO/E User’s Guide, and
the z/OS ISPF User’s Guide. These guides describe how to navigate each interface,
including the use of keyboard shortcuts or function keys (PF keys). Each guide
includes the default settings for the PF keys and explains how to modify their
functions.

Related accessibility information

Online documentation for DB2 Version 9.1 for z/OS is available in the Information
Management Software for z/OS Solutions Information Center, which is available at

x Command Reference
 the following Web site: http://publib.boulder.ibm.com/infocenter/dzichelp

IBM and accessibility

See the IBM Accessibility Center at http://www.ibm.com/able for more information

about the commitment that IBM has to accessibility.

How to send your comments

Your feedback helps IBM to provide quality information. Please send any
comments that you have about this book or other DB2 for z/OS documentation.
You can use the following methods to provide comments:
v Send your comments by e-mail to [email protected] and include the name
of the product, the version number of the product, and the number of the book.
If you are commenting on specific text, please list the location of the text (for
example, a chapter and section title or a help topic title).
v You can send comments from the Web. Visit the DB2 for z/OS - Technical
Resources Web site at:

http://www.ibm.com/support/docview.wss?&uid=swg27011656

This Web site has an online reader comment form that you can use to send
comments.
v You can also send comments by using the feedback link at the footer of each
page in the Information Management Software for z/OS Solutions Information
Center at http://publib.boulder.ibm.com/infocenter/db2zhelp.

How to read syntax diagrams

Certain conventions apply to the syntax diagrams that are used in IBM
documentation.

Apply the following rules when reading the syntax diagrams that are used in DB2
for z/OS documentation:
v Read the syntax diagrams from left to right, from top to bottom, following the
path of the line.
The

─── symbol indicates the beginning of a statement.
The ───
symbol indicates that the statement syntax is continued on the next
line.
The
─── symbol indicates that a statement is continued from the previous line.
The ───
 symbol indicates the end of a statement.
v Required items appear on the horizontal line (the main path).

required_item


v Optional items appear below the main path.

required_item

optional_item

If an optional item appears above the main path, that item has no effect on the
execution of the statement and is used only for readability.

About this information xi

 optional_item


required_item


v If you can choose from two or more items, they appear vertically, in a stack.
If you must choose one of the items, one item of the stack appears on the main
path.

required_item required_choice1

required_choice2

If choosing one of the items is optional, the entire stack appears below the main
path.

required_item

optional_choice1
optional_choice2

If one of the items is the default, it appears above the main path and the
remaining choices are shown below.

default_choice


required_item

optional_choice
optional_choice

v An arrow returning to the left, above the main line, indicates an item that can be
repeated.

required_item  repeatable_item


If the repeat arrow contains a comma, you must separate repeated items with a
comma.

required_item  repeatable_item


A repeat arrow above a stack indicates that you can repeat the items in the
stack.
| v Sometimes a diagram must be split into fragments. The syntax fragment is
| shown separately from the main syntax diagram, but the contents of the
| fragment should be read as if they are on the main path of the diagram.

|

required_item fragment-name

|

| fragment-name:

| required_item
optional_name
|

xii Command Reference

| v With the exception of XPath keywords, keywords appear in uppercase (for
| example, FROM). Keywords must be spelled exactly as shown. XPath keywords
| are defined as lowercase names, and must be spelled exactly as shown. Variables
appear in all lowercase letters (for example, column-name). They represent
user-supplied names or values.
v If punctuation marks, parentheses, arithmetic operators, or other such symbols
are shown, you must enter them as part of the syntax.

About this information xiii

xiv Command Reference
Part 1. Privileges, authorization IDs, and the bind process
These topics contain information about the privileges and authorization IDs that
are required to issue the various commands used for DB2 and a summary of the
bind process.

© Copyright IBM Corp. 1983, 2009 1

2 Command Reference
Chapter 1. Privileges and authorization IDs
DB2 processes are represented by a set of identifiers (IDs). What the process can do
with DB2 is determined by privileges and authorities that can be held by its
identifiers.

A privilege is the capability of performing a specific function, sometimes on a

specific object. The types of privileges are:
explicit privileges
which have names and are held as the result of SQL GRANT and REVOKE
statements. For example, the SELECT privilege.
implicit privileges
which accompany the ownership of an object, such as the privilege to drop
a synonym that one owns, or the holding of an authority, such as the
privilege of SYSADM authority to terminate any utility job.

An authorization ID is a string that can be verified for connection to DB2 and to

which a set of privileges is allowed. It can represent an individual, an
organizational group, or a function, but DB2 does not determine this
representation.

The issuer of a command can be an individual user. It can also be a program

running in batch mode or an IMS or CICS transaction. The term process is used to
represent any or all of those. The privilege set of a process means the entire set of
privileges and authorities that can be used by the process in a specific situation.

There are three types of identifiers: primary authorization IDs, secondary

authorization IDs, and SQL IDs.
v Generally the primary authorization ID identifies a specific process. For
example, in the process initiated through the TSO attachment facility, the
primary authorization ID is identical to the TSO logon ID. A trace record
identifies the process by the primary authorization ID.
If RACF is active, IDs that issue commands from logged-on MVS consoles or
from TSO SDSF must have appropriate RACF authorization for DB2 commands,
or the primary authorization IDs must have DB2 authorization to issue
commands.
v Secondary authorization IDs, which are optional, can hold additional privileges
that are available to the process. A secondary authorization ID is often a
Resource Access Control Facility (RACF®) group ID. For example, a process can
belong to a RACF group that holds the LOAD privilege on a particular database.
Any member of the group can run the LOAD utility to load table spaces into the
database.
DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization
IDs.
v An SQL authorization ID (SQL ID) holds the privileges that are exercised when a
process issues certain dynamic SQL statements. This ID does not effect most DB2
and related commands.

Within DB2, a process can be represented by a primary authorization ID and

possibly by one or more secondary IDs.
© Copyright IBM Corp. 1983, 2009 3
 A privilege or authority is granted to, or revoked from, an identifier by executing
an SQL GRANT or REVOKE statement.

| Authorization for trusted context: You can use DB2 authorization to check DB2
| commands issued from a DSN session under TSO or DB2I by using primary
| authorization IDs, secondary authorization IDs, and role, if the commands are
| running in a trusted context with an associated role.

4 Command Reference
Chapter 2. The bind process
The bind process establishes a relationship between an application program and its
relational data. This process is necessary before you can execute your program.
DB2 allows you two basic ways to bind a program: to a package, or directly to an
application plan.

If your program uses DRDA® access to distribute data, you must use packages.

During the precompilation process, the DB2 precompiler produces both modified
source code and a database request module (DBRM) for each application program.
The modified source code must be compiled and link-edited before the program
can be run. DBRMs must be bound to a plan or package.

When determining the maximum size of a plan, you must consider several
physical limitations, including the time required to bind the plan, the size of the
EDM pool, and fragmentation. There are no restrictions to the number of DBRMs
that can be included in a plan. However, packages provide a more flexible method
for handling a large number of DBRMs within a plan. As a general rule, the EDM
pool should be at least 10 times the size of the largest DBD or plan, whichever is
greater.

The BIND PACKAGE subcommand allows you to bind DBRMs individually. It

gives you the ability to test different versions of a program without extensive
rebinding. Package binding is also the only method for binding programs at
remote sites.

Even when they are bound into packages, all application programs must be
designated in an application plan. BIND PLAN establishes the relationship
between the DB2 system and all DBRMs or packages in that plan. Plans can
specify explicitly named DBRMs, packages, collections of packages, or a
combination of these elements. The plan contains information about the designated
DBRMs or packages and about the data that the application program intends to
use. The plan is stored in the DB2 catalog.

In addition to building packages and plans, the bind process does the following
tasks:
v Validates the SQL statements using the DB2 catalog. During the bind process,
DB2 checks your SQL statements for valid table, view, and column names.
Because the bind process occurs as a separate step before program execution,
errors are detected and can be corrected before the program is executed.
v Verifies that the process binding the program is authorized to perform the
data accessing operations requested by your program’s SQL statements. When
you issue BIND, you can specify an authorization ID as the owner of the plan or
package. The owner can be any one of the authorization IDs of the process that
is performing the bind. The bind process determines whether the owner of the
plan or package is authorized to access the data the program requests.
v Selects the access paths that are needed to access the DB2 data your program
needs to process. In selecting an access path, DB2 considers indexes, table sizes,
and other factors. DB2 considers all indexes that are available to access the data
and decides which ones (if any) to use when selecting a path to the data.

© Copyright IBM Corp. 1983, 2009 5

 BIND PLAN and BIND PACKAGE can be accomplished using DB2I panels, the
DSNH CLIST, or the DSN subcommands BIND PLAN and BIND PACKAGE.

6 Command Reference
Part 2. Description of DB2 and related commands
Use the DB2 for z/OS and related commands to execute database administrative
functions.

These topics provide detailed reference information for DB2 and related
commands, including the environment in which each command is issued, the
privileges and authorities that are required to issue each command, syntax and
option descriptions, usage information, and examples.

© Copyright IBM Corp. 1983, 2009 7

8 Command Reference
|

| Chapter 3. Types of commands

| DB2 supports several different types of commands.

| The commands are divided into the following categories:

|| The DSN command and its DSN is the DB2 command processor and executes as a
| subcommands TSO command processor.
| DB2 commands You can use DB2 commands to control most of the
| operational environment.
| IMS commands You can use IMS commands to control IMS connections
| as well as to start and stop connections to DB2 and
| display activity on the connections.
| CICS attachment facility You can use CICS commands to control CICS
| commands connections as well as to start and stop connections to
| DB2 and display activity on the connections.
| “Administrative task scheduler You can use administrative task scheduler commands to
| commands” on page 12 start, stop, and change the administrative task scheduler.
| z/OS IRLM commands You can use z/OS Internal Resource Lock Manager
| (IRLM) commands to start, stop, and change the IRLM.
| TSO CLISTs You can use Time Sharing Option (TSO) commands to
| perform TSO tasks such as prepare and execute
| programs under TSO.
|
|
| The DSN command and its subcommands
| DSN is the DB2 command processor and executes as a TSO command processor.

| Environment: All of the DSN subcommands, except SPUFI, run under DSN in
| either the foreground or background, and all, except END, also run under DB2
| Interactive (DB2I). SPUFI runs only in the foreground under ISPF.
|| BIND PACKAGE (DSN) The DSN subcommand BIND PACKAGE builds an
| application package. DB2 records the description of the
| package in the catalog tables and saves the prepared
| package in the directory.
| BIND PLAN (DSN) The DSN subcommand BIND PLAN builds an application
| plan. All DB2 programs require an application plan to
| allocate DB2 resources and support SQL requests made at
| run time.
| DB2 commands You can use DB2 commands to control most of the
| operational environment.
| DSN (TSO) The TSO command DSN starts a DSN session.
| END (DSN) The DSN subcommand END is used to end the DSN
| session and return to TSO.
| FREE PACKAGE (DSN) The DSN subcommand FREE PACKAGE can be used to
| delete a specific version of a package, all versions of a
| package, or whole collections of packages.
| FREE PLAN (DSN) The DSN subcommand FREE PLAN deletes application
| plans from DB2.

© Copyright IBM Corp. 1983, 2009 9

| DCLGEN (DECLARATIONS The declarations generator (DCLGEN) produces an SQL
| GENERATOR) (DSN) DECLARE TABLE statement and a COBOL, PL/I, or C
| data declaration for a table or a view named in the
| catalog.
| REBIND PACKAGE (DSN) The DSN subcommand REBIND PACKAGE rebinds an
| application package when you make changes that affect
| the package, but have not changed the SQL statements in
| the program.
| REBIND PLAN (DSN) The DSN subcommand REBIND PLAN rebinds an
| application plan when you make changes that affect the
| plan, but do not change the SQL statements in the
| programs.
| REBIND TRIGGER PACKAGE The DSN subcommand REBIND TRIGGER PACKAGE
| (DSN) rebinds a package that was created when DB2 executed a
| CREATE TRIGGER statement.
| RUN (DSN) The DSN subcommand RUN executes an application
| program, which can contain SQL statements.
| SPUFI (DSN) The DSN subcommand SPUFI executes the SQL processor
| using file input.
|
|
| DB2 commands
| You can use DB2 commands to control most of the operational environment.

| Environment: The command START DB2 can be issued only from a z/OS console.
| All other DB2 commands can be issued from the following environments:
| v A z/OS console or application program
| v A DSN session
| v A DB2I panel
| v An IMS terminal
| v A CICS terminal
| v An application program, using the DB2 instrumentation facility interface (IFI)

| DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
| be checked by DB2 authorization using primary and secondary authorization IDs.

| Extended MCS Consoles: The extended MCS console feature of z/OS lets a z/OS
| system have more than 99 consoles. Because DB2 supports extended MCS consoles,
| messages returned from a DB2 command are routed to the extended MCS console
| that issued the command.

| Completion Messages: Message DSN9022I indicates the normal end of DB2

| command processing; DSN9023I indicates the abnormal end of DB2 command
| processing.
|
| IMS commands
| You can use IMS commands to control IMS connections as well as to start and stop
| connections to DB2 and display activity on the connections.

10 Command Reference
|| /CHANGE (IMS) The IMS command /CHANGE resets an indoubt unit of recovery
| as identified by the OASN keyword of the /DISPLAY command.
| That command deletes the item from the standpoint of IMS, but it
| does not communicate to DB2.
| /DISPLAY (IMS) The IMS command /DISPLAY displays the status of the connection
| between IMS and an external subsystem (as well as all application
| programs communicating with the external subsystem), or the
| outstanding recovery units that are associated with the subsystem.
| /SSR (IMS) The IMS /SSR command allows the IMS operator to enter an
| external subsystem command.
| /START (IMS) The IMS /START command (with the SUBSYS parameter) makes
| the connection between IMS and the specified external subsystem
| available. Establishing the connection allows application programs
| to access resources managed by the external subsystem.
| /STOP (IMS) The IMS /STOP command (with the SUBSYS parameter) prevents
| application programs from accessing external subsystem resources.
| /TRACE (IMS) The IMS /TRACE command directs and controls the IMS
| capabilities for tracing internal IMS events. It also starts, stops, and
| defines the activity to be monitored by the IMS Monitor.
|
| Related reference
| ″DSNAIMS stored procedure″ (DB2 Administration Guide)
| ″DSNAIMS2 stored procedure″ (DB2 Administration Guide)
|
| CICS attachment facility commands
| You can use CICS commands to control CICS connections as well as to start and
| stop connections to DB2 and display activity on the connections.

| Environment: Each CICS attachment facility command can be issued from a CICS
| terminal.

|| DSNC (CICS attachment The CICS attachment facility DSNC command allows you
| facility) to enter DB2 commands from CICS.
| DSNC DISCONNECT (CICS The CICS attachment facility command DSNC
| attachment facility) DISCONNECT disconnects threads.
| DSNC DISPLAY (CICS The CICS attachment facility command DSNC DISPLAY
| attachment facility) displays information on CICS transactions accessing DB2
| data, or statistical information associated with
| DB2ENTRYs and the DB2CONN.
| DSNC MODIFY (CICS The CICS attachment facility command DSNC MODIFY
| attachment facility) modifies the message queue destination of the DB2CONN,
| or modifies the maximum active thread value for the pool,
| for DSNC commands, or for DB2ENTRY.
| DSNC STOP (CICS attachment The CICS attachment facility command DSNC STOP stops
| facility) the attachment facility.
| DSNC STRT (CICS attachment The DSNC STRT command starts the CICS attachment
| facility) facility, which allows CICS application programs to access
| DB2 databases.
|

Chapter 3. Types of commands 11

|
| Administrative task scheduler commands
| You can use administrative task scheduler commands to start, stop, and change the
| administrative task scheduler.

| Environment: Each administrative task scheduler command can be issued from a

| z/OS console.

|| Chapter 48, “MODIFY The MODIFY admtproc, APPL=SHUTDOWN command

| admtproc,APPL=SHUTDOWN,” stops the administrative task scheduler from accepting
| on page 311 requests and starting new task executions. It also shuts
| down the administrative task scheduler.
| Chapter 49, “MODIFY The MODIFY admtproc, APPL=TRACE command starts
| admtproc,APPL=TRACE,” on or stops traces in the administrative task scheduler.
| page 313
| Chapter 71, “START admtproc,” The START admtproc command starts the scheduler that
| on page 385 is specified in the admtproc parameter
| Chapter 82, “STOP admtproc The STOP admtproc command stops the administrative
| (z/OS ),” on page 439 task scheduler that is specified in the admtproc
| parameter.
|
|
| z/OS IRLM commands
| You can use z/OS Internal Resource Lock Manager (IRLM) commands to start,
| stop, and change the IRLM.

| Environment: Each z/OS IRLM command can be issued from a z/OS console.

|| MODIFY irlmproc,ABEND The MODIFY irlmproc , ABEND command terminates

| (z/OS IRLM) IRLM abnormally. IRLM processes this command even if a
| DB2 subsystem is identified to it.
| MODIFY irlmproc,DIAG (z/OS The MODIFY irlmproc , DIAG command initiates
| IRLM) diagnostic dumps for IRLM subsystems.)
| MODIFY irlmproc,PURGE The MODIFY irlmproc,PURGE command releases IRLM
| (z/OS IRLM) locks retained due to a DB2, IRLM, or system failure.
| MODIFY irlmproc,SET (z/OS The MODIFY irlmproc,SET command dynamically sets
| IRLM) various IRLM operational parameters
| MODIFY irlmproc,STATUS The MODIFY irlmproc,STATUS command displays
| (z/OS IRLM) information for one or more subsystems connected to the
| IRLM that is specified using irlmproc .
|
|
| TSO CLISTs
| You can use Time Sharing Option (TSO) commands to perform TSO tasks such as
| prepare and execute programs under TSO.

|| Chapter 44, The DSNH command procedure (a TSO CLIST) is a powerful yet easy
| “DSNH (TSO method of preparing an application program for execution.
| CLIST),” on
| page 275
| DSNU The DSNU command procedure can be executed directly or by using
| DB2I.
|

12 Command Reference
| Related information
| ″Invoking a DB2 utility by using the DSNU CLIST command in TSO″ (DB2 Utility
| Guide and Reference)

Chapter 3. Types of commands 13

14 Command Reference
Chapter 4. DB2 command parsing
All of the DB2 and related commands have a similar structure that is necessary to
execute valid commands.

The following figure illustrates the pattern of DB2 commands.

Recognition character
Command
Primary keyword
Value

-DISPLAY DATABASE(J64DBASE),SPACENAM(PROJ32)
Value
Keyword
Separators

Figure 1. The format and parts of a DB2 command

The parts of a command are:

Recognition character
Shown as a hyphen throughout this information, with the following
exceptions:
v If the command is issued from a z/OS console, the recognition character
must be the command prefix.
The command prefix can be up to eight characters. The default is
’-DSN1’. However, the majority of examples in this information assume
that the command prefix has been defined as a hyphen (-). Examples
involving members of a data sharing group demonstrate the use of
multi-character command prefixes, such as -DB1G.
Inserting a space between the command prefix and the command is
optional. For example, you can use either one of the following formats:
-DB1GDIS THREAD(*)
-DB1G DIS THREAD(*)

Using a space makes it easier for users to identify the command,

especially when the command prefix has multiple characters.
The command prefix can be defined at installation time.
v If the command is issued from an IMS terminal, the recognition
character must be the command recognition character (CRC). The
command recognition character is defined in the IMS SSM PROCLIB
member.
v If the command is issued from a CICS terminal or under the DSN
command processor, the recognition character must be a hyphen.
Command name
The name of the command. Command names have abbreviations, which
are provided in the description of each command.
Operands
Combinations of keywords and parameters that can be specified for the
command.

© Copyright IBM Corp. 1983, 2009 15

 Keywords
Sometimes called command options. Keywords can be required or
optional. They must be entered exactly as shown in the descriptions of
the commands.
Parameters
A keyword can have zero or more parameters. A parameter list, if
present, must be enclosed in parentheses.
Separators
These can be one or more blanks or commas. An open parenthesis
marks the beginning of a parameter list; no separator is needed.
Optionally, an equal sign can be used to separate a single parameter
from its keyword without using parentheses.

Characters with special meanings

Several characters have special meaning for the syntax of DB2 commands.

The following characters have special meaning:

A blank is a separator.
Multiple blanks are equivalent to a single blank, except in strings enclosed
between apostrophes.
, A comma is a separator.
’ An apostrophe is the usual SQL string constant delimiter, and marks the
beginning or end of a string constant in SQL. (In COBOL programs only,
the QUOTESQL precompiler option allows you to choose the quotation
mark as the SQL string delimiter; the apostrophe is then the SQL escape
character.)
Letters not in string constants are changed to uppercase. Two successive
apostrophes in a string constant are changed to one apostrophe. Blanks,
commas, equal signs, and parentheses in string constants are treated as
literal characters, and are not recognized as separators.
There is an exception to the rule about changing letters to uppercase. If the
CODED CHARACTER SET option is set to 930 or 5026 during installation,
the letters are not folded to uppercase, whether in an SQL string constant
or not.
″ A quotation mark is the SQL escape character, and marks the beginning or
end of an SQL delimited identifier. (In COBOL programs only, the
QUOTESQL precompiler option allows you to choose the apostrophe as
the SQL escape character; the double quotation mark is then the SQL string
delimiter.)
Within a string delimited by quotation marks, two successive quotation
marks are changed to one. Other rules are the same as for SQL string
constants.
= An equal sign separates a single parameter from a keyword. Thus, an
equal sign is used as a separator for keywords that have only one
parameter. An equal sign can be used for keywords with multiple
parameters when only one member of the parameter list is specified.
( An open parenthesis marks the beginning of a parameter list.
) A close parenthesis marks the end of a parameter list.

16 Command Reference
 : A colon means an inclusive range. For example, (A:D) means the same as
(A,B,C,D); (1:5) means (1,2,3,4,5). The colon can be used this way only in
commands where this operation is specifically permitted.
* An asterisk means any of the following usages:
* A single asterisk as a keyword_value indicates all. For example:
-DISPLAY UTILITY (*)
*keyword_value
An asterisk as the first character of a keyword_value indicates that
a match for the value will be satisfied when all characters
following the * are the same. For example: (*BCD)
keyword*value
An intermediate asterisk indicates that a match for the value will
be satisfied when all characters preceding and all characters
following the asterisk are the same. For example: (ABC*EFG)
keyword_value*
An asterisk as the final character of a keyword_value indicates that
a match will for the value will be satisfied when all characters
preceding the asterisk are the same. For example: (ABC*)
*keyword*_value*
Asterisks used as the first, intermediate and final characters in a
string are also valid. For example: (*BCD*FGH*)

For example, DISPLAY UTILITY (*) displays the status of all utilities;
DISPLAY UTILITY (R2*) displays the status of all utilities whose identifiers
begin with R2.
The asterisk pattern-matching character is available to all DB2 commands,
but not all DB2 commands support an asterisk. The asterisk can be used
this way only in commands in which the pattern-matching operation is
specifically permitted.
NO (two-character string) negates the keyword that follows.
A negated keyword means the opposite of the keyword itself, and is often
used to override a keyword default. In keywords that have no opposite
meaning, the initial characters “NO” can be merely part of the keyword
itself; for example, in NODE.

Examples of keyword entry

The following examples illustrate valid combinations of keywords and parameters:
v MODE (FORCE)
v MODE=FORCE
v MODE (NOFORCE) (keyword negation)
v MODE=NOFORCE (keyword negation)
v DATABASE(name1 name2 . . . namen) ACCESS(RO)
v SPACENAM (name1,name2) ACCESS(RO)
v ACCESS (RO),SPACENAM=name
v Combinations of the preceding

Do not use more than one parameter after an equal sign or an error condition
occurs.

Chapter 4. DB2 command parsing 17

18 Command Reference
Chapter 5. DSN subcommand parsing
The parsing of DSN subcommands conforms to standard TSO command parsing
conventions.

To continue a subcommand on the next line while using the DSN processor, type
either a hyphen (-) or a plus sign (+) at the end of the current line. If you use a
plus sign, precede it by at least one blank character to prevent the concatenation of
character strings from line to line. Using a plus sign causes TSO/E to delete
leading delimiters (blanks, commas, tabs, and comments) on the continuation line,
and will reduce the overall size of the command.

Important: The names of the DSN command and its subcommands cannot be
abbreviated. For compatibility with prior releases of DB2, abbreviations for some
keywords are allowed. To avoid potential problems, avoid abbreviating keywords.

© Copyright IBM Corp. 1983, 2009 19

20 Command Reference
Chapter 6. Scope of DB2 and related commands
In a data sharing environment, the scope of a command is the breadth of its impact.

All commands have one of the following scopes:

Member or Local
Many commands used in a data sharing environment have member (or
local) scope because they affect only the DB2 subsystem for which they are
issued. For example, a CANCEL THREAD command cancels the specified
threads for the member that is identified by the command prefix.
Group Other commands have group scope because they affect an object in such a
way that affects all members of the group. For example, a STOP
DATABASE command issued from any member of the group stops that
database for all members of the group.

The following commands have group scope:

ALTER GROUPBUFFERPOOL (DB2) FREE PLAN (DSN)

BIND PACKAGE (DSN) MODIFY irlmproc,DIAG (z/OS IRLM)
BIND PLAN (DSN) REBIND PACKAGE (DSN)
DCLGEN (DSN) REBIND PLAN (DSN)
DISPLAY DATABASE (DB2) REBIND TRIGGER PACKAGE (DSN)
DISPLAY GROUP (DB2) START DATABASE (DB2)
DISPLAY GROUPBUFFERPOOL (DB2) STOP DATABASE (DB2)
FREE PACKAGE (DSN)

The following commands have either group or member scope, depending on

which options you specify with them:

ARCHIVE LOG (DB2) START FUNCTION SPECIFIC (DB2)

DISPLAY FUNCTION SPECIFIC (DB2) START PROCEDURE (DB2)
DISPLAY PROCEDURE (DB2) START TRACE (DB2)
DISPLAY THREAD (DB2) STOP FUNCTION SPECIFIC (DB2)
DISPLAY TRACE (DB2) STOP PROCEDURE (DB2)
DISPLAY UTILITY (DB2) STOP TRACE (DB2)
MODIFY irlmproc,SET (z/OS IRLM) TERM UTILITY (DB2)
MODIFY irlmproc,STATUS (z/OS IRLM)

All other commands have member scope. The description of each command
includes its scope.

© Copyright IBM Corp. 1983, 2009 21

22 Command Reference
Chapter 7. Output from DB2 commands
Several factors affect the amount of output you can receive from a DB2 command.

The amount of output that you receive from a DB2 command is always less than
256 KB. The following factors determine the maximum amount of output you can
receive:
v The amount of storage available to your DB2 subsystem or to an individual
command.
v The environment from which you issue the DB2 command.
For example, if you issue a DB2 command from an IMS console, you can receive
no more than 32 KB of output.
v For DISPLAY DATABASE, the value of the LIMIT parameter.
v For DISPLAY THREAD, the number of lines of output.
DISPLAY THREAD does not display more than 254 lines of output.

© Copyright IBM Corp. 1983, 2009 23

24 Command Reference
Chapter 8. Issuing commands to DB2 from IFI
Consider using IFI to let your programs issue commands to DB2. This method
returns information about the success or failure of the command to your program.

If the command issues a non-zero return code, the information returned to your
program includes diagnostic information about the command processed.

© Copyright IBM Corp. 1983, 2009 25

26 Command Reference
 Chapter 9. Command Line Processor
You can use the command line processor to issue SQL statements, bind DBRMs
that are stored in HFS files, and call stored procedures.

The command line processor operates as follows:

v The COMMAND LINE PROCESSOR command (in either case) is typed at the
UNIX® System Services system prompt.
v It can be started in either batch mode or interactive input mode.
v Output is automatically directed to the standard output device.
v Piping and redirection are supported.
v The user is notified of successful and unsuccessful completion.
v Following execution of the command, control returns to the operating system
command prompt, and the user can enter more commands.

The following sections provide move information on the command line processor:
v “How to start and set up the command line processor”
v “Information on the batch and interactive modes” on page 28
v “Command line processor options and settings” on page 28
v “Setting up command line processor options and settings” on page 28
v “How to connect to a DB2 server” on page 32
v “Command line processor basic commands” on page 33
v “Command line processor information commands” on page 34
v “Command line processor XML commands” on page 36
v “Command line processor help commands” on page 42
v “SQL statements for the command line processor” on page 43

How to start and set up the command line processor

The command line processor can be started in the following two modes:
v Batch mode
v Interactive Input mode

The syntax below shows how to start the command:

|

db2

option-flag
|

Please see DB2 Installation Guide for more detailed information on installing the
command line processor.

© Copyright IBM Corp. 1983, 2009 27

 Information on the batch and interactive modes

Batch Mode

Issue the word db2, followed by the option –f filename in order to have the
command line processor take all of the data from the named file, and process all of
the commands in the file consecutively. For example, the following command will
direct the command line processor to process all the statements in the file named
demo.clp:
v db2 -f demo.clp

Interactive Mode

Issue the word db2, and the command line processor will automatically go into
interactive mode. The command line processor will prompt you to enter SQL
statements or commands, one at a time. The simplest form of the DB2 command is
as follows:
v db2

While the command line processor is executing in interactive mode, it will prompt
you for input by means of a prompt that will look like this:
v db2 =>

Command line processor options and settings

You can specify command options for the command line processor for either the
entire command line processor session or with option flags. You can view the
options settings by issuing the command line processor command -LIST
COMMAND OPTIONS. Option settings can be changed from the interactive input
mode or a command file by using command line processor command -UPDATE
COMMAND OPTIONS. The command line processor sets options in the following
order:
1. Sets up default options.
2. Reads option settings from the properties file to override the defaults.
3. Reads the command line options to override option settings from properties
file.
4. Accepts input from UPDATE COMMAND OPTIONS as a final override.

Setting up command line processor options and settings

The table below outlines the default options for the command line processor:
Table 1. Default options table
OPTION KEYWORD IN
DESCRIPTION DEFAULT SETTING PROPERTIES FILE OPTIONS FLAG
Display SQLCA data OFF DisplaySQLCA a
Automatically ON AutoCommit c
commit SQL
statements
Read command input OFF InputFilename f<filename>
from the given file

28 Command Reference
Table 1. Default options table (continued)
OPTION KEYWORD IN
DESCRIPTION DEFAULT SETTING PROPERTIES FILE OPTIONS FLAG
Output data and ON DisplayOutput o
messages to standard
output
Stop the command OFF StopOnError s
line processor and
exit to the operating
system if error is
encountered during
execution of a
statement
Use semicolon(;) as OFF TerminationChar t
the statement
termination character.
If this option is not
set, each line will be
considered a
statement unless it
ends with a space
followed by a
backslash(\).
Use x as the OFF TerminationChar tdx
statement termination
character
Echo command text OFF Echo v
to standard output
Return data without OFF StripHeaders x
any headers,
including column
name
Output data and OFF OutputFilename z<filename>
messages are stored
in the given file
Transaction isolation CS IsolationLevel
level
Maximum number of ALL MaxLinesFromSelect
lines to return from a
SELECT query
Controls the 32 MaxColumnWidth Width=<value> pair
maximum number of
characters of a
column that would
be displayed on
execution of SQL
SELECT statements,
result set returned
from CALL stored
procedures or
command line
processor catalog
commands.

Setting up command line properties file

Chapter 9. Command Line Processor 29

 You can create this optional file for the command line processor in order to
customize your environment. When the processor is invoked from the UNIX
system services prompt, in either interactive or batch mode, the processor checks
for the definition of CLPPROPERTIESFILE environment variable in order to locate
the properties file. You can define this environment variable if you intend to use
the command line processor properties file to change the command line processor
defaults. It is a simple text file that contains attributes of the form key=value pair.
The properties file is initially loaded when the command line processor is invoked.
Any changes to the properties file while the command line processor session is
active will not be picked up. In order for the changes to be picked up, you need to
terminate the current session and start a new command line processor session. You
can always change command line processor defaults using either option flags or
the UPDATE COMMAND OPTIONS, regardless of whether or not you use the
command line processor properties file. The following are the keywords that can
be used to set the command line processor command options in the properties file
:
Table 2. properties file : table for command options
Keyword Name Acceptable Keyword value
DisplaySQLCA ON | OFF | blank
AutoCommit ON | OFF | blank
InputFilename <Filename> | blank
OutputFilename <Filename> | blank
DisplayOutput ON | OFF | blank
StopOnError ON | OFF | blank
TerminationChar ON | OFF | any single character or blank
Echo ON | OFF | blank
StripHeaders ON | OFF | blank

Note:

If blanks are specified for the keyword in the properties file, the default value will
be used.

If InputFilename is specified in the properties file, the command line processor will
execute in the batch mode.

To enter into interactive mode, you can do one of the following:

1. Remove InputFilename keyword or blank out the value
2. Invoke command line processor with +f command line options flag. For
example:
db2 +f

You can use the following keywords to set the command line processor
non-command options in the properties file:
Table 3. properties file : table for non-command options
Keyword Name Acceptable Keyword value
IsolationLevel RR | RS | CS | UR | blank
MaxLinesFromSelect ALL | Positive numeric value | blank

30 Command Reference
Using UPDATE COMMAND OPTIONS

You can use the UPDATE COMMAND OPTIONS command using the following
format

UPDATE COMMAND OPTIONS USING [OPTIONS FLAG/KEYWORD][ON/OFF]

The default options table above shows the command options that the command
line processor has for various aspects of its operation. Refer to the ’Default options
table’ above for options flags and keywords. You can change these default settings
by using this command.

If you want to turnoff AutoCommit, specify one of the following:

UPDATE COMMAND OPTIONS USING c OFF

or

UPDATE COMMAND OPTIONS USING AutoCommit OFF

Using LIST COMMANDS OPTIONS

You can tell which options are currently in effect by issuing the LIST COMMAND
OPTIONS command, which is as follows:

LIST COMMAND OPTIONS

Examples of command line processor invocations

If clp.properties contains the following attributes:

AutoCommit=OFF
Echo=ON

and the command line processor is invoked from Unix System Services prompt as:
db2 -t

The options will be processed as follows:

v The command line processor will start with default options.
v The command line processor will read the properties file and will turn off
Autocommit and turn on Echo options.
v The command line processor will read the command line options flags (-t) and
will set the termination character to semicolon (;).

Since no InputFilename is specified in the properties file and no ’-f’ options flag is
specified during the command line processor command invocation, the command
line processor will enter into interactive mode.

If clp.properties contains the following attributes:

AutoCommit=ON
Echo=
InputFilename=/tmp/test.clp
TerminationChar=%
OutputFilename=

and the command line processor is invoked from Unix System Services prompt as:

Chapter 9. Command Line Processor 31

 db2 +f

then the options will be processed as follows:

v The command line processor will start with default options.
v The command line processor will read the properties file and will turn on
Autocommit , set termination character to ’%’ and will read input from the file
named ’/tmp/test.clp’. Since Echo and OutputFilename keywords in the
properties file are blank, the default value is assigned.
v The command line processor will read the command line options flags (+f) that
will turn off the file mode and the command line processor will enter into
interactive mode.

How to connect to a DB2 server

Use the CONNECT command to connect to a DB2 server. Before you can access
any data you must first connect to a server. Issue the following command:

CONNECT TO <URL> USER <username> USING <password>

where URL is in the form :

|

server database

:port property=value;
|

The URL specifies a data source name that consists of server, port, database and
property=value fields.

The part of the URL has the following meanings:

v server : The domain name or IP address of the database server.
v port : The TCP/IP server port number that is assigned to the database server.
v database : The DB2 location name that is defined during installation.
v property=value : Specifies the property for the JDBC connection.

The command line processor uses IBM Data Server Driver for JDBC and SQLJ type
4 connectivity to connect to data sources. Ensure that the driver packages are
bound at the target data sources and that you have execute permissions on those
packages. All characters in the DB2 location name must be uppercase characters.
The IBM Data Server Driver for JDBC and SQLJ does not convert lowercase
characters in the database value to uppercase for IBM Data Server Driver for JDBC
and SQLJ type 4 connectivity.

The location name can be determined by executing the following SQL statement on
the server:

SELECT CURRENT SERVERFROM SYSIBM.SYSDUMMY1

You can also define your own alias names in the properties file and use the alias
names to connect to specified DB2 servers. The alias names specified in the
properties file should not be confused with alias that you can create for a DB2

32 Command Reference
table or view through CREATE ALIAS SQL statement. The alias name specified in
properties file should be defined as follows :

<DB2ALIASNAM>=<URL>,<username>,<password>

The following command can then be used to connect to the DB2 server.

CONNECT TO <DB2ALIASNAME>

For example, in the properties file, DSN1 is the alias name defined as follows:

DSN1=v01ec107.svl.ibm:8000/STLEC1,JOHNDOE,PASSW0RD

Then the following command can be issued using the command line processor in
order to connect to DSN1 alias.

CONNECT TO DSN1

Command line processor basic commands

BIND filename [-collection collection] [options]
This command binds the HFS DBRMS into packages or collections at the
target DB2 server.
COMMIT
This command makes all changes made since the previous commit or
rollback permanent and releases any database locks currently held by the
active connection. If the auto-commit is on, then the command line
processor will automatically commit at the end of each SQL statement at
the current server. If there is an active connection and you issue a new
connect command, then the command line processor will close the
currently active connection before making the new connection. If the
auto-commit is off and a connection is made to a new server without
issuing COMMIT or ROLLBACK at the current server where a transaction
was in progress, then the command line processor will produce error
message DSNC109I.
DISCONNECT
This command will close and release the connection from the currently
connected database. This command should only be used when there are
not any transactions in progress or the command line processor will
produce error message DSNC113I.
If this command is issued when there are no active database connections,
the command line processor will return error message DSNC108I.
CHANGE ISOLATION TO <RR | RS | CS | UR >
This command changes the level of isolation between the user transactions
and the transactions of other concurrent users. Choosing a high isolation
level protects against interference from other users, and also protects
system performance and limits concurrent access to data. The supported
isolation levels, from highest to lowest, are as follows:
v Repeatable Read (RR). Repeated reads of the same data are guaranteed
consistent within a transaction.
v Read Stability (RS). When performing a repeated read of a table, old
rows will be unchanged but new rows may appear.
v Cursor Stability (CS). Guarantees that a row of data will not change
while your cursor is positioned on it. This is the default isolation level.

Chapter 9. Command Line Processor 33

 v Uncommitted Read (UR). Allows you to read updates that have not been
committed by other users and that are therefore subject to being rolled
back.
By default, the command line processor uses the isolation level of Cursor
Stability for executing transactions. To override this default, you must
define IsolationLevel keyword in the properties file. To change the isolation
level later during a command line processor session, you can use the
CHANGE ISOLATION LEVEL command. This command can be executed
anytime after making a connection to a DB2 server. If there is no active
connection, then the command line processor will return message
DSNC108I.
ECHO <string>
The ECHO command will simply echo its content to the output stream.
This can be useful for generating labels in an output file. For example, if
the command line processor is running test cases from an input file and
saving the results in an output file, the ECHO command can be used to
label the test cases. For example, you can issue the following:
ECHO Test Case 10
ROLLBACK
This command undoes all the changes made in the current transaction and
releases any database locks currently held by the active connection. If
auto-commit is on, then this command will have no effect.
TERMINATE
This command will terminate the database connection, if any, and will end
your command line processor session. If a transaction is in progress, it will
be committed.
! <UNIX System Services command>
Within a command line processor, you can issue UNIX System Services
command by prefixing the command with ’!’ character. Example :
! ls
This command will list all the files and directories in the current directory.

Command line processor information commands

CHANGE MAXCOLUMNWIDTH TO <number>
This controls the maximum number of characters of a column that would
be displayed on execution of SQL SELECT statements.
CHANGE MAXLINESFROMSELECT TO <ALL|number>
This controls the number of rows that will be displayed from the result set
returned by SELECT SQL statements, CALL stored procedure statements or
command line processor catalog commands. The DSNC111I error message
is returned if neither ALL or a positive number is specified.
DESCRIBE CALL
This command specifies the stored procedure that you want to be
described. If the stored procedures are not fully qualified, then the schema
used will be that of the current user. Fully qualified stored procedures
must be in the form <schema>.<stored procedure>.
The DESCRIBE CALL command will list the following information about
each parameter of the stored procedure: This command will also return a
table with the following columns:

34 Command Reference
 v COLUMN_NAME - the column or parameter name
v COLUMN_TYPE- a type of column or parameter. The following are
possible return values:
– 0 - unknown
– 1 - IN parameter
– 2- INOUT parameter
– 3 - result column in ResultSet
– 4 - OUT parameter
– 5 - procedure return value
v TYPE_NAME - the data source dependant type name
v LENGTH - the length in bytes of data
v PRECISION - precision
v SCALE - the scale
v NULLABLE- has the following possible returned values:
– 0 - does not allow NULL values
– 1 - allows NULL values
– 2 - unknown if value is nullable
Example 1: Assuming that TEST.EMPLOYEE_INFO is a stored procedure
which is already defined, then the user can issue the following command
to get information about this stored procedure:
DESCRIBE CALL TEST.EMPLOYEE_INFO
DESCRIBE TABLE [schema] <tablename|view>
This command specifies the table or view that you want described. An
alias for the table cannot be used in place of the actual table. If the table
name or view is not fully qualified, then the schema used will be that of
the current user. Fully qualified table names must be in the form
<schema>.<table>.
The DESCRIBE TABLE command will list the following information about
each column:
v COLUMN_NAME - the column of the table
v TABLE_SCHEM- a table schema
v TYPE_NAME - the data source dependant type name
v COLUMN_SIZE- the column size. For character or date types, this is the
maximum number of characters. For number or decimal type, this is
precision.
v DECIMAL_DIGITS- the number of fractional digits
v IS_NULLABLE- has the following possible returned values:
– No - column does not allow NULL values
– Yes- column might allow NULL values
– Empty string - unknown if column allows NULL values
DISPLAY RESULT SETTINGS
This command displays the current settings for MAXCOLUMNWIDTH
and MAXLINESFROMSELECT.
LIST TABLES FOR <USER| ALL | SYSTEM | SCHEMA schema-name>|
This command is used to list tables, views, or aliases associated with the
connected database. If the FOR clause is not specified, then tables for
USER will be listed.

Chapter 9. Command Line Processor 35

 Example 1: Lists all tables or views in the connected database.
FOR ALL
Example 2: Lists all catalog tables in the connected database.
FOR SYSTEM
Example 3: Lists all tables or views in the database for the specified
<schema-name> only.
FOR SCHEMA <schema-name>
Example 4: Lists all tables or views in the connected database for the
current user.
FOR USER
The list table command will list the following information about each table
or view:
v The table, view, or alias.
v Schema.
v Type- typical types are the following:
– TABLE
– VIEW
– SYSTEM TABLE
– GLOBAL TEMPORARY
– LOCAL TEMPORARY
– ALIAS
– SYNONYM
– AUXILIARY
v Creation time

Command line processor package-related commands

BIND filename [-collection collection] [options]
This command binds the HFS DBRMS into packages or collections at the
target DB2 server. For more information on the bind command, see the
topic “Binding DBRMs in HFS files”.

Command line processor XML commands

-ADD XMLSCHEMA DOCUMENT
Adds one or more XML schema documents to an existing but incomplete
| XML schema registration.
|

36 Command Reference
|

ADD XMLSCHEMA DOCUMENT TO relational-identifier

|

|
|

 ADD schemaLocation-URI FROM content-URI

WITH properties-URI

|


| COMPLETE
WITH schema-properties-URI ENABLE DECOMPOSITION

Option descriptions
TO relational-identifier
| Specifies the relational name of a registered, but incomplete, XML
| schema to which additional schema documents will be added.
| The schema of the relational identifier must be SYSXSR. If you
| specify a qualified name, the qualifier must be SYSXSR; for
| example, SYSXSR.MYSCHEMA. If you specify an unqualified
| name, you need to execute the SQL statement SET SCHEMA="SYSXSR"
| before you execute the command. A name that is enclosed in
| quotation marks, such as ″SYSXSR.MYSCHEMA″, is considered as
| an unqualified name. Qualifiers or schema names that are enclosed
| in quotation marks are not folded to uppercase. Qualifiers or
| schema names that are not enclosed in quotation marks are folded
| to uppercase.
| ADD schemaLocation-URI
| Specifies the schema location URI of an XML schema document to
| be added to this schema, as the document would be referenced
| from another XML document.
FROM content-URI
Specifies the URI where the actual content of an XML schema
document is located. The CLP supports only file:// based URI.
WITH properties-URI
Specifies the URI of a properties document to be associated with a
schema document. The CLP supports only file:// based URI.
COMPLETE
Indicates that there are no more XML schema documents to be
associated with this XML schema other than those indicated in this
ADD XML SCHEMA DOCUMENT command. Validation of the
schema will be performed, and if no errors are found the schema
will be marked as usable. Until XML schema registration is
completed, the schema is not visible to or usable in other
SQL/XML commands.
WITH schema-properties-URI
Specifies the URI of a properties document to be associated with

Chapter 9. Command Line Processor 37

 this XML schema. The CLP supports only file:// based URI. A
schema properties document can only be specified when the XML
schema is also being completed.
ENABLE DECOMPOSITION
Indicates that this schema is to be used for the purpose of
decomposing XML documents. It can only be specified when the
XML schema is also being completed.
Example 1: An XML schema referred to by the relational name
JOHNDOE.PRODSCHEMA1 has already been registered. Two more
documents need to be added to the list of schema documents associated
with the schema. The first is ″http:// mycompany.com/xml/schema/
order.xsd″, stored locally in /u/temp. The second is ″http://
othercompany.com/external/po.xsd″, also stored locally in /u/temp.
Neither document has an associated properties file, and the DBA is certain
that there are no other documents referenced by the schema and wishes to
complete it:
-ADD XMLSCHEMA DOCUMENT TO JOHNDOE.PRODSCHEMA1
ADD http://mycompany.com/xml/schema/order.xsd
FROM file:///u/temp/order.xsd
ADD http://othercompany.com/external/po.xsd
FROM file:///u/temp/po.xsd
COMPLETE

Example 2: An XML schema referred to by the relational name

JOHNDOE.TEST has been registered, and the DBA wishes to add a single
document but not complete the registration. The schema document is
″http://johndoe.com/test/test3.xsd″ and it is stored locally in
/usr/jdoe/test/test3.xsd. The command would be:
-ADD XMLSCHEMA DOCUMENT TO JOHNDOE.TEST
ADD http://johndoe.com/test/test3.xsd
FROM file:///usr/jdoe/test/test3.xsd
-COMPLETE XMLSCHEMA
| Completes the registration of an XML schema.
|

|

COMPLETE XMLSCHEMA relational-identifier

| WITH schema-properties-URI

|


| ENABLE DECOMPOSITION
|

Option descriptions:
relational-identifier
Specifies the relational name given to an XML schema in a
previous REGISTER XMLSCHEMA command.
| The schema of the relational identifier must be SYSXSR. If you
| specify a qualified name, the qualifier must be SYSXSR; for
| example, SYSXSR.MYSCHEMA. If you specify an unqualified
| name, you need to execute the SQL statement SET SCHEMA="SYSXSR"
| before you execute the command. A name that is enclosed in
| quotation marks, such as ″SYSXSR.MYSCHEMA″, is considered as
| an unqualified name. Qualifiers or schema names that are enclosed

38 Command Reference
| in quotation marks are not folded to uppercase. Qualifiers or
| schema names that are not enclosed in quotation marks are folded
| to uppercase.
WITH schema-properties-URI
Specifies the URI of a properties document to be associated with
this XML schema. The CLP supports only file:// based URI.
ENABLE DECOMPOSITION
indicates that this schema is to be used for the purpose of
decomposing XML documents.
Example 1: Assume you have previously registered a complicated schema
consisting of multiple documents and given it the relational name
’PRODSCHEMA’. The schema has additional properties that you would
like to store in the database catalogs, which is stored locally in
/u/temp/CUSTPROP.XML. The command would be:
-COMPLETE XMLSCHEMA PRODSCHEMA WITH 'file:///u/temp/CUSTPROP.xml'
-DECOMPOSE XML DOCUMENT
| Decomposes a single XML document.
|

|

DECOMPOSE XML DOCUMENT xml-document-name XMLSCHEMA relational-identifier


|

Option descriptions:
| xml-document-name
| The file path and file name of the input XML document to be
| decomposed.
relational-identifier
Specifies the relational name given to an XML schema in a
previous REGISTER XMLSCHEMA command.
| The schema of the relational identifier must be SYSXSR. If you
| specify a qualified name, the qualifier must be SYSXSR; for
| example, SYSXSR.MYSCHEMA. If you specify an unqualified
| name, you need to execute the SQL statement SET SCHEMA="SYSXSR"
| before you execute the command. A name that is enclosed in
| quotation marks, such as ″SYSXSR.MYSCHEMA″, is considered as
| an unqualified name. Qualifiers or schema names that are enclosed
| in quotation marks are not folded to uppercase. Qualifiers or
| schema names that are not enclosed in quotation marks are folded
| to uppercase.
Example 1: This example specifies that the XML document in
/u/gb/doc1.xml is to be decomposed according to the XSR registered
schema ’genbankschema’.
-DECOMPOSE XML DOCUMENT /u/gb/doc1.xml
XMLSCHEMA genbankschema
-REGISTER XMLSCHEMA
| Registers an XML schema with the database manager.
|

Chapter 9. Command Line Processor 39

|

REGISTER XMLSCHEMA FROM content-URI

| schemaLocation-URI-1 WITH properties-URI

|
AS relational-identifier

| sub-document-clause
|

| sub-document-clause:
|

|
|


 ADD schemaLocation-URI-2 FROM content-URI

WITH properties-URI

|


| COMPLETE
WITH schema-properties-URI ENABLE DECOMPOSITION

Option descriptions
| schemaLocation-URI-1
| Specifies the schema location URI of the XML schema to be
| registered, as it is referenced from XML instance documents or the
| SQL XML schema validation function. If a single XML schema
| references multiple schema documents, each XML schema
| document other than the primary document must also be
| registered, either in the sub-document clause in the REGISTER
| XMLSCHEMA command or in a separate ADD XMLSCHEMA
| DOCUMENT command.
FROM content-URI
Specifies the URI where the actual content of an XML schema
document is located. The CLP supports only file:// based URI.
WITH properties-URI
Specifies the URI of a properties document to be associated with a
schema document. The CLP supports only file:// based URI.
AS relational-identifier
Specifies a name that can be used to refer to the XML Schema in
relational SQL/XML.
| The schema of the relational identifier must be SYSXSR. If you
| specify a qualified name, the qualifier must be SYSXSR; for
| example, SYSXSR.MYSCHEMA. If you specify an unqualified
| name, you need to execute the SQL statement SET SCHEMA="SYSXSR"
| before you execute the command. A name that is enclosed in
| quotation marks, such as ″SYSXSR.MYSCHEMA″, is considered as
| an unqualified name. Qualifiers or schema names that are enclosed
| in quotation marks are not folded to uppercase. Qualifiers or
| schema names that are not enclosed in quotation marks are folded
| to uppercase.

40 Command Reference
| ADD schemaLocation-URI-2
| Specifies the schema location URI of a related XML schema
| document, as it is referenced by this XML schema document either
| directly or indirectly.
COMPLETE
Indicates that there are no more XML schema documents to be
associated with this XML schema. Validation of the schema will be
performed, and if no errors are found the schema will be marked
as usable. Until XML schema registration is completed, the schema
is not visible to or usable in other SQL/XML commands.
WITH schema-properties-URI
Specifies the URI of a properties document to be associated with
this XML schema. The CLP supports only file:// based URI. A
schema properties document can only be specified when the XML
schema is also being completed.
ENABLE DECOMPOSITION
Indicates that this schema is to be used for the purpose of
decomposing XML documents. It can only be specified when the
XML schema is also being completed.
Example 1: Assume you want to register a simple schema referred as
EXAMPLE.TEST1 and make it available immediately. The schema is
″http://mycompany.com/prod/p1_1.xsd″, and is stored locally in
/u/temp. The command would be:
-REGISTER XMLSCHEMA http://mycompany.com/prod/p1_1.xsd
FROM file:///u/temp/p1_1.xsd AS EXAMPLE.TEST1 COMPLETE

Example 2: Assume you want to register a more complicated schema

consisting of multiple documents, and refer to it as ’PRODSCHEMA’ in
SQL/XML commands. The schema is ″http:// mycompany.com/prod/
cust.xsd″, and is stored locally in /u/temp. Three of the sub-documents,
stored locally in the same location and called ″cust1.xsd″ through
″cust3.xsd″, will be registered along with any additional properties that
you would like to store. The schema properties are stored locally in
/u/temp/CUSTPROP.XML. Do not finalize the schema at this time,
because there are more related schema documents that you will need to
add later on.Because the XML schema is not yet completed, you cannot
store the schema properties document in the catalogs yet. When the
schema is completed using the COMPLETE keyword in either the
COMPLETE XMLSCHEMA or ADD XMLSCHEMA DOCUMENT
commands, you will then be able to store the schema properties document.
-REGISTER XMLSCHEMA http://mycompany.com/prod/cust.xsd
FROM file:///u/temp/cust.xsd'
AS PRODSCHEMA WITH file:///u/temp/CUSTPROP.XML
ADD http://mycompany.com/prod/cust1.xsd
FROM file:///u/temp/cust1.xsd
ADD http://mycompany.com/prod/cust2.xsd
FROM file:///u/temp/cust2.xsd
ADD http://mycompany.com/prod/cust3.xsd
FROM file:///u/temp/cust3.xsd

Example 1: This example specifies that the XML document in

/u/gb/doc1.xml is to be decomposed according to the XSR registered
schema ’genbankschema’.
-DECOMPOSE XML DOCUMENT /u/gb/doc1.xml
XMLSCHEMA genbankschema

Chapter 9. Command Line Processor 41

 -REMOVE XMLSCHEMA
| Removes the previously registered XML schema.
|

|

REMOVE XMLSCHEMA relational-identifier


|

Option descriptions:
relational-identifier
Specifies the relational name given to an XML schema in a
previous REGISTER XMLSCHEMA command.
| The schema of the relational identifier must be SYSXSR. If you
| specify a qualified name, the qualifier must be SYSXSR; for
| example, SYSXSR.MYSCHEMA. If you specify an unqualified
| name, you need to execute the SQL statement SET SCHEMA="SYSXSR"
| before you execute the command. A name that is enclosed in
| quotation marks, such as ″SYSXSR.MYSCHEMA″, is considered as
| an unqualified name. Qualifiers or schema names that are enclosed
| in quotation marks are not folded to uppercase. Qualifiers or
| schema names that are not enclosed in quotation marks are folded
| to uppercase.
Example 1: This example specifies the removal of the previously registered
schema ’PRODSCHEMA’.
-REMOVE XMLSCHEMA PRODSCHEMA

Command line processor help commands

You can use the command line processor help commands in order to invoke
information or options from the command line processor. Below is the syntax you
| need to run these commands:
|

|



CLP PHRASE
OPTIONS
|

The following are examples of the help command:

Example 1: Displays all of the available command line processor commands.

Example 2: Displays information about the command line processor command that
starts with the keyword LIST.

? LIST

Example 3: Displays information about the command line processor command that
starts with the keywords, ″Update Command.″

42 Command Reference
? Update Command

Example 4: Displays information about all of the command line processor option
flags..

? OPTIONS

SQL statements for the command line processor

SQL statements allow you to work with stored data in your database. The
statements are applied against the database you are connected to. The command
line processor will support the following SQL statements:
v ALTER
v CALL
For more information about CALL statements, see DB2 Application
programming and SQL Part 6.
v CREATE
v DELETE
v DROP
v GRANT
v INSERT
v REVOKE
v SELECT
v UPDATE

Chapter 9. Command Line Processor 43

44 Command Reference
Part 3. DB2 and related commands
The DB2 command topics contain syntax diagrams, semantic descriptions, rules,
and usage examples of commands, organized alphabetically by command name.

© Copyright IBM Corp. 1983, 2009 45

46 Command Reference
 Chapter 10. -ACCESS DATABASE (DB2)
The DB2 command ACCESS DATABASE forces a physical open of a table space,
index space, or partition, or removes the GBP-dependent status for a table space,
index space, or partition. The MODE keyword specifies the desired state.

| This command is also available in conversion mode.

Abbreviation: -ACC

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 48
v “Option descriptions” on page 48
v “Examples” on page 49

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS® terminal, or a program using
the instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v STARTDB privilege
v DBMAINT authority
v DBCTRL authority
v DBADM authority
v SYSCTRL authority
v SYSADM authority
When you are using a privilege set that does not contain the STARTDB privilege
for a specified database, DB2 issues an error message and the ACCESS command
fails.

All specified databases with the STARTDB privilege included in the privilege set of
the process are started.

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

When data definition control is active, installation SYSOPR or installation SYSADM

authority is required to start a database, a table space, or an index space containing
a registration table or index.

© Copyright IBM Corp. 1983, 2009 47

| Syntax
|

| ,
|


ACCESS DATABASE (  database-name )

|


| ,

SPACENAM(  space-name )MODE( open )

ngbpdep ,

PART(  integer )
integer1:integer2

Option descriptions

One of the following options is required.

| ( database-name , ...)
Specifies the names of the database, or database for the table spaces or index
spaces to access. If you use more than one name, separate names in the list by
commas.
SPACENAM( space-name , ...)
Indicates names of table spaces or indexes within the specified database to
access.
Abbreviation: SPACE, SP
space-name
Is the name of one or more table spaces or index spaces to access.
| You can write space-name like database-name to designate the name of a
| single table space or index space.
PART ( integer , ...)
Indicates the partition number of one or more partitions, within the
specified table space or index, that are to be accessed. The START or STOP
state of other partitions does not change.
The integer specified must identify a valid partition number for the
corresponding space name and database name. If you specify nonvalid
partition numbers, you receive an error message for each nonvalid number,
but all valid partitions that you specified are accessed.
integer can be written to designate one of the following specifications:
v A list of one or more partitions
v A range of all partition numbers that collate greater than or equal to
integer1 and less than or equal to integer2
v A combination of lists and ranges
PART is valid with partitioned table spaces, partitioned indexes, and
nonpartitioned type 2 indexes of partitioned table spaces. If you specify
PART with a nonpartitioned table space or index on a nonpartitioned table
space, you receive an error message, and the nonpartitioned space is not

48 Command Reference
 accessed. When a logical partition is accessed, the index is not closed. A
nonpartitioning index must be accessed without the use of PART to close
the index.
Mode (OPEN)
Forces the physical opening of the page set or partition on just the local
member. This moves the overhead of the physical open from an SQL thread to
the command thread. This improves the transaction rate for the first SQL
thread to reference a given page set or partition.
Mode (NGBPDEP)
Converts the specified page set or partition, non-disruptively to a non-group
buffer pool dependent. You should use this before running large batch
processes against a particular page set or partition to improve performance in a
data sharing environment. Only issue this command to the member on which
you plan to run the batch programs.

Examples

Example 1: Physically open partitions 1 and 3 of table space DSN9002 of database

DSN9001.
-ACCESS DATABASE(DSN9001) SPACENAM(DSN9002) PART(1,3) MODE(OPEN)

Example 2: Physically close the entire non-partitioned tablespace DSN9003 of

database DSN9001 and make it non-group bufferpool dependent.
-ACCESS DATABASE(DSN9001) SPACENAM(DSN9003) MODE(NGBPDEP)

Output similar to the following output indicates that the command completed
successfully:
-DSNTDDIS 'ACCESS DATABASE' NORMAL COMPLETION

Chapter 10. -ACCESS DATABASE (DB2) 49

50 Command Reference
Chapter 11. -ALTER BUFFERPOOL (DB2)
The DB2 command ALTER BUFFERPOOL alters attributes for active or inactive
buffer pools. Altered values are used until altered again.

Abbreviation: -ALT BPOOL

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 52
v “Option descriptions” on page 52
v “Usage notes” on page 54
v “Examples” on page 56

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS® terminal, or a program using
the instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 51

 Syntax

ALTER BUFFERPOOL (bpname)

VPSIZE(integer) VPSEQT(integer)

VPPSEQT(integer) VPXPSEQT(integer) DWQT(integer)

VDWQT(integer1,integer2) PGSTEAL( LRU )
FIFO

|


NO NO
PGFIX( YES ) AUTOSIZE( YES )

Option descriptions
( bpname )
Specifies the buffer pool to alter.
v 4-KB page buffer pools are named BP0 through BP49
v 8-KB page buffer pools are named BP8K0 through BP8K9
v 16-KB page buffer pools are named BP16K0 through BP16K9
v 32-KB page buffer pools are named BP32K through BP32K9
VPSIZE ( integer )
Changes the buffer pool size.
integer specifies the number of buffers to allocate to the active buffer pool.
| integer can range from 0 to 250000000 for 4-KB page buffer pools other than
| BP0. For BP0, the minimum value is 2000. For 8-KB page buffer pools, the
| range is from 1000 to 125000000. For 16-KB page buffer pools, the range is
| from 500 to 62500000. For 32-KB page buffer pools, the range is from 250 to
| 31250000.
DB2 limits the total VPSIZE for all buffer pools to 1 TB. In addition, DB2 limits
the amount of buffer pool storage to approximately twice the available real
storage for the z/OS image.
If you specify VPSIZE as 0 for an active buffer pool (other than BP0), DB2
quiesces all current database access and update activities for that buffer pool
and then deletes the buffer pool. Subsequent attempts to use table spaces or
indexes that are assigned to that buffer pool fail.
VPSEQT ( integer )
Changes the sequential steal threshold for the buffer pool.
integer specifies the sequential steal threshold for the buffer pool. This value is
expressed as a percentage of the total buffer pool size, and valid values range
from 0 to 100. This threshold affects the allocation of buffers in the buffer pool
to page read requests that are part of a sequential access pattern. This includes
pages being prefetched. If the number of buffers that contain sequentially
accessed pages exceeds the threshold, a sequential request attempts to reuse

52 Command Reference
 one of those buffers rather than a buffer that contains a non-sequentially
accessed page. The initial default value is 80.
When VPSEQT=0, sequentially accessed pages are not kept in the buffer pool
after being released by the accessing agent. Also, prefetch is disabled.
When VPSEQT=100, DB2 does not prefer reusing sequential buffers over using
non-sequential buffers.
VPPSEQT ( integer )
Changes the parallel sequential threshold for the buffer pool. This threshold
determines how much of the buffer pool is used for parallel processing
operations.
integer specifies the parallel sequential threshold for the buffer pool. This value
is expressed as a percentage of the sequential steal threshold, and valid values
range from 0 to 100. The initial default value is 50.
When VPPSEQT=0, parallel processing operations are disabled.
VPXPSEQT ( integer )
Changes the assisting parallel sequential threshold for the buffer pool. This
threshold determines the portion of the buffer pool that is used for processing
queries that originate on other members of the data sharing group. This option
is valid and effective only when DB2 is in data sharing mode; it is ignored
when DB2 is not in data sharing mode.
integer specifies the assisting parallel sequential threshold for the buffer pool.
integer is expressed as a percentage of the parallel sequential threshold
(VPPSEQT). Whenever the sequential steal threshold or the parallel sequential
threshold is altered, it directly affects the portion of buffer resources dedicated
to assistant parallel operations. The valid values range from 0 to 100. The
initial default value is 0.
When VPXPSEQT=0, this buffer pool cannot be used to assist another DB2
with parallel processing.
DWQT ( integer )
Changes the buffer pool’s deferred write threshold.
integer specifies the deferred write threshold for the buffer pool. This value is
expressed as a percentage of the total buffer pool size, and valid values range
from 0 to 90. This threshold determines when deferred writes begin, based on
the number of unavailable buffers. When the count of unavailable buffers
exceeds the threshold, deferred writes begin. The initial default value is 30
percent.
VDWQT ( integer1 , integer2 )
Changes the buffer pool’s vertical deferred write threshold.
integer1 specifies the vertical deferred write threshold for the buffer pool.
integer1 is expressed as a percentage of the total buffer pool size, and valid
values range from 0 to 90.
This threshold determines when deferred writes begin, based on the number of
updated pages for a given data set. Deferred writes begin for that data set
when the count of updated buffers for a data set exceeds the threshold. This
threshold can be overridden for page sets accessed by DB2 utilities and must
be less than or equal to the value specified for the DWQT option.
The default value is 5 percent. A value of 0 indicates that the deferred write of
32 pages begins when the updated buffer count for the data set reaches 40.

Chapter 11. -ALTER BUFFERPOOL (DB2) 53

 integer2 specifies the vertical deferred write threshold for the buffer pool.
integer2 is expressed as an absolute number of buffers. You can use integer2
when you want a relatively low threshold value for a large buffer pool, but
integer1 cannot provide a fine enough granularity between integer1 values of 0
and 1. integer2 only applies when integer1 is 0; DB2 ignores a value specified
for integer2 if the value specified for integer1 is non-zero. integer2 can range
from 0 to 9999. The default value is 0.
If integer1 is 0 and integer2 is a non-zero value, DB2 uses the value specified for
integer2 to determine the threshold. If both values are 0, the integer1 value of 0
is used as the threshold.
PGSTEAL
Specifies the page-stealing algorithm that DB2 uses for the buffer pool.
The initial default is PGSTEAL (LRU). However, when you issue the ALTER
BUFFERPOOL command, you must explicitly specify either LRU or FIFO when
the PGSTEAL option is used.
(LRU)
Specifies that the buffer pool buffers should be managed by using the least
recently used (LRU) algorithm.
(FIFO)
Specifies that the buffer pool buffers should be managed by using the
first-in-first-out (FIFO) algorithm.
PGFIX
Specifies whether the buffer pool should be fixed in real storage when it is
used.
(NO)
Specifies that the buffer pool is not fixed in real storage. Page buffers are
fixed and unfixed in real storage across each I/O and group buffer pool
operation.
This is the default.
(YES)
Specifies that the buffer pool is fixed in real storage. Page buffers are fixed
when they are first used after the buffer pool is allocated or expanded.
| AUTOSIZE
| Specifies whether the buffer pool adjustment is turned on or off.
| (NO)
| Specifies that the buffer pool does not use Workload Manager (WLM)
| services for automatic buffer pool sizing adjustment.
| This is the default.
| (YES)
| Specifies that the buffer pool uses WLM services, if available, to
| automatically adjust the size of the buffer pool based on dynamic
| monitoring of the workload goals and the available storage on the system.

Usage notes

The following description contains additional information about how to use the
ALTER BUFFERPOOL command.

54 Command Reference
Changing several buffer pool attributes: A failure in modifying one buffer pool
attribute has no effect on other modifications requested in the same command.

Insufficient virtual storage: If insufficient virtual storage is detected while

expanding a buffer pool, DB2 issues an error message, and the process terminates,
leaving the buffer pool with a smaller size than was requested.

Contracting an active buffer pool: If you use ALTER BUFFERPOOL to contract the
size of an active buffer pool, DB2 contracts the pool by marking active buffers as
″to be deleted,″ which means that they are not reusable to satisfy other page
requests. However, the virtual storage might not be freed immediately. A system
administrator can determine the status of the buffer pool by issuing the DISPLAY
BUFFERPOOL command.

Deleting an active buffer pool: If you use ALTER BUFFERPOOL to delete an active
buffer pool (by specifying 0 for VPSIZE), DB2 issues a message to indicate that it is
ready to explicitly delete this buffer pool. When DB2 accepts the delete buffer pool
request, the buffer pool is marked as ″delete pending″. All current access to the
buffer pool is quiesced, later access attempts fail with an error message, and all
open page sets that refer to the buffer pool are closed.

Altering attributes stored in the BSDS: The buffer pool attributes that are stored in
the BSDS cannot be changed offline.

Setting a buffer pool to be fixed in real storage: If you use the ALTER
BUFFERPOOL command with the PGFIX option set to YES to fix a buffer pool in
real storage, the change is pending and the buffer pool becomes fixed only at the
next allocation.

In order to fix the buffer pool in real storage, issue the command ALTER
BUFFERPOOL( bpname ) PGFIX(YES). If the buffer pool that you specify for bpname is
not currently allocated, the buffer pool will become fixed in real storage when it is
allocated. If the buffer pool that you specify for bpname is currently allocated, do
one of the following procedures to fix the buffer pool in real storage:
v If the buffer pool that you specify for bpname is not one of the buffer pools that
is used for the DB2 catalog and directory (BP0, BP8K0, BP16K0, or BP32K):
1. Issue the ALTER BUFFERPOOL command with the VPSIZE option set to 0 to
deallocate the buffer pool:
-ALTER BUFFERPOOL(bpname) VPSIZE(0)
2. Issue the ALTER BUFFERPOOL command with the VPSIZE and PGFIX
options to change the buffer pool size and to use long-term page fixing at the
next allocation:
-ALTER BUFFERPOOL(bpname) VPSIZE(vpsize) PGFIX(YES)
v If the buffer pool that you specify for bpname is one of the buffer pools that is
used for the DB2 catalog and directory (BP0, BP8K0, BP16K0, or BP32K):
1. Issue the ALTER BUFFERPOOL command with the PGFIX option to change
the buffer pool to use long-term page fixing (the change is pending until the
next allocation of the buffer pool):
-ALTER BUFFERPOOL(bpname) PGFIX(YES)
2. Issue the STOP DATABASE command or the STOP DB2 command to
deallocate the buffer pool
3. Issue the START DATABASE command or the START DB2 command to
reallocate the buffer pool (depending on which command you used to
deallocate the buffer pool)

Chapter 11. -ALTER BUFFERPOOL (DB2) 55

 Relating VPPSEQT and VPXPSEQT: The following table explains how the two
parallel sequential thresholds, VPPSEQT for parallel sequential and VPXPSEQT for
assisting parallel sequential threshold, are related. VPXPSEQT is a percentage of
VPPSEQT, which is itself a portion of VPSEQT. Multiply VPXPSEQT by VPPSEQT
to obtain the total amount of the buffer pool that can be used to assist another DB2
subsystem with parallel processing. In addition, VPPSEQT is affected by changing
VPSIZE and VPSEQT; therefore, VPXPSEQT is also affected by VPSIZE and
VPSEQT.
Table 4. Relationship between VPPSEQT and VPXPSEQT
The percentage of the buffer
pool available to assist
Sysplex query parallelism
If VPPSEQT is set to and VPXPSEQT is set to equals
50 50 25
50 100 50
100 50 50
any value 0 0
0 any value 0

Examples

Example 1: The following command sets the buffer pool for BP0 to 2000.
-ALTER BUFFERPOOL(BP0) VPSIZE(2000)

Example 2: The following command sets the sequential steal threshold of the buffer
pool for BP0 to 75 % of the buffer pool size.
-ALTER BUFFERPOOL(BP0) VPSEQT(75)

Example 3: The following command deletes BP1. Be very careful when using this
option because specifying a 0 size for an active buffer pool causes DB2 to quiesce
all current database access. All subsequent requests to open page sets fail.
-ALTER BUFFERPOOL(BP1) VPSIZE(0)

56 Command Reference
 Chapter 12. -ALTER GROUPBUFFERPOOL (DB2)
The DB2 command ALTER GROUPBUFFERPOOL alters attributes of group buffer
pools.

Abbreviation: -ALT GBPOOL

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions” on page 58
v “Usage notes” on page 59
v “Examples” on page 60

| Environment

| This command can be issued from a z/OS console, a DSN session under TSO, a
| DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
| instrumentation facility interface (IFI).

| Data sharing scope: Group

| Authorization

| To execute this command, you must use a privilege set of the process that includes
| one of the following authorities:
| v SYSOPR authority
| v SYSCTRL authority
| v SYSADM authority

| DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
| be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

ALTER GROUPBUFFERPOOL ( gbpname )

structure-name GBPCACHE( YES )
NO

AUTOREC( YES ) RATIO(ratio) CLASST(integer)
NO


GBPOOLT(integer) GBPCHKPT(integer)

© Copyright IBM Corp. 1983, 2009 57

 Option descriptions
( gbpname )
Specifies the DB2 group buffer pool to alter.
v 4-KB group buffer pools are named GBP0 through GBP49
v 8-KB group buffer pools are named GBP8K0 through GBP8K9
v 16-KB group buffer pools are named GBP16K0 through GBP16K9
v 32-KB group buffer pools are named GBP32K through GBP32K9
( structure-name )
Specifies the coupling facility structure for the group buffer pool. The coupling
facility structure name has the format, groupname _ gbpname .
groupname is the DB2 data sharing group name and the underscore (_)
separates groupname and gbpname .
GBPCACHE
Specifies whether gbpname is to be used for both caching data and
cross-invalidation, or just for cross-invalidation.
(YES)
Indicates that gbpname is used for caching data and cross-invalidation.
Any no-data-caching attribute that is specified at either the page set or
group buffer pool level takes precedence over a caching specification. The
following table illustrates the precedence of a no-data-caching specification.
Table 5. Precedence of a no-data-caching specification
Group buffer pool Attribute that takes
specification Page set specification precedence
GBPCACHE CHANGED
GBPCACHE(NO) GBPCACHE ALL GBPCACHE(NO)
GBPCACHE(YES) GBPCACHE NONE GBPCACHE NONE

(NO)
Indicates that gbpname is used only for cross-invalidation. This group
buffer pool contains no data entries. The GBPCACHE option of table
spaces or index spaces that use this group buffer pool is ignored.
AUTOREC
Specifies whether automatic recovery by DB2 takes place when a structure
failure occurs or when the connectivity of all members of the group to the
group buffer pool is lost.
(YES)
Enables DB2 to automatically recover page sets and partitions that have a
status of group buffer pool RECOVER pending (GRECP) and that have
pages on the logical page list.
(NO)
Disables automatic recovery. Issue a START DATABASE command to
recover page sets and partitions that have a status of GRECP or that have
pages on the logical page list.
RATIO ( ratio )
Changes the desired ratio of the number of directory entries to the number of
data pages in the group buffer pool; that is, how many directory entries exist
for each data page.

58 Command Reference
 ratio can be a decimal number from 1.0 to 255, inclusive. Any digits after the
first decimal place are ignored; for example, 5.67 is treated as 5.6. If ratio is
greater than 25, any digits after the decimal point are ignored; for example,
25.98 is treated as 25. The default ratio is 5.
The actual number of directory entries and data pages that are allocated
depends on the size of the coupling facility structure, which is specified in the
coupling facility policy definitions (CFRM policy).
CLASST ( integer )
Changes the threshold at which class castout is started. integer is expressed as a
percentage of the number of data entries; it can range from 0 to 90. The default
is 5 percent.
For example, CLASST(10) starts class castout when the number of pages in that
class equals 10 % of the group buffer pool page capacity.
GBPOOLT ( integer )
Changes the threshold at which data in the group buffer pool is cast out to
disk. integer is expressed as a percentage of the number of data entries and can
range from 0 to 90. The default is 30 percent.
For example, GBPOOLT(55) casts out data if the number of pages in the group
buffer pool equals 55 % of the group buffer pool page capacity.
GBPCHKPT ( integer )
Changes the time interval, in minutes, between successive checkpoints of the
group buffer pool. integer can range from 1 to 999999. Unless a value is
explicitly specified for the GBPCHKPT option, the default value is 4 minutes.
The more frequently checkpoints are taken, the less time it takes to recover the
group buffer pool if the coupling facility fails.

Usage notes

Defaults: Issuing the ALTER GROUPBUFFERPOOL command does not change any
option that is not explicitly specified; the default is to leave the value unchanged.
The following table lists the default values for the options when the command is
first issued for a group buffer pool or a structure.
Table 6. Default option values when ALTER GROUPBUFFERPOOL is first issued
Option Value
GBPCACHE YES
RATIO 5
CLASST 5 (%)
GBPOOLT 30 (%)
GBPCHKPT 4 (minutes)

When new values take effect: When you issue the ALTER GROUPBUFFERPOOL
command, some option specifications become effective only at the next allocation
of the group buffer pool. The following table lists each option, when the new value
takes effect, and if the option is applicable for a group buffer pool that is specified
as GBPCACHE(NO).

Chapter 12. -ALTER GROUPBUFFERPOOL (DB2) 59

 Table 7. Changing group buffer pool attributes
Applicable if
Keyword New value takes effect GBPCACHE(NO)?
GBPCACHE at next allocation N/A
AUTOREC immediately No
2 3
RATIO at next allocation No
3
CLASST immediately No
3
GBPOOLT immediately No
3
GBPCHKPT immediately No
Note:
1. You can use the z/OS command SETXCF START,REBUILD to have the change take
effect if the group buffer pool is not duplexed. If the group buffer pool is duplexed and
you want to change to GBPCACHE(NO), first go back to simplex mode and rebuild.
GBPCACHE(NO) is not allowed for duplexed group buffer pools.
2. You can use the z/OS command SETXCF START,REBUILD to have the change take
effect if the group buffer pool is not duplexed. If the group buffer pool is duplexed, first
go back to simplex mode and rebuild; then optionally go back to duplex mode. If a
group buffer pool is duplexed, both instances of that duplexed group buffer pool use the
same RATIO value.
3. DB2 issues message DSNB761 when you specify this option for a GBPCACHE(NO)
group buffer pool. These settings only take effect after the GBPCACHE attribute has
been changed to YES.

Examples

Example 1: For group buffer pool 0, change the ratio of directory entries to data
pages to one directory entry for every data page. The RATIO specification becomes
effective at the next allocation of the group buffer pool.
-DB1G ALTER GROUPBUFFERPOOL (GBP0) RATIO(1)

Example 2: For group buffer pool 2, change the class castout threshold to 10 % and
the group buffer pool castout threshold to 50 %. The new values take effect
immediately.
-DB1G ALTER GROUPBUFFERPOOL (GBP2) CLASST(10) GBPOOLT(50)

Example 3: Assume that the DB2 group name is DSNCAT. For group buffer pool 3,
change the class castout threshold to 10 %. The new value takes effect immediately.
Because the group name is DSNCAT, the coupling facility structure name is
DSNCAT_GBP3. Also, when a structure fails, the AUTOREC(YES) option enables
DB2 to automatically recover the page sets and partitions that are in a GRECP
status or that have pages on the logical page list.
-DB1G ALTER GROUPBUFFERPOOL (DSNCAT_GBP3) CLASST(10) AUTOREC(YES)

Example 4: For group buffer pool 32K, change the GBP checkpoint frequency to
five minutes. The new value takes effect immediately. In this example, with
AUTOREC(NO) specified, DB2 does not start automatic recovery when a structure
fails. You might choose this option if you want to determine what page sets or
partitions are in a GRECP status or have pages on the logical page list before you
enter the START DATABASE command to recover the data with the options you
specify.
-DB1G ALTER GROUPBUFFERPOOL (GBP32K) GBPCHKPT(5) AUTOREC(NO)

60 Command Reference
 Chapter 13. -ALTER UTILITY (DB2)
| The DB2 command ALTER UTILITY changes the values of certain parameters of an
| execution of the REORG utility that uses SHRLEVEL REFERENCE or CHANGE
| and the REBUILD utility that uses SHRLEVEL CHANGE.

Specifically, this command changes the values of DEADLINE, MAXRO,

LONGLOG, and DELAY.

| REBUILD and REORG can be altered only from the DB2 subsystem on which it is
| running.

Abbreviation: -ALT UTIL

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 62
v “Option descriptions” on page 62
v “Usage notes” on page 63
v “Example” on page 63

Environment

This command can be issued from a z/OS console, a DSN session, a DB2I panel
(DB2 COMMANDS), an IMS or a CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope : Member

Authorization

To execute this command, you must use the primary or some secondary
authorization ID of the process that originally submitted the utility job.
Alternatively, you must use a privilege set of the process that includes one of the
following authorities:
v DBMAINT authority
v DBCTRL authority
v DBADM authority
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

For users with DBMAINT, DBCTRL, or DBADM authority, the command takes
effect only when a user has sufficient authority over each object that the utility job
accesses.

© Copyright IBM Corp. 1983, 2009 61

 Syntax

|

ALTER UTILITY (utility-id) REBUILD

REORG DEADLINE( NONE )
timestamp


MAXRO( integer ) LONGLOG( CONTINUE ) DELAY(integer)
DEFER TERM
DRAIN

Option descriptions
( utility-id )
Is the utility identifier, or the UID parameter, used when creating the utility job
step.
| This job must execute REBUILD SHRLEVEL CHANGE, REORG with
| SHRLEVEL CHANGE, or SHRLEVEL REFERENCE.
If utility-id was created by the DSNU CLIST by default, it has the form
tso-userid.control-file-name .
If utility-id was created by default by the EXEC statement that executed
DSNUTILB, it has the form userid.jobname .
| REBUILD
| Specifies that a REBUILD SHRLEVEL CHANGE utility is being altered.
| REORG
| Specifies that a REORG SHRLEVEL REFERENCE or REORG SHRLEVEL
| CHANGE utility is being altered.
DEADLINE
Specifies the deadline by which the user wants the switch phase of
reorganization to start.
Only valid when altering a REORG SHRLEVEL REFERENCE or REORG
SHRLEVEL CHANGE utility.
If DB2 estimates that the switch phase will not start by the deadline, DB2
terminates reorganization. The default is the most recently specified value of
DEADLINE.
The pre-switch processing might continue until after the deadline.
( NONE )
Specifies that there is no deadline for the read-only iteration of log
processing.
( timestamp )
Specifies the deadline by which the user wants the switch phase to start
processing. This deadline must not have been reached when ALTER
UTILITY executes.
MAXRO
Specifies the maximum amount of time that is tolerated for the last iteration of
log processing during reorganization. During that iteration, applications have
read-only access.

62 Command Reference
 The actual execution time of the last iteration can exceed the value specified
for MAXRO.
( integer )
Specifies the number of seconds. The default is the most recently specified
value of MAXRO.
( DEFER )
Specifies that the log phase is deferred indefinitely.
LONGLOG
Specifies the action that DB2 performs (after sending the LONGLOG message
to the console) if the number of log records that are processed during the next
iteration is not sufficiently lower than the number of log records that were
processed during the previous iterations. The default is the most recently
specified value of LONGLOG.
( CONTINUE )
Specifies that DB2 continues the log phase.
( TERM )
Specifies that DB2 terminates the utility after the delay.
( DRAIN )
Specifies that DB2 drain the write claim class after the delay (if specified).
The number of log records, and thus the estimated time, for a future
iteration of log processing will be 0.
DELAY ( integer )
| Specifies a lower bound for the interval between the time when the utility
| sends the LONGLOG message to the console and the time when the utility
| performs the action specified by the LONGLOG parameter.
| integer is the delay in seconds. The value must be nonnegative. The default is
| the most recently specified value of DELAY.

Usage notes

| You can alter a REBUILD or REORG job only from the DB2 subsystem on which it
| is running.

Example

The following example alters the execution of the REORG utility for the utility job
step whose utility identifier is REORGEMP:
-ALTER UTILITY (REORGEMP) REORG MAXRO(240) LONGLOG(DRAIN)

The following list explains what each option does in the preceding example:
v MAXRO(240) changes the maximum tolerable time for the last iteration of log
processing to 240 seconds (4 minutes).
v LONGLOG(DRAIN) specifies that DB2 drain the write claim class (if reading of
the log during REORG is not catching up to the speed at which the application
is writing the log).
v DELAY is not specified so this example does not change the existing delay
between sending the LONGLOG message to the console and performing the
action specified by LONGLOG.
v DEADLINE is not specified so this example does not change the deadline (if
any) that was defined in the last iteration of log processing.

Chapter 13. -ALTER UTILITY (DB2) 63

64 Command Reference
Chapter 14. -ARCHIVE LOG (DB2)
The DB2 command ARCHIVE LOG enables a site to close a current active log and
open the next available log data set.

When issued without any options, the DB2 command ARCHIVE LOG performs the
following functions:
v Truncates the current active log data sets
v Starts an asynchronous task to offload the data sets
v Archives previous active log data sets not yet archived
v Returns control to the user (immediately)
In a data sharing environment, you can truncate and archive the logs for an
individual member or for all members in the group.

When specified with the option MODE(QUIESCE), the ARCHIVE LOG command
attempts to quiesce (suspend) all DB2 user update activity on the DB2 active log
prior to the offload process. When a system-wide point of consistency is reached
(that is, when all currently active update users have reached a commit point), the
active log is immediately truncated, and the offload process is initiated. The
resulting point of consistency is captured in the current active log before it is
off-loaded. In a data sharing environment, you can create a system-wide point of
consistency only for the entire group.

Abbreviation: -ARC LOG

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 66
v “Option descriptions” on page 66
v “Usage notes” on page 68
v “Examples” on page 69

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

The ARCHIVE LOG command can also be issued from the z/OS subsystem
interface (SSI) to enable automated scheduling systems and other programs to
execute the command via supervisor call instruction (SVC) 34.

Data sharing scope: Group or member, depending on whether you specify

MODE(QUIESCE), or on which SCOPE option you choose

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:

© Copyright IBM Corp. 1983, 2009 65

 v ARCHIVE privilege
v Installation SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

ARCHIVE LOG

MODE(QUIESCE)
TIME(nnn) NO
WAIT( )
YES
MEMBER
SCOPE( GROUP )
CANCEL OFFLOAD

Option descriptions
MODE(QUIESCE)
Halts all new update activity by the DB2 subsystem for a specified period of
time and attempts to bring all existing users to a point of consistency after a
commit or rollback. When a point of consistency is reached and captured in the
current active log data set, the current active log data set is truncated, and
another log data set in the inventory becomes current. Offload processing then
begins with the oldest active log data set and ends with the active log data set
that was truncated.
In a data sharing environment, before archiving logs of any member, this
option quiesces all active members of a data sharing group. MODE(QUIESCE)
also ensures that each inactive member had successfully quiesced its update
activity and resolved any indoubt units of recovery (URs) before the inactive
subsystem completed normal termination. If any DB2 subsystem is in a failed
state, fails during quiesce processing, or is stopped with outstanding URs, the
ARCHIVE LOG command fails, and the remaining active members allow
update activity to proceed.
If no indoubt URs exist on all quiesced members, active or inactive, the archive
operation can continue for active members in the group. Thus, you can archive
logs of a data sharing group normally without forcing all members to be
active. The current logs of inactive members are truncated and off-loaded after
they start.
If a system-wide point of consistency cannot be reached during the quiesce
period, which is a length of time you can specify, execution of the ARCHIVE
LOG command fails and an error message is issued. In a data sharing
environment, the maximum time period applies for the whole group, and if
any DB2 subsystem cannot quiesce within the time allowed, the command
fails.

66 Command Reference
 If there is no update activity on DB2 data when the command ARCHIVE LOG
MODE(QUIESCE) is issued, the active log is truncated and off-loaded
immediately.
TIME( nnn )
Specifies the maximum length of time, in seconds, in which the DB2
subsystem is allowed to attempt a full system quiesce.
If you do not specify a time, the default is the length of time specified in
the field QUIESCE PERIOD of installation panel DSNTIPA.
nnn can range from 001 to 999 seconds. You must allocate an appropriate
time period for the quiesce processing or the following events can occur:
v The quiesce processing can expire before a full quiesce is accomplished.
v An unnecessary DB2 lock contention can be imposed.
v A time-out can occur.
This option is valid only when used in conjunction with the option
MODE(QUIESCE).
WAIT
Specifies whether the DB2 subsystem should wait until the quiesce
processing has completed before returning control to the invoking console
or program, or should return control when the quiesce processing begins.
This option is valid only when used in conjunction with the option
MODE(QUIESCE).
( NO )
Specifies that control must be returned to the invoking program when
the quiesce processing begins.
If WAIT(NO) is used, quiesce processing is asynchronous to the user;
that is, you can issue additional DB2 commands after the ARCHIVE
LOG command returns control to you.
(YES)
Specifies that the quiesce processing must complete before returning
control to the invoking console or program.
If WAIT(YES) is used, quiesce processing is synchronous to the user;
that is, additional DB2 commands can be issued, but they are not
processed by the DB2 command processor until the ARCHIVE LOG
command is complete.
SCOPE
Specifies whether the command applies to the entire data sharing group or to a
single member only. The SCOPE option is valid only in a data sharing
environment; the option is ignored in a non-data-sharing environment. SCOPE
cannot be specified if MODE(QUIESCE) is specified; the two keywords are
mutually exclusive.
(MEMBER)
Initiates offload processing only for the member from which the command
is issued. User update activity is not suspended. If that member, or the
entire group, is already archiving, the command fails. This is the default,
except when MODE(QUIESCE) is specified.
(GROUP)
Initiates offload processing for every member of the DB2 group. User
update activity is not suspended. If any member of the group, or the entire
group, is already archiving, the command fails.

Chapter 14. -ARCHIVE LOG (DB2) 67

 CANCEL OFFLOAD
Cancels any off loading currently in progress and restarts the off-load process,
beginning with the oldest active log data set that has not been off loaded and
proceeding through all active log data sets that need off loading. Any
suspended off-load operations are restarted.

Usage notes

Remote site recovery: The ARCHIVE LOG command is very useful when
performing a DB2 backup in preparation for a remote site recovery. For example,
the command allows the DB2 subsystem to quiesce all users after a commit point,
and capture the resulting point of consistency in the current active log before the
archive is taken. Therefore, when the archive log is used with the most current
image copy (during an offsite recovery), the number of data inconsistencies will be
minimized.

Simultaneous executions: The ARCHIVE LOG command cannot be executed if

another ARCHIVE LOG command is in progress. Instead, error message DSNJ318I
is issued and the command fails. This is true in both data sharing and
non-data-sharing environments. For example, in a data sharing environment, the
command fails if the data sharing member, or group to which it belongs, is already
archiving.

Available active log space: ARCHIVE LOG cannot be used when the current active
log is the last available active log data set because of the following reasons:
v All available active log space would be used.
v The DB2 subsystem would halt processing until an offload is complete.

Executing ARCHIVE LOG while STOP DB2 is in progress: ARCHIVE LOG without
the option MODE(QUIESCE) is permitted when STOP DB2 MODE(QUIESCE) is in
progress. However, if an attempt is made to execute the ARCHIVE LOG command
when a STOP DB2 MODE(FORCE) is in progress, error message DSNJ315I is
issued and the ARCHIVE LOG command is not processed.

ARCHIVE LOG with the option MODE(QUIESCE) is not allowed when a STOP
DB2 MODE(FORCE) or STOP DB2 MODE(QUIESCE) is in progress. If an attempt
is made to run the ARCHIVE LOG command under these circumstances, error
message DSNJ315I or DSNJ316I is issued.

If the system was not fully quiesced (as determined by the number of users which
could not be quiesced), error message DSNJ317I is issued and ARCHIVE LOG
command processing is terminated. The current active log data set is not truncated
and switched to the next available active log data set, and the archive log is not
created.

Canceling log offloads: It is possible for the offload of an active log to be

suspended when something goes wrong with the offload process, such as a
problem with allocation or tape mounting. Issuing ARCHIVE LOG CANCEL
OFFLOAD interrupts the offload process and restarts the offload. The command
causes an abnormal termination of the offload task, which can result in a dump.
Use ARCHIVE LOG CANCEL OFFLOAD only if the offload task is no longer
functioning, or if you want to restart a previous offload attempt that failed.

68 Command Reference
Demand on DB2 resources: Using the option MODE(QUIESCE) during times of
peak activity or during periods in which time is critical causes a significant
disruption in the availability of DB2 for all users of DB2 resources.

Interaction with DISPLAY THREAD: The command DISPLAY THREAD issues

message DSNV400I, indicating that an ARCHIVE LOG MODE(QUIESCE)
command is active.

Quiescing members of a data sharing group: It is not possible to quiesce a single

member of a data sharing group. When MODE(QUIESCE) is specified in a data
sharing group, the entire group is quiesced.

Executing ARCHIVE LOG while logging is suspended: While logging is suspended

by SET LOG SUSPEND, do not use ARCHIVE LOG unless CANCEL OFFLOAD is
specified. If logging is suspended, issue SET LOG RESUME to resume logging
before issuing ARCHIVE LOG.

Examples
Example 1: Truncate the current active log data sets and initiate an asynchronous
job to offload the truncated data sets. No quiesce processing occurs.
-ARCHIVE LOG

Example 2: Initiate a quiesce period. If all DB2 update activity is stopped within
this period, truncate the current active log data set and switch to the next available
active log data set. Let the value in the field QUIESCE PERIOD of installation
panel DSNTIPA determine the length of the quiesce period. The MODE(QUIESCE)
processing is asynchronous.

If the DB2 subsystem can successfully block all update activity before the quiesce
period ends, it proceeds to the next processing step. If the quiesce time period is
insufficient to successfully quiesce the DB2 subsystem, the active log data sets are
not truncated and the archive does not occur.
-ARCHIVE LOG MODE(QUIESCE)

Example 3: Initiate a quiesce period. If all DB2 update activity is stopped within
this period, truncate the current active log data set and switch to the next available
active log data set. The maximum length of the quiesce processing period is seven
minutes (420 seconds) and the processing is synchronous for the entire seven
minutes.

If the DB2 subsystem can successfully block all update activity before the quiesce
period ends, it proceeds to the next processing step. If the quiesce time period is
insufficient to successfully quiesce the DB2 subsystem, the active log data sets are
not truncated and the archive does not occur.
-ARCHIVE LOG MODE(QUIESCE) WAIT(YES) TIME(420)

Example 4: In a data sharing environment, initiate a quiesce period for all members
of the data sharing group. If all DB2 update activity is stopped within this period,
truncate the current active log data set and switch to the next available active log
data set. Specify a quiesce time period of 10 minutes (600 seconds) to override the
value in the field QUIESCE PERIOD of installation panel DSNTIPA for member
DB1G. If the update activity has not quiesced after the 10 minute quiesce period,
the command fails and new update activity is allowed to proceed.
-DB1G ARCHIVE LOG MODE(QUIESCE) TIME(600)

Chapter 14. -ARCHIVE LOG (DB2) 69

 Example 5: In a data sharing environment, truncate the active log data sets for
group member DB2G and initiate an asynchronous job to offload the truncated
data sets, without any quiesce processing. In this example, SCOPE(MEMBER) is
used by default.
-DB2G ARCHIVE LOG

Example 6: In a data sharing environment, truncate the data sets for all members
of the data sharing group and initiate an asynchronous job to offload the truncated
data sets, without any quiesce processing.
-DB2G ARCHIVE LOG SCOPE(GROUP)

70 Command Reference
 Chapter 15. BIND PACKAGE (DSN)
The DSN subcommand BIND PACKAGE builds an application package. DB2
records the description of the package in the catalog tables and saves the prepared
package in the directory.

Environment

You can use BIND PACKAGE from DB2I, or from a DSN session under TSO that
runs in either the foreground or background.

Data sharing scope: Group

Authorization

The package owner must have authorization to execute all statements embedded
in the package for BIND PACKAGE to build a package without producing error
messages. (The SYSADM authority includes this authorization.) For
VALIDATE(BIND), DB2 verifies the authorization at bind time. For
VALIDATE(RUN), DB2 verifies the authorization initially at bind time, but if the
authorization check fails, DB2 rechecks it at run time.

The required authorization to add a new package or a new version of an existing

package depends on the value of field BIND NEW PACKAGE on installation panel
DSNTIPP. The default value is BINDADD.

| The package owner must be a role to execute BIND PACKAGE in a trusted context
| with role ownership. If performing a bind in a trusted context that has a
| role-as-object owner, then the owner of the package will be a role. If OWNER is
| specified, then it is assumed to be a role. If it is not specified, then the role of the
| binder becomes the owner.

The following table summarizes the required authorization to run BIND

PACKAGE, depending on the bind options that you specify, and in the case of the
ADD option, the value of field BIND NEW PACKAGE.

© Copyright IBM Corp. 1983, 2009 71

Table 8. Summary of privileges needed for BIND PACKAGE options
Installation panel field BIND NEW Authorization required to run BIND
Bind option PACKAGE PACKAGE
ADD, using the default owner or BINDADD The primary authorization ID (default
primary authorization ID owner) or role must have one of the
following to add a new package or
new version of an existing package to
a collection:
v The BINDADD system privilege
and either the CREATE IN
privilege or PACKADM authority
on the collection or on all
collections
v SYSADM or SYSCTRL authority
BIND The primary authorization ID (default
owner) or role must have one of the
following to add a new package or a
new version of an existing package to
a collection:
v The BINDADD system privilege
and either the CREATE IN
privilege or PACKADM authority
on the collection or on all
collections
v SYSADM or SYSCTRL authority
v PACKADM authority on the
collection or on all collections
v The BIND package privilege (can
only add a new version of an
existing package)

72 Command Reference
 Table 8. Summary of privileges needed for BIND PACKAGE options (continued)
Installation panel field BIND NEW Authorization required to run BIND
Bind option PACKAGE PACKAGE
ADD, specifying an OWNER other BINDADD If the binder does not have SYSADM
than the primary authorization ID (1, 2)
or SYSCTRL authority, the
authorization ID or role of the
OWNER must have one of the
following to add a new package or
new version of an existing package to
a collection:
v The BINDADD system privilege
and either the CREATE IN
privilege or PACKADM authority
on the collection or on all
collections
v SYSADM or SYSCTRL authority
The binder can also be a role.
BIND If the binder does not have SYSADM
or SYSCTRL authority, the
authorization ID or role of the
OWNER must have one of the
following to add a new package or
new version of an existing package to
a collection:
v The BINDADD system privilege
and either the CREATE IN
privilege or PACKADM authority
on the collection or on all
collections
v SYSADM or SYSCTRL authority
v PACKADM authority on the
collection or on all collections
v The BIND package privilege (can
only add a new version of an
existing package)
The binder can also be a role.
REPLACE, using the default owner or BINDADD or BIND Primary authorization ID or role must
primary authorization ID have one of the following:
v Ownership of the package
| v BIND privilege on the package. If
| the package does not exist, see the
| authorization that is required for
| ″ADD, using the default owner or
| primary authorization ID.″
v PACKADM authority on the
collection or on all collections
v SYSADM or SYSCTRL authority

Chapter 15. BIND PACKAGE (DSN) 73

 Table 8. Summary of privileges needed for BIND PACKAGE options (continued)
Installation panel field BIND NEW Authorization required to run BIND
Bind option PACKAGE PACKAGE
REPLACE, specifying an OWNER BINDADD or BIND If the binder does not have SYSADM
other than the primary authorization or SYSCTRL authority, the
ID (1, 2) authorization ID or role of the
OWNER must have one of the
following:
| v BIND privilege on the package. If
| the package does not exist, see the
| authorization that is required for
| ″ADD, specifying an OWNER other
| than the primary authorization ID.″
v PACKADM authority on the
collection or on all collections
v SYSADM or SYSCTRL authority
The binder can also be a role.
COPY BINDADD or BIND The primary or secondary
authorization ID or role of the binder
or OWNER must have one of the
following on the package being
copied:
v Ownership of the package
v COPY privilege on the package
v BINDAGENT privilege from the
owner of the package
v PACKADM authority on the
collection or on all collections
v SYSADM or SYSCTRL authority
Note:
1. If any of the authorization IDs of the process has the SYSADM authority or SYSCTRL authority, OWNER
authorization-id can be any value. If any of the authorization IDs has the BINDAGENT privilege granted from the
owner, then authorization-id can specify the grantor as OWNER. Otherwise, the OWNER authorization-id must be
one of the primary or secondary authorization IDs of the binder.
| 2. If you specify OWNER authorization-id , DB2 first checks if the OWNER has the necessary bind privilege. If the
| OWNER does not have the necessary bind privilege and if the IFCID 140 trace is active, the trace record is
| written. DB2 then checks if the binder has SYSCTRL or SYSADM authority. If the binder has the privilege, the
| BIND is successful.

74 Command Reference
| Syntax
|

|

BIND PACKAGE ( collection-id )

| location-name. OWNER ( authorization-id )

|
enable-block member-block

| QUALIFIER(qualifier-name) DEFER(PREPARE)
NODEFER(PREPARE)

|


| ACTION (REPLACE) NO
REPLVER(version-id) CURRENTDATA( YES )
(ADD)

|


| DRDA 1 DYNAMICRULES( RUN )
DBPROTOCOL( PRIVATE ) DEGREE( ANY ) BIND
DEFINEBIND
DEFINERUN
INVOKEBIND
INVOKERUN

|


| ENCODING( ASCII ) NO I
EBCDIC EXPLAIN( YES ) FLAG( W )
UNICODE E
ccsid C

|


| IMMEDWRITE( NO ) (1) NO
YES ISOLATION( CS ) KEEPDYNAMIC( YES )
RR
RS
UR
NC

(2) OPTHINT( ’hint-id’ ) ,
NONE
(3) PATH(  schema-name )
REOPT( ALWAYS ) USER
ONCE
AUTO

ROUNDING ( CEILING )

DOWN RELEASE( COMMIT ) NOPACKAGE
FLOOR DEALLOCATE SQLERROR( CONTINUE )
HALFDOWN
HALFEVEN
HALFUP
UP


RUN
VALIDATE( BIND )
|
Notes:
| 1 The default for a local package is the plan value. The default for a remote package is CS.

Chapter 15. BIND PACKAGE (DSN) 75

 2 NOREOPT(VARS) can be specified as a synonym of REOPT(NONE)
3 REOPT(VARS) can be specified as a synonym of REOPT(ALWAYS)

member-block:

MEMBER(dbrm-member-name)

LIBRARY(dbrm-pds-name)
COPY(collection-id.package-id)
COPYVER(version-id) COMPOSITE
OPTIONS( COMMAND )
DEPLOY(collection-id.package-id) COPYVER(version-id)

enable-block:


ENABLE(*)
,

ENABLE (  BATCH ) 
DISABLE DLIBATCH ,
DB2CALL
CICS DLIBATCH(  connection-name )
IMS ,
IMSBMP
IMSMPP CICS(  applid )
REMOTE ,
RRSAF
IMSBMP(  imsid )
,

IMSMPP(  imsid )
,

REMOTE(  location-name )
<luname>

Option descriptions

For descriptions of the options shown in the syntax diagram, see “Bind and rebind
options”.

Examples

Example 1: Replace version APRIL_VERSION of package TEST.DSN8BC81 at local

location USIBMSTODB22 with another version of the package. The new version (or
it could be the same) is in the DBRM DSN8BC81. If the DBRM contains no version
ID, the version ID of the package defaults to the empty string. The package runs
only from the TSO BATCH environment, and from the CICS environment if the
connection ID is CON1. The name PRODUCTN qualifies all unqualified table,
view, alias and index names.
76 Command Reference
BIND PACKAGE (USIBMSTODB22.TEST) -
MEMBER (DSN8BC81) -
ACTION (REPLACE) REPLVER (APRIL_VERSION) -
QUALIFIER (PRODUCTN) -
ENABLE (BATCH, CICS) CICS (CON1)

Example 2: UR isolation acquires almost no locks. It is fast and causes little

contention, but it reads uncommitted data. Do not use ISOLATION(UR) unless you
are sure that your applications and end users can accept the logically inconsistent
data that can occur, such as in the case of this example.

Assume that a supervisor routinely executes SQL statements using SPUFI to check
the status of parts as they go through the assembly process and to update a table
with the results of her inspection. She does not need to know the exact status of
the parts; a small margin of error is acceptable.

The supervisor queries the status of the parts from a production table called
ASSEMBLY-STATUS and makes the updates in a non-production table called
REPORTS. She uses the SPUFI option AUTOCOMMIT NO and has the habit of
leaving data on the screen while she performs other tasks.

If the supervisor executes a version of SPUFI that is bound with ISOLATION(UR),

the query for the status of the parts executes without acquiring locks using UR
isolation level and the update executes using CS isolation level. Thus, the query
does not inadvertently hold locks in the production table, which interferes with the
production jobs, and the supervisor has data good enough for her purposes.

The SPUFI application is bound as follows:

BIND PACKAGE(DSNESPUR) -
COPY(DSNESPCS.DSNESM68) -
ACTION(ADD) -
ISOLATION(UR)

Example 3: The following command creates a native SQL procedure named

CHICAGO.PRODUCTION.MYPROC from the current location procedure
TEST.MYPROC. Both native SQL procedures have the same version ABC. The
package for native SQL procedure CHICAGO.PRODUCTION.MYPROC.(ABC) has
XYZ as QUALIFIER.
CREATE PROCEDURE TEST.MYPROC LANGUAGE SQL VERSION ABC ...

BEGIN
...
END

BIND PACKAGE(CHICAGO.PRODUCTION) DEPLOY(TEST.MYPROC) COPYVER(ABC)

ACTION(ADD) QUALIFIER(XYZ)

The following command then replaces the native SQL procedure

CHICAGO.PRODUCTION.MYPROC version ABC, using the current location
native SQL procedure TEST.MYPROC version ABC.
BIND PACKAGE(CHICAGO.PRODUCTION) DEPLOY(TEST.MYPROC) COPYVER(ABC)
ACTION(REPLACE) REPLVER(ABC)

Chapter 15. BIND PACKAGE (DSN) 77

78 Command Reference
 Chapter 16. BIND PLAN (DSN)
The DSN subcommand BIND PLAN builds an application plan. All DB2 programs
require an application plan to allocate DB2 resources and support SQL requests
made at run time.

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 81
v “Option descriptions” on page 82
v “Examples” on page 82

Environment

You can use BIND PLAN through DB2I, or from a DSN session under TSO that
runs in either the foreground or background.

Data sharing scope: Group

Authorization

The plan owner must have authorization to execute all SQL statements embedded
in the plan for BIND PLAN to build a plan without producing error messages.
This excludes statements included in DBRMs that are bound to packages included
in the package list of the plan. The SYSADM authority includes this authorization.
For VALIDATE(BIND), DB2 verifies the authorization at bind time. For
VALIDATE(RUN), DB2 verifies the authorization initially at bind time, but if the
authorization check fails, DB2 rechecks it at run time.

| The plan owner must be a role to execute BIND PLAN in a trusted context with
| role ownership.

The following table explains the authorization required to run BIND PLAN,
depending on the options specified.
Table 9. Summary of privileges needed for BIND PLAN options
Option Authorization required to run BIND PLAN
ADD, using the Primary authorization ID (default owner) must have one of the
default owner or following:
primary v BINDADD privilege
authorization ID
v SYSADM or SYSCTRL authority
ADD, specifying an If the binder does not have SYSADM or SYSCTRL authority, the
OWNER other than authorization ID of the new OWNER must have one of the following:
the primary v BINDADD privilege
authorization ID
v SYSADM or SYSCTRL authority

© Copyright IBM Corp. 1983, 2009 79

 Table 9. Summary of privileges needed for BIND PLAN options (continued)
Option Authorization required to run BIND PLAN
REPLACE, using Primary authorization ID of the process must have one of the
the default owner following:
or primary v Ownership of the plan
authorization ID
| v BIND privilege on the plan. If the plan does not exist, see the
| authorization that is required for ″ADD, using the default owner or
| primary authorization ID.″
v SYSADM or SYSCTRL authority
REPLACE, If the binder does not have SYSADM or SYSCTRL authority, the
specifying an authorization ID of the OWNER must have one of the following:
OWNER other than v Ownership of the plan
the primary
| authorization ID
v BIND privilege on the plan. If the plan does not exist, see the
| authorization that is required for ″ADD, specifying an OWNER
| other than the primary authorization ID.″
v SYSADM or SYSCTRL authority
PKLIST, specifying Authorization ID of the process must include one of the following:
individual packages v EXECUTE authority on each package specified in the PKLIST
v PACKADM authority on specific collections that contain the
packages or on all collections
v SYSADM authority
PKLIST, specifying Authorization ID of the process must include one of the following:
(*), indicating all v EXECUTE authority on collection-id .*
packages in the
v PACKADM authority on specific collections that contain the
collection
packages or on all collections
v SYSADM authority

Specifying the OWNER for ADD and REPLACE: If any of the authorization IDs
of the process has SYSADM authority or SYSCTRL authority, OWNER
authorization-id can be any value. If any of the authorization IDs has the
BINDAGENT privilege granted from the owner, authorization-id can specify the
grantor as OWNER. Otherwise, OWNER authorization-id must be one of the
primary or secondary authorization IDs of the binder.

| If you specify OWNER authorization-id , DB2 first checks if the OWNER has the
| necessary bind privilege. If the OWNER does not have the necessary bind privilege
| and if the IFCID 140 trace is active, the trace record is written. DB2 then checks the
| binder for SYSCTRL or SYSADM authority. If the binder has the privilege, the
| BIND is successful.

80 Command Reference
 Syntax

BIND PLAN enable-block member-block

PLAN(plan-name) OWNER(authorization-id) QUALIFIER(qualifier-name)

NODEFER(PREPARE)



DEFER(PREPARE) USE (REPLACE) CACHESIZE(decimal-value)
ACQUIRE( ALLOCATE ) RETAIN
ACTION (ADD)

NO CURRENTSERVER(location-name) DBPROTOCOL( DRDA ) 1
CURRENTDATA( YES ) PRIVATE DEGREE( ANY )

EXPLICIT RUN ENCODING( ASCII ) NO
DISCONNECT( AUTOMATIC ) DYNAMICRULES( BIND ) EBCDIC EXPLAIN( YES )
CONDITIONAL UNICODE
ccsid

|


I IMMEDWRITE( NO ) CS NO
FLAG( W ) YES ISOLATION( RR ) KEEPDYNAMIC( YES )
E RS
C UR

(1) OPTHINT( ’hint-id’ ) , COMMIT
NONE RELEASE( DEALLOCATE )
(2) PATH(  schema-name )
REOPT( ALWAYS ) USER
ONCE
AUTO

|


ROUNDING( CEILING ) DB2 RUN
DOWN SQLRULES( STD ) VALIDATE( BIND )
FLOOR
HALFDOWN
HALFEVEN
HALFUP
UP

Notes:
1 NOREOPT(VARS) can be specified as a synonym of REOPT(NONE)
2 REOPT(VARS) can be specified as a synonym of REOPT(ALWAYS)

enable-block:

Chapter 16. BIND PLAN (DSN) 81





,

ENABLE (  BATCH ) 
DISABLE DLIBATCH ,
DB2CALL
CICS DLIBATCH(  connection-name )
IMS ,
IMSBMP
IMSMPP CICS(  applid )
RRSAF ,
ENABLE(*)
IMSBMP(  imsid )
,

IMSMPP(  imsid )

member-block:

 MEMBER(  dbrm-member-name )

,

LIBRARY(  dbrm-pds-name )
,

PKLIST(  . collection-id . package-id )

location-name * *
*

Option descriptions

For descriptions of the options shown in the syntax diagram, see “Bind and rebind
options”.

Examples

Example 1: This subcommand creates a new plan called IMSONLY. The SQL
statements for the plan are in the DBRM member DSN8BC81. An ISOLATION
level of cursor stability (CS) provides maximum concurrency when you run the
plan, and protects database values only while the program uses them. DEPTM92
owns the plan, but PRODUCTN qualifies any unqualified table, view, index, and
alias names that are referenced in the DBRM.

A cache size of 0 indicates that users will not run the plan repeatedly. Caching the
names of users authorized to run the plan helps only when the same user runs the
plan repeatedly while it is in the EDM pool. Because this is not the case with this
plan, there is no need to reserve space in the EDM pool for a cache that the plan
does not use.

82 Command Reference
The option ENABLE(IMS) runs the plan only from an IMS environment (DLI
Batch, BMP and MPP). If you attempt to run the plan from another environment,
such as TSO Batch, the plan allocation fails.
BIND PLAN(IMSONLY) -
MEMBER(DSN8BC81) -
ACTION(ADD) -
ISOLATION(CS) -
OWNER(DEPTM92) -
QUALIFIER(PRODUCTN) -
CACHESIZE -
ENABLE(IMS)

Example 2: If the DBRM of plan IMSONLY in Example 1 contains both embedded

and dynamic SQL statements and you want to allow other users to run the plan,
you must grant the EXECUTE privilege on plan IMSONLY to those users’
authorization IDs. However, because the EXECUTE privilege on a plan is sufficient
authority to run embedded SQL statements in a DBRM but is not sufficient
authority to run dynamic SQL statements, you must also do one of the following:
v Use the SQL GRANT statement to grant the necessary privileges on the objects
(tables, views, aliases, and indexes) referenced in the dynamic SQL statements to
the users’ authorization IDs, or
v BIND the plan IMSONLY with the option DYNAMICRULES(BIND) as follows:
BIND PLAN(IMSONLY) -
MEMBER(DSN8BC81) -
ACTION(ADD) -
ISOLATION(CS) -
OWNER(DEPTM92) -
QUALIFIER(PRODUCTN) -
CACHESIZE(0) -
ENABLE(IMS) -
DYNAMICRULES(BIND)

To allow other users having only the EXECUTE privilege on a plan to run both the
embedded and dynamic SQL statements, you must bind that plan with the option
DYNAMICRULES(BIND). When DYNAMICRULES(BIND) is in effect for plan
IMSONLY:
v A single authorization ID, the authorization ID for DEPTM92, is used for
authorization checking of both the embedded and dynamic SQL statements in
the DBRM.
v PRODUCTN is the implicit qualifier of unqualified object names referenced in
both the embedded and dynamic SQL statements in the DBRM.

Example 3: This subcommand creates a new plan called CICSONLY. The plan
specifies an ISOLATION level of cursor stability (CS). DEPTM12 owns the plan,
but TESTSYS qualifies any unqualified table, view, index, and alias names
referenced in the DBRM. A cache size of 0 indicates that users will not run the plan
repeatedly.

The option ENABLE(CICS) CICS(CON1) runs the plan only from CICS VTAM®
node CON1 which is specified in the APPLID parameter of the CICS SIT table. If
you attempt to run the plan from another environment or from another CICS
VTAM® note, the run attempt fails.
BIND PLAN(CICSONLY) -
MEMBER(DSN8BC81) -
ACTION(ADD) -
ISOLATION(CS) -

Chapter 16. BIND PLAN (DSN) 83

 OWNER(DEPTM12) -
QUALIFIER(TESTSYS) -
CACHESIZE(0) -
ENABLE(CICS) CICS(CON1)

84 Command Reference
Chapter 17. BIND and REBIND options
There are several options you can use for binding or rebinding plans and packages.
Some of the options are common for both bind and rebind and for both plans and
packages.

Defaults: The default for an option is the value used if you omit the entire option.
A default of plan value for BIND PACKAGE means that the default is the same
as the value determined during the bind or rebind of the plan to which the
package is appended at run time.
A default of existing value for REBIND PLAN or REBIND PACKAGE means
that the default is the value that was determined during the previous bind or
rebind of the plan or package that you are rebinding.

Catalog records: The DB2 catalog records information about plans and packages,
chiefly in the tables SYSIBM.SYSPLAN and SYSIBM.SYSPACKAGE. The
descriptions of where the options record information omit the constant qualifier,
SYSIBM, of those table names.

For all other cases, the option descriptions note the specific defaults, which DB2
assigns at bind time. If a specific default value exists, that value is underlined.

The following BIND and REBIND options are listed in alphabetical order.

ACQUIRE
ACQUIRE ( USE ) On: BIND and REBIND PLAN
( ALLOCATE )

Determines whether to acquire resources for DBRMs specified in the MEMBER list
when the application first accesses them or when the plan is allocated. Local or
remote packages associated with the plan acquire their resources when the
application first accesses them.
( USE )
Acquires table space locks only when the application program bound to the
plan first uses them.
(ALLOCATE)
Acquires all table space locks when the plan is allocated. The value has no
effect on dynamic SQL statements, which always use ACQUIRE(USE).
If you use ACQUIRE(ALLOCATE), you must also use
RELEASE(DEALLOCATE). ACQUIRE(ALLOCATE) can increase the plan size,
because additional items become resident in the plan.

Defaults:
Process
Default value
BIND PLAN
USE

© Copyright IBM Corp. 1983, 2009 85

 BIND PACKAGE
N/A
REBIND PLAN
Existing value
REBIND PACKAGE
N/A

There is no ACQUIRE option for packages. A package always acquires resources

when it first uses them, as if you specified ACQUIRE(USE).

Catalog record: Column ACQUIRE of table SYSPLAN.

ACTION
ACTION ( REPLACE ) On: BIND PLAN and
( REPLACE ) REPLVER (BIND PACKAGE only) PACKAGE
( REPLACE ) RETAIN (BIND PLAN only)
( ADD )

Determines whether the object (plan or package) replaces an existing object with
the same name or is new.
( REPLACE )
The object replaces an existing one with the same identifier, and a new entry
replaces the old one in the catalog table SYSPLAN or SYSPACKAGE. If no
object with the given identifier already exists, the bind process creates the new
object and a new entry.
The authorization ID designated explicitly or implicitly by the option OWNER
becomes the owner of the new object. If that authorization ID is not the
previous owner, all grants of privileges for the object that the previous owner
issued change to name the new owner as the grantor.
If the bind fails, the old object and its entry remain.
For BIND PACKAGE: You cannot use REPLACE with a remote package
bound with either of the options ENABLE or DISABLE. The attempt causes the
bind to fail.
REPLVER ( version-id ) (For BIND PACKAGE only)
Replaces a specific version of the package, identified by version-id . If the
package with the specified version-id does not exist, the bind fails.
The default for version-id comes from the DBRM if you use the MEMBER
option on BIND, or from the COPYVER option if you use the COPY
option.
RETAIN (For BIND PLAN only)
Preserves EXECUTE privileges when you replace the plan. If ownership of
the plan changes, the new owner grants the privileges BIND and
EXECUTE to the previous owner.
RETAIN is not the default. If you do not specify .RETAIN, everyone but
the plan owner loses the EXECUTE privilege (but not the BIND privilege).
If plan ownership changes, the new owner grants the BIND privilege to
the previous owner.
( ADD )
Adds a new object, but does not replace an existing one. If the object name

86 Command Reference
 already exists in the catalog, the bind fails. If the bind fails for any reason, the
bind process does not produce a new package or plan and makes no entry in
the catalog.

Replacing a version of a package (REPLVER): This topic describes the effect of

ACTION(REPLACE) REPLVER in four situations. Here, DBRM1 is the member
name and A and B represent the names of two versions of the package. Suppose
you bind version A with this command:
BIND PACKAGE(COLL1) MEMBER(DBRM1) ACTION(REPLACE) REPLVER(B)
v If neither DBRM1, version A, nor version B exist in the DB2 catalog, the
command fails because version B is not in the catalog. No new package is
added.
v If DBRM1 and version B, but not version A, exist in the DB2 catalog, then
version A replaces version B. As a result, version A exists in the catalog, and
version B no longer exists in the catalog.
v If DBRM1 and version A exist in the catalog, but not version B, the command
fails because version B is not in the catalog. Version A continues to exist.
v If DBRM1 and both versions A and B exist in the catalog, the command fails
because version A already exists.

Defaults:
Process
Default value
BIND PLAN
REPLACE
BIND PACKAGE
REPLACE
REBIND PLAN
N/A
REBIND PACKAGE
N/A

Catalog record: Tables SYSPLAN or SYSPACKAGE.

CACHESIZE
CACHESIZE ( value of field PLAN AUTH CACHE ) On: BIND and REBIND PLAN
( decimal-value )

Determines the size (in bytes) of the authorization cache acquired in the EDM pool
for the plan. At run time, the authorization cache stores user IDs authorized to run.
Consulting the cache can avoid a catalog lookup for checking authorization to run
the plan.
decimal-value
The size of the cache can range from 0 to 4096. Nonzero values that are not
multiples of 256 round to the next highest multiple of 256. CACHESIZE(0)
specifies creating no cache when the plan runs.

Defaults:
Process
Default value

Chapter 17. BIND and REBIND options 87

 BIND PLAN
value of field PLAN AUTH CACHE on installation panel DSNTIPP, which
has a default of 0
BIND PACKAGE
N/A
REBIND PLAN
Existing value
REBIND PACKAGE
N/A

Catalog record: Column CACHESIZE of table SYSPLAN.

COPY
COPY ( collection-id.package-id ) On: BIND PACKAGE
( collection-id.package-id ) COPYVER

Determines that you are copying an existing package and names that package.
Copying the package recalculates the access paths in the copy.

To create a remote copy, this option copies SQL statements from a package at your
local server. Therefore, you must hold the COPY privilege or its equivalent at the
local server.
collection-id
The name of the collection that contains the package to copy, as listed in
column COLLID of catalog table SYSPACKAGE.
package-id
The name of the package to copy, as listed in column NAME of catalog table
SYSPACKAGE.
COPYVER ( version-id )
Determines the version of the package to copy. The default for version-id is the
empty string.

Restrictions:
v collection-id.package-id must identify a package on the local server.
v You cannot copy to a package in the same collection. If you make the copy on
the local server, collection-id. on the COPY option must not name the collection
used on the PACKAGE option.
| v DB2 uses the ISO format for output values unless the SQL statement explicitly
| specifies a different format. Input values can be specified in one of the standard
| formats, or in a format that is recognized by the server’s local date/time exit.

Defaults:
Process
Default value
BIND PLAN
N/A
BIND PACKAGE
None

88 Command Reference
 REBIND PLAN
N/A
REBIND PACKAGE
N/A

COPY has no default. If you do not use COPY, you must use MEMBER. You
cannot use both options.

The option values of the package copied (except the values of ENABLE, DISABLE,
OWNER, and QUALIFIER) become the defaults for binding the new package. You
can override a default by choosing a new value for an option on the BIND
PACKAGE command.

Copy packages to remote servers: To copy and bind packages from DB2 Version 9.1
for z/OS to some other server that does not support all the new BIND options in
Version 9.1, use the OPTIONS(COMMAND) option on BIND PACKAGE COPY.
Any options you do not explicitly specify on the BIND PACKAGE subcommand
are set to the server’s defaults. Using this option can prevent bind errors when you
bind and copy packages to servers other than DB2 Version 9.1 for z/OS.

| BIND PACKAGE for remote SQL: To execute SQL statements in the native SQL
| procedure after a CONNECT SQL statement or SQL statements that contain a
| three-part name from a remote server, you need a package at the target server. Use
| the BIND PACKAGE COPY command to specify the following:
| v Target location as the target site on the CONNECT/implicit DRDA SQL
| v Collection ID as the native SQL procedure’s schema
| v Package ID as the native SQL procedure’s name
| v COPYVER as the native SQL procedure’s version

| Example 1: To copy a version to a remote server using the CREATE PROCEDURE

| command, issue:
| CREATE PROCEDURE TEST.MYPROC LANGUAGE SQL VERSION ABC ...
| BEGIN
| ...
| CONNECT TO SAN_JOSE
| ...
| END
| BIND PACKAGE(SAN_JOSE.TEST) COPY(TEST.MYPROC) COPYVER(ABC) ACTION(ADD)

| BIND PACKAGE with SET CURRENT PACKAGESET and SET CURRENT

| PACKAGE PATH: To use the SQL statements SET CURRENT PACKAGESET and
| SET CURRENT PACKAGE PATH, you must use the BIND PACKAGE COPY
| command to specify the following:
| v Target collection ID as the target of the SQL statements
| v Source collection ID as the native SQL procedure’s schema
| v Package ID as the native SQL procedure’s name
| v COPYVER as the native SQL procedure’s version

| Example 2: To use the SQL statement SET CURRENT PACKAGESET with the
| BIND PACKAGE command , issue:
| CREATE PROCEDURE TEST.MYPROC LANGUAGE SQL VERSION ABC ...
| BEGIN
| ...
| SET CURRENT PACKAGESET = 'COLL2'

Chapter 17. BIND and REBIND options 89

| ...
| END
| BIND PACKAGE(COLL2) COPY(TEST.MYPROC) COPYVER(ABC)
| ACTION(ADD) QUALIFIER(XYZ)

| If you need to create a new copy because the native SQL procedure has changed
| and requires a regeneration, use the BIND COPY ACTION(REPLACE) command.

Catalog record: Column COPY of table SYSPACKAGE.

CURRENTDATA
CURRENTDATA ( NO ) On: BIND and REBIND PLAN
( YES ) and PACKAGE, REBIND
TRIGGER PACKAGE

Determines whether to require data currency for read-only and ambiguous cursors
when the isolation level of cursor stability is in effect. It also determines whether
block fetching can be used for distributed, ambiguous cursors.
( NO ) Specifies that currency is not required for read-only and ambiguous
cursors. Block fetching for distributed, ambiguous cursors is allowed.
If your application attempts to dynamically prepare and execute a DELETE
WHERE CURRENT OF statement against an ambiguous cursor, after that
cursor is opened, use of CURRENTDATA(NO) is not recommended. You
receive a negative SQLCODE if your application attempts a DELETE
WHERE CURRENT OF statement for any of the following cursors:
v A cursor that is using block fetching
v A cursor that is using query parallelism
v A cursor that is positioned on a row that is modified by this or another
application process
( YES )
Specifies that currency is required for read-only and ambiguous cursors.
DB2 acquires page or row locks to ensure data currency. Block fetching for
distributed, ambiguous cursors is inhibited.

Restriction for remote rebinds: You cannot use CURRENTDATA when rebinding a
package at a remote server. To change the value of CURRENTDATA, you can:
v Issue BIND REPLACE, remotely or locally.
v Free the package and issue BIND ADD, remotely or locally.
v Rebind the package locally at the location where the package resides.

Defaults:
Process
Default value
BIND PLAN
| NO
BIND PACKAGE
| NO
REBIND PLAN
Existing value

90 Command Reference
 REBIND PACKAGE
Existing value

Catalog record: Column DEFERPREP of table SYSPACKAGE and column

EXPREDICATE of table SYSPLAN.

DBPROTOCOL
DBPROTOCOL ( DRDA ) On: BIND and REBIND PLAN
( PRIVATE ) and PACKAGE

Specifies which protocol to use when connecting to a remote site that is identified
by a three-part name statement.

For DRDA, a package must be bound to each remote site that is referenced by a
three-part name statement. Specify DRDA to inform DB2 that the three-part name
statements in the plan or package are to be converted to DRDA protocol.

If you specify an option on the BIND PACKAGE command, DB2 uses that remote
access method for the package statements, regardless of the BIND PLAN option.
For remote bind, the default is the system default at the remote site.

If you specify an option on the BIND PLAN statement, that information is stored
in table SYSPLAN.
(DRDA)
DBPROTOCOL(DRDA) is passed on BIND PACKAGE, BIND PLAN, REBIND
PACKAGE, or REBIND PLAN invocation. This keyword is the default.
(PRIVATE)
| A warning is issued if you bind or rebind a package or plan with this
| keyword. An application that uses DB2 private protocol access cannot include
| SQL statements that were added to DB2 after Version 7. An application that
| uses DB2 private protocol access cannot include SQL statements that were
| added to DB2 after Version 7.

Defaults:
Process
Default value
BIND PLAN
DRDA
BIND PACKAGE
System default
REBIND PLAN
Value that was specified the last time the plan was bound
| REBIND PACKAGE
| Value that was specified the last time the package was bound

Catalog record: Column DBPROTOCOL of tables SYSPACKAGE and SYSPLAN.

NODEFER and DEFER

NODEFER(PREPARE) On: BIND and REBIND PLAN and
DEFER(PREPARE) PACKAGE

Chapter 17. BIND and REBIND options 91

 Determines whether to defer preparation for dynamic SQL statements that refer to
remote objects, or to prepare them immediately. If you defer preparation, the
dynamic statement prepares when DB2 first encounters a statement of the type
EXECUTE, OPEN, or DESCRIBE that refers to the dynamic statement.

For BIND and REBIND PACKAGE, if neither option is specified, and

REOPT(NONE) applies:
v For local bind the package inherits the plan’s option at run time.
v For remote bind the default is NODEFER(PREPARE) at the remote DB2 server.

| If you specify the bind option REOPT(ALWAYS), REOPT(AUTO), or

| REOPT(ONCE), DB2 sets the bind option DEFER(PREPARE) automatically.

You cannot use both DEFER(PREPARE) and NODEFER(PREPARE).

NODEFER(PREPARE)
Does not defer preparation.
DEFER(PREPARE)
Defers preparation.

| DEFER(PREPARE) and distributed processing: Specify the bind option

| DEFER(PREPARE) to improve performance, instead of NODEFER(PREPARE),
| when binding dynamic or static SQL for DB2 private protocol access and when
| binding dynamic SQL for DRDA access. DB2 does not prepare the dynamic SQL
| statement until that statement executes. (The exception to this situation is dynamic
| SELECT, which combines PREPARE and DESCRIBE, regardless of whether the
| DEFER(PREPARE) option is in effect.) When a dynamic SQL statement accesses
| remote data, the PREPARE and EXECUTE statements can be transmitted over the
| network together and processed at the remote location. Responses to both
| statements can be sent back to the local subsystem together. This reduces network
| traffic, which improves the performance of the dynamic SQL statement.

| For DB2 private protocol access, when a static SQL statement refers to a remote
| object, the transparent PREPARE statement and the EXECUTE statements are
| automatically combined and transmitted across the network together. The
| PREPARE statement is deferred only if you specify the bind option
| DEFER(PREPARE).

| PREPARE statements that contain INTO clauses are not deferred.

To defer the preparation of an SQL statement in an application, bind or rebind the

application with the option DEFER(PREPARE). This defers PREPARE messages for
SQL statements that refer to a remote object until either:
v The statement executes
v The application requests a description of the results of the statement

If you choose to defer PREPARE statements, after the EXECUTE or DESCRIBE

statement, you should code your application to handle any SQL error codes or
SQLSTATEs that the PREPARE statement might return. You can defer PREPARE
statements only if you specify the bind option DEFER(PREPARE).

Defaults:
Process
Default value
92 Command Reference
 BIND PLAN
NODEFER
BIND PACKAGE
Plan value
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

Catalog record: Column DEFERPREP of table SYSPLAN and column

DEFERPREPARE of table SYSPACKAGE.

DEGREE
DEGREE (1) On: BIND and REBIND PLAN
( ANY ) and PACKAGE

Determines whether to attempt to run a query using parallel processing to

maximize performance.

For plans, the value of DEGREE applies only to the DBRMs bound directly to the
plan (named in the MEMBER option on BIND PLAN), and has no affect on
PKLIST names. The value has no effect on dynamic SQL statements, which use the
value of the special register CURRENT DEGREE. The value of the special register
can be changed by executing the SET CURRENT DEGREE statement.
(1) Prohibits parallel processing.
( ANY )
Allows parallel processing.

Limitations: If you bind plans or packages using DEGREE=ANY, the space

required in the EDM pool could increase by 50%–70%.

Defaults:
Process
Default value
BIND PLAN
1
BIND PACKAGE
1
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

Catalog record: Column DEGREE of tables SYSPACKAGE and SYSPLAN.

| DEPLOY
|| DEPLOY (collection-id.package-id ) On: BIND PACKAGE
| COPYVER(version-id)
|

Chapter 17. BIND and REBIND options 93

| Deploys a native SQL procedure.

| Specify BIND PACKAGE DEPLOY COPYVER only when the target DB2 is a DB2
| for z/OS server. You can use the DSNTBIND or DSNACCTS procedure to submit
| this command from a remote requester environment.

| You can specify the target collection-id, QUALIFIER, ACTION, and OWNER
| options on the BIND PACKAGE DEPLOY command. If you specify any other bind
| option DB2 returns message DSNT215I. If you do not specify QUALIFIER and
| OWNER their default values are the authorization ID that issues the BIND
| DEPLOY command.

| Using DEPLOY with the ACTION option: If you specify ACTION(ADD) for a
| version that does not exist at the target location, DB2 creates or adds a new version
| of the native SQL procedure and its associated package while keeping the source
| native SQL procedure’s logic. DB2 adds a new version if a native SQL procedure
| with the same target name already exists.

| If you specify ACTION(REPLACE), DB2 replaces the version specified in

| COPYVER. If you specify REPLVER, the version ID must be the same as the
| COPYVER version ID or DB2 returns TSO error message, DSNE977E.

| Authorization:

| To issue a BIND DEPLOY ACTION(ADD) command, the following authorization is

| necessary:
| BINDADD and CREATEIN
| Necessary authorization if there is no native SQL procedure version and
| package at the target location.
| BINDADD and ALTERIN
| Necessary authorization if a native SQL procedure and its package with a
| different version ID already exist at the target location.

| To issue a BIND DEPLOY ACTION(REPLACE) command, the following

| authorization is necessary:
| BINDADD and CREATEIN
| Necessary authorization if the native SQL procedure and its package do
| not exist at the target location.
| BINDADD and ALTERIN
| Necessary authorization if the native SQL procedure and its package
| already exist at the target location.

| Defaults:
| Process
| Default value
| BIND PLAN
| N/A
| BIND PACKAGE
| None
| REBIND PLAN
| N/A

94 Command Reference
| REBIND PACKAGE
| N/A

| DEPLOY has no default. If you do not use DEPLOY, you must use MEMBER or
| COPY.

| Catalog record: Column TYPE of table SYSPACKAGE

DISCONNECT
DISCONNECT ( EXPLICIT ) On: BIND and REBIND PLAN
( AUTOMATIC )
( CONDITIONAL )

Determines which remote connections to destroy during commit operations. The

option applies to any application process that uses the plan and has remote
connections of any type. Regardless of the value of this option, a commit operation
destroys all connections in the release pending state. You can put a connection in
the release pending state using the SQL statement RELEASE.
( EXPLICIT )
Destroy only connections in the release pending state. This value allows you
maximum flexibility for controlling remote connections.
( AUTOMATIC )
Destroy all remote connections.
( CONDITIONAL )
Destroy all remote connections unless an open cursor defined as WITH HOLD
is associated with the connection.

Defaults:
Process
Default value
BIND PLAN
EXPLICIT
BIND PACKAGE
N/A
REBIND PLAN
Existing value
REBIND PACKAGE
N/A

Catalog record: Column DISCONNECT of table SYSPLAN.

DYNAMICRULES
DYNAMICRULES ( RUN ) On: BIND and REBIND
( BIND ) PLAN and PACKAGE
( DEFINEBIND ) (BIND and REBIND PACKAGE only)
( DEFINERUN ) (BIND and REBIND PACKAGE only)
( INVOKEBIND ) (BIND and REBIND PACKAGE only)
( INVOKERUN ) (BIND and REBIND PACKAGE only)

Chapter 17. BIND and REBIND options 95

 Determines what values apply at run time for the following dynamic SQL
attributes:
v The authorization ID that is used to check authorization
v The qualifier that is used for unqualified objects
v The source for application programming options that DB2 uses to parse and
semantically verify dynamic SQL statements
v Whether dynamic SQL statements can include GRANT, REVOKE, ALTER,
CREATE, DROP, and RENAME statements

In addition to the DYNAMICRULES value, the runtime environment of a package

controls how dynamic SQL statements behave at run time. The two possible
runtime environments are:
v The package runs as part of a stand-alone program
v The package runs as a stored procedure or user-defined function package, or
runs under a stored procedure or user-defined function

The combination of the DYNAMICRULES value and the runtime environment

determine the values for the dynamic SQL attributes. That set of attribute values is
called the dynamic SQL statement behavior. The four behaviors are:
v Run behavior
v Bind behavior
v Define behavior
v Invoke behavior

The following DYNAMICRULES option descriptions include a description of the

dynamic SQL statement behavior for each runtime environment. This information
is summarized in Table 10 on page 100.
( RUN )
Processes dynamic SQL statements using the standard attribute values for
dynamic SQL statements, which are collectively called run behavior:
v DB2 uses the authorization ID of the application process and the SQL
authorization ID (the value of the CURRENT SQLID special register) for
authorization checking of dynamic SQL statements.
| v DB2 uses the value of the CURRENT SCHEMA special register as the
| default schema of table, view, index, and alias names.
v Dynamic SQL statements use the values of application programming
options that were specified during installation. The installation option
USE FOR DYNAMICRULES has no effect.
v GRANT, REVOKE, CREATE, ALTER, DROP, and RENAME statements
can be executed dynamically.
( BIND )
Processes dynamic SQL statements using the following attribute values,
which are collectively called bind behavior:
v DB2 uses the authorization ID of the plan or package for authorization
checking of dynamic SQL statements.
| v Unqualified table, view, index, and alias names in dynamic SQL
| statements are implicitly qualified with value of the bind option
| QUALIFIER; if you do not specify QUALIFIER, DB2 uses the
| authorization ID of the plan or package owner as the default schema.
v The attribute values that are described in Common attribute values for
bind, define, and invoke behaviors.

96 Command Reference
| v If you are running a trusted context with a role, or when the owner is a
| role, DB2 uses the authorization ID of the owner of the package or plan
| for authorization checking of dynamic SQL statements. The same rules
| that are used to determine the authorization ID for static (embedded)
| statements are used for dynamic statements. DB2 uses the authorization
| ID of the owner of the package or plan for authorization checking of
| dynamic SQL statements. The privilege set is the privileges that are held
| by the authorization ID of the owner of the package or plan. The owner
| can also be a role. The identifier specified in the QUALIFIER option of
| the bind command that is used to bind the SQL statements is the
| implicit qualifier for all unqualified tables, views, aliases, indexes, and
| sequences. If this bind option was not used when the plan or package
| was created or last rebound, the implicit qualifier is the authorization ID
| of the owner of the plan or package. The owner can also be a role.
( DEFINEBIND )
Processes dynamic SQL statements using one of two behaviors, define
behavior or bind behavior.
When the package is run as or runs under a stored procedure or
user-defined function package, DB2 processes dynamic SQL statements
using define behavior, which consists of the following attribute values:
v DB2 uses the authorization ID of the user-defined function or stored
procedure owner for authorization checking of dynamic SQL statements
in the application package.
v The default qualifier for unqualified objects is the user-defined function
or stored procedure owner.
v The attribute values that are described in Common attribute values for
bind, define, and invoke behaviors.
| v If you are running a trusted context with a role, or when the owner is a
| role, then define behavior applies only if the dynamic SQL statement is
| in a package that is run as a stored procedure or user-defined function
| (or runs under a stored procedure or user-defined function package),
| and the package is bound with DYNAMICRULES (DEFINEBIND). DB2
| uses the authorization ID of the stored procedure or user-defined
| function owner for authorization checking of dynamic SQL statements in
| the application package. This can be a primary or secondary
| authorization ID or a role. In this case, the privilege set is the privileges
| that are held by the authorization ID of the stored procedure or
| user-defined function owner. This owner can be a primary or secondary
| authorization ID or a role. The authorization ID of the stored procedure
| or user-defined function owner is also the implicit qualifier for
| unqualified table, view, alias, index, and sequence names. The owner can
| also be a role.
When the package is run as a stand-alone program, DB2 processes
dynamic SQL statements using bind behavior, which is described in BIND
keyword.
( DEFINERUN )
Processes dynamic SQL statements using one of two behaviors, define
behavior or run behavior.
When the package is run as or runs under a stored procedure or
user-defined function package, dynamic SQL statements have define
behavior, which is described in DEFINEBIND keyword.

Chapter 17. BIND and REBIND options 97

 When the package is run as a stand-alone program, DB2 processes
dynamic SQL statements using run behavior, which is described in RUN
keyword.
| If you are running a trusted context with a role, or when the owner is a
| role, then define behavior applies only if the dynamic SQL statement is in
| a package that is run as a stored procedure or user-defined function (or
| runs under a stored procedure or user-defined function package), and the
| package is bound with DYNAMICRULES (DEFINERUN). DB2 uses the
| authorization ID of the stored procedure or user-defined function owner
| for authorization checking of dynamic SQL statements in the application
| package. This can be a primary or secondary authorization ID or a role. In
| this case, the privilege set is the privileges that are held by the
| authorization ID of the stored procedure or user-defined function owner.
| This owner can be a primary or secondary authorization ID or a role. The
| authorization ID of the stored procedure or user-defined function owner is
| also the implicit qualifier for unqualified table, view, alias, index, and
| sequence names. The owner can also be a role.
( INVOKEBIND )
Processes dynamic SQL statements using one of two behaviors, invoke
behavior or bind behavior.
When the package is run as or runs under a stored procedure or
user-defined function package, DB2 processes dynamic SQL statements
using invoke behavior, which consists of the following attribute values:
v DB2 uses the authorization ID of the user-defined function or stored
procedure invoker for authorization checking of dynamic SQL
statements in the application package.
If the invoker is the primary authorization ID of the process or the
CURRENT SQLID value, secondary authorization IDs are also checked if
they are needed for the required authorization. Otherwise, only one ID,
the ID of the invoker, is checked for the required authorization.
v The default qualifier for unqualified objects is the user-defined function
or stored procedure invoker.
v The attribute values that are described in Common attribute values for
bind, define, and invoke behaviors.
| v If you are running a trusted context with a role, or when the owner is a
| role, then invoke behavior applies only if the dynamic SQL statement is
| in a package that is run as a stored procedure or user-defined function
| (or runs under a stored procedure or user-defined function package),
| and the package was bound with DYNAMICRULES( INVOKEBIND).
| DB2 uses the authorization ID of the stored procedure or user-defined
| function invoker for authorization checking of dynamic SQL statements
| in the application package. The invoker can also be a role. The privilege
| set is the privileges that are held by the authorization ID of the stored
| procedure or user-defined function invoker. However, if the invoker is
| the primary authorization ID of the process or the CURRENT SQLID
| value, secondary authorization IDs are also checked along with the
| primary authorization ID’s role. Therefore, the privilege set is the union
| of the set of privileges held by each authorization ID of the process and
| the primary authorization ID’s role. The authorization ID of the stored
| procedure or user-defined function invoker is also the implicit qualifier
| for unqualified table, view, alias, index, and sequence names. The
| invoker can also be a role.

98 Command Reference
 When the package is run as a stand-alone program, DB2 processes
dynamic SQL statements using bind behavior, which is described in BIND
keyword.
( INVOKERUN )
Processes dynamic SQL statements using one of two behaviors, invoke
behavior or run behavior.
When the package is run as or runs under a stored procedure or
user-defined function package, DB2 processes dynamic SQL statements
using invoke behavior, which is described in INVOKEBIND keyword.
| If you are running a trusted context with a role, or when the owner is a
| role, then invoke behavior applies only if the dynamic SQL statement is in
| a package that is run as a stored procedure or user-defined function (or
| runs under a stored procedure or user-defined function package), and the
| package was bound with DYNAMICRULES( INVOKERUN). DB2 uses the
| authorization ID of the stored procedure or user-defined function invoker
| for authorization checking of dynamic SQL statements in the application
| package. The invoker can also be a role. The privilege set is the privileges
| that are held by the authorization ID of the stored procedure or
| user-defined function invoker. However, if the invoker is the primary
| authorization ID of the process or the CURRENT SQLID value, secondary
| authorization IDs are also checked along with the primary authorization
| ID’s role. Therefore, the privilege set is the union of the set of privileges
| held by each authorization ID of the process and the primary authorization
| ID’s role. The authorization ID of the stored procedure or user-defined
| function invoker is also the implicit qualifier for unqualified table, view,
| alias, index, and sequence names. The invoker can also be a role.
When the package is run as a stand-alone program, DB2 processes
dynamic SQL statements using run behavior, which is described in RUN
keyword.

Common attribute values for bind, define, and invoke behavior: The following
attribute values apply to dynamic SQL statements in plans or packages that have
bind, define, or invoke behavior:
v You can execute the statement SET CURRENT SQLID in a package or plan that
is bound with any DYNAMICRULES value. However, DB2 does not use the
value of CURRENT SQLID as the authorization ID for dynamic SQL statements.
DB2 always uses the value of CURRENT SQLID as the qualifier for the
EXPLAIN output and optimizer hints input PLAN_TABLE. (If the value of
CURRENT SQLID has an alias on PLAN_TABLE and has the appropriate
privileges, that PLAN_TABLE is populated.)
v If the value of installation option USE FOR DYNAMICRULES is YES, DB2 uses
the application programming default values that were specified during
installation to parse and semantically verify dynamic SQL statements. If the
value of USE for DYNAMICRULES is NO, DB2 uses the precompiler options to
parse and semantically verify dynamic SQL statements.
v GRANT, REVOKE, CREATE, ALTER, DROP, and RENAME statements cannot be
executed dynamically.

Remote DB2 servers: For a package that uses DRDA access, DB2 sends the
DYNAMICRULES option to the DB2 server at bind time.

Chapter 17. BIND and REBIND options 99

 For a plan or package that uses private protocol access, DB2 sends a
DYNAMICRULES value of BIND or RUN to the server at run time, using the
following rules:
v If the DYNAMICRULES value with which the package is bound is BIND,
DEFINEBIND, or INVOKEBIND, DB2 sends a value of BIND to the server.
v If the DYNAMICRULES value with which the package is bound is RUN,
DEFINERUN, or INVOKERUN, DB2 sends a value of RUN to the server.

The following table summarizes the dynamic SQL statement attribute values for
each behavior.
Table 10. Definitions of dynamic SQL statement behaviors
Value for bind Value for run Value for define Value for invoke
Dynamic SQL attribute behavior behavior behavior behavior
Authorization ID Package OWNER Current SQLID User-defined function Authorization ID of
or stored procedure invoker
owner
Default qualifier for Bind OWNER or Current SQLID User-defined function Authorization ID of
unqualified objects QUALIFIER value or stored procedure invoker
owner
CURRENT SQLID Initialized to Initialized to Initialized to primary Initialized to primary
primary authid. primary authid. authid. SET SQLID is authid. SET SQLID is
SET SQLID is SET SQLID is allowed. allowed.
allowed. allowed.
Source for application As determined by Installation panel As determined by the As determined by the
programming options the DSNHDECP DSNHDECP DSNHDECP DSNHDECP parameter
parameter application parameter DYNRULS DYNRULS
DYNRULS defaults
Can execute GRANT, No Yes No No
REVOKE, CREATE,
ALTER, DROP, RENAME?

ENABLE and DISABLE

ENABLE DISABLE ( *) On: BIND and REBIND
( BATCH ) PLAN and PACKAGE
( CICS )
( CICS ) CICS ( applid , ...)
( DB2CALL )
( DLIBATCH )
( DLIBATCH ) DLIBATCH ( connection-name , ...)
( IMS )
( IMSBMP )
( IMSBMP ) IMSBMP ( imsid , ...)
( IMSMPP )
( IMSMPP ) IMSMPP ( imsid , ...)
( REMOTE ) (BIND and REBIND PACKAGE only)
( REMOTE ) REMOTE ( location-name ,..., < luname >,...)
( RRSAF )

Determines which connections can use the plan or package. You cannot use both
DISABLE and ENABLE. For packages, DISABLE and ENABLE are valid only for
local bind operations.

100 Command Reference

ENABLE
Lists the system connection types that can use the plan or package. Connection
types not listed cannot use it.
DISABLE
Lists the system connection types that cannot use the plan or package.
Connection types not listed can use it.

With some connection types you can list connection IDs to identify specific
connections of the type to disable or enable.
If you list connection IDs as disabled, any connections not listed for the same
connection type are enabled.
If you list connection IDs as enabled, any connections not listed for the same
connection type are disabled.

A connection ID is valid only after the keyword that names its corresponding
connection type.

Connection types:
(*)
Specifies all valid connection types. Use only with ENABLE.
( BATCH )
Indicates that all TSO connections are either enabled or disabled for the plan or
package.
( CICS )
Identifies the CICS Connection®. All CICS VTAM node names specified in the
CICS SIT table are either enabled or disabled for the plan or package.
( CICS ) CICS ( applid , ...)
Identifies the CICS VTAM node name specified in the APPLID parameter of
the CICS SIT table. The CICS VTAM node identified by applid is either enabled
or disabled for the plan or package.
( DB2CALL )
Indicates that the call attachment facility (CAF) connection is either enabled or
disabled for the plan or package.
( DLIBATCH )
Identifies the Data Language I (DL/I) Batch Support Facility connection. All
connection identifiers from the DDITV02 data set or the job name in the JCL
that the DL/I batch support system needs to have are either enabled or
disabled for the plan or package.
( DLIBATCH ) DLIBATCH ( connection-name , ...)
Specifies the connection identifier as from the DDITV02 data set or the job
name in the JCL that the DL/I batch support system needs to have. The DL/I
batch connection identified by connection-name is either enabled or disabled for
the plan or package.
( IMS )
Specifies that all Information Management System (IMS) connections,
DLIBATCH, IMSBMP, and IMSMPP are either enabled or disabled for the plan
or package.
( IMSBMP )
Specifies the IMS connection for the Batch Message Program (BMP) region. All
IMS BMP connections identified by the value of IMSID on the CTL parameter
EXEC are either enabled or disabled for the plan or package.

Chapter 17. BIND and REBIND options 101

 ( IMSBMP ) IMSBMP ( imsid , ...)
Specifies the value of IMSID on the CTL parameter EXEC. The IMS BMP
connection identified by imsid is either enabled or disabled for the plan or
package.
( IMSMPP )
Specifies the IMS connection for the Message Processing Program (MPP) and
IMS Fast Path (IFP) regions. All IMS MPP connections identified by the value
of the IMSID on the CTL parameter EXEC. are either enabled or disabled for
the plan or package.
( IMSMPP ) IMSMPP ( imsid , ...)
Specifies the value of IMSID on the CTL parameter EXEC. The IMS MPP
connection identified by imsid is either enabled or disabled for the plan or
package.
( REMOTE )
Indicates that all remote connections are either enabled or disabled for the plan
or package.
( REMOTE ) REMOTE ( location-name ,...,< luname >,...) (PACKAGE only)
Specifies that the remote connections identified by the following are either
enabled or disabled for the package:
location-name
Specifies the location name of a requesting DBMS that is a DB2 for z/OS
subsystem.
< luname >
Specifies the logical unit name, as defined to VTAM at the server location,
of a requesting DBMS that is not a DB2 for z/OS subsystem.
You must bracket a logical unit name with the less than (<) and the greater
than (>) characters to differentiate it from a location name.
( RRSAF )
Indicates that the RRS attachment facility connection is either enabled or
disabled for the plan or package.

Plans that disable a system: If a plan disables a system, then no packages

appended to that plan can run from that system, regardless of the
ENABLE/DISABLE options. However, if the same packages are appended to other
plans that enable the system, those packages can run from that system under those
plans.

Defaults:
Process
Default value
BIND PLAN
ENABLE(*)
BIND PACKAGE
ENABLE(*)
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

102 Command Reference

 Catalog record: Table SYSPKSYSTEM for packages and table SYSPLSYSTEM for
plans.

ENCODING
ENCODING ( ASCII )( EBCDIC )( UNICODE )( ccsid ) On: BIND and REBIND PLAN
and PACKAGE

| Specifies the application encoding for all host variables in static statements in the
| plan or package. EBCDIC is the only valid option for a plan or package that was
| precompiled on DB2 Version 6 or earlier. If you specify ccsid on any plan or
| package precompiled prior to Version 7, the value of ccsid must match the EBCDIC
| CCSID specified on the installation panel DSNTIPF (the SYSTEM EBCDIC CCSID).
| You can specify ASCII, UNICODE, or ccsid, where ccsid is a value other than the
| SYSTEM EBCDIC CCSID for any plan or package precompiled on Version 7 or
| later. You might select this option when a data source, such as a terminal emulator,
| uses a CCSID that is not the same as the SYSTEM EBCDIC CCSID. For example, a
| user has a terminal emulator with a CCSID of 1047, but the SYSTEM EBCDIC
| CCSID is 37. In this case, the plan or package being used by that user should be
| bound with ENCODING (1047).

ENCODING also affects the content of the data that is returned by the SQL
statement DESCRIBE. DB2 will return column names, label names, or both (if
requested) in the specified application encoding scheme.

Defaults: The default package application encoding scheme is not inherited from
the plan application encoding option. The default for a package that is bound on a
remote DB2 for z/OS system is the remote server’s default application encoding
scheme. Similarly, when a plan or package is run on a remote DB2 for z/OS server,
the specified ENCODING option is ignored. Instead, the remote server’s encoding
scheme is used.

| The following statements set the value of the host variable and do not require the
| package or DBRM to be bound into the plan:
SET CURRENT PACKAGE SET = :HV ,
SET :HV = CURRENT PACKAGE SET ,
SET :HV = CURRENT PACKAGE PATH ,
SET CURRENT PACKAGE PATH = :HV

| The host variable uses the system default application encoding scheme, even when
| the application is bound with the ENCODING (EBCDIC/UNICODE) bind option.
Process
Default value
BIND PLAN
The system default application encoding scheme that was specified at
installation time.
BIND PACKAGE
The system default application encoding scheme that was specified at
installation time.
| REBIND PLAN
| The value that was specified the last time that the plan was bound.
| REBIND PACKAGE
| The value that was specified the last time the package was bound.

Chapter 17. BIND and REBIND options 103

| Catalog record: Column ENCODING_CCSID of table SYSPLAN or SYSPACKAGE.
| For a MIXED=NO subsystem, the SBCS CCSID of the encoding scheme is stored in
| the catalog. For MIXED=YES subsystems, as well as default Unicode subsystems,
| the MIXED CCSID of the encoding scheme is stored in the catalog.

EXPLAIN

PSPI

EXPLAIN ( NO ) ( YES ) On BIND and REBIND PLAN and

PACKAGE, REBIND TRIGGER
PACKAGE

Obtains information about how SQL statements in the package, or in the member
list of the plan, are to execute. It inserts that information into the table owner
.PLAN_TABLE. Owner can be the authorization ID of the owner of the plan or
package. Alternatively, the authorization ID of the owner of the plan or package
can have an alias as owner .PLAN_TABLE that points to the base table,
PLAN_TABLE. Owner must also have the appropriate SELECT and INSERT
privileges on that table. This option does not obtain information for statements that
access remote objects.

PLAN_TABLE must have a base table and can have multiple aliases with the same
table name, PLAN_TABLE, but using different authids; it cannot be a view or a
synonym. It should exist before the bind process begins.

The EXPLAIN option also populates two optional tables, if they exist:
DSN_STATEMNT_TABLE and DSN_FUNCTION_TABLE.

DSN_STATEMNT_TABLE contains DB2’s estimate of the processing cost for an

SQL statement.

DSN_FUNCTION_TABLE contains information about function resolution.

You can get EXPLAIN output for a statement that is embedded in a program that
is bound with EXPLAIN(NO) by embedding the SQL statement EXPLAIN in the
program. Otherwise, the value of the EXPLAIN option applies to all explainable
SQL statements in the program, and to the fullselect portion of any DECLARE
CURSOR statements.

In all inserts to owner .PLAN_TABLE, the value of QUERYNO is the statement

number that the precompiler assigned and placed in the DBRM.

For automatic rebind: EXPLAIN(YES) is in effect if you bind the plan or package
with EXPLAIN(YES) and if the value of field EXPLAIN PROCESSING on
installation panel DSNTIPO is YES. If EXPLAIN(YES) and VALIDATE(BIND) are in
effect and PLAN_TABLE is not correct, the automatic rebind fails.
( NO ) Provides no EXPLAIN information.
( YES )
Inserts information in the tables populated by EXPLAIN. If owner
.PLAN_TABLE does not exist at bind time, the value of the option
VALIDATE determines the success of the bind operation.
v If the value is BIND, the bind fails.

104 Command Reference

 v If the value is RUN, DB2 checks to see if the table exists again at run
time. If it still does not exist, the plan or package cannot run. If it does
exist, DB2 inserts information in PLAN_TABLE before the plan or
package runs.
If neither or both of the optional tables DSN_FUNCTION_TABLE or
DSN_STATEMNT_TABLE exist, or if they are defined incorrectly, the bind
does not fail.

Invalidation resulting from an unsuccessful rebind: An unsuccessful rebind

generating a return code of greater than 4 invalidates the rebind object and rolls
back all changes to the object, leaving it as it was before the rebind attempt.
However, if the rebind fails because of either the REBIND option EXPLAIN or the
SQL statement EXPLAIN (that is, the PLAN_TABLE does not exist or was created
incorrectly), DB2 rolls back all changes to the object but does not invalidate the
object.

Defaults:
Process
Default value
BIND PLAN
NO
BIND PACKAGE
NO
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

Catalog record: Column EXPLAIN of table SYSPACKAGE and column EXPLAIN

of SYSPLAN.

PSPI

FLAG
FLAG ( I )( W )( E )( C ) On: BIND and REBIND PLAN
and PACKAGE, REBIND
TRIGGER PACKAGE

Determines what messages to display.

(I) All informational, warning, error, and completion messages
(W) Only warning, error, and completion messages
(E) Only error and completion messages
(C) Only completion messages

Rebinding multiple plans or packages: When your REBIND command contains

an asterisk (*) and affects many plans or packages, FLAG(E) is recommended to
avoid running out of message storage.

Defaults:

Chapter 17. BIND and REBIND options 105

 Process
Default value
BIND PLAN
I
BIND PACKAGE
I
REBIND PLAN
I
REBIND PACKAGE
I

IMMEDWRITE
IMMEDWRITE ( NO )( YES ) On: BIND and REBIND PLAN
and PACKAGE

Indicates whether immediate writes are to be done for updates that are made to
group buffer pool dependent page sets or partitions. This option is only applicable
for data sharing environments. The IMMEDWRITE subsystem parameter has no
effect on the IMMEDWRITE bind option at bind time. The following table shows
the implied hierarchy of this option as it affects run time. The IMMEDWRITE
option values are as follows:
( NO ) Specifies that normal write activity is done. Updated pages that are group
buffer pool dependent are written at or before phase one of commit or at
the end of abort for transactions that have rolled back.
( YES )
Specifies that updated pages that are group buffer pool dependent are
immediately written as soon as the buffer update completes. Updated
pages are written immediately even if the buffer is updated during
forward progress or during rollback of a transaction. Specifying this option
might impact performance.
Table 11. The implied hierarchy of the IMMEDWRITE option
IMMEDWRI subsystem
IMMEDWRITE bind option parameter Value at run time
NO NO NO
NO PH1 PH1
NO YES YES
PH1 NO PH1
PH1 PH1 PH1
PH1 YES YES
YES NO YES
YES PH1 YES
YES YES YES

Note: The NO and PH1 options are equivalent. The PH1 option is shown for
backward compatibility only.

106 Command Reference

 Performance hints: You can use IMMEDWRITE(PH2) and IMMEDWRITE(YES) for
situations where a transaction spawns another transaction that can run on another
DB2 member and that depends on uncommitted updates that were made by the
originating transaction.

Specify IMMEDWRITE(PH2) to cause group buffer pool dependent pages to be

written at or before phase 1 of commit.

Specify IMMEDWRITE(YES) to cause the originating transaction to immediately

write its updated GBP-dependent buffers (instead of waiting until the end of
commit or rollback), which will ensure that the dependent transaction always gets
the same results regardless of whether it runs on the same member or a different
member as the originating transaction. IMMEDWRITE(YES) should be used with
caution because of its potential impact to performance. The impact will be more
significant for plans and packages that do many buffer updates to GBP-dependent
pages, and not as noticeable for plans or packages that perform few buffer updates
to GBP-dependent pages. The following options can be considered as alternatives
to using IMMEDWRITE(YES):
v Always run the dependent transaction on the same DB2 member as the
originating transaction.
v Run the dependent transaction with ISOLATION(RR).
v Wait until the completion of phase two of commit before spawning the
dependent transaction.
v CURRENTDATA(YES) or ISOLATION(RS) can be used to solve the problem
only if the originating transaction updates columns that are not in the WHERE
clause of the dependent transaction.

Defaults:
Process
Default value
BIND PLAN
NO
BIND PACKAGE
NO
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

The default for a package on a remote DB2 server is IMMEDWRITE(NO).

ISOLATION
| ISOLATION ( CS )( RS )( RR )( UR )( NC ) On: BIND and REBIND PLAN
and PACKAGE, REBIND
TRIGGER PACKAGE

Determines how far to isolate an application from the effects of other running
applications.
| ( CS ) Cursor stability. Ensures, like repeatable read, that your application does not
read a row that another process changes until that process releases that

Chapter 17. BIND and REBIND options 107

 row. Unlike repeatable read, cursor stability does not prevent other
applications from changing rows that your application reads before your
program commits or terminates.
( RR ) Repeatable read. Ensures that:
v Your application does not read a row that another process has changed
until that process releases that row.
v Other processes do not change a row that your application reads until
your application commits or terminates.
( RS ) Read stability. Ensures that:
v Your application does not read a row that another process has changed
until that process releases that row.
v Other processes do not change a row that satisfies the application’s
search condition until your application commits or terminates. It does
allow other application processes to insert a row, or to change a row that
did not originally satisfy the search condition.
If the server does not support RS, it uses RR.
( UR ) Uncommitted read. Unlike repeatable read and cursor stability, does not
ensure anything. With the exception of LOB data, uncommitted read
avoids acquiring locks on data and allows:
v Other processes change any row your application reads during the unit
of work.
v Your application read any row that another process has changed, even if
the process has not committed the row.
You can use this option only with a read-only operation: SELECT, SELECT
INTO, or FETCH using a read-only cursor. If you specify ISOLATION(UR)
for any other operation, DB2 uses ISOLATION(CS) for that operation.
( NC ) No commit. Used on packages that are bound to certain servers other than
DB2 for z/OS. DB2 for z/OS does not support NC. If the server does not
support this isolation level, it uses UR.

Defaults:
Process
Default value
BIND PLAN
CS
BIND PACKAGE
| Plan value for a local server; CS for a remote server.
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

For REBIND PACKAGE, you cannot change ISOLATION from a specified value to
a default of the plan value by using REBIND PACKAGE. To do that, you must use
BIND PACKAGE ACTION(REPLACE).

Catalog record: Column ISOLATION of tables SYSPACKAGE and SYSPLAN.

108 Command Reference

 KEEPDYNAMIC
KEEPDYNAMIC ( NO )( YES ) On: BIND and REBIND PLAN
and PACKAGE

Determines whether DB2 keeps dynamic SQL statements after commit points.
( NO ) Specifies that DB2 does not keep dynamic SQL statements after commit
points.
( YES )
Specifies that DB2 keeps dynamic SQL statements after commit points.

If you specify KEEPDYNAMIC(YES), the application does not need to prepare an

SQL statement after every commit point. DB2 keeps the dynamic SQL statement
until one of the following occurs:
v The application process ends
v A rollback operation occurs.
v The application executes an explicit PREPARE statement with the same
statement identifier.

If you specify KEEPDYNAMIC(YES), and the prepared statement cache is active,

DB2 keeps a copy of the prepared statement in the cache. If the prepared statement
cache is not active, DB2 keeps only the SQL statement string past a commit point.
DB2 then implicitly prepares the SQL statement if the application executes an
OPEN, EXECUTE, or DESCRIBE operation for that statement.

If you specify KEEPDYNAMIC(YES), DDF server threads that are used to execute
KEEPDYNAMIC(YES) packages will remain active. Active DDF server threads are
subject to idle thread timeouts.

If you specify KEEPDYNAMIC(YES), you must not specify REOPT(ALWAYS).

KEEPDYNAMIC(YES) and REOPT(ALWAYS) are mutually exclusive. However,
you can use KEEPDYNAMIC(YES) with REOPT(ONCE).

Performance hint: KEEPDYNAMIC(YES) results in improved performance if your

DRDA client application uses a cursor defined WITH HOLD. DB2 automatically
closes a held cursor when there are no more rows to retrieve, which eliminates an
extra network message.

Defaults:
Process
Default value
BIND PLAN
NO
BIND PACKAGE
NO
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

The default for a package on a remote DB2 server is KEEPDYNAMIC(NO).

Chapter 17. BIND and REBIND options 109

 Catalog record: Column KEEPDYNAMIC of table SYSPLAN and SYSPACKAGE.

LIBRARY
LIBRARY ( dbrm-pds-name )( dbrm-pds-name , ...) (BIND PLAN only) On: BIND PLAN, BIND
PACKAGE

Determines what partitioned data sets (libraries) to search for the DBRMs listed in
the MEMBER option. The libraries must be cataloged.

The bind process searches for the libraries in the order that you list them. If the
libraries do not contain some DBRM listed in the MEMBER option, and if a JCL
statement exists for DBRMLIB DD, then the process searches for the member
among the libraries that the JCL statement describes.

dbrm-pds-name is the data set name of a library.

For BIND PACKAGE, you can specify only one library to search.

For BIND PLAN, you can specify one or more libraries to search.

Defaults:
Process
Default value
BIND PLAN
None
BIND PACKAGE
None
REBIND PLAN
N/A
REBIND PACKAGE
N/A

The default is to search only the libraries described by the DD statement for
DBRMLIB.

MEMBER
MEMBER ( dbrm-member-name )( dbrm-member-name , ...) (BIND PLAN On: BIND PLAN, BIND
only) PACKAGE

Determines what database request modules (DBRMs) to include in the plan or

package.
dbrm-member-name
Specifies the name of a library member that contains a DBRM. You can name
the partitioned data set, of which a DBRM is a member, either in the LIBRARY
option or in the JCL statement for DBRMLIB DD.
For BIND PACKAGE only, the name becomes the package name. Names
beginning with DSN are reserved; you receive a warning message if you use
one.

110 Command Reference

 For BIND PACKAGE, you can use only one member. If you do not use MEMBER,
you must use COPY. You cannot use both options.

For BIND PLAN, you can list many members. DB2 sorts the member list in
alphabetical order. If you do not use MEMBER, you must use PKLIST.

Defaults:
Process
Default value
BIND PLAN
None
BIND PACKAGE
None
REBIND PLAN
N/A
REBIND PACKAGE
N/A

Catalog record: Column NAME of table SYSPACKAGE for BIND PACKAGE, or

the table SYSDBRM for BIND PLAN.

OPTHINT
OPTHINT (’ hint-id ’) On: BIND and REBIND PLAN
and PACKAGE

Controls whether query optimization hints are used for static SQL.
(’ hint-id ’)
A character string of up to 128 characters in length, which is used by the
optimizer when searching the PLAN_TABLE for rows to use as input to
the optimizer. The delimiters can only be single quotation marks (’).
If ’ hint-id ’ contains all blank characters, DB2 does not use optimization
hints for static SQL statements.

| DB2 uses optimization hints only when optimization hints are enabled for your
| system. To enable optimization hints, specify YES in the OPTIMIZATION HINTS
| field of installation panel DSNTIP8.

Restriction: The PACKAGE does not inherit from the PLAN.

Defaults:
Process
Default value
BIND PLAN
All blanks, use normal optimization
BIND PACKAGE
All blanks, use normal optimization
REBIND PLAN
Existing value

Chapter 17. BIND and REBIND options 111

 REBIND PACKAGE
Existing value

The default for a package on a remote server is all blanks.

Catalog record: Column OPTHINT of tables SYSPLAN and SYSPACKAGE.

OPTIONS
OPTIONS (COMPOSITE) (COMMAND) On: BIND PACKAGE COPY

Specifies which bind options to use for the new package.

COMPOSITE
The options for the new package are what you specify on the BIND
PACKAGE COPY subcommand. Options that you do not specify are the
option values taken from the SYSPACKAGE catalog table row that
describes the source package that is to be copied. For a remote copy,
OPTIONS(COMPOSITE) is only valid if the remote DB2 subsystem is DB2
Version 9.1 for z/OS.
COMMAND
The options for the new package are what you specify on the BIND
PACKAGE COPY subcommand. Options that you do not specify are
determined as follows:
v For a local copy, the DB2-defined BIND PACKAGE options defaults are
used.
v For a remote copy, the server-defined BIND PACKAGE option defaults
are used at the server. You must use OPTIONS(COMMAND) when
copying to a down-level server or to a non-z/OS DB2 server. A
down-level server is any server that is not DB2 Version 9.1 for z/OS.

Defaults:
Process
Default value
BIND PACKAGE COPY
COMPOSITE

OWNER
OWNER ( authorization-id ) On: BIND and REBIND PLAN
and PACKAGE

Determines the authorization ID of the owner of the object (plan or package). The
owner must have the privileges required to execute the SQL statements contained
in the object.

If ownership changes, all grants for privileges on the object that the previous
owner issued change to name the new owner as the grantor. The new owner has
the privileges BIND and EXECUTE on the object and grants them to the previous
owner.

You can bind or rebind only the objects for which the authorization ID has bind
privileges. If you do not specify an authorization ID, the process rebinds only the
objects for which the primary ID has bind privileges.

112 Command Reference

| OWNER for BIND and REBIND in trusted context: When BIND and REBIND
| commands are issued in a trusted context that has the ROLE AS OBJECT OWNER
| clause, the owner is determined as follows:
| v If the OWNER option is not specified, the role associated with the binder
| becomes the owner.
| v If the OWNER option is specified, the role specified in the OWNER option
| becomes the owner. In a trusted context, the OWNER specified must be a role.
| For the bind to succeed, the binder needs BINDAGENT privilege from the role
| specified in the OWNER option. The binder also receives BINDAGENT
| privilege, if the role associated with the binder has BINDAGENT privilege.
| If the ROLE AS OBJECT OWNER clause is not in effect for the trusted context,
| then the current rules for BIND and REBIND ownership apply. If a role is
| associated in a trusted context, then the role privileges are included in the binder’s
| privilege set to determine if the binder is allowed to perform the bind.

For remote BIND or REBIND PACKAGE only, the value of OWNER is subject to
translation when sent to the remote system.

Defaults:
Process
Default value
BIND PLAN
Primary ID
BIND PACKAGE
Primary ID
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

The default owner is the primary authorization ID of the agent that runs the bind
process.

Catalog record: Column OWNER of table SYSPACKAGE, column GRANTOR of

table SYSPACKAUTH, and column CREATOR of table SYSPLAN.

PACKAGE
PACKAGE ( location-name.collection-id.package-id.(version-id) )( * ) (REBIND On: BIND and REBIND
PACKAGE only) PACKAGE

Determines what package or packages to bind or rebind.

You cannot use the BIND PACKAGE subcommand to:

v Bind a package with the same name as an existing trigger package
v Copy a trigger package

The following options identify the location, collection, package name, and version
of the package. You can identify a location and collection. For BIND, the DBRM

Chapter 17. BIND and REBIND options 113

 supplies the package ID and version ID if you use the option MEMBER, or those
IDs come from the option COPY. For REBIND, you must identify a package name,
and you can also supply a version ID.
location-name
The location of the DBMS where the package binds or rebinds and where the
description of the package resides. The location name must be defined in
catalog table SYSIBM.LOCATIONS. If that table does not exist or if the DBMS
is not in it, you receive an error message.
The default is the local DBMS.
collection-id or *
Specifies the collection to contain the package to bind, or that already contains
the package to rebind. There is no default.
For REBIND, you can use an asterisk (*) to rebind all local packages with the
specified package-id in all the collections for which you have bind privileges.
package-id or * (For REBIND only)
Specifies the name of the package to rebind, as listed in column NAME of
catalog table SYSPACKAGE. There is no default.
You can use an asterisk (*) to rebind all local packages in collection-id for which
you have bind privileges.
version-id or * (For REBIND only)
Specifies the version of the package to rebind, as listed in column VERSION of
catalog table SYSPACKAGE.
You can use an asterisk (*) to rebind all local versions of the specified
package-id in collection-id for which you have bind privileges.
Using simply () rebinds the version of the package that is identified by the
empty string.
If you omit version-id , the default depends on the how you specify package-id .
If you use * for package-id , then version-id defaults to *. If you explicitly
provide a value for package-id , then version-id defaults to the empty string
version.
DBRMs created in releases of DB2 before Version 2 Release 3 use a version-id of
the empty string by default.
( * ) (For REBIND only)
Rebinds all local DB2 packages for which the applicable authorization ID has
the BIND privilege. Specifying (*) is the same as specifying the package name
as (*.*.(*)) or (*.*). The applicable authorization ID is:
v The value of OWNER, if you use that option
v The primary authorization ID of the process running the bind, if you do not
use the option OWNER

Catalog record: Columns COLLID, NAME, and VERSION of table SYSPACKAGE.

PATH
PATH ( schema-name ) On: BIND and REBIND PLAN
( USER ) and PACKAGE
( schema-name , USER , ...)

114 Command Reference

Determines the SQL path that DB2 uses to resolve unqualified user-defined distinct
types, functions, and stored procedure names (in CALL statements).

For the PATH option, consider the following guidelines when you specify a
schema-name :
v The specified schema names are not folded to uppercase by DB2. This behavior
is different than that for schema names in SQL statements, which are folded to
uppercase before being stored in the catalog. If you do not specify these
nondelimited schema names in upper case, DB2 cannot find a match in the
catalog for those schema names.
v You can specify delimited identifiers in both mixed and uppercase characters.

The PATH keyword is mutually exclusive with the PATHDEFAULT keyword. Do

not specify both keywords in the same REBIND command.
( schema-name )
Identifies a schema.
DB2 does not validate that the specified schema actually exists at
precompile or at bind time.
You do not need to explicitly specify the SYSIBM, SYSFUN, and SYSPROC
schemas; DB2 implicitly assumes that these schemas are at the beginning
of the SQL path. DB2 adds these schemas in the order listed. If you do not
specify the SYSIBM, SYSFUN, and SYSPROC schemas, they are not
included in the 2048-byte length.
( schema-name , ...)
Identifies a list of schemas. The same schema name should not appear
more than once in the SQL path.
The number of schemas that you can specify is limited by the length of the
resulting SQL path, which cannot exceed 2048 bytes. To calculate the length
of the resulting SQL path:
1. Take the length of each schema.
2. Add 2 for delimiters around each schema-name in the list.
3. Add 1 for each comma after each schema. Do not add 1 for the last
schema.
USER
Represents a maximum 8-byte schema-name . At bind time, DB2 includes
this 8-byte length in the total length of the list of schema names specified
for the PATH bind option. The maximum length for a list of schema
names, including comma separators, delimiters, and the 8-byte USER
value, is 2048 bytes. If you exceed this limit, DB2 generates an error
message at bind time.
At run time, DB2 substitutes the run-time value of the USER special
register, which contains the primary authorization ID of the run-time
process, for the schema-name in the position of USER in the PATH
schema-name list.
If you specify USER in a list of schema names, do not use delimiters
around the USER keyword.

Defaults:
Process
Default value

Chapter 17. BIND and REBIND options 115

 BIND PLAN
“SYSIBM,” “SYSFUN,” “SYSPROC,” plan qualifier
BIND PACKAGE
“SYSIBM,” “SYSFUN,” “SYSPROC,” package qualifier
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

Although plan qualifier is the default value for BIND PLAN, it is not stored in the
catalog. Instead, the catalog value is blank. The catalog value is also blank for
package qualifier.

PATHDEFAULT
PATHDEFAULT On: REBIND PLAN and
PACKAGE

Resets the PATH for a package or plan to “SYSIBM,” “SYSFUN,” “SYSPROC,” or

plan qualifier or package qualifier .

The PATHDEFAULT keyword is mutually exclusive with the PATH keyword. Do

not specify both keywords in the same REBIND command.

Defaults:
Process
Default value
BIND PLAN
N/A
BIND PACKAGE
N/A
REBIND PLAN
None
REBIND PACKAGE
None

PKLIST and NOPKLIST

PKLIST NOPKLIST ( location-name.collection-id.package-id , ...) PKLIST only On: BIND and REBIND
PLAN

PKLIST determines what packages to include in the package list for the plan. The
order in which you list packages with partial identifiers determines the search
order at run time and can affect performance.

NOPKLIST is used with REBIND PLAN only. NOPKLIST determines that the plan
rebinds without a package list. If a package list already exists, NOPKLIST deletes
it.
location-name or *
Names the location of the DBMS where the package resides, or defers that

116 Command Reference

 choice until run time. Use either a particular location name or an asterisk ( * ),
or omit this part of the identifier. The default is the local DBMS.
v If you use a particular location name, then that DBMS should be defined in
catalog table SYSIBM.LOCATIONS. If that table does not exist or if the
DBMS is not in it, you receive warning messages.
v If you use an asterisk, at run time the location comes from the special
register CURRENT SERVER. DB2 checks privileges to use the SQL
statements in the package at that location.
collection-id or *
Names the collection that contains the package or defers that choice until run
time. Use either a particular collection ID or an asterisk ( * ). No default exists.
If you use an asterisk, then DB2 checks the privileges to use the SQL
statements that are embedded in the package at run time. At that time also,
DB2 determines the collection ID as follows:
v If the value in the special register CURRENT PACKAGESET is not blank,
then that value is the collection ID.
v If the value of CURRENT PACKAGESET is blank, DB2 skips the entry
unless it is the last entry in the package list. If it is the last or only entry, an
error message is issued.
package-id or *
Names a particular package or specifies, by the asterisk, all packages in the
collection. Because you cannot specify a version-id for the packages included in
the package list, all versions are effectively included.

Defaults:
Process
Default value
BIND PLAN
None
BIND PACKAGE
N/A
REBIND PLAN
Existing value
REBIND PACKAGE
N/A

PKLIST has no default; if you do not use PKLIST, you must use MEMBER.

The default for NOPKLIST is to use the package list specified in the PKLIST
option, if any, during the current or previous bind or rebind.

Catalog record: Table SYSPACKLIST.

PLAN
PLAN ( plan-name ) * (*) (REBIND PLAN only) On: BIND and
REBIND PLAN

Determines what plan or plans to bind or rebind.

Chapter 17. BIND and REBIND options 117

 ( plan-name )
Specifies the name of the application plan.
For REBIND only, the value of column NAME in the catalog table SYSPLAN;
you can use a list of plan names.
The default is to perform all bind functions, including error diagnostics,
without producing an application plan and without inserting rows into
PLAN_TABLE for the option EXPLAIN.
( * ) (For REBIND only)
Rebinds all plans for which the applicable authorization ID has the BIND
privilege. The applicable ID is:
v The value of OWNER, if you use that option
v The authorization ID of the process running the bind, if you do not use the
option OWNER

Catalog record: Column NAME of table SYSPLAN.

QUALIFIER
QUALIFIER ( qualifier-name ) On: BIND and REBIND PLAN
and PACKAGE

Determines the implicit qualifier for unqualified names of tables, views, indexes,
and aliases contained in the plan or package.
( qualifier-name )
Specifies the value of the implicit qualifier. This value is not subject to
translation when sent to a remote system for BIND or REBIND PACKAGE.

Defaults:
Process
Default value
BIND PLAN
Owner ID
BIND PACKAGE
Owner ID
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

The default is the owner’s authorization ID, whether you use the OWNER option
or its default.

Catalog record: Column QUALIFIER of tables SYSPACKAGE and SYSPLAN.

| PLANMGMT
|| PLANMGMT On: REBIND PACKAGE and
| REBIND TRIGGER PACKAGE
|

118 Command Reference

| Retains, during a rebind, all relevant package information (metadata, query text,
| dependencies, authorizations, access paths, and so on) in catalog tables and in the
| directory. In the event of a performance regression, you can direct DB2 to fall back
| to the older copy of a package. Over time, a package can have multiple copies that
| exist on the disk, but only one of those copies is the active or current copy. All
| other copies are inactive. The PLANMGMT option supports regular packages,
| non-native SQL procedures, external procedures, and trigger packages.

| This option is also available in conversion mode.

| ( OFF )
| Purge all on-disk and in-memory pieces of the current package copy from the
| catalog tables and directory.
| ( BASIC )
| Discard the previous copy of a package. The current copy becomes the
| previous copy, and the incoming copy becomes the current copy. If an original
| copy of a package already exists, it remains available.
| (EXTENDED)
| Discard the previous copy of a package. The current copy becomes the
| previous copy, and the original copy is managed as follows:
| v If no original copy exists, the current copy is cloned to become the original.
| v If an original copy exists, it is retained as the original.
| In each case, the incoming copy of a package becomes the new current copy.

| Behavior of a rebind operation with PLANMGMT (OFF): With

| PLANMGMT(OFF), DB2 normally only affects the current package copy. If any
| previous or original copies exist, they remain untouched. However, if you change
| any of the following REBIND options, all package copies (current, previous, and
| original) are purged:
| v OWNER
| v QUALIFIER
| v DBPROTOCOL
| v ENABLE
| v DISABLE
| v PATH
| v PATHDEFAULT
| v IMMEDWRITE

| Behavior of a rebind operation with PLANMGMT (BASIC) or PLANMGMT

| (EXTENDED): If you change any of the following options with PLANMGMT
| (BASIC) or PLANMGMT (EXTENDED), DB2 issues a DSNTI216I error message:
| v OWNER
| v QUALIFIER
| v DBPROTOCOL
| v ENABLE
| v DISABLE
| v PATH
| v PATHDEFAULT
| v IMMEDWRITE

Chapter 17. BIND and REBIND options 119

| Behavior of a rebind operation in which PLANMGMT is not specified: If the
| PLANMGMT option is not specified, the rebind operation takes the value from the
| subsystem parameter, PLANMGMT, in macro DSN6SPRM.

| Wildcards:PLANMGMT settings remain valid when wildcards (*) are used in the
| REBIND syntax. When you use REBIND PACKAGE to rebind more than one
| package, DB2 retains previous and original copies for each package separately.

| Defaults:
| Process
| Default value
| BIND PLAN
| N/A
| BIND PACKAGE
| N/A
| REBIND PLAN
| Existing value
| REBIND PACKAGE
| Existing value

| Catalog record: Column QUALIFIER of tables SYSPACKAGE and SYSPLAN.

RELEASE
RELEASE ( COMMIT ) On: BIND and REBIND PLAN
( DEALLOCATE ) and PACKAGE, REBIND
TRIGGER PACKAGE

Determines when to release resources that a program uses, either at each commit
point or when the program terminates.
( COMMIT )
Releases resources at each commit point.
(DEALLOCATE)
Releases resources only when the program terminates.
| RELEASE(DEALLOCATE) has no effect on packages that are run on a DB2
| server through a DRDA connection with a client system. The value also has no
| effect on dynamic SQL statements, which always use RELEASE(COMMIT),
| with one exception: When you use RELEASE(DEALLOCATE) and
| KEEPDYNAMIC(YES), and your subsystem is installed with YES for field
| CACHE DYNAMIC SQL on installation panel DSNTIP8, the
| RELEASE(DEALLOCATE) option is honored for dynamic SELECT, INSERT,
| UPDATE and DELETE statements.
Locks that are acquired for dynamic statements are held until one of the
following events occurs:
v The application process ends (deallocation).
v The application issues a PREPARE statement with the same statement
identifier. (Locks are released at the next commit point.)
v The statement is removed from the cache because it has not been used.
(Locks are released at the next commit point.)

120 Command Reference

 v An object that the statement is dependent on is dropped or altered, or a
privilege that the statement needs is revoked. (Locks are released at the next
commit point.)
RELEASE(DEALLOCATE) can increase the package or plan size, because
additional items become resident in the package or plan.

Defaults:
Process
Default value
BIND PLAN
COMMIT
BIND PACKAGE
Plan value
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

COMMIT is the default for a package that is bound at a remote server.

Catalog record: Column RELEASE of tables SYSPACKAGE and SYSPLAN.

REOPT
REOPT ( NONE ) On: BIND and REBIND PLAN and
PACKAGE
( ALWAYS )
( ONCE )
( AUTO )

Specifies whether to have DB2 determine an access path at run time by using the
values of host variables, parameter markers, and special registers.
(NONE)
Does not determine an access path at run time. You can use
NOREOPT(VARS) as a synonym for REOPT(NONE).
| (ALWAYS)
Determines the access path again at run time each time the statement is
run. DB2 determines access paths at both bind time and run time for
statements that contain one or more of the following variables:
v Host variables
v Parameter markers
v Special registers
At run time, DB2 uses the values in those variables to determine the access
paths. You can use REOPT(VARS) as a synonym for REOPT(ALWAYS).
(ONCE)
Determines the access path for any dynamic statement only once, at the
first run time or at the first time the statement is opened. This access path
is used until the prepared statement is invalidated or removed from the
dynamic statement cache and needs to be prepared again.
| (AUTO)
Autonomically determines if a new access path needs to be generated to
further optimize the performance for each execution. DB2 determines the

Chapter 17. BIND and REBIND options 121

 access path at the first run time and then at each subsequent execution,
DB2 evaluates whether a new access path is needed. If so, DB2 generates a
new access path and uses that access path until another new access path is
generated. For a cached dynamic statement referencing parameter markers,
a new path can be generated at any execution, based on how the
parameter marker value changes.
| If you specify the bind option REOPT(ALWAYS), REOPT(AUTO), or
| REOPT(ONCE), DB2 sets the bind option DEFER(PREPARE) automatically.
| However, when you specify REOPT(ONCE), DB2 determines the access
| path for a statement only once (at the first run time).

Usage notes:

You cannot use REOPT(ALWAYS) with the following options:

v REOPT(NONE)
v REOPT(ONCE)
v KEEPDYNAMIC(YES)

The following restrictions apply to REOPT(ONCE):

v REOPT(ONCE) is ignored if you use it with static SQL statements because DB2
for z/OS caches only dynamic statements.
v If a dynamic statement in a plan or package that is bound with REOPT(ONCE)
runs when dynamic statement caching is turned off, the statement runs as if
REOPT(ONCE) is not specified.
v You cannot use both REOPT(ONCE) and NODEFER(PREPARE).
v You can use both REOPT(ONCE) and KEEPDYNAMIC(YES).

Defaults:
Process
Default value
BIND PLAN
NONE
BIND PACKAGE
NONE
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

REOPT(NONE) is the default for a package that is bound on a remote DB2 server.

Catalog record: Column REOPTVAR of table SYSPLAN and SYSPACKAGE.

122 Command Reference

| ROUNDING
||| ROUNDING ( CEILING ) On: BIND and REBIND PLAN and
| PACKAGE
| ( DOWN )
| ( FLOOR )
| ( HALFDOWN )
| ( HALFEVEN )
| ( HALFUP )
| ( UP )
|

| Specifies the rounding mode at bind time. Use rounding mode to manipulate
| DECFLOAT data.
| CEILING
| Round toward +infinity. If all of the discarded digits are zero or if the sign
| is negative the result is unchanged other than the removal of discarded
| digits. Otherwise, the result coefficient should be incremented by 1 (round
| up).
| DOWN
| Round toward 0 (TRUNCATION). The discarded digits are ignored.
| FLOOR
| Round toward -infinity. If all of the discarded digits are zero or if the sign
| is positive the result is unchanged other than the removal of discarded
| digits. Otherwise, the sign is negative and the result coefficient should be
| incremented by 1.
| HALFDOWN
| Round to the nearest; if equidistant, round down. If the discarded digits
| represent greater than half (0.5) of the value of a one in the next left
| position then the result coefficient should be incremented by 1 (rounded
| up). Otherwise, (the discarded digits are 0.5) or less) the discarded digits
| are ignored.
| HALFEVEN
| Round to the nearest; if equidistant, round so that the final digit is even. If
| the discarded digits represent greater than half (0.5) the value of a one in
| the next left position then the result coefficient should be incremented by 1
| (rounded up). If they represent less than half, then the result coefficient is
| not adjusted (that is, the discarded digits are ignored). Otherwise, (they
| represent exactly half) the result coefficient is unaltered if its rightmost
| digit is even, or incremented by 1 (rounded up) if its rightmost digit is odd
| (to make an even digit).
| This option is the default.
| HALFUP
| Round to nearest; if equidistant, round up. If the discarded digits represent
| greater than or equal to half (0.5) of the value of a one in the next left
| position then the result coefficient should be incremented by 1 (rounded
| up). Otherwise, the discarded digits are ignored.
| UP Round away from 0. If all the discarded digits are zero the result is
| unchanged other than they removal of discarded digits. Otherwise, the
| result coefficient should be incremented by 1 (rounded up).

| The default value of ROUNDING option is DEF DECFLOAT ROUNDING MODE

| from the DECP.

| Defaults:

Chapter 17. BIND and REBIND options 123

| Process
| Default value
| BIND PLAN
| HALFEVEN
| BIND PACKAGE
| HALFEVEN
| REBIND PLAN
| Existing value
| REBIND PACKAGE
| Existing value

| Catalog record: Column ROUNDING of tables SYSPACKAGE and SYSPLAN, and

| column ROUNDING_MODE of table SYSENVIRONMENT.

SQLERROR
SQLERROR ( NOPACKAGE ) On: BIND PACKAGE only
( CONTINUE )

Determines whether to create a package if SQL errors occur.

( NOPACKAGE )
Creates no package if an error occurs.
(CONTINUE)
Creates a package, even if errors occur when binding SQL statements. The
statements in error cannot execute. Any attempt to execute them at run time
causes errors.

Defaults:
Process
Default value
BIND PLAN
N/A
BIND PACKAGE
NOPACKAGE
REBIND PLAN
N/A
REBIND PACKAGE
N/A

Because you cannot use the option SQLERROR for REBIND PACKAGE, the value
for the previous package remains in effect when you rebind that package. If you
rebind a package that uses SQLERROR(CONTINUE), those SQL statements found
in error at bind time do not rebind.

Catalog record: Column SQLERROR of table SYSPACKAGE.

SQLRULES
SQLRULES ( DB2 ) On: BIND and REBIND PLAN
( STD )

124 Command Reference

 Determines whether you can execute a type 2 CONNECT statement to an existing
SQL connection, according to DB2 rules. Alternatively, the statement causes an
error, according to the ANSI/ISO SQL standard of 1992. This option applies to any
application process that uses the plan and executes type 2 CONNECT statements.
It has no effect on type 1 CONNECT statements or the rules for DB2 private
protocol access.
( DB2 )
No error occurs if CONNECT identifies an existing SQL connection. If X is
an existing SQL connection, CONNECT TO X makes X the current
connection. If X is already the current connection, CONNECT TO X has no
effect on the state of any connections.
( STD )
An error occurs if CONNECT identifies an existing SQL connection.
Therefore, if X is a dormant SQL connection, you must use the SQL
statement SET CONNECTION to make X the current connection.

For local operations, the value of SQLRULES is used for the initial value of the
SQL special register CURRENT RULES.

Defaults:
Process
Default value
BIND PLAN
DB2
BIND PACKAGE
N/A
REBIND PLAN
Existing value
REBIND PACKAGE
N/A

Catalog record: Column SQLRULES of table SYSPLAN.

SWITCH
SWITCH ( PREVIOUS )( ORIGINAL ) On: REBIND PACKAGE, REBIND
TRIGGER PACKAGE

Restores all previous or original package information in the catalog tables and
directory to that of the specified package copy. This option allows you to fallback
to an older copy of a package in the event of a performance regression. You cannot
specify SWITCH with any other rebind options. If the package you specified does
not have the previous or original copy to switch to, DB2 will issue an error
message, and will then continue processing the rest of the list. Use this option with
wildcards (*) in the syntax.
( PREVIOUS )
Switches between the current and previous copies of a package. The
current copy takes the place of the previous copy, and the previous copy
takes the place of the current copy.

Chapter 17. BIND and REBIND options 125

 ( ORIGINAL )
Moves the current copy to take the place of the previous copy. Any
previous copy that exists is purged. The original copy is cloned to take the
place of the current copy.

Defaults:
Process
Default value
BIND PLAN
NO
BIND PACKAGE
NO
REBIND PLAN
Existing value
REBIND PACKAGE
Existing value

VALIDATE
VALIDATE ( RUN ) On: BIND and REBIND PLAN
( BIND ) and PACKAGE

Determines whether to recheck, at run time, errors of the type ″OBJECT NOT
FOUND″ and ″NOT AUTHORIZED″ found during bind or rebind. The option has
no effect if all objects and needed privileges exist.
( RUN )
Indicates that if not all objects or privileges exist at bind time, the process
issues warning messages, but the bind succeeds. DB2 checks existence and
authorization again at run time for SQL statements that failed those checks
during bind. The checks use the authorization ID of the plan or package
owner.
( BIND )
Indicates that if not all objects or needed privileges exist at bind time, the
process issues error messages, and does not bind or rebind the plan or
package, except that:
For BIND PACKAGE only, if you use the option
SQLERROR(CONTINUE), the bind succeeds, but the SQL statements in
it that have errors cannot execute.

Defaults:
Process
Default value
BIND PLAN
RUN
BIND PACKAGE
RUN
REBIND PLAN
Existing value

126 Command Reference

REBIND PACKAGE
Existing value

Catalog record: Column VALIDATE of tables SYSPACKAGE and SYSPLAN.

Chapter 17. BIND and REBIND options 127

128 Command Reference
 Chapter 18. -CANCEL THREAD (DB2)
The DB2 command CANCEL THREAD cancels processing for specific local or
distributed threads.

Abbreviation: -CAN THD

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage notes” on page 131
v “Examples” on page 133

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or a CICS terminal, or a program using
the instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

|

CANCEL THREAD(token)

DDF THREAD( luwid ) DUMP LOCAL NOBACKOUT
token

Option descriptions
THREAD ( token )
Identifies a specific thread, either distributed or not, whose processing you
want to cancel. DB2 assigns a token to each thread that is unique for that DB2
subsystem, but not necessarily unique across subsystems.

© Copyright IBM Corp. 1983, 2009 129

| The token is a one- to six-digit decimal number. You can determine what the
| token is by issuing the DB2 command DISPLAY THREAD or by using an IFI
| READS call for IFCID 0147 or 0148. The token can also appear after the equal
| sign in DB2 messages that display an LUWID. If the token is 0, then the thread
| of that token cannot be cancelled.
DDF THREAD( luwid )
Identifies distributed threads for which you want to cancel processing. luwid is
a logical unit of work identifier (LUWID), consisting of:
v A fully qualified LU network name, which consists of:
– A one- to eight-character network ID
– A period
– A one- to eight-character network LU name
v An LUW instance number, which consists of 12 hexadecimal characters that
uniquely identify the unit of work
If you enter three fields separated by periods, DB2 assumes that you are
entering an LUWID.
You might have two or more distributed threads with the same LUWID. All
distributed threads with the same LUWID are canceled.
The LUWID can be determined from the DB2 DISPLAY THREAD command
and other DB2 messages.
DUMP
Provides a dump for diagnostic purposes.
When you cancel a thread that is not currently active in DB2, DB2 performs a
hard cancel and no dump is provided. A thread is considered to be not
currently active in DB2 when it has left DB2 to perform application work.
| LOCAL
| Specifies that DB2 search the home address space of the allied agent for a
| thread that matches token. If DB2 finds a thread, it performs a soft cancel on
| that thread. The LOCAL option applies only to a CANCEL THREAD
| command that is issued through the IFI interface. The IFI application must run
| in the same address space as the thread that needs to be cancelled, and the
| thread must be connected to DB2 through the RRS attachment facility.
NOBACKOUT
Specifies that DB2 is not to attempt to back out the data during transaction
rollback processing. Canceling the thread with NOBACKOUT leaves objects in
an inconsistent state. Do not issue this command with NOBACKOUT unless
you have a plan to resolve the data inconsistency.
Multiple NOBACKOUT requests are allowed. However, if the thread is active
and the request is accepted, subsequent requests are ignored. You can choose
to issue a subsequent request if a request fails (as indicated by message
DSNI032I). Objects that the thread modifies are recovered (backed out). If back
out processing fails, the objects are marked REFRESH PENDING (REFP) and
either RECOVER PENDING (RECP) or REBUILD PENDING (RBDP or PSRBD)
in the database exception table. Resolve the REFP status of the object by
running the RECOVER utility to recover the object to a prior point in time or
by running LOAD REPLACE on the object.

130 Command Reference

 Usage notes

Canceling distributed threads: Canceling a distributed thread can cause the thread
to enter the indoubt state. Message DSNL450I is issued if the CANCEL command
causes the DDF thread to be converted from active to indoubt. DB2 releases the
resources that the thread holds when the indoubt state is resolved by automatic
indoubt resolution with the coordinator, or by resolution with the command
RECOVER INDOUBT.

If a thread that is specified in the command is part of a global transaction, the

command is executed against all threads in the global transaction.

The CANCEL command schedules a thread to be terminated in DB2. To terminate,

the thread must be processing within DB2. If the thread does not terminate, it
could be:
v Processing outside of DB2, possibly in the application. If that is the case, the
thread does not terminate until the application makes a request to DB2. Use the
z/OS CANCEL command to terminate the application immediately.
v Hung up in a network operation. Use VTAM or TCP/IP commands to cause the
network operation to return processing to DB2, which will then allow the thread
to be terminated. See the following topic for details.

| Canceling threads on applications that update NOT LOGGED tables spaces: Take
| care when you issue a CANCEL command for an application that updates a NOT
| LOGGED table space. The CANCEL THREAD command can cause the NOT
| LOGGED table space to be placed in the LPL, so that the table space must be
| recovered.

Canceling local threads: The CANCEL command schedules a thread to terminate.

Threads that are not in DB2 terminate immediately.

Using VTAM commands to cancel SNA distributed threads: If the CANCEL

command does not terminate a distributed thread, it is possible that it is hung up
in VTAM. Use the VTAM VARY NET,TERM command to cancel the thread’s
VTAM sessions.

To cancel a thread’s VTAM session, you need to know the VTAM session IDs
(SIDs) that correspond to the thread. Take the following steps:
1. Issue the DB2 command DISPLAY THREAD(*) LUWID(nnnn) DETAIL. (The
value of nnnn is the token or LUWID provided by CANCEL DDF THREAD.)
This gives you the VTAM session IDs that must be canceled. Sessions are
identified by the column header SESSID as shown in the following DISPLAY
THREAD output:
-DIS THD(*) LUWID(123) DETAIL
| DSNV401I - DISPLAY THREAD REPORT FOLLOWS:
| DSNV402I - ACTIVE THREADS:
| NAME ST A REQ ID AUTHID PLAN ASID TOKEN
| BATCH TR * 5 BKH2C SYSADM BKH2 000D 123
| V444-DB2NET.LUND0.C4B23F1F4D06=123 ACCESSING DATA AT
| ( 1)SAN JOSE-LUND1
| V447--INDEX SESSID A ST TIME
| V448--( 1) 00D3590EA1E89701 S1 0923816181452
| V448--( 1) 00D3590EA1E89822 N R1 0923816181584
| DISPLAY ACTIVE REPORT COMPLETE
| DSN9022I - DSNVDT '-DIS THD' NORMAL COMPLETION
| The N indicates the thread is processing in VTAM.

Chapter 18. -CANCEL THREAD (DB2) 131

 2. Record positions 3 through 16 of SESSID for the threads to be canceled. (In the
preceding DISPLAY THREAD output, the values are D3590EA1E89701 and
D3590EA1E89822.)
3. Issue the VTAM command DISPLAY NET to display the VTAM session IDs.
The ones you want to cancel match the SESSIDs in positions 3 through 16 and
the corresponding session IDs are in bold. The following is an output example
of this command:

D NET,ID=LUND0,SCOPE=ACT

IST097I DISPLAY ACCEPTED

IST075I NAME = LUND0, TYPE = APPL
IST486I STATUS= ACTIV, DESIRED STATE= ACTIV
IST171I ACTIVE SESSIONS = 0000000005, SESSION REQUESTS = 0000000000
IST206I SESSIONS:
IST634I NAME STATUS SID SEND RECV VR TP NETID
IST635I LUND1 ACTIV-S D24B171032B76E65 0051 0043 0 0 NET2
IST635I LUND1 ACTIV-S D24B171032B32545 0051 0043 0 0 NET2
IST635I LUND1 ACTIV-R D2D3590EA1E89701 0022 0031 0 0 NET2
IST635I LUND1 ACTIV-R D2D3590EA1E89802 0022 0031 0 0 NET2
IST635I LUND1 ACTIV-R D2D3590EA1E89822 0022 0031 0 0 NET2
IST314I END

4. Issue the VTAM command VARY NET,TERM for each of the VTAM SIDs
associated with the DB2 thread. In this case, you might need to cancel only the
session ID that DISPLAY THREAD shows to be processing in VTAM
(D2D3590EA1E89822).

Using TCP/IP Commands to Cancel TCP/IP Distributed Threads: If the CANCEL

command does not terminate a distributed thread, the thread might be hung up in
TCP/IP. Use the TCP/IP DROP command to cancel the thread’s connection ID. To
do this, you need to first determine the TCP/IP connection ID that corresponds to
the thread.

Depending on whether the thread is a DB2 requester or server thread, take the
following steps:
v Terminating TCP/IP connection for a requester thread:
1. Issue the DB2 command DISPLAY THREAD(*) LUWID(nnnn) DETAIL. (The
value of nnnn is the token or LUWID provided by CANCEL THREAD.)
Find the IP address and local port for the connection to the partner, as
shown in the following DISPLAY THREAD output:
| #display thread(*) detail
|
| DSNV401I # DISPLAY THREAD REPORT FOLLOWS -
| DSNV402I # ACTIVE THREADS -
| NAME ST A REQ ID AUTHID PLAN ASID TOKEN
| TEST0001 TR 4 CTHDCORID001 SYSADM DONSQL1 0027 19
| V444-USIBMSY.SYEC715B.C4B220851392=19 ACCESSING DATA AT
| ( 1)-STL714A-::FFFF:9.112.114.102..446
| V447--INDEX SESSID A ST TIME
| V448--( 1) 1028:446 N R2 0923814011448
| DISPLAY ACTIVE REPORT COMPLETE
| DSN9022I # DSNVDT '-DIS THD' NORMAL COMPLETION
| In this case, the partner’s IP address and port is 9.112.114.102 446, and the
| local port is 1028. N indicates that the thread is processing in TCP/IP.
2. Determine the associated TCP/IP connection ID:

132 Command Reference

 d tcpip,,netstat,conn,ipaddr=9.112.114.102

EZZ2500I NETSTAT CS V2R10 TCPIP

USER ID CONN LOCAL SOCKET FOREIGN SOCKET STATE
V71BDIST 0000049D 9.112.114.103..1028 9.112.114.102..446 ESTBLSH
1 OF 1 RECORDS DISPLAYED
3. Terminate the connection:
v tcpip,,drop,conn=0000049d

EZZ0060I PROCESSING COMMAND: VARY TCPIP,,DROP,

CONN=0000049D
EZZ0053I COMMAND VARY DROP COMPLETED SUCCESSFULLY
v Terminating TCP/IP connection for a server thread::
1. Issue the DB2 command DISPLAY THREAD(*) LUWID(nnnn) DETAIL. (The
value of nnnn is the token or LUWID provided by CANCEL THREAD.)
Find the IP address and local port for the connection to the partner, as
shown in the following DISPLAY THREAD output:
| !display thread(*) detail
|
| DSNV401I ! DISPLAY THREAD REPORT FOLLOWS -
| DSNV402I ! ACTIVE THREADS -
| NAME ST A REQ ID AUTHID PLAN ASID TOKEN
| TEST0001 RA * 2 CTHDCORID001 SYSADM DONSQL1 002D 11
| V445-USIBMSY.SYEC715B.C4B24232F81D=11 ACCESSING DATA FOR
| ( 1)::FFFF:9.112.114.103
| V447--INDEX SESSID A ST TIME
| V448--( 1) 446:1029 W R2 0923816315680
| DISPLAY ACTIVE REPORT COMPLETE
| DSN9022I ! DSNVDT '-DIS THD' NORMAL COMPLETION
In this case, the partner’s IP address is 9.112.114.103 and the local port is
1029.
2. Determine the associated TCP/IP connection ID:
d tcpip,,netstat,conn,ipaddr=9.112.114.103

EZZ2500I NETSTAT CS V2R8 TCPIP

USER ID CONN LOCAL SOCKET FOREIGN SOCKET STATE
V61ADIST 0000048E 9.112.114.102..446 9.112.114.103..1029 ESTABLS
1 OF 1 RECORDS DISPLAYED
Find the entry where the foreign socket shows the partner’s IP address and
port (9.112.114.103 1029) and note the CONN.
3. Terminate the connection:
v tcpip,,drop,conn=0000048e

EZZ0060I PROCESSING COMMAND: VARY TCPIP,,DROP,

CONN=0000048E
EZZ0053I COMMAND VARY DROP COMPLETED SUCCESSFULLY

Examples

Example 1: To cancel a non-distributed thread whose token you found through the
DISPLAY THREAD command and to produce a diagnostic dump, issue:
-CANCEL THREAD (123) DUMP

Example 2: To cancel a distributed thread whose LUWID you found through the
DISPLAY THREAD command, issue:
-CANCEL DDF THREAD (LUDALLAS.DB2SQL1.3042512B6425)

Chapter 18. -CANCEL THREAD (DB2) 133

 Assume that the output from -DISPLAY THREAD shows that the thread-ID and
token associated with this LUWID is 45162. You can also cancel this thread by
issuing either of the following commands:
-CANCEL DDF THREAD (45162)
-CANCEL THREAD (45162)

As in the first example, specifying DUMP with any of the commands shown in this
example causes a diagnostic dump to be produced.

134 Command Reference

Chapter 19. /CHANGE (IMS)
The IMS command /CHANGE resets an indoubt unit of recovery as identified by
the OASN keyword of the /DISPLAY command. That command deletes the item
from the standpoint of IMS, but it does not communicate to DB2.

Abbreviation: /CHA

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage note” on page 136
v “Examples” on page 136

Environment

This command can be issued only from an IMS terminal.

Data sharing scope: Member

Authorization

This command requires an appropriate level of IMS authority.

Syntax

/CHANGE SUBSYS  subsystem-name RESET


subsystem-name OASN schedule-number
ALL

Option descriptions
SUBSYS
Deletes IMS recovery elements from one or more subsystems. You must code
one of the following subparameters:
subsystem-name
Specifies one or more subsystems, separated by commas, from which
recovery elements will be deleted.
subsystem-name OASN schedule-number
Deletes one or more origin application schedule numbers, separated by
commas, from one subsystem, specified by subsystem-name .

© Copyright IBM Corp. 1983, 2009 135

 schedule-number can be a list of up to 32768 origin application schedule
numbers. The numbers are displayed using the OASN parameter of the
/DISPLAY command.
ALL
Deletes IMS recovery elements from all subsystems.
RESET
Deletes the indoubt recovery unit. The recovery unit represents an incomplete
unit of work assigned to an external subsystem as the result of an application
request.

Usage note

The preceding description of the /CHANGE command is a partial description

only. The complete description is documented in the IMS library.

Examples

Example 1: Reset all indoubt recovery units for subsystem DB2.

/CHA SUBSYS DB2 RESET

Example 2: Reset all indoubt recovery units for all subsystems.

/CHA SUBSYS ALL RESET

Example 3: Reset indoubt recovery units identified by OASN numbers 99, 685, and
2920 for subsystem DB2.
/CHA SUBSYS DB2 OASN 99 685 2920 RESET

136 Command Reference

Chapter 20. DCLGEN (DECLARATIONS GENERATOR) (DSN)
The declarations generator (DCLGEN) produces an SQL DECLARE TABLE
statement and a COBOL, PL/I, or C data declaration for a table or a view named
in the catalog.

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 138
v “Option descriptions” on page 138
v “Usage notes” on page 142
v “Examples” on page 144

Environment

The declarations generator is executed by the DSN subcommand DCLGEN. That

subcommand can be issued from a DSN session, running in either foreground or
background mode, or it can be issued through DB2I.

Data sharing scope: Group

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v Ownership of the table or view
v SELECT privilege on the table or view
v DBADM authority on the database containing the table
v SYSADM authority
v SYSCTRL authority (catalog tables only)

© Copyright IBM Corp. 1983, 2009 137

 Syntax

DCLGEN TABLE( table-name )

view-name OWNER(owner-name)

AT(location-name)

LIBRARY(library name )

(member-name) /password

ADD LANGUAGE( PLI ) NAMES(prefix)
ACTION( REPLACE ) C
IBMCOB
CPP

STRUCTURE(structure-name) APOST NO
QUOTE LABEL( YES )

DBCSSYMBOL( G ) YES
N DBCSDELIM( NO )

NO NO STD
COLSUFFIX( YES ) INDVAR( YES ) RMARGIN( WIDE )

|


NO
DCLBIT( YES )

Option descriptions
TABLE
Specifies the table or view for which a declaration is generated. table-name or
view-name is the qualified or unqualified name of the table or view.
The name must follow these rules:
v If the name is a single-byte or mixed string and contains special characters
other than underscores (_), it must be enclosed between apostrophes (’). If
the language is COBOL, single-byte underscores in the name are translated
into hyphens (-) by DCLGEN. Double-byte character set (DBCS) names need
not be enclosed in apostrophes.
v If the name contains single-byte apostrophes, each one must be doubled (’’).
(Some host languages do not permit apostrophes in variable names.)
A table or view name that contains a period and is not enclosed by
apostrophes is a qualified table name. The characters to the left of the period
constitute the table owner, and those to the right of the period constitute the
table name. Any table name enclosed in apostrophes is an unqualified table
name. To understand how DCLGEN determines the table name qualifier, see
the description of the OWNER option, which follows.

138 Command Reference

OWNER( owner-name )
Specifies a qualifier for the table name. owner-name is the qualifier for the table
name.
If you specify a qualified table name for the TABLE( table-name ) option, and
you also specify OWNER( owner-name ), the qualifier portion of table-name
supersedes owner-name as the table name qualifier. If you specify an
unqualified table name for the TABLE( table-name ) option, and you do not
specify OWNER( owner-name ), the SQL authorization ID is the table name
qualifier.
DCLGEN supports the use of underscore (_) as a valid character in the
owner-name keyword parameter.
The following table illustrates the decision process for determining the
DCLGEN table name qualifier.
Table 12. Decision process for determining the DECLGEN table name qualifier
OWNER( owner-name ) OWNER( owner-name ) not
Table name specified specified
TABLE( table-name ) qualified table-name qualifier table-name qualifier
TABLE( table-name ) owner-name SQL authorization ID
unqualified

AT( location-name )
Identifies the location of the table or view name specified in TABLE (
table-name ). location-name , which can consist of 1 to 16 characters, uniquely
identifies an instance of a table or view in a network.
If you specify AT, location-name is used as the prefix for the table name, and
table-name or table-view must be a qualified name.
DCLGEN supports the use of underscore (_) as a valid character in the
location-name keyword parameter.
LIBRARY( library-name ( member-name )/ password )
Specifies the data set into which the declarations go. This data set must already
exist and be accessible to the declarations generator. It can be either sequential
or partitioned. password is optional.
If the library name is not enclosed within apostrophes, DCLGEN constructs the
following full data set name:
user-prefix.library-name.language.(member-name)

where:
user-prefix
The user prefix of the primary authorization ID of the transaction.
language
The value of the LANGUAGE option: PLI, or C;
( member-name )
Optional; if not used, the output goes to a sequential data set.
ACTION
Indicates whether to add or replace the data set.
( ADD )
Adds the data set as a new member, if it does not already exist.

Chapter 20. DCLGEN (DECLARATIONS GENERATOR) (DSN) 139

 The default is ACTION ( ADD ).
(REPLACE)
Replaces an existing member or data set with the new one. If the output is
to a partitioned data set, and no member exists with the given name, one
is added.
LANGUAGE
Specifies the language of the generated declaration.
Possible languages are:
v (PLI), for PL/I
v (C), for C/370™
v (IBMCOB), for IBM COBOL
v (CPP), for C++
NAMES( prefix )
Allows field names to be formed in the declaration.
Avoid possible name conflicts between DCLGEN output and the source
program. If a conflict occurs, use NAMES or STRUCTURE, or manually edit
the generated declaration or source program.
prefix can contain double-byte characters.
The field names consist of prefix concatenated with a number from one to three
digits in length. prefix can have up to 28 characters. If prefix is a single-byte or
mixed string and the first character is not alphabetic, it must be enclosed in
apostrophes. For example, if prefix is ABCDE, the field names will be ABCDE1,
ABCDE2, and so on, up to a maximum of ABCDE999. Special characters can be
used, but use caution to avoid possible name conflicts.
For COBOL and PL/I, if the prefix is a DBCS string, the field name will be the
DBCS prefix concatenated with the DBCS representation of the number. For
example, if prefix is <D1D2D3> (where “<” and “>” represent shift-out and
shift-in characters, respectively, and D1D2D3 represent double-byte characters),
generated field names will be <D1D2D3.1>, <D1D2D3.2>, and so on. The
period (.) represents X’42’.
The column names in the table are taken as default names for the fields in the
output.
STRUCTURE( structure-name )
Specifies the generated data structure.
structure-name can have up to 31 characters. If structure-name is a single-byte or
mixed string and the first character is not alphabetic, it must be enclosed in
apostrophes. You can use special characters, but use caution to avoid possible
name conflicts.
structure-name can contain double-byte characters.
For SQL output, the name is the same as the table or view name. If the host
language is C, the default structure name is the prefix DCL concatenated with
the table name. If the host language is COBOL or PL/I and the table name is a
single-byte or mixed string, the default structure name is also the prefix DCL
concatenated with the table name. If the host language is COBOL or PL/I and
the table name is a DBCS string, the default structure name is the prefix
<.D.C.L> concatenated with the table or view name. “<” and “>” represent
shift-out and shift-in characters, respectively. You must guard against possible

140 Command Reference

 conflicts with names in the source program. DCLGEN allows the specified
structure name to be the same as the table or view name, but will issue a
warning message.
APOST or QUOTE
Specifies the string delimiter character used in the host language. This option
is effective only for COBOL programs.
APOST specifies the apostrophe (’) as the host language string delimiter; the
SQL delimiter is the quotation mark (″).
QUOTE specifies the quotation mark (″) as the host language delimiter; the
SQL delimiter is the apostrophe (’).
If neither APOST nor QUOTE is specified, the default is either APOST or
QUOTE for COBOL, depending on what was specified on DB2 installation
panel DSNTIPF.
The string delimiter delimits strings in host language statements. The SQL
escape character delimits table and column names in the SQL DECLARE
TABLE statement produced by DCLGEN. It is possible, by a choice made
during DB2 installation, to make both delimiters the quotation mark or both
the apostrophe.
LABEL
Indicates whether to include column labels in the output as comments.
(Column labels can be assigned by the LABEL ON statement.)
| ( NO )
| Omits the column labels.
| ( YES )
| Includes the column labels.
DBCSSYMBOL
Specifies the symbol used to denote a graphic data type in a COBOL PICTURE
clause.
(G)
Graphic data is denoted using G.
(N)
Graphic data is denoted using N.
DBCSDELIM
Specifies whether the DBCS table and column names in the generated
DECLARE table statement will be delimited.
( YES )
DBCS table and column names will be delimited in the DCLGEN table
declaration.
(NO)
DBCS table and column names will not be delimited in the DCLGEN table
declaration.
COLSUFFIX
Determines whether to form field names by attaching the column name to the
prefix given by the NAMES option.
( NO )
The column name is not used as a suffix, and field names are controlled by
the option NAMES.

Chapter 20. DCLGEN (DECLARATIONS GENERATOR) (DSN) 141

 (YES)
If NAMES is specified, DCLGEN forms field names by adding column
names as a suffix to the value of NAMES. For example, if the prefix given
by NAMES is “NEW” and the column name is EMPNO, the field name is
“NEWEMPNO”.
If NAMES is not specified, DCLGEN issues a warning message and uses
the column names as the field names.
INDVAR
Determines whether to create an indicator variable array for the host variable
structure.
( NO )
DCLGEN does not create an indicator variable array.
(YES)
DCLGEN creates an indicator array for the host variable structure. The
array name is the table name with a prefix of “I” (or DBCS letter “<I>” if
the table name is double-byte).
| RMARGIN
| Specifies the break point for statement tokens that must be wrapped onto one
| or more subsequent records of DCLGEN output.
| ( STD )
| Statement tokens will be wrapped after column 72.
| (WIDE)
| Statement tokens will be wrapped after column 80.
| DCLBIT
| Specifies whether to generate a DECLARE VARIABLE statement of SQL
| variables for columns that are defined as FOR BIT DATA. This statement is
| required in IBM COBOL applications that have host variables for FOR BIT
| DATA columns and are prepared by using the SQLCCSID option of the
| integrated DB2 coprocessor. The statement is also valid, but not currently
| required, for C/C++ and PL/I, and for COBOL that is not prepared by using
| the SQLCCSID option of the integrated DB2 coprocessor.
| ( NO )
| Does not generate a DECLARE VARIABLE statement of SQL variables for
| columns that are defined as FOR BIT DATA.
| ( YES )
| Generates a DECLARE VARIABLE statement of SQL variables for columns
| that are defined as FOR BIT DATA. If the table or view does not have any
| FOR BIT DATA columns, the statement is not generated.

Usage notes

Parsing of the DCLGEN command conforms to standard TSO parsing conventions.

The DECLARE statement: The DECLARE statement generated by DCLGEN will

define all columns created with a data type of VARCHAR or LONG VARCHAR as
VARCHAR. Columns created with a data type of VARGRAPHIC or LONG
VARGRAPHIC will be defined as VARGRAPHIC.

Comments: The output for all host languages includes comments. The leading
comment block echoes the DCLGEN subcommand that requested the declarations.
The trailing comment block indicates the number of variables declared.

142 Command Reference

 Using the output: To include the DCLGEN output in an application program, use
the SQL INCLUDE statement. The same member name specified in the DCLGEN
LIBRARY parameter is specified on the INCLUDE statement.

Prompts: Online TSO will prompt for missing or incorrectly specified options.

Editing the output: It is expected that the output of DCLGEN will not meet every
need. You can freely edit the output before including it in a program. For example,
you might want to change a variable name, or include SQL escape characters.

You can edit the output to add WITH DEFAULT to NOT NULL for columns that
do not allow null values. If you edit the output, you must provide a default value.

If your column names contain embedded blanks, they will also be reflected in the
host variable declarations, and you will have to remove, or translate, any blank
characters to some other value.

| For a column with an XML data type, DCLGEN generates the following output:
| SQL TYPE IS XML AS CLOB(1M). The default length value for the XML host
| variable is 1MB. You can manually update the DCLGEN output if you want a
| larger or smaller size.

C: DCLGEN support of the C language is unique in the following ways:

v DCLGEN does not fold the STRUCTURE, NAMES, or TABLE values to
uppercase.
v For any DB2 column that has the data type CHAR( n ), where n > 1, DCLGEN
generates the corresponding host variable as CHAR( n + 1) to avoid the DB2
warning. For n = 1, the corresponding host variable is CHAR.

COBOL and binary integers: DB2 uses the full size of binary integers. It can place
larger values than allowed in the specified number of digits in the COBOL
declaration, which can result in truncated values.

For small integers that can exceed 9999, use S9(5). For large integers that can
exceed 999999999, use S9(10) COMP-3 to obtain the decimal data type. If COBOL is
used for integers that exceed the COBOL PICTURE, specify the column as decimal
to ensure that the data types match and perform well.

COBOL and the underscore character: Because COBOL does not allow the use of
the underscore character, DCLGEN translates any underscore characters in the
table’s column names into hyphens (-) for use in the generated structure.

COBOL and DBCS: OS/VS COBOL does not support DBCS, but later versions of
COBOL (VS COBOL II and COBOL/370™) do. Although DB2 accepts values
outside of the range from X’41’ to X’FE’, in COBOL data definition statements,
both bytes of each double-byte character in data names must be within this range.
Data names must also contain at least one DBCS character that does not have X’42’
as its first byte.

Data declarations for arrays of indicator variables: If DCLGEN creates an array of

indicator variables, data declarations have the following form:
Language
Data declaration
C short int I table-name [ n ];

Chapter 20. DCLGEN (DECLARATIONS GENERATOR) (DSN) 143

 Cobol 01 I table-name PIC S9(4) USAGE COMP OCCURS n TIMES
PL/I DCL I table-name ( n ) BIN FIXED (15);

Where n is the number of columns in the table.

Examples

Example 1: This example shows the use of the DCLGEN. Issue the following
statement from a DSN session or through DB2I:
DCLGEN TABLE(VEMPL) -
LIBRARY('prefix.SRCLIB.DATA(DSN8MPEM)') -
LANGUAGE(PLI) -
APOST

This statement produces the following statements in prefix

.SRCLIB.DATA(DSN8MPEM):

/*********************************************************************/
/* DCLGEN TABLE(VEMPL) - */
/* LIBRARY('prefix.SRCLIB.DATA(DSN8MPEM)') - */
/* LANGUAGE(PLI) - */
/* APOST */
/* ... IS THE DCLGEN COMMAND THAT MADE THE FOLLOWING STATEMENTS */
/*********************************************************************/
EXEC SQL DECLARE VEMPL TABLE
( EMPNO CHAR(6) NOT NULL,
FIRSTNME VARCHAR(12) NOT NULL,
MIDINIT CHAR(1) NOT NULL,
LASTNAME VARCHAR(15) NOT NULL,
WORKDEPT CHAR(3) NOT NULL
) ;
/*********************************************************************/
/* PLI DECLARATION FOR TABLE VEMPL */
/*********************************************************************/
DCL 1 DCLVEMPL,
5 EMPNO CHAR(6),
5 FIRSTNME CHAR(12) VAR,
5 MIDINIT CHAR(1),
5 LASTNAME CHAR(15) VAR,
5 WORKDEPT CHAR(3);
/*********************************************************************/
/* THE NUMBER OF COLUMNS DESCRIBED BY THIS DECLARATION IS 5 */
/*********************************************************************/

Example 2: This example shows the use of NAMES and STRUCTURE. Issue the
following statement from a DSN session or through DB2I:
DCLGEN TABLE(VEMPL) -
LIBRARY('prefix.SRCLIB.DATA(DSN8MPEM)') -
LANGUAGE(PLI) -
NAMES(FIELD) -
STRUCTURE(EMPRECORD) -
APOST

This statement produces the following statements in prefix

.SRCLIB.DATA(DSN8MPEM):

144 Command Reference

 /*********************************************************************/
/* DCLGEN TABLE(VEMPL) - */
/* LIBRARY('prefix.SRCLIB.DATA(DSN8MPEM)') - */
/* LANGUAGE(PLI) - */
/* NAMES(FIELD) - */
/* STRUCTURE(EMPRECORD) - */
/* APOST */
/* ... IS THE DCLGEN COMMAND THAT MADE THE FOLLOWING STATEMENTS */
/*********************************************************************/
EXEC SQL DECLARE VEMPL TABLE
( EMPNO CHAR(6) NOT NULL,
FIRSTNME VARCHAR(12) NOT NULL,
MIDINIT CHAR(1) NOT NULL,
LASTNAME VARCHAR(15) NOT NULL,
WORKDEPT CHAR(3) NOT NULL
) ;

/*********************************************************************/
/* PLI DECLARATION FOR TABLE VEMPL */
/*********************************************************************/
DCL 1 EMPRECORD,
5 FIELD1 CHAR(6),
5 FIELD2 CHAR(12) VAR,
5 FIELD3 CHAR(1),
5 FIELD4 CHAR(15) VAR,
5 FIELD5 CHAR(3);
/*********************************************************************/
/* THE NUMBER OF COLUMNS DESCRIBED BY THIS DECLARATION IS 5 */
/*********************************************************************/

| Example 3: The following example creates a table with columns that are defined as
| FOR BIT DATA:
| CREATE TABLE MYTABLE
| ( COL1 CHAR(10) NOT NULL
| ,COL2 CHAR(10) FOR BIT DATA
| ,COL3 VARCHAR(12) NOT NULL
| ,COL4 VARCHAR(12) FOR BIT DATA NOT NULL
| );

This statement produces the following results:

Chapter 20. DCLGEN (DECLARATIONS GENERATOR) (DSN) 145

| ******************************************************************
| * DCLGEN TABLE(MYTABLE) *
| * LIBRARY('prefix.SRCLIB.DATA(MYTABLE)) *
| * LANGUAGE(COBOL) *
| * APOST *
| * DCLBIT(YES) *
| * ... IS THE DCLGEN COMMAND THAT MADE THE FOLLOWING STATEMENTS *
| ******************************************************************
| EXEC SQL DECLARE MYTABLE TABLE
| ( COL1 CHAR(10) NOT NULL,
| COL2 CHAR(10),
| COL3 VARCHAR(12) NOT NULL,
| COL4 VARCHAR(12) NOT NULL
| ) END-EXEC.
| ******************************************************************
| * DECLARED VARIABLES FOR 'FOR BIT DATA' COLUMNS *
| ******************************************************************
| EXEC SQL DECLARE
| :COL2
| ,:COL4
| VARIABLE FOR BIT DATA END-EXEC.
| ******************************************************************
| * COBOL DECLARATION FOR TABLE MYTABLE *
| ******************************************************************
| 01 DCLMYTABLE.
| 10 COL1 PIC X(10).
| 10 COL2 PIC X(10).
| 10 COL3.
| 49 COL3-LEN PIC S9(4) USAGE COMP.
| 49 COL3-TEXT PIC X(12).
| 10 COL4.
| 49 COL4-LEN PIC S9(4) USAGE COMP.
| 49 COL4-TEXT PIC X(12).
| ******************************************************************
| * THE NUMBER OF COLUMNS DESCRIBED BY THIS DECLARATION IS 4 *
| ******************************************************************

146 Command Reference

Chapter 21. /DISPLAY (IMS)
The IMS command /DISPLAY displays the status of the connection between IMS
and an external subsystem (as well as all application programs communicating
with the external subsystem), or the outstanding recovery units that are associated
with the subsystem.

Environment

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Output” on page 148
v “Example” on page 149

This command can be issued only from an IMS terminal.

Data sharing scope: Member

Authorization
This command requires an appropriate level of IMS authority.

Syntax

/DISPLAY SUBSYS  subsystem-name


ALL
,

OASN SUBSYS  subsystem-name

ALL

Option descriptions

One of the following options is required:

SUBSYS
Identifies the subsystems to display information about.
subsystem-name , ...
Specifies one or more subsystems.
ALL
Displays information about all subsystems.

© Copyright IBM Corp. 1983, 2009 147

 OASN SUBSYS
Displays the outstanding recovery units (origin application schedule numbers,
or OASN) associated with the external subsystems. The OASN is assigned by
IMS when it schedules an application into a dependent region. That, coupled
with the IMS ID, becomes the recovery token for units of work distributed to
other subsystems.
subsystem-name , ...
Specifies one or more subsystems to display information about.
ALL
Displays the outstanding recovery units associated with all external
subsystems.

Output

The command recognition character (CRC) is displayed for each external

subsystem. Subsystem status is one of the following:
CONNECTED
An IMS control region or dependent region has successfully connected to
the external subsystem. At this point, the two systems can begin a normal
dialog.
NOT CONNECTED
The external subsystem is in an idle state. That is, either it has not been the
object of the /START SUBSYS command, or the external subsystem
initialization exit routine indicated not to connect.
CONNECT IN PROGRESS
The connection process for the specified subsystem is in progress.
STOPPED
The specified subsystem has been stopped with the /STOP SUBSYS
command. All region connections to the specified external subsystem have
been terminated.
STOP IN PROGRESS
The /STOP SUBSYS command is in progress. Before it completes
successfully, all active connections to the specified subsystem from all IMS
regions must be quiesced.
INVALID SUBSYSTEM NAME = subsystem-name
The indicated subsystem name has not been defined to the IMS subsystem
PROCLIB member. Add the subsystem definition to the subsystem member
and issue the /START SUBSYS command.
SUBSYSTEM subsystem-name NOT DEFINED BUT RECOVERY
OUTSTANDING
The indicated subsystem name has not been defined to IMS in the external
subsystem PROCLIB member, but IMS still has outstanding recovery
elements from a previous execution when the name was known. To resolve
the recovery element problem, either add the indicated subsystem
definition to the external subsystem PROCLIB member and then issue the
/START SUBSYS command, or issue the /DISPLAY OASN SUBSYS
command to determine the identification of the OASNs and then manually
resolve the recovery elements by issuing the /CHANGE SUBSYS RESET
command.
TERM IN PROGRESS
An internal termination of the subsystem is underway. This type of

148 Command Reference

 termination was instigated by IMS abnormal condition processing, an
external subsystem exit, or the external subsystem.

A thread between an IMS dependent region and an external subsystem is created

when an application program in the region establishes a connection to the external
subsystem. The status of threads to an external subsystem is listed under the status
of the subsystem. The absence of a list of threads under a connected subsystem
indicates that no threads to the specified subsystem have been established.

Thread status can be one of the following:

CONNECTED(CONN)
An IMS control region or dependent region has successfully connected to
the external subsystem.
ACTIVE
An IMS application program has established communication with an
external subsystem.

The absence of a PSB name for a thread indicates that a connection to the external
subsystem exists, but an application program is not currently occupying the region.
The presence or absence of an LTERM name indicates whether a region is
message-driven.

Note: The preceding description of the /DISPLAY command is a partial

description only.

Example

Display the status of connections between IMS and all subsystems.

/DISPLAY SUBSYSTEM ALL
SUBSYS CRC REGID PROGRAM LTERM STATUS
SSTR ? CONN
1 DDLTLM17 PTERM01 CONN,ACTIVE
2 DDLTLM06 PTERM02 CONN
*85202/065933*

Chapter 21. /DISPLAY (IMS) 149

150 Command Reference
Chapter 22. -DISPLAY ARCHIVE (DB2)
The DB2 command DISPLAY ARCHIVE displays input archive log information.

Abbreviation: -DIS ARC

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Usage note”
v “Example” on page 152

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v ARCHIVE system privilege
v DISPLAY system privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

DISPLAY ARCHIVE


Usage note

Data sharing members: Although the command ARCHIVE LOG SCOPE(GROUP)

or ARCHIVE LOG MODE(QUIESCE) initiates archive processing for all members
of a data sharing group, the command DISPLAY ARCHIVE shows information
only for the member for which it is issued. To display input archive log
information for all members of a data sharing group, enter the command on each
member.

© Copyright IBM Corp. 1983, 2009 151

 Example

Use the following command to display information about archive log data sets in
use.
-DISPLAY ARCHIVE

This command produces output similar to the following output:

DSNJ322I -DISPLAY ARCHIVE REPORT FOLLOWS-
COUNT TIME
(TAPE UNITS) (MIN,SEC)
DSNZPARM 2 0,00
CURRENT 2 0,00
===============================
ADDR STATUS CORR-ID VOLSER DATASET_NAME
03B0 BUSY SHEDDEN A00001 DSNT2AR1.DT25.D04169.T1328583.A0012701
RECALL 03RCRSC MIGRAT DSNT2AR1.DT25.D04169.T1334426.A0012704
A99B BUSY 14DRSTRT ARN690 DSNT2AR1.DT25.D04169.T1346176.A0012705
BDDD BUSY 10LPLALR ARN738 DSNT2AR1.DT25.D04170.T1506437.A0012743
END OF DISPLAY ARCHIVE REPORT.

This example report shows:

v The subsystem parameter values for MAX RTU (COUNT) and DEALLC
PERIOD TIME as recorded in the DSNZPxxx load module
v Current specifications for the COUNT and TIME parameters
v Availability status of allocated archive log data sets
v Volume and data set names that are associated with current archive log read
requests

152 Command Reference

Chapter 23. -DISPLAY BUFFERPOOL (DB2)
The DB2 command DISPLAY BUFFERPOOL displays the current status for one or
more active or inactive buffer pools.

Abbreviation: -DIS BPOOL

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 154
v “Option descriptions” on page 154
v “Output” on page 156
v “Examples” on page 159

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v DISPLAY system privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 153

 Syntax

ACTIVE


DISPLAY BUFFERPOOL( * )

, INTERVAL
DETAIL( )
 bpname *

ACTIVE ACTIVE
LIST( ) LSTATS( )
* *

*
,

DBNAME (  database-name )
name1:name2
name*

* GBPDEP( YES )
, NO

SPACENAM(  space-name )
name1:name2
name*


CASTOWNR( YES )
NO

Option descriptions
( ACTIVE )
Displays the current buffer pool status for all active buffer pools.
(*) Displays the current buffer pool status for all active or inactive buffer pools.
( bpname )
Names the buffer pool for which current status is to be displayed.
v 4-KB page buffer pools are named BP0 through BP49
v 8-KB page buffer pools are named BP8K0 through BP8K9
v 16-KB page buffer pools are named BP16K0 through BP16K9
v 32-KB page buffer pools are named BP32K through BP32K9
DETAIL
Produces a detail report for one or more buffer pools. If DETAIL is not
specified, a summary report is produced.

154 Command Reference

 ( INTERVAL )
Requests statistics accumulated since the last incremental display, or since
the buffer pool was first activated if no previous incremental display exists.
(*) Requests statistics accumulated since the buffer pool was first activated.
LIST
Lists the open index spaces and table spaces associated with the buffer pools
included in the report. Basic information is provided for non-data-sharing
systems while more detail is provided if data sharing is active.
( ACTIVE )
Restricts the list of open index spaces and table spaces to those that are
currently in use.
(*) Requests a list of all open index spaces and table spaces, whether currently
in use or not.
LSTATS
Lists data set statistics for the open index spaces and table spaces associated
with the buffer pools included in the report. The statistics displayed are
incremental since the last time they were displayed.
( ACTIVE )
Restricts the list statistics to those data sets that are currently in use.
The default is ACTIVE when LIST is not specified or if LIST is specified
with no parameter. If LIST is specified with a parameter and LSTATS has
no parameter, the parameter specified for LIST is used for LSTATS.
(*) Includes statistics for all open index spaces and table spaces, whether
currently in use or not.
DBNAME
Specifies which databases are included in the LIST display and the LSTATS
display. If you specify DBNAME without LIST, LIST(ACTIVE) is assumed.
ABBREVIATION: DBN
( database-name , ...)
Identifies one or more databases to be included in the LIST and
LSTATS displays. database-name can have any of the forms in the
following list. In the list, name1 and name2 represent strings of one- to
eight-characters. name represents a string of one- to eight-characters.
Form Displays the status of...
name1 The database name1
name1:name2
All databases with names from name1 to name2 in a sorted list
of database names.
name* All databases whose names begin with the string name
(*) Displays information on all databases that match the LIST specification.
This is the default.
SPACENAM
Specifies which table spaces or index spaces within the specified databases to
include in the LIST display and the LSTATS display. If you use SPACENAM
without DBNAME, DBNAME(*) is assumed.
ABBREVIATION: SPACE

Chapter 23. -DISPLAY BUFFERPOOL (DB2) 155

 (*) Displays information about all table spaces and index spaces of the
specified databases. This is the default.
( space-name , ...)
Identifies one or more spaces to be included in the LIST and LSTATS
displays. You can write space-name like database-name to designate:
v The name of a single table space or index space
v A range of names
v A partial name followed by a pattern-matching character
GBPDEP
Indicates whether to restrict the list of data sets to those that are group buffer
pool dependent. This option is not valid if this is a non-data sharing DB2.
(YES)
Restricts the list of page sets to those that are group buffer pool dependent
(GBP-dependent). An index space or table space is GBP-dependent if either
of these conditions are true:
v Inter-DB2 R/W interest exists in it.
v Changed pages from it exist in the group buffer pool that have not yet
been written to disk.
(NO)
Restricts the list of page sets to those that are non-group buffer pool
dependent.
CASTOWNR
Indicates whether to restrict the list of data sets to those for which this DB2
member is the castout owner. This option is not valid if this is a non-data
sharing DB2.
(YES)
Restricts the list of page sets for which this DB2 member is the castout
owner.
(NO)
Restricts the list of page sets for which this DB2 member is not the castout
owner.

Output

You can request a summary report or a detail report.

Summary report

A summary report contains the following information, as seen in Example 1.

Identification
BUFFERPOOL NAME
Buffer pool external name (BP0, BP1, ..., BP49, or BP32K, BP32K1, ...,
BP32K9).
BUFFERPOOL ID
Buffer pool internal identifier (0-49, 80-89, 100-109, 120-129).
USE COUNT
Number of open table spaces or index spaces that reference this buffer
pool. (Inactive pools have a zero use count.)

156 Command Reference

BUFFERPOOL SIZE
User-specified buffer pool size.
BUFFERS ALLOCATED
Number of allocated buffers in an active buffer pool.
TO BE DELETED
Number of buffers to be deleted in an active buffer pool (because of pool
contraction).
IN-USE/UPDATED
Number of currently active (non-stealable) buffers in the buffer pool.
BUFFERS ACTIVE
Number of currently active (containing data) buffers in the buffer pool. For
a fixed buffer pool, BUFFERS ACTIVE also indicates the number of buffers
that are fixed in real storage.

Thresholds
VP SEQUENTIAL
Sequential steal threshold for the buffer pool.
DEFERRED WRITE
Deferred write threshold for the buffer pool.
VERTICAL DEFERRED WRT
Vertical deferred write threshold for the buffer pool.
PARALLEL SEQUENTIAL
Parallel sequential threshold for the buffer pool.
ASSISTING PARALLEL SEQT
Assisting parallel sequential threshold for the buffer pool.

Detail report

A detail report includes all summary report information and additional buffer pool
related statistics. You can request cumulative statistics (accumulated since DB2
startup) or incremental statistics (accumulated since the last incremental display). A
sample report appears in Example 2. The statistics in a detail report are grouped in
the following categories:

Getpage information (message DSNB411I):

RANDOM GETPAGE
Non-sequential getpage requests
SYNC READ I/O(R)
Synchronous read I/O operations for non-sequential getpage
SEQ. GETPAGE
Sequential getpage requests
SYNC READ I/O(S)
Synchronous read I/O operations for sequential getpage
DMTH HIT
Number of times data management threshold reached
PAGE-INS REQ
Number of page-ins required for read I/O

Chapter 23. -DISPLAY BUFFERPOOL (DB2) 157

 Sequential prefetch statistics (message DSNB412I):
REQUESTS
Sequential prefetch requests
PREFETCH I/O
Sequential prefetch read I/O operations
PAGES READ
Number of pages read with sequential prefetch

List prefetch statistics (message DSNB413I):

REQUESTS
List prefetch requests
PREFETCH I/O
List prefetch read I/O operations
PAGES READ
Number of pages read due to list prefetch

Dynamic prefetch statistics (message DSNB414I):

REQUESTS
Dynamic prefetch requests
PREFETCH I/O
Dynamic prefetch read I/O operations
PAGES READ
Number of pages read with dynamic prefetch

Disabled prefetch statistics (message DSNB415I):

NO BUFFER
Prefetch disabled - no buffer
NO READ ENGINE
Prefetch disabled - no read processor

Page update statistics (message DSNB420I):

SYS PAGE UPDATES
System page updates
SYS PAGES WRITTEN
System pages written
ASYNC WRITE I/O
Asynchronous write I/O operations
SYNC WRITE I/O
Synchronous write I/O operations
| PAGE-INS REQ
| Number of page-ins required for read I/O

Page write statistics (message DSNB421I):

DWT HIT
Number of times deferred write threshold reached
VERTICAL DWT HIT
Number of times vertical deferred write threshold reached

158 Command Reference

NO WRITE ENGINE
Number of times write processor not available for I/O operations

Parallel processing activity (message DSNB440I):

PARALLEL REQUEST
Number of negotiations for task streams for parallel processing activity
DEGRADED PARALLEL
Number of times negotiation resulted in a degraded mode of operation

Examples

Example 1: A summary report is the default report if the DETAIL option is not
specified. The following example shows a summary report that can be produced
by the command:
-DISPLAY BUFFERPOOL(BP0) LIST(*) DBNAME(DSN8*)
DSNB401I - BUFFERPOOL NAME BP0, BUFFERPOOL ID 0, USE COUNT 20
DSNB402I - BUFFERPOOL SIZE = 2000
BUFFERS ALLOCATED = 2000
TO BE DELETED = 0
IN-USE/UPDATED = 0
BUFFERS ACTIVE = 2000
DSNB404I - THRESHOLDS -
VP SEQUENTIAL = 80
DEFERRED WRITE = 85
VERTICAL DEFERRED WRT = 80
PARALLEL SEQUENTIAL = 50
ASSISTING PARALLEL SEQT = 0
DSNB406I - PGFIX ATTRIBUTE -
CURRENT = NO
PENDING = YES
PAGE STEALING METHOD = LRU
DSN9022I - DSNB1CMD '-DISPLAY BUFFERPOOL' NORMAL COMPLETION

Example 2: A detail report can be generated that includes all summary report
information and additional buffer pool related statistics. The following example
shows a detail report that can be produced by the command:
-DISPLAY BUFFERPOOL(BP0) DETAIL
DSNB401I - BUFFERPOOL NAME BP0, BUFFERPOOL ID 0, USE COUNT 10
DSNB402I - BUFFERPOOL SIZE = 2000
BUFFERS ALLOCATED = 2000
TO BE DELETED = 0
IN-USE/UPDATED = 200
BUFFERS ACTIVE = 2000
DSNB404I - THRESHOLDS -
VP SEQUENTIAL = 80
DEFERRED WRITE = 50
VERTICAL DEFERRED WRT = 10
PARALLEL SEQUENTIAL = 50
ASSISTING PARALLEL SEQT = 0

DSNB409I - INCREMENTAL STATISTICS SINCE 10:32:48 OCT 23, 1993

DSNB411I - RANDOM GETPAGE = 230 SYNC READ I/O (R) = 180

SEQ. GETPAGE = 610 SYNC READ I/O (S) = 20
DMTH HIT = 0 PAGE-INS REQ = 40

DSNB412I - SEQUENTIAL PREFETCH -

REQUESTS = 0 PREFETCH I/O = 0
PAGES READ = 0

DSNB413I - LIST PREFETCH -

Chapter 23. -DISPLAY BUFFERPOOL (DB2) 159

 REQUESTS = 0 PREFETCH I/O = 0
PAGES READ = 0

DSNB414I - DYNAMIC PREFETCH -

REQUESTS = 0 PREFETCH I/O = 0
PAGES READ = 0

DSNB415I - PREFETCH DISABLED -

NO BUFFER = 0 NO READ ENGINE = 0
DSNB420I - SYS PAGE UPDATES = 0 SYS PAGES WRITTEN = 0
ASYNC WRITE I/O = 0 SYNC WRITE I/O = 0
PAGE-INS REQ = 0
DSNB421I - DWT HIT = 0 VERTICAL DWT HIT = 0
NO WRITE ENGINE = 0

DSNB440I - PARALLEL ACTIVITY -

PARALL REQUEST = 0 DEGRADED PARALL = 0

DSN9022I - DSNB1CMD '-DISPLAY BUFFERPOOL' NORMAL COMPLETION

Example 3: With the summary or detail report, you can list open table spaces and
index spaces associated with the buffer pool. You can also request a display of
statistics for each listed table space and index space. An example of a report
generating this information could be produced by the command:
-DISPLAY BUFFERPOOL(BP0) LIST LSTATS
DSNB401I - BUFFERPOOL NAME BP0, BUFFERPOOL ID 0, USE COUNT 3
DSNB402I - BUFFERPOOL SIZE = 2000
BUFFERS ALLOCATED = 2000
TO BE DELETED = 0
IN-USE/UPDATED = 200
BUFFERS ACTIVE = 2000
DSNB404I - THRESHOLDS -
VP SEQUENTIAL = 80
DEFERRED WRITE = 50
VERTICAL DEFERRED WRT = 10
PARALLEL SEQUENTIAL = 50
ASSISTING PARALLEL SEQT = 0
DSNB455I - SYNCHRONOUS I/O DELAYS -
AVERAGE DELAY = 22
MAXIMUM DELAY = 35
TOTAL PAGES = 23
DSN9022I - DSNB1CMD '-DISPLAY BUFFERPOOL' NORMAL COMPLETION

160 Command Reference

 Chapter 24. -DISPLAY DATABASE (DB2)
The DB2 command DISPLAY DATABASE displays status information about DB2
databases.

The DISPLAY DATABASE command displays information about the status of the
following objects:
v DB2 databases
v Table spaces
v Tables in segmented table spaces
| v XML table spaces
v LOB table spaces
v Index spaces within a database
v Indexes on auxiliary tables
v Partitions of partitioned table spaces
v Partitions of index spaces

DISPLAY DATABASE RESTRICT indicates if a table space, index space, or partition

is in any pending status. Use the ADVISORY option without the RESTRICT option
to display any objects that are in an advisory pending status, such as the
informational COPY-pending status or auxiliary warning advisory status.

In a data sharing environment, the command can be issued from any DB2
subsystem in the group that has access to the database.

Abbreviation: -DIS DB

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 163
v “Option descriptions” on page 164
v “Usage notes” on page 169
v “Output” on page 171
v “Examples” on page 172

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group

Authorization

The DISPLAY system privilege allows you to display status information for any
database. The resulting display lists those databases for which the primary
authorization ID or any of the secondary authorization IDs has the DISPLAYDB

© Copyright IBM Corp. 1983, 2009 161

 privilege. Error messages are produced for those databases specified over which
the set of privileges does not include one of the following privileges or authorities:
v DISPLAYDB privilege
v DISPLAY privilege
v DBMAINT authority
v DBCTRL authority
v DBADM authority
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

| For implicitly created databases, the database privilege or authority can be held on
| the implicitly created database or on DSNDB04. If the DISPLAY DATABASE
| command is issued on specific table spaces or index spaces in an implicitly created
| database, ownership of the table spaces is sufficient to display status information
| about them. This means that the owner can display information about an implicitly
| created table space or index space if the command explicitly specifies that table
| space or index space name.

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

162 Command Reference

Syntax

DISPLAY DATABASE (  database-name )

*
dbname1:dbname2
dbname*
*dbname
*dbname*
*dbstring1*dbstring2*

USE
CLAIMERS
LOCKS
LPL
WEPR
,

SPACENAM(  space-name )
*
spacename1:spacename2 USE ONLY
spacename* CLAIMERS
*spacename LOCKS
*spacename* LPL
*spacestring1*spacestring2* WEPR
(1)
ONLY

, (2)
OVERVIEW
PART(  integer )
integer1:integer2

50
LIMIT( integer )
*

restrict-block

AFTER ACTIVE ,

ADVISORY (  )
ICOPY
AUXW
ARBDP
AREO*

Notes:
1 If you specify the ONLY option without the SPACENAM() keyword, only
the LIMIT, AFTER, and RESTRICT keywords apply.
2 The OVERVIEW keyword cannot be specified with any other keywords
except SPACENAM, LIMIT, and AFTER.

Chapter 24. -DISPLAY DATABASE (DB2) 163

 restrict block:


,

RESTRICT (  )
ACHKP
CHKP
COPY
GRECP
LPL
RBDP
RECP
REORP
RO
STOP
UT
UTRO
UTRW
UTUT
UT*
WEPR

Option descriptions
( database-name , ...)
Identifies one or more databases whose status is to be displayed.
(*)
Displays information on all databases that are defined to the DB2
subsystem for which the privilege set of the process has the required
authorization.

dbname and dbstring can have any of the forms listed in the following table
(where dbname1 and dbname2 represent any strings of from one to eight
characters, and dbname represents any string of from one to seven characters).
Table 13. Forms of dbname and dbstring
Form Displays the status of...
| dbname1:dbname2 All databases whose names, in UNICODE, are between dbname1
| and dbname2 inclusive
dbname* All databases whose names begin with the string dbname
*dbname All databases whose names end with the string dbname
*dbname* All databases whose names contain the string dbname
*dbstring1*dbstring2* All databases whose names contain the strings dbstring1 and
dbstring2

SPACENAM
Specifies what space to display. If you use SPACENAM, you must also specify
the corresponding database name. If (*) is used to specify multiple databases,
SPACENAM(*) can be specified to display all objects in these databases.
Abbreviation: SPACE, SP

164 Command Reference

 ( space-name , ...)
Lists one or more spaces whose status is to be displayed. You can write
space-name like database-name to designate:
v The name of a single table space or index space
v A range of names
v A partial name, including a beginning or ending pattern-matching
character (*), a pattern-matching character between two strings, or any
combination of these, with the following exception. Consecutive
pattern-matching characters (*) are not allowed, and you cannot specify
two pattern-matching characters in the middle of a keyword string.
(*)
Displays information about all table spaces and index spaces of the
specified database.

spacename and spacestring can have any of the forms listed in the following
table (where spacename1 and spacename2 represent any strings of from one
to eight characters, and spacename represents any string of from one to
seven characters).
Table 14. Forms of spacename and spacestring
Form Displays the status of...
| spacename1:spacename2 All table spaces or index spaces whose names, in
| UNICODE, are between spacename1 and spacename2
| inclusive
spacename* All table spaces or index spaces whose names begin with
the string spacename
*spacename All table spaces or index spaces whose names end with the
string spacename
*spacename* All table spaces or index spaces whose names contain the
string spacename
*spacestring1*spacestring2* All table spaces or index spaces whose names contain the
strings spacestring1 and spacestring2

USE
Displays the following information:
v The applications and subsystems of the database or space that have internal
DB2 resources allocated
v The applications and subsystems of the database or space on whose behalf
locks for the space are held or waited for
v The connection IDs, correlation IDs, and authorization IDs for all
applications allocated to spaces and partitions whose statuses are displayed
v The LUWID and location of any remote threads accessing the local database
CLAIMERS
Displays the following information:
v The claims on all table spaces, index spaces and partitions whose statuses
are displayed
v The LUWID and location of any remote threads accessing the local database
v The connection IDs, correlation IDs, and authorization IDs for all
applications allocated to spaces whose statuses are displayed
v The logical partitions that have logical claims and their associated claims

Chapter 24. -DISPLAY DATABASE (DB2) 165

| v The agent token for the claimer, if the claimer is local
CLAIMERS overrides both LOCKS and USE. If you specify CLAIMERS, any
references to LOCKS or USE are ignored.
LOCKS
Displays the following information:
v The applications and subsystems on whose behalf locks are held, waited on,
or retained for the database or space
v The transaction locks for all table spaces, tables, index spaces and partitions
whose statuses are displayed
v The connection IDs, correlation IDs, and authorization IDs for all
applications allocated to spaces whose statuses are displayed
v The LUWID and location of any remote threads accessing the local database
v The drain locks for a resource held by running jobs
v The logical partitions that have drain locks and the drain locks that are
associated with them
v The retained locks for a resource
v The page set or partition physical locks (P-locks) for a resource
| v The agent token for the lock holder, if the lock holder is local
LOCKS overrides USE. If both LOCKS and USE are specified, USE is ignored.
LPL
Displays logical page list entries.
WEPR
Displays write error page range information.
ONLY
Displays information about the specified object.
without SPACENAM() keyword
Displays only database information. DB2 does not display information for
the spaces within the database you specified with the DISPLAY
DATABASE command. If you specify ONLY, the following keywords are
valid:
v RESTRICT
v LIMIT
v AFTER
with SPACENAM() keyword
Displays the table spaces or indexes that have information requested by
the DISPLAY DATABASE command. If you specify SPACENAM() ONLY,
you must also specify one of the following keywords:
v USE
v CLAIMERS
v LOCKS
v LPL
v WEPR
DB2 displays tables with table locks when you specify both the LOCKS
and ONLY keywords.
PART ( integer , ...)
Indicates the partition number of one or more partitions whose status is to be

166 Command Reference

 displayed. The integer specified must identify a valid partition number for the
corresponding space name and database name. integer can be written to
designate one of the following values:
v A list of one or more partitions
v A range of all partition numbers that collate greater than or equal to integer1
and less than or equal to integer2
v A combination of lists and ranges
OVERVIEW
Displays each object in the database on its own line, providing an easy way to
see all objects in the database.
OVERVIEW limits the display to only the space names and space types that
exist in the specified databases. The number of parts is displayed for any
partitioned spaces.
The OVERVIEW keyword cannot be specified with any other keywords except
SPACENAM, LIMIT, and AFTER.
LIMIT
Limits the number of messages to be displayed by the command.
( integer )
Is the maximum number of messages that are to be displayed. The default
is 50 . The maximum number of messages that can be displayed is limited
by the space available.
(*)
Limits the display to the space available.
AFTER
Displays the following information:
v If only a database name is used, AFTER continues the display of all other
databases whose names collate greater than that name.
v If SPACENAM and a table space or index space name are used, AFTER
continues the display to all other table spaces or index spaces in the same
database whose names collate greater than that name.
AFTER cannot be used with more than one database name, table space name,
index space name, with any pattern-matching character (*) within the database
name, or with the SPACENAM() keyword.
ACTIVE
Limits the display to table spaces or index spaces that have had internal DB2
resources allocated to applications and are in a started state or to databases
that contain such spaces.
Abbreviation: A
Default: Using neither ACTIVE nor RESTRICT displays information on all
databases defined to DB2.
RESTRICT
Limits the display to databases, table spaces, or indexes in a restricted status.
This includes those page sets that have logical page list entries. Specifying one
or more keywords further limits the display to the named objects only.
Abbreviation: RES
Use of a database is restricted if the database is in any of the following
situations:

Chapter 24. -DISPLAY DATABASE (DB2) 167

 v It is started for read-only processing.
v It is started for utility-only processing.
v It is stopped.
Use of a table space or index space is restricted if the table space or index
space is in any of the following situations:
v It is in one of the three situations listed previously.
v It is being processed by a utility.
v It is in COPY-pending, CHECK-pending, RECOVER-pending, group buffer
pool RECOVER-pending, auxiliary CHECK-pending, or REORG-pending
status.
v It contains a page error range.
v It contains pages in the logical page list (LPL).
Specify one or more of the following keywords to limit objects that are to be
listed.
ACHKP
Displays objects in the auxiliary warning advisory state.
CHKP Display objects that are in CHECK-pending status.
COPY Display objects that are in COPY-pending status.
GRECP
Displays objects that are in group buffer pool RECOVER-pending
status.
LPL Displays logical page list entries.
RBDP Displays index objects that are in REBUILD- or RECOVER-pending
status. This includes the restricted states RBDP, RBDP*, PSRBDP, LPL,
and WEPR.
RECP Displays objects that are in RECOVER-pending status, including the
restricted states RECP, RECP*, LPL, and WEPR (write error page
range).
REORP
Displays objects that are in REORG-pending status.
RO Displays objects that are in read-only mode.
STOP Displays objects that are stopped, including the restricted states STOP,
STOPE, STOPP, and LSTOP.
UT Displays objects that are in utility access mode.
UTRO Display objects that are serialized for utility access and available for
read-only access.
UTRW
Display objects that are serialized for utility access and available for
read-write access.
UTUT Displays objects that are serialized for utility access and unavailable.
UT* Displays objects that are in any utility access mode: UT, UTRW, UTRO,
or UTUT.
WEPR Displays write error page range information.

168 Command Reference

ADVISORY
Limits the display to indexes and table spaces to which read-write access is
allowed, but for which some action is recommended.
Abbreviation: ADV
Use the DISPLAY DATABASE ADVISORY command without the RESTRICT
option to determine when:
v An index space is in the informational COPY-pending (ICOPY) advisory
status.
v A base table space or LOB table space is in the auxiliary warning (AUXW)
advisory status.
v An index space is in the REBUILD-pending (ARBDP) advisory status.
v An index space is in the REORG (AREO*) advisory status.
Specify one or more of the following keywords to limit the objects listed.
AUXW
Displays objects that are in the auxiliary warning advisory state.
ICOPY
Displays objects that are in the informational COPY-pending advisory
state.
ARBDP
Displays objects that are in the advisory REBUILD-pending status.
AREO*
Displays objects that are in the advisory REORG-pending status.

Usage notes

Displaying DB2 catalog tables: You can always display the DB2 catalog tables.
However, if a table space in the catalog containing information about user
databases or user table spaces is stopped, those databases or table spaces cannot be
displayed. Trying to display them will cause an error.

If you issue DISPLAY DATABASE LOCKS on the catalog (DSNDB06), you might
see a lock held on SYSDBASE with the correlation ID 020.DBCMD_05 or
020.DBCMD_06. This simply indicates the lock that DISPLAY DATABASE itself
needs and is normal.

Displaying restricted and advisory status objects: To display all resources that are
in restricted status, you must issue the DISPLAY DATABASE command twice. To
display table spaces and indexes in restricted status, use the SPACENAM
parameter with RESTRICT. To display databases in restricted status, do not use the
SPACENAM parameter. Spaces could be unavailable even if they show RW mode
if the database is in restricted status.

To display all resources that are in advisory status, issue the DISPLAY DATABASE
ADVISORY command without the RESTRICT option.

Communications Database and Resource Limit Facility: If the command specifies

a table space or index space in the communications database or in the active
resource limit facility database, the USE option displays the names of all members
of the data sharing group that are using the specified table space or index space.
Knowing which other members of the data sharing group might be using these

Chapter 24. -DISPLAY DATABASE (DB2) 169

 spaces is useful when considering whether to drop table spaces and index spaces
in the communications database and the resource limit facility database.

| Displaying logical partitions: If you issue DISPLAY DATABASE with the PART
| parameter for a logical partition of a type 2 index, DB2 does not display physical
| claimers and physical locks in the output. Nonpartitioned indexes are displayed
| with a type of ’IX’ and with partition numbers displayed either as ’L’ followed by
| a four-digit number, or as ’L*.’ When the information for all the logical partitions is
| the same, partition numbers are displayed as ’L*.’ If there is unique information to
| be displayed for a particular logical partition, L is used with that partition number
| to represent the logical part.

Displaying databases for declared temporary tables: DISPLAY DATABASE can

display information about databases that are created with the AS TEMP option and
the associated table spaces, but does not display information for declared
temporary tables or index spaces that the database contains.

Displaying data-partitioned secondary indexes (DPSIs): DISPLAY DATABASE can

display information about data-partitioned secondary indexes. DPSIs are displayed
with a type of ’IX’. The partition number is displayed as ’D’ followed by the
four-digit partition number, ranging from 0001 to 4096.

| Displaying XML table spaces: DISPLAY DATABASE can display information about
| the status of XML table spaces. XML table spaces are displayed with a type of ’XS’.

| Displaying clone table information: The information about base table objects and
| their clones is automatically displayed if a clone table exists. The information for
| both base objects and clones is displayed because clone objects can have different
| states than their base counterparts. DISPLAY will indicate what the current base
| and clone data set instance numbers are.

| Base table objects that have been cloned are noted with the character ’B’ in the
| TYPE column of the DISPLAY output. Cloned objects are noted with the character
| ’C’ in the TYPE column. Immediately following the ’B’ or ’C’ character is the data
| set instance number. The data set number is always a ’1’ or ’2’. All the base table
| objects have the same data set instance number. All of the clone table objects have
| the same instance number, which is different than the base table objects’ instance
| number. Data set instance number associations change during each data exchange.

| You can also query the INSTANCE column of the SYSTABLESPACE catalog table
| to determine the current instance number associated with a particular base table.

| If you drop a cloned table of a base table with a instance number ’2’ then the
| DISPLAY output of the base table still indicates that a clone once existed. The
| DISPLAY command output still shows ’B2’ in the TYPE column to indicate that the
| base object is using instance number ’2’. If you drop a cloned table and the base
| object instance number is ’1’ then the DISPLAY command outputs information that
| does not indicate that a clone ever existed. There is no ’B’ character or instance
| number in the TYPE column.

| See the following Examples section for examples of how to display cloned table
| information.

170 Command Reference

 Output

Message DSNT392I status information: The status codes that are displayed by the
DISPLAY DATABASE command and their respective descriptions are as follows:
ARBDP
Indicates that the index should be rebuilt to improve performance and
allows the DB2 subsystem to pick this index for index-only access.
AREO*
Indicates that the table space, index, or partition identified should be
reorganized for optimal performance.
ACHKP
Indicates an error in the LOB column of the base table space. The base
table space has the auxiliary CHECK-pending restrictive status.
AREST
Indicates that an object (a table space, index space, or a physical partition
of a table space or index space) is in an advisory RESTART-pending state.
If backout activity against the object is not already underway, initiate it
either by issuing the RECOVER POSTPONED command, or by recycling
the system with the system parameter LBACKOUT=AUTO.
AUXW
| Either the base table space or XML table space is in the auxiliary warning
| advisory status, indicating an error in the LOB column, or the LOB table
| space is in the auxiliary warning advisory status, indicating an invalid
| LOB. This message can also indicate an error in a base table space with an
| XML column or in an XML table space.
CHKP The object (a table space, a partition within a table space, or an index) is in
the CHECK-pending status.
COPY The object (a table space or a partition within a table space) is in the
COPY-pending status. An image copy is required for this object.
DBETE
Indicates that the DBET status for the object (a table space, a partition
within a table space, an index space, an index partition, or a logical index
partition) is in error. The error occurred when the DBET states were being
modified during log apply or must-complete processing. This prohibited
DB2 from successfully updating the DBET states.
GRECP
The object is GBP-dependent and a group buffer pool RECOVER is
pending.
ICOPY
| The table space or index space is in the informational COPY-pending
| advisory status.
LPL The object has entries in the logical page list.
LSTOP
The logical partition of a nonpartitioning index is stopped.
PSRBD
The entire nonpartitioning index space is in a page set REBUILD-pending
status.
RBDP The physical or logical index partition is in the REBUILD-pending status.

Chapter 24. -DISPLAY DATABASE (DB2) 171

 RBDP*
The logical partition of a nonpartitioning index is in the REBUILD-pending
status, and the entire index is inaccessible to SQL applications. However,
only the logical partition needs to be rebuilt.
RECP The object (a table space, table space partition, index space, index partition,
or logical index partition) is in the RECOVER-pending status.
REFP The object (a table space, index space, or an index) is in the
REFRESH-pending status.
RELDP
The object has a release dependency.
REORP
The data partition is in the REORG-pending status.
RESTP
The table space or index space is in the restart-pending status.
RO The database, table space, table space partition, index space, or index space
partition is started for read-only activity.
RW The database, table space, table space partition, index space, or index space
partition is started for read and write activity.
STOP The database, table space, table space partition, index space, or index space
partition is stopped.
STOPE
The table space or index space was implicitly stopped because there is a
problem with the log RBA in a page. Message DSNT500I or DSNT501I is
issued when the error is detected, indicating the inconsistency.
STOPP
A stop is pending for the database, table space, table space partition, index
space, or index space partition.
UT The database, table space, table space partition, index space, or index space
partition is started for utility processing only.
UTRO A utility is in process, on the table space, table space partition, index space,
or index space partition, that allows only RO access. If the utility was
canceled before the object was drained, the object can allow SQL access
because the object was not altered by the utility.
UTRW
A utility is in process, on the table space, table space partition, index space,
or index space partition, that allows RW access.
UTUT A utility is in process, on the table space, table space partition, index space,
or index space partition, that allows only UT access. If the utility was
canceled before the object was drained, the object can allow SQL access
because the object was not altered by the utility.
WEPR Displays write error page range information.

Examples

Example 1: Display information about table space TBS33 in database CB3. The USE
option causes connection-name (CONNID), correlation-id (CORRID), and authorization
ID (USERID) information to be displayed.
-DISPLAY DATABASE(CB3) SPACENAM(TBS33) USE

172 Command Reference

The following output is generated:
DSNT360I - ***********************************************************
DSNT361I - * DISPLAY DATABASE SUMMARY
* GLOBAL USE
DSNT360I - ***********************************************************
DSNT362I - DATABASE = CB3 STATUS = RW
DBD LENGTH = 4028
DSNT397I -
NAME TYPE PART STATUS CONNID CORRID USERID
-------- ---- ----- ----------------- -------- ------------ --------
TBS33 TS 0001 RW LSS001 DSN2SQL SYSADM
TBS33 TS 0002 RW LSS001 DSN2SQL SYSADM
TBS33 TS 0003 RW LSS001 DSN2SQL SYSADM
TBS33 TS 0004 RW LSS001 DSN2SQL SYSADM

******* DISPLAY OF DATABASE CB3 ENDED **********************

DSN9022I . DSNTDDIS 'DISPLAY DATABASE' NORMAL COMPLETION

Example 2: Display information about table space TBS33 in database CB3. The
LOCKS option displays lock information for table spaces and tables specified;
LUWIDs and locations of any remote threads; and connection-name , correlation-id ,
and authorization ID information.
-DISPLAY DATABASE(CB3) SPACENAM(TBS33) LOCKS

The following output is generated:

DSNT360I - ***********************************************************
DSNT361I - * DISPLAY DATABASE SUMMARY
* GLOBAL LOCKS
DSNT360I - ***********************************************************
DSNT362I - DATABASE = CB3 STATUS = RW
DBD LENGTH = 4028
DSNT397I -
NAME TYPE PART STATUS CONNID CORRID LOCKINFO
-------- ---- ----- ----------------- -------- ------------ ---------
TBS33 TS 0001 RW
TBS33 TS 0002 RW
TBS33 TS 0003 RW
TBS33 TS 0004 RW LSS004 DSN2SQL H(IS,S,C)
TBS33 TS 0004 RW LSS005 DSN2SQL H(IS,S,C)

******* DISPLAY OF DATABASE CB3 ENDED **********************

Example 3: Display information about table space TBS33 in database CB3. The
CLAIMERS option displays claim types and durations; LUWIDs and locations of
any remote threads; and connection-name , correlation-id , and authorization ID
information.
-DISPLAY DATABASE(CB3) SPACENAM(TBS33) CLAIMERS

The following output is generated:

DSNT360I - ***********************************************************
DSNT361I - * DISPLAY DATABASE SUMMARY
* GLOBAL CLAIMERS
DSNT360I - ***********************************************************
DSNT362I - DATABASE = CB3 STATUS = RW
DBD LENGTH = 4028
DSNT397I -
NAME TYPE PART STATUS CONNID CORRID CLAIMINFO
-------- ---- ----- ----------------- -------- ------------ --------
TBS33 TS 0001 RW
TBS33 TS 0002 RW
TBS33 TS 0003 RW
TBS33 TS 0004 RW LSS001 DSN2SQL (RR,C)

Chapter 24. -DISPLAY DATABASE (DB2) 173

 TBS33 TS 0004 RW LSS001 DSN2SQL (WR,C)

******* DISPLAY OF DATABASE CB3 ENDED *********************

Example 4: In a data sharing environment, display information about locks held for
a table space. The application that is identified as LSS001 on member DB1G has
locked partitions 1 and 2. LSS002 on member DB2G has locked partitions 1 and 3.
Partition 4 has no locks held on it.
-DISPLAY DATABASE(DSN8D51A) SPACENAM(TSPART) LOCKS

The following output is generated:

NAME TYPE PART STATUS CONNID CORRID LOCKINFO
-------- ---- ----- ----------------- -------- ------------ ---------
TSPART TS 0001 RO LSS001 DSN2SQL H-IS,P,C
- MEMBER NAME DB1G
TSPART TS 0001 RO H-S,PP,I
- MEMBER NAME DB1G
TSPART TS 0001 RO LSS002 DSN2SQL H-IS,P,C
- MEMBER NAME DB2G
TSPART TS 0001 RO H-S,PP,I
- MEMBER NAME DB2G
TSPART TS 0002 RW LSS001 DSN2SQL H-IS,P,C
- MEMBER NAME DB1G
TSPART TS 0002 RW H-S,PP,I
- MEMBER NAME DB1G
TSPART TS 0003 RW LSS002 DSN2SQL H-IS,P,C
- MEMBER NAME DB2G
TSPART TS 0003 RW H-S,PP,I
- MEMBER NAME DB2G
TSPART TS 0004 RW

If DB2 cannot selectively lock the partitions, it must lock all of the partitions and
the display looks similar to the following output. The LOCKINFO field shows a
value of S, indicating that this is a table space lock. If partitions are held in
different statuses, those statuses are listed below the table space locks.
NAME TYPE PART STATUS CONNID CORRID LOCKINFO
-------- ---- ----- ----------------- -------- ------------ ---------
TSPART TS LSS001 DSN2SQL H-IS,S,C
- MEMBER NAME DB1G
TSPART TS LSS002 DSN2SQL H-IS,S,C
- MEMBER NAME DB2G
TSPART TS 0001 RO H-S,PP,I
- MEMBER NAME DB1G
TSPART TS 0002 RW H-S,PP,I
- MEMBER NAME DB2G
TSPART TS 0003 RW H-S,PP,I
- MEMBER NAME DB2G
TSPART TS 0004 RW

Example 5: Display information about page sets in database DSNDB01 that have
entries in the logical page list. Limit the number of messages displayed to the
space available.
-DB1G DISPLAY DATABASE(DSNDB01) SPACENAM(*) LIMIT(*) LPL

The following output is generated:

***********************************************************
DSNT361I -DB1G * DISPLAY DATABASE SUMMARY
* GLOBAL LPL
DSNT360I -DB1G
***********************************************************
DSNT362I -DB1G DATABASE = DSNDB01 STATUS = RW
DBD LENGTH = 8000

174 Command Reference

DSNT397I -DB1G
NAME TYPE PART STATUS LPL PAGES
-------- ---- ----- ----------------- ------------------
DBD01 TS RW,LPL,GRECP 000001,000004,00000C,000010
---- 000039-00003C
SPT01 TS RW
SCT02 TS RW
SYSLGRNG TS RW
SYSUTILX TS RW
SYSLGRNX TS RW,LPL,GRECP 000000-FFFFFF
DSNSCT02 IX RW
DSNSPT01 IX RW
DSNSPT02 IX RW
DSNLUX01 IX RW
DSNLUX02 IX RW
DSNLLX01 IX RW
DSNLLX02 IX RW
******* DISPLAY OF DATABASE DSNDB01 ENDED **********************
DSN9022I -DB1G DSNTDDIS 'DISPLAY DATABASE' NORMAL COMPLETION

Example 6: Suppose DB2 is unable to selectively lock the partitions of table space
TSPART, which is in database DSN8D81A. When you specify the following
command, two applications are accessing TSPART, and the partitions have different
statuses.
-DB1G DISPLAY DATABASE(DSN8D81A) SPACE(TSPART) PART(1,4) LOCKS

DB2 displays the locks as table space locks, as shown in the following output:
NAME TYPE PART STATUS CONNID CORRID LOCKINFO
-------- ---- ----- ----------------- -------- ------------ ---------
TSPART TS LSS001 DSN2SQL H-IS,S,C
TSPART TS LSS002 DSN2SQL H-IS,S,C
TSPART TS 0001 RO
TSPART TS 0004 RW

Example 7: Suppose that you have executed the ALTER TABLESPACE statement
on table space TSPART so that TSPART is now defined with LOCKPART YES.
LOCKPART YES causes DB2 to do selective partition locking on TSPART. When
you specify the following command, two applications are accessing TSPART. The
application identified by connection ID LSS001 has locked partitions 1 and 2. The
application identified by connection ID LSS002 has locked partitions 1 and 3.
-DB1G DISPLAY DATABASE(DSN8D81A) SPACE(TSPART) PART(1:4) LOCKS

DB2 displays the locks as partition locks, as shown in the following output:
NAME TYPE PART STATUS CONNID CORRID LOCKINFO
-------- ---- ----- ----------------- -------- ------------ ---------
TSPART TS 0001 RO LSS001 DSN2SQL H-IS,P,C
TSPART TS 0001 RO LSS002 DSN2SQL H-IS,P,C
TSPART TS 0002 RW LSS001 DSN2SQL H-IS,P,C
TSPART TS 0003 RW LSS002 DSN2SQL H-IS,P,C
TSPART TS 0004 RW

Example 8: Display information about all table spaces and index spaces in the
range of databases from DBKD0101 to DBKD0106 that are in a restrictive status.
Limit the number of messages that are displayed to the available space.
-DISPLAY DATABASE(DBKD0101,DBKD0103) SPACENAM(*) RESTRICT LIMIT(*)

The following output is generated:

DSNT360I - ***********************************
DSNT361I - * DISPLAY DATABASE SUMMARY
* RESTRICTED

Chapter 24. -DISPLAY DATABASE (DB2) 175

 DSNT360I - ***********************************
DSNT362I - DATABASE = DBKD0101 STATUS = RW
DBD LENGTH = 4028
DSNT397I -
NAME TYPE PART STATUS PHYERRLO PHYERRHI CATALOG PIECE
-------- ---- ----- ----------------- -------- -------- -------- -----
TLKD0101 TS RW,RESTP
IUKD011A IX RW,RESTP
IXKD011B IX RW,RESTP

Example 9: Display information about all table spaces that are in the auxiliary
warning advisory status (AUXW), and all index spaces that are in informational
COPY-pending status (ICOPY) in database DBIQUQ01. Limit the number of
messages that are displayed to the available space.
-DISPLAY DATABASE(DBIQUQ01) SPACENAM(*) LIMIT(*) ADVISORY

The following output is generated:

DSNT360I - ***********************************
DSNT361I - * DISPLAY DATABASE SUMMARY
* ADVISORY
DSNT360I - ***********************************
DSNT362I - DATABASE = DBIQUQ01 STATUS = RW
DBD LENGTH = 8066
DSNT397I -
NAME TYPE PART STATUS PHYERRLO PHYERRHI CATALOG PIECE
-------- ---- ----- ----------------- -------- -------- -------- -----
TPIQUQ01 TS 0001 RW,AUXW
-THRU 0004
IAIQUQ01 IX RW,ICOPY
IAIQUQ02 IX RW,ICOPY
IAIQUQ03 IX RW,ICOPY
IAIQUQ04 IX RW,ICOPY
IPIQUQ01 IX 0001 RW,ICOPY
-THRU 0004
IUIQUQ03 IX RW,ICOPY
IXIQUQ02 IX RW,ICOPY
******* DISPLAY OF DATABASE DBIQUQ01 ENDED **********************
DSN9022I - DSNTDDIS 'DISPLAY DATABASE' NORMAL COMPLETION

Example 10: Display a list of all objects in database DB486A. This example shows
five objects in the database. TS486A is a table space with four parts and TS486C is
a nonpartitioned table space. IX486A is a nonpartitioned index for table space
TS486A, IX486B is a partitioned index with four parts, and IX486C is a
nonpartitioned index.
-DISPLAY DATABASE(DB486A) SPACE(*) OVERVIEW

The following output is generated:

DSNT360I - ***********************************
DSNT361I - * DISPLAY DATABASE SUMMARY
* GLOBAL OVERVIEW
DSNT360I - ***********************************
DSNT362I - DATABASE = DB486A STATUS = RW
DBD LENGTH = 4028
DSNT397I -
NAME TYPE PART
-------- ---- -----
TS486A TS 0004
IX486A IX L0004
IX486B IX 0004
TS486C TS
IX486C IX
******* DISPLAY OF DATABASE DB486A ENDED **********************
DSN9022I - DSNTDDIS 'DISPLAY DATABASE' NORMAL COMPLETION

176 Command Reference

Example 11: Display database DB486B, specifying SPACE(*) for all spaces. This
example shows table space TS486X with partitions 1 through 6 in STOP status.
Partition 7 is in UT and COPY status, partition 8 is in STOP status, and partitions 9
and 10 are in RW status.
-DISPLAY DATABASE(DB486B) SPACE(*)

The following output is generated:

DSNT360I - ***********************************
DSNT361I - * DISPLAY DATABASE SUMMARY
* GLOBAL OVERVIEW
DSNT360I - ***********************************
DSNT362I - DATABASE = DB486B STATUS = RW
DBD LENGTH = 4028
DSNT397I -
NAME TYPE PART STATUS PHYERRLO PHYERRHI CATALOG PIECE
-------- ---- ----- ----------------- -------- -------- -------- -----
TS486X TS 0001 STOP
- THRU 0006
TS486X TS 0007 UT,COPY
TS486X TS 0008 STOP
TS486X TS 0009 RW
- THRU 0010
IX486X IX L0001 RW
IX486X IX L0002 LSTOP
- THRU L0003
IX486X IX L0004 LSTOP
- THRU L0010
IX486Y IX 0001 RW
- THRU 0010
IX486Z IX RW
******* DISPLAY OF DATABASE DB486B ENDED **********************
DSN9022I - DSNTDDIS 'DISPLAY DATABASE' NORMAL COMPLETION

Example 12: Display information about all indexes in the DBKD0101 database.
INDEX2 contains information to be displayed at a logical level. Partitions 0001 and
0002 of INDEX3 are data-partitioned secondary indexes, as indicated by ’D’ in the
partition number.
-DISPLAY DATABASE(DBKD0101) SPACENAM(INDEX*)

The following output is generated:

DSNT360I - ***********************************
DSNT361I - * DISPLAY DATABASE SUMMARY
* RESTRICTED
DSNT360I - ***********************************
DSNT362I - DATABASE = DBKD0101 STATUS = RW
DBD LENGTH = 4028
DSNT397I -
NAME TYPE PART STATUS PHYERRLO PHYERRHI CATALOG PIECE
-------- ---- ----- ----------------- -------- -------- -------- -----
INDEX1 IX 0001 RW
-THRU 0002
INDEX2 IX L* RW
INDEX3 IX D0001 RW
-THRU D0002
INDEX4 IX L0001 RECP
INDEX4 IX L0002 RW

Example 13: Display information about all table spaces in the DBKD0103 database
that are in the advisory REBUILD-pending status (ARBDP) and the advisory
REORG-status (AREO*). Limit the number of messages that are displayed to the
available space. Assume that you specify the following command:
-DISPLAY DATABASE(DBKD0103) SPACENAM(*) LIMIT(*) ADVISORY(ARBDP,AREO*)

Chapter 24. -DISPLAY DATABASE (DB2) 177

 The following output is generated:
DSNT360I - ***********************************
DSNT361I - * DISPLAY DATABASE SUMMARY
* ADVISORY
DSNT360I - ***********************************
DSNT362I - DATABASE = DBKD0103 STATUS = RW
DBD LENGTH = 16142
DSNT397I -
NAME TYPE PART STATUS PHYERRLO PHYERRHI CATALOG PIECE
-------- ---- ----- ----------------- -------- -------- -------- -----
PIX IX 0001 RW,ARBDP,AREO*
-THRU 0007

Example 14: Display information about table space DB2TSP in database DB2. The
PART option includes both lists and ranges to display a very specific set of
partitions. The table space underwent a single ROTATE operation before the final
partitions were added.
-DISPLAY DATABASE(DB2) SPACENAME(DB2TSP) PART(1,2,4:6,9,10:12)

The following output is generated:

DSNT360I - ***********************************
DSNT361I - * DISPLAY DATABASE SUMMARY
* GLOBAL
DSNT360I - ***********************************
DSNT362I - DATABASE = DB2 STATUS = RW
DBD LENGTH = 4028
DSNT397I -
NAME TYPE PART STATUS PHYERRLO PHYERRHI CATALOG PIECE
-------- ---- ----- ----------------- -------- -------- -------- -----
DB2TSP TS 0002 RW,AREO*
DB2TSP TS 0004 RW
DB2TSP TS 0001 RW,AREO*
DB2TSP TS 0005 RW
-THRU 0006
DB2TSP TS 0009 RW
-THRU 0012
******* DISPLAY OF DATABASE DB2 ENDED ****************************
DSN9022I - DSNTDDIS 'DISPLAY DATABASE' NORMAL COMPLETION

Example 15: If the table space is opened for update while it has the NOT LOGGED
attribute the table space is placed in the Informational Copy Pending state. The
DISPLAY DATABASE ADVISORY command is enhanced to display the
Informational Copy Pending (ICOPY) state for table spaces in the database.
-DISPLAY DATABASE(DBIQUQ01) SPACENAM(*) ADVISORY

The following output is generated:

DSNT360I - ***********************************
DSNT362I - DATABASE = DBIQUQ01 STATUS = RW
DBD LENGTH = 8066
DSNT397I -
NAME TYPE PART STATUS HYERRLO PHYERRHI CATALOG PIECE
-------- ---- ---- ------------------ -------- -------- -------- -----
TPIQUQ01 TS 001 RW,AUXW
TPIQUQ01 TS 002 RW,AUXW
TPIQUQ01 TS 003 RW,AUXW
TPIQUQ01 TS 004 RW,ICOPY

Example 16: Display information about base table and clone table objects as well as
objects that are not involved with cloning.
-DISPLAY DATABASE(MYDB*) SPACENAM(*) LIMIT(*)

178 Command Reference

The following output is generated:
DSNT360I - ***********************************
DSNT361I - * DISPLAY DATABASE SUMMARY
* GLOBAL
DSNT360I - ***********************************
DSNT362I - DATABASE = MYDBX STATUS = STOP
DBD LENGTH = 4028
DSNT397I -
NAME TYPE PART STATUS PHYERRLO PHYERRHI CATALOG PIECE
-------- ---- ----- ----------------- -------- -------- -------- -----
CHKOUT2 TSB1 001 RW
CHKOUT2 TSB1 002 RW
CHKOUT2 TSB1 003 RW
XDEPT1 IXB1 001 RECP
XDEPT1 IXB1 002 RW
XDEPT1 IXB1 003 RW
CHKOUT2 TSC2 001 RO
CHKOUT2 TSC2 002 RW
CHKOUT2 TSC2 003 RW
XDEPT1 IXC2 001 ICOPY
XDEPT1 IXC2 002 RW
XDEPT1 IXC2 003 RW
CHKOUT3 TS 001 RO
CHKOUT3 TS 002 RO
CHKOUT3 TS 003 RO
XDEPT3 IX 001 RW
XDEPT3 IX 002 RW
XDEPT3 IX 003 RO

Chapter 24. -DISPLAY DATABASE (DB2) 179

180 Command Reference
Chapter 25. -DISPLAY DDF (DB2)
The DISPLAY DDF command displays information regarding the status and
configuration of DDF, as well as statistical information regarding connections or
threads controlled by DDF.

Abbreviation: -DIS DDF

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Output” on page 182
v “Examples” on page 182

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v DISPLAY privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

DISPLAY DDF

DETAIL

Option descriptions
DETAIL
Displays additional statistics and configuration information.

© Copyright IBM Corp. 1983, 2009 181

 Output

The DISPLAY DDF command displays the following output:

STATUS
The operational status of DDF.
LOCATION
The location name of DDF.
LUNAME
The fully qualified LUNAME of DDF.
GENERICLU
The fully qualified generic LUNAME of DDF.
IPADDR
The IP address of DDF.
TCPPORT
The SQL listener port used by DDF.
RESPORT
The resync listener port used by DDF.
DOMAIN
The SQL and resync domains used by DDF.
| SECPORT
| The TCP/IP SQL listener port used by DDF to accept inbound SSL
| connections.

| Message DSNL087I displays column headers for a table that contains the alias
| names and their associated ports. Message DSNL088I displays each alias name,
| and its associated port (if any), defined in the BSDS DDF record. The DSNL087I
| and DSNL088I are provided only if alias information is present in the BSDS DDF
| record.

Examples

Example 1: The following command is used to display a DDF detail report where
DDF has not yet been started:
#display ddf detail

This command produces output similar to the following output:

| DSNL081I STATUS=STOPDQ
| DSNL082I LOCATION LUNAME GENERICLU
| DSNL083I STLEC1 -NONE.SYEC1DB2 -NONE
| DSNL084I TCPPORT=446 SECPORT=0 RESPORT=5001 IPNAME=-NONE
| DSNL085I IPADDR=NONE
| DSNL086I SQL DOMAIN=-NONE
| DSNL090I DT=A CONDBAT= 64 MDBAT= 64
| DSNL092I ADBAT= 0 QUEDBAT= 0 INADBAT= 0 CONQUED= 0
| DSNL093I DSCDBAT= 0 INACONN= 0
| DSNL099I DSNLTDDF DISPLAY DDF REPORT COMPLETE

| Example 2: The following command is used to display a DDF report, with no

| detail, where DDF is started:
| #display ddf

| This command produces output similar to the following output:

182 Command Reference

| DSNL080I ) DSNLTDDF DISPLAY DDF REPORT FOLLOWS:
| DSNL081I STATUS=STARTD
| DSNL082I LOCATION LUNAME GENERICLU
| DSNL083I STLEC1 -NONE -NONE
| DSNL084I TCPPORT=446 SECPORT=447 RESPORT=5001 IPNAME=XYZ_A
| DSNL085I IPADDR=::9.30.178.50
| DSNL085I IPADDR=ABCD::91E:B232
| DSNL086I SQL DOMAIN=xyz_ahost.ibm.com
| DSNL086I RESYNC DOMAIN=xyz_ahost.ibm.com
| DSNL087I ALIAS PORT SECPORT
| DSNL088I XYZ_S 448 449
| DSNL089I MEMBER IPADDR=::9.30.178.112
| DSNL089I MEMBER IPADDR=ABCD::91E:B270
| DSNL099I DSNLTDDF DISPLAY DDF REPORT COMPLETE

| Example 3: The following command is used to display a DDF detail report where
DDF is started:
#display ddf detail

This command produces output similar to the following output:

| DSNL080I ) DSNLTDDF DISPLAY DDF REPORT FOLLOWS: 211
| DSNL081I STATUS=STARTD
| DSNL082I LOCATION LUNAME GENERICLU
| DSNL083I STLEC1 USIBMSY.SYEC1DB2 -NONE
| DSNL084I TCPPORT=446 SECPORT=447 RESPORT=5001 IPNAME=XYZ_A
| DSNL085I IPADDR=::9.30.178.50
| DSNL085I IPADDR=ABCD::91E:B232
| DSNL086I SQL DOMAIN=xyz_ahost.ibm.com
| DSNL086I RESYNC DOMAIN=xyz_ahost.ibm.com
| DSNL087I ALIAS PORT SECPORT
| DSNL088I XYZ_S 448 449
| DSNL089I MEMBER IPADDR=::9.30.178.112
| DSNL089I MEMBER IPADDR=ABCD::91E:B270
| DSNL090I DT=A CONDBAT= 64 MDBAT= 64
| DSNL092I ADBAT= 0 QUEDBAT= 0 INADBAT= 0 CONQUED= 0
| DSNL093I DSCDBAT= 0 INACONN= 0
| DSNL100I LOCATION SERVER LIST:
| DSNL101I WT IPADDR IPADDR
| DSNL102I 64 ::9.30.178.111 ABCD::91E:B26F
| DSNL102I ::9.30.178.112 ABCD::91E:B270
| DSNL099I DSNLTDDF DISPLAY DDF REPORT COMPLETE

| Example 4: The following example shows the DISPLAY DDF command report
| when alias information is present in the BSDS DDF record.
| #display ddf

| This command produces output similar to the following output:

| #dis ddf
| DSNL080I # DSNLTDDF DISPLAY DDF REPORT FOLLOWS:
| DSNL081I STATUS=STARTD
| DSNL082I LOCATION LUNAME GENERICLU
| DSNL083I STL717A USIBMSY.SYEC717A -NONE
| DSNL084I TCPPORT=446 SECPORT=0 RESPORT=5001 IPNAME=-NONE
| DSNL085I IPADDR=::9.30.115.135
| DSNL085I IPADDR=2002:91E:610:1::5
| DSNL086I SQL DOMAIN=v7ec135.svl.ibm.com
| DSNL087I ALIAS PORT SECPORT
| DSNL088I STL717A1 551 0
| DSNL088I STL717A2 552 0
| DSNL088I STL717A3 553 0
| DSNL088I STL717A4 554 0
| DSNL088I STL717A5 555 0
| DSNL088I STL717A6 556 0

Chapter 25. -DISPLAY DDF (DB2) 183

| DSNL088I STL717A7 557 0
| DSNL088I STL717A8 558 0
| DSNL099I DSNLTDDF DISPLAY DDF REPORT COMPLETE

184 Command Reference

|

Chapter 26. -DISPLAY FUNCTION SPECIFIC (DB2)

The DB2 command DISPLAY FUNCTION SPECIFIC displays statistics about
external user-defined functions that DB2 applications access.

Abbreviation: -DIS FUNC SPEC

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group or local, depending on the value of the SCOPE option.

Authorization

To run this command, you must use a privilege set of the process that includes one
of the following authorities for each function:
v Ownership of the function
v DISPLAY privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

If you specify DISPLAY FUNCTION SPECIFIC *.* or schema.partial-name *, you

must use a privilege set of the process that includes one of the following
authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

| If you are using an external security product to authorize usage of DISPLAY

| FUNCTION SPECIFIC, define SYSOPR as a user to the external security product
| for those cases in which DISPLAY FUNCTION SPECIFIC SCOPE(GROUP) runs on
| a remote system and SYSOPR is used as the authorization ID.

© Copyright IBM Corp. 1983, 2009 185

 Syntax

DISPLAY FUNCTION SPECIFIC

(*.*) LOCAL

SCOPE ( GROUP )

,

(  schema.specific-function-name )
schema.partial-name*

Option descriptions
schema.specific-function-name
Displays information for the specific named function in the specified schema.
You cannot specify a function name as you can in SQL; you must use the
specific name. If a specific name was not specified on the CREATE FUNCTION
statement, query SYSIBM.SYSROUTINES for the correct specific name:
SELECT SPECIFICNAME, PARM_COUNT
FROM SYSIBM.SYSROUTINES
WHERE NAME='function_name'
AND SCHEMA='schema_name';

For overloaded functions, this query can return multiple rows.

schema.partial-name*
Displays information for a set of functions in the specified schema.
The specific names of all functions in the set begin with partial-name and can
end with any string, including the empty string. For example, schema1.ABC*
displays information for all functions with specific names that begin with ABC
in schema1.
(*.*)
Displays information for all functions that DB2 applications have accessed
since the DB2 subsystem was started.
SCOPE
Specifies the scope of the command.
( LOCAL )
Specifies that the display includes information from only the local member.
(GROUP)
Specifies that the display includes information from all members of the
data sharing group.

Usage notes

Displaying information for all functions: If you do not specify a partial or specific
function name, DB2 displays information for all functions that DB2 applications
have accessed since the DB2 subsystem was started.

Built-in functions or user-defined functions that are sourced on another function:

This command does not apply to built-in functions or user-defined functions that
are sourced on another function.

186 Command Reference

Output

This command displays one line of output for each function that a DB2 application
has accessed.

Information returned by this command reflects a dynamic status. By the time DB2
displays the information, the status might have changed.

Sample output: The DISPLAY FUNCTION SPECIFIC command generates the

following output:
DSNX975I = DSNX9DIS DISPLAY FUNCTION SPECIFIC REPORT FOLLOWS -

------- SCHEMA=PAYROLL
FUNCTION STATUS ACTIVE QUED MAXQ TIME FAIL WLM_ENV
APPL1 STARTED 1 0 0 0 0 PAYROLL
APPL2 STARTED 1 0 0 0 1 PAYROLL
APPL3 STARTED 0 1 2 0 0 PAYROLL
APPL5 STOPREJ 0 0 0 0 0 SANDBOX
APPL6 STOPABN 0 0 0 0 1 PAYROLL
FUNC1 STOPQUE 0 0 0 0 0 SANDBOX

DSNX9DIS DISPLAY FUNCTION SPECIFIC REPORT COMPLETE

DSN9022I = DSNX9COM '-DISPLAY FUNC' NORMAL COMPLETION

DISPLAY FUNCTION SPECIFIC command output: The DISPLAY FUNCTION

SPECIFIC command displays the following output:
FUNCTION
The specific name of the function.
STATUS
The status of the function. The possible values are:
STARTED
Requests for the function can be processed.
STOPQUE
Requests are queued.
STOPREJ
Requests are rejected.
STOPABN
Requests are rejected because of abnormal termination.
ACTIVE
The number of threads that are currently running the function.
QUED
The number of threads that are waiting for the function to be scheduled.
MAXQ
The maximum number of threads that have waited concurrently for the
function to be scheduled since the DB2 subsystem was started.
TIMEOUT
The number of times an SQL statement timed out while waiting for a
request for the function to be scheduled.
FAIL The number of times a procedure has failed. DB2 resets this value to 0
each time you run the START FUNCTION command.
WLM_ENV
The WLM environment where the function runs.

Chapter 26. -DISPLAY FUNCTION SPECIFIC (DB2) 187

 Message DSNX971I lists a range of functions that are stopped because a STOP
FUNCTION SPECIFIC command included a partial name with the
pattern-matching character (*). See the topic Chapter 87, “-STOP FUNCTION
SPECIFIC (DB2),” on page 459 for more information.

Examples

Example 1: Display information about functions in the PAYROLL schema and the
HRPROD schema.
-DISPLAY FUNCTION SPECIFIC(PAYROLL.*, HRPROD.*)

This command produces output similar to the following output:

DSNX975I = DSNX9DIS DISPLAY FUNCTION SPECIFIC REPORT FOLLOWS-

------ SCHEMA=PAYROLL
FUNCTION STATUS ACTIVE QUED MAXQ TIMEOUT FAIL WLM_ENV
PAYRFNC1 STARTED 0 0 1 0 0 WLMENV1
PAYRFNC2 STOPQUE 0 5 5 3 0 WLMENV1
PAYRFNC3 STARTED 2 0 6 0 0 WLMENV1
USERFNC4 STOPREJ 0 0 1 0 0 WLMENV3

------ SCHEMA=HRPROD
FUNCTION STATUS ACTIVE QUED MAXQ TIMEOUT FAIL WLM_ENV
HRFNC1 STARTED 0 0 1 0 0 WLMENV2
HRFNC2 STOPREJ 0 0 1 0 0 WLMENV2
DSNX9DIS DISPLAY FUNCTION SPECIFIC REPORT COMPLETE
DSN9022I = DSNX9COM '-DISPLAY FUNC' NORMAL COMPLETION

Example 2: Display information about specific functions in the PAYROLL schema.

-DISPLAY FUNCTION SPECIFIC(PAYROLL.USERFNC2,PAYROLL.USERFNC4)

This command produces output similar to the following output:

DSNX975I = DSNX9DIS DISPLAY FUNCTION SPECIFIC REPORT FOLLOWS-

------ SCHEMA=PAYROLL
FUNCTION STATUS ACTIVE QUED MAXQ TIMEOUT FAIL WLM_ENV
USERFNC2 STOPQUE 0 5 5 3 0 WLMENV3
USERFNC4 STOPREJ 0 0 1 0 0 WLMENV3
DSNX9DIS DISPLAY FUNCTION SPECIFIC REPORT COMPLETE
DSN9022I = DSNX9COM '-DISPLAY FUNC' NORMAL COMPLETION

Example 3: Display information about all functions that are in the SYSADM
schema that DB2 applications have accessed. Assume that the STOP FUNCTION
SPECIFIC(SYSADM.FN*) ACTION(QUEUE) command is in effect at the time you
Enter the following command:
-DISPLAY FUNCTION SPECIFIC(SYSADM.*)

This command produces output similar to the following output:

DSNX975I = DSNX9DIS DISPLAY FUNCTION SPECIFIC REPORT FOLLOWS-

------ SCHEMA=SYSADM
FUNCTION STATUS ACTIVE QUED MAXQ TIMEOUT FAIL WLM_ENV
FNC1 STOPQUE 0 0 0 0 0 WLMENV1
FNC2 STOPQUE 0 0 0 0 0 WLMENV3
DSNX9DIS FUNCTIONS FN - FN* STOP QUEUE
DSNX9DIS DISPLAY FUNCTION SPECIFIC REPORT COMPLETE
DSN9022I = DSNX9COM '-DISPLAY FUNC' NORMAL COMPLETION

188 Command Reference

Chapter 27. -DISPLAY GROUP (DB2)
The DB2 command DISPLAY GROUP displays information about the data sharing
group to which a DB2 subsystem belongs.

DISPLAY GROUP DETAIL displays the DB2 subsystem and group mode
(conversion mode, enabling new function mode, or DB2 Version 8 new-function
mode or later).

Abbreviation: -DIS GROUP

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions” on page 190
v “Usage notes” on page 190
v “Examples” on page 192

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v DISPLAY privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

DISPLAY GROUP

DETAIL

© Copyright IBM Corp. 1983, 2009 189

 Option descriptions
DETAIL
Displays information about the parallelism coordinator and parallelism
assistant. If the DB2 data sharing group is in enabling new-function mode,
DISPLAY GROUP DETAIL lists catalog and directory table spaces along with
their status.

Usage notes

Member status: Message DSN7106I includes information about the XCF status of
the members (STATUS in the display output). The status can be ACTIVE,
QUIESCED, or FAILED.

ACTIVE indicates that the DB2 subsystem is active, and FAILED indicates that it is
failed. A QUIESCED status results from a STOP DB2 command and consists of
several subcategories:
QUIESCED
Indicates a normal quiesced state, as the result of a normal STOP DB2
command.
Q Q (quiesced) can be paired with one or more of the following letters:
I Indoubt or postponed abort units of recovery (URs) are
outstanding. This means that retained locks are held.
| C The member was shut down without completing castout
| processing. This event might have occurred because DB2 was
| started with the LIGHT(YES) option or stopped with the
| CASTOUT(NO) option, or because an error was encountered while
| attempting to cast out data from the coupling facility to the disk.
| If DB2 encounters errors during castout processing, ensure that no
| connectivity problems exist between the coupling facility and the
| processor before restarting DB2.
R Retained information is needed for DB2 to perform
resynchronization with one or more remote locations.
When DB2 is restarted, this resynchronization occurs.
ACTIVE
Indicates a normal active state without conditions.
A The member is active, but with the additional conditions. A (active) can be
paired with the following letter:
I Indoubt or postponed abort units of recovery (URs) are
outstanding. This indicates that retained locks are held.

Using this command in a non-data-sharing environment: DB2 issues the same

response, except for information which does not exist: group name, member name,
and member ID.

Output

DISPLAY GROUP command output: The DISPLAY GROUP command displays the
following output:
*** BEGIN
The name of the DB2 group

190 Command Reference

 DB2 MEMBER
The names of the DB2 group members
ID The IDs of the DB2 group members
SUBSYS
The subsystem names of the DB2 group members
CMDPREF
The command prefix for each member
STATUS
The status of each member (ACTIVE, QUIESCED with or without
additional conditions, or FAILED)
SYSTEM NAME
The names of the z/OS system where the member is running, or was last
running in cases when the member status is QUIESCED or FAILED
LVL A string of three numeric characters that list the following information:
v DB2 version
v DB2 release
v DB2 modification level
IRLM SUBSYS
The name of the IRLM subsystem to which the DB2 member is connected
IRLMPROC
The procedure names of the connected IRLM
SCA The SCA structure size in KB and the percentage currently in use
LOCK1
The LOCK1 structure size in KB.
The display also shows the following lock information:
| v The maximum number of lock entries possible for the lock table. This
| number is an approximate value.
v The maximum number of modify lock list entries and how many of
those list entries are currently in use.
PARALLELISM COORDINATOR
Indicates whether this DB2 member can coordinate parallel processing.
PARALLELISM ASSISTANT
Indicates whether this DB2 member can assist with parallel processing.

If the output indicates that either the lock structure or SCA are 0 % in use, it does
not mean that the structure is empty. It could mean that the structure is very large
and that the number of locks held or the number of records in the SCA is less than
1 %.

Description of message DSN7101I:

GROUP
The name of the data sharing group
GROUP LEVEL
A string of three numeric characters that lists the following information:
v DB2 version
v DB2 release

Chapter 27. -DISPLAY GROUP (DB2) 191

 v DB2 modification level
DB2 release indicates the highest release with which any DB2 subsystem in
the data sharing group has been started.
MODE
| Indicates the catalog mode, as follows:
| v C indicates conversion mode.
| v E indicates enabling new function mode.
| v N indicates new-function mode.
| v E* indicates ENFM for a system that, at one time, was in new-function
| mode.
| v C* indicates CM for a system that, at one time, was at a higher level.
PROTOCOL LEVEL
This value is supplied for serviceability only.

Examples

Example 1: The following sample output for a data sharing group can be generated
by using the DISPLAY GROUP command:
-DB1A DISPLAY GROUP

| DSN7100I -DB1A DSN7GCMD

| *** BEGIN DISPLAY OF GROUP(DSNDB10 ) GROUP LEVEL(910) MODE(C)
| PROTOCOL LEVEL(2) GROUP ATTACH NAME(DB10)
| --------------------------------------------------------------------
| DB2 DB2 SYSTEM IRLM
| MEMBER ID SUBSYS CMDPREF STATUS LVL NAME SUBSYS IRLMPROC
| -------- --- ---- -------- -------- --- -------- ---- --------
| DB1A 1 DB1A -DB1A ACTIVE 910 MVSA DJ1A DB1AIRLM
| DB1B 2 DB1B -DB1B ACTIVE 910 MVSB DJ1B DB1BIRLM
| DB1C 3 DB1C -DB1C ACTIVE 910 MVSC DJ1C DB1CIRLM
| DB1D 4 DB1D -DB1D FAILED 810 MVSD DJ1D DB1DIRLM
| DB1E 5 DB1E -DB1E QUIESCED 810 MVSE DJ1E DB1EIRLM
| DB1F 6 DB1F -DB1F ACTIVE 910 MVSF DJ1F DB1FIRLM
| DB1G 7 DB1G -DB1G ACTIVE 910 MVSG DJ1G DB1GIRLM
| --------------------------------------------------------------------
| SCA STRUCTURE SIZE: 1024 KB, STATUS= AC, SCA IN USE: 11 %
| LOCK1 STRUCTURE SIZE: 1536 KB
| NUMBER LOCK ENTRIES: 262144
| NUMBER LIST ENTRIES: 7353, LIST ENTRIES IN USE: 0
| *** END DISPLAY OF GROUP(DSNDB10 )
| DSN9022I -DB1A DSN7GCMD 'DISPLAY GROUP ' NORMAL COMPLETION

Example 2: In a non-data-sharing environment, the following sample output is

generated by the DISPLAY GROUP command:
-DB1A DISPLAY GROUP

192 Command Reference

| DSN7100I -DB1A DSN7GCMD
| *** BEGIN DISPLAY OF GROUP(.......) GROUP LEVEL(...) MODE(N)
| PROTOCOL LEVEL(...) GROUP ATTACH NAME(....)
| --------------------------------------------------------------------
| DB2 DB2 SYSTEM IRLM
| MEMBER ID SUBSYS CMDPREF STATUS LVL NAME SUBSYS IRLMPROC
| -------- --- ---- -------- -------- --- -------- ---- --------
| ........ 0 DB1A -DB1A ACTIVE 910 MVSA DJ1A DB1AIRLM
| --------------------------------------------------------------------
| *** END DISPLAY OF GROUP(DSNDB10)
| DSN9022I -DB1A DSN7GCMD 'DISPLAY GROUP ' NORMAL COMPLETION

Example 3: You can obtain more information about the data sharing group, as
shown in the following example, using the DISPLAY GROUP command with
DETAIL option:
-DB1A DISPLAY GROUP DETAIL

Chapter 27. -DISPLAY GROUP (DB2) 193

 DSN7100I -DB1A DSN7GCMD
*** BEGIN DISPLAY OF GROUP(DSNCAT1) GROUPLEVEL(810) MODE(E)
PROTOCOL LEVEL(2) GROUP ATTACH NAME(CAT1)
--------------------------------------------------------------------
DB2 SYSTEM IRLM
MEMBER ID SUBSYS CMDPREF STATUS NAME LVL SUBSYS IRLMPROC
-------- --- ---- -------- -------- -------- --- ---- --------
DB1A 1 DB1A -DB1A ACTIVE MVSA 810 AR21 ARLM21
DB1B 2 DB1B -DB1B ACTIVE MVSB 810 BR21 BRLM21
DB1C 3 DB1C -DB1C ACTIVE MVSC 810 CRLM CRLM21
DB2D 4 DB2D -DB2D FAILED MVSD 810 DR21 DRLM21
DB2E 5 DB2E -DB2E QUIESCED MVSE 810 ER21 ERLM21
DB2F 6 DB2F -DB2F ACTIVE MVSF 810 FR21 FRLM21
DB2G 7 DB2G -DB2G ACTIVE MVSG 810 GR21 GRLM21
--------------------------------------------------------------------
DB2 PARALLEL PARALLEL
MEMBER COORDINATOR ASSISTANT
-------- ----------- ---------
DB2A YES NO
DB2B YES YES
DB2B YES YES
DB1C **** ****
DB2D **** ****
DB2E **** ****
DB2F NO YES
DB2G NO NO
--------------------------------------------------------------------
TABLE ENABLED FOR
SPACE NEW FUNCTION
-------- ------------
SPTR YES
SYSDBASE YES
SYSDBAUT YES
SYSDDF YES
SYSGPAUT YES
SYSGROUP YES
SYSGRTNS YES
SYSHIST YES
SYSJAVA YES
SYSOBJ NO
SYSPKAGE NO
SYSPLANP NO
SYSSEQ NO
SYSSEQ2 NO
SYSSTATS NO
SYSSTR NO
SYSUSER NO
SYSVIEWS NO
--------------------------------------------------------------------

SCA STRUCTURE SIZE: 1024 KB, STATUS= AC, SCA IN USE: 11 %

| LOCK1 STRUCTURE SIZE: 1536 KB
| NUMBER LOCK ENTRIES: 262144NUMBER LIST ENTRIES: 7353, LIST ENTRIES IN USE: 0
*** END DISPLAY OF GROUP(DSNCAT )
DSN9022I -DB1A DSN7GCMD 'DISPLAY GROUP ' NORMAL COMPLETION

194 Command Reference

Chapter 28. -DISPLAY GROUPBUFFERPOOL (DB2)
The DB2 command DISPLAY GROUPBUFFERPOOL displays information about
the status of DB2 group buffer pools. It can also display related statistics.

Abbreviation: -DIS GBPOOL

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 196
v “Option description” on page 196
v “Output” on page 197
v “Examples” on page 202

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v DISPLAY privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 195

 Syntax

DISPLAY GROUPBUFFERPOOL

*
,

(  gbpname )
structure-name

* MDETAIL
TYPE( GCONN ) INTERVAL
MCONN ( )
NOCACHE *


GDETAIL NO
INTERVAL CONNLIST( YES )
( )
*

Option description
(*)
Displays the group buffer pool status for all group buffer pools.
( gbpname )
Names the group buffer pool for which status is to be displayed.
v 4-KB group buffer pools are named GBP0 through GBP49
v 8-KB group buffer pools are named GBP8K0 through GBP8K9
v 16-KB group buffer pools are named GBP16K0 through GBP16K9
v 32-KB group buffer pools are named GBP32K through GBP32K9
( structure-name )
Names the backing coupling facility structure for the group buffer pool. The
coupling facility structure name has the following format:
groupname_gbpname

where groupname is the DB2 data sharing group name and the underscore (_)
separates groupname and gbpname .
TYPE
Indicates the type of group buffer pools (among those that are specified) for
which information is displayed.
(*)
All group buffer pools are specified. This is the default.
(GCONN)
Group buffer pools that are currently connected to any member of the data
sharing group. The connection can be “active” or “failed-persistent”.
(MCONN)
Group buffer pools that are currently connected to the member to which
the command is directed.

196 Command Reference

 (NOCACHE)
Group buffer pools that have the GBPCACHE attribute set to NO.
MDETAIL
Shows a detailed statistical report for the specified group buffer pools,
reflecting the member’s activity for each group buffer pool. If the member to
which the command is directed has never been actively connected to the group
buffer pool, no detail report is shown.
(INTERVAL)
Shows incremental statistics. The values displayed are accumulated since
the last MDETAIL(INTERVAL) report for this member, if there was one.
This is the default.
(*) Shows cumulative statistics. The values displayed are accumulated since
this member first connected to the group buffer pool.
GDETAIL
Shows a detailed statistical report for the specified group buffer pools,
reflecting the activity of the entire group for each group buffer pool. If the
member to which the command is directed is not actively connected to the
group buffer pool, no detail report is shown.
(INTERVAL)
Shows incremental statistics. The values displayed are accumulated since
the last GDETAIL(INTERVAL) report, if there was one. This is the default.
(*) Shows cumulative statistics. The values displayed are accumulated since
the group buffer pool was most recently allocated or reallocated.
CONNLIST
Specifies whether a connection list report is shown for the specified group
buffer pools, listing the connection names of the subsystems that are currently
connected to the group buffer pools and their connection status.
(NO)
Do not show the connection list report.
(YES)
Show the connection list report.

Output

The DISPLAY GROUPBUFFERPOOL command can produce the following the

three report types:
v A summary report
v A group detail report
v A member detail report

Summary report

You can display summary information about group buffer pools. The report
indicates whether this DB2 subsystem is actively connected to the group buffer
pools for which you requested information. The summary report also shows the
following information:

Group buffer pool characteristics:

v Threshold values
v Directory-to-data entry ratio (both pending and current)

Chapter 28. -DISPLAY GROUPBUFFERPOOL (DB2) 197

 v Checkpoint interval
v Recovery status (whether damage assessment is pending)

CFRM policy information about the group buffer pool:

v The allocation value specified in the CFRM policy and whether the group buffer
pool is currently allocated in the coupling facility.
v The actual allocated size (which can be different from that specified in the
CFRM policy) and volatility status. DB2 requests nonvolatile storage; however, it
can allocate in a volatile structure.
v The actual number of directory entries, data pages, and connections to the group
buffer pool.
The summary report contains additional information as follows:
AUTOMATIC RECOVERY
Indicates whether automatic recovery is allowed for this group buffer pool.
DUPLEX
Indicates the current duplexing option for the group buffer pool that is
specified in the active CFRM policy.
REBUILD STATUS
Indicates whether a rebuild is in progress for this group buffer pool. If so,
the phase of the rebuild is indicated as either QUIESCE, CONNECT, or
CLEANUP. If the rebuild is in the process of stopping, the status indicates
STOPPING.
DUPLEXING STATUS
Indicates the current state of the group buffer pool with respect to
duplexing.
CFNAME
Indicates the name of the coupling facility in which the group buffer pool
is allocated. If the group buffer pool is duplexed, this is the coupling
facility name associated with the primary group buffer pool.
CFLEVEL
Indicates the level of the coupling facility in which the group buffer pool is
allocated. If the group buffer pool is duplexed, this is the coupling facility
level associated with the primary group buffer pool.
Both the operational and actual levels of the coupling facility are shown.
The operational level indicates the capabilities of the coupling facility from
the DB2 subsystem perspective. The actual level is the level as displayed
by the z/OS D CF command.
LAST GROUP BUFFER POOL CHECKPOINT
Indicates the date and time of the last group buffer pool checkpoint, the
LRSN that was recorded at that checkpoint, and the member name of the
group buffer pool structure owner.

Group detail report

The group detail report shows detailed statistical information reflecting the activity
of the entire group for the specified group buffer pools. This statistical information
is helpful in tuning the size and other characteristics of group buffer pools. The
group detail report includes the same information as the summary report in
addition to the following information:

198 Command Reference

READS
Information about reads.
This is a detailed accounting of the number of reads against the group
buffer pool, including the following:
v The number of reads where data was returned.
v The number of reads where data was not returned, broken down to
include more detailed information about whether the page was cached
in the coupling facility or not, and whether directory entries needed to
be created to fulfill requests for data.
WRITES
Information about writes.
This includes the number of writes for clean pages and changed pages,
and how many writes failed because there was not enough storage in the
group buffer pool.
CHANGED PAGES SNAPSHOT VALUE
The number of changed pages currently in the group buffer pool (a
snapshot value).
RECLAIMS
The number of reclaims of directory entries and data pages.
CASTOUTS
The number of castouts.
CROSS INVALIDATIONS
The number of cross-invalidations that occurred because of directory
reclaims and because of writes.
DUPLEXING STATISTICS FOR GBP n
This section of output indicates detailed duplexing statistics as follows:
CHANGED PAGES
Indicates the number of changed pages that are written to the
secondary group buffer pool. If the group buffer pool has been
duplexed for the entire reporting interval, this number
approximates the CHANGED PAGES counter that is reported in
message DSNB786I for the primary group buffer pool. The counts
might not be exactly the same, due to timing periods for gathering
the counter information for display or previous transaction failures
that might have occurred.
FAILED DUE TO LACK OF STORAGE
Indicates the number of writes to the secondary group buffer pool
that failed due to a lack of storage.
CHANGED PAGES SNAPSHOT VALUE
Indicates the number of changed pages that are currently cached in
the secondary group buffer pool. This number approximates the
CHANGED PAGES SNAPSHOT VALUE for the primary group
buffer pool, but is probably not identical due to the asynchronous
nature of gathering statistics for the two different coupling facility
structures.

Member detail report

The member detail report includes the summary report and additional information
about how a particular member’s system is responding to the current environment.

Chapter 28. -DISPLAY GROUPBUFFERPOOL (DB2) 199

 It categorizes reads and writes as synchronous or asynchronous. A large number of
synchronous reads or writes can indicate that you need to tune your group buffer
pools.
GBP CHECKPOINTS TRIGGERED
The number of checkpoints that occurred for this group buffer pool.
PARTICIPATION IN REBUILD
The number of times this member participated in a rebuild for this group
buffer pool.
CASTOUTS
This section of output indicates detailed statistics for castout processing as
follows:
PAGES CAST OUT
Indicates how many data pages were cast out of the group buffer
pool by this member.
UNLOCK CASTOUT
The number of times that DB2 issued an unlock request to the
coupling facility for castout I/Os that completed. As pages are cast
out to disk, they are ″locked for castout″ in the coupling facility.
The castout lock ensures that only one system is doing castout for
a given page.
DB2 usually includes multiple pages in the write I/O request to
disk for castout. Therefore, the UNLOCK CASTOUT counter
should always be less than or equal to the value of the PAGES
CASTOUT counter; it should be significantly less if multiple pages
are written per I/O. For example, if there are four pages written
per castout write I/O on average, PAGES CASTOUT should be
four times larger than UNLOCK CASTOUT.
READ CASTOUT CLASS
Number of requests made to the group buffer pool to determine
which pages belonging to a given page set or partition are cached
in the group buffer pool as changed pages and thus need to be cast
out.
READ CASTOUT CLASS is issued by the page set or partition
castout owner, and it is also issued by the group buffer pool
structure owner when the GBPOOLT threshold has been reached.
READ CASTOUT STATISTICS
The number of requests that are issued by the group buffer pool
structure owner when the GBPOOLT threshold is reached. This
determines which castout classes have changed pages. Generally
READ CASTOUT STATISTICS is issued only once or twice for each
occurrence of the GBPOOLT threshold.
READ DIRECTORY INFO
The number of requests to read the directory entries of all changed
pages in the group buffer pool. The group buffer pool structure
owner issues these requests at group buffer pool checkpoints. The
purpose of the request is to determine the oldest recovery LRSN to
use in case the group buffer pool fails. This recovery LRSN is
displayed in message DSNB798I.
The request to read directory information might be issued several
times for each group buffer pool checkpoint. If you see an

200 Command Reference

 abnormally high number here, it might be that the requests are
being cut short by the model-dependent timeout criteria of the
coupling facility. To help alleviate this problem, upgrade those
coupling facilities to CFLEVEL=2 or above.
OTHER INTERACTIONS
This section of the output lists details of other interactions that this DB2
has with this group buffer pool.
REGISTER PAGE
The number of times that DB2 registered interest to the group
buffer pool for a single page. These are register-only requests,
meaning that DB2 is not requesting that any data be returned for
the page because no data is cached in the group buffer pool for
this page. The REGISTER PAGE request is made only to create a
directory entry for the page for cross-invalidation when
downgrading the P-lock on a page set or partition from S mode to
IS mode, or from SIX mode to IX mode.
UNREGISTER PAGE
The number of times that DB2 reversed registered interest from the
group buffer pool for a single page. This is generally done as DB2
uses pages from the local buffer pool that belong to partitions or
page sets that are group buffer pool dependent.
DELETE NAME
The number of times that DB2 issued a request to the group buffer
pool to delete directory and data entries that were associated with
a given page set or partition. DB2 issues this request:
v When it converts a page set or partition from group buffer pool
dependent to non group buffer pool dependent.
v When the first DB2 member opens the object for GBPCACHE
ALL objects.
READ STORAGE STATS
The number of times that DB2 requested statistics information from
the group buffer pool. This number should be relatively low. It is
issued once per group buffer pool checkpoint by the group buffer
pool structure owner. It is also issued for DISPLAY
GROUPBUFFERPOOL GDETAIL requests and to record IFCID
0254.
DUPLEXING STATISTICS FOR GBP0-SEC
This section of the output lists details of other interactions that this DB2
has with this group buffer pool.
CHANGED PAGES
Indicates the number of changed pages written to the secondary
group buffer pool. This number approximates the sum of the
synchronous writes of changed pages to the primary group buffer
pool and the asynchronous writes of changed pages to the primary
group buffer pool. The counts might not be exactly the same, due
to timing periods for gathering the counter information for display
or previous transaction failures that might have occurred.
FAILED DUE TO LACK OF STORAGE
Indicates the number of writes to the secondary group buffer pool
that failed due to a lack of storage.

Chapter 28. -DISPLAY GROUPBUFFERPOOL (DB2) 201

 COMPLETION CHECKS SUSPENDED
Indicates the number of times DB2 checked for the completion of
the write of a changed page to the secondary group buffer pool,
but the write had not yet completed; DB2 suspends the execution
unit until the write to the secondary group buffer pool completes.
DELETE NAME LIST
Indicates the number of DELETE NAME LIST requests to delete a set of
pages from the secondary group buffer pool that have just been cast out to
disk from the primary group buffer pool.
READ CASTOUT STATISTICS
Indicates the number of READ CASTOUT STATISTICS requests to check
for orphaned data entries in the secondary group buffer pool. The DB2
member that is the group buffer pool structure owner periodically issues
these requests to determine whether garbage collection is necessary.
DELETE NAME
Indicates the number of DELETE NAME requests to delete orphaned data
entries from the secondary group buffer pool. The DB2 member that is the
group buffer pool structure owner issues these requests if it determines
that garbage collection is necessary.

Examples

Example 1: This is an example of a summary report that can be produced by the

following command:
-DISPLAY GROUPBUFFERPOOL(GBP29)

Message DSNB799I is displayed if the group buffer pool is duplexed and the
secondary group buffer pool is currently allocated. If a secondary group buffer
pool is not allocated, message DSNB799I is not included in the output.

202 Command Reference

DSNB750I - DISPLAY FOR GROUP BUFFER POOL GBP29 FOLLOWS
DSNB755I - DB2 GROUP BUFFER POOL STATUS
CONNECTED = YES
CURRENT DIRECTORY TO DATA RATIO = 5
PENDING DIRECTORY TO DATA RATIO = 5
CURRENT GBPCACHE ATTRIBUTE = YES
PENDING GBPCACHE ATTRIBUTE = YES
DSNB756I - CLASS CASTOUT THRESHOLD = 10%
GROUP BUFFER POOL CASTOUT THRESHOLD = 50%
GROUP BUFFER POOL CHECKPOINT INTERVAL = 8 MINUTES
RECOVERY STATUS = NORMAL
AUTOMATIC RECOVERY = Y
DSNB757I - MVS CFRM POLICY STATUS FOR DSNCAT_GBP29 = NORMAL
MAX SIZE INDICATED IN POLICY = 2048 KB
DUPLEX INDICATOR IN POLICY = ENABLED
CURRENT DUPLEXING MODE = DUPLEX
ALLOCATED = YES
DSNB758I - ALLOCATED SIZE = 2048 KB
VOLATILITY STATUS = VOLATILE
REBUILD STATUS = DUPLEXED
CFNAME = CACHE01
OPERATIONAL CFLEVEL = 5
ACTUAL CFLEVEL = 7
DSNB759I - NUMBER OF DIRECTORY ENTRIES = 1950
NUMBER OF DATA PAGES = 389
NUMBER OF CONNECTIONS = 2
DSNB798I - LAST GROUP BUFFER POOL CHECKPOINT
17:08:41 OCT 16, 2002
GBP CHECKPOINT RECOVERY LRSN = AF6BBAEF3307
STRUCTURE OWNER = V61B
DSNB799I - SECONDARY GBP ATTRIBUTES
ALLOCATED SIZE = 2048 KB
VOLATILITY STATUS = VOLATILE
CFNAME = LF01
OPERATIONAL CFLEVEL = 5
ACTUAL CFLEVEL = 7
NUMBER OF DIRECTORY ENTRIES = 1950
NUMBER OF DATA PAGES = 389
DSNB790I - DISPLAY FOR GROUP BUFFER POOL GBP29 IS COMPLETE
DSN9022I - DSNB1CMD '-DISPLAY GBPOOL' NORMAL COMPLETION

Example 2: Assume you want a summary report about group buffer pool 29
(GBP29), including all connections to that group buffer pool. Enter the following
command:
-DISPLAY GROUPBUFFERPOOL(GBP29) CONNLIST(YES)

This command produces output similar to the following output:

Chapter 28. -DISPLAY GROUPBUFFERPOOL (DB2) 203

 DSNB750I - DISPLAY FOR GROUP BUFFER POOL GBP29 FOLLOWS
DSNB755I - DB2 GROUP BUFFER POOL STATUS
CONNECTED = YES
CURRENT DIRECTORY TO DATA RATIO = 5
PENDING DIRECTORY TO DATA RATIO = 5
CURRENT GBPCACHE ATTRIBUTE = YES
PENDING GBPCACHE ATTRIBUTE = YES
DSNB756I - CLASS CASTOUT THRESHOLD = 10%
GROUP BUFFER POOL CASTOUT THRESHOLD = 50%
GROUP BUFFER POOL CHECKPOINT INTERVAL = 8 MINUTES
RECOVERY STATUS = NORMAL
AUTOMATIC RECOVERY = Y
DSNB757I - MVS CFRM POLICY STATUS FOR DSNCAT_GBP29 = NORMAL
MAX SIZE INDICATED IN POLICY = 2048 KB
DUPLEX INDICATOR IN POLICY = ENABLED
CURRENT DUPLEXING MODE = SIMPLEX
ALLOCATED = YES
DSNB758I - ALLOCATED SIZE = 2048 KB
VOLATILITY STATUS = VOLATILE
REBUILD STATUS = DUPLEXED
CFNAME = CACHE01
OPERATIONAL CFLEVEL = 5
ACTUAL CFLEVEL = 7
DSNB759I - NUMBER OF DIRECTORY ENTRIES = 1950
NUMBER OF DATA PAGES = 389
NUMBER OF CONNECTIONS = 2
DSNB798I - LAST GROUP BUFFER POOL CHECKPOINT
17:08:41 OCT 16, 2002
GBP CHECKPOINT RECOVERY LRSN = AF6BBAEF3307
STRUCTURE OWNER = V61B
DSNB799I - SECONDARY GBP ATTRIBUTES
ALLOCATED SIZE = 2048 KB
VOLATILITY STATUS = VOLATILE
CFNAME = LF01
OPERATIONAL CFLEVEL = 5
ACTUAL CFLEVEL = 7
NUMBER OF DIRECTORY ENTRIES = 1950
NUMBER OF DATA PAGES = 389
DSNB766I - THE CONNLIST REPORT FOLLOWS
DSNB767I - CONNECTION NAME = DB2_V61B , CONNECTION STATUS = D
CONNECTOR'S RELEASE = 6100
DSNB767I - CONNECTION NAME = DB2_V61A , CONNECTION STATUS = D
CONNECTOR'S RELEASE = 6100
DSNB769I - THE CONNLIST REPORT IS COMPLETE
DSNB790I - DISPLAY FOR GROUP BUFFER POOL GBP29 IS COMPLETE
DSN9022I - DSNB1CMD '-DISPLAY GBPOOL' NORMAL COMPLETION

Example 3: This example shows a group detail report that is produced by the
following command:
-DISPLAY GROUPBUFFERPOOL(GBP29) GDETAIL(*)

Message DSNB762I is displayed in the output only if the secondary group buffer
pool is allocated.

204 Command Reference

DSNB750I - DISPLAY FOR GROUP BUFFER POOL GBP29 FOLLOWS
DSNB755I - DB2 GROUP BUFFER POOL STATUS
CONNECTED = YES
CURRENT DIRECTORY TO DATA RATIO = 5
PENDING DIRECTORY TO DATA RATIO = 5
CURRENT GBPCACHE ATTRIBUTE = YES
PENDING GBPCACHE ATTRIBUTE = YES
DSNB756I - CLASS CASTOUT THRESHOLD = 10%
GROUP BUFFER POOL CASTOUT THRESHOLD = 50%
GROUP BUFFER POOL CHECKPOINT INTERVAL = 8 MINUTES
RECOVERY STATUS = NORMAL
AUTOMATIC RECOVERY = Y
DSNB757I - MVS CFRM POLICY STATUS FOR DSNCAT_GBP29 = NORMAL
MAX SIZE INDICATED IN POLICY = 2048 KB
DUPLEX INDICATOR IN POLICY = ENABLED
CURRENT DUPLEXING MODE = DUPLEX
ALLOCATED = YES
DSNB758I - ALLOCATED SIZE = 2048 KB
VOLATILITY STATUS = VOLATILE
REBUILD STATUS = DUPLEXED
CFNAME = CACHE01
OPERATIONAL CFLEVEL = 5
ACTUAL CFLEVEL = 7
DSNB759I - NUMBER OF DIRECTORY ENTRIES = 1950
NUMBER OF DATA PAGES = 389
NUMBER OF CONNECTIONS = 2
DSNB798I - LAST GROUP BUFFER POOL CHECKPOINT
17:08:41 OCT 16, 2002
GBP CHECKPOINT RECOVERY LRSN = AF6BBAEF3307
STRUCTURE OWNER = V61B
DSNB799I - SECONDARY GBP ATTRIBUTES
ALLOCATED SIZE = 2048 KB
VOLATILITY STATUS = VOLATILE
CFNAME = LF01
OPERATIONAL CFLEVEL = 5
ACTUAL CFLEVEL = 7
NUMBER OF DIRECTORY ENTRIES = 1950
NUMBER OF DATA PAGES = 389
DSNB783I - CUMULATIVE GROUP DETAIL STATISTICS SINCE 17:08:35 OCT 16,
2002
DSNB784I - GROUP DETAIL STATISTICS
READS
DATA RETURNED = 4
DSNB785I - DATA NOT RETURNED
DIRECTORY ENTRY EXISTED = 0
DIRECTORY ENTRY CREATED = 45
DIRECTORY ENTRY NOT CREATED = 0, 0
DSNB786I - WRITES
CHANGED PAGES = 5
CLEAN PAGES = 0
FAILED DUE TO LACK OF STORAGE = 0
CHANGED PAGES SNAPSHOT VALUE = 5
DSNB787I - RECLAIMS
FOR DIRECTORY ENTRIES = 0
FOR DATA ENTRIES = 0
CASTOUTS = 0
DSNB788I - CROSS INVALIDATIONS
DUE TO DIRECTORY RECLAIMS = 0
DUE TO WRITES = 0
EXPLICIT = 0
DSNB762I - DUPLEXING STATISTICS FOR GBP29-SEC
WRITES
CHANGED PAGES = 5
FAILED DUE TO LACK OF STORAGE = 0
CHANGED PAGES SNAPSHOT VALUE = 5
DSNB790I - DISPLAY FOR GROUP BUFFER POOL GBP29 IS COMPLETE
DSN9022I - DSNB1CMD '-DISPLAY GBPOOL' NORMAL COMPLETION

Chapter 28. -DISPLAY GROUPBUFFERPOOL (DB2) 205

 Example 4: This example shows the member detail section from the report that is
produced by the following command:
-DISPLAY GROUPBUFFERPOOL(GBP29) MDETAIL(*)

Messages DSNB764I and DSNB793I are displayed in the output only if the
secondary group buffer pool is allocated.
DSNB750I - DISPLAY FOR GROUP BUFFER POOL GBP29 FOLLOWS
DSNB755I - DB2 GROUP BUFFER POOL STATUS
CONNECTED = YES
CURRENT DIRECTORY TO DATA RATIO = 5
PENDING DIRECTORY TO DATA RATIO = 5
CURRENT GBPCACHE ATTRIBUTE = YES
PENDING GBPCACHE ATTRIBUTE = YES
DSNB756I - CLASS CASTOUT THRESHOLD = 10%
GROUP BUFFER POOL CASTOUT THRESHOLD = 50%
GROUP BUFFER POOL CHECKPOINT INTERVAL = 8 MINUTES
RECOVERY STATUS = NORMAL
AUTOMATIC RECOVERY = Y
DSNB757I - MVS CFRM POLICY STATUS FOR DSNCAT_GBP29 = NORMAL
MAX SIZE INDICATED IN POLICY = 2048 KB
DUPLEX INDICATOR IN POLICY = ENABLED
CURRENT DUPLEXING MODE = DUPLEX
ALLOCATED = YES
DSNB758I - ALLOCATED SIZE = 2048 KB
VOLATILITY STATUS = VOLATILE
REBUILD STATUS = DUPLEXED
CFNAME = CACHE01
OPERATIONAL CFLEVEL = 5
ACTUAL CFLEVEL = 7
DSNB759I - NUMBER OF DIRECTORY ENTRIES = 1950
NUMBER OF DATA PAGES = 389
NUMBER OF CONNECTIONS = 2
DSNB798I - LAST GROUP BUFFER POOL CHECKPOINT
17:08:41 OCT 16, 2002
GBP CHECKPOINT RECOVERY LRSN = AF6BBAEF3307
STRUCTURE OWNER = V61B
DSNB799I - SECONDARY GBP ATTRIBUTES
ALLOCATED SIZE = 2048 KB
VOLATILITY STATUS = VOLATILE
CFNAME = LF01
OPERATIONAL CFLEVEL = 5
ACTUAL CFLEVEL = 7
NUMBER OF DIRECTORY ENTRIES = 1950
NUMBER OF DATA PAGES = 389
DSNB772I - CUMULATIVE MEMBER DETAIL STATISTICS SINCE 17:08:41 OCT 16,
2002
DSNB773I - MEMBER DETAIL STATISTICS
SYNCHRONOUS READS
DUE TO BUFFER INVALIDATION
DATA RETURNED = 0
DATA NOT RETURNED = 0
DSNB774I - DUE TO DATA PAGE NOT IN BUFFER POOL
DATA RETURNED = 0
DATA NOT RETURNED = 0
DSNB775I - PREFETCH READS
DATA NOT RETURNED = 0
DSNB789I - REGISTER PAGE LIST = 0
PAGES RETRIEVED = 0
FAILED READS DUE TO LACK OF STORAGE = 0
DSNB776I - SYNCHRONOUS WRITES
CHANGED PAGES = 5
CLEAN PAGES = 0
DSNB777I - ASYNCHRONOUS WRITES

206 Command Reference

 CHANGED PAGES = 0
CLEAN PAGES = 0
FAILED WRITES DUE TO LACK OF STORAGE = 0
DSNB778I - CASTOUT THRESHOLDS DETECTED
FOR CLASSES = 0
FOR GROUP BUFFER POOL = 0
GBP CHECKPOINTS TRIGGERED = 0
PARTICIPATION IN REBUILD = 1
DSNB796I - CASTOUTS
PAGES CASTOUT = 0
UNLOCK CASTOUT = 0
READ CASTOUT CLASS = 0
READ CASTOUT STATISTICS = 0
READ DIRECTORY INFO = 0

DSNB797I - OTHER INTERACTIONS

REGISTER PAGE = 0
UNREGISTER PAGE = 0
DELETE NAME = 0
READ STORAGE STATISTICS = 0
EXPLICIT CROSS INVALIDATIONS = 0
ASYNCHRONOUS GBP REQUESTS = 0
DSNB764I - DUPLEXING STATISTICS FOR GBP29-SEC
WRITES

FAILED DUE TO LACK OF STORAGE = 0

ASYNCHRONOUS COMPLETION CHECKS = 0
DSNB793I - DELETE NAME LIST = 0
READ CASTOUT STATISTICS = 0
DELETE NAME = 0
OTHER ASYNCHRONOUS GBP REQUESTS = 0
DSNB790I - DISPLAY FOR GROUP BUFFER POOL GBP29 IS COMPLETE
DSN9022I - DSNB1CMD '-DISPLAY GBPOOL' NORMAL COMPLETION

Chapter 28. -DISPLAY GROUPBUFFERPOOL (DB2) 207

208 Command Reference
Chapter 29. -DISPLAY LOCATION (DB2)
The DB2 command DISPLAY LOCATION displays various information about the
specified remote locations.

If you specify the DETAIL option, each line can be followed by information
regarding conversations owned by DB2 system threads that are communicating
with the location.

The information returned by the DISPLAY LOCATION command reflects a

dynamic status. By the time the information is displayed, it is possible that the
status has changed.

Abbreviation: -DIS LOC

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 210
v “Option descriptions” on page 210
v “Output” on page 210
v “Examples” on page 211

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v DISPLAY privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 209

 Syntax

DISPLAY LOCATION

* DETAIL
,

(  location-name )
partial-location*
<luname>
ipaddr

Option descriptions
(*)
Displays information for all remote locations.
( location-name )
Lists one or more location names, separated by commas.
Because DB2 does not receive a location name from requesters that are not DB2
for z/OS subsystems, you can enter the LUNAME or IP address of such a
requester. Refer to the option descriptions for the < luname > and ( ipaddr )
options for more information about using the LUNAME or IP address to
specify a requester that is not a DB2 for z/OS subsystem.
( partial-location *)
Selects all location names that begin with the string partial-location and can end
with any string, including the empty string. For example, LOCATION(ABC*)
selects all location names that begin with the string ’ABC’.
< luname >
Requests information about the remote clients that are connected to DDF
through the remote SNA LU that is specified. Enclose the LU name in the
less-than (<) and greater-than (>) symbols. For example, DISPLAY
LOCATION(<LULA>) displays information about a remote location (that is not
DB2 for z/OS) with the LU name of LULA.
You can use an asterisk (*) when specifying an LU name in the same manner
as previously described for specifying a partial-location name. For example,
DISPLAY LOCATION(<LULA*) selects all remote locations (that are not DB2
for z/OS) with an LU name that begins with the string ’LULA’.
( ipaddr )
Requests information about the clients that are connected to DDF through the
remote TCP/IP host. Enter the IP address. For example,
DISPLAY LOCATION(124.63.51.17) displays information about clients at the
remote TCP/IP host whose dotted decimal IP address is 124.63.51.17.
DETAIL
Displays additional information about conversation activity for DB2 system
threads, as shown in Example 2.

Output

The DISPLAY LOCATION command displays the following output:

210 Command Reference

 LOCATION
The LOCATION of the remote system.
PRDID
The product identifier (PRDID) of the remote system. The PRDID is
displayed in the form nnnvvrrm , where:
nnn The database product
vv The product version
rr The product release
m The product modification level
LINKNAME
The address (LU name or IP address) of the remote system.
REQSTR
The number of requester connections from the local subsystem that are
accessing the remote system.
SERVER
The number of connections from the remote system that are accessing the
local system as a server.
CONVS
The total number of connections related to the partner system. Note that
this value may include DB2 system related connections that are not
reflected in the REQSTR and SERVER values.
| CONTEXT-NAME
| An unqualified SQL identifier that designates a context.

| Note: The maximum value for REQSTR, SERVER, and CONVS is 999999. The
| LINKNAME information is provided as an extension of the DSNL202I message,
| and only if the LINKNAME is different than LOCATION.

Examples

| Example 1: Display information about threads and conversations with specific

| remote locations, using the following command:
| -DISPLAY LOCATION REPORT FOLLOWS-
|
| DSNL200I - DISPLAY LOCATION REPORT FOLLOWS-
| LOCATION PRDID REQSTR SERVER CONVS
| SAN_JOSE DSN09010 1 0 3
| LUND1
| SAN_FRANCISCO DSN09010 1 0 6
| LUND3
| DISPLAY LOCATION REPORT COMPLETE

| Example 2: Display information about threads and conversations with all remote
| locations. Additionally, display detail conversation information about DB2 system
| threads that communicate with other locations. This is an example of the output
| generated by the following command:
| -DISPLAY LOCATION DETAIL
|
| DSNL200I - DISPLAY LOCATION REPORT FOLLOWS-
| LOCATION PRDID REQSTR SERVER CONVS
| SAN_JOSE DSN09010 1 0 3
| LUND1
| L203-SYSTASK SESSID A ST TIME
| L204-SYSCON-O E15FDE02D310FB80 S 0820914411180
| L204-SYSCON-I E15FDE02D310FB81 W R 0820914411181

Chapter 29. -DISPLAY LOCATION (DB2) 211

| MENLO_PARK DSN09010 1 0 4
| LUND2
| L203-SYSTASK SESSID A ST TIME
| L204-SYSCON-O E15FDE02D310FB82 S 0820914411182
| L204-SYSCON-I E15FDE02D310FB83 W R 0820914411183
| L204-RESYNC E15FDE02D310FB84 N R 0820914411184
| SAN_FRANCISCO DSN09010 1 0 6
| LUND3
| L203-SYSTASK SESSID A ST TIME
| L204-SYSCON-O 0000000000000000 C 0820914411185
| L204-SYSCON-I E15FDE02D310FB86 W R 0820914411186
| L204-RESYNC E15FDE02D310FB87 W R 0820914411187
| L204-RESYNC E15FDE02D310FB88 W R 0820914411188
| L204-RESYNC E15FDE02D310FB89 W R 0820914411189
| DISPLAY LOCATION REPORT COMPLETE

| Example 3: Display information for a DB2 system that is connected with the
| following DRDA partners:
| v A non-z/OS server named DRDALOC via TCP/IP IPv4.
| v Several TCP/IP clients from the same TCP/IP host as the DRDALOC server.
| v A DB2 for z/OS server named DB2SERV via SNA.
| v A DB2 for z/OS client via TCP/IP IPv6.
| DISPLAY LOCATION(*)
|
| DSNL200I - DISPLAY LOCATION REPORT FOLLOWS -
| LOCATION PRDID REQSTR SERVER CONVS
| DRDALOC SQL09053 3 0 3
| ::FFFF:124.63.51.17
| ::FFFF:124.63.51.17 SQL09053 0 15 15
| DB2SERV DSN09010 1 0 1
| LULA
| 2002:91E:610:1::5 DSN09015 0 1 1
| DISPLAY LOCATION REPORT COMPLETE

| Example 4: The following example shows the requestor report from the DISPLAY
| LOCATION command where the connection is established as trusted.
| -DISPLAY LOC
|
| DSNL200I - DISPLAY LOCATION REPORT FOLLOWS -
| LOCATION PRDID REQSTR SERVER CONVS
| STL912B 1 0 1
| 9.30.115.135
| CONTEXTNAME= DOMINOCONTEXT
| DISPLAY LOCATION REPORT COMPLETE

212 Command Reference

|

Chapter 30. -DISPLAY LOG (DB2)

The DB2 command DISPLAY LOG displays log information about, and the status
of, the offload task.

Abbreviation: DIS LOG

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Usage notes”
v “Examples” on page 214

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v DISPLAY privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

DISPLAY LOG


Usage notes

Information provided by the DISPLAY LOG command : You can use the DISPLAY
LOG command to view the current LOGLOAD setting, including information
about the current active log data sets and status of the offload task. You can obtain
additional information about log data sets and checkpoint information by using the
Print Log Map utility (DSNJU004).

© Copyright IBM Corp. 1983, 2009 213

 Examples

Example 1: Display log information and status of the offload task.

-DISPLAY LOG

This command produces output similar to the following output:

DSNJ370I - DSNJCOOA LOG DISPLAY
CURRENT COPY1 LOG = DSNC810.LOGCOPY1.DS03 IS 22% FULL
CURRENT COPY2 LOG = DSNC810.LOGCOPY2.DS03 IS 22% FULL
H/W RBA = 0000039A9F24, LOGLOAD = 150000
FULL LOGS TO OFFLOAD = 2 OF 6, OFFLOAD TASK IS (BUSY,ALLC)
DSNJ371I - DB2 RESTARTED 14:06:23 MAY 22, 2002
RESTART RBA 0000039A8000
DSN9002I - DSNJC001 'DIS LOG' NORMAL COMPLETION

This example shows the following information:

v The active log data sets are 22% full. If you are running dual logs and the
percentages are different, the log data sets are of different sizes. DB2 switches
both active logs when one reaches the end of the file. This can result in unused
active log space if one log data set is larger than the other.
v The current LOGLOAD setting is 150000 log records between system
checkpoints. You can modify this value using the SET LOG command.
v Two of the six active log data sets require archiving. The status of the offload
task includes the indicator that it is busy, allocating an archive log data set. This
might be an indication of an outstanding tape mount on the system console. If
the status remains busy and no longer seems to be functioning, you can
terminate the task and then restart it using the ARCHIVE LOG CANCEL
OFFLOAD command.
v DB2 was started at 14:06:23 on MAY 22, 2002, and began logging at RBA
0000039A8000.

214 Command Reference

Chapter 31. -DISPLAY PROCEDURE (DB2)
The DB2 command DISPLAY PROCEDURE displays statistics about stored
procedures that are accessed by DB2 applications.

This command displays one line of output for each stored procedure that a DB2
application has accessed. You can qualify stored procedure names with a schema
name.

The information returned by the DISPLAY PROCEDURE command reflects a

dynamic status. By the time the information is displayed, it is possible that the
status could have changed.

Abbreviation: -DIS PROC

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 216
v “Option descriptions” on page 216
v “Output” on page 217
v “Examples” on page 218

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or a CICS terminal, or a program using
the instrumentation facility interface (IFI).

Data sharing scope: Group or local, depending on the value of the SCOPE option.

Authorization

To run this command, you must use a privilege set of the process that includes one
of the following privileges or authorities:
v Ownership of the stored procedure
v DISPLAY privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

If you specify DISPLAY PROCEDURE *.* or schema.partial-name *, the privilege set

of the process must include one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 215

| If you are using an external security product to authorize usage of DISPLAY
| PROCEDURE, define SYSOPR as a user to the external security product for those
| cases in which DISPLAY PROCEDURE SCOPE(GROUP) runs on a remote system
| and SYSOPR is used as the authorization ID.

Syntax

(*.*)


DISPLAY PROCEDURE

,

(  schema.procedure-name )
schema.partial-name*
procedure-name
partial-name*


LOCAL
SCOPE ( GROUP )

Option descriptions
(*.*)
Displays information for all stored procedures in all schemas that DB2
applications have accessed since DB2 was started.
( schema.procedure-name )
Displays the specified stored procedure in the specified schema.
( schema.partial-name *)
Displays a set of stored procedures in the specified schema that DB2
applications have accessed since DB2 was started. The names of all procedures
in the set begin with partial-name and can end with any string, including the
empty string. For example, PAYROLL.ABC* displays information for all stored
procedure names beginning with ABC in the PAYROLL schema.
( procedure-name )
Displays one or more specific stored procedure names in the SYSPROC
schema. If no procedures are named, DB2 displays information for all stored
procedures that have been accessed by DB2 applications.
( partial-name *)
Displays information for a set of stored procedures in the SYSPROC schema
that DB2 applications have accessed since DB2 was started. The names of all
procedures in the set begin with partial-name and can end with any string,
including the empty string. For example, ABC* displays information for all
stored procedures in the SYSPROC schema with names that begin with ABC.
SCOPE
Specifies the scope of the command.
( LOCAL )
Specify to display information about procedures on the local member only.

216 Command Reference

 (GROUP)
Specify to display information about procedures on all members of the
data sharing group.

Output

Sample output: The DISPLAY PROCEDURE command generates output similar to

the following output:
DSNX940I = DSNX9DIS DISPLAY PROCEDURE REPORT FOLLOWS -

PROCEDURE STATUS ACTIVE QUED MAXQ TIMEOUT FAIL WLM_ENV

APPL1 STARTED 1 0 0 0 1 SANDBOX
APPL2 STARTED 1 0 0 0 0 SANDBOX
APPL2 STARTED 0 1 2 0 0 SANDBOX
APPL5 STOPREJ 0 0 0 0 0 SANDBOX
APPL6 STOPABN 0 0 0 0 0 SANDBOX
PROC1 STOPQUE 0 0 0 0 0 SANDBOX

DSNX9DIS DISPLAY PROCEDURE REPORT COMPLETE

DSN9022I = DSNX9COM '-DISPLAY PROC' NORMAL COMPLETION

Description of output: Each output line displays the following information:

PROCEDURE
The name of the stored procedure.
STATUS
The status of the stored procedure of the stored procedure. The possible
values are:
STARTED
Requests for the procedure can be processed.
STOPQUE
Requests are queued.
STOPREJ
Requests are rejected.
STOPABN
Requests are rejected because of abnormal termination.
ACTIVE
The number of threads that are currently running the load module.
QUED
The number of threads that are waiting for the procedure to be scheduled.
MAXQ
The maximum number of threads that have waited concurrently for the
procedure to be scheduled since DB2 was started. DB2 resets this value to
0 each time you run the START PROCEDURE command.
TIMEOUT
The number of times an SQL CALL statement timed out while waiting for
a request for the procedure to be scheduled. DB2 resets this value to 0 each
time you run the START PROCEDURE command.
FAIL The number of times a procedure has failed. DB2 resets this value to 0
each time you run the START PROCEDURE command.
WLM_ENV
The WLM environment where the procedure runs.

Chapter 31. -DISPLAY PROCEDURE (DB2) 217

 Message DSNX943I lists a range of procedures that are stopped because a STOP
PROCEDURE command included a partial name with a pattern-matching character
(*), as in the following example:
-STOP PROCEDURE(ABC*)

Message DSNX950I is returned when DISPLAY PROCEDURE is issued for a

procedure name that has not been accessed by a DB2 application.

| Displaying native SQL procedures: Native SQL procedures, SQL procedures that are
| created using the new support introduced in Version 9, are not displayed in the
| DISPLAY PROCEDURE output unless you run the procedure in DEBUG mode. If
| you do run the procedure in DEBUG mode the WLM environment column in the
| output contains the WLM ENVIRONMENT FOR DEBUG that you specified when
| you created the native SQL procedure.

| The DISPLAY PROCEDURE output shows the statistics of native SQL procedures
| as ’0’ if the native SQL procedures are under the effect of a STOP PROCEDURE
| command.

Examples

Example 1: Display information about all stored procedures that have been
accessed by DB2 applications.
-DISPLAY PROCEDURE

This command produces output similar to the following output:

DSNX940I = DSNX9DIS DISPLAY PROCEDURE REPORT FOLLOWS-
PROCEDURE STATUS ACTIVE QUED MAXQ TIMEOUT FAIL WLM_ENV
USERPRC1 STARTED 0 0 1 0 0 SANDBOX
USERPRC2 STOPQUE 0 5 5 3 0 SANDBOX
USERPRC3 STARTED 2 0 6 0 0 SANDBOX
USERPRC4 STOPREJ 0 0 1 0 0 SANDBOX
DSNX9DIS DISPLAY PROCEDURE REPORT COMPLETE
DSN9022I = DSNX9COM '-DISPLAY PROC' NORMAL COMPLETION

Example 2: Display information about specific stored procedures in the SYSPROC

schema.
-DISPLAY PROCEDURE(SYSPROC.USERPRC2,USERPRC4)

This command produces output similar to the following output:

DSNX940I = DSNX9DIS DISPLAY PROCEDURE REPORT FOLLOWS-

------ SCHEMA=SYSPROC
PROCEDURE STATUS ACTIVE QUED MAXQ TIMEOUT FAIL WLM_ENV
USERPRC2 STOPQUE 0 5 5 3 0 SANDBOX
USERPRC4 STOPREJ 0 0 1 0 0 SANDBOX
DSNX9DIS DISPLAY PROCEDURE REPORT COMPLETE
DSN9022I = DSNX9COM '-DISPLAY PROC' NORMAL COMPLETION

Example 3: Display information about stored procedures in the PAYROLL and

HRPROD schemas.
-DISPLAY PROCEDURE(PAYROLL.*,HRPROD.*)

This command produces output similar to the following output:

DSNX940I = DSNX9DIS DISPLAY PROCEDURE REPORT FOLLOWS-

------ SCHEMA=PAYROLL
PROCEDURE STATUS ACTIVE QUED MAXQ TIMEOUT FAIL WLM_ENV

218 Command Reference

PAYPRC1 STARTED 0 0 1 0 0 PAYROLL
PAYPRC2 STOPQUE 0 5 5 3 0 PAYROLL
PAYPRC3 STARTED 2 0 6 0 0 PAYROLL
USERPRC4 STOPREJ 0 0 1 0 0 SANDBOX

------ SCHEMA=HRPROD
PROCEDURE STATUS ACTIVE QUED MAXQ TIMEOUT FAIL WLM_ENV
HRPRC1 STARTED 0 0 1 0 0 HRPROCS
HRPRC2 STOPREJ 0 0 1 0 0 HRPROCS
DSNX9DIS DISPLAY PROCEDURE REPORT COMPLETE
DSN9022I = DSNX9COM '-DISPLAY PROC' NORMAL COMPLETION

Example 4: Display information about all stored procedures in the SYSADM

schema that have been accessed by DB2 applications. Assume that the -STOP
PROCEDURE(SYSADM.SP*) ACTION(QUEUE) command is in effect at the time
that the following command is issued.
-DISPLAY PROCEDURE(SYSADM.*)

This command produces output similar to the following output:

DSNX940I = DSNX9DIS DISPLAY PROCEDURE REPORT FOLLOWS-

------ SCHEMA=SYSADM
PROCEDURE STATUS ACTIVE QUED MAXQ TIMEOUT FAIL WLM_ENV
SPC1 STOPQUE 0 0 0 0 0 WLMENV1
SPC2 STOPQUE 0 0 0 0 0 WLMENV3
DSNX9DIS PROCEDURES SP - SP* STOP QUEUE
DSNX9DIS DISPLAY PROCEDURE REPORT COMPLETE
DSN9022I = DSNX9COM '-DISPLAY PROC' NORMAL COMPLETION

Chapter 31. -DISPLAY PROCEDURE (DB2) 219

220 Command Reference
 Chapter 32. -DISPLAY PROFILE (DB2)
The DISPLAY PROFILE command allows you to determine if profiling is active or
inactive

Abbreviation: -DIS PROFILE

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Output”
v “Examples” on page 222

Environment

This command can be issued from the z/OS console, through a batch job or
instrumentation facility interface (IFI). The command is only used by tools, such as
the Optimization Service Center for DB2 for z/OS. Individual users should not
issue this command.

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

| Syntax
|

|

DISPLAY PROFILE

|

Output

Message DSNT753I status information: The status codes that are displayed by the
DISPLAY PROFILE command and their respective descriptions are as follows:
status Indicates the value is either ON, OFF, SUSPENDED, STARTING, or
STOPPING.
ON Profiling is active.
OFF Profiling is inactive.

© Copyright IBM Corp. 1983, 2009 221

 SUSPENDED
Profiling was active, but is now suspended due to error conditions.
For example, the maximum push-out limit has been reached or the
table space is full.
STARTING
Profiling is being started, but has not completed.
STOPPING
Profiling has been stopped, but has not completed.

If the status is either OFF, STARTING, or STOPPING then the TIMESTAMP

and PUSHOUT lines will not be reported.
current Indicates the current number of push-out from the time that profiling is
started.
max Indicates the maximum number of allowable push-out.

Examples
Example 1: This command displays the status of the profiling activities, as either
active or inactive.
-DISPLAY PROFILE

222 Command Reference

 Chapter 33. -DISPLAY RLIMIT (DB2)
The DB2 command DISPLAY RLIMIT displays the current status of the resource
limit facility (governor).

| If the facility has already been started, DISPLAY RLIMIT also displays the ID of
| the resource limit specification table or the resource limit middleware table that is
| being used.

Abbreviation: -DIS RLIM

Subsections:
v “Environment”
v “Authorization”
v “Example”

Environment

This command can be issued from a z/OS console, a DSN session, a DB2I panel
(DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

DISPLAY RLIMIT


Example

Display the current status of the resource limit facility.

-DISPLAY RLIMIT

If the resource limit facility (RLF) is inactive, the following output is generated:
DSNT701I - RESOURCE LIMIT FACILITY IS INACTIVE
DSN9022I - DSNTCDIS 'DISPLAY RLIMIT' NORMAL COMPLETION

© Copyright IBM Corp. 1983, 2009 223

 If the RLF is active, the value of field RESOURCE AUTHID on panel DSNTIPP is
SYSADM, and the resource limit specification table with
RLST NAME SUFFIX = 03 was started, the following output is generated:
DSNT700I = SYSADM.DSNRLST03 IS THE ACTIVE RESOURCE LIMIT
SPECIFICATION TABLE
DSN9022I = DSNTCDIS 'DISPLAY RLIMIT' NORMAL COMPLETION

224 Command Reference

Chapter 34. -DISPLAY THREAD (DB2)
The DB2 command DISPLAY THREAD displays current status information about
DB2 threads.

A DB2 thread can be an allied thread, a database access thread, or a parallel task
thread. Threads can be active, inactive, indoubt, or postponed.

Distributed threads are those threads that have a connection with a remote location
(active or inactive) or that had a connection with a remote location (indoubt). An
allied thread and a parallel task thread can be distributed or non-distributed; a
database access thread is always distributed.

The DISPLAY THREAD command allows you to select the type of information you
want to display by using one or more of the following criteria:
v Active threads, inactive threads, indoubt threads, postponed threads, procedure
threads, system threads, or the set of active, indoubt, postponed, and system
threads (see the descriptions under the TYPE option for more information)
v Allied threads, including those threads that are associated with the address
spaces whose connection names are specified
v Distributed threads, including those threads that are associated with a specific
remote location
v Detailed information about connections with remote locations
v A specific logical unit of work ID (LUWID)

The information that is returned by the DISPLAY THREAD command reflects a

dynamic status. When the information is displayed, it is possible that the status
has changed. Moreover, the information is consistent only within one address
space and is not necessarily consistent across all address spaces displayed.

Abbreviation: -DIS THD

Subsections:
v “Environment”
v “Authorization” on page 226
v “Syntax” on page 226
v “Option descriptions” on page 227
v “Usage notes” on page 230
v “Output” on page 232
v “Examples” on page 234

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group or local, depending on the SCOPE option.

© Copyright IBM Corp. 1983, 2009 225

 Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v DISPLAY privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

| Syntax
|

|

DISPLAY THREAD ( )

| ,

 connection-name
partial-connection*
*

| LOCAL
|
SCOPE ( GROUP )

ACTIVE
TYPE( INDOUBT )
*
INACTIVE
POSTPONED
PROC
SYSTEM

|


| ,

LOCATION(  location-name )
partial-location*
*
,

LUWID(  luwid )
partial-luwid*
token

|


| 512 DETAIL ,
LIMIT( integer )
* RRSURID(  rrs-urid )
*

226 Command Reference

Option descriptions

Only under certain conditions, as described in the following lists, are any of the
following options required.

If you do not specify either ( connection-name ) or (*), the following rules apply:
v If the command is issued from a DSN session under TSO, a DB2I panel (DB2
COMMANDS), or an IMS or CICS terminal, the connection name is inherited
from the associated address space.
v If the command is not issued from one of those environments, the following
rules apply:
– If you do not specify either LOCATION or LUWID, processing terminates
with a DSNV413I message.
– If you do specify LOCATION or LUWID, only distributed threads of the type
selected by the TYPE option are displayed.
– When you explicitly specify location-name , only distributed threads of the
type selected by the TYPE option that either have (active or inactive threads)
or had (indoubt threads) a connection with the specified location are
displayed.
( connection-name , ...)
Lists one or more connection names (of 1 to 8 characters each). Allied threads
are selected only from the address spaces associated with those connection
names. The LOCATION option can restrict what is displayed:
v If you specify LOCATION(*), only distributed threads of the type specified
in the TYPE option are displayed.
v When you explicitly specify location-name , only distributed threads of the
specified type that either have or had a connection with the specified
location are displayed.
( partial-connection* , ...)
Selects the connections that begin with the string partial-connection and can end
with any string, including the empty string. For example, DISPLAY
THREAD(CICS*,IMS*) selects all connection names that begin with the string
’CICS’ or ’IMS’. The LOCATION option can restrict the display exactly the
same way as previously described for location-name .
(*)
Displays all threads in all address spaces attached to DB2 and all database
access threads of the types specified in the TYPE option. The LOCATION
option can restrict what is displayed:
v If you specify LOCATION(*), only distributed threads are displayed.
v When you explicitly specify location-name , only distributed threads that
either have (active or inactive threads) or had (indoubt threads) a connection
with the specified location are displayed.
The default is to display only the connections that are associated with the
transaction manager from which the command was entered.
SCOPE
Specifies the scope of the command.
( LOCAL )
Displays threads on only the current member.
(GROUP)
Displays all threads on the data sharing group.

Chapter 34. -DISPLAY THREAD (DB2) 227

 TYPE
Tells the type of thread to display.
Abbreviation: T
( ACTIVE )
| Displays only active threads. An active allied thread is connected to DB2
| via TSO, BATCH, IMS, CICS or CAF. An active database access thread is
| connected by a network connection to another system and is performing
| work on behalf of that system. If, during command processing, an active
| thread becomes indoubt, it can appear twice—once as active and once as
| indoubt.
| Abbreviation: A
| The information that is produced by ACTIVE can be useful for debugging
| purposes, especially messages DSNV403I and DSNV404I.
(INDOUBT)
Displays only indoubt threads.
An indoubt thread is a participant in a two-phase commit protocol that has
completed the first phase of commit, and has then lost communication
with the commit coordinator and does not know whether to commit or roll
back the updates that have been made.
The indoubt thread information that is displayed includes threads for
which DB2 has a coordinator role, a participant role, or both coordinator
and participant roles.
The commit coordinator for an allied thread is either a transaction manager
(for example, IMS or CICS) or z/OS RRS for threads that use RRSAF. The
commit coordinator for a database access thread is a requester at a remote
system.
Indoubt threads hold locks on all resources that were updated.
Abbreviation: I
(*) Displays active, indoubt, postponed, and system threads.
(INACTIVE)
| Displays only inactive database access threads and connections that are
| connected by a network connection to another system. An inactive thread
| is idle and waits for a new unit of work to begin from that system.
| Abbreviation: INA
| Use qualifiers such as complete location names or LUWIDs with this
| option. When there are large numbers of inactive database access threads,
| unqualified display requests can temporarily change the DB2 working set,
| which can temporarily affect the performance of active threads.
(POSTPONED)
Displays information about units of work whose back-out processing has
been postponed.
Abbreviation: P
After you have identified postponed threads, use the RECOVER
POSTPONED command, described, to complete backout processing for the
postponed units of work.

228 Command Reference

| (PROC)
| Displays information about threads that are executing stored procedures
| and user-defined functions. All -DISPLAY THREAD keywords are valid
| when TYPE(PROC) is specified.
| (SYSTEM)
| Displays a subset of system agent threads with message DSNV404I. The
| system agent threads displayed are deemed useful for serviceability
| purposes. Not all system threads are displayed.
| Abbreviation SYS
| If the command or system agent can be cancelled, then the associated
| token is displayed in the output. You can specify this option from early in
| the restart to late in the shutdown process. If you issue this command
| before or after release work, then the restart or shutdown status is
| displayed in the output.
| When the token is identified for the database command or systems agent,
| you can use the CANCEL THREAD(token) command to cancel it.
LOCATION( location-name , ...)
Limits the display to distributed threads as described.
Abbreviation: LOC
location-name
Displays only distributed threads of the specified type that either have
(active or inactive threads) or had (indoubt threads) a remote connection
with the specified location-name .
| DB2 does not receive a location name from requesters that are not DB2 for
| z/OS subsystems. To display information about a requester that is not a
| DB2 for z/OS subsystem, enter its LU name or IP address. Enclose the LU
| name in the less-than (<) and greater-than (>) symbols. For example, the
| following command displays information about a remote location (that is
| not DB2 for z/OS) with the LU name of LULA:
| -DISPLAY THREAD (*) LOCATION (<LULA>)

| The following command displays information about a remote location (that

| is not DB2 for z/OS) with an IP address of ::FFFF:123.34.101.98:
| -DISPLAY THREAD (*) LOCATION (::FFFF:123.34.101.98)
DB2 uses the <LU name> notation or IP address in messages displaying
information about requesters other than DB2.
partial-location *
Selects all location names that begin with the string partial-location and can
end with any string, including the empty string. For example,
LOCATION(SAN*) selects all location names that begin with the string ’SAN’.
You can use an asterisk (*) when specifying an LU name in the same
manner as previously described for other location names that are not DB2
for z/OS subsystems. For example, LOCATION(<LULA*) selects all remote
locations (that are not DB2 for z/OS) with an LU name that begins with
the string ’LULA’.
You cannot use an asterisk when you specify an IP address.
(*)
Display all distributed threads of the specified type.

Chapter 34. -DISPLAY THREAD (DB2) 229

 LUWID( luwid , ...)
Displays information about the distributed threads that have the specified
LUWID. It is possible for more than one thread to have the same LUWID.
luwid
Consists of a fully qualified LU network name followed by a period and
an LUW instance number.
The LU network name consists of a one- to eight-character network ID, a
period, and a one- to eight-character network LU name. The LUW instance
number consists of 12 hexadecimal characters that uniquely identify the
unit of work.
partial-luwid *
Selects all LUWIDs that begin with the string partial-luwid and can end
with any string, including the empty string. For example, LUWID(NET1.*)
selects all LUWIDs with a network name of ’NET1’.
token
Identifies a specific thread in an alternate way. DB2 assigns a token to each
distributed thread it creates. A token is a one- to six-digit decimal number
that appears after the equal sign in all DB2 messages that display a
LUWID.
If you do not include any periods nor a ’*’ in the LUWID specification,
DB2 assumes that you are supplying a token. The token that DB2 assigns
to a specific LUWID is unique for that DB2 subsystem, but not necessarily
unique across subsystems.
DETAIL
Displays additional information about active, inactive, and indoubt threads.
| LIMIT
| Accepts numeric input that specifies the number of lines of output that is
| desired. The default limit is 512, so you must use the limit keyword if you
| want to set a different limit.
| If you select LIMIT(*), all output that can be properly formatted within internal
| storage constraints will be displayed.
| When SCOPE(GROUP) is specified, the line limit is enforced per member
| displayed.
RRSURID( rrs-urid )
Specifies that only threads that match the specified RRSURID selection criteria
are to be displayed.
v If RRSURID( rrs-urid ) is specified, any thread involved in the RRSURID that
has the value rrs-urid , and that meets any other specified selection criteria,
will be displayed.
v If RRSURID(*) is specified, any thread involved in any RRSURID, and that
meets any other specified selection criteria, will be displayed.

Usage notes
Formatted report for distributed threads
The series of messages, DSNV444I through DSNV446I, augment the
formatted report for DISPLAY THREAD TYPE (ACTIVE or INACTIVE) for
distributed threads.
| Threads for connections to remote servers
A database access thread that is connected to a requester can also be

230 Command Reference

 connected to another database server location using DB2 private protocol
access or DRDA access. In this case, DB2 issues message DSNV445I for the
requester, and message DSNV444I and zero or more DSNV446I messages
for the remote server connections. In this case, the database access thread
acts as an intermediate database server.
Participant threads waiting for the commit or abort decision
A DSNV465I message is issued for an active participant thread that has
completed phase 1 of commit processing and has been waiting for the
commit or abort decision from the coordinator for more than 60 seconds.
DISPLAY THREAD output limit
If a DISPLAY THREAD command is issued from the z/OS console, the
maximum number of lines of output for a single invocation of the
command is 512 lines (at which time a DSNV513I, DSNV514I, or
DSNV515I message is printed). If you do not receive the required
information in the first 255 lines of output, issue the command again,
specifying the TYPE option and a specific connection name, location,
luwid, or a combination of these, as appropriate, to reduce the output.
Showing parallel tasks
The DISPLAY THREAD command shows parallel tasks by using a status
type of PT. The parallel tasks are displayed immediately after the
originating task. If the thread has a status of PT, the connection name
contains blanks if the thread of the originating task is running on the same
DB2 subsystem. This shows that these parallel tasks are related to the
originating task. If the parallel task is running on a DB2 subsystem that is
different from the subsystem that runs the originating task, the connection
name is shown and the entry is followed by message DSNV443I.
Displaying the XID
If the DISPLAY THREAD command is issued with the TYPE ACTIVE and
DETAIL options, or with the TYPE INDOUBT option, message DSNV440I
displays the contents of the XID. The contents of the XID are displayed as
a hexadecimal value.
The XID is displayed in the DISPLAY THREAD TYPE INDOUBT report if
the indoubt transaction is XID related.
| Threads associated with trusted context
| If a thread is associated with a trusted context, message DSNV485I
| displays the trusted context name, system authorization ID, and role.
| Displaying threads while DB2 is active
| All -DISPLAY and -CANCEL commands are allowed to run concurrent to
| other command issued through the console. This ensures thread tokens can
| be identified and used for soft thread cancels, even while long running
| console commands are in progress. The majority of system threads
| displayed cannot be canceled. For example, a 0 thread token is provided
| for DSNV404I messages.
| The command preprocessor (GCPC) console commands tasks can be
| canceled, and a token will be provided for these threads in a DSNV404I
| message in the -DISPLAY THREAD(*) TYPE(SYSTEM) report.
| Displaying threads during shutdown
| All commands will be quiesced at the beginning of shutdown. Only
| -DISPLAY THREAD(*) commands will be accepted after this point, and
| these will be valid until the last stages of shutdown. Much like -DISPLAY
| THD(*) during restart, only -DISPLAY THREAD(*) TYPE(SYSTEM) will

Chapter 34. -DISPLAY THREAD (DB2) 231

| produce meaningful thread information. All other variations of -DISPLAY
| THREAD(*) will terminate without thread data. If SCOPE(GROUP) is
| specified during shutdown, then a DSNV495I message will be displayed
| and the command will only execute locally.

Output

The following table shows sample DISPLAY THREAD commands and the types of
output they generate. Numbers in each row refer to the descriptions at the bottom
of the table. The DETAIL keyword is not included because it affects only the
amount of information displayed about a distributed thread.

If RRSURID(*) is specified, only threads involved in any RRSURID will be

displayed. If RRSURID( rrs-urid ) is specified, only threads involved in that specific
RRSURID will be displayed.
Table 15. Sample DISPLAY THREAD commands. The following output is generated when
commands are issued from different environments with different TYPE specifications.
(Specifying TYPE(*) displays the equivalent output of both TYPE(ACTIVE) and
TYPE(INDOUBT) in one report.)
Environment
where the
command is
issued Command ACTIVE INDOUBT INACTIVE
A DSN session -DIS THD 1 1 2
under TSO, DB2I,
IMS, or CICS, -DIS THD LOC(*) 3 3 2
where the
connection name -DIS THD LOC(location-name) 4 4 2
is inherited
z/OS console -DIS THD 6 6 6
-DIS THD LOC(*) 9 9 8
-DIS THD LOC(location-name) 10 10 11
Any source -DIS THD(connection-name) 1,12 1,12,15 12
-DIS THD(connection-name) 3,12 3,12,15 12
LOC(*)
-DIS THD(connection-name) 4,13 4,13,15 13
LOC(location-name)
-DIS THD(*) 7 7,15,16 8
-DIS THD(*) LOC(*) 9 9,15,16 8
-DIS THD(*) 10 10,15,16 11
LOC(location-name)
-DIS THD(*) LUWID(luwid or 5 5,15,16 5
token)
-DIS THD(connection-name) 14 14,15,16 14
LUWID(luwid or token)
-DIS THD LUWID(luwid or 5 5,15,16 5
token)

232 Command Reference

 Table 15. Sample DISPLAY THREAD commands (continued). The following output is
generated when commands are issued from different environments with different TYPE
specifications. (Specifying TYPE(*) displays the equivalent output of both TYPE(ACTIVE) and
TYPE(INDOUBT) in one report.)
Environment
where the
command is
issued Command ACTIVE INDOUBT INACTIVE
Description of display that is generated:
1. Allied threads of the specified TYPE with the connection name.
2. No threads (inactive threads are database access threads and have no inherited
connection name).
3. Distributed allied threads of the specified TYPE with the connection name.
4. Distributed allied threads of the specified TYPE with the connection name and a
distributed connection = location-name .
5. The threads of the specified TYPE that have LUWID = luwid or token .
6. Message DSNV413I is displayed to indicate an error.
7. All threads (both allied and database access) of the specified TYPE.
8. All inactive database access threads.
9. All distributed threads (both allied and database access) of the specified TYPE.
10. All distributed threads (both allied and database access threads) of the specified TYPE
with a distributed connection = location-name .
11. All inactive database access threads with a distributed connection = location-name .
12. Database access threads of the specified TYPE with the connection name.
13. Database access threads of the specified TYPE with the connection name and a
distributed connection = location-name .
14. A thread of the specified TYPE with the connection name and LUWID = luwid or token .
15. Messages DSNV407 and DSNV408 also display coordinator’s TCP/IP resync port
number; message DSNV446 also displays the participant’s TCP/IP resync port number.
16. Message DSNV440I displays the contents (in hexadecimal representation) of the remote
client’s XID for distributed threads of the specified TYPE that are associated with an
XA transaction manager coordinator.

If the DETAIL option is specified, the following additional information is

displayed:
LOCATION
The location name of the remote system.
SESSID
For a VTAM connection, the VTAM defined session instance identifier of
the session on which the conversation is executing.
For a TCP/IP connection, the local and remote TCP/IP port numbers, in
the form local:remote. local is the port number for the local DB2 subsystem.
remote is the port number for the remote partner.
| A If VTAM or TCP/IP has control of the connection (if DB2 transferred
| control of the thread to VTAM or TCP/IP for that connection), an N is
| displayed in the A (Active) column, indicating that processing is in the
| network layer. A value of W indicates that the DB2 subsystem has
| suspended processing of this connection until VTAM or TCP/IP notifies
| the DB2 subsystem that the network event is complete. The column is
| otherwise blank.
STATUS
This 2-byte column indicates the status of the conversation or socket. The
possible values for STATUS are:

Chapter 34. -DISPLAY THREAD (DB2) 233

 Value Status
Sx Send
Rx Receive
Ax Allocation
Dx Deallocation
Cx Change number of sessions (CNOS) processing
Xx Exchange Log name processing
blank Not in one of the preceding states
T An allied, non-distributed thread was established (plan allocated).
N The thread is either IDENTIFY or SIGNON status.
x can be one of the following values:
1 = Private protocol conversation with single-phase commit.
2 = DRDA conversation with single-phase commit
3 = Private protocol conversation with two-phase commit.
4 = DRDA conversation with two-phase commit.

If you specify the DETAIL keyword for active, inactive, or indoubt threads, DB2
also displays message DSNV441I, which, if available, displays accounting suffix
information as a character string. DB2 will recognize accounting information, and
display suffix information that originates from the following systems:
v DB2 for z/OS systems
v Any system where the accounting information matches the format that is
described in DSNSQMDA.QMDASQLI, which includes the product ID prefixes
JCC (IBM Data Server Driver for JDBC and SQLJ) and SQL (DB2® Universal
Database™ for Linux®, UNIX, and Windows®).

If you specify the DETAIL option for active threads, DB2 also displays message
DSNV440I, which, if applicable, displays the contents (in hexadecimal
representation) of the remote client’s XID.

| If you specify the DETAIL option for active threads, the DSNV445I and DSNV446I
| messages provide an index number in parenthesis, ’(ix)’. This index number is
| related to the table of conversation detail information described by the DSNV447I
| and DSNV448I messages. This index reference is appended to the front of the
| location name information. The detail report contains the index reference even if
| only one location is reported.

| The location information is reported using a dash to delimit the first two location
| name and address (SNA LUNAME, or TCP/IP IP address) components. In the case
| of TCP/IP connections, a double colon is used to delimit the third port component.

Examples

Example 1: The output of the command DISPLAY THREAD shows a token for
every thread, distributed or not. This example shows the token for an allied thread
that is not distributed. The token is 123. You can use the thread’s token as the
parameter in the CANCEL THREAD command.
-DISPLAY THREAD(*)

This command produces output similar to the following output:

DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
DSNV402I - ACTIVE THREADS -
NAME ST A REQ ID AUTHID PLAN ASID TOKEN

234 Command Reference

BATCH T * 5 BKH2C SYSADM BKH2 000D 123
DISPLAY ACTIVE REPORT COMPLETE
DSN9022I - DSNVDT '-DIS THD' NORMAL COMPLETION

Example 2: This example shows information about conversation activity when

distribution information is displayed for active threads. DB2 returns the following
output, indicating that the local site application is waiting for a conversation to be
allocated in DB2, and that a DB2 server is accessed by a DRDA client using
TCP/IP.
-DISPLAY THREAD(*) LOCATION(*) DETAIL

This command produces output similar to the following output:

DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
DSNV402I - ACTIVE THREADS -
NAME ST A REQ ID AUTHID PLAN ASID TOKEN
TSO TR * 9 SYSADM SYSADM DSNESPRR 0029 30
V441-ACCOUNTING=D1001
V436-PGM=DSNESPRR.DSNESM68, SEC=1, STMNT=137
V444-USIBMSY.SYEC717A.BD6E55DCF589=30 ACCESSING DATA AT
( 1)STL716A-SYEC716A
V447--INDEX SESSID A ST TIME
V448-- ( 1) 0000000000000000 N A4 0522008555443
TSO RA * 2 SYSADM SYSADM DSNESPRR 0033 28
V441-ACCOUNTING=D1001
V445-USIBMSY.SYEC716A.BD6E543A7BDF=28 ACCESSING DATA FOR
( 1)::FFFF:9.30.115.136
V447--INDEX SESSID A ST TIME
V448--( 1) 446:1027 W R2 0522008483849
DISPLAY ACTIVE REPORT COMPLETE
DSN9022I - DSNVDT '-DIS THD' NORMAL COMPLETION

Example 3: In this example, a system at Site 1 has a TSO application and an IMS
application. The system at Site 1 fails after DB2 commits the TSO application, but
before the commit decision has been communicated to the participant subsystems
at Site 2. The failure occurs before IMS has communicated the commit or rollback
decision to the Site 1 DB2 subsystem. The DISPLAY THREAD commands that are
issued at Site 1 and 2 show report output similar to the following:

The following DISPLAY THREAD command is issued at Site 1:

-DISPLAY THREAD(*) TYPE(INDOUBT)

This command produces output similar to the following output:

DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
DSNV406I - INDOUBT THREADS -
COORDINATOR STATUS RESET URID AUTHID
TEST0001 INDOUBT 00000EA8BD60 SYSADM
V449-HAS NID= DONSQLXX.F100000000 AND ID= CTHDCORID001
V467-HAS LUWID USIBMSY.SYEC717A.BD6E5A52FFd1.0001=49
V466-THREAD HAS BEEN INDOUBT FOR 00:06:03
V450-HAS PARTICIPANT INDOUBT AT
STL717B-SYEC717B
STL717A COMMITTED 00000EA8C6CE SYSADM
V467-HAS LUWID USIBMSY.SYEC717A.BD6E5BOA1F94.0001=52
V450-HAS PARTICIPANT INDOUBT AT
STL717B-SYEC717B
STL716A-SYEC716A
DISPLAY INDOUBT REPORT COMPLETE
DSN9022I - DSNVDT '-DISPLAY THREAD' NORMAL COMPLETION

The following DISPLAY THREAD command is issued at Site 2:

-DISPLAY THREAD(*) TYPE(INDOUBT)

Chapter 34. -DISPLAY THREAD (DB2) 235

 This command produces output similar to the following output:
| DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
| DSNV406I - INDOUBT THREADS -
| COORDINATOR STATUS RESET URID AUTHID
| STL717A-SYEC717A INDOUBT 00000DAC6538 SYSADM
| V467-HAS LUWID USIBMSY.SYEC717A.BD6E5A52FFD1.0001=26
| V466-THREAD HAS BEEN INDOUBT FOR 00:14:29
| STL717A-SYEC717A INDOUBT 00000DAC792C SYSADM
| V467-HAS LUWID USIBMSY.SYEC717A.BD6E5BOA1F94.0001=28
| V466-THREAD HAS BEEN INDOUBT FOR 00:09:45
| DISPLAY INDOUBT REPORT COMPLETE
| DSN9022I - DSNVDT '-DIS THREAD' NORMAL COMPLETION

Example 4: This example shows a thread executing within a stored procedure and
a thread waiting for a stored procedure to be scheduled. Assume that an
application makes a call to stored procedure PROC1 and then to stored procedure
PROC2. PROC2 is in a STOP QUEUE state.

The output for PROC1 while it is executing shows a status of SP in the ST column,
which indicates that a thread is executing within a stored procedure:
-DISPLAY THREAD(*)

This command produces output similar to the following output:

DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
DSNV402I - ACTIVE THREADS - 176
NAME ST A REQ ID AUTHID PLAN ASID TOKEN
BATCH SP 3 RUNAPPL SYSADM PL01AP01 001D 43
V429 CALLING STORED PROCEDURE PROC1, LOAD MODULE LMPROC1
DISPLAY ACTIVE REPORT COMPLETE
DSN9022I - DSNVDT '-DISPLAY THREAD' NORMAL COMPLETION

The output for PROC2, while it is queued, shows a status of SW in the ST column,
which indicates that a thread is waiting for a stored procedure to be scheduled:
-DISPLAY THREAD(*)

This command produces output similar to the following output:

DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
DSNV402I - ACTIVE THREADS - 198
NAME ST A REQ ID AUTHID PLAN ASID TOKEN
BATCH SW * 13 RUNAPPL SYSADM PL01AP01 001D 43
V429 CALLING STORED PROCEDURE PROC2, LOAD MODULE
DISPLAY ACTIVE REPORT COMPLETE
DSN9022I - DSNVDT '-DISPLAY THREAD' NORMAL COMPLETION

Example 6: This example shows an allied, non-distributed originating thread

(TOKEN=30) that is established (allocated according to plan) in addition to all of
its parallel tasks (PT), which are running on the same DB2 system. All parallel
tasks are displayed immediately following their corresponding originating thread.
16.32.57 DB1G DISPLAY THREAD(*)
16.32.57 STC00090 DSNV401I DB1G DISPLAY THREAD REPORT FOLLOWS -
16.32.57 STC00090 DSNV402I DB1G ACTIVE THREADS -
NAME ST A REQ ID AUTHID PLAN ASID TOKEN
BATCH T * 1 PUPPYDML USER001 DSNTEP3 0025 30
PT * 641 PUPPYDML USER001 DSNTEP3 002A 40
PT * 72 PUPPYDML USER001 DSNTEP3 002A 39
PT * 549 PUPPYDML USER001 DSNTEP3 002A 38
PT * 892 PUPPYDML USER001 DSNTEP3 002A 37
PT * 47 PUPPYDML USER001 DSNTEP3 002A 36
PT * 612 PUPPYDML USER001 DSNTEP3 002A 35
PT * 545 PUPPYDML USER001 DSNTEP3 002A 34
PT * 432 PUPPYDML USER001 DSNTEP3 002A 33

236 Command Reference

 PT * 443 PUPPYDML USER001 DSNTEP3 002A 32
PT * 252 PUPPYDML USER001 DSNTEP3 002A 31
DISPLAY ACTIVE REPORT COMPLETE
16.32.58 STC00090 DSN9022I DB1G DSNVDT '-DISPLAY THREAD' NORMAL
COMPLETION

Example 7: This example shows the detail report for a DB2 client that uses TCP/IP
to access a remote DRDA server.
-DISPLAY THREAD(*) LOCATION(*) DETAIL

This command produces output similar to the following output:

DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
DSNV402I - ACTIVE THREADS -
NAME ST A REQ ID AUTHID PLAN ASID TOKEN
BATCH TR * 4 DSNTEP3 ADMF001 DSNTEP3 0024 61
V441-ACCOUNTING=KEITH:DSNTEP3
V436-PGM=DSNTEP3.DSNTEP3, SEC=1, STMNT=1973
V444-USIBMSY.SYEC717A.BD6E60CE2BD3=61 ACCESSING DATA AT
( 1)STL717B-::FFFF:9.30.115.135..447
V447--INDEX SESSID A ST TIME
V448--( 1) 1027:447 N R2 0522009445180
DISPLAY ACTIVE REPORT COMPLETE
DSN9022I - DSNVDT '-DIS THD' NORMAL COMPLETION

| Example 8: This example shows the detail report for a client that supports IPv6
| addressing and provides a 58-character extended correlation token to the DB2
| server. That token is displayed in message V442.
| -DISPLAY THREAD(*)

| This command produces output similar to the following output:

| DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
| DSNV402I - ACTIVE THREADS -
| NAME ST A REQ ID AUTHID PLAN ASID TOKEN
| SERVER RA * 1 db2bp ADMF001 DISTSERV 003A 3
| V437-WORKSTATION=hornet, USERID=admf001,
| APPLICATION NAME=db2bp
| V442-CRTKN=1111:2222:3333:4444:5555:6666:7777:8888.65535.123456789ABC
| V445-G91A0D32.EBCF.C0C44BBCCFF4=3 ACCESSING DATA FOR
| 1111:2222:3333:4444:5555:6666:7777:8888
| DISPLAY ACTIVE REPORT COMPLETE
| DSN9022I - DSNVDT '-DIS THD' NORMAL COMPLETION

| Example 9: This example shows information about units of work whose back-out
processing has been postponed.
-DISPLAY THREAD (*) TYPE (POSTPONED)

This command produces output similar to the following output:

DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
DSNV431I - POSTPONED ABORT THREADS -
COORDINATOR STATUS RESET URID AUTHID
BATCH ABORT-P 000002FF98EA ADMF001
BATCH ABORT-P 000002FF9000 ADMF001
DISPLAY POSTPONED ABORT REPORT COMPLETE
DSN9022I - DSNVDT '-DISPLAY THREAD' NORMAL COMPLETION

Example 10: This example shows the token for a thread that is executing a
user-defined function. The token is 18.
-DISPLAY THREAD(*) DETAIL

This command produces output similar to the following output:

Chapter 34. -DISPLAY THREAD (DB2) 237

 DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
DSNV402I - ACTIVE THREADS -
NAME ST A REQ ID AUTHID PLAN ASID TOKEN
BATCH T * 231 DISTHD ADMF001 0021 95
BATCH SW * 38 INSERT ADMF001 DSNTEP3 0025 18
V436-PGM=CLIP74C1.UFIP74C1, SEC=0, STMNT=0
V429 CALLING FUNCTION =SCIP7401.SP_UFIP74C1 ,
PROC=V61AWLM3, ASID=0030, WLM_ENV=WLMENV3
DISPLAY ACTIVE REPORT COMPLETE
DSN9022I - DSNVDT '-DISPLAY THREAD' NORMAL COMPLETION

Example 11: This example shows information about a thread that is involved in an
RRS unit of recovery.
-DISPLAY THREAD(*) RRSURID(*)

This command produces output similar to the following output:

- 08.23.58 STC00149 DSNV401I ( DISPLAY THREAD REPORT FOLLOWS -
- 08.23.58 STC00149 DSNV402I ( ACTIVE THREADS -
- NAME ST A REQ ID AUTHID PLAN ASID TOKEN
- RRSAF T 8 TGXID-111 ADMF001 TGXIDR 0023 35
- V481-DB2 IS PARTICIPANT FOR RRS URID B4D0FC267EB020000000001101010000
- DISPLAY ACTIVE REPORT COMPLETE
- 08.23.58 STC00149 DSN9022I ( DSNVDT '-DIS THD' NORMAL COMPLETION

Example 12: This example shows information about a thread where DB2 is the
coordinator for an indoubt RRS unit of recovery. DB2 has committed the thread but
has not been able to resolve the RRS UR with RRS.
-DISPLAY THREAD(*) TYPE(I) RRSURID(*)

This command produces output similar to the following output:

- 09.27.21 STC00185 DSNV406I ( INDOUBT THREADS -
- COORDINATOR STATUS RESET URID AUTHID
- UNKNOWN COMMITTED 123456789ABC UNKNOWN
- V480-DB2 IS COORDINATOR FOR RRS URID C4D4FA267EB040000000001201020000
00- DISPLAY INDOUBT REPORT COMPLETE
- 09.27.21 STC00185 DSNV434I ( DSNVDT NO POSTPONED ABORT THREADS FOUND
- 09.27.21 STC00185 DSN9022I ( DSNVDT '-DIS THD' NORMAL COMPLETION

Example 13: This example shows the XID for an active thread that is associated
with an XA transaction manager:
-DISPLAY THREAD(*) DETAIL

This command produces output similar the following output:

#dis thd(*) det
DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
DSNV402I - ACTIVE THREADS -
NAME ST A REQ ID AUTHID PLAN ASID TOKEN
SERVERRX * 3 xidappl AdMF001 DISTSERV 0036 50
V440-XID=53514C20 00000017 00000000 544D4442
00000000 002F93DD A92F8C4F F3000000
0000BD
V445-G91E1F24.BAC1.01E098172410=50 ACCESSING DATA FOR
( 1)::FFFF:9.30.31.36
V447--INDEX SESSID A ST TIME
V448-- ( 1) 447:47809 W R2 0522010250267
DISPLAY ACTIVE REPORT COMPLETE
DSN9022I - DSNVDT '-DIS THD' NORMAL COMPLETION

| Example 14: This example shows a DISPLAY report of a thread associated with a
| trusted context.

238 Command Reference

| -DIS THD(*)
| DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
| DSNV402I - ACTIVE THREADS - 133
| NAME ST A REQ ID AUTHID PLAN ASID TOKEN
| BATCH T * 10 JOB01 ADMF001 APPL01 0027 12
| V485-TRUSTED CONTEXT=DOMINOCONTEXT, SYSTEM AUTHID=SYSADM,
| ROLE=USRROLE
| DISPLAY ACTIVE REPORT COMPLETE
| DSN9022I - DSNVDT '-DIS THD' NORMAL COMPLETION

| Example 15: This example shows the command during restart. A DSNV506I
| message will indicate what state DB2 is in, such as STARTING, ACTIVE,
| STOPPING. The message will also indicate the phase of restart or shutdown, if
| available.
| -DIS THD(*) TYPE(SYSTEM)
| DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
| DSNV497I - SYSTEM THREADS -
| DB2 STARTING PHASE=Subsystem Startup Recovery Log Manager
| NAME ST A REQ ID AUTHID PLAN ASID TOKEN
| V91A N * 0 031.GlmTsk00 SYSOPR 002D 0
| V490-SUSPENDED 05136-13:53:12.73 DSN7LSTK +00000D0C 05.45
| V91A N * 0 023.GCSCNM03 SYSOPR 002D 0
| DISPLAY SYSTEM THREAD REPORT COMPLETE
| DSN9022I ) DSNVDT '-DIS THD' NORMAL COMPLETION

| Example 16: This example shows the command executing while DB2 is active.
| Many system threads are suspended as shown in the DSNV490I messages. In
| addition, system thread 023.GSCN6 03 is currently executing the -DISPLAY
| THREAD(*) TYPE(SYSTEM) command.
| -DIS THD(*) TYPE(SYSTEM)
| DSNV401I ) DISPLAY THREAD REPORT FOLLOWS -
| DSNV497I ) SYSTEM THREADS -
| DB2 ACTIVE
| NAME ST A REQ ID AUTHID PLAN ASID TOKEN
| V91A N * 0 020.PEXCTL00 SYSOPR 002E 0
| V490-SUSPENDED 05136-13:53:29.55 DSNTLCTL +000004F0 16.31
| V91A N * 0 010.PMICMS01 SYSOPR 002E 0
| V490-SUSPENDED 05136-13:53:47.29 DSNB1CMS +000005E8 12.21
| V91A N * 0.010.PMITMR02 SYSOPR 002E 0
| ...
| ...
| V91A N * 0.004.JW007 01 SYSOPR 002D 0
| V490-SUSPENDED 05136-13:54:03.60 DSNJW107 +000002B2 12.27
| V91A N * 0.004.JTIMR 00 SYSOPR 002D 0
| V91A N * 0.016.WVSMG 00 SYSOPR 002D 0
| V490-SUSPENDED 05136-13:53:23.83 DSNWVSMG +00000534 01.54
| V91A N * 0.026.WVZXT 01 SYSOPR 002D 0
| V91A N * 0.016.WVSMT 01 SYSOPR 002D 0
| V490-SUSPENDED 05136-13:53:48.10 DSNWVSMT +00000D7C 01.54
| V91A N * 0.023.GSCN6 03 SYSOPR 002D 0
| V501-COMMAND EXECUTING: -DIS THD(*) TYPE(SYSTEM)
| DISPLAY SYSTEM THREAD REPORT COMPLETE
| DSN9022I ) DSNVDT '-DIS THD' NORMAL COMPLETION
| DISPLAY SYSTEM THREAD REPORT COMPLETE
| DSN9022I ) DSNVDT '-DIS THD' NORMAL COMPLETION

| Example 17: This display shows the command executing while DB2 is stopping.
| The DSNV506I message identifies the phase of shutdown.
| -DIS THD(*) TYPE(SYSTEM)
| DSNV401I - DISPLAY THREAD REPORT FOLLOWS -
| DSNV497I - SYSTEM THREADS -
| NAME ST A REQ ID AUTHID PLAN ASID TOKEN
| V91A N * 0 020.PEXCTL00 SYSOPR 002E 0

Chapter 34. -DISPLAY THREAD (DB2) 239

| V490-SUSPENDED 05136-13:53:29.55 DSNTLCTL +000004F0 16.31
| V91A N * 0 010.PMICMS01 SYSOPR 002E 0
| V490-SUSPENDED 05136-13:53:47.29 DSNB1CMS +000005E8 12.21
| V91A N * 0.010.PMITMR02 SYSOPR 002E 0
| V91A N * 0.022.SPQMON01 SYSOPR 002E 0
| V91A N * 0.014.RTSTST00 SYSOPR 002E 0
| V490-SUSPENDED 05136-13:53:45.79 DSNB1TMR +00000B74 16.27
| V91A N * 0.010.PM2PCP01 SYSOPR 002E 0
| V490-SUSPENDED 05136-13:53:47.33 DSNB1TMR +00000B74 16.27
| V91A N * 0 010.PM2CSX01 SYSOPR 002E 0
| V490-SUSPENDED 05136-13:53:47.30 DSNB1TMR +00000B74 16.27
| V91A N * 0 010.PM2PCK02 SYSOPR 002E 0
| V490-SUSPENDED 05136-13:54:17.31 DSNB1TMR +00000B74 16.27
| V91A N * 0 031.GlmTsk00 SYSOPR 002D 0
| V490-SUSPENDED 05136-13:53:12.73 DSN7LSTK +00000D0C 05.45
| V91A N * 0 023.GCSCNM03 SYSOPR 002D 0
| V91A N * 0 004.JW007 01 SYSOPR 002D 0
| V490-SUSPENDED 05136-13:54:31.62 DSNJW107 +000002B2 12.27
| V91A N * 0 023.GSCN6 03 SYSOPR 002D 0
|
| V501-COMMAND EXECUTING: -DIS THD(*) TYPE(SYSTEM)
| DISPLAY SYSTEM THREAD REPORT COMPLETE
| DSN9022I ) DSNVDT '-DIS THD' NORMAL COMPLETION

| Example 18: This example shows information about an active database access
| thread that is disconnected.
| -DISPLAY THREAD(*) DETAIL

| This command produces output that is similar to the following output:

| 13.23.46 =dis thread(*) detail
| 13.23.46 STC00067 DSNV401I = DISPLAY THREAD REPORT FOLLOWS -
| 13.23.46 STC00067 DSNV402I = ACTIVE THREADS -
| NAME ST A REQ ID AUTHID PLAN ASID TOKEN
| DISCONN DA * 8 NONE NONE DISTSERV 003B 11
| V471-USIBMSY.SYEC1DB2.C1C38BDE809D=11
| DISPLAY ACTIVE REPORT COMPLETE
| 13.23.46 STC00067 DSN9022I = DSNVDT '-DIS THREAD' NORMAL COMPLETION

| Example 19: This example shows information about an inactive connection.

| -DISPLAY THREAD(*) TYPE(INACTIVE)

| This command produces output that is similar to the following output:

| - 13.27.47 =dis thread(*) type(inactive)
| - 13.27.47 STC00067 DSNV401I = DISPLAY THREAD REPORT FOLLOWS -
| - 13.27.47 STC00067 DSNV424I = INACTIVE THREADS -
| - NAME ST A REQ ID AUTHID PLAN ASID TOKEN
| - SERVER R2 0 javaw.exe ADMF001 DISTSERV 003B 12
| - V437-WORKSTATION=KFUKUSH, USERID=admf001,
| - APPLICATION NAME=javaw.exe
| - V445-G91E1686.EF04.080107212323=12 ACCESSING DATA FOR ::FFFF:9.30.22.134
| - SERVER R2 0 db2bp.exe ADMF001 DISTSERV 003B 14
| - V437-WORKSTATION=KFUKUSH, USERID=admf001,
| - APPLICATION NAME=db2bp.exe
| - V445-G91E1686.F104.080107212343=14 ACCESSING DATA FOR ::FFFF:9.30.22.134
| - DISPLAY INACTIVE REPORT COMPLETE
| - 13.27.47 STC00067 DSN9022I = DSNVDT '-DIS THREAD' NORMAL COMPLETION

240 Command Reference

 Chapter 35. -DISPLAY TRACE (DB2)
The DB2 command DISPLAY TRACE displays a list of active traces.

An additional option to this command and additional values for a few options of
this command are not described here. They are intended for service and use under
the direction of IBM support personnel.

| This command is also available in conversion mode.

Abbreviation: -DIS TRACE

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 242
v “Option descriptions” on page 243
v “Usage notes” on page 247
v “Examples” on page 249

Environment

This command can be issued from a z/OS console, a DSN session, a DB2I panel
(DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group or local, depending on the value of the SCOPE option.

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v DISPLAY privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 241

| Syntax
|

| ,
| *


DISPLAY TRACE ( ) DEST(  GTF )

PERFM SMF constraint block DETAIL(output-type) COMMENT(string)
ACCTG SRV
STAT OPn
AUDIT
MONITOR

|


| LOCAL RMID
SCOPE ( GROUP )

|
| constraint block:

|



| * * *
, , ,

PLAN(  plan-name ) PKGLOC(  package-location ) PKGCOL(  package-collection-id )

partial-package-location partial-package-collection-id

|


| * * *
, , ,

PKGPROG(  package-program name ) AUTHID(  auth-id ) CLASS(  integer )

partial-package-program name partial-userid

|


| * LOCATION( * ) *
, , ,

TNO(  integer )  location-name USERID(  userid )

<luname> partial-userid
partial-<luname>*
ipaddr
partial-ipaddr

|


| * *
, ,

APPNAME(  application-name ) WRKSTN(  workstation-name )

partial-application-name partial-workstation-name

|


| * *
, ,

CONNID(  connection-role-id ) CORRID(  correlation-id )

partial-connection-role-id partial-correlation-id

|


| * constraint block 2
,

ROLE(  connection-role )
partial-connection-role-id
|

242 Command Reference

 constraint block 2:

|



| , ,

XPLAN(  plan-name ) XPKGLOC(  package-location )

partial-plan-name partial-package-location

|


| , ,

XPKGCOL(  package-collection-id ) XPKGPROG(  package-program-name )

partial-package-collection-id partial-package-program-name

|


| , , ,

XAUTHID(  authorization-id ) XLOC(  location-name ) XUSERID(  userid )

partial-authorization-id partial-location-name partial-userid
< luname >
partial-<luname>*
ipaddr
partial-ipaddr

|


| , ,

XAPPNAME(  application-name ) XWRKSTN(  workstation-name )

partial-application-name partial-workstation-name

|


| , ,

XCONNID(  connection-role-id ) XCORRID(  correlation-id )

partial-connection-role-id partial-correlation-id

|


| ,

XROLE(  connection-role )
partial-connection-role-id
|

Option descriptions

None of the options are required. The command DISPLAY TRACE lists all active
traces. Each option that is used, except TNO, limits the effect of the command to
active traces that were started using the same option, either explicitly or by
default, with exactly the same parameter values. For example, the following
command lists only the active traces that were started using the options PERFM
and CLASS (1,2); it does not list, for example, any trace started using CLASS(1).
-DISPLAY TRACE (PERFM) CLASS (1,2)
(*)
Does not limit the list of traces. The default is ( * ).
The CLASS option cannot be used with DISPLAY TRACE (*).
Each of the following keywords limits the list to traces of the corresponding
type.
Type (Abbrev)
Description

Chapter 35. -DISPLAY TRACE (DB2) 243

 PERFM (P)
Performance records of specific events
ACCTG (A)
Accounting records for each transaction
STAT (S)
Statistical data
AUDIT (AU)
Audit data
MONITOR (MON)
Monitor data
DETAIL ( output-type )
Limits the information that a trace displays based on the output type specified
within parentheses.
The possible values for output-type are:
1 Display summary trace information: TRACE NUMBER, TYPE, CLASS,
DEST
2 Display qualification trace information: TRACE NUMBER, AUTHID,
LOCATION, PACKAGE, PLAN, TXACT, USERID, WORKSTATION
1,2 Display both summary and qualification information
* Display both summary and qualification information
If no parameter follows DETAIL, type 1 trace information is displayed.
An additional column, QUAL, is also displayed, indicating whether the trace is
qualified. Part of the summary trace information, the QUAL column can be
used to determine if further qualification information for the trace is available.
This information can be obtained by specifying DETAIL (2) or DETAIL (*). A
QUAL column value of YES indicates that additional information for this
particular trace exists in the qualification trace information; a value of NO
indicates that no additional information for this trace exists.
COMMENT ( string )
Specifies that comment string appears in the trace output, except for the output
in the resident trace tables.
string is any character string; it must be enclosed between apostrophes if it
includes a blank, comma, or special character. The comment does not appear in
the display; it can be recorded in trace output, but only if commands are being
traced.
SCOPE
Specifies the scope of the command.
( LOCAL )
Displays the trace for the local member only.
(GROUP)
Displays the trace for all members in the data sharing group.
DEST
Limits the list to traces started for particular destinations. More than one value
can be specified, but do not use the same value twice. If you do not specify a
value for DEST, DB2 does not use the destination of where trace output is
recorded to limit the list of traces displayed.

244 Command Reference

 Abbreviation: D
Possible values and their meanings are:
Value Trace destination
GTF The generalized trace facility
SMF The system management facility
SRV An exit to a user-written routine
OP n A specific destination. n can be a value from 1 to 8.
| RMID
| Specifies resource manager identifier. You can specify up to 8 valid RMIDs,
| which are one or two digit identifiers. You cannot specify RMID for accounting
| or statistic traces.
PLAN( plan-name , ...)
Limits the list to traces started for particular application plans. Up to eight
plan names can be used. If more than one name is used, only one value can be
used for AUTHID, TNO, and LOCATION. Do not use this option with STAT.
The default is PLAN ( * ), which does not limit the list.
| PKGLOC
| Specifies the location name where the package is bound.
| PKGCOL
| Specifies the package collection name.
| PKGPROG
| Specifies the DBRM or program name.
AUTHID( authorization-id , ...)
Limits the list to traces started for particular authorization identifiers. Up to
eight identifiers can be used. If more than one identifier is used, only one
value can be used for PLAN, TNO, and LOCATION. Do not use this option
with STAT.
The default is AUTHID ( * ), which does not limit the list.
CLASS( integer , ...)
Limits the list to traces started for particular classes.
The default is CLASS( * ), which does not limit the list.
TNO( integer , ...)
Limits the list to particular traces, identified by their trace numbers (1 to 32, 01
to 09). Up to eight trace numbers can be used. If more than one number is
used, only one value each for PLAN, AUTHID, and LOCATION can be used.
The default is TNO( * ), which does not limit the list.
LOCATION( location-name , ...)
Limits the list to traces started for threads that have a distributed relationship
with the specified location.
( location-name )
Introduces a list of specific location names for which trace information is to be
displayed. Supplying an * as the location name indicates that the trace report
must include all traces started with any location name qualifier.
You can specify up to eight location names. If you specify more than one
location name, you can only specify one value each for PLAN, AUTHID, and
TNO.
LOCATION cannot be specified when you choose a statistics trace.

Chapter 35. -DISPLAY TRACE (DB2) 245

 Requesters other than DB2 for z/OS: DB2 does not receive a location name
from requesters that are not DB2 for z/OS subsystems. To display information
about a requester that is not a DB2 for z/OS subsystem, enter its LU name,
enclosed in the less-than (<) and greater-than (>) symbols. For example, the
following command displays information about a remote location with the LU
name of LULA:
-DISPLAY TRACE (*) LOCATION (<LULA>)
DB2 uses the < LU name> notation in messages displaying information about
requesters that are not DB2 for z/OS subsystems.
The default is LOCATION( * ), which does not limit the list.
<luname>
Activates the DB2 trace for the remote clients that are connected to DDF
through the remote SNA LU that you specified in luname.
| ipaddr
| Activates the DB2 trace for the remote clients that are connected to DDF
| through the remote TCP/IP host whose IP address is specified by ipaddr .
| USERID
| Specifies a 16-byte area that contains the user ID of the client end user. You can
| use this parameter to provide the identity of the client end user for accounting
| and monitoring purposes. DB2 displays this user ID in DISPLAY THREAD
| output and in DB2 accounting and statistics trace records.
| APPNAME
| A 32-byte area that contains the application or transaction name of the end
| user’s application. You can use this parameter to provide the identity of the
| client end user for accounting and monitoring purposes. DB2 displays the
| application name in the DISPLAY THREAD output and in DB2 accounting and
| statistics trace records.
| WRKSTN
| An 18-byte area that contains the workstation name of the client end user. You
| can use this parameter to provide the identity of the client end user for
| accounting and monitoring purposes. DB2 displays the workstation name in
| the DISPLAY THREAD output and in DB2 accounting and statistics trace
| records.
| CONNID
| Specifies the connection ID.
| CORRID
| Specifies the correlation ID.
| ROLE
| Specifies the connection roles.
| XPLAN
| Provides exclude filtering for plan name.
| XPKGLOC
| Provides exclude filtering for package location name.
| XPKGCOL
| Provides exclude filtering for package collection ID.
| XPKGPROG
| Provides exclude filtering for package program name.

246 Command Reference

| XAUTHID
| Provides exclude filtering for authorization ID.
| XLOC
| Provides exclude filtering for location.
| XUSERID
| Provides exclude filtering for user ID.
| XAPPNAME
| Provides IFC exclude filtering for application or transaction name.
| XWRKSTN
| Provides IFC exclude filtering for workstation name.
| XCONNID
| Provides exclude filtering for connection ID.
| XCORRID
| Provides exclude filtering for correlation ID.
| XROLE
| Provides exclude filtering for connection roles.

| Usage notes

| Displaying traced threads using the * wildcard: You can use the wildcard suffix,
| “*” to filter threads that you want to display. For example, if you specify
| “-DISPLAY TRACE PLAN (A,B,C*)”, DB2 will display traces A, B, CDE, CDEFG,
| CDEFGH, and so on. It will display traced threads “A”, “B” and all threads
| starting with “C”.

| Displaying traced threads using the positional, (_) wildcard: You can utilize the
| positional wildcard, which is represented by the, “_” character, to display traced
| threads when you want the wildcard in the middle, or when you want to trace
| threads of a specific length. For example, if you specify “-DISPLAY TRACE PLAN
| (A_B), all display all traced threads that have “A” as the first character, any
| character for the ″_,″ and “C” as the plan filter.

| Displaying multiple traced threads at once using wildcards: You also have the
| option of displaying multiple traced threads based on multiple trace qualifications.
| For example, you can specify, “-DISPLAY TRACE PLAN (A*, B*, C*) to
| simultaneously display all traced threads for plan that start with “A”, “B”, and
| “C”. The wildcard character, “*” will display all traced threads. You can specify
| more complex combinations such as, “-DISPLAY TRACE PLAN (A_B*, C*, AND
| C/_D*)”, which will return all threads that:
| v begin with “A”, have a one character wild card as the second character in the
| thread, have a “B” as the third character in the thread, and end with any type or
| number of characters (ADBIOP, AOBTYJDP,)
| v begin with “C”, and end with any combination of characters (CDE, CGHKO)
| v begin with “C_D” and end with any type of character combination (C_DEFGH,
| C_DlMNOP)
| All of the possible thread combinations listed above will be returned with the
| command above.

| You have the ability to filter multiple threads at the same time, setting specific
| criteria for the trace. For example, you can specify, “-DISPLAY TRACE PLAN (A)
| USERID (B).″ This will display all traced threads where the plan thread is ″A,″ and

Chapter 35. -DISPLAY TRACE (DB2) 247

| the user ID is ″B.″ Note: When displaying traced threads, you can only specify one
| thread criteria for each filter for the display trace command. For example, you can
| specify “-DISPLAY TRACE PLAN(A,B) USERID (B) WRKSTN (E),” but you cannot
| specify “-DISPLAY TRACE PLAN(A, B) USERID(A, B) WRKSTN(E) because, in
| this example, two of the filter qualifications have two elements defined to be
| traced, and DB2 only allows for one attribute to have more than one trace element
| to be defined per trace.

| Filtering traced threads that you want to display using exclude functionality:
| When you specify an “X” with any constraint keyword, such as “XPLAN”, when
| you are filtering threads, you are using the exclude functionality for the display
| trace command. You have the option of excluding specific types of threads you
| want to display when you are running trace commands. You can use the “X”
| character to exclude specific combinations of characters when you are running a
| display trace command. For example, you can specify “-DISPLAY TRACE
| XPLAN(A), to display all traced threads EXCEPT “A”. In this instance B, BCD,
| BCDE, or CD could possibly be returned.

| You also have the option of excluding multiple types of threads from your trace.
| For example, you can specify, “-DISPLAY TRACE XPLAN (A*, B*) to display all
| traced threads EXCEPT those starting with “A”, with any combination of
| characters following “A”, and all those characters starting with “B”, with any
| combination of characters following “B”. Note: Specifying XPLAN (*) will exclude
| all threads from your search, and is not allowed. You also cannot use the wildcard
| in the middle of a display trace command with exclude functionality, such as,
| “-DISPLAY TRACE XPLAN (A*C).” You can, however, specify “-DISPLAY TRACE
| XPLAN (A_ _ C *)”, which will return all threads EXCEPT those starting with “A”,
| a variety of TWO characters next, a “C” in the fourth space, and a variety of
| characters at the end. The wildcard symbol cannot be placed in the middle of trace
| criteria.

| You have the ability to display two traces at once, in order to help you optimize
| your tracing capabilities. For example, you can specify (-DISPLAY TRACE XPLAN
| (A, B, C) USERID (D))”. This tells DB2 to display all threads that are being traced
| for “plan” EXCEPT threads “A”, “B”, or “C”, only where the user ID = “D”.

| Combining trace qualifiers: You can customize the threads you trace by
| commanding DB2 to trace specific threads, while excluding other specific threads.
| For example, you can specify, “-DISPLAY TRACE USERID(A,B) XPLAN (C)” . This
| criteria only traces threads where the user ID is equal to “A” or “B”, and plan is
| NOT equal to “C”. In this example, a thread where the user ID is “A” and the plan
| is equal to “D” would pass, and be traced, but a thread where the user ID is “A”
| and plan is “C” would not pass, and would not be traced.

| You can introduce wildcards into your display trace commands to add more
| customization to your traces. For example, you can specify “-DISPLAY TRACE
| PLAN (C*) USERID (Z, X) XPLAN (C, D, E)”. In this example, for the thread to be
| traced, the plan must begin with ″C,″ the user ID must be equal to ″Z″ or to ″X,″
| and the plan cannot be ″C,″ ″D,″ or ″E.″ So a plan of ″CB,″ with a user ID of ″Z″
| would pass, and the thread being traced would be displayed, but plan C with a
| user ID of ″X″ would fail because the command specifies not to trace threads
| where the plan is “C”, without additional characters in the thread.

248 Command Reference

Examples

Example 1: List all traces that have the generalized trace facility as their only
destination.
-DISPLAY TRACE (*) DEST (GTF)

Example 2: List all active performance traces.

-DISPLAY TRACE=P

Example 3: List all active audit traces for threads that are connected to the DB2
subsystem with location name USIBMSTODB23.
-DISPLAY TRACE (AUDIT) LOCATION (USIBMSTODB23)

Example 4: Output from the DISPLAY TRACE command is a set of messages that
look similar to the following messages:
- 10.26.34 -DISPLAY TRACE
- 10.26.34 STC 21 DSNW127I - CURRENT TRACE ACTIVITY IS -
- TNO TYPE CLASS DEST QUAL
- 01 STAT 01 SMF NO
- 02 ACCTG 01 SMF YES
- 03 PERFM 01,02,03 GTF YES
- 04 AUDIT 01,02,03,04, SMF YES
- 04 06,07
- 05 MON 01,02,03 OP1 NO
- *********END OF DISPLAY TRACE SUMMARY DATA*********
- 10.26.34 STC 21 DSN9022I - DSNWVCM1 '-DISPLAY TRACE' NORMAL COMPLETION

- 10.28.47 -DISPLAY TRACE DETAIL(*)

- 10.28.47 STC 21 DSNW127I - CURRENT TRACE ACTIVITY IS -
- TNO TYPE CLASS DEST QUAL
- 01 STAT 01 SMF NO
- 02 ACCTG 01 SMF YES
- 03 PERFM 01,02,03 GTF YES
- 04 AUDIT 01,02,03,04, SMF YES
- 04 06,07
- 05 MON 01,02,03 OP1 NO
- *********END OF DISPLAY TRACE SUMMARY DATA*********
- 10.28.47 STC 21 DSNW143I - CURRENT TRACE QUALIFICATIONS ARE -
- TNO AUTHID PLAN RMID LOCATION
- 01 * * *
- 02 * * *
- 03 USER01 * *
- 04 * * 14,16,18,26 DENVER
- 05 * PROG1 *
- 06 * * *
- ******END OF DISPLAY TRACE QUALIFICATION DATA******
- 10.28.47 STC 21 DSN9022I - DSNWVCM1 '-DISPLAY TRACE' NORMAL COMPLETION

Example 5: Output from the DISPLAY TRACE command is a set of messages that
look similar to the following messages:
- 13.47.09 )dis trace(*)
- 13.47.09 STC00068 DSNW127I - CURRENT TRACE ACTIVITY IS -
- TNO TYPE CLASS DEST QUAL
- 01 STAT 01 SMF NO
- 02 ACCTG 01 SMF YES
- 03 PERFM 01,02,03 GTF YES
- 04 AUDIT 01,02,03,04, SMF YES
- 04 06,07
- 05 MON 01,02,03 OP1 NO
- *********END OF DISPLAY TRACE SUMMARY DATA*********
- 10.26.34 STC 21 DSN9022I - DSNWVCM1 '-DISPLAY TRACE' NORMAL COMPLETION

Chapter 35. -DISPLAY TRACE (DB2) 249

 - 10.28.47 -DISPLAY TRACE DETAIL(*)
- 10.28.47 STC 21 DSNW127I - CURRENT TRACE ACTIVITY IS -
- TNO TYPE CLASS DEST QUAL
- 01 STAT 01 SMF NO
- 02 ACCTG 01 SMF YES
- 03 PERFM 01,02,03 GTF YES
- 04 AUDIT 01,02,03,04, SMF YES
- 04 06,07
- 05 MON 01,02,03 OP1 NO
- *********END OF DISPLAY TRACE SUMMARY DATA*********
- 10.28.47 STC 21 DSNW143I - CURRENT TRACE QUALIFICATIONS ARE -
- TNO AUTHID PLAN RMID LOCATION
- 01 * * *
- 02 * * *
- 03 USER01 * *
- 04 * * 14,16,18,26 DENVER
- 05 * PROG1 *
- 06 * * *
- ******END OF DISPLAY TRACE QUALIFICATION DATA******
- 10.28.47 STC 21 DSN9022I - DSNWVCM1 '-DISPLAY TRACE' NORMAL COMPLETION

Example 6: Output from the DISPLAY TRACE command with the XPLAN option,
is a message that looks similar to the following message:
- 10.54.16 STC00051 DSNW127I ) CURRENT TRACE ACTIVITY IS -
- TNO TYPE CLASS DEST QUAL IFCID
- 02 ACCTG 01 SMF YES
- *********END OF DISPLAY TRACE SUMMARY DATA*********
- 10.54.16 STC00051 DSN9022I ) DSNWVCM1 '-DIS TRACE' NORMAL COMPLETION

If you dont have a trace started with XPLAN(A) qualifier, then you will get this:
- 10.55.41 STC00051 DSNW137I ) SPECIFIED TRACE NOT ACTIVE
- 10.55.41 STC00051 DSN9022I ) DSNWVCM1 '-DIS TRACE' NORMAL COMPLETION

250 Command Reference

Chapter 36. -DISPLAY UTILITY (DB2)
The DB2 command DISPLAY UTILITY displays the status of utility jobs, including
utility jobs in a data sharing group.

The output from the command consists of informational messages only. One set of
messages is returned for each job identified by the command. For utility jobs in a
data sharing group, the output shows the member name of the system on which
each utility job is running.

The status from the display represents the current status, except in a data sharing
group when the utility is running on a member other than the one from which the
command is issued. In that case, the status is current as of the last checkpoint.

Abbreviation: -DIS UTIL

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions” on page 252
v “Usage notes” on page 252
v “Output” on page 252
v “Examples” on page 254

Environment

This command can be issued from a z/OS console, a DSN session, a DB2I panel
(DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group or member, depending on which option you choose

Authorization

None is required.

Syntax

DISPLAY UTILITY ( utility-id )

partial-utility-id*
*


,

MEMBER(  member-name )

© Copyright IBM Corp. 1983, 2009 251

 Option descriptions

Use at least one of the following options but do not use the same option more than
once.
( utility-id )
Identifies a single job by its utility identifier, the value given for the UID
parameter when the job was created.
If utility-id was created by the DSNU CLIST by default, it has the form of
tso-userid.control-file-name .
If utility-id was omitted when the utility job was created, utility-id has the form
userid.jobname .
( partial-utility-id* )
Identifies a set of utility jobs. A status message is shown for each utility
identifier that begins with the characters of partial-utility-id .
For example, -DISPLAY UTILITY(ABCD*) shows the status of every utility job
known to DB2 whose identifier begins with the characters ABCD.
(*) Shows the status of all utility jobs known to DB2, including jobs currently
running in a data sharing group.
MEMBER ( member-name , ...)
Restricts the display for the identified utility jobs to specific members of the
data sharing group. The default is to display utility jobs running on any
member. In a non-data-sharing environment, the option is ignored.

One set of messages is returned for each job identified by the command.

Usage notes
DISPLAY status
The status displayed in the returned message is the status at the time the
DB2 utility function received the command. Execution has proceeded,
therefore the current state of the utility can be different from the state
reported. For instance, the DISPLAY UTILITY command can indicate that a
particular utility identifier is active, but, when the message is received by
the requester, the utility job step could have terminated so that the utility
identifier is no longer known to DB2.
Command response
In a data sharing environment, messages DSNU100I, DSNU105I, DSNU106I
show the name of the member on which the utility job is running. If you
specify a single member name in the MEMBER option and that member
does not belong to the group, or if you specify a list of member names in
the MEMBER option and none of those members belong to the group, the
command fails and a message is issued.

Output

The output from the DISPLAY UTILITY command consists of informational

messages only.

Output during any phase of REORG with SHRLEVEL CHANGE or SHRLEVEL

REFERENCE: During any phase of REORG with SHRLEVEL CHANGE or
SHRLEVEL REFERENCE, the output of DISPLAY UTILITY includes the

252 Command Reference

 information in DSNU347I. During any phase of REORG with SHRLEVEL
CHANGE, the output of DISPLAY UTILITY includes information in DSNU384I as
shown in Example 4.
DEADLINE
Indicates a timestamp according to the most recently specified value of
DEADLINE.
MAXRO
Indicates the number of seconds, according to the most recently specified
value of MAXRO.
LONGLOG
Indicates either CONTINUE, TERM, or DRAIN according to the most
recently specified value of LONGLOG.
DELAY
Indicates the number of seconds according to the most recently specified
value of DELAY.

Output during LOG phase of REORG with SHRLEVEL CHANGE: During the LOG
phase of REORG with SHRLEVEL CHANGE, the output of DISPLAY UTILITY
now includes the additional information found in message DSNU383I, as shown in
Example 4.
CURRENT ITERATION NUMBER
Indicates the current iteration number.
WRITE ACCESS ALLOWED IN CURRENT ITERATION
Indicates “YES” or “NO” according to whether write access is allowed in
the current iteration of log processing.
ITERATION BEFORE PREVIOUS ITERATION
Indicates the ELAPSED TIME so far, and the NUMBER OF LOG
RECORDS PROCESSED in the iteration. Their value is zero if the current
iteration number is one or two.
PREVIOUS ITERATION
Indicates the ELAPSED TIME and the NUMBER OF LOG RECORDS
PROCESSED for the previous iteration. Their value is zero if the current
iteration number is one.
CURRENT ITERATION:
Indicates the ESTIMATED ELAPSED TIME, the ACTUAL ELAPSED TIME
SO FAR and the ACTUAL NUMBER OF LOG RECORDS BEING
PROCESSED.
CURRENT ESTIMATE FOR NEXT ITERATION
For the next iteration, indicates the currently ELAPSED TIME and the
currently estimated NUMBER OF LOG RECORDS TO BE PROCESSED.

| Output during UNLOAD phase of REORG with SHRLEVEL CHANGE or

| SHRLEVEL REFERENCE: During the UNLOAD phase of REORG with SHRLEVEL
| CHANGE or SHRLEVEL REFERENCE, DSNU111I messages are issued for the
| following subtasks: unloading nonpartitioned indexes, building shadow
| nonpartitioned indexes, sort, build, and inline statistics. The phase for subtasks for
| unloading nonpartitioned indexes is UNLOADIX. The phase for subtasks during
| the LOG phase is LOGAPPLY.

Chapter 36. -DISPLAY UTILITY (DB2) 253

 Progress of utility processing: The DISPLAY UTILITY command provides an
estimate of how much processing the utility has completed. The output displays
information from message DSNU105I as seen in Example 2, and includes the
following information:
COUNT
COUNT n is the number of pages or records processed in a utility phase.
COUNT has different meanings for different utilities. For utilities not
mentioned in the following list, ignore this field.
v For the LOAD utility, COUNT represents the total number of records
that have been loaded into all partitions when the command is issued.
The count is zero from the time the RELOAD phase starts until the first
LOAD subtask begins loading records into the first partition assigned to
that subtask.
v For the CHECK INDEX, RECOVER INDEX, and REORG utilities,
COUNT represents the number of records processed.
v For the COPY, MERGE COPY, RECOVER (restore phase), and
RUNSTATS utilities, COUNT represents the number of pages processed.
v For the STOSPACE utility, COUNT represents the number of table spaces
or indexes processed.

| Progress of the RECOVER utility: During the LOGAPPLY phase, you can use the
| DISPLAY UTILITY command to check the progress status of the RECOVER utility.
| Message DSNU116I provides an estimate of the log processing that has been
| completed for the recovery job. This function is available in conversion mode.

Examples

Example 1: Display status information for all utility jobs currently known to DB2.
-DISPLAY UTILITY (*)

Example 2: Display the status of utilities jobs on all members of the data sharing
group.
-DB1G DISPLAY UTILITY (*)

The following output, which shows utility jobs on members DB1G and DB2G, is
generated:
DSNU100I -DB1G DSNUGDIS USER = SAMPID
MEMBER = DB1G
UTILID = RUNTS
PROCESSING UTILITY STATEMENT 1
UTILITY = RUNSTATS
PHASE = RUNSTATS COUNT = 0
STATUS = STOPPED
DSNU100I -DB1G DSNUGDIS USER = SAMPID
MEMBER = DB2G
UTILID = CHKIX1
PROCESSING UTILITY STATEMENT 8
UTILITY = CHECK
PHASE = UNLOAD COUNT = 0
STATUS = STOPPED
DSN9022I -DB1G DSNUGCC '-DB1G DISPLAY UTILITY' NORMAL COMPLETION

Example 3: In a data sharing environment, display the status of utilities on member

DB1G.
-DB1G DISPLAY UTILITY (*) MEMBER (DB1G)

254 Command Reference

Example 4: This shows output from the following DISPLAY UTILITY command:
-DB1G DISPLAY UTILITY(*)
DSNU105I -DB1G DSNUGDIS - USERID = SYSADM 973
MEMBER = DB1G
UTILID = REORGCP
PROCESSING UTILITY STATEMENT 1
UTILITY = REORG
PHASE = LOG COUNT = 0
STATUS = ACTIVE
DSNU347I -DB1G DSNUGDIS - 974
DEADLINE = NONE
DSNU384I -DB1G DSNUGDIS - 975
MAXRO = DEFER
LONGLOG = CONTINUE
DELAY = 1200 SECONDS
DSNU383I -DB1G DSNUGDIS - CURRENT ITERATION NUMBER = 4 976
WRITE ACCESS ALLOWED IN THIS ITERATION = YES
ITERATION BEFORE PREVIOUS ITERATION:
ELAPSED TIME = 00:00:00
NUMBER OF LOG RECORDS PROCESSED = 0
PREVIOUS ITERATION:
ELAPSED TIME = 00:00:00
NUMBER OF LOG RECORDS PROCESSED = 0
CURRENT ITERATION:
ESTIMATED ELAPSED TIME = 00:00:00
ACTUAL ELAPSED TIME SO FAR = 00:00:00
ACTUAL NUMBER OF LOG RECORDS BEING PROCESSED = 0
CURRENT ESTIMATE FOR NEXT ITERATION:
ELAPSED TIME = 00:00:00
NUMBER OF LOG RECORDS TO BE PROCESSED = 0
SN9022I -DB1G DSNUGCCC '-DIS UTIL' NORMAL COMPLETION

Chapter 36. -DISPLAY UTILITY (DB2) 255

256 Command Reference
|

Chapter 37. DSN (TSO)

The TSO command DSN starts a DSN session.

The TSO command DSN enables you to issue the following DSN subcommands:
v ABEND
v BIND
v DCLGEN
v END
v FREE
v REBIND
v RUN
v SPUFI

During a DSN session, you can enter DB2 commands or comments. DB2
commands must start with a hyphen (-). Comments must start with an asterisk (*).

During a DSN session, you can also issue TSO commands, except for FREE, RUN,
TEST, and TIME. To use TSO TEST to debug an application program, run it with
the DSN command; for example:
TEST 'prefix.SDSNLOAD(DSN)' CP

The ABEND subcommand is used for diagnostic purposes only, and is intended to
be used only under the direction of IBM Software Support. Use it only when
diagnosing a problem with DSN or DB2. Percent commands are not recognized
during a DSN session, they are only supported by the TSO command processor.

Subsections:
v “Environment”
v “Authorization” on page 258
v “Syntax” on page 258
v “Option descriptions” on page 258
v “Usage notes” on page 259
v “Examples” on page 260

Environment

A DSN session runs under TSO in either foreground or background mode. When
you run it in background mode, you are not prompted for corrections or additional
required information.

You can also start a DSN session from a CLIST running in either foreground or
background mode.

Data sharing scope: Member

© Copyright IBM Corp. 1983, 2009 257

 Authorization

None is required for the DSN command, but authorization is required for most
subcommands.

| Syntax
|

|

DSN

| DSN 0
SYSTEM( subsystem-name ) RETRY( integer )
group-attachment-name

|


| TEST(integer) YES ASUSER(userid)
GROUP( )
NO
|

Option descriptions

None of the following options are required.

SYSTEM
( subsystem-name )
Specifies the name of the DB2 subsystem.
( group-attachment-name )
Specifies the group attachment name of the data sharing group.

The default is SYSTEM( DSN ). This value can be modified during DB2
installation.
RETRY( integer )
Specifies the number (integer) of additional times connection to the DB2
subsystem should be attempted if DB2 is not up or the maximum number of
batch connections has been reached when DSN is issued. Retries occur at
30-second intervals.
The default is RETRY( 0 ). The maximum number of retries is 120.
TEST( integer )
Specifies the last two digits (integer) of the module name in order to trace a
single DSN module. Specify a number greater than 100 to trace all DSN
modules. DSN trace information messages are written to the TSO SYSTSPRT
DD statement, and optionally, to the DSNTRACE DD statement.
GROUP
( YES )
Specify to consider group attach processing when the specified system
is not active.
(NO) Specifies that group attach processing is not considered.
| ASUSER( userid )
| Specifies a user ID to associate with the trusted connection for the current DSN
| session.

258 Command Reference

| A trusted connection is established if the primary authorization ID and
| jobname matches a trusted context defined in DB2. The user ID that you
| specify as ASUSER goes through the standard authorization and connection
| exit processing to pick up the primary and secondary IDs. If the primary
| authorization ID is allowed to use the trusted connection without
| authentication, DB2 establishes the trusted connection for the ASUSER user ID.
| The primary authorization ID, any secondary authorization IDs, and any role
| associated with the ASUSER user ID are now in effect for the trusted
| connection.
| If the primary authorization ID associated with the user ID that you specify in
| the ASUSER option is not allowed to use the trusted connection or requires
| authentication information the connection request fails.
| DB2 retains the ASUSER value only for the life of the DSN session.

Usage notes

Beginning a DSN session: Issue the DSN command to begin a DSN session, which
allows you to enter DSN subcommands. The following rules govern the session:
v In foreground operation, you are prompted for input by the prompt string DSN
at the terminal. In background mode, your input is read from the SYSTSIN data
set.
v Except for delimited table names in the DCLGEN command, input in lowercase
letters is changed to uppercase.
v If duplicate keywords of any subcommand are specified, only the last of these
keywords is processed. For example, if both MEMBER( dbrm-member-name1 ) and
MEMBER( dbrm-member-name2 ) are specified with BIND PLAN, DB2 receives
only the latter, MEMBER( dbrm-member-name2 ).
v If ATTENTION (PA1) is pressed during a DSN session, and PROMPT is
specified in the TSO user profile, message DSNE005 appears: EXECUTION IS
INTERRUPTED, ENTER C TO CANCEL, OR ANY OTHER REPLY TO RESUME THE
subcommand SUBCOMMAND.
If you enter C, the current subcommand is canceled and the current DB2
connection terminates; a new one is established, and another DSN prompt
appears. Any other reply, except ATTENTION, causes the current subcommand
to continue from the point at which it was interrupted.
If a DSN session is started from a CLIST, or a CLIST is executed under DSN,
CONTROL PROMPT must be specified in the CLIST in order to receive message
DSNE005.
v After a command is processed during a DSN session, you are prompted for
input. That cycle continues until you end the session.
v You can end the session by doing one of the following:
– Issue the END subcommand. Control is passed to TSO.
– Press ATTENTION and respond to the message by pressing ATTENTION
again.
– Issue another DSN command. The old session ends and a new one begins.

DSN return code processing: At the end of a DSN session, register 15 contains the
highest value used by any DSN subcommand in the session or by any program
run using the RUN subcommand. Your run-time environment might format that
value as a return code. The value does not, however, originate in DSN.

Chapter 37. DSN (TSO) 259

| Establishing trusted context using TSO and DB2I: DB2I runs under TSO using
| ISPF services. The DB2I facility provides an ISPF front end for tools such as SPUFI
| and DCLGEN and tasks such as preparing DB2 programs and binding plans and
| packages. In Version 9, the DB2I Defaults Panel includes the field AS USER. Use
| the AS USER field to specify an authorization name to use for the current session
| that is associated with the trusted connection. The trusted connection is established
| when the TSO logon ID matches the system authorization ID and jobname defined
| for a trusted context. The ASUSER field is always blank on entry to DB2I. If you
| enter a value in the AS USER field it is passed to all TSO attach (DSN) calls by
| using the ASUSER option of the DSN (TSO) command.

Examples

Example 1: Start a DSN session. If the attempt to connect to DB2 fails, up to five
retries (at 30 second intervals) will be made.
DSN SYSTEM (DB2) RETRY (5)

Example 2: Start a DSN session, run a program, and then end the session and
return to TSO.
TSO prompt : READY
USER enters: DSN SYS (SSTR)
DSN prompt : DSN
USER enters: RUN PROGRAM (MYPROG)
DSN prompt : DSN
USER enters: END
TSO prompt : READY

260 Command Reference

Chapter 38. DSNC (CICS attachment facility)
The CICS attachment facility DSNC command allows you to enter DB2 commands
from CICS.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage note”
v “Example” on page 262

Environment

This command can be issued only from a CICS terminal.

Data sharing scope: Member

Authorization

This command requires the appropriate level of CICS authority.

Entering the DSNC command requires no privileges from DB2 security. For a
description of the privileges required to issue a DB2 command using the DSNC
command, see the command’s description.

Syntax

DSNC db2-command

destination

Option descriptions
destination
Identifies another terminal to receive display information. It must be a valid
terminal that is defined to CICS and supported by CICS basic mapping
support (BMS).
db2-command
Specifies the exact DB2 command that you want to enter from a CICS terminal.
It must be preceded by a hyphen.

Usage note

Screen scrolling: The CICS SIT table keyword SKRxxxx can be used to support the
scrolling of DSNC DB2 commands from your terminal.

© Copyright IBM Corp. 1983, 2009 261

 Example

Example: Issue the DB2 command DISPLAY THREAD from a CICS terminal.
DSNC -DISPLAY THREAD

262 Command Reference

Chapter 39. DSNC DISCONNECT (CICS attachment facility)
The CICS attachment facility command DSNC DISCONNECT disconnects threads.

The command provides manual control to release resources being shared by

normal transactions so that special purpose processes, such as utilities, can have
exclusive access to the resources.

Abbreviation: DSNC DISC

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option description”
v “Usage notes”
v “Example” on page 264

Environment

This command can be issued only from a CICS terminal.

Data sharing scope: Member

Authorization

This command requires an appropriate level of CICS authority.

Syntax

DSNC DISCONNECT plan-name


Option description
plan-name
Specifies a valid application plan.

Usage notes

Preventing creation of threads: The command DSNC DISCONNECT does not

prevent threads from being created on behalf of transactions. The command only
causes currently connected threads to be terminated as soon as they are not being
used by a transaction. To interrupt a transaction and cancel a thread faster, you can
use the DB2 command CANCEL THREAD.

You can stop the transactions associated with a particular plan ID in CICS with the
MAXACTIVE setting for TRANCLASS. This prevents new instances of the
transaction from causing a re-creation of a thread.

© Copyright IBM Corp. 1983, 2009 263

 Alternative for protected threads: You might want to deallocate a plan for
rebinding or for running a utility against the database. If you are using a protected
thread, use DSNC MODIFY rather than DSNC DISCONNECT. Modify the THRDA
value of the plan to zero to send all the threads to the pool. The protected thread
will terminate on its own within 60 seconds and DISCONNECT is unnecessary.

Example

Example: Disconnect active threads for PLAN1.

DSNC DISCONNECT PLAN1

264 Command Reference

Chapter 40. DSNC DISPLAY (CICS attachment facility)
The CICS attachment facility command DSNC DISPLAY displays information on
CICS transactions accessing DB2 data, or statistical information associated with
DB2ENTRYs and the DB2CONN.

Abbreviation: DSNC DISP

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage notes” on page 266
v “Output” on page 266
v “Examples” on page 268

Environment

This command can be issued only from a CICS terminal.

Data sharing scope: Member

Authorization

This command requires an appropriate level of CICS authority.

Syntax

DSNC DISPLAY PLAN


plan-name destination
TRANSACTION
transaction-id
STATISTICS

Option descriptions
PLAN plan-name
Displays information about transactions by plan name.
plan-name is a valid plan name for which information is displayed.
Default: If you do not specify plan-name (or if you specify an asterisk, *),
information is displayed for all active transactions.
TRANSACTION transaction-id
Displays information about transactions by transaction ID.
Abbreviation: TRAN

© Copyright IBM Corp. 1983, 2009 265

 transaction-id is a valid transaction ID for which information is displayed.
Default: If you do not specify a transaction ID, information is displayed for all
active transactions.
STATISTICS
Displays one line of the statistical counters that are associated with each
DB2ENTRY. The counters correspond to the usage of the available connections
of the CICS attachment facility to DB2.
Abbreviation: STAT
If you issue this command from CICS while the CICS attachment facility is
active but the DB2 subsystem is not, CICS produces a statistics display with no
obvious indication that the DB2 subsystem is not operational. Message
DFHDB2037 appears in the CICS message log to indicate that the attachment
facility is waiting for DB2 to start.
destination
Specifies the identifier of another terminal that is to receive the requested
display information. It must be a valid terminal that is defined to CICS and
supported by CICS basic mapping support (BMS).

Usage notes

Entering parameters: Because the optional destination is sometimes preceded by an

optional plan name or transaction ID in the command, each parameter must be
unique and separately identifiable as either a name or a terminal identifier. If only
one parameter is entered, it is first checked to see whether it is a plan name or a
transaction ID, and it is then checked as a destination. To use a character string
that is both a plan name or transaction ID and also a valid terminal identifier, you
must use both the name and destination parameters to display the desired
information at the desired terminal.

Acknowledging display information sent to an alternative destination: When an

alternative destination is specified to receive the requested display information, the
following message is sent to the requesting terminal:
DFHDB2032 THE DISPLAY COMMAND IS COMPLETE

Output

For each created thread, the output for the DSNC DISPLAY (PLAN or
TRANSACTION) command, as seen in Example 2, displays the following
information:
DB2ENTRY
The name of the DB2ENTRY, *POOL for the pool, or *COMMAND for
DSNC command calls.
S The status field. A status of A indicates the thread is active within a unit of
work. A status of I indicates that a protected thread is waiting for work.
PLAN The plan that is associated with the thread. Command threads have no
plan.
PRI –AUTH
The primary authorization ID for the thread.
SEC –AUTH
The secondary authorization ID (if any) for the thread.

266 Command Reference

CORRELATION
The 12-byte thread correlation ID in the form of eeeettttnnnn, where eeee is
either COMD, POOL, or ENTR, indicating a command, pool, or
DB2ENTRY thread; tttt is the transaction ID; nnnn is a unique number.

If the thread is active within a unit of work, its CICS transaction name (TRAN),
task number (TASK), and CICS local unit of work ID (UOW-ID) are also displayed.

The output of a DSNC DISPLAY STATISTICS command, as seen in Example 4,

displays the following information:
DB2ENTRY
The name of the DB2ENTRY, *COMMAND for DSNC command calls, or
*POOL for pool statistics.
PLAN The plan name that is associated with this entry. Eight asterisks in this
field indicate that this transaction is using dynamic plan allocation. The
command processor transaction DSNC does not have a plan associated
with it because it uses a command processor.
CALLS
The total number of SQL statements that are issued by transactions that are
associated with this entry.
AUTHS
The total number of sign-on invocations for transactions associated with
this entry. A sign-on does not indicate whether a new thread is created or
an existing thread is reused. If the thread is reused, a sign-on occurs only if
the authorization ID or transaction ID has changed.
W/P The number of times that all available threads for this entry were busy.
This value depends on the value of THREADWAIT for the entry.
An overflow to the pool is displayed in the transaction statistics only and
is not reflected in the pool statistics.
If THREADWAIT is set to YES, the output reflects the number of times that
the thread had to wait. If the number of started tasks has reached
THREADLIMIT, the output also reflects the number of times the thread
could not attach a new subtask.
The only time W/P is updated for the pool is when a transaction had to
wait for a pool thread and a new subtask could not be attached for the
pool. The W/P statistic is useful for determining if a sufficient number of
threads are defined for the entry.
HIGH The maximum number of threads that are required by transactions that are
associated with this entry at any time since the connection was started. It
provides a basis for setting the maximum number of threads for the entry.
For releases of CICS Transaction Server before release 1.2, this number
includes the transactions that were forced to wait or diverted to the pool.
For release 1.2 or later, the HIGH keyword is associated only with the
threads that are actually created on the entry.
ABORTS
The total number of units of recovery that were rolled back. It includes
both abends and SYNCPOINT ROLLBACKS, including SYNCPOINT
ROLLBACKS generated by -911 SQL codes.
COMMITS
One of the following two fields increments each time a DB2 transaction

Chapter 40. DSNC DISPLAY (CICS attachment facility) 267

 that is associated with this entry has a real or implied (such as EOT)
syncpoint. Units of recovery that do not process SQL calls are not reflected
here.
1-PHASE
The total number of single phase commits for transactions that are
associated with this entry. This total does not include any two-phase
commits (see the explanation for 2-PHASE). This total does include
read-only commits and single-phase commits for units of recovery that
have performed updates. A two-phase commit is needed only when CICS
is the recovery coordinator for more than one resource manager.
2-PHASE
The total number of two-phase commits for transactions that are associated
with this entry. This number does not include one-phase commit
transactions.

Examples

Example 1: This command displays information about all active threads. The
display information is to be sent to another terminal designated as MTO2.
DSNC DISP PLAN * MTO2

Example 2: This example shows the output for the DSNC DISPLAY (PLAN or
TRANSACTION) command.
DFHDB2013 07/09/98 15:26:47 IYK4Z2G1 DISPLAY REPORT FOLLOWS FOR THREADS
ACCESSING DB2 DB3A

DB2ENTRY S PLAN PRI-AUTH SEC-AUTH CORRELATION TRAN TASK UOW-ID

*POOL A TESTC05 JTILLI1 POOLXC050001 XC05 01208 AEEEC03-1ACDCE00
XC06 A TESTC06 JTILLI1 ENTRXC060003 XC06 01215 AEEEC04-2F8EFE01
XP05 A TESTP05 JTILLI1 ENTRXP050002 XP05 01209 AEEEC03-35230C00
XP05 I TESTP05 JTILLI1 ENTRXP050004
DFHDB2020 07/09/98 15:26:47 IYK4Z2G1 THE DISPLAY COMMAND IS COMPLETE.

Example 3: This command displays statistical counters that are associated with
DB2ENTRY.
DSNC DISP STAT

Example 4: This example shows the output for the DSNC DISPLAY STATISTICS
command:
DFHDB2014 07/09/98 14:35:45 IYK4Z2G1 STATISTICS REPORT FOLLOWS
-----COMMITS-----
DB2ENTRY PLAN CALLS AUTHS W/P HIGH ABORTS 1-PHASE 2-PHASE
*COMMAND 1 1 1 1 0 0 0
*POOL POOL 0 0 0 0 0 0 0
XC01 DSNXC01 22 1 11 2 0 7 5
XC02 DSNXC02 0 0 0 0 0 0 0
XA81 DSNA81 0 0 0 0 0 0 0
XCD4 DSNCED4 0 0 0 0 0 0 0
XP03 DSNTP03 1 1 0 1 0 1 0
XA20 DSNTA20 1 1 0 1 0 0 1
XA88 ******** 0 0 0 0 0 0 0
DFHDB2020 07/09/98 15:45:27 IYKA4z2G1 THE DISPLAY COMMAND IS COMPLETE

268 Command Reference

Chapter 41. DSNC MODIFY (CICS attachment facility)
The CICS attachment facility command DSNC MODIFY modifies the message
queue destination of the DB2CONN, or modifies the maximum active thread value
for the pool, for DSNC commands, or for DB2ENTRY.

Abbreviation: DSNC MODI

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage notes” on page 270
v “Examples” on page 270

Environment

This command can be issued only from a CICS terminal.

Data sharing scope: Member

Authorization

This command requires an appropriate level of CICS authority.

Syntax

DSNC MODIFY DESTINATION old new


TRANSACTION transaction-id integer

Option descriptions
DESTINATION
Specifies that the MSGQUEUE parameter of the DB2CONN is to be changed,
replacing the old destination ID with the new destination ID.
Abbreviation: DEST
old
Specifies any destination ID that is currently active in the MSGQUEUE of
the DB2CONN.
new
Specifies a new destination identifier. CICS verifies the new destination to
ensure that it is an existing transient data entry in the destination control
table.

© Copyright IBM Corp. 1983, 2009 269

 TRANSACTION
Specifies that the maximum active thread value that is associated with the
specified transaction or group is to be modified.
Abbreviation: TRAN
transaction-id
Specifies a valid transaction identifier.
To change the maximum active thread value, use one of the following
transaction IDs:
v For the pool: CEPL
v For command threads: DSNC
v For DB2ENTRY: the ID of any transaction that is defined to use
DB2ENTRY
integer
Specifies a new maximum value.

Usage notes

Protected threads: If you increase the active thread value by using the command
DSNC MODIFY TRANSACTION, the attributes of the DB2ENTRY are used.

Issuing DSNC MODIFY TRANSACTION to increase the total number of threads

that are permitted allows creation of unprotected threads. For example, assume
PROTECTNUM(2) and THREADLIM(2). If the total number of permitted threads
increases, the additional threads are unprotected.

The command DSNC MODIFY TRANSACTION can also allow creation of

protected threads. If PROTECTNUM(2) and THREADLIM(2) and you modify the
thread limit to 1, one of the protected threads is eliminated. If the thread limit is
then modified back to 2, the thread that is re-created is protected.

TRANSACTION thread limit: The lowest possible value is zero.

Examples

Example 1: Change the specification of the MSGQUEUE parameter in the

DB2CONN from MTO1 to MTO2.
DSNC MODIFY DESTINATION MTO1 MTO2

Example 2: Change the pool thread limit to 12.

DSNC MODIFY TRANSACTION CEPL 12

Example 3: Change the command thread limit to 3.

DSNC MODIFY TRANSACTION DSNC 3

Example 4: Change the thread limit of the DB2ENTRY that is used by the
transaction XP05 to 8.
DSNC MODIFY TRANSACTION XP05 8

270 Command Reference

Chapter 42. DSNC STOP (CICS attachment facility)
The CICS attachment facility command DSNC STOP stops the attachment facility.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage notes”
v “Example” on page 272

Environment

This command can be issued only from a CICS terminal.

Data sharing scope: Member

Authorization

This command requires an appropriate level of CICS authority.

Syntax

QUIESCE


DSNC STOP FORCE


Option descriptions
QUIESCE
Specifies that the CICS attachment facility is to be stopped after CICS
transactions that are currently running terminate.
Abbreviation: Q
FORCE
Specifies that the CICS attachment facility is to be stopped immediately by
forcing disconnection with DB2, regardless of any transactions that are
running.

Usage notes

Requirements for restarting: Using FORCE can leave threads in an indoubt

situation. Restarting requires reconnection of CICS and DB2 to resolve any indoubt
situations. In a data sharing environment, resolution of indoubt situations requires
that the CICS be reconnected to the same DB2 member.

Output destinations: Output from the command DSNC STOP is sent to the
requesting terminal, which remains locked until shutdown is complete.

© Copyright IBM Corp. 1983, 2009 271

 Example

Example: Stop the CICS attachment facility.

DSNC STOP FORCE

272 Command Reference

Chapter 43. DSNC STRT (CICS attachment facility)
The DSNC STRT command starts the CICS attachment facility, which allows CICS
application programs to access DB2 databases.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option description”
v “Usage note”
v “Examples”

Environment

This command can be issued only from a CICS terminal.

Data sharing scope: Member

Authorization

This command requires an appropriate level of CICS authority.

Syntax

DSNC STRT

ssid

Option description
ssid
Specifies the subsystem ID (SSID) that is to override the ID that is specified in
the CICS DB2CONN.
Default: The DB2ID that is specified in the last installed DB2CONN. If the
DB2CONN contains a blank DB2ID, the default is the SSID that is specified in
the CICS INTIPARM parameter.

Usage note

Output destinations: Output from the DSNC START command is sent to the
requesting terminal. If no DB2CONN is installed when you issue DSNC STRT,
error message DFHDB2031 is sent to the terminal.

Examples

Example 1: Start the CICS attachment facility.

DSNC STRT

© Copyright IBM Corp. 1983, 2009 273

 Example 2: Start the CICS attachment facility. Override the SSID that is specified in
the DB2CONN with DB2P.
DSNC STRT DB2P

Example 3: Start the CICS attachment facility. Use SSID DBA1.

DSNC STRT DBA1

274 Command Reference

Chapter 44. DSNH (TSO CLIST)
The DSNH command procedure (a TSO CLIST) is a powerful yet easy method of
preparing an application program for execution.

The DSNH command procedure (a TSO CLIST) prepares a program for execution,
and executes it if it runs under TSO. By issuing a single command, you can select
numerous options required for the preparation of an application and execute it
under TSO.

DSNH processing is a sequential process that can include any of the actions listed
in the following table.

Individual steps or a sequence of steps can be performed, and you can end the
process at any point you choose. Any steps in the process that are skipped must
have previously been completed successfully by DSNH.
Table 16. DSNH actions and the corresponding step names
For invoking the... Use step name
PL/I macro processor MP
DB2 precompiler PC
CICS command language translator TR
DSN BIND PLAN subcommand for binding a plan BI
DSN BIND PACKAGE subcommand for binding a package BP
Compiler or assembler for your program CO
A C compiler prelink utility for including compile-time parameters PL
Link-editor to produce an executable load module LE
DSN RUN subcommand to execute the program RU
Note: The step names are used in the heading of Table 18 on page 277.

Subsections:
v “Environment”
v “Authorization” on page 276
v “Syntax” on page 276
v “Usage notes” on page 299
v “Examples” on page 300

Environment

The DSNH CLIST can run in TSO foreground or in batch under the TSO terminal
monitor program. DB2I uses the DSNH CLIST on the precompiler panel to control
program preparation. You can pass DSNH parameters from DB2I panels on the
″Other options″ lines.

Data sharing scope: Member

© Copyright IBM Corp. 1983, 2009 275

 Authorization

See the appropriate description for information about the privileges necessary to
bind a package.

See the appropriate description for information about the privileges necessary to
bind a plan.

See the appropriate description for information about the privileges necessary to
run a plan.

Syntax

DSNH INPUT(data-set-name)


 clist-parameter

Summary of DSNH CLIST parameters

The CLIST parameters provide the processing options for each step; specify them
when you execute DSNH. Some parameters are used for more than one step, as
indicated in Table 18 on page 277. This table shows where each parameter is used,
using the following notation:
v Y in any cell shows that the option listed at the beginning of the row is used in
the step whose name appears at the top of the column.
v * in any cell indicates that the option listed at the beginning of the row is used
in another step which affects the step whose name appears at the top of the
column.

Notation of CLIST parameters for the BIND PLAN and BIND PACKAGE steps:
Many parameters of BIND PLAN and of BIND PACKAGE provide the same
function and are spelled alike. CLIST parameters for BIND PLAN and BIND
PACKAGE are differentiated from general parameters and from each other by
prefixes. A parameter name prefixed by the letter B applies to the BIND PLAN
subcommand; a parameter name prefixed by the letter P applies to BIND
PACKAGE. The following table shows the possible variations for a single
parameter name.
Table 17. DSNH CLIST prefixing rules
Parameter value Function or subcommand Example
parameter If no prefix is specified, the parameter applies to DBRMLIB
a single function or subcommand.
B/parameter The prefix B is used to indicate that this B/DBRMLIB
variation of the parameter applies only to the
BIND PLAN step.
P/parameter The prefix P is used to indicate that this P/DBRMLIB
variation of the parameter applies only to the
BIND PACKAGE step.

276 Command Reference

In the following table, a prefix is separated from the DB2 parameter name by a
slash (/). Refer to Table 16 on page 275 for an explanation of the two-letter step
names.
Table 18. Summary of DSNH CLIST parameters
OPTIONS MP PC TR BI BP CO PL LE RU
ACQUIRE Y *
P/ACTION Y Y
ASMLIB Y
ASMLOAD Y
P/BDMEM Y Y
P/BIND Y Y
P/BLIB Y
P/BnLIB Y
P/BMEM Y Y
CACHESIZE Y
CCLINK Y
CCLLIB Y
CCLOAD Y
CCMSGS Y Y
CCOLIB Y
CCPLIB Y
CCPMSGS Y
CCSID Y
CCSLIB Y
P/CICS Y Y
CICSCOB Y Y
CICSLLIB Y Y
CICSOPT Y
CICSPRE Y Y
CICSPLIB Y Y
CICSVER Y Y
CICSXLAT Y
CLIB Y Y
CnLIB Y Y
COBICOMP Y
COBILINK Y
COBIPLNK Y
COBIPMSG Y
COBLIB Y
COBLOAD Y
COBSOM Y
COB2CICS Y

Chapter 44. DSNH (TSO CLIST) 277

 Table 18. Summary of DSNH CLIST parameters (continued)
OPTIONS MP PC TR BI BP CO PL LE RU
COB2LIB Y
COB2LOAD Y
COMPILE Y
CONNECT Y
CONTROL Y Y * Y Y Y
COPTION Y Y
COPY Y
COPYVER Y
CPPCLASS Y
CPPCLINK Y
CPPCLLIB Y
CPPCSLIB Y
CPPLLIB Y
CPPPMSGS Y
CPPSLIB Y
CPPUTIL Y
CURRENTDATA Y Y
CURRENTSERVER Y
DATE Y
P/DBPROTOCOL Y Y
P/B/DBRMLIB Y Y Y
DECARTH Y
DECIMAL Y *
P/DEFER Y Y
P/DEGREE Y Y
DELIMIT Y Y Y
P/DISABLE Y Y
DISCONNECT Y -
P/DLIBATCH Y Y
P/DYNAMICRULES Y Y
P/ENABLE Y Y
ENTRY Y
EXPLAIN Y Y
P/FLAG Y Y Y Y Y Y
FORTLIB Y
FORTLOAD Y
GRAPHIC Y
HOST Y Y Y * Y Y Y
P/IMSBMP Y Y
P/IMSMPP Y Y

278 Command Reference

Table 18. Summary of DSNH CLIST parameters (continued)
OPTIONS MP PC TR BI BP CO PL LE RU
IMSPRE Y
INPUT Y Y * * Y Y Y
P/ISOLATION Y Y
P/KEEPDYNAMIC Y Y
LINECOUNT Y Y Y Y
LINK Y
LLIB Y
LnLIB Y
LOAD Y Y
LOPTION Y
MACRO Y Y
NEWFUN Y
NOFOR Y
P/NODEFER Y Y
P/OPTHINT Y Y
OPTIONS Y Y Y Y
OUTNAME Y Y Y Y Y
P/OWNER Y Y
PACKAGE Y
PARMS Y
PASS Y
P/PATH Y Y
PCLOAD Y
PKLIST Y
PLAN Y Y
PLIB Y
PnLIB Y
PLI2LIB Y
PLILIB Y
PLILOAD Y Y
PLIPLNK Y
PLIPMSG Y
POPTION Y
PRECOMP Y
PRELINK Y
PRINT Y Y Y Y Y
PSECSPAC Y Y Y Y Y
PSPACE Y Y Y Y Y
P/QUALIFIER Y Y
RCTERM Y Y Y Y Y Y Y Y

Chapter 44. DSNH (TSO CLIST) 279

 Table 18. Summary of DSNH CLIST parameters (continued)
OPTIONS MP PC TR BI BP CO PL LE RU
P/RELEASE Y Y
REMOTE Y
P/REOPT Y Y
REPLVER Y
RETAIN Y
RUN Y Y Y Y
RUNIN Y
RUNOUT Y
SOMDLLI Y Y
SOURCE Y Y Y Y
SPACEUN Y Y Y Y Y
SQL Y
SQLDELIM Y
SQLERROR Y
SQLRULES Y
STDSQL Y
SUFFIX Y Y
SYSTEM * * Y
TERM Y Y Y Y
TIME Y
P/VALIDATE Y Y
VERSION Y
WORKUNIT Y Y Y Y
WSECSPAC Y Y Y Y
WSPACE Y Y Y Y
XLIB Y
XREF Y Y Y Y

General parameter descriptions

Due to similarities in name and function, the CLIST parameters for BIND PLAN
and BIND PACKAGE are described separately from the parameters in Table 19 on
page 281. For a summary of:
v BIND PLAN parameters, refer to Table 20 on page 294
v BIND PACKAGE parameters, refer to Table 21 on page 297

The only parameter that is required on the DSNH statement is INPUT; the others
are optional. In Table 19 on page 281:
v Parameter values must be enclosed between parentheses.
v Parameter values need not be enclosed between apostrophes, except in either of
the following cases:

280 Command Reference

 – If the value is a list of tokens with separators, the value must be enclosed
between apostrophes.
– If the value is a data set name, your user identifier is added as a prefix. To
avoid the prefix, enclose the data set name between sets of three apostrophes.
v Most parameter values that are data set names (dsname) cannot include member
names. Exceptions are noted in the parameter descriptions.
v Underlined values are defaults. Default names can be changed to names specific
to your site when DB2 is installed.
Table 19. General DSNH CLIST parameters
Parameter Value Comments
ASMLIB dsname Specifies a data set to be used as the standard MACLIB for High Level
Assembler.

The default is ’’’SYS1.MACLIB’’’.

ASMLOAD dsname Specifies a data set that contains the High Level Assembler load module.

dsname can include a member name.

The default is ’’’SYS1.LINKLIB(ASMA90)’’’.

CCLINK dsname Specifies a data set that contains the IBM Language Environment® prelink
editor utility invocation load module that is to be used for preparing C
programs.

dsname can include a member name.

The default is ’’’CEE.SCEERUN(EDCPRLK)’’’.

CCLLIB dsname Specifies a data set that contains the linkage editor include modules for the
C compiler routines.

The default is ’’’CEE.SCEELKED’’’.

CCLOAD dsname Specifies a data set that contains the C compiler invocation load module.

dsname can include a member name.

The default is ’’’CBC.SCCNCMP(CCNDRVR)’’’.

CCMSGS dsname Specifies a data set that contains the C compiler messages. This data set is
required only for C/370.

dsname can include a member name.

The default is ’’’EDC.V1R2M0.SEDCDMSG(EDCMSGE)’’’.

CCSID integer
Specifies the CCSID for source SQL statements as the integer.
CCOLIB Specifies that the data set that contains C object modules is included during
NONE the execution of the prelink utility step.

dsname
CCPLIB NONE Specifies a data set that contains include modules for PL/I routines. This
dsname parameter is used only for IBM C/370 Version 2 or earlier.
CCPMSGS dsname Specifies a data set that contains the message library that is to be used by
the IBM prelink editor when preparing C programs.

The default is ’’’CEE.SCEEMSGP(EDCPMSGE)’’’.

CCSLIB dsname Specifies a data set that contains the C compiler headers.

The default is ’’’CEE.SCEEH.H’’’.

Chapter 44. DSNH (TSO CLIST) 281

Table 19. General DSNH CLIST parameters (continued)
Parameter Value Comments
CICSOPT NONE Specifies a list of additional CICS translator options. See the appropriate
option-list CICS application programming reference for information about translator
options.

The default, NONE, specifies no additional options.

CICSPRE prefix Specifies the prefix for the CICS libraries. The library names are:
prefix.LOADLIB for translators
prefix.PL1LIBn for PL/I include
prefix.COBLIB for COBOL include

Leave this parameter blank to use CICSLLIB, CICSPLIB, CICSCOB.

The default is blank.

CICSLLIB dsname Specifies the CICS load library. To use this library, leave the CICSPRE
parameter blank.

The default is set on installation panel DSNTIP3.

CICSPLIB dsname Specifies the CICS PL/I library. To use this library, leave the CICSPRE
parameter blank.

The default is set on installation panel DSNTIP3.

CICSCOB dsname Specifies the CICS COBOL library. To use this library, leave the CICSPRE
parameter blank.

The default is set on installation panel DSNTIP3.

CICSVER 21
31 Specifies the CICS release. This field is ignored because current releases of
33 CICS do not require DSNH to handle release-specific considerations.
41
CICSXLAT NO Specifies whether to execute the CICS command translator. This parameter
YES is effective only if you use RUN(CICS). You cannot use this parameter with
the MARGINS option of the translator.

The default is YES. The DB2I panel default is NO.

CLIB C nLIB NONE Specifies a data set that contains host language source statements to be
dsname included by the compiler or assembler. The parameters C n LIB (where n
can be 2, 3, or 4) are extensions of CLIB, which is used to simplify passing
a list of data set names.

Use the default, NONE, to specify no data set.

COBICOMP dsname Specifies the IBM COBOL data set that is required for compilation.

The default is ’’’IGY.SIGYCOMP’’’.

COBILINK dsname Specifies the IBM COBOL data set that is required for link edit.

The default is ’’’CEE.SCEELKED’’’.

COBIPLNK dsname
Specifies a data set that contains the IBM Environment prelink editor utility
invocation load module that is to be used for preparing COBOL programs.

dsname can include a member name.

The default is ’’’CEE.SCEERUN(EDCPRLK)’’’.

282 Command Reference

Table 19. General DSNH CLIST parameters (continued)
Parameter Value Comments
COBIPMSG dsname
Specifies a data set that contains the message library that is to be used by
the IBM prelink editor when preparing COBOL programs.

dsname can include a member name.

The default is ’’’CEE.SCEEMSGP(EDCPMSGE)’’’.

COBLIB dsname Specifies the linkage editor include library that is to be used for OS/VS
COBOL routines.

This parameter is obsolete.

COBLOAD dsname Specifies a data set that contains the OS/VS COBOL compiler load module.

This parameter is obsolete.

COBSOM dsname Specifies the IBM System Object Model® (SOM®) data set that is required
for access to SOM objects.

This parameter is obsolete.

COB2CICS dsname Specifies the linkage editor include library that is to be used for VS COBOL
II CICS routines.

This parameter is obsolete.

COB2LIB dsname Specifies the linkage editor include library that is to be used for the VS
COBOL II or COBOL/370 routines.

This parameter is obsolete.

COB2LOAD dsname Specifies a data set that contains the VS COBOL II or COBOL/370 compiler
load module.

This parameter is obsolete.

COMPILE YES Specifies whether to execute the compiler or assembler if the precompile
NO step is successful.
CONNECT (1) Specifies whether a CONNECT SQL statement should be processed as a
(2) type 1 CONNECT or a type 2 CONNECT statement. The DSNH(TSO
CLIST) command does not accept the CT(1) and CT(2) abbreviations for this
precompiler option.

The default is CONNECT(2).

CONTROL NONE Specify to help you trace the allocation of non-existent data sets. Use this
CONLIST parameter if you have a problem without an obvious cause.
LIST
SYMLIST CONLIST displays CLIST commands after substitution for symbols and
before command execution.

LIST displays TSO commands after substitution for symbols and before
command execution.

SYMLIST displays all executable statements (TSO commands and CLIST

statements) before substitution for symbols.
COPTION NONE Specifies a list of compiler or assembler options. For more information, refer
string to the manual that describes the compiler or assembler options for the
specific language you are using. For a list of restrictions on some options,
see COBOL Options.

NONE specifies no options.

Chapter 44. DSNH (TSO CLIST) 283

Table 19. General DSNH CLIST parameters (continued)
Parameter Value Comments
CPPCLASS dsname Specifies the data set that contains C++ class libraries.

The default is ’’’CBC.SCLBCPP’’’.

CPPCLINK dsname
Specifies the data set that contains the IBM Language Environment prelink
editor utility invocation load module that is to be used for preparing C
programs.

The default is ’’’CEE.SCEERUN(EDCPRLK)’’’.

CPPCLLIB dsname Specifies the data set for the C linkage editor automatic call library that is
used by the C++ compiler.

The default is ’’’CEE.SCEELKED’’’.

CPPCSLIB dsname Specifies a data set that contains the C compiler headers that are used by
the C++ compiler.

The default is ’’’CEE.SCEEH.H’’’.

CPPLLIB dsname Specifies a data set that contains the C++ prelink automatic call library.

The default is ’’’CEE.SCEECPP’’’.

CPPPMSGS dsname
Specifies the data set that contains the message library that is to be used by
the IBM prelink editor when preparing C++ programs.

dsname can include a member name.

The default is ’’’CEE.SCEEMSGP(EDCPMSGE)’’’.

CPPSLIB dsname Specifies the data set that contains C++ header files for class libraries.

The default is ’’’CBC.SCLBH.HPP’’’.

CPPUTIL dsname Specifies the data set that contains procedures to set up and execute the
C++ compiler.

The default is ’’’CBC.SCCNUTL’’’.

DATE ISO Specifies the format of date values that are to be returned, which overrides
JIS the format that is specified as the location default.
USA
EUR The default is the value that is supplied when DB2 is installed, and is
LOCAL written in the data-only load module, DSNHDECP.

284 Command Reference

Table 19. General DSNH CLIST parameters (continued)
Parameter Value Comments
DBRMLIB DEFAULT Specifies the partitioned data set, and an optional member name, that
dsname(member) contains the DBRM library and member name that is used during the DB2
NONE precompile step. Because you can specify individual DBRM member and
library names during each individual phase, you must use the DBRMLIB
parameter and associated prefixes to identify a specific phase.

DBRMLIB specifies the DBRM library and member that is defined on the
DBRMLIB DD statement during DB2 precompiler processing.

DEFAULT indicates that the same DBRM library data set that is defined for
the DB2 precompiler process (DBRMLIB(parameter)) is also used on the
LIBRARY(dsname) subcommand keyword. If the precompiler DBRMLIB is
not specified, the default generated DBRMLIB library that is based on the
INPUT data set name is used.

dsname is generated using the DSNH OUTNAME parameter value, or its

default, TEMP, with the constant DBRM appended to the prefix; for
example, outname .DBRM or TEMP.DBRM.

member is obtained from the data set member name that is specified on the
DSNH INPUT parameter or from the data set name as follows:
v Given INPUT(outname.DBRM(dbrmmem)):
– outname.DBRM(dbrmmem) - If the member name is specified
– outname.DBRM(dbrm) - If no member name is specified

NONE indicates that no LIBRARY(dsname) subcommand keyword is

specified on invocation.
DECARTH DEFAULT Specifies the maximum precision of decimal numbers.
15
31 DEFAULT designates the value chosen, during installation, for the
DECIMAL ARITHMETIC field on the APPLICATION PROGRAMMING
DEFAULTS panel.

A value of 15 specifies that decimal arithmetic operations on decimal values

with precision 15 or less are performed in accordance with the existing
rules for determining the precision and scale of the result.

A value of 31 specifies that decimal arithmetic operations on decimal values

with precision 15 to 31 are performed in accordance with new rules for
determining the precision and scale of the result.

DECARTH is ignored for Fortran.

DECIMAL COMMA Specifies the decimal point indicator for decimal and floating point literals.
PERIOD DECIMAL is valid only for COBOL programs; PERIOD is forced for all
other programs.

COMMA makes the indicator a comma.

PERIOD makes the indicator a period.

The default is the value of the DECIMAL POINT field, set on the DB2
APPLICATION PROGRAMMING DEFAULTS panel during installation.

Chapter 44. DSNH (TSO CLIST) 285

Table 19. General DSNH CLIST parameters (continued)
Parameter Value Comments
DELIMIT DEFAULT Specifies the APOST or QUOTE precompiler option to indicate the string
APOST delimiter that is used within host language statements. DELIMIT is effective
QUOTE only for COBOL programs; APOST is forced for all other programs.

DEFAULT designates the value chosen during installation for the STRING
DELIMITER field on the APPLICATION PROGRAMMING DEFAULTS
panel.

APOST specifies the apostrophe as the string delimiter for host language
statements.

QUOTE specifies a quotation mark as the string delimiter for host language
statements.
ENTRY entry-name Specifies the entry point that is assigned by the linkage editor.

The default depends on the host language and the value of RUN.
v For the PL/I language, the ENTRY value default is:
– NONE if the RUN value is CICS
– PLISTART for any other RUN value.
v For assembler language, the ENTRY value default is DLITASM if the
RUN value is IMS.
v For COBOL, the ENTRY value default is DLITCBL if the RUN value is
IMS.
v For any other language, the ENTRY value default is NONE (no specified
entry point) for any RUN value.
FLAG I Specifies the messages that you want to see. Use one of the following
C values to show messages of the corresponding types:
E I All informational, warning, error, and completion messages
W W Only warning, error, and completion messages
E Only error and completion messages
C Only completion messages
FORTLIB dsname Specifies the linkage editor include library that is to be used for Fortran
routines.

The default is ’’’SYS1.VSF2FORT’’’.

FORTLOAD dsname Specifies a data set that contains the VS Fortran compiler load module.

dsname can include a member name.

The default is ’’’SYS1.VSF2VCOMP(FORTVS2)’’’.

GRAPHIC NONE Specifies the value of the DSNHDECP MIXED option for the precompiler.
NO
YES NONE indicates that the default specified during installation is used.

NO indicates that the data is not mixed DBCS.

YES indicates that all character data can be mixed DBCS.

GRAPHIC is ignored for C.

286 Command Reference

Table 19. General DSNH CLIST parameters (continued)
Parameter Value Comments
HOST ASM Defines the host language within which SQL statements are embedded.
C
CPP COBOL and COB2 are also acceptable values but are obsolete.
IBMCOB
FORTRAN If your program is one of the following types of programs, you cannot use
PLI DB2I to prepare it:
v A COBOL program that uses object-oriented extensions
v A C++ program that uses object-oriented extensions and consists of more
than one compilation unit

The default is the value of the LANGUAGE DEFAULT field, set on the DB2
APPLICATION PROGRAMMING DEFAULTS panel during installation.
IMSPRE prefix Specifies the prefix for RESLIB, which is used for routines that are to be
included by the linkage editor for IMS.

The default is IMSVS.

INPUT dsname Specifies the data set that contains the host language source and SQL
statements.

dsname can include a member name.

LINECOUNT integer Specifies how many lines, including headings, are to be printed on each
page of printed output.

The default is 60.

LINK YES Specifies whether to execute the linkage editor after successful completion
NO of compilation or assembly.

YES indicates that the linkage editor is to be executed. The DSNHLI entry
point from the precompiler is directed to the appropriate language interface
module that is specified by the RUN parameter.

NO indicates that linkage editor processing is to be bypassed.

LLIB LnLIB NONE Specifies a data set that contains object or load modules that are to be
dsname included by the linkage editor. The parameters L n LIB (where n can be 2,
3, or 4) are extensions of LLIB, which is used to simplify passing a list of
data set names.

The LLIB and LnLIB libraries are concatenated with the XLIB library and
the linkage editor include libraries for the specific host language. Object
and load module libraries must not be mixed in this concatenation.

Use the default, NONE, to specify no data set.

LOAD dsname Specifies a data set that is to contain the output from the linkage editor (the
load module).

dsname can include a member name.

The default is RUNLIB.LOAD.

LOPTION NONE Specifies a list of linkage editor options. For information about the options
string you can use, see the appropriate z/OS publication.

Use the default, NONE, to give no options.

Chapter 44. DSNH (TSO CLIST) 287

 Table 19. General DSNH CLIST parameters (continued)
Parameter Value Comments
MACRO YES Specifies whether the macro preprocessor is to be executed before the
NO precompilation of a PL/I program. If the PL/I macro processor is used, the
PL/I *PROCESS statement must not be used to pass options to the PL/I
compiler. The COPTION parameter of the DSNH command can be used to
pass the needed options to the PL/I compiler.
| NEWFUN NO Specifies whether to allow syntax for functions that DB2Version 9.1
| YES introduces.
NOFOR NO Specifies whether all FOR UPDATE OF clauses in static SQL statements are
YES optional.

When you specify NOFOR(YES), the FOR UPDATE OF clause is optional.

Positioned updates can be made to any columns that the user has authority
to update.

When you specify NOFOR(NO), any query that appears in a DECLARE

CURSOR statement must contain a FOR UPDATE OF clause if the cursor is
used for positional updates. The clause must designate all the columns that
the cursor can update.

The option is implied when the STDSQL(YES) option is in effect.

OPTIONS NO Specifies whether to print the options that are used when executing the
YES precompiler or the CICS command translator with the output listing.
OUTNAME TEMP Specifies the prefix that is used to form intermediate data set names.
string
string must not be enclosed between apostrophes and must not have the
same initial character as the dsname for INPUT. It cannot contain special
characters.
PARMS NONE Specifies a parameter string that is to be passed to the compiled program
string during its execution. This parameter is valid only if the run-time execution
environment requested is TSO. If CAF is specified as the run-time execution
environment, this parameter is ignored.

Use the default, NONE, to pass no parameter string.

PASS ONE or 1 Specifies how many passes the precompiler is to use. One pass saves
TWO or 2 processing time, but requires that declarations of host variables in the
program precede any reference to those variables. PASS has no effect for
COBOL or Fortran; ONE is forced.

The default is ONE or 1 for PL/I and C.

The default is TWO or 2 for assembler.

PCLOAD dsname Specifies the precompiler load module.

dsname can include a member name.

The default is ’*(DSNHPC)’.

PLAN plan-name Specifies the application plan that is created by the bind process.

The default plan name is the first of the following available choices defined
in the INPUT data set:
v DBRM member name
v Leftmost qualifier

plan-name must not be DEFAULT.

If no name is found, a plan is not created.

288 Command Reference

Table 19. General DSNH CLIST parameters (continued)
Parameter Value Comments
PLIB PnLIB NONE Specifies the data set that contains host language source or SQL statements
dsname included by the SQL INCLUDE statement during precompilation. The
parameters PnLIB (where n can be 2, 3, or 4) are extensions of PLIB, which
is used to simplify passing a list of data set names.

Use NONE to specify no data set.

PLI2LIB dsname Specifies the linkage editor common library that is used for PL/I routines.

This parameter is obsolete.

PLILIB dsname Specifies the linkage editor base library that is used for PL/I routines.

The default is ’’’CEE.SCEELKED’’’.

PLILOAD dsname Specifies a data set that contains the PL/I compiler load module.

dsname can include a member name.

The default is ’’’IBM.SIBMZCMP(IBMZPLI)’’’.

PLIPLNK dsname
Specifies the data set that contains the IBM Environment prelink editor
utility invocation load module that is to be used for preparing PL/I
programs.

dsname can include a member name.

The default is ’’’CEE.SCEERUN(EDCPRLK)’’’.

PLIPMSG dsname
Specifies the data set that contains the message library that is to be used by
the IBM prelink editor for preparing PL/I programs.

dsname can include a member name.

The default is ’’’CEE.SCEEMSGP(EDCPMSGE)’’’.

POPTION NONE Specifies a list of the C compiler language prelink utility options
string
Use the default, NONE, to give no options.
PRECOMP YES Specifies whether to precompile.
NO
PRELINK YES Specifies whether to execute the C compiler prelink utility to make your
NO program reentrant. This utility concatenates compile-time initialization
information (for writable static) from one or more text decks into a single
initialization unit. If this step is requested, it must follow the compile step
and precede the link-edit step.

This parameter can apply to IBMCOB that also has a prelink step. Whether
the prelink step applies to C or IBMCOB is determined by the choice of
values C, CPP, or IBMCOB for the HOST parameter.

Descriptions of the prelink process for C and IBMCOB are presented in

their respective language publications.

If PRELINK(YES) is specified or defaulted for a HOST language compiler

that does not support the prelink utility, DB2 will issue warning message
DSNH760I and prelink utility processing will be bypassed.

Chapter 44. DSNH (TSO CLIST) 289

Table 19. General DSNH CLIST parameters (continued)
Parameter Value Comments
PRINT NONE Specifies where to send printed output, including the lists of options,
dsname source, cross-reference, error, and summary information.
LEAVE
TERM The default, NONE, omits printed output.

dsname specifies a data set that is to be used for the output. Do not enclose
dsname between apostrophes. The current user profile is prefixed to dsname.
The following suffixes are also added:
v SYSCPRT.LIST for PL/I macro listings (these listings are overwritten by
the compiler listings)
v PCLIST for precompiler listings
v CXLIST for CICS command translator listings
v LIST for compiler listings
The PRINT parameter is ignored for the compile step when HOST(CPP)
is specified.
v SYSOUT.PRELLIST for C prelink utility listings
v LINKLIST for link-edit listings

LEAVE sends output to the specified print data set. You can allocate the
print data set in one of the following ways:
v Dynamically
v In the JCL that is used to run the DSNH CLIST (if in batch mode)
v With the TSO ALLOCATE command (before running DSNH)

TERM sends output to the terminal.

PSECSPAC integer Specifies the amount of secondary space to allocate for print data sets, in
the units given by SPACEUN.

The default is 20.

PSPACE integer Specifies the primary size of the print data sets in the units given by
SPACEUN.

The default is 20.

RCTERM integer Specifies the minimum value of the return code from the precompile step
that prevents execution of later steps.

The default is 8.

290 Command Reference

Table 19. General DSNH CLIST parameters (continued)
Parameter Value Comments
RUN TSO or YES Specifies whether to execute the compiled program if the previous steps are
BATCH or NO successful, and, if so, in which environment it executes. Your choice for the
CAF RUN parameter might affect your choice for LLIB.
CICS
IMS TSO or YES indicates that the application program is to be scheduled for
RRSAF execution in the TSO environment, and executes the compiled program.

BATCH or NO indicates that the application program is not to be

scheduled for execution, and defaults to TSO as the execution environment.

CAF indicates that the application program is to be scheduled for execution

in the call attachment facility environment. Specify BATCH or NO with
CAF to indicate that the application program is not to be scheduled for
execution, but to identify CAF as the execution environment. (BATCH,CAF)
or (NO,CAF)

CICS indicates that the application program is not to be scheduled for

execution, and identifies CICS as the run-time execution environment. CICS
applications cannot run in TSO.

IMS indicates that the application program is not to be scheduled for

execution, and identifies IMS as the run-time execution environment. IMS
applications cannot run in TSO.

RRSAF indicates that the application program is not to be scheduled for

execution, and identifies RRSAF as the run-time execution environment.
RRSAF applications cannot run in TSO.
RUNIN TERM Specifies where to get input for the RUN step.
dsname
LEAVE The default, TERM, gets input from the terminal.
NONE
dsname specifies a data set that is to be used for the input.

LEAVE gets input from SYSIN if the only steps taken are LINK and RUN.
LEAVE gets input from FT05F001 if the language is Fortran. Do not use
LEAVE in any other case.

NONE allocates no input file.

RUNOUT TERM Specifies where to send output from the RUN step.
dsname
LEAVE The default, TERM, sends output to the terminal.
NONE
dsname specifies a data set to receive output.

LEAVE sends output to SYSPRINT if the only steps taken are LINK and
RUN. LEAVE sends output to FT06F001 if the language is Fortran. Do not
use LEAVE in any other case.

NONE allocates no output file for the RUN step.

SOMDLLI dsname Specifies the name that of the SOM/MVS DLL import library.

This parameter is obsolete.

SOURCE NO Specifies whether the source code and diagnostics are to be printed with
YES output from the precompiler, CICS command translator, and compiler.

Chapter 44. DSNH (TSO CLIST) 291

Table 19. General DSNH CLIST parameters (continued)
Parameter Value Comments
SPACEUN TRACK Specifies the unit of space for PSPACE and WSPACE.
CYLINDER
TRACK makes the space unit one track.

CYLINDER makes the space unit one cylinder.

SQL DB2 Specifies how to interpret SQL statements and check syntax for use by
ALL either DB2 for z/OS or other database management systems.

The default, DB2, indicates that SQL statements are to be interpreted and
syntax is to be checked for use by DB2 for z/OS. SQL(DB2) is the
recommended mode for DRDA access when the server is a DB2 subsystem.

ALL indicates that SQL statements are to be interpreted for use by database
management systems that are not DB2 for z/OS. SQL syntax checking is
deferred until bind time so that the remote location can bind the resulting
DBRM. When SQL(ALL) is in effect, the precompiler issues an
informational message if SAA® reserved words are used as identifiers.
SQL(ALL) is the recommended mode if you have written your application
to be executed in a environment that is not DB2 for z/OS.

The default is SQL(DB2).

SQLDELIM DEFAULT Specifies the APOSTSQL or QUOTESQL precompiler option, to set the SQL
APOSTSQL string delimiter and, by implication, the SQL escape character within SQL
QUOTESQL statements. Whichever character is chosen to be the string delimiter, the
other is used for the SQL escape character.

This parameter is effective only for COBOL. For PL/I, Fortran, and
assembler language programs, the precompiler forces the APOSTSQL
option.

DEFAULT designates the value that is chosen during installation for the
SQL STRING DELIMITER field on the APPLICATION PROGRAMMING
DEFAULTS panel.

APOSTSQL specifies that the string delimiter is the apostrophe (’) and the
escape character is the quotation mark (″).

QUOTESQL specifies that the string delimiter is the quotation mark (″) and
the escape character is the apostrophe (’).
STDSQL NO Specify whether to interpret SQL using a subset of ANSI rules.
YES or 86
NO specifies that DB2 rules are used.

YES or 86 automatically implies that the NOFOR option is used.

SUFFIX YES Specifies whether the TSO standard naming convention must be followed.
NO That convention adds a TSO authorization ID prefix and a host language
suffix to the name of the input data set (unless that name is enclosed
between apostrophes, or already ends in the appropriate suffix). For
example, names become userid.name.COBOL, userid.name.PLI,
userid.name.Fortran, or userid.name.ASM.
SYSTEM subsystem-name Specifies the DB2 subsystem name as it is known to the z/OS operating
system.

The default is the installation-defined subsystem name (often DSN).

292 Command Reference

Table 19. General DSNH CLIST parameters (continued)
Parameter Value Comments
TERM TERM Specifies where to send terminal output, including error information, error
dsname statements, and summary information.
LEAVE
NONE The default, TERM, sends output to the terminal.

dsname specifies a data set that is to be used for terminal output. Do not
enclose dsname between apostrophes. The following suffixes are added to
dsname :
v PCTERM for precompiler output
v LIST for compiler output

LEAVE sends the output to the current allocation for SYSTERM.

NONE omits terminal output.

TIME ISO Specifies the format for time values that are to be returned, overriding the
JIS format that is specified as the location default.
USA
EUR There is no default because this option overrides the default previously
LOCAL specified.

VERSION version-id Specifies the name of the version ID for the program and associated DBRM
AUTO during the DB2 precompile step.

AUTO specifies that the consistency token is used to generate the version
ID. If the consistency token is a timestamp, the timestamp is converted into
ISO character format and used as the version identifier.

The default is no version ID if specified at precompiler invocation.

WORKUNIT unit Specifies the device to use for print and work data sets.

unit can be a unit name or a device type.

The default in batch mode is any eligible device.

The default in any other mode is the UADS unit name for the current TSO
user.
WSECSPAC integer Specifies the amount of secondary space to allocate for work data sets, in
the units given by SPACEUN.

The default is 20.

WSPACE integer Specifies the primary size of the work data sets in the units given by
SPACEUN.

The default is 20.

XLIB dsname Specifies the linkage editor include library that is to be used for DB2
routines.

The default is ’’’ prefix .SDSNLOAD’’’.

XREF NO Specifies whether a sorted cross-reference listing of symbolic names that are
YES used in source statements is to be printed with output from the
precompiler.
Note: Precompiler options do not affect ODBC behavior.

Chapter 44. DSNH (TSO CLIST) 293

 DSNH/DSN subcommand summary

Table 20 and Table 21 on page 297 differentiate the functions that support BIND
PLAN and BIND PACKAGE. Each table associates the DSNH CLIST parameter
and its corresponding DSN BIND PLAN or BIND PACKAGE subcommand
keyword, if any. In general:
v The function and value of a CLIST parameter is identical to that of its
corresponding DSN subcommand keyword unless otherwise noted.
v A DSNH parameter value of NONE indicates that the corresponding DSN
keyword is not specified on subcommand invocation. Exceptions are noted
where applicable.

DSNH CLIST/BIND PLAN subcommand comparison

Table 20. DSNH CLIST/ BIND PLAN subcommand summary
DSNH CLIST BIND PLAN subcommand
Parameter Value Keyword Value Comments
ACQUIRE USE ALLOCATE ACQUIRE USE ALLOCATE
ACTION REPLACE ADD ACTION REPLACE ADD
1 1
BDMEM DEFAULT MEMBER dbrm-member-name DBRM member name, which
dbrm-member-name is obtained from one of the
NONE2 following sources, in the order
listed:
v BDBRMLIB member name
v DBRMLIB member name
v INPUT member name, or
generated using dsname.
2
Keyword is not specified on
subcommand invocation.
BIND YES 1 NO2 (command-verb) 1
Execute BIND PLAN
subcommand.
2
Do not execute BIND PLAN
subcommand.
BLIB NONE 1 dsname LIBRARY dbrm-pds-name 1
Keyword is not specified on
subcommand invocation.
BnLIB1 NONE 2 dsname LIBRARY list of 1
n can be 2, 3, 4, 5, 6, 7, or 8.
dbrm-pds-names Specify the first data set name
by using the BLIB parameter.
Specify any additional data
set names by using this
parameter.
2
No additional data set
names.
BMEM1 NONE 2 list of MEMBER list of 1
Specify the first DBRM
dbrm-member-names dbrm-member-names member name using the
BDMEM parameter and any
additional member names
individually using this
parameter.
2
No additional DBRM
member names.

294 Command Reference

Table 20. DSNH CLIST/ BIND PLAN subcommand summary (continued)
DSNH CLIST BIND PLAN subcommand
Parameter Value Keyword Value Comments
1 2 1
CACHESIZE NONE CACHESIZE decimal-value The size is provided by the
2
decimal-value subsystem.
2
Specify a size from 0 to 4096
bytes.
CICS NONE 1 CICS application-ids 1
Keyword is not specified on
application-ids subcommand invocation.
CURRENTDATA YES NO NONE CURRENTDATA YES NO
1
CURRENTSERVER NONE CURRENTSERVER location-name
location-name
DBPROTOCOL NONE DRDA DBPROTOCOL DRDA PRIVATE If you specify PRIVATE, your
PRIVATE application cannot include
SQL statements that were
added to DB2 after Version 7.
BDBRMLIB DEFAULT 1 LIBRARY dbrm-pds-name 1
The precompiler DBRMLIB
dsname(member) data set is used. If the
NONE2 precompiler DBRMLIB is not
specified, the
default-generated DBRMLIB
library that is based on the
INPUT data set is used.
2
Keyword is not specified on
subcommand invocation.
DEFER NONE 1 PREPARE DEFER PREPARE 1
Keyword is not specified on
subcommand invocation.
DEGREE 1 ANY DEGREE 1 ANY
DISABLE NONE BATCH DISABLE NONE BATCH
CICS DB2CALL CICS DB2CALL
IMS IMS
DLIBATCH DLIBATCH
IMSBMP IMSBMP
IMSMPP IMSMPP
RRSAF RRSAF
DISCONNECT EXPLICIT DISCONNECT EXPLICIT
AUTOMATIC AUTOMATIC
CONDITIONAL CONDITIONAL
DLIBATCH NONE 1 list of DLIBATCH connection-name 1
Keyword is not specified on
connection-ids subcommand invocation.
DYNAMICRULES RUN BIND DYNAMICRULES RUN BIND
ENABLE NONE * BATCH ENABLE NONE * BATCH
CICS DB2CALL CICS DB2CALL
IMS DLIBATCH IMS DLIBATCH
IMSBMP IMSMPP IMSBMP IMSMPP
RRSAF RRSAF
EXPLAIN NO YES EXPLAIN NO YES
FLAG ICEW FLAG ICEW
1 1
IMSBMP NONE imsid IMSBMP imsid Keyword is not specified on
subcommand invocation.

Chapter 44. DSNH (TSO CLIST) 295

Table 20. DSNH CLIST/ BIND PLAN subcommand summary (continued)
DSNH CLIST BIND PLAN subcommand
Parameter Value Keyword Value Comments
1 1
IMSMPP NONE imsid IMSMPP imsid Keyword is not specified on
subcommand invocation.
ISOLATION RR RS CS UR ISOLATION RR RS CS UR
KEEPDYNAMIC NO YES KEEPDYNAMIC NO YES
1 1
NODEFER NONE PREPARE NODEFER PREPARE Keyword is not specified on
subcommand invocation.
OPTHINT (’ ’) (’ hint-id ’) OPTHINT (’ ’) (’ hint-id ’)
1 1
OWNER NONE OWNER authorization-id Keyword is not specified on
authorization-id subcommand invocation.
PATH (schema-name) ( PATH (schema-name) (
USER USER
)(schema-name, )(schema-name,
USER ...) USER ...)
PKLIST NONE 1 list of PKLIST list of collection-ids 1
The package names are not
collection-ids and and package- names specified on subcommand
package- names invocation.
1 1
PLAN plan-name PLAN plan-name plan-name must not be
DEFAULT. The default
(primary-keyword) plan-name is the first of the
following available choices
that are defined in the INPUT
data set:
v DBRM member name
v Left-most qualifier
If no name is found, a plan is
not created.
QUALIFIER NONE 1 QUALIFIER qualifier-name 1
Keyword is not specified on
implicit-qualifier subcommand invocation.
RELEASE COMMIT RELEASE COMMIT
DEALLOCATE DEALLOCATE
REOPT NONE 1 VARS REOPT NONE ALWAYS 1
Keyword is not specified on
ONCE AUTO subcommand invocation.
RETAIN NO 1 YES2 RETAIN 1
Keyword is not specified on
subcommand invocation.
2
Keyword is specified on
subcommand invocation.
SQLRULES DB2 STD SQLRULES DB2 STD
VALIDATE RUN BIND VALIDATE RUN BIND

296 Command Reference

 DSNH CLIST/BIND PACKAGE subcommand comparison
Table 21. DSNH CLIST/ BIND PACKAGE subcommand summary
DSNH CLIST BIND PACKAGE subcommand
Parameter Value Keyword Value Comments
PACTION REPLACE ADD ACTION
REPLACE
ADD
PBIND NO 1 YES2 (command-verb) 1
Do not execute BIND
PACKAGE subcommand.
2
Execute BIND PACKAGE
subcommand.
PCICS NONE 1 CICS application-ids 1
Keyword is not specified on
application-ids subcommand invocation.
COPY NONE 1 collection-id. COPY collection-id. 1
Keyword is not specified on
package-id package-id subcommand invocation.
COPYVER version-id COPYVER version-id
PCURRENTDATA NO YES NONE CURRENTDATA YES NO
PDBPROTOCO NONE DRDA DBPROTOCOL DRDA PRIVATE If you specift PRIVATE, your
PRIVATE application cannot include
SQL statements that were
added to DB2 after Version 7.
PDBRMLIB DEFAULT 1 LIBRARY dbrm-pds-name 1
The precompiler DBRMLIB
dsname(member) data set is used. If the
NONE2 precompiler DBRMLIB is not
specified, the
default-generated DBRMLIB
library that is based on the
INPUT data set is used.
2
Keyword is not specified on
subcommand invocation.
PDEFER NONE 1 PREPARE DEFER PREPARE 1
Keyword is not specified on
subcommand invocation.
PDEGREE 1 ANY DEGREE 1 ANY
PDISABLE NONE BATCH DISABLE NONE BATCH
CICS DB2CALL CICS DB2CALL
IMS DLIBATCH IMS DLIBATCH
IMSBMP IMSMPP IMSBMP IMSMPP
REMOTE RRSAF REMOTE RRSAF
PDLIBATCH NONE 1 list of DLIBATCH connection-name 1
Keyword is not specified on
connection-ids subcommand invocation.
PDMEM DEFAULT 1 MEMBER dbrm-member- name 1
DBRM member name, which
dbrm-member- name is obtained from one of the
NONE2 following sources, in the order
listed:
v PDBRMLIB member name
v DBRMLIB member name
v INPUT member name, or
generated using dsname
2
Keyword is not specified on
subcommand invocation.

Chapter 44. DSNH (TSO CLIST) 297

Table 21. DSNH CLIST/ BIND PACKAGE subcommand summary (continued)
DSNH CLIST BIND PACKAGE subcommand
Parameter Value Keyword Value Comments
PDYNAMICRULES NONE RUN BIND DYNAMICRULES RUN BIND
DEFINE INVOKE DEFINE INVOKE
PENABLE NONE * BATCH ENABLE NONE * BATCH
CICS DB2CALL CICS DB2CALL
IMS DLIBATCH IMS DLIBATCH
IMSBMP IMSMPP IMSBMP IMSMPP
REMOTE RRSAF REMOTE RRSAF
EXPLAIN NO YES EXPLAIN NO YES
PFLAG ICEW FLAG ICEW
1 1
PIMSBMP NONE imsid IMSBMP imsid Keyword is not specified on
subcommand invocation.
PIMSMPP NONE 1 imsid IMSMPP imsid 1
Keyword is not specified on
subcommand invocation.
PISOLATION NONE 1 RR RS CS ISOLATION1 RR RS CS UR NC 1
For local packages, the
UR NC default value is the same as
that of the plan that is
appended at execution time.
For remote packages, the
default value is RR.
PKEEPDYNAMIC NONE NO YES KEEPDYNAMIC NO YES
1 1
PNODEFER NONE PREPARE NODEFER PREPARE Keyword is not specified on
subcommand invocation.
POPTHINT (’ ’) (’ hint-id ’) OPTHINT (’ ’) (’ hint-id ’)
1 1
POWNER NONE OWNER authorization-id Keyword is not specified on
authorization-id subcommand invocation.
PACKAGE DEFAULT 1 PACKAGE location-name. 1
Member name that is
location-name. collection-id defined in the INPUT
collection-id parameter data set, or the
data set name if no member
name was specified.
PPATH (schema-name) ( PATH (schema-name) (
USER USER
)(schema-name, )(schema-name,
USER , ...) USER , ...)
PQUALIFIER NONE 1 qualifier-name 1
Keyword is not specified on
implicit-qualifier QUALIFIER subcommand invocation.
PRELEASE NONE 1 COMMIT RELEASE1 COMMIT 1
For local packages, the
DEALLOCATE DEALLOCATE default value is the same as
that of the plan that is
appended at execution time.
For remote packages, the
default value is NONE.
REOPT NONE 1 VARS REOPT NONE ALWAYS 1
Keyword is not specified on
ONCE AUTO subcommand invocation.
REMOTE NONE 1 REMOTE network-name 1
Keyword is not specified on
location-name, subcommand invocation.
<luname>

298 Command Reference

Table 21. DSNH CLIST/ BIND PACKAGE subcommand summary (continued)
DSNH CLIST BIND PACKAGE subcommand
Parameter Value Keyword Value Comments
1 1
REPLVER NONE version-id REPLVER version-id version-id is not specified on
subcommand invocation.
SQLERROR NOPACKAGE SQLERROR NOPACKAGE
CONTINUE CONTINUE
PVALIDATE RUN BIND VALIDATE RUN BIND

Usage notes
CICS translator: Do not use CICS translator options in the source language for
assembler programs; pass the options to the translator with the CICSOPT option.

COBOL options: The COBOL DYNAM option has several restrictions:

v You cannot use the option with CICS.
v You must use the VS COBOL II library or the Language Environment (z/OS
Language Environment) library.
v To use the option with TSO or batch, the SDSNLOAD library must precede the
IMS RESLIB in the step library, job library, or link list concatenations.
v To use the option with IMS, the IMS RESLIB must precede DSNLOAD.

Several COBOL options require DD statements that are not provided by the DSNH
CLIST, as shown in the following table.
Table 22. COBOL options that require additional DD statements
Option Statements required for...
CDECK SYSPUNCH
COUNT SYSCOUNT, SYSDBG, SYSDBOUT, SYSUT5, a debug file
DECK SYSPUNCH
DUMP SYSABEND, SYSDUMP, or SYSUDUMP
FDECK SYSPUNCH
FLOW SYSCOUNT, SYSDBG, SYSDBOUT, SYSUT5, a debug file
LVL SYSUT6
STATE SYSCOUNT, SYSDBG, SYSDBOUT, SYSUT5, a debug file
SYMDUMP SYSCOUNT, SYSDBG, SYSDBOUT, SYSUT5, a debug file
SYST SYSOUT
SYSx SYSOUx
TEST SYSUT5

COBOL parameters: The BUF and SIZE parameters passed to the COBOL compiler
might need to be changed.

COPTION: Do not use the COPTION parameter to specify values for the
LINECOUNT, SOURCE, TERM, and XREF compiler options; use the DSNH
LINECOUNT, SOURCE, TERM, and XREF keywords.

Fortran and PL/I considerations: Variable-format input records are not supported.

Chapter 44. DSNH (TSO CLIST) 299

 Library limits: At most, eight bind libraries, four precompile libraries, four compile
libraries, and four link-edit libraries can exist.

User-supplied DSNHDECP module: The following steps are required to enable

DSNH CLIST to load your user-supplied DSNHDECP module rather than the
DB2-supplied DSNHDECP module:
1. The JOBLIB or STEPLIB concatenation of any job or TSO userid that calls
DSNH must allocate the library where the user-supplied DSNHDECP module
resides (usually prefix .SDSNEXIT) before it allocates the library where the
DB2-supplied DSNHDECP module resides ( prefix .SDSNLOAD).
2. The DSNH call should include the PCLOAD parameter, coded as follows:
PCLOAD('*(DSNHPC)')

Link-edit:
v DSNH cannot process programs that need additional link-edit control statements
and cannot link-edit programs that use the call attachment facility.
v You cannot use the NOLOAD and SYNTAX link-edit options.

NONE is a reserved word: NONE cannot be the name of an input or a load library,
or the value of the string passed with PARMS.

SQL host variables: You must explicitly define SQL host variables.

SYSPROC: If compilation is done, the SYSPROC data set must include the DB2
CLIST library.

WORKUNIT parameter: You must use the WORKUNIT parameter when running
the DSNH CLIST in batch mode. This insures that the temporary and intermediate
data sets are allocated to the correct devices.

Examples

Example 1: Precompile, bind, compile, link-edit, and run the COBOL program in
data set prefix .SDSNSAMP(DSN8BC4).
v The compiler load module is in SYS1.LINKLIB (IKFCBL00).
v Additional load modules to be included are in prefix .RUNLIB.LOAD and prefix
.SDSNSAMP.
v The load module is to be put into the data set prefix .RUNLIB.LOAD(DSN8BC4).
v The plan name is DSN8BC81 for the bind and run.
v DCLGEN data from prefix .SRCLIB.DATA is required for the precompile.
This example assumes that the DSNH CLIST is in your SYSPROC concatenation.
DSNH INPUT('prefix.SDSNSAMP(DSN8BC4)'') -
COBLOAD('SYS1.LINKLIB(IKFCBL00)'') -
LLIB('prefix.RUNLIB.LOAD'') -
L2LIB('prefix.SDSNSAMP'') -
LOAD('prefix.RUNLIB.LOAD'') -
PLAN(DSN8BC81) -
PLIB('prefix.SRCLIB.DATA'')

Example 2: Precompile, bind, compile, and link-edit the program in data set prefix
.SDSNSAMP.PLI(DSN8BP4).
v The program is written in PL/I; the macro pass is not needed.
v The PL/I compiler options MAP and LIST are to be used.

300 Command Reference

v Additional load modules to be included are in prefix .RUNLIB.LOAD and prefix
.SDSNSAMP.
v The PL/I optimizing compiler load module is in library SYS2.LINKLIB(IEL0AA).
v The DB2 subsystem identifier is SSTR.
v The load module is put into the data set prefix .RUNLIB.LOAD(DSN8BC4).
v Printed output is sent to the following data sets:
Output
Data set
Precompiler listings
prefix .PROG.PCLIST
Compiler listings
prefix .PROG.LIST
Link-edit listings
prefix .PROG.LINKLIST
v The plan name is DSN8BC81 for the bind and run.
v The DCLGEN data from prefix .SRCLIB.DATA is required for the precompile.
DSNH INPUT('prefix.SDSNSAMP(DSN8BP4)'') -
HOST(PLI) MACRO(NO) -
COPTION ('MAP LIST') -
LLIB('prefix.RUNLIB.LOAD'') -
L2LIB('prefix.SDSNSAMP'') -
PLILOAD('SYS2.LINKLIB(IEL0AA)'') -
SYSTEM(SSTR) -
LOAD('prefix.RUNLIB.LOAD'') -
PRINT(PROG) -
PLAN(DSN8BC81) -
PLIB('prefix.SRCLIB.DATA'')

The COPTION parameters are enclosed between single apostrophes so that they
are passed by TSO as a single parameter. If a single token is being passed as a
parameter, no apostrophes are needed. That same rule applies to the PARMS and
CICSOPT parameters.

If a data set name is being passed as a parameter, and you want TSO to add your
user prefix, no apostrophes are needed. If the usual TSO prefixing and suffixing
must not be performed, the data set name must be enclosed between sets of three
apostrophes if the CLIST is executed implicitly, and sets of six apostrophes if the
CLIST is executed explicitly.

The user prefix for that example is prefix ; if it had been SMITH, the listing data set
names would be as shown in the preceding example, except that SMITH would be
used as the first level qualifier. For example, the compiler listings would have gone
to SMITH.PROG.LIST.

Example 3: Invocation of the DB2 C sample application program prefix

.SDSNSAMP(DSN8BD3).
v The C linkage editor include library is EDC.V1R1M1.SEDCBASE
v The C compiler load module is EDC.V1R1M1.SEDCCOMP(EDCCOMP)
v Printed output is sent to the following data sets:
Output
Data set

Chapter 44. DSNH (TSO CLIST) 301

 Precompiler listings
user_id.TEMP.PCLIST
Compiler listings
user_id.TEMP.SYSCPRT.LIST
Prelink utility listings
user_id.TEMP.SYSOUT.PRELLIST
Link-edit listings
user_id.TEMP.LINKLIST
v The following C DD names are allocated based on the PRINT keyword value:
DD name
Allocation
SYSCPRT
Used in the compile step
SYSUT10
Used in the compile step
SYSOUT
Used in the prelink step
SYSUT10 and SYSCPRT are always allocated to the same data set or destination.
v SYSTERM is used in the compile step. It is based on the TERM keyword.
v CEEDUMP is used in the run step. It is based on the RUNOUT keyword.
v The LOPTION keyword values of AMODE(31) and RMODE(ANY) are required
when link editing the C sample program to insure 31-bit addressability during
execution.
ALLOC DD(SYSPROC) DSN('prefix.SDSNCLST ') SHR
%DSNH BIND(YES) ACQUIRE(USE) ACTION(REPLACE)-
EXPLAIN(NO) -
CICSXLAT(NO) -
COMPILE(YES) -
CCLLIB('EDC.V1R1M1.SEDCBASE'')-
CCLOAD('EDC.V1R1M1.SEDCCOMP(EDCCOMP)'')-
DBRM('prefix.DBRMLIB.DATA(DSN8BD3)'')-
DECIMAL(PERIOD) DELIMIT(DEFAULT) FLAG(I)-
HOST(C) ISOLATION(RR)-
INPUT('prefix.SDSNSAMP(DSN8BD3)'')-
LINK(YES)-
LLIB('prefix.RUNLIB.LOAD'')-
L2LIB('prefix.SDSNLOAD'')-
LOAD('prefix.RUNLIB.LOAD'')-
LOPTION('AMODE(31) RMODE(ANY)')-
MACRO(NO)-
OUTNAME(TEMP)-
PLAN(DSN8BD31) PRECOMP(YES)-
PLIB('prefix.SDSNSAMP'')-
PRELINK(NO)-
POPTION(NONE)-
PRINT(TEMP) RCTERM(8)-
RELEASE(COMMIT) RETAIN(YES)-
RUN(NO) RUNIN(TERM)-
RUNOUT(TERM) SOURCE(YES)-
SYSTEM(DSN) SQLDELIM(DEFAULT)-
VALIDATE(RUN)

302 Command Reference

Chapter 45. END (DSN)
The DSN subcommand END is used to end the DSN session and return to TSO.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Usage note”
v “Example”

Environment
This subcommand originates from a TSO input stream when DSN is running in
either background or foreground mode.

Data sharing scope: Member

Authorization

None is required.

Syntax

END


Usage note

Ending the DSN session in batch or foreground: In batch, if END is not found in
the SYSIN stream, /* or // ends the DSN session. From the foreground, pressing
the ATTENTION key twice ends the DSN session.

Example

End the DSN session and return to TSO.

TSO prompt : READY
USER enters: DSN SYS (SSTR)
DSN prompt : DSN
USER enters: RUN PROGRAM (MYPROG)
DSN prompt : DSN
USER enters: END
TSO prompt : READY

© Copyright IBM Corp. 1983, 2009 303

304 Command Reference
Chapter 46. FREE PACKAGE (DSN)
The DSN subcommand FREE PACKAGE can be used to delete a specific version of
a package, all versions of a package, or whole collections of packages.

The FREE PACKAGE subcommand deletes corresponding table entries from the
catalog tables. Authorization for a package name is removed only when no more
versions of the package exist. After a version of a package has been freed, that
package name is then available for use in a BIND PACKAGE subcommand to
create a new package.

The FREE PACKAGE subcommand does not proceed until all currently running
applications using the package finish running.

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 306
v “Option descriptions” on page 306
v “Usage notes” on page 307
v “Examples” on page 307

Environment

You can enter this subcommand from DB2I, or from a DSN session under TSO that
is running in either foreground or background.

Data sharing scope: Group

Authorization

To execute this subcommand, you must use a privilege set of the process that
includes one of the following privileges or authorities:
v Ownership of the package
v BINDAGENT privilege granted by the owner of the package
v SYSCTRL authority
v SYSADM authority
v PACKADM authority for the collection or for all collections

The BIND privilege on a package is not sufficient to allow a user to free a package.

© Copyright IBM Corp. 1983, 2009 305

 Syntax

FREE PACKAGE

(  collection-id . package-id )

location-name. * * .( )
version-id
*
*


I PLANMGMTSCOPE( )
FLAG( W ) ALL
E INACTIVE
C

Option descriptions
location-name
Specifies the location of the DBMS where the package is to be freed. The
location name must be defined in the SYSIBM.LOCATIONS table. If this table
does not exist or the DBMS is not found, you receive an error message. If the
location name is specified, the name of the local DB2 subsystem must be
defined.
The default is the local DB2 subsystem if you omit location-name .
collection-id or (*)
Identifies the collection of the package to be freed. There is no default.
You can use an asterisk ( * ) to free all local packages with the specified
package-id in all the collections that you are authorized to free. (You cannot use
the * to free remote packages.)
package-id or (*)
Identifies the package to be freed. There is no default.
You can use an asterisk ( * ) to free all local packages in collection-id that you
are authorized to free. (You cannot use the * to free remote packages.)
version-id or (*)
Identifies the version of the package to be freed.
You can use an asterisk ( * ) to free all local packages in the collection-id and
package-id that you are authorized to free. (You cannot use the * to free remote
packages.)
If you specify () for version-id , the empty string is used for the version ID.
If you omit the version-id , the default depends on how you specify package-id .
If you use * for package-id , version-id defaults to *. If you provide an explicit
value for package-id , version-id defaults to an empty string.
DBRMs created before DB2 Version 2 Release 3 use an empty string for
version-id by default.

306 Command Reference

 (*)
Frees all local DB2 packages that you are authorized to free.
Specifying (*) is equivalent to specifying the package name as (*.*.(*)) or (*.*).
FLAG
Indicates what messages you want the system to display. Use one of the
following values to show messages of the corresponding types.
(I) All: informational, warning, error, and completion messages.
(W) Only warning, error, and completion messages.
(E) Only error and completion messages.
(C) Only completion messages.
| PLANMGMTSCOPE
| Allows you to manually free inactive copies of packages. Use one of the
| following options to help reclaim disk space:
| ALL Frees the entire package, including copies.
| INACTIVE
| Frees only previous or original copies from the directory, catalog, and
| access path repository. This option will succeed even if the package has
| no inactive copies.

Usage notes

Freeing multiple packages: If you free multiple packages with this subcommand,
each successful free is committed before freeing the next package.

If an error occurs on a certain package specified explicitly in a list or implicitly

with (*), FREE PACKAGE terminates for that package and continues with the next
package to be processed.

Freeing trigger packages: You cannot free a trigger package using the FREE
PACKAGE subcommand.

Examples

Example 1: Free version newver of the package TEST.DSN8BC81 located at

USIBMSTODB22. Generate only warning, error, and completion messages (not
informational messages).
FREE PACKAGE (USIBMSTODB22.TEST.DSN8BC81.(newver)) FLAG(W)

Example 2: Free all packages at the local server in the collection named
TESTCOLLECTION.
FREE PACKAGE (TESTCOLLECTION.*)

Chapter 46. FREE PACKAGE (DSN) 307

308 Command Reference
Chapter 47. FREE PLAN (DSN)
The DSN subcommand FREE PLAN deletes application plans from DB2.

The FREE PLAN subcommand deletes corresponding table entries from the
SYSIBM.SYSPLAN catalog tables. All authorization against an application plan
name is dropped. The application plan name is then available for use in a BIND
PLAN subcommand to create a new package.

The FREE PLAN subcommand does not proceed until all currently executing
applications using that plan finish executing.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions” on page 310
v “Usage notes” on page 310
v “Example” on page 310

Environment

You can enter this subcommand from DB2I, or from a DSN session under TSO that
is running in either foreground or background.

Data sharing scope: Group

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v Ownership of the plan
v BIND privilege on the plan
v BINDAGENT privilege granted by the plan owner
v SYSCTRL authority
v SYSADM authority

Syntax

FREE PLAN (  plan-name )


* I
FLAG( W )
E
C

© Copyright IBM Corp. 1983, 2009 309

 Option descriptions
( plan-name , ...)
Lists the names of one or more plans you want to free.
(*)
Frees all application plans over which you have BIND authority. Be careful
when using this form of the command.
FLAG
Indicates what messages you want the system to display. Use one of the values
listed to show messages of the corresponding types.
(I) All: informational, warning, error, and completion messages.
(W) Only warning, error, and completion messages.
(E) Only error and completion messages.
(C) Only completion messages.

Usage notes

Freeing multiple plans: If you free multiple plans with this subcommand, each
successful free is committed before freeing the next plan.

If an error occurs on a certain plan specified explicitly in a list or implicitly with

(*), FREE PLAN terminates for that plan and continues with the next plan to be
processed.

Example

Free plan DSN8BC81 from DB2. Generate only warning, error, and completion
messages (not informational messages).
FREE PLAN (DSN8BC81) FLAG (W)

310 Command Reference

 Chapter 48. MODIFY admtproc,APPL=SHUTDOWN
The MODIFY admtproc, APPL=SHUTDOWN command stops the administrative
task scheduler from accepting requests and starting new task executions. It also
shuts down the administrative task scheduler.

When the SHUTDOWN option is specified, the administrative task scheduler will
wait until the execution of all currently running tasks completes. When all running
tasks are complete, the administrative will terminate.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Examples”

Environment

This command can be issued only from a z/OS console.

Data sharing scope: Member

Authorization

The command requires an appropriate level of operating system authority.

Syntax

MODIFY admtproc,APPL= SHUTDOWN


| You cannot include spaces when you specify options.

Option descriptions
admtproc
Specifies the procedure name of the administrative task scheduler task to that
you want to modify.

Examples

Example 1: This command modifies the admtproc scheduler in order to shut it

down.

Enter the following command on the system console:

modify admtproc,appl=SHUTDOWN

© Copyright IBM Corp. 1983, 2009 311

312 Command Reference
 Chapter 49. MODIFY admtproc,APPL=TRACE
The MODIFY admtproc, APPL=TRACE command starts or stops traces in the
administrative task scheduler.

It is not required to stop the scheduler to access the trace. If you want to turn trace
on or off when the administrative task scheduler starts, you can do one of the
following:
v Modify the procedure parameter TRACE in the JCL job that starts the
administrative task scheduler. This job has the name admtproc and was copied
into one of the PROCLIB library during the installation. Specify TRACE=ON or
TRACE=OFF.
v Dynamically overwrite the trace parameter on the operator’s console when
starting the administrative task scheduler. This option does not exist when DB2
starts the administrative task scheduler automatically, and can only be done
manually.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Examples” on page 314

Environment

This command can be issued only from a z/OS console.

Data sharing scope: Member

Authorization

The command requires an appropriate level of operating system authority.

Syntax

MODIFY admtproc,APPL= TRACE= ON


OFF

| You cannot include spaces when you specify options.

Option descriptions
admtproc
Specifies the procedure name of the administrative task scheduler task that you
want to modify.

© Copyright IBM Corp. 1983, 2009 313

 ON
Turns the trace on.
OFF
Turns the trace off.

Examples

Example 1: This command modifies the admtproc scheduler and turns the trace on.

Enter the following command on the system console:

modify admtproc,appl=trace=on

Response from z/OS console:

STC00072 DSNA672I MODIFY COMMAND FOR ADMIN SCHEDULER V91AADMT
NORMAL COMPLETION

Example 2: This command modifies the admtproc scheduler and turns the trace off.

Enter the following command on the system console:

modify admtproc,appl=trace=off

Response from z/OS console:

STC00072 DSNA672I MODIFY COMMAND FOR ADMIN SCHEDULER V91AADMT
NORMAL COMPLETION

314 Command Reference

Chapter 50. MODIFY irlmproc,ABEND (z/OS IRLM)
The MODIFY irlmproc , ABEND command terminates IRLM abnormally. IRLM
processes this command even if a DB2 subsystem is identified to it.

Abbreviation: F

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage notes” on page 316
v “Example” on page 316

Environment

This command can be issued only from a z/OS console.

Data sharing scope: Member

Authorization
The command requires an appropriate level of operating system authority.

Syntax

DUMP


MODIFY irlmproc,ABEND,

NODUMP

Option descriptions

Parameters must be separated by commas with no spaces.

irlmproc
Specifies the procedure name of the IRLM that is to be terminated.
DUMP
Specifies that IRLM is to terminate abnormally with a U2020 abend. A system
dump is taken to the SYS1.DUMPxx data set. IRLM does not deregister from
ARM.
NODUMP
Specifies that IRLM is to FORCE the DBMS off and terminate normally
without generating a dump. All DBMS work is quiesced and IRLM stops itself.
NODUMP requires that IRLM be functioning normally. Do not use this option
if IRLM appears to be hung.

© Copyright IBM Corp. 1983, 2009 315

 A second invocation causes IRLM to terminate abnormally with a U2020
abend; no dump is taken.

Usage notes

Terminating IRLM: Use the STOP irlmproc (z/OS IRLM) command to terminate
IRLM.

Deregistering IRLM: You can use the NODUMP option to deregister IRLM before
stopping it. This action prevents the automatic restart manager from immediately
trying to restart IRLM.

Example
Enter the following command on the system console:
F KRLM001,ABEND

Response on the z/OS system console is as follows:

DXR124E IR21001 ABENDED VIA MODIFY COMMAND
*IEA911E COMPLETE DUMP ON SYS1.DUMP00
FOR ASID(0004)
ERROR ID = SEQ00001 CPU00 ASID0004 TIME08.34.59.9
DXR121I IR21001 END-OF-TASK CLEANUP SUCCESSFUL
IEF450I IR21001 IR21001 - ABEND=S000 U2020 REASON=00000000

The default is dump. If you do not want a dump, you must specify the following
command:
F KRLM001,ABEND,NODUMP

316 Command Reference

Chapter 51. MODIFY irlmproc,DIAG (z/OS IRLM)
The MODIFY irlmproc , DIAG command initiates diagnostic dumps for IRLM
subsystems.)

If IRLM detects a delay in the child-lock propagation process, it retries the XES
calls in order to recover. Use the MODIFY irlmproc , DIAG command under the
direction of IBM Software Support if this situation occurs.

Abbreviation: F

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage note” on page 318
v “Example” on page 318

Environment

This command can be issued only from a z/OS console.

Data sharing scope: Group

Authorization

The command requires an appropriate level of operating system authority.

Syntax

MODIFY irlmproc,DIAG ,DELAY


,PLOCK
,ALL
,NONE
,HANG

Option descriptions

Parameters must be separated by commas, with no spaces.

irlmproc
Specifies the procedure name of the IRLM instance that is to be diagnosed.
DIAG
Specifies that this is a diagnostic dump.
DELAY
Directs IRLM to generate a dump the first time it detects that child lock

© Copyright IBM Corp. 1983, 2009 317

 propagation to the coupling facility is taking longer than 45 seconds. The
dump is placed in the SYS1.DUMPxx data set.
PLOCK
| Directs IRLM to generate a dump the first time it detects that P-lock
| negotiation is taking longer than four minutes. Dumps of the IRLM and DB2
| address spaces are placed in the SYS1.DUMPxx data set.
ALL
Directs IRLM to generate diagnostic dumps for IRLM or DBMS subsystems in
a data sharing group for the following unusual conditions:
| v P-lock negotiation takes longer than four minutes.
| v Child-lock propagation takes longer than 72 seconds. IRLM retries the child
| lock propagation after 78 seconds if this condition still exists.
v If IRLM detects a delay in the child-lock propagation process, it retries the
XES calls in order to recover.
NONE
Disables generating all diagnostic dumps.
HANG
Collects IRLM SYSPLEX dumps when DEADLOCK or TIMEOUT issues are
suspected. The dumps are taken during DEADLOCK processing. The
DEADLOCK processing is stopped, and the dynamic deadlock storage is
collected. z/OS DUMP services then schedules an SRB to restart DEADLOCK
processing. Message DXR183I is issued by each IRLM as DEADLOCK
processing is restarted. If message DXR183I is not issued by an IRLM, that
IRLM must be terminated and restarted. You must start the IRLM XCF
CTRACE internally and wait 30 seconds before issuing this command.

Usage note

The MODIFY irlmproc,DIAG command should be used only under the direction of
IBM Software Support.

This command is active for only one incident per IRLM, that is, after an IRLM
instance detects the delay and initiates the dump. You can initiate one dump per
IRLM in the group. You must enter the command again to initiate another dump.
Be aware that when you enter this command for one member of the data sharing
group, any member that detects the delay initiates a dump.

The irlmproc identifies the procedure name for IRLM. If multiple IRLM instances
exist in the same system, each procedure must have a unique name.

Example

Issue this command to initiate one diagnostic dump for the IR21PROC IRLM
subsystem. The dump occurs once, after the propagation of child locks takes longer
than 45 seconds.
MODIFY IR21PROC,DIAG,DELAY

318 Command Reference

Chapter 52. MODIFY irlmproc,PURGE (z/OS IRLM)
The MODIFY irlmproc,PURGE command releases IRLM locks retained due to a
DB2, IRLM, or system failure.

The command causes all retained locks for the specified DB2 to be deleted from
the system, thereby making them available for update. Because retained locks
protect updated resources, it should be used only after understanding what the
resources are and the consequence to data integrity if they are deleted.

Abbreviation: F

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage notes”
v “Example” on page 320

Environment

This command can be issued only from a z/OS console.

Data sharing scope: Member

Authorization

The command requires an appropriate level of operating system authority.

Syntax

MODIFY irlmproc,PURGE,db2name


Option descriptions

Use commas with no spaces to separate parameters.

irlmproc
Specifies the active IRLM that is to process the command.
db2name
Specifies the inactive DB2 name, as displayed by the STATUS command.

Usage notes

DB2 subsystem inactive: The DB2 subsystem that owns the retained locks must be
inactive or else this command fails.

© Copyright IBM Corp. 1983, 2009 319

 The irlmproc must be the procedure name of an active IRLM that is connected to
the same sysplex group as the failed member. Issuing a purge request using an
inactive IRLM returns error IEE341I.

Example

Example: For an active DB2 subsystem named db2b with irlmproc name db2birlm,
issue the following command to display all active and inactive subsystems in a
data sharing sysplex:
F db2birlm,STATUS,ALLD

If the subsystem db2a is inactive, enter the following command:

F db2birlm,PURGE,db2a

Response on the MVS system console for completed purge request:

DXR109I IR2B002 PURGE COMMAND COMPLETED FOR DB2A

Explanation: In a sysplex environment, if the DB2 database is inactive and the

database IRLM has stopped or is disconnected, the operator of the z/OS system
uses one of the other active IRLM members to query retained locks and issue the
PURGE request.

320 Command Reference

 Chapter 53. MODIFY irlmproc,SET (z/OS IRLM)
The MODIFY irlmproc,SET command dynamically sets various IRLM operational
parameters

The MODIFY irlmproc,SET command performs the following tasks:

v Dynamically sets the maximum private storage allowed from IRLM.
v Dynamically sets the number of trace buffers allowed for IRLM.
v Dynamically sets the number of LOCK LTE entries to be specified on the next
connect to the XCF LOCK structure.
v Dynamically sets the timeout value for a specified subsystem.
v Dynamically sets the local deadlock frequency.

Abbreviation: F

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option description”
v “Usage notes” on page 323
v “Examples” on page 323

Environment

This command can be issued only from a z/OS console.

Data sharing scope: Group or Member, depending on whether you specify the
DEADLOCK or LTE options.

Authorization

The command requires an appropriate level of operating system authority.

| Syntax
|

|

MODIFY irlmproc,SET ,DEADLOCK=nnnn


,LTE=nnnn
,MLT=nnnnnU
,PVT=nnnn
,TIMEOUT=nnnn,subsystem-name
10
,TRACE= nnn
|
||

Option description

Use commas with no spaces to separate parameters.

© Copyright IBM Corp. 1983, 2009 321

 irlmproc
Specifies the IRLM that is to process the command.
SET
Sets the following values for this IRLM:
DEADLOCK= nnnn
Specifies the number, in milliseconds, indicating how often the local
deadlock processing is scheduled. nnnn must be a number from 100
through 5000 milliseconds. If a member of a sysplex group and all
IRLMs are not enabled for subsecond deadlock processing, message
DXR106E is issued.
LTE= nnnn
Specifies the number of lock table entries that are to be specified on the
next connect to the XCF lock structure. nnnn must be a number from 0
through 1024, and it must be an even power of 2. Each increment in
value represents 1 048 576 LTE entries. Note that this parameter is used
for data sharing only.
| MLT= nnnnnU
| Specifies the upper limit of private storage above the two gigabyte bar,
| also called the MEMLIMIT, which is managed by MVS. This command
| allows you to dynamically change the MEMLIMIT for IRLM. This
| storage is used for locks. The value nnnnn. must be a five digit number
| from 0 through 99999, and U must be a one character units indicator
| with the value of M for megabytes, G for gigabytes, T for terabytes, or
| P for petabytes. MEMLIMIT specified for IRLM must be larger than
| both the 2 GB minimum and the amount of above the bar storage in
| use at the time of the command. If the specified value is out of range
| or lower than the amount in use (or the 2 GB minimum), then the
| command is rejected with message DXR106E.
| This MEMLIMIT update is temporary, holding only as long as the
| execution of this IRLM instance. To make a permanent MEMLIMIT
| change, update the corresponding IRLM startup procedure with a new
| value for the MEMLIMIT JCL EXEC parameter.
PVT= nnnn
Specifies the upper limit of private storage, below the two gigabyte
bar. nnnn must be a four digit number from 1 through 1800. You can
specify this value in megabytes or gigabytes by specifying M (for
megabytes) or G (for gigabytes) after the value, as follows, nnnn M or
nnnn G. IRLM monitors the amount of private storage used for locks.
If the specified limit is reached, new lock requests will be rejected
unless they are must complete. If the specified value is out of range or
if IRLM’s use of private storage is already larger than the specified
value, the command is rejected with message DXR106E. No reserve for
must complete locks is calculated from the specified PVT= value.
TIMEOUT= nnnn,subsystem-name
Requests that IRLM dynamically set the timeout value, in seconds, for
the specified subsystem. nnnn must be a number from 1 through 3600.
subsystem-name is the DB2 subsystem name, as displayed by the
MODIFY irlmproc,STATUS command.
TRACE= nnn
Requests that IRLM dynamically set the maximum number of 64 KB
trace buffers per trace type to the value you specify in nnn . nnn must

322 Command Reference

 be a number from 10 through 255. If you specify a value outside of this
range, IRLM automatically adjusts the value to a value within the
range.
The default is 10 .
This value is used only when the external CTRACE writer is not
active. The trace buffers are allocated from extended common storage
area (ECSA).
IRLM does not immediately acquire the number of trace buffers you
set using this command; IRLM allocates buffers as needed, not to
exceed the number of buffers you specify. If the number of trace
buffers that you set is less than the number of currently allocated
buffers, IRLM brings the number within your specified range by
releasing the oldest buffers at the end of the next deadlock cycle.

Usage notes
Effect of an IRLM restart: The values you set using the MODIFY irlmproc,SET
command do not persist through a stop and restart of IRLM. The number of trace
buffers for each trace type returns to the default value of 10.

TIMEOUT considerations: The TIMEOUT value must be a multiple of the local

deadlock parameter. If the value entered is not an even multiple of the deadlock
parameter, IRLM will increase the timeout value to the next highest multiple. This
new value is used until the IRLM or identified subsystem is terminated, or the
timeout is changed again by the operator. The value specified on the command
does not affect the timeout value in the DB2 subsystem parameters.

The LTE value is used in the following order:

1. The value specified using the MODIFY irlmproc,SET,LTE= command, if the
value is greater than zero.
2. The value from the LTE= in the IRLMPROC, if the value is greater than zero.
3. The value determined by the existing logic, which divides the XES structure
size returned on the XESQUERY call by 2 multiplied by the LTE width. The
result is rounded to the nearest power of 2, which the existing logic uses for
the value.

Note: The LTE width is determined by the MAXUSRS value.

If an attempt is made to use a nonzero value from either option number 1 or 2,

and that value is too large for the structure size that is returned on the QUERY, the
value from the next option in the sequence is used instead.

Deadlock value range for non-supporting members: When an IRLM that supports
subsecond deadlock joins a group that has a member that does not support
subsecond deadlock, if the deadlock value of the new member is less than one
second, the value is set to one second.

Examples

Example 1: Enter the following command on a z/OS system console:

F IR21PROC,SET,TRACE=20

Response on the z/OS system console is as follows:

Chapter 53. MODIFY irlmproc,SET (z/OS IRLM) 323

 DXR177I IR21033 THE VALUE FOR TRACE IS SET TO 20.

Example 2: Enter the following command on a z/OS system console:

F IR21PROC,SET,TIMEOUT=60,DBMS

Response on the z/OS system console is as follows:

DXR177I IR21033 THE VALUE FOR TIMEOUT IS SET TO 60 FOR DBMS

Example 3: Enter the following command on a z/OS system console:

F IR21PROC,SET,LTE=1024

Response on the z/OS system console is as follows:

DXR177I IR21033 THE VALUE FOR LTE IS SET TO 1024

Example 4: Enter the following command on a z/OS system console:

F IR21I,SET,DEADLOCK=1000

Response on the z/OS system console is as follows:

DXR177I IR21033 THE VALUE FOR DEADLOCK IS SET TO 1000 MILLISECONDS

Example 5: Enter the following command on a z/OS console:

F IR21I,SET,PVT=1000

Response from the z/OS system console is as follows:

DXR177I IR21033 THE VALUE FOR PVT IS SET TO 1000

| Example 6: Enter the following command on a z/OS console:

| F IR21I,SET,MLT=4G

| Response from the z/OS system console is as follows:

DXR177I IR21033 THE VALUE FOR MLT IS SET TO 4G

324 Command Reference

Chapter 54. MODIFY irlmproc,STATUS (z/OS IRLM)
The MODIFY irlmproc,STATUS command displays information for one or more
subsystems connected to the IRLM that is specified using irlmproc .

Each subsystem connected to the specified IRLM is listed, including subsystem

name, status, work unit, lock information, the current values of the IRLM
TIMEOUT, and DEADLOCK parameter values. Additionally, you can list an
IRLM’s ID and service level. For a specified IRLM, you can display the current
storage allocated, as well as the greatest amount of storage that was allocated since
the last time this IRLM was started.

Abbreviation: F

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage notes” on page 327
v “Examples” on page 327

Environment

This command can be issued only from a z/OS console.

Data sharing scope: Member or group, depending on which option you choose

Authorization

The command requires an appropriate level of z/OS authority.

Syntax

,irlmx


MODIFY irlmproc,STATUS

,ALLD
,ALLI
,MAINT
,STOR
,TRACE

Option descriptions
irlmproc
Specifies the IRLM that is to process the command.
irlmx
Specifies which IRLM’s status is to be displayed. irlmx is the concatenation of

© Copyright IBM Corp. 1983, 2009 325

 the IRLM subsystem name and IRLM member ID as specified in the IRLM
startup procedure (DB2 installation panel DSNTIPI). An example is DJ2A2 (the
member ID is 2).
ALLD
Requests the DB2 subsystem name and status of a DB2 that is identified to an
IRLM. In a data sharing group, this command lists information about all DB2
subsystems that are currently identified to an IRLM, assuming that the IRLM
on which the command is issued is connected to the data sharing group. You
can determine if the IRLM is connected by issuing a MODIFY
irlmproc,STATUS command and checking that the output shows
SCOPE=GLOBAL.
If a DB2 is down and holds retained locks, that DB2 is also displayed.
However, the IRLM that is displayed with that DB2 can vary depending on
several circumstances:
v Normally, it is the last IRLM to which the DB2 subsystem identified.
v If a rebuild of the lock structure occurred after the retained locks were
created, the IRLM with the lowest member ID at the time the rebuild
occurred is displayed.
v If a group restart is occurring and one DB2 subsystem is recovering on
behalf of another DB2 subsystem, the IRLM that is displayed is the one
associated with the DB2 subsystem doing the peer recovery. For example, if
DB1A is doing a peer recovery of DB2A, the display might show the
following information:
NAME STATUS ... IRLM_NAME
DB1A UP IRLA
DB2A DOWN IRLA
ALLI
Requests the IRLM subsystem name, ID, status, and service level. In a data
sharing group, this command lists information about all IRLM subsystems in
the data sharing group, assuming that the IRLM on which the command is
issued is connected to the data sharing group. You can determine if the IRLM
is connected by issuing a MODIFY irlmproc,STATUS command and checking
that the output shows SCOPE=GLOBAL.
| In a list of IRLM subsystems in a data sharing group, the name of the IRLM
| that is the global deadlock manager is followed by an asterisk (*).
If an IRLM is down, it is displayed only if its associated DB2 subsystem is
down and holds retained locks. The IRLM that is displayed can vary
depending on several circumstances:
v Normally, it is the last IRLM to which the DB2 subsystem identified.
v If a rebuild of the lock structure occurred after the retained locks were
created, the IRLM with the lowest member ID at the time the rebuild
occurred is displayed.
v If the failed DB2 subsystem had recovery done on its behalf by another DB2
subsystem, the IRLM that is displayed is the one associated with the DB2
subsystem that did the peer recovery.
MAINT
For this IRLM only, displays the maintenance levels of IRLM load module
CSECTS in a two-column format.
STOR
For this IRLM only, displays the current and maximum allocation for CSA,
ECSA, and private extended storage.

326 Command Reference

 TRACE
Requests information about IRLM subcomponent trace types. Information
includes whether a subcomponent trace type is active, how many trace buffers
are used by the trace, and whether the component trace external writer is
active for the trace.

Usage notes

Messages: If irlmx is not specified, or if this IRLM is in a non-data-sharing

environment, message DXR101I is issued. That message lists each subsystem
connected to the IRLM specified by irlmx , with an indication as to whether the
connection is active.

Displaying IRLM IDs: If irlmproc is started specifying SCOPE=GLOBAL, the

second line of the display indicates the IRLM IDs of the IRLM subsystems.

Examples

Example 1: Enter the following command on the z/OS system console:

MODIFY IRTPROC,STATUS

Response on the z/OS system console:

DXR101I IR2T001 STATUS SCOPE=LOCAL
DEADLOCK:0500
SUBSYSTEMS IDENTIFIED PT01
NAME T/OUT STATUS UNITS HELD WAITING RET_LKS
DSNT1 0010 UP 0005 0010 0002 0

Explanation: The operator on the z/OS system has requested information about
the DB2 systems connected to the IRLM identified by the IRLM procedure named
IRTPROC.

If the IRLM is SCOPE=GLOBAL on the irlmproc and is not connected to any

group, the status message shows:
DXR101I IR21001 STATUS SCOPE=DISCON

Other information includes:

| DEADLOCK
| IRLM’s deadlock detection interval time. The value is measured in
| milliseconds.
| T/OUT
| The timeout value specified by DBMS for resource timeout. The value is
| measured in seconds.
STATUS
Indicates the status of the DB2 subsystem:
UP The value UP in the STATUS field indicates that the DB2
subsystem is active.
DOWN
The value DOWN in the STATUS field indicates that the DB2
subsystem is failed. All modify type locks held by this DB2
subsystem have been retained by IRLM. The DB2 subsystem is
known to be down only if it holds retained locks.

Chapter 54. MODIFY irlmproc,STATUS (z/OS IRLM) 327

 RET_LKS
The number of retained locks that are owned by this DB2 subsystem.

Example 2: Assume that you have a data sharing group. Enter the following
command on the system console:
MODIFY DB1GIRLM,STATUS,ALLD

Response on system console is as follows:

11.11.07 STC00061 DXR102I DJ1G001 STATUS C
SUBSYSTEMS IDENTIFIED
NAME STATUS RET_LKS IRLMID IRLM_NAME IRLM_LEVL
DB1G UP 0 001 DJ1G 2.022
DB2G UP 0 002 DJ2G 1.022
DXR102I End of display

Explanation: The output shows all the DB2 subsystems that are connected to
IRLMs in this data sharing group (the group to which the IRLM processing the
request belongs). Other information includes:
STATUS
Indicates the status of the DB2 subsystem:
UP The value UP in the STATUS field indicates that the DB2
subsystem is active.
DOWN
The value DOWN in the STATUS field indicates that the DB2
subsystem is failed. All modify type locks held by this DB2
subsystem have been retained by IRLM. The DB2 subsystem is
known to be down only if it holds retained locks.
SYSFAIL
The value SYSFAIL in the STATUS field indicates that the IRLM
that this DB2 subsystem is identified to is disconnected from the
data sharing group. All modify type lock that are held by this DB2
subsystem are retained by IRLM. The DB2 subsystem is known to
be SYSFAIL only if it holds retained locks.
RET_LKS
The number of retained locks that are owned by this DB2 subsystem.
IRLMID
The ID of the IRLM to which this DB2 subsystem is identified.
IRLM_NAME
The name of the IRLM to which this DB2 subsystem is identified.
IRLM_LEVL
The IRLM release and function level that this DB2 subsystem requested on
the identify to IRLM. This is in the form of r.fff .

Example 3: To display information about a specific member of a data sharing

group, enter the following command:
MODIFY DB1GIRLM,STATUS,DJ1G002

Response on system console is as follows:

11.11.21 STC00061 DXR102I DJ1G001 STATUS C
SUBSYSTEMS IDENTIFIED
NAME STATUS RET_LKS IRLMID IRLM_NAME IRLM_LEVL
DB1G UP 0 002 DJ1G 2.022
DXR102I End of display

328 Command Reference

Explanation: This output shows information similar to the output that is shown in
example 1, but this command specifies a specific IRLM in the data sharing group.

Example 4: Again, assume data sharing is in effect. Enter the following command
on the system console:
MODIFY DB1GIRLM,STATUS,ALLI

The response on the console is as follows:

11.11.00 STC00061 DXR103I DJ1G001 STATUS C
IRLMS PARTICIPATING IN DATA SHARING GROUP FUNCTION LEVEL=1.022
IRLM_NAME IRLMID STATUS LEVEL SERVICE MIN_LEVEL MIN_SERVICE
DJ1G 001 UP 2.022 HIR2220 2.022 HIR2220
DJ2G 002 UP 1.022 PQ52360 1.012 PN90337
DXR103I End of display

Explanation: The output shows the IRLMs that are participating in this data
sharing group (the group which includes the IRLM processing the request). Other
information includes:
STATUS
The value “UP” in the STATUS field indicates that the IRLM is active.
STATUS shows “DOWN” if the IRLM is failed. An IRLM is known to be
“DOWN” only if the DB2 subsystem that was identified to it holds
retained locks. This connection between a failed DB2 subsystem and IRLM
is lost after a REBUILD or a group restart.
LEVEL
The current IRLM release and function level in the form of r.fff .
SERVICE
The IRLM service or release that corresponds to the release and function
level that is given in ″LEVEL″.
MIN_LEVEL
The minimum IRLM function level with which this IRLM can coexist.
MIN_SERVICE
The IRLM service or release that corresponds to the function level given in
″MIN-LEVEL.″
Group Function Level
The IRLM release and function level that is in use by all the IRLMs in this
data sharing group.

Example 5: Assume that this command is issued in a non-data-sharing

environment. Enter the following command on the system console:
MODIFY DB1GIRLM,STATUS,ALLI

The response on the console is as follows:

11.11.03 STC00082 DXR103I DJ1G001 STATUS C
IRLMS PARTICIPATING IN DATA SHARING GROUP FUNCTION LEVEL=2.022
IRLM_NAME IRLMID STATUS LEVEL SERVICE MIN_LEVEL MIN_SERVICE
DJ1G 001 UP 2.022 HIR2220 1.022 PQ523690
DXR103I End of display

Explanation: The output shows information only for the specified IRLM. The
group function level that is shown is the function level for the specified IRLM.
Refer to Example 3 for additional information about interpreting output.

Example 6: Enter the following command on the system console:

Chapter 54. MODIFY irlmproc,STATUS (z/OS IRLM) 329

 MODIFY IR21PROC,STATUS,STOR

The response on the console is as follows:

DXR100I PR21001 STOR STATS 150
PC: YES LTEW: 32 LTE: OM RLE: 3046 RLEUSE: 0
BB PVT: 1738M AB PVT (MEMLIMIT): 2G
CSA USE: ACNT: OK AHWM: OK CUR: 312K HWM: 312K
ABOVE 16M: 15 312K BELOW 16M: 0 0K
CLASS TYPE SEGS MEM TYPE SEGS MEM TYPE SEGS MEM
ACCNT T-1 1 2048K T-2 1 1024K T-3 1 4K
PROC WRK 4 20K SRB 1 1K OTH 1 1K
MISC VAR 7 733K N-V 10 247K FIX 1 24K
DXR100I END OF DISPLAY

Explanation: The example shows that current storage allocated for IRLM is 312 KB,
and the greatest amount that has been allocated since the last time IRLM was
started is also 312 KB. The storage for the locking structures (RHB and RLB) is
contained within IRLM private storage. Use the following information to interpret
the display output:
PC Displays the current value for the PC option of the IRLM startup
procedure. For DB2 Versions 8 and 9, this value will always be YES.
BB PVT
Displays the current amount of private storage below the bar. The PVT
value is 1738 MB in this example.
AB PVT (MEMLIMIT)
Displays the current limit to private storage above the bar, also known as
the MEMLIMIT, which is managed by MVS. This storage is used for locks.
The AB PVT value is 2 GB in this example.
LTE The number of lock table entries that were available in the coupling facility
the last time this IRLM was connected to the group. Each unit consists of 1
048 576 entries. If LTE is less than one unit, the value will be zero.
LTEW The lock table entry width is the number of bytes needed for each lock
table entry in the lock structure. The more users in the group, the more
bytes are needed to manage each lock table entry. For up to 6 users, the
LTEW is 2, for up to 22 users, the LTEW is 4, and for up to 32 users, the
LTEW is 8.
RLE The number of record table entries that were available in the coupling
facility the last time this IRLM was connected to the group.
RLEUSE
The number of RLE that are in use in the coupling facility at the time you
issue the MODIFY command. If the IRLM is disconnected from the CF, this
number represents the RLE that were in use when the IRLM last updated
prior to DISCONNECT.
CSA USE
CSA USE is unused in DB2 Versions 8 and 9, and is displayed for
compatibility reasons only.
CUR Shows the total current CSA and ECSA usage. In this case, the current
usage (CUR) is 312 KB, and the high water mark (HWM) is also 312 KB.
The accountable storage is a subset of this total storage.
ACCNT
The ACCNT row of the report is a breakdown of lock control block
structures and their storage use.

330 Command Reference

 T-1 Type one structures are for resources. In this case, it shows that one
storage segment is held for a total of 2048 KB.
T-2 Type two structures are for all resource requests after the first
request for a specific resource. This example shows that one
storage segment is held for a total of 1024 KB.
T-3 Type three structures are for requesters or work units that are
waiting for or hold resources. This example shows that one storage
segment is held for a total of 4 KB.
PROC and MISC rows
These rows contain usage information for private storage that is used to
process DBMS requests. Use this information under the guidance of IBM
Software Support for diagnosing problems.

Example 7: Enter the following command on the system console:

MODIFY PR21PROC,STATUS,TRACE

The command displays the following output on the system console:

DXR179I PR21034 TRACE USAGE
TRACE BUFFER STORAGE IN USE: 256 KB
MAXIMUM NUMBER OF TRACE BUFFERS ALLOWED PER TRACE TYPE: 10
TRACE TYPE ACTIVE BUFFERS IN USE CTRACE WRITER
---------- ------ -------------- -------------
SLM N 0 N
XIT Y 2 N
XCF N 0 N
DBM N 0 N
EXP Y 1 N
INT Y 1 N

Explanation: This example shows that the storage currently allocated for IRLM
tracing is 256 KB, the maximum number of trace buffers allowed per trace type is
set to 10, and the external CTRACE writer is not active.

Use the z/OS TRACE CT command to activate or deactivate traces. You cannot
turn off the EXP and INT traces. The XIT (for data sharing), EXP, and INT traces
are automatically activated when you start IRLM. All traces are automatically
activated with IRLMPROC TRACE=YES.

The trace size for each buffer is 64 KB. Use the MODIFY irlmproc,SET,TRACE=
nnn command to change the maximum number of trace buffers.

Example 8: Enter the following command on the system console:

MODIFY IR21I,STATUS,MAINT

The command displays the following output on the system console:

DXR104I IR21240 MAINTENCE LEVELS
LMOD.Csect MaintLv Date Csect APAR DATE
DXRRLM00.DXRRL010 PQ35083 02/22/00 DXRRL020 PQ35083 02/22/00
DXRRL030 PQ27464 08/18/99 DXRRL040 PQ35083 02/22/00

Explanation: The output shows the maintenance levels of IRLM load module
CSECTS in a two-column format.

Chapter 54. MODIFY irlmproc,STATUS (z/OS IRLM) 331

332 Command Reference
Chapter 55. -MODIFY TRACE (DB2)
The DB2 command MODIFY TRACE changes the IFCIDs (trace events) associated
with a particular active trace.

The DB2 command MODIFY TRACE does the following:

v Changes the trace events (IFCIDs) being traced for a particular active trace.
v Stops any IFCID previously active for the specified trace.
v Writes statistics records.

Abbreviation: -MOD TRA

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 334
v “Option descriptions” on page 334
v “Example” on page 335

Environment

This command can be issued from a z/OS console, a DSN session, a DB2I panel
(DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Traces started by a IFI/IFC program: Before you modify an active trace, ensure
that an IFI application program or the IFC Selective Dump utility (DSN1SDMP)
did not start the trace. If you modify a trace started by DSN1SDMP, the
DSN1SDMP utility abnormally terminates. When DSN1SDMP terminates, it stops
the trace. This stop could interfere with the MODIFY TRACE command, which
stops and restarts the trace.

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v TRACE privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 333

 Syntax

*
,

MODIFY TRACE ( PERFM ) CLASS(  integer ) TNO(integer)

ACCTG
STAT
AUDIT
MONITOR

*
,

IFCID(  ifcid_nbr )

COMMENT(string)

Option descriptions
TRACE
Determines which IFCIDs are started. The following table lists each trace type,
its abbreviation, and a brief description of each type.
One additional trace type is not described in the table because it is intended
for service and is to be used under the direction of IBM Software Support.
Table 23. Trace types
Type Abbreviation Description
PERFM P Performance records of specific events
ACCTG A Accounting records for each transaction
STAT S Statistical data
AUDIT AU Audit data
MONITOR MON Monitor data

CLASS( integer , ...)

Limits the list to IFCIDs started for specified classes.
Abbreviation: C
integer is a class to which the list of IFCIDs started is limited.
The default is CLASS( * ) , which starts all default IFCID classes.
TNO( integer )
Specifies the particular trace to be modified, identified by its trace number (1
to 32, 01 to 09). You can specify only one trace number. TNO is a required
option for the MODIFY TRACE command.
No default exists for the TNO keyword.
IFCID( ifcid_nbr , ...)
Specifies which other IFCIDs (trace events), in addition to those IFCIDs
contained in the classes specified in the CLASS option, are to be started. To

334 Command Reference

 start only those IFCIDs specified in the IFCID option, use trace classes 30-32.
These classes have no predefined IFCIDs and are available for a location to
use.
If you do not specify the IFCID option, only those IFCIDs contained in the
activated trace classes are started.
The maximum number of IFCIDs is 156. The range of values that are valid for
the IFCID option is 1 through 350, with the exception of: 4, 5, 185, 187, 217,
232, 234, 240, and 241.
The default is IFCID( * ).
COMMENT ( string )
Specifies a comment that is reproduced in the trace output record (except in
the resident trace tables).
string is any character string; it must be enclosed between apostrophes if it
includes a blank, comma, or special character.

Example

Example 1:Change trace number six so that it collects only statistics and accounting
data. You can define CLASS(30) at your site.
-MODIFY TRACE(S) IFCID(1,2,3) TNO(6) CLASS(30)
COMMENT ('STATS AND ACCOUNTING ON')

Chapter 55. -MODIFY TRACE (DB2) 335

336 Command Reference
 Chapter 56. REBIND PACKAGE (DSN)
The DSN subcommand REBIND PACKAGE rebinds an application package when
you make changes that affect the package, but have not changed the SQL
statements in the program.

For example, you can use REBIND PACKAGE when you change the
authorizations, create a new index for the package, or use RUNSTATS. When the
REBIND PACKAGE(*) command is issued, trigger packages will not be affected.

REBIND PACKAGE is generally faster and more economical than BIND

PACKAGE. You should use BIND PACKAGE with the ACTION(REPLACE) option
under the following conditions:
v When you change the SQL statements
v When you recompile the program
v When you have previously run BIND PACKAGE with the
SQLERROR(CONTINUE) option

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 339
v “Option descriptions” on page 340
v “Usage notes” on page 340
v “Example” on page 340

Environment

You can use REBIND PACKAGE through DB2I, or enter the REBIND PACKAGE
subcommand from a DSN session running in foreground or background.

Data sharing scope: Group

Authorization

The package owner must have authorization to execute all SQL statements
embedded in the package for REBIND PACKAGE to build a package without
producing error messages. For VALIDATE(BIND), DB2 verifies the authorization at
bind time. For VALIDATE(RUN), DB2 verifies the authorization initially at bind
time, but if the authorization check fails, DB2 rechecks it at run time.

| The package owner must be a role to execute REBIND PACKAGE in a trusted

| context with role ownership.

The following table explains the authorization required to run REBIND PACKAGE,
depending on the options specified.

© Copyright IBM Corp. 1983, 2009 337

 Table 24. Summary of privileges for REBIND PACKAGE
Option Authorization required to run REBIND PACKAGE
REBIND PACKAGE The authorization IDs of the process must have one of the following
with no change in authorities:
ownership because the v Ownership of the package
OWNER keyword is
v BIND privilege on the package
not specified.
v BINDAGENT privilege from the owner of the package
v PACKADM authority on the collection or on all collections
v SYSADM or SYSCTRL authority
REBIND PACKAGE The authorization IDs of the process must have one of the following
with no change in authorities:
ownership, although v OWNER authorization-id must be one of the primary or secondary
the original owner is authorization IDs of the binder
specified for the
v BINDAGENT privilege from the owner of the package
OWNER keyword.
v SYSADM or SYSCTRL authority
REBIND PACKAGE The new OWNER must have one of the following authorities:
with change of v BIND privilege on the package
ownership. (An
v PACKADM authority on the collection or on all collections
authorization ID that
is not the original v SYSADM or SYSCTRL authority
owner is specified in
the OWNER Specifying the OWNER: If any of the authorization IDs have the
keyword.) BINDAGENT privilege granted from the owner, the authorization-id
can specify the grantor as OWNER. Otherwise, OWNER
authorization-id must be one of the primary or secondary
authorization IDs of the binder.

338 Command Reference

 Syntax

REBIND PACKAGE

(  . collection-id . package-id . )

location-name * * ( )
version-id
*
*

enable-block

OWNER(authorization-id) QUALIFIER(qualifier-name) CURRENTDATA( YES )
NO

DBPROTOCOL( DRDA ) DEFER(PREPARE) DEGREE( 1 ) DYNAMICRULES( RUN )
PRIVATE NODEFER(PREPARE) ANY BIND
DEFINE
INVOKE

ENCODING( ASCII ) EXPLAIN( YES ) I IMMEDWRITE( NO )
EBCDIC NO FLAG( W ) YES
UNICODE E
ccsid C

ISOLATION( RR ) NO (1) OPTHINT(’hint-id’)
RS KEEPDYNAMIC( YES ) NONE
CS (2)
UR REOPT( ALWAYS )
NC ONCE
AUTO

, (3) PLANMGMT( )
PATHDEFAULT OFF
PATH(  schema-name ) BASIC
USER EXTENDED


RELEASE( COMMIT ) SWITCH( PREVIOUS ) VALIDATE( RUN )
DEALLOCATE ORIGINAL BIND

Notes:
1 NOREOPT(VARS) can be specified as a synonym of REOPT(NONE)

Chapter 56. REBIND PACKAGE (DSN) 339

 2 REOPT(VARS) can be specified as a synonym of REOPT(ALWAYS)
3 The PATHDEFAULT keyword is mutually exclusive with the PATH keyword. Do not specify both
keywords in the same REBIND command.

enable-block:


,

ENABLE (  BATCH ) 
DISABLE DLIBATCH ,
DB2CALL
CICS DLIBATCH(  connection-name )
IMS ,
IMSBMP
IMSMPP CICS(  applid )
REMOTE ,
RRSAF
ENABLE(*) IMSBMP(  imsid )
,

IMSMPP(  imsid )
,

REMOTE(  location-name )
<luname>

Option descriptions

For descriptions of the options shown in the syntax diagram, see the topic
Chapter 17, “BIND and REBIND options,” on page 85.

Usage notes

Rebinding multiple packages: If you rebind multiple packages, DB2 commits each
successful rebind before rebinding the next package.

| Rebinding a package for a native SQL procedure: If you issue a REBIND

| PACKAGE command against a native SQL procedure’s package, then the only bind
| option you can change is EXPLAIN. If you try to change other bind options the
| command will fail and return message DSNT215I. The REBIND PACKAGE
| command rebinds only the SQL statements included in the procedure and not the
| control statements in the procedure definition.

Example

Rebind packages TEST.DSN8BC81.(MAY_VERSION) and

PRODUCTION.DSN8BC81.(DEC_VERSION), both of which are located at the local
location USIBMSTODB22. The packages can run only from the CICS or the
DLIBATCH environments if the connection ID is CON2. This replaces the CON1
that is specified on the BIND PACKAGE command.
REBIND PACKAGE (USIBMSTODB22.TEST.DSN8BC81.(MAY_VERSION),
USIBMSTODB22.PRODUCTION.DSN8BC81.(DEC_VERSION)) -
ENABLE (CICS,DLIBATCH) CICS (CON2)

340 Command Reference

 Chapter 57. REBIND PLAN (DSN)
The DSN subcommand REBIND PLAN rebinds an application plan when you
make changes that affect the plan, but do not change the SQL statements in the
programs.

For example, you can use REBIND PLAN when you change authorizations, create
a new index for the plan, or use RUNSTATS. If the rebind is successful, the process
prepares an application plan and updates its description in the catalog table
SYSPLAN.

REBIND PLAN is generally faster and more economical than BIND PLAN. But if
you change the SQL statements or recompile a program, you should use BIND
PLAN with the option ACTION(REPLACE).

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 343
v “Option descriptions” on page 344
v “Usage note” on page 344
v “Example” on page 344

Environment

You can use REBIND PLAN through DB2I, or enter the REBIND PLAN
subcommand from a DSN session running in foreground or background.

Data sharing scope: Group

Authorization

The plan owner must have authorization to execute all SQL statements embedded
in the plan for REBIND PLAN to build a plan without producing error messages.
For VALIDATE(BIND), DB2 verifies the authorization at bind time. For
VALIDATE(RUN), DB2 initially verifies the authorization at bind time, but if the
authorization check fails, DB2 rechecks it again at run time. If you use the PKLIST
keyword, you must have EXECUTE authority for the packages or collections
specified on PKLIST.

| The plan owner must be a role to execute REBIND PLAN in a trusted context with
| role ownership.

The following table explains the authorization required to run REBIND PLAN,
depending on the options specified.

© Copyright IBM Corp. 1983, 2009 341

 Table 25. Summary of privileges for REBIND PLAN
Option Authorization required to run REBIND PLAN
REBIND PLAN with no The authorization IDs of the process must have one of the
change in ownership because following authorities:
the OWNER keyword is not v Ownership of the plan
specified.
v BIND privilege on the plan
v BINDAGENT privilege from the owner of the plan
v SYSADM or SYSCTRL authority
REBIND PLAN with no The authorization IDs of the process must have one of the
change in ownership, following authorities:
although the original owner v OWNER authorization-id must be one of the primary or
is specified for the OWNER secondary authorization IDs of the binder
keyword.
v BINDAGENT privilege from the owner of the plan
v SYSADM or SYSCTRL authority
REBIND PLAN with change The new OWNER must have one of the following
of ownership. (An authorities:
authorization ID that is not v BIND privilege on the plan
the original owner is
v SYSADM or SYSCTRL authority
specified in the OWNER
keyword.) Specifying the OWNER: If any of the authorization IDs has
the BINDAGENT privilege granted from the owner, then
authorization-id can specify the grantor as OWNER.
Otherwise, OWNER authorization-id must be one of the
primary or secondary authorization IDs of the binder.
PKLIST, specifying individual Authorization ID of the process must include one of the
packages following authorities:
v EXECUTE privilege on each package specified in the
PKLIST
v PACKADM authority on specific collections containing
packages or on collection *
v SYSADM authority
PKLIST, specifying (*), Authorization ID of the process must include one of the
indicating all packages in the following authorities:
collection v EXECUTE privilege on each package in the collection
v EXECUTE privilege on collection-id .*
v PACKADM authority on collection-id or on *
v SYSADM authority

342 Command Reference

 Syntax

REBIND PLAN (  plan-name ) enable-block pklist-block

* OWNER(authorization-id) QUALIFIER(qualifier-name)

NODEFER(PREPARE) ACQUIRE( USE ) CACHESIZE(decimal-value) CURRENTDATA( NO )
DEFER(PREPARE) ALLOCATE YES

CURRENTSERVER(location-name) DBPROTOCOL( DRDA ) DEGREE( 1 ) DISCONNECT( EXPLICIT )
PRIVATE ANY AUTOMATIC
CONDITIONAL

DYNAMICRULES( RUN ) ENCODING( ASCII ) EXPLAIN( NO ) I
BIND EBCDIC YES FLAG( W )
UNICODE E
ccsid C

IMMEDWRITE( NO ) ISOLATION( RR ) NO (1)
YES RS KEEPDYNAMIC( YES ) NONE
CS (2)
UR REOPT( ALWAYS )
ONCE
AUTO

OPTHINT(’hint-id’) , (3) RELEASE( COMMIT )
PATHDEFAULT DEALLOCATE
PATH(  schema-name )
USER


SQLRULES( DB2 ) VALIDATE( RUN )
STD BIND

Notes:
1 REOPT(VARS) can be specified as a synonym of REOPT(ALWAYS)
2 NOREOPT(VARS) can be specified as a synonym of REOPT(NONE)
3 The PATHDEFAULT keyword is mutually exclusive with the PATH keyword. Do not specify both
keywords in the same REBIND command.

enable-block:

Chapter 57. REBIND PLAN (DSN) 343





,

ENABLE (  BATCH ) 
DISABLE DLIBATCH ,
DB2CALL
CICS DLIBATCH(  connection-name )
IMS ,
IMSBMP
IMSMPP CICS(  applid )
RRSAF ,
ENABLE(*)
IMSBMP(  imsid )
,

IMSMPP(  imsid )

pklist-block:


,

PKLIST(  . collection-id . package-id )

location-name * *
*
NOPKLIST

Option descriptions

For descriptions of the options shown in the syntax diagram, see the topic
Chapter 17, “BIND and REBIND options,” on page 85.

Usage note

If you rebind multiple plans, DB2 commits each successful rebind before rebinding
the next plan.

Example

Rebind plan DSN8BC81 to enable DB2 to take advantage of a newly created index.
Use FLAG(W) to issue warning, error, and completion messages, but not
informational messages. Use VALIDATE(BIND) to point out any error conditions
during the bind process. Use ISOLATION(CS) to prevent other applications from
changing the database values that this application uses only while the application
is using them. This isolation level protects changed values until the application
commits or terminates. Omit the OWNER keyword to leave the plan’s owner
authorization ID the same. Omit the ENABLE or DISABLE keywords to use the
connections previously defined for the plan.
REBIND PLAN (DSN8BC81) -
FLAG (W) -
VALIDATE (BIND) -
ISOLATION (CS)

344 Command Reference

Chapter 58. REBIND TRIGGER PACKAGE (DSN)
The DSN subcommand REBIND TRIGGER PACKAGE rebinds a package that was
created when DB2 executed a CREATE TRIGGER statement.

You can use this subcommand to change a limited subset of the default bind
options that DB2 used when creating the package. You might also rebind a trigger
package to re-optimize its SQL statements after you create a new index or use the
RUNSTATS utility. Additionally, you can rebind a trigger package if it has been
marked invalid because an index, or another object it was dependent on, was
dropped.

If the rebind is successful, the trigger package is marked valid. When REBIND
TRIGGER PACKAGE(*) is issued, the rebind will affect all trigger packages that the
issuer is authorized to rebind. Trigger packages cannot be rebound remotely. The
location name is permitted when specifying the package name on a REBIND
TRIGGER PACKAGE subcommand. However, the location name must not refer to
a remote location.

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 346
v “Option descriptions” on page 346
v “Usage notes” on page 347
v “Output” on page 347
v “Example” on page 347

Environment

You can use REBIND TRIGGER PACKAGE through DB2I, or enter the REBIND
TRIGGER PACKAGE subcommand from a DSN session that is running in
foreground or background.

Data sharing scope: Group

Authorization

To build a package without producing error messages, the package owner must
have authorization to execute all SQL statements that are embedded in the package
for REBIND TRIGGER PACKAGE.

To execute this subcommand, you must use a privilege set of the process that
includes one of the following privileges or authorities:
v Ownership of the trigger package
v BIND privilege on the trigger package
v BINDAGENT privilege from the owner of the trigger package
v PACKADM authority on the collection or on all collections
v SYSADM authority
v SYSCTRL authority
© Copyright IBM Corp. 1983, 2009 345
 When the trigger package is bound, the privileges of the current authorization ID
are used when checking authority to bind statements within the triggered action.
On REBIND TRIGGER PACKAGE, you need one of the following privileges or
authorities:
v Ownership of the package
v BIND privilege on the package
v BINDAGENT privilege granted from owner
v PACKADM authority
v SYSADM authority
v SYSCTRL authority

Syntax

REBIND TRIGGER PACKAGE

( collection-id . package-id )

location-name. * *

NO EXPLAIN( YES ) I
CURRENTDATA( YES ) NO FLAG( W )
E
C

IMMEDWRITE( NO ) ISOLATION( RR )
YES RS
CS
UR
NC

|


PLANMGMT( ) RELEASE( COMMIT )
OFF DEALLOCATE
BASIC
EXTENDED


SWITCH( PREVIOUS )
ORIGINAL

Option descriptions
TRIGGER PACKAGE
Determines what trigger package or packages to rebind. The following options
identify the location, collection, and package name of the package. You can
identify a location and collection. For REBIND TRIGGER, you must identify a
trigger package name.
location-name
Identifies the current local location. Remote rebind of a trigger package is
not allowed. location-name is the location of the DBMS where the package
rebinds and where the description of the package resides.

346 Command Reference

 The default is the local DBMS.
collection-id or *
Identifies the schema-name that already contains the trigger package to
rebind. No default exists.
For REBIND TRIGGER, you can use an asterisk (*) to rebind all local
packages with the specified package-id in all the collections for which you
have bind privileges.
package-id or *
Identifies the name of the trigger package to rebind, as listed in the NAME
column of the SYSPACKAGE catalog table. No default exists.
You can use the pattern-matching character (*) to rebind all local triggers in
collection-id for which you have bind privileges.

For descriptions of the options that are shown in the syntax diagram, see the topic
Chapter 17, “BIND and REBIND options,” on page 85.

Usage notes

Restrictions on trigger packages: A trigger package can be explicitly rebound, but

it cannot be explicitly bound using the BIND PACKAGE subcommand.

A trigger package cannot be explicitly freed using the FREE PACKAGE

subcommand or the DROP PACKAGE statement. Use the DROP TRIGGER
statement to delete the trigger package.

A trigger package cannot be copied, and it can only be rebound locally. Remote
rebind of a trigger package is not allowed.

Rebinding multiple trigger packages: If you rebind multiple trigger packages, DB2
commits each successful rebind before rebinding the next package.

| Restriction on trigger names: Although DBCS characters are generally allowed in

| trigger names, trigger names that contain DBCS characters cannot be used in
| REBIND TRIGGER PACKAGE operations.

Output

REBIND TRIGGER PACKAGE updates the COLLID and NAME columns in the
SYSPACKAGE catalog table.

Example

Enter the following command to rebind trigger package TRIG1 in the ADMF001
collection of packages:
REBIND TRIGGER PACKAGE (ADMF001.TRIG1);

This command produces output that is similar to the following output:

DSNT254I - DSNTBRB2 REBIND OPTIONS FOR
PACKAGE = STLEC1.ADMF001.TRIG1.()
ACTION
OWNER ADMF001
QUALIFIER ADMF001
VALIDATE BIND
EXPLAIN NO
ISOLATION CS

Chapter 58. REBIND TRIGGER PACKAGE (DSN) 347

 RELEASE COMMIT
COPY
DSNT255I - DSNTBRB2 REBIND OPTIONS FOR
PACKAGE = STLEC1.ADMF001.TRIG1.()
SQLERROR NOPACKAGE
CURRENTDATA YES
DEGREE 1
DYNAMICRULES BIND
NODEFER PREPARE
REOPT NONE
KEEPDYNAMIC NO
DBPROTOCOL DRDA
QUERYOPT 1
PATH
"SYSIBM","SYSFUN","SYSPROC","SYSADM","ADMF001"
DSNT232I - SUCCESSFUL REBIND FOR
PACKAGE = STLEC1.ADMF001.TRIG1.()

348 Command Reference

Chapter 59. -RECOVER BSDS (DB2)
The DB2 command RECOVER BSDS reestablishes dual bootstrap data sets (BSDS)
after one has been disabled by a data set error.

Follow these steps to reestablish dual BSDS mode:

1. Use access method services to rename or delete the failing BSDS, which the
DB2 system has deallocated, and define a new BSDS with the same name as
the failing BSDS. You can find control statements in job DSNTIJIN.
2. Issue the DB2 command RECOVER BSDS to make a copy of the remaining
BSDS in the newly allocated data set and to reestablish dual BSDS mode.

Abbreviation: -REC BSDS

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Usage note” on page 350
v “Example” on page 350

Environment
This command can be issued from a z/OS console, a DSN session, a DB2I panel
(DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v BSDS privilege
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

RECOVER BSDS


© Copyright IBM Corp. 1983, 2009 349

 Usage note

Using RECOVER BSDS following a BSDS I/O error: For a detailed description of
the steps you must take to reestablish dual BSDS mode after a BSDS I/O error
occurs, see the topic “Recovering the BSDS from a backup copy” in the DB2
Administration Guide.

Example

Reestablish dual BSDS mode.

-RECOVER BSDS

350 Command Reference

Chapter 60. -RECOVER INDOUBT (DB2)
The DB2 command RECOVER INDOUBT recovers threads that are left in an
indoubt state because DB2 or a transaction manager could not automatically
resolve the indoubt status with the commit coordinator.

This command should only be used when automatic resolution will not work. The
commit coordinator must determine the commit or abort decision.

Abbreviation: -REC IND

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 352
v “Option descriptions” on page 352
v “Usage note” on page 353
v “Examples” on page 354

Environment

This command can be issued from a z/OS console, a DSN session, a DB2I panel
(DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v RECOVER privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 351

 Syntax

RECOVER INDOUBT ACTION( COMMIT )

(connection-name) ABORT

ID(  correlation-id )

*
,

NID(  network-id )
,

LUWID(  luwid )
token

Option descriptions
( connection-name )
Specifies a one- to eight-character connection name. Allied threads (including
those that are distributed) that belong to the connection name are recovered.
This parameter is ignored if LUWID is specified.
The default is the connection name from which you enter the command. If you
enter this command from a z/OS console, and you are recovering an allied
thread using the ID or NID parameter, you must supply a connection name; no
default connection name is available.
ACTION
Specifies whether to commit or cancel the indoubt thread. If there are any
downstream participants for which the local thread is the coordinator, the
commit or abort decision is propagated to these participants.
Abbreviation: ACT
(COMMIT)
Commits the thread.
(ABORT)
Cancels the thread.
ID( correlation-id , ...)
Specifies whether to recover a specific allied thread or all allied threads
(including those that are distributed) that are associated with the connection
name.
correlation-id
Is the correlation ID (1 to 12 characters) of a specific thread that is to be
recovered. If you use more than one correlation ID, separate the IDs with
commas.
Do not use a correlation ID that is associated with more than one network
ID. Instead, use the NID option.

352 Command Reference

 (*) Recovers all indoubt threads that are associated with the connection name.
Even threads that have the same correlation ID are resolved.
NID( network-id , ...)
Specifies threads to recover based on their network IDs.
network-id is a network ID that is associated with an individual thread. You can
use more than one network ID for the same connection name.
For IMS and CICS connections, a network ID is specified as net-node.number ,
which is 3 to 25 characters in length.
v net-node is the network-node name of the system that originated the unit of
work. net-node is one to eight characters in length.
v number is a unique number within the system of origin. number is 1 to 16
characters in length.
For RRSAF connections, a network ID is the z/OS RRS unit of recovery ID
(URID) that is used to uniquely identify a unit of work. A z/OS RRS URID is a
32-character number.
The network ID appears on the recovery log of the commit coordinator as a
16-byte unique identification of a unit of work.
v For IMS and CICS, the network ID is an 8-byte node name immediately
followed by an 8-byte number.
v For RRSAF connections, the network ID is a 16-byte number.
LUWID
Recovers the indoubt thread that has the specified LUWID.
luwid
Consists of an LU network name, an LUW instance number, and a commit
sequence number.
The LU network name consists of a one- to eight-character network ID, a
period, and a one- to eight-character network LU name. The LUW instance
number consists of a period followed by 12 hexadecimal characters. The
last element of the LUWID is the commit sequence number of 4
hexadecimal characters, preceded by a period.
token
A token is an alternate way to express an LUWID. DB2 assigns a token to
each thread that it creates. It is a one- to six-digit decimal number that
appears after the equal sign in all DB2 messages that display a LUWID.
If you enter one- to six-decimal digits, DB2 assumes that you are supplying
a token. The token that DB2 assigns to a specific LUWID is unique for that
DB2 subsystem, but not necessarily unique across all subsystems.

Usage note

When to use a network ID: A network-id is not normally needed, because a

correlation-id can identify indoubt threads. However, if the correlation-id is not
unique, network-id must be used. You do not need a network-id if you specify a
LUWID.

If you specify a thread in the command that is part of a global transaction, the
command is executed against all threads that are in the global transaction.

Chapter 60. -RECOVER INDOUBT (DB2) 353

 Examples

Example 1: Recover indoubt allied threads. Schedule a commit for all threads that
are associated with the connection name from which the command is entered.
-RECOVER INDOUBT ACTION(COMMIT) ID(*)

Example 2: Recover an indoubt thread from a remote requester. Schedule a commit

for the indoubt thread whose token is 1332.
-RECOVER INDOUBT ACTION(COMMIT) LUWID(1332)

Example 3: Recover indoubt threads from remote requesters. Schedule an abort for
two indoubt threads. The first thread has an LUWID of
DB2NET.LUNSITE0.A11A7D7B2057.0002. (The 0002 in the last segment of the
LUWID represents the commit sequence number.) The second thread has a token
of 442.
-RECOVER INDOUBT ACTION(ABORT)
LUWID (DB2NET.LUNSITE0.A11A7D7B2057.0002, 442)

354 Command Reference

Chapter 61. -RECOVER POSTPONED (DB2)
The DB2 command RECOVER POSTPONED completes back-out processing for
units of recovery that are left incomplete during an earlier restart (POSTPONED
ABORT units of recovery). Use this command when automatic resolution is not
selected.

Abbreviation: -REC POST

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions” on page 356
v “Usage note” on page 356
v “Output” on page 356
v “Example” on page 356

Environment

This command can be issued from a z/OS console, a DSN session, a DB2I panel
(DB2 COMMANDS), or an IMS or CICS terminal.

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v RECOVER privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

RECOVER POSTPONED

CANCEL

© Copyright IBM Corp. 1983, 2009 355

 Option descriptions
CANCEL
Specify to stop DB2 processing of all postponed abort units of recovery
immediately. Canceling postponed abort units of recovery leaves objects in an
inconsistent state.
Objects that the postponed units of recovery modify are recovered (backed
out). If back out processing fails, the objects are marked as REFRESH
PENDING (REFP) and either RECOVER PENDING (RECP) or REBUILD
PENDING (RBDP or PSRBD) in the database exception table. Resolve the REFP
status of the object by running the RECOVER utility to recover the object to a
prior point in time or by running LOAD REPLACE on the object.

Usage note

Recovery action: Recovery (rollback) action is always taken for all POSTPONED
ABORT units of recovery.

Output

The output from RECOVER POSTPONED consists of informational messages only.

Progression of RECOVER POSTPONED: Message DSNI024I indicates the

completion of backout work against the page set or partition, and the removal of
the page set or partition from the restart-pending status.

If backout processing lasts for an extended period of time, progress message

DSNR047I is displayed at periodic intervals until backout processing is complete.

DB2 issues message DSN9022I after successful completion of the RECOVER

POSTPONED command, or message DSN9023I if the command completed
unsuccessfully. Message DSNV434I indicates that RECOVER POSTPONED was
issued when no postponed-abort units of recovery needed to be resolved.

Example

Enter the following command to recover postponed-abort units of recovery.

-RECOVER POSTPONED

If postponed-abort units of recovery are found, output that is similar to the

following output is generated:
DSNV435I - RESOLUTION OF POSTPONED ABORT URS HAS BEEN SCHEDULED
DSNI024I - DSNIARPL BACKOUT PROCESSING HAS COMPLETED
FOR PAGESET DBKD0103.IPKD013A PART 00000004.
DSNI024I - DSNIARPL BACKOUT PROCESSING HAS COMPLETED
FOR PAGESET DBKD0103.TPKD0103 PART 00000004.
DSNI024I - DSNIARPL BACKOUT PROCESSING HAS COMPLETED
FOR PAGESET DBKD0103.IXKD013C PART (n/a).
DSNI024I - DSNIARPL BACKOUT PROCESSING HAS COMPLETED
FOR PAGESET DBKD0103.IUKD013B PART (n/a).
DSNI024I - DSNIARPL BACKOUT PROCESSING HAS COMPLETED
FOR PAGESET DBKD0103.IPKD013A PART 00000002.
DSNI024I - DSNIARPL BACKOUT PROCESSING HAS COMPLETED
FOR PAGESET DBKD0103.TPKD0103 PART 00000002.
DSNI024I - DSNIARPL BACKOUT PROCESSING HAS COMPLETED
FOR PAGESET DBKD0101.IXKD011C PART (n/a).
DSNI024I - DSNIARPL BACKOUT PROCESSING HAS COMPLETED
FOR PAGESET DBKD0101.IXKD011B PART (n/a).

356 Command Reference

DSNI024I - DSNIARPL BACKOUT PROCESSING HAS COMPLETED
FOR PAGESET DBKD0101.IUKD011A PART (n/a).
DSNI024I - DSNIARPL BACKOUT PROCESSING HAS COMPLETED
FOR PAGESET DBKD0101.TLKD0101 PART (n/a).
DSN9022I - DSNVRP 'RECOVER POSTPONED' NORMAL COMPLETION

If no postponed units of recovery are found, the following output is returned:

DSNV434I - DSNVRP NO POSTPONED ABORT THREADS FOUND
DSN9022I - DSNVRP 'RECOVER POSTPONED' NORMAL COMPLETION

Chapter 61. -RECOVER POSTPONED (DB2) 357

358 Command Reference
 Chapter 62. -REFRESH DB2,EARLY (DB2)
The DB2 command -REFRESH DB2,EARLY reloads the EARLY code modules, and
rebuilds the EARLY control block.

When this command is run, previous copies of the EARLY modules are deleted
from the system the next time that DB2 is started. This command is only valid
when DB2 is inactive and the normal DSNY003I message will be issued if the
REFRESH command is issued when DB2 is active.

| This command is also available in conversion mode.

Abbreviation: -REF DB2

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage notes” on page 360
v “Examples” on page 360

Environment

This command can only be issued from a z/OS console. The name of the DB2
subsystem is determined by the command prefix. For example, -START indicates
that the DB2 subsystem to be started is the one with ’-’ as the command prefix.

The command is rejected if the DB2 subsystem is already active. The EARLY code
can only be properly updated when DB2 is not active

Data sharing scope: Member

Authorization

None is required. However, the command can be executed only from a z/OS
console with the START command capability. This command is rejected when DB2
is active, so no other authorization is required.

Syntax

-REFRESH DB2,EARLY


Option descriptions

The following option is required.

© Copyright IBM Corp. 1983, 2009 359

 EARLY
Indicates that the EARLY block will be rebuilt, and that all of the modules
loaded at IPL time will be reloaded.

Usage notes

Scope of the -REFRESH command: The -REFRESH command has member-only

scope, and needs to be executed for every instance where a unique recognition
character for the -START command has been defined.

Examples

Example 1: Refresh the DB2 subsystem.

-REFRESH DB2,EARLY

360 Command Reference

Chapter 63. -RESET GENERICLU (DB2)
The RESET GENERICLU command allows you to purge information stored by
VTAM in the coupling facility for one or more partners of a particular DB2
subsystem.

The command must be issued from the DB2 subsystem that has the VTAM affinity
to the particular partner LU whose information you are purging.

Abbreviation: -RESET GENERIC

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions” on page 362
v “Usage notes” on page 362
v “Examples” on page 362

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

RESET GENERICLU (  luname )


netid.luname
(*)

© Copyright IBM Corp. 1983, 2009 361

 Option descriptions
( luname )
Specifies the real VTAM LU name of the partner whose generic LU name
mapping is to be purged. The NETID of this partner LU must be the same as
the local DB2 NETID.
( netid.luname )
Specifies that the VTAM shared memory information that is associated with
the specified NETID and LUNAME is purged.
(*) Purges the VTAM shared memory information for all partners of this DB2
subsystem. This command option should only be used if you are planning to
remove this DB2 subsystem from the DB2 group.

Usage notes

The following conditions must be satisfied for the RESET GENERICLU command
to be successful:
v DDF must be started.
v No VTAM sessions can be active to the partner LU that is specified on the
command.
v DB2 must not have any indoubt thread resolution information associated with
the specified partner LU.

Examples

Example 1: Purge the VTAM generic name mapping that is associated with partner
NET1.USER5LU.
-DB2A RESET GENERICLU(NET1.USER5LU)

Example 2: Purge the VTAM generic name mappings for all LUs that are partners
of this DB2 subsystem. Use this version of the command only when removing this
DB2 subsystem from the data sharing group.
-DB2A RESET GENERICLU(*)

362 Command Reference

Chapter 64. -RESET INDOUBT (DB2)
The DB2 command RESET INDOUBT purges the information that is displayed in
the indoubt thread report that is generated by the DISPLAY THREAD command.

This command must be used to purge indoubt thread information in the following
situations:
v For threads where DB2 has a coordinator responsibility that it cannot fulfill
because of participant cold start, sync point protocol errors, or indoubt
resolution protocol errors.
v For threads that were indoubt but were resolved with the RECOVER INDOUBT
command, and subsequent resynchronization with the coordinator shows
heuristic damage.
The RESET column of a display thread report for indoubt threads indicates
whether information in the report must be purged with this command.

This command can also be used to purge indoubt thread information for threads
where:
v DB2 has a coordinator responsibility even when no errors have been detected
that preclude automatic resolution with the participants. The FORCE keyword
must be specified to purge this information. Resynchronization with affected
participants is not performed.
v DB2 has a participant responsibility even when no errors have been detected
that preclude automatic resolution with the coordinator. Resynchronization with
the coordinator will not be performed.

Abbreviation: -RESET IND

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 364
v “Option descriptions” on page 364
v “Output” on page 365
v “Usage notes” on page 365

Environment
This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v RECOVER privilege
v SYSOPR authority
© Copyright IBM Corp. 1983, 2009 363
 v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

| Syntax
|

| ,

RESET INDOUBT LUNAME(  luname )


* FORCE
,

LOCATION(  location-name )
,

IPADDR(  ipaddr..port )
* FORCE
,

LUWID(  luwid )
token LOCATION(location-name)
|

Option descriptions
LUNAME( luname , ...)
Purges all qualifying indoubt information that pertains to the specified
LUNAME.
luname
Is expressed as a one- to eight-character name. If you use more than one
LUNAME, separate each name with a comma.
(*) Purges indoubt information for all SNA locations.
FORCE
Forces the purging of coordinator and participant indoubt resolution
responsibility even when no errors that preclude automatic resolution have
been detected. FORCE can be used in conjunction with IPADDR or LUNAME.
Purging resynchronization information when no errors that preclude automatic
resynchronization have been detected simulates a cold start. Thus, no
connections can exist between DB2 and the named partner when this
command is executed. After you run the FORCE option, the next connection
with the named partner location will be a cold start connection. If a connection
with the named partner exists at the time this command is run, the command
fails with message DSNL448I.
FORCE can be used to bypass warm start connectivity problems when errors
that are occurring in the recovery log name exchange result in the partner
refusing the connection attempt.
LOCATION( location-name , ...)
Purges all qualifying indoubt information that pertains to the named location.

364 Command Reference

 location-name is expressed as a 1- to 39-character name, which identifies the
partner, whether it is a requester or server. If the partner is not a DB2 for z/OS
subsystem, the location name can be expressed as one of the following formats:
v A one- to eight-character luname, as defined to VTAM at the server location.
This name must be enclosed in the less-than (<) and the greater-than (>)
characters to distinguish it from a DB2 location name.
v A dotted decimal or colon hexadecimal IP address.
| IPADDR( ipaddr..port )
| Purges all qualifying indoubt information that pertains to the dotted decimal
| or colon hexadecimal IP address that is associated with the resync port
| number.
| This keyword can be used in place of the LUNAME keyword when the partner
| uses TCP/IP instead of SNA.
| ipaddr..port
| Is the dotted decimal or colon hexadecimal IP address of the remote site,
| followed by the resync port number. The IP address and port must be
| delimited by a double period (..). If you use more than one IP address and
| port number, use commas to separate the items in the list.
| (*) Purges indoubt information for all TCP/IP locations.
LUWID
Purges indoubt information for the thread with the specified LUWID.
luwid
Consists of an LU network name, an LUW instance number, and a commit
sequence number.
The LU network name consists of a 1- to 8-character network ID, a period,
and a 1- to 8-character network LU name. The LUW instance number
consists of a period followed by 12 hexadecimal characters. The last
element of the LUWID is the commit sequence number, which consists of a
period followed by four hexadecimal characters.
token
A token is an alternate way to express an LUWID. DB2 assigns a token to
each thread that it creates. It is a one- to six-digit decimal number that
appears after the equal sign in all DB2 messages that display an LUWID.
If you enter one- to six-decimal digits, DB2 assumes that you are supplying
a token. The token that DB2 assigns to a specific LUWID is unique for that
DB2 subsystem, but it is not necessarily unique across all subsystems.

Output

The response from this command includes any of the messages from DSNL440I
through DSNL449I.

If you specify RESET INDOUBT incorrectly, you receive message DSNL440I.

Usage notes

Purging participant indoubt information: Use caution when you specify the
FORCE option to purge participant indoubt information. Normally, after the use of
the RECOVER INDOUBT command, automatic resolution with the coordinator

Chapter 64. -RESET INDOUBT (DB2) 365

 determines if heuristic damage has occurred. This detection is lost if RESET
INDOUBT is used before automatic resolution with the coordinator can be
achieved.

Purging coordinator indoubt information: Use caution when you specify the
FORCE option to purge coordinator indoubt information when no errors are
precluding automatic resolution. When the information is purged, any participant
that is indoubt is forced to use a heuristic decision process to resolve the indoubt
logical unit of work.

366 Command Reference

Chapter 65. RUN (DSN)
The DSN subcommand RUN executes an application program, which can contain
SQL statements.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage note” on page 369
v “Examples” on page 369

Environment

This subcommand can be issued under the DSN command processor running in
either foreground or background mode, or it can be issued by using the DB2I RUN
panel.

Data sharing scope: Member

Authorization
To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v EXECUTE privilege on the plan
v Ownership of the plan
v SYSADM authority
To run an application, the plan must be enabled for your local server. Any
associated packages from which you execute statements must also be enabled.

Syntax

RUN PROGRAM(program-name)

PLAN(plan-name)
CP PLAN(plan-name)


LIBRARY(library-name) PARMS(parameter-string)

Option descriptions

Use at least one of the two following clauses, but do not use the same clause twice.
PROGRAM ( program-name )
Identifies the program that you want to run.

© Copyright IBM Corp. 1983, 2009 367

 CP
Directs input to the user’s command processor, and causes a prompt to be
issued: ENTER TSO COMMAND. This is useful for running command processors and
debugging programs (for example, COBTEST).
Processing the specified TSO command creates a new task control structure
under which the TSO command executes. All application programs that are
initiated from this TSO command session also execute under the same task
structure, and must establish a new connection to DB2 if they use SQL
requests.
When the TSO command completes, the new task structure is terminated, and
control is returned to the original DB2 connection and task structure
established by the DSN command.
Later TSO commands can be issued directly from the DSN session, or through
the RUN subcommand with the CP option.
PLAN( plan-name )
Is optional after the PROGRAM option, but required after the CP option.
plan-name is the name of the application plan for the program.
When PROGRAM is used, the default plan name is program-name .
LIBRARY( library-name )
Specifies the name of the data set that contains the program to be run.
If library-name is not specified, normal z/OS library searching is used. The data
sets that are specified in the STEPLIB DD statements are first searched for the
entry point name of the program. If STEPLIB is not present, the data sets that
are specified in the JOBLIB DD statements are searched. If the entry point
name is not found there, the link list is searched.
Subprograms: Normal z/OS library searching is always used for any
subprograms that is loaded by the main program. If the subprograms reside in
the same library as the main program, the library-name must also be defined
for the normal z/OS search pattern (STEPLIB, JOBLIB, link list). If a library
that is defined in that way contains both the main program and any loaded
subprograms, you do not need to use the LIBRARY option.
PARMS( parameter-string )
parameter-string is a list of parameters that are to be passed to your application
program. Separate items in the list with commas, blanks, or both, and enclose
the list between apostrophes. If the list contains apostrophes, represent each
apostrophe by using two consecutive apostrophes. The list is passed as a
varying-length character string of 1 to 100 decimal characters.
For Assembler: Use a list of the form ’program parameters’. There are no
run-time parameters.
No run-time or application parameter validation is performed by the RUN
subcommand on the parameter-string that is passed to your application
program. All specified parameter values are assumed to adhere to the
parameter syntax and format criteria defined by the language in which the
application program is written.
For C: Use a list of the form A/B, where A represents a list of run-time
options, and B represents a list of parameters for the C application program. If
run-time options are not needed, write the list in the form /B. If the
NOEXECOPS run-time option is in effect, omit the “/”.

368 Command Reference

 For COBOL: If Language Environment is not the run-time environment, use a
list of the form B/A, where B represents a list of parameters for the COBOL
application program, and A represents a list of run-time options. If program
parameters are not needed, write the list in the form of /A.
If Language Environment is the run-time environment, use a list of the form
A/B, where A represents a list of run-time options, and B represents a list of
parameters for the COBOL application program. If run-time options are not
needed, write the list in the form of /B. For compatibility, Language
Environment provides the CBLOPTS run-time option. When CBLOPT(YES) is
specified in CEEDOPT or CEEUOPT and the main routine is COBOL, specify
the list in the form of B/A, the same form as when the run-time environment
is not Language Environment. CBLOPT(NO) is the default.
For Fortran: Use a list of the form A/B, where A represents a list of Fortran
run-time options and B represents a list of parameters for the Fortran
application program. If Fortran run-time options are not needed, write the list
in the form of B or /B. The second form must be used if a slash is present
within the program arguments. If only Fortran run-time options are present,
write the list in the form of A/.
For PL/I: Use a list of the form A/B, where A represents a list of run-time
options, and B represents a list of parameters for the PL/I application program.
If run-time options are not needed, write the list in the form /B. If the PL/I
NOEXECOPS procedure option is specified, omit the “/”. An informational
system message is issued if you omit the slash, or if the value that is passed to
the PL/I run-time package is not valid.

Usage note

Multitasking restriction: When running a program that uses a multitasking

environment, the first task to issue an SQL statement must issue all subsequent
SQL calls. That is, only one task in a multitasking environment can issue SQL calls.
This task must be a subtask of, or running at the same TCB level as, the DSN main
program.

Examples

Example 1: Run application program DSN8BC4. The application plan has the same
name. The program is in library ’ prefix .RUNLIB.LOAD’.
DSN SYSTEM (DSN)
RUN PROGRAM (DSN8BC4) LIB ('prefix.RUNLIB.LOAD')

Example 2: Run application program DSN8BP4. The application plan is DSN8BE81.

The program is in library ’ prefix .RUNLIB.LOAD’. Pass the parameter O’TOOLE to
the PL/I application program with no PL/I run-time options.
DSN SYSTEM (DSN)
RUN PROGRAM (DSN8BP4) PLAN (DSN8BE81) -
LIB ('prefix.RUNLIB.LOAD') PARMS ('/O'TOOLE')

Chapter 65. RUN (DSN) 369

370 Command Reference
Chapter 66. -SET ARCHIVE (DB2)
The DB2 command SET ARCHIVE sets the maximum number of tape units for the
archive log. It also sets the maximum deallocation time of tape units for the
archive log.

This command overrides the values that are specified during installation or in a
previous invocation of the SET ARCHIVE command. The changes that SET
ARCHIVE makes are temporary; at restart, DB2 again uses the values that are set
during installation.

Abbreviation: -SET ARC

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 372
v “Option descriptions” on page 372
v “Usage notes” on page 373
v “Output” on page 373
v “Examples” on page 373

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v ARCHIVE privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 371

 Syntax

SET ARCHIVE


COUNT (integer) TIME( minutes )
,seconds
,seconds
1440
NOLIMIT
DEFAULT

Option descriptions

The following options override the READ TAPE UNITS(COUNT) and DEALLC
PERIOD TIME subsystem parameters that are specified during installation.
COUNT( integer )
Specifies the maximum number of tape units that can be dedicated to reading
archive logs. This value affects the number of concurrent reads that are
allowed for unique archive data sets that reside on tapes.
integer can range from 1 to 99.
v If the number that you specify is greater than the current specification, the
maximum number of tape units allowable for reading archive logs increases.
v If the number that you specify is less than the current specification, tape
units that are not being used are immediately deallocated to adjust to the
new COUNT value. Active (or premounted) tape units remain allocated;
only tape units that are inactive are candidates for deallocation because of a
lowered COUNT value.
TIME
Specifies the length of time during which an allocated archive read tape unit is
allowed to remain unused before it is deallocated.
( minutes )
Specifies the maximum number of minutes.
minutes must be an integer between 0 and 1439.
( seconds )
Specifies the maximum number of seconds.
seconds must be an integer between 1 and 59.
(NOLIMIT) or (1440)
Indicates that the tape unit will never be deallocated. Specifying
TIME(1440) is equivalent to TIME(NOLIMIT). The seconds specification is
not allowed when you specify that TIME is 1440.
DEFAULT
Resets the COUNT and TIME parameters back to the values that were
specified during DB2 installation.

372 Command Reference

Usage notes

Archive tape reading performance: To achieve the best performance for reading
archive tapes, specify the maximum values that are allowed (within system
constraints) for both the COUNT and TIME options.

IEF238D “REPLY DEVICE NAME OR CANCEL” message: Replying “CANCEL” to

this message resets the COUNT value to the current number of tape units. For
example, if the current COUNT value is 10, but you reply “CANCEL” to the
request for the seventh tape unit, the COUNT value is reset to 6.

Delaying tape deallocation in a data sharing environment: When you submit a

recover job on a member of a data sharing group that requires a tape unit that
must remain unused for a certain length of time before it is deallocated, the
archive tape is not available to any other member of the group until the tape is
deallocated. Unless all recover jobs will be submitted from the same member, you
might not want to use the COUNT option and ensure that field DEALLOC
PERIOD on installation panel DSNTIPA has a value of 0.

Output

The response from this command includes any of the messages from DSNJ334I
through DSNJ337I.

Examples

Example 1: Allocate two tape units that can remain unused for 30 seconds before
they are deallocated.
-SET ARCHIVE COUNT(2) TIME(,30)

Example 2: Allocate four tape units that can remain unused for 2 minutes before
they are deallocated.
-SET ARCHIVE COUNT(4) TIME(2)

Example 3: Allocate one tape unit that is never deallocated.

-SET ARCHIVE COUNT(1) TIME(1440)

Chapter 66. -SET ARCHIVE (DB2) 373

374 Command Reference
Chapter 67. -SET LOG (DB2)
The DB2 command SET LOG modifies the checkpoint frequency that is specified
during installation.

This command also overrides the value that was specified in a previous invocation
of the SET LOG command. The changes that SET LOG makes are temporary; at
restart, DB2 again uses the values that were set during installation. The LOGLOAD
value takes effect following the next system checkpoint. SET LOG can also be used
to SUSPEND or RESUME logging and update activity for the current DB2
subsystem.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions” on page 376
v “Usage notes” on page 377
v “Examples” on page 377

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program that uses
the instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v ARCHIVE privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

SET LOG LOGLOAD(integer)


CHKTIME(integer)
SUSPEND
RESUME

© Copyright IBM Corp. 1983, 2009 375

 Option descriptions

The following option overrides the LOGLOAD subsystem parameter that is

specified in the CHECKPOINT FREQ field on installation panel DSNTIPN.
LOGLOAD( integer )
Specifies the number of log records that DB2 writes between the start of
successive checkpoints. You can specify a value of 0 to initiate a system
checkpoint without modifying the current LOGLOAD value.
integer can be 0, or within the range from 200 to 16000000.
CHKTIME( integer )
Specifies the number of minutes between the start of successive checkpoints.
This option overrides log records that are specified by installation options or
the LOGLOAD option that are based on checkpoint frequency.
integer can be any integer value from 0 to 60. Specifying 0 starts a system
checkpoint immediately without modifying the checkpoint frequency.
SUSPEND
Specify to suspend logging and update activity for the current DB2 subsystem
until SET LOG RESUME is issued. DB2 externalizes unwritten log buffers,
takes a system checkpoint (in non-data-sharing environments), updates the
BSDS with the high-written RBA, and then suspends the update activity.
Message DSNJ372I is issued and remains on the console until update activity
resumes.
SUSPEND quiesces the writes for 32-KB pages and the data set extensions for
all page sizes. If a 32-KB page write is in progress when you take volume-level
copies of your data, SUSPEND prevents an inconsistent copy of a 32-KB page
when the copy of your data is restored. If a data set extension is in progress,
SUSPEND prevents inconsistencies between the VSAM catalog and the DB2
data set when the copy of your data is restored.
This option is not allowed when the ARCHIVE LOG or STOP DB2 commands
activate a system quiesce. Update activity remains suspended until SET LOG
RESUME or STOP DB2 is issued. (Also, when logging is suspended, do not
issue the ARCHIVE LOG command without also specifying CANCEL
OFFLOAD.)
Recommendation: Do not keep log activity suspended during periods of high
activity or for long periods of time. Suspending update activity can cause
timing-related events such as lock timeouts or DB2 and IRLM diagnostic
dumps.
RESUME
Specify to resume logging and update activity for the current DB2 subsystem
and to remove the message DSNJ372I from the console. Resumes 32-KB page
writes and data set extensions for pages of all sizes.
Recommendation: Issue this command from a z/OS console or from the
installation SYSADM ID to avoid possible contention during command
authorization checking. When logging is suspended by the SET LOG
SUSPEND command, the contention that is generated by holding the log-write
latch can cause command-authorization checking to hang until logging
resumes.

376 Command Reference

 Usage notes

How LOGLOAD and CHKTIME values affect DB2 performance: LOGLOAD and
CHKTIME values can affect the amount of time needed to restart DB2 after
abnormal termination. A large value for either option can result in lengthy restart
times. A low value can result in DB2 taking excessive checkpoints. However, when
you specify LOGLOAD(0) or CHKTIME(0), the checkpoint request is synchronous
when issued from a batch job, and it is asynchronous when issued from a z/OS or
TSO console.

| The behavior of LOGLOAD(0) and CHKTIME(0) is different in a data sharing

| environment. Avoid issuing SET LOG LOGLOAD(0) or SET LOG CHKTIME(0) in
| the data sharing environment if logging has been suspended with SET LOG
| SUSPEND on any member in the group. If you specify LOGLOAD(0) or
| CHKTIME(0), the synchronous checkpoint might be suspended until all logging
| has been resumed when you issue the SET LOG RESUME command.

Use the DISPLAY LOG command to display the current LOGLOAD setting.

The value that you specify for LOGLOAD or CHKTIME is reset to the value
specified in the subsystem parameter when DB2 is restarted. If you load a different
value by issuing the command SET SYSPARM, the new value is used.

When to suspend logging: Specify SET LOG SUSPEND before making a remote
copy of the entire database and logs for a system-level, point-in-time recovery or
disaster recovery. You can make remote copies with peer-to-peer remote recovery
(PPRC) and FlashCopy®. Suspending logging to make a remote copy of the
database lets you avoid quiescing update activity. Read-only activity continues
while logging is suspended.

The backup that is made between the SET LOG SUSPEND and the SET LOG
RESUME window might contain uncommitted data. If you must restore the entire
DB2 subsystem to the time when the log was suspended, restore the entire
database and logs from the backup, and then restart DB2 to recover the entire DB2
subsystem to a consistent state.

| Avoiding deadlock when using SET LOG SUSPEND in a data sharing

| environment: To avoid deadlock in a data sharing environment, issue the SET LOG
| SUSPEND command on one data sharing member first, wait until it completes,
| and then issue the command for the remaining members.

Examples

Example 1: Initiate a system checkpoint without modifying the current LOGLOAD

value.
-SET LOG LOGLOAD(0)

Example 2: Modify the system checkpoint interval to every 150000 log records.
-SET LOG LOGLOAD(150000)

Example 3: Suspend logging activity.

-SET LOG SUSPEND

Example 4: Resume logging activity.

-SET LOG RESUME

Chapter 67. -SET LOG (DB2) 377

378 Command Reference
Chapter 68. -SET SYSPARM (DB2)
The DB2 command SET SYSPARM lets you change subsystem parameters while
DB2 is up.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage notes” on page 380
v “Examples” on page 380

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program that uses
the instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization
To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

SET SYSPARM LOAD( DSNZPARM )


load-module-name
RELOAD
STARTUP

Option descriptions
LOAD( load-module-name )
Specifies the name of the load module to load into storage. The default load
module is DSNZPARM.
RELOAD
Reloads the last named subsystem parameter load module into storage.

© Copyright IBM Corp. 1983, 2009 379

 STARTUP
Resets loaded parameters to their startup values.

Usage notes

To update the subsystem parameters on a subsystem, follow these steps:

1. Run through the installation process in Update mode.
2. Produce a new subsystem parameter load module.
3. Issue the SET SYSPARM command.

If you attempt to change installation SYSADM or installation SYSOPR subsystem

parameters and you do not have the proper authority, the parameter values that
are in place prior to the load of the new subsystem-parameter module are used
instead of the unauthorized values in the new module. DB2 issues message
DSNZ015 for each attempt of an unauthorized change to a subsystem parameter.

Examples

Example 1: Change from DSNZPARM to ADMPARM1.

-SET SYSPARM LOAD(ADMPARM1)

Example 2: Reload ADMPARM1 if it is the currently running load module.

-SET SYSPARM RELOAD

Example 3: Reload the subsystem parameters that the DB2 subsystem loaded at
startup.
-SET SYSPARM STARTUP

380 Command Reference

Chapter 69. SPUFI (DSN)
The DSN subcommand SPUFI executes the SQL processor using file input.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Usage notes”

Environment

You can use this subcommand only under ISPF. You can issue it from ISPF option
6, or from a CLIST.

Data sharing scope: Member

Authorization

None is required.

Syntax

SPUFI


Usage notes

SPUFI session: The SPUFI subcommand runs SPUFI and presents the SPUFI panel
as the start of a SPUFI session.

In the SPUFI session, you can access the CURRENT SPUFI DEFAULTS panel. You
can change DB2I defaults by splitting the screen and accessing the DB2I
DEFAULTS panel, or by changing the defaults before starting the SPUFI session.

SPUFI panel variables: The SPUFI panel variables you enter after invoking SPUFI
directly with the DSN command are not saved in the same place. Panel variables,
therefore, vary depending on whether you execute the facility directly, or through
DB2I.

© Copyright IBM Corp. 1983, 2009 381

382 Command Reference
Chapter 70. /SSR (IMS)
The IMS /SSR command allows the IMS operator to enter an external subsystem
command.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option description”
v “Usage note”

Environment

This command can be issued only from an IMS terminal.

Data sharing scope: Member

Authorization

This command requires an appropriate level of IMS authority.

In addition, the set of privileges held by the primary authorization ID or any of

the secondary authorization IDs must include the authority to enter the DB2
command that follows /SSR.

Syntax

/SSR subsystem-command


Option description
subsystem-command
Specifies a valid subsystem command. The first character following /SSR must
be the subsystem recognition character of the subsystem to which the
command is to be directed (in this case DB2). The IMS subsystem recognition
character is defined in the IMS SSM member for the external subsystem.

Usage note

Routing the command: IMS uses the command recognition character (CRC) to
determine which external subsystem, in this case DB2, receives the command. The
only action taken by IMS is to route the command to the appropriate subsystem.

© Copyright IBM Corp. 1983, 2009 383

384 Command Reference
Chapter 71. START admtproc
The START admtproc command starts the scheduler that is specified in the admtproc
parameter.

This command can be started at the operator’s console, or during DB2 startup or
initialization. Once started, the administrative task scheduler is always up, unless it
is stopped by a STOP command at the operator’s console.

Each DB2 subsystem has a coordinated administrative task scheduler address space
for starting a z/OS started task procedure, therefore if there are many DB2
subsystems running on one z/OS, there is a separate administrative task scheduler
with a separate name for each. Two instances of the same administrative task
scheduler cannot run simultaneously. To avoid starting up a duplicate
administrative task scheduler, at startup the administrative task scheduler checks
all of the address spaces for duplicate names. If another address space with the
same name is already running, the administrative task scheduler that is starting up
will immediately shut down with a console error message. The administrative task
scheduler can only check the address spaces in the same system, but not the entire
Sysplex.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions” on page 386
v “Examples” on page 386

Environment

This command can be issued only from a z/OS console.

Data sharing scope: Member

Authorization

The command requires an appropriate level of operating system authority.

Syntax

START admtproc,

TRACE= ON
OFF

Options must be separated by commas, with no spaces.

© Copyright IBM Corp. 1983, 2009 385

 Option descriptions
admtproc
Specifies the procedure name of the administrative task scheduler task that you
want to start.
trace
Traces can be turned on or off using this option.

Examples

Example: This command starts the admtproc scheduler.

Enter the following command on the system console:

start admtproc

386 Command Reference

Chapter 72. /START (IMS)
The IMS /START command (with the SUBSYS parameter) makes the connection
between IMS and the specified external subsystem available. Establishing the
connection allows application programs to access resources managed by the
external subsystem.

The following information is only a partial description of the /START command.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage note” on page 388

Environment

This command can be issued only from an IMS terminal.

Data sharing scope: Member

Authorization

This command requires an appropriate level of IMS authority.

Syntax

/START

,

SUBSYS  subsystem-name
SUBSYS ALL

Option descriptions
SUBSYS
Specifies one or more names of external subsystems to be connected to IMS, or
all external subsystems.
subsystem-name , ...
Identifies one or more names of external subsystems to be connected to
IMS.
ALL
Indicates that all external subsystems are to be connected to IMS.

© Copyright IBM Corp. 1983, 2009 387

 Usage note

Inactive entries: The copy in main storage of the external subsystem PROCLIB
entry is refreshed as part of /START command function when that entry is not
active (that is, when the connection does not exist). This allows the installation to
stop the subsystem connection, change the specifications in the PROCLIB entry,
and restart the subsystem connection without bringing down IMS.

388 Command Reference

Chapter 73. -START DATABASE (DB2)
The START DATABASE command makes the specified database available for use.

Depending on which options you specify, the following objects can be made
available for read-only processing, read-write processing, or utility-only processing:
v Databases
v Table spaces
v Index spaces
v Physical partitions of partitioned table spaces or index spaces (including index
spaces housing data-partitioned secondary indexes (DPSIs))
v Logical partitions of nonpartitioned secondary indexes.

The command is typically used after one of the following events:

v The STOP DATABASE command is issued
v A table space, partition, or index is placed in group buffer pool
RECOVER-pending status (GRECP)
v Pages have been put on the logical page list (LPL) for a table space, partition, or
index

In a data sharing environment, the command can be issued from any DB2
subsystem in the group that has access to the specified database.

Abbreviation: -STA DB

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 391
v “Option descriptions” on page 391
v “Usage notes” on page 394
v “Examples” on page 396

Environment

This command can be issued from a z/OS console, a DSN session, a DB2I panel
(DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v STARTDB privilege
v DBMAINT authority
v DBCTRL authority

© Copyright IBM Corp. 1983, 2009 389

 v DBADM authority
v SYSCTRL authority
v SYSADM authority
When you are using a privilege set that does not contain the STARTDB privilege
for a specified database, DB2 issues an error message.

| For implicitly created databases, the database privilege or authority can be held on
| the implicitly created database or on DSNDB04. If the START DATABASE
| command is issued on specific table spaces or index spaces in an implicitly created
| database, ownership of the table spaces is sufficient to start them. This means that
| the owner can display information about an implicitly created table space or index
| space if the command explicitly specifies that table space or index space name.

All specified databases with the STARTDB privilege included in the privilege set of
the process are started.

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

When data definition control is active, installation SYSOPR or installation SYSADM

authority is required to start a database, a table space, or an index space containing
a registration table or index.

Table space DBD01 in database DSNDB01 and table spaces and index spaces in
database DSNDB06 are required to check the authorization for using the START
DATABASE command. If a table space or index space required for this
authorization check is stopped, or is unavailable because it is in LPL or GRECP
status, installation SYSADM authority is required to start any database, table space,
or index space, including the ones required for the authorization check.

390 Command Reference

| Syntax
|

| ,
|


START DATABASE (  database-name )

*
dbname1:dbname2
dbname*
*dbname
*dbname*
*dbstring1*dbstring2*

|


| ,

SPACENAM(  space-name )
* , CLONE
spacename1:spacename2
spacename* PART(  integer )
*spacename integer1:integer2
*spacename*
*spacestring1*spacestring2*

|


| RW
ACCESS( RO )
UT
FORCE

Option descriptions
( database-name , ...)
Specifies the name of a database, or a database for the table spaces or index
spaces that are to be started. If you use more than one name, separate names
in the list with commas.
(*) Starts all databases for which the privilege set of the process has at least
DBMAINT authority or STARTDB privilege (except databases that are
already started). You cannot use (*) with ACCESS(FORCE).
You can start DSNDB01, DSNDB06, and work file databases, such as
DSNDB07, only by explicitly specifying them (for example, START
DATABASE(DSNDB01)).

dbname and dbstring can have any of the forms in the following list (where
dbname1 and dbname2 represent any 1- to 8-character string, and dbname
represents any 1- to 7-character string):
Form Starts
dbname1:dbname2
| All databases whose names, in UNICODE, are greater than or equal to
| dbname1 and less than or equal to dbname2
dbname*
All databases whose names begin with the string dbname

Chapter 73. -START DATABASE (DB2) 391

 *dbname
All databases whose names end with the string dbname
*dbname*
All databases whose names contain the string dbname
*dbstring1*dbstring2*
All databases whose names contain the strings dbstring1 and dbstring2
SPACENAM
Specifies the particular table spaces or indexes within the database that are to
be started. If you use ACCESS(FORCE), you must use SPACENAM with a list
of table space and index names.
Abbreviation: SPACE, SP
( space-name , ...)
Specifies the name of a table space or index space that is to be started. You
can use a list of several names of table spaces and index spaces. Separate
names in the list with commas.
You can specify space-name like database-name to designate:
v The name of a single table space or index space
v A range of names
v A partial name, including a beginning or ending pattern-matching
character (*)
v Two strings separated by a pattern-matching character (*)
v Any combination of the previous items in this list, with the following
exceptions. Consecutive pattern-matching characters (*) are not allowed,
and you cannot specify two pattern-matching characters (*) in the
middle of a keyword string.
You cannot use a partial name or a range of names with the
ACCESS(FORCE) option.
(*) Starts all table spaces and index spaces in the specified database. You
cannot use (*) with ACCESS(FORCE).

spacename and spacestring can have any of the forms in the following list
(where spacename1 and spacename2 represent any 1- to 8-character string,
and spacename represents any 1- to 7-character string):
Form Displays the status of
spacename1:spacename2
| All table spaces or index spaces whose names, in UNICODE, are
| greater than or equal to spacename1 and less than or equal to
| spacename2
spacename*
All table spaces or index spaces whose names begin with the string
spacename
*spacename
All table spaces or index spaces whose names end with the string
spacename
*spacename*
All table spaces or index spaces whose names contain the string
spacename

392 Command Reference

 *spacestring1*spacestring2*
All table spaces or index spaces whose names contain the strings
spacestring1 and spacestring2
PART ( integer , ...)
Specifies the partition number of one or more partitions, within the
specified table space or index, that are to be started. The start or stop state
of other partitions does not change.
The specified integer must identify a valid partition number for the
corresponding space name and database name. If you specify nonvalid
partition numbers, you receive an error message for each nonvalid number,
but all other valid partitions that you specified are started.
integer can be written to designate one of the following specifications:
v A list of one or more partitions
v A range of all partition numbers that are greater than or equal to integer1
and less than or equal to integer2
v A combination of lists and ranges
The PART option is valid with partitioned table spaces, partitioned
indexes, and nonpartitioned type 2 indexes of partitioned table spaces. If
you specify PART with a nonpartitioned table space or index on a
nonpartitioned table space, you receive an error message, and the
nonpartitioned space is not started.
| CLONE
| Starts clone objects. In the absence of the CLONE keyword, base table
| objects are started and the clone table objects are not processed. If you
| specify the CLONE keyword then only clone objects are processed.
ACCESS
Specifies whether the objects that are started are in read/write, read only, or
utility only status. Also forces access to objects that are in unavailable status.
Abbreviation: ACC
(RW)
Allows programs to read from and write to the specified databases, table
spaces, indexes, or partitions.
(RO)
Allows programs to only read from the specified databases, table spaces,
indexes, or partitions. Any programs attempting to write to the specified
objects will not succeed. Do not use this option for a database for declared
temporary tables (databases created with the AS TEMP option).
(UT)
Allows only DB2 online utilities and the SQL DROP statement to access the
specified databases, table spaces, indexes, or partitions.
(FORCE)
Resets any indications that a table space, index, or partition is unavailable
because of pages in the logical page list, pending-deferred restarts,
write-error ranges, read-only accesses, or utility controls. FORCE also resets
the CHECK-pending, COPY-pending, and RECOVER-pending states. Full
access to the data is forced. FORCE cannot be used to reset the
restart-pending (RESTP) state.
When using ACCESS(FORCE), you must use a single database name, the
SPACENAM option, and an explicit list of table space and index names.

Chapter 73. -START DATABASE (DB2) 393

 You cannot use any range or combination of pattern-matching characters
(*), including DATABASE (*) or SPACENAM (*).
A utility-restrictive state is reset (and the utility is terminated) only if all of
the target objects are reset with this command. To identify which objects
are target objects of the utility, use the DISPLAY DATABASE command, or
run the DIAGNOSE utility with the DISPLAY SYSUTIL option. The
DIAGNOSE utility should be used only under the direction of IBM
Software Support.
Note: ACCESS(FORCE) will not successfully complete if the object you are
trying to force was placed in a utility-read-only (UTRO), utility-read-write
(UTRW), or utility-utility (UTUT) state by a utility running in a previous
release of DB2. If this situation is encountered, DB2 issues message
DSNI041I. To reset the restrictive state, you must terminate the utility using
the release of DB2 in which it was started.
A table space or index space that is started with ACCESS(FORCE) might
be in an inconsistent state.

Usage notes

Data sets offline: Disk packs that contain partitions, table spaces, or indexes, do
not necessarily need to be online when a database is started. Packs must, however,
be online when partitions, table spaces, or indexes are first referred to. If they are
not online, an error in opening occurs.

Table spaces and indexes explicitly stopped: If table spaces and indexes are
stopped explicitly (using the STOP DATABASE command with the SPACENAM
option), they must be started explicitly. Starting the database does not start table
spaces or indexes that have been explicitly stopped.

Effect on objects marked with GRECP or with LPL entries: If a table space,
partition, or index is in the group buffer pool RECOVER pending (GRECP) status,
or if it has pages in the logical page list (LPL), the START DATABASE command
begins recovery of the object. You must specify the SPACENAM option and
ACCESS (RW) or (RO).

This recovery operation is performed even if SPACENAM specifies an object that is

already started.

If the object is stopped when the command is issued, then the START DATABASE
command both starts the object and clears the GRECP or LPL status. If the GRECP
or LPL recovery action cannot complete, the object is still started.

If any table space or index space that is required to check command authority is
unavailable, Installation SYSADM or Installation SYSOPR authority will be
required to issue the START DATABASE command.

When recovering objects that are in GRECP or LPL status, avoid using
pattern-matching characters (*) for both the database name and the space name.
Multiple START DATABASE(dbname) SPACENAM(*) commands running in parallel
should complete faster than one START DATABASE(*) SPACENAM(*) command.

If you use pattern-matching characters (*) for both the database name and space
name, you must have DBMAINT authority and ensure that the catalog and
directory databases have already been explicitly started in the following order:

394 Command Reference

 -START DATABASE(DSNDB01) SPACENAM(*)
-START DATABASE(DSNDB06) SPACENAM(*)

Although not recommended, you can start an object using START DATABASE
ACCESS(FORCE). That deletes all LPL and write error page range entries without
recovering the pages. It also clears the GRECP status.

| When a table space or partition is placed in the LPL because undo processing is
| needed for a NOT LOGGED table space, the -START DATABASE command does
| not remove the table space or partition from the LPL.

When starting a LOB table space defined as LOG NO and either in GRECP or
having pages in the LPL, the LOB table space will be placed in the AUXW state
and the LOB will be invalidated if DB2 detects that log records required for LPL
recovery are missing due to the LOG NO attribute.

Use of ACCESS(FORCE): The ACCESS(FORCE) option is intended to be used

when data has been restored to a previous level after an error, by DSN1COPY, or
by a program that is not DB2 for z/OS, and the exception states resulting from the
error still exist and cannot be reset. When using ACCESS(FORCE), it is up to the
user to ensure the consistency of data with respect to DB2.

If an application process requests a transaction lock on a table space that is in a

restrictive status (RECP) or has a required index in a restrictive status, DB2
acquires the lock. DB2 does not detect the status until the application tries to
access the table space or index, when the application receives an error message
indicating that the resource is not available (SQLCODE -904). After receiving this
message, the application should release the lock, either by committing or rolling
back (if the value of the RELEASE option is COMMIT) or by ending (if the value
of RELEASE is DEALLOCATE). If you issue the command START DATABASE
ACCESS(FORCE) for either the table space or the index space while the lock is in
effect, the command fails.

If an object has retained locks (that is, a member of a DB2 data sharing group has
failed and the locks it held on the object are retained in the lock structure), START
DATABASE ACCESS (FORCE) is not allowed.

START DATABASE ACCESS(FORCE) does not execute if postponed abort or

indoubt units of recovery exist. If you attempt to issue the START DATABASE
ACCESS(FORCE) command in this situation, the command fails. FORCE cannot be
used to reset the restart pending (RESTP) state.

Restricted mode (RO or UT): When a START DATABASE command for a restricted
mode (RO and UT) takes effect depends on whether applications are started after
the START DATABASE command has completed, or whether applications are
executing at the time the command is issued. For applications that are started after
START DATABASE has completed, access restrictions are effective immediately. For
applications that are executing at the time START DATABASE is issued, the access
restrictions take effect when a subsequent claim is requested or the application is
allowed to run to completion. Whether the application is interrupted by the START
DATABASE command depends on various factors. These factors include the
ACCESS mode that is specified on the START DATABASE command, the type of
drain activity, if any, on the table space or partition, and whether any cursors are
being held on the table space or partition.

Chapter 73. -START DATABASE (DB2) 395

 Do not start table spaces or index spaces for defined temporary tables with RO or
UT access. You can start a temporary file database with UT access to accommodate
the REPAIR DBD utility.

If the table space, index, or partition must be accessed in a mode that is

incompatible with the ACCESS type currently in effect, DB2 issues a
resource-unavailable message.

For shared-owner databases, a STOP DATABASE command must be issued to

quiesce a database or table space prior to issuing the START DATABASE
command.

Communications database or resource limit facility: If the communications

database (CDB) or resource limit facility (RLF) is currently being used by any
member of the data sharing group, any attempt to start either active database or
table space with ACCESS(UT) fails.

Synchronous processing completion: Message DSN9022I indicates that synchronous

processing has completed successfully.

Asynchronous processing completion: Recovery of objects in GRECP status or with

pages on the LPL is performed asynchronously. Message DSNI022I is issued
periodically to give you the progress of the recovery. The starting of databases,
table spaces, or indexes (a synchronous task) often completes before the recovery
operation starts. Therefore, when DB2 issues message DSN9022I, which indicates
that synchronous processing has completed, the recovery of objects might not be
complete. Message DSNI006I is issued in response to START DATABASE when the
object (table space or index space) identified by TYPE and NAME had group
buffer pool RECOVER pending (GRECP) or logical page list (LPL) status, and
recovery was triggered. The START DATABASE command does not complete until
the asynchronous task of recovery completes.

Message DSNI021I indicates that asynchronous processing for an object has

completed. You can issue the command DISPLAY DATABASE to determine
whether the recovery operation for all objects is complete. If it is complete, the
output from the command shows either a RW or a RO status without LPL or
GRECP.

Starting a LOB table space: The START DATABASE command can be used to start
LOB table spaces and indexes on auxiliary tables. LOB table spaces are started
independently of the base table space with which the LOB table space is
associated.

Examples

Example 1: Start table space DSN8S81E in database DSN8D81A. Recover the table
space if it is in GRECP status or recover the pages on the LPL if one exists.
-START DATABASE (DSN8D81A) SPACENAM (DSN8S81E)

Example 2: Start all databases (except DSNDB01, DSNDB06, and work file
databases) for which you have authority. Recovery for any objects with GRECP or
LPL status is not performed.
-START DATABASE (*)

396 Command Reference

 Example 3: Start the third and fourth partitions of table space DSN8S81E in
database DSN8D81A for read-only access. Recover the partitions if they are in
GRECP status or recover the pages on the LPL if one exists.
-START DATABASE (DSN8D81A) SPACENAM (DSN8S81E) PART (3,4) ACCESS (RO)

Example 4: Start all table spaces that begin with ″T″ and end with the string
″IQUA03″ in database DBIQUA01 for read and write access.
-START DATABASE (DBIQUA01) SPACENAM (T*IQUA03) ACCESS (RW)

This command produces output that is similar to the following output:

DSN9022I - DSNTDDIS 'START DATABASE' NORMAL COMPLETION

| Example 5: Start clone objects.

-START DATABASE (MYDB*) SPACENAM (MYDB*SP) CLONE

Chapter 73. -START DATABASE (DB2) 397

398 Command Reference
Chapter 74. -START DB2 (DB2)
The DB2 command START DB2 initializes the DB2 subsystem. When the operation
is complete, the DB2 subsystem is active and available to TSO applications and to
other subsystems (for example, IMS and CICS).

The effect of restarting the system can be controlled by a conditional restart control
record, which you create by using the DSNJU003 (change log inventory) utility. For
more details about the effects, see “Usage notes” on page 401.

Abbreviation: -STA DB2

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 400
v “Option descriptions” on page 400
v “Usage notes” on page 401
v “Examples” on page 402

Environment

This command can be issued only from a z/OS console. The name of the DB2
subsystem is determined by the command prefix. For example, -START indicates
that the DB2 subsystem to be started is the one with ’-’ as the command prefix.

The command is rejected if the DB2 subsystem is already active. The restart
recovery status of DB2 resources is determined from the prior DB2 shutdown
status.

Data sharing scope: Member

Authorization

None is required. However, the command can be executed only from a z/OS
console with the START command capability.

© Copyright IBM Corp. 1983, 2009 399

 Syntax

|

START DB2

PARM( module name ) *
ACCESS( )
MAINT

|


NO MSTR(jcl-substitution)
LIGHT( )
YES
NOINDOUBTS


DBM1(jcl-substitution) DIST(jcl-substitution)

Option descriptions

None of the following options are required.

PARM ( module-name )
Specifies the load module that contains the DB2 subsystem parameters.
| The default is the name of the parameter module that was specified on panel
| DSNTIPO while running the installation Clist. The default can also be changed
| if you update PARM=’ZPARM(new default module name)’ in DB2 subsystem
| MSTR proc.
ACCESS
Specifies whether access to DB2 is to be general or restricted.
Abbreviation: ACC
(*)
Makes access general; all authorized users can connect to DB2.
The default is ACCESS( * ) .
(MAINT)
Prohibits access to any authorization IDs other than installation SYSADM
and installation SYSOPR.
For data sharing, ACCESS(MAINT) restricts access on only the DB2
member on which you execute this command. Other members of the data
sharing group are unaffected.
LIGHT
Specifies whether a light restart is to be performed in a data sharing
environment.
(NO)
Restart light is not performed.
(YES)
Specifies that a restart light is to be performed. DB2 starts with reduced
storage, waits for resolution of indoubt units of recovery, and terminates
normally after freeing retained locks.

400 Command Reference

| (NOINDOUBTS)
| Specifies that DB2, during a restart light, does not wait for indoubt units of
| recovery to resolve before it terminates.
| Abbreviation: NOI
MSTR ( jcl-substitution )
Gives parameters and values to be substituted in the EXEC statement of the
JCL that executes the startup procedure for the system services address space.
DBM1 ( jcl-substitution )
Gives parameters and values to be substituted in the EXEC statement of the
JCL that executes the startup procedure for the database services address
space.
DIST ( jcl-substitution )
Gives parameters and values to be substituted in the EXEC statement of the
JCL that executes the startup procedure for the distributed services address
space.
( jcl-substitution )
One or more character strings of the form keyword = value , enclosed
between apostrophes. If you use more than one character string, separate
each string with a comma and enclose the entire list between a single pair
of apostrophes.
Recommendation: Omit the keyword and use the parameters that are
provided in the startup procedure.

Usage notes

Command prefix: If your installation has more than one DB2 subsystem, you must
define more than one command prefix.

Conditional restart: A conditional restart control record can prevent a complete

restart and specify current status rebuild only. In that case, the following actions
occur during restart:
v Log records are processed to the extent that is determined by the conditional
restart control record.
v The following values are displayed:
– The relative byte address (RBA) of the start of the active log
– The RBA of the checkpoint record
– The status counts for units of recovery
– The display table for restart unit of work elements
v The restart operation terminates with an abend.

Light restart with ARM: To enable a light restart in an ARM environment, you
must code an ARM policy for DB2 and IRLM.

The following example shows an ARM policy for DB2, where the element name is
the DB2 data sharing group name and member name concatenated. For example,
DSNDB0GDB1G.
ELEMENT(elementname)

RESTART_METHOD(SYSTERM,STC,'cmdprfx STA DB2,LIGHT(YES)')

Chapter 74. -START DB2 (DB2) 401

 The following example shows an ARM policy for IRLM, where the element name
is the IRLM group name and the ID concatenated. For example,
DXRDB0GDJ1G001.
ELEMENT(elementname)

RESTART_METHOD(SYSTERM,STC,'cmdprfx S irlmproc')

The element name that DB2 uses is the DB2 data sharing group name and member
name concatenated. For example, DSNDB0GDB1G.F

Endless wait during start: The start operation might begin and fail to complete, if
the system services address space starts and the database services address space
cannot start. If a seemingly endless wait occurs, cancel the system services address
space from the console, and check both startup procedures for JCL errors.

Starting members of a data sharing group: To start members of a data sharing

group, you must enter a START DB2 command for each subsystem in the group. If
it is the first startup of the group, you must start the originating member (the first
DB2 that was installed) first.

Examples

Example 1: Start the DB2 subsystem.

-START DB2

Example 2: Start the DB2 subsystem, and provide a new value for the REGION
parameter in the startup procedure for the system services address space.
-START DB2 MSTR('REGION=6000K')

Example 3: Start the DB2 subsystem. Assuming that the EXEC statement of the JCL
that executes the startup procedure for the system services address space uses the
symbol RGN, provide a value for that symbol.
-START DB2 MSTR('RGN=6000K')

Example 4: DB2 subsystems DB1G and DB2G are members of a data sharing
group. Both were installed with a command prefix scope of STARTED. Start DB1G
and DB2G by routing the appropriate commands to the z/OS system on which
they are to be started, MVS1 and MVS2.
ROUTE MVS1,-DB1G START DB2
ROUTE MVS2,-DB2G START DB2

402 Command Reference

Chapter 75. -START DDF (DB2)
The DB2 command START DDF starts the distributed data facility (DDF) if it is not
already started.

Abbreviation: -STA DDF

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Usage note”
v “Example”

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

START DDF


Usage note

The START DDF command activates the DDF interface to VTAM and TCP/IP.
When this command is issued after STOP DDF MODE(SUSPEND), suspended
threads are resumed and DDF activity continues.

Example

Start the distributed data facility.

-START DDF

© Copyright IBM Corp. 1983, 2009 403

404 Command Reference
Chapter 76. -START FUNCTION SPECIFIC (DB2)
The DB2 command START FUNCTION SPECIFIC starts an external function that is
stopped. Built-in functions or user-defined functions that are sourced on another
function cannot be started with this command.

On successful completion of the command, queued requests for the specified

functions begin executing. The abend counts for those functions are set to zero.

You do not need to issue the START FUNCTION SPECIFIC command when
defining a new function to DB2. DB2 automatically starts the new function on the
first SQL statement that invokes the new function.

Historical statistics in the DISPLAY FUNCTION SPECIFIC report (MAXQUE,

TIMEOUT) are reset each time a START FUNCTION SPECIFIC command is issued
for a given function.

Abbreviation: -STA FUNC SPEC

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 406
v “Option descriptions” on page 406
v “Usage notes” on page 406
v “Examples” on page 407

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel, an IMS or CICS terminal, or a program that uses the instrumentation
facility interface (IFI).

Data sharing scope: Group or local, depending on the value of the SCOPE option.

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities for each function:
v Ownership of the function
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

If you specify START FUNCTION SPECIFIC *.* or schema.partial-name *, the

privilege set of the process must include one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

© Copyright IBM Corp. 1983, 2009 405

 DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

(*.*)


START FUNCTION SPECIFIC

,

(  schema.specific-function-name )
schema.partial-name*

LOCAL

SCOPE ( GROUP )


Option descriptions
* (asterisk)(*.*)
Starts all functions in all schemas. This is the default.
( schema.specific-function-name )
Starts the specific function name in the schema. You cannot specify a function
name in the same way that you do in SQL; you must use the specific name. If
a specific name was not specified on the CREATE FUNCTION statement,
query SYSIBM.SYSROUTINES for the correct specific name:
SELECT SPECIFICNAME, PARM_COUNT
FROM SYSIBM.SYSROUTINES
WHERE NAME='function_name'
AND SCHEMA='schema_name';

For overloaded functions, this query can return multiple rows.

( schema.partial-name *)
Starts all functions or a set of functions in the specified schema. The specific
names of all functions in the set begin with partial-name and can end with any
string, including the empty string. For example, schema1.ABC* starts all
functions with specific names that begin with ABC in schema1.
SCOPE
Specifies the scope of the command.
( LOCAL )
Specifies that the command applies only to the current member.
(GROUP)
Specifies that the command applies to all members of the data sharing
group.

Usage notes

Language Environment in the WLM-established stored procedure address space :

The START FUNCTION SPECIFIC command does not refresh the Language
Environment in the WLM-established stored procedure address space. You must
issue the WLM command. For example, if you need to refresh the Language
Environment to get new copies of user-defined function load modules, issue the
following WLM command:

406 Command Reference

VARY WLM, APPLENV=applenv,REFRESH

Examples

Example 1: Start all functions.

-START FUNCTION SPECIFIC

Output that is similar to the following output is generated:

DSNX973I - DSNX9ST2 START FUNCTION SPECIFIC SUCCESSFUL FOR *.*
DSN9022I - DSNX9COM '-START FUNC' NORMAL COMPLETION

Example 2: Start functions USERFN1 and USERFN2. If any requests are queued for
these functions, the functions are executed.
-START FUNCTION SPECIFIC(PAYROLL.USERFN1,PAYROLL.USERFN2)

Output that is similar to the following output is generated:

DSNX973I - DSNX9ST2 START FUNCTION SPECIFIC SUCCESSFUL FOR
PAYROLL.USERFN1
DSNX973I - DSNX9ST2 START FUNCTION SPECIFIC SUCCESSFUL FOR
PAYROLL.USERFN2
DSN9022I - DSNX9COM '-START FUNC' NORMAL COMPLETION

Chapter 76. -START FUNCTION SPECIFIC (DB2) 407

408 Command Reference
Chapter 77. START irlmproc (z/OS IRLM)
The START irlmproc command starts an IRLM component with a procedure that is
defined by the installation. Symbolic parameters in the procedure can be
overridden on the START irlmproc command.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions” on page 410
v “Examples” on page 413

Environment

This command can be issued only from a z/OS console.

Data sharing scope: Member

Authorization

The command requires an appropriate level of operating system authority.

Syntax

START irlmproc, 

DEADLOK=’iiii,kkkk’
IRLMGRP=’irlm-group-name’
IRLMID=n
IRLMNM=irlmname
LOCKTABL=irlmltnm
LTE=nnnn
MAXCSA=
MAXUSRS=nnn
PC=
PGPROT= YES
NO
SCOPE= LOCAL
GLOBAL
NODISCON
TRACE= NO
YES

Options must be separated by commas, with no spaces.

© Copyright IBM Corp. 1983, 2009 409

 Option descriptions
irlmproc
Specifies the procedure name of the IRLM to be started.

None of the following options are required:

DEADLOK=’ iiii,kkkk ’
Specifies the local deadlock-detection interval in seconds ( iiii ), and the
number of local cycles ( kkkk ) that are to occur before a global detection is
initiated.
| iiii
| Is a one- to four-digit number. Values between 1 and 5 are interpreted as
| seconds. Values between 100 and 5000 are interpreted as milliseconds.
| Depending on the value that you enter, IRLM might substitute a smaller
| maximum value.
| kkkk
| Is a one- to four-digit number from 1 to 9999 that specifies the number of
| local deadlock cycles that must expire before global deadlock detection is
| performed. You can specify any value from 1 to 9999, but IRLM uses 1.
| The recommended value to specify is 1.

In a data sharing environment, IRLM synchronizes all of the DEADLOK values

in the group to the values specified on the most recent IRLM to join the group.
The DEADLOK values can be changed by starting a member with the values
desired. To reduce confusion, it is recommended that the installation specify
the same value for DEADLOK on all of its IRLM startup procedures and use
the START irlmproc command to override this value only when the interval
must be increased from its original value.
IRLMGRP=’ irlm-group-name ’
Specifies the name of the cross system coupling facility (XCF) group, in a
data sharing environment, to which the IRLM belongs as the lock manager
for DBMSs that share the same data. All IRLMs in the same group must
specify the same value for LOCKTABL and unique values for IRLMID.
The group name is used as the XCF group name. The name must not start
with ’SYS’ and must not be the same name specified for LOCKTABL.
In a non-data-sharing environment (SCOPE=LOCAL), IRLMGRP is
ignored.
IRLMID= n
Specifies a decimal number that is used to distinguish between IRLMs in a
data sharing group.
n can be either a one- to three-digit number from 1 to 255, or a printable
character in quotation marks. Note that this IRLM ID does not relate
directly to the limit of IRLM members that can be in the group. That limit
is determined by the current hardware limits (currently 32).
When n is specified as a printable character, IRLM uses the EBCDIC value
of the printable character as the IRLMID (such as X’C4’). The printable
character must be surrounded by enough single quotes to permit IRLM to
see it as a printable character. Because of the way that the operating system
interprets quotes, single quotes must be on either side of the characters.
For example, if you want to specify the printable character ’D’, you must
specify it here as IRLMID=’D’.

410 Command Reference

 A unique IRLMID must be specified for each IRLM in a group (IRLMs
with the same value specified for the IRLMGRP option).
IRLMNM= irlmname
Specifies a 4-byte z/OS subsystem name assigned to this IRLM. (Although
z/OS can accept names that are less than 4 bytes, IRLM requires a 4-byte
name.)
LOCKTABL= irlmltnm
Specifies the lock table to be used by this group. This option is overridden
by DB2; it is needed in an IMS environment.
In a non-data-sharing environment (SCOPE=LOCAL), LOCKTABL is
ignored.
LTE= nnnn
Specifies the number of lock table entries that are required in the coupling
facility (CF) lock structure in units of 1048576 entries. LTE= can have a
value of blank, zero, or any exact power of two up to 1024 (inclusive). The
number of lock table entries in the group is determined by the first IRLM
to connect to the group during initial structure allocation or during
REBUILD.
The LTE value is used in the following order:
1. The value that is specified using MODIFY irlmproc,SET,LTE= if the
value is greater than zero.
2. The value from LTE= in the irlmproc if the value is greater than zero.
3. The value that is determined by the existing logic, which divides the
XES structure size returned on the IXCQUERY call by two times LTE
width. The result is rounded to the nearest power of two, which the
existing logic uses for the value.

Note: The LTE width is determined by the MAXUSRS value.

If IRLM attempts to use a value from MODIFY irlmproc,SET,LTE= that is
greater than the available storage in the structure size returned by XES
IXCQUERY, the value for the LTE= in the irlmproc is used. If this value is
greater than the available storage, IRLM uses the value that is determined
by the existing logic.
Table 26. Some common values for lock table entries and the required lock table storage
Lock Table Storage needed Lock Table Storage needed
For LTE= for 2-byte entries for 4-byte entries
8 16 MB 32 MB
16 32 MB 64 MB
32 64 MB 128 MB
64 128 MB 256 MB
128 256 MB 512 MB
256 512 MB 1024 MB

MAXCSA=
MAXCSA= is a required positional parameter but is currently unused.
MAXUSRS= nnn
Specifies the initial maximum number of members in the data sharing
group, set by the IRLM which results in structure allocation. The specified

Chapter 77. START irlmproc (z/OS IRLM) 411

 value determines the size of each lock entry in the lock table portion of the
lock structure, as shown in the following table.
Table 27. Effect of MAXUSRS on initial size of lock table entry
MAXUSRS Initial size of lock entry
7 or less 2 bytes
≥ 8 and < 24 4 bytes
≥ 24 and < 33 8 bytes

nnn must be a one- to two-digit number from 1 to 32. The default is 7. The
recommended value is 7 or less.
In a non-data-sharing environment (SCOPE=LOCAL), MAXUSRS is
ignored.
PC=
PC= is a required positional parameter but is currently unused.
PGPROT=
Specifies whether the IRLM load modules that are resident in common
storage are placed in z/OS page-protected storage.
YES The IRLM load modules that are resident in common storage are
placed in z/OS page-protected storage.
NO The IRLM load modules that are resident in common storage are
not placed in z/OS page-protected storage.
SCOPE=
Specifies whether the IRLM is to be used in a data sharing environment.
LOCAL
Specifies the IRLM is in a non-data-sharing environment and there is
no intersystem sharing.
GLOBAL
Specifies the IRLM is in a data sharing environment and that
intersystem sharing is to be performed.
NODISCON
Specifies that IRLM is in a data sharing environment and that
intersystem sharing is to be performed. IRLM remains connected to the
data sharing group even when no database management systems are
identified to it. You must explicitly stop IRLM to bring it down.
If you specify the NODISCON option, there is less impact on other
systems when a DB2 subsystem fails because the operating system is
not required to perform certain recovery actions that it normally
performs when IRLM comes down. Using the NODISCON option
might allow DB2 to restart more quickly after a DB2 subsystem
normally or abnormally terminates because it does not have to wait for
IRLM to rejoin the IRLM data sharing group.
TRACE=
Specifies whether the IRLM is to capture traces in wrap-around IRLM
buffers. Each buffer is reused when the previous buffer is filled. Traces are
captured at IRLM startup. You should specify TRACE=YES in the irlmproc
to place traces in wrap-around mode.
NO
Does not capture traces unless the TRACE CT command is issued.

412 Command Reference

 YES
Captures traces in wrap-around buffers.

Examples

Example: This command starts the IRLM with a lock table storage size of 64 MB,
assuming a width of 2-bytes for each lock table entry.

Enter the following command on the system console:

S irlmproc,LTE=32

If this value is correct, message DXR132I, which is displayed after successful

connection to the lock structure, displays the value used by IRLM. If this value is
incorrect, START will terminate with DXR116E CODE=24 and ABENDU2018. This
value is only used if SCOPE=GLOBAL or SCOPE=NODISCON and has a default
value calculated by IRLM.

Chapter 77. START irlmproc (z/OS IRLM) 413

414 Command Reference
 Chapter 78. -START PROCEDURE (DB2)
| The DB2 command START PROCEDURE activates the definition of a stored
| procedure that is stopped or refreshes one that is stored in the cache. You can
| qualify stored procedure names with a schema name.

On successful completion of the command, queued requests for the specified

stored procedures begin to execute. The abend counts for the specified procedures
are set to zero. DB2 resets the MAXQUE and TIMEOUT statistics to 0 each time
that you execute the START PROCEDURE command.

You do not need to issue START PROCEDURE when you define a new stored
procedure to DB2. DB2 automatically activates the new definition when it first
receives an SQL CALL statement for the new procedure.

Abbreviation: -STA PROC

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 416
v “Option descriptions” on page 416
v “Usage notes” on page 416
v “Examples” on page 417

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group or local, depending on the value of the SCOPE option.

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v Ownership of the stored procedure
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 415

 Syntax

(*.*)


START PROCEDURE

,

(  schema.procedure-name )
schema.partial-name*
procedure-name
partial-name*

LOCAL

SCOPE ( GROUP )


Option descriptions
(*.*)
Marks all stored procedures in all schemas as available to be called.
( schema.procedure-name )
Starts the specified stored procedure in the specified schema.
( schema.partial-name *)
Starts a set of stored procedures in the specified schema. The names of all
procedures in the set begin with partial-name and can end with any string,
including the empty string. For example, PAYROLL.ABC* starts all stored
procedures with names that begin with ABC in the PAYROLL schema.
procedure-name
Marks one or more specific stored procedures as available to be called.
partial-name *
Marks a set of stored procedures in the SYSPROC schema as available to be
called. The names of all procedures in the set begin with partial-name and can
end with any string, including the empty string. For example, ABC* starts all
stored procedure names that begin with ABC in the SYSPROC schema.
SCOPE
Specifies the scope of the command.
( LOCAL )
Starts the specified stored procedures in only the local members.
(GROUP)
Starts the specified stored procedures in all members of the data sharing
group.

Usage notes

Errors in a definition of a stored procedure: Errors are detected at create time for a
stored procedure.

| Considerations for native SQL procedures: The START PROCEDURE command

| affects all versions of the native SQL procedures that you specify in the command.

416 Command Reference

Examples

Example 1: Start all stored procedures.

-START PROCEDURE

This command produces output that is similar to the following output:

DSNX946I - DSNX9ST2 START PROCEDURE SUCCESSFUL FOR *.*
DSN9022I - DSNX9COM '-START PROC' NORMAL COMPLETION

Example 2: Make the stored procedures USERPRC1 and USERPRC2 available to be

called, and start any requests that are waiting for those procedures.
-START PROCEDURE(USERPRC1,USERPRC2)

This command produces output that is similar to the following output:

DSNX946I - DSNX9ST2 START PROCEDURE SUCCESSFUL FOR USERPRC1
DSNX946I - DSNX9ST2 START PROCEDURE SUCCESSFUL FOR USERPRC2
DSN9022I - DSNX9COM '-START PROC' NORMAL COMPLETION

Chapter 78. -START PROCEDURE (DB2) 417

418 Command Reference
 Chapter 79. -START PROFILE (DB2)
The DB2 command START PROFILE loads or reloads the profile table into a data
structure in memory.

If this data structure already exists, DB2 deletes it, and a new structure is created.
The profile table must be loaded by issuing the command above explicitly. The
table is not loaded when the database is initialized at the startup time. After
loading the database, the functions specified in the profile become active. Only the
rows in the profile table with column PROFILE_ENABLED=’Y’ are activated.

Abbreviation: -STA PROFILE

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Examples”

Environment

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

| Syntax
|

|

START PROFILE

|

Examples

Example 1: This command is required to load the profile table into memory.
-START PROFILE

© Copyright IBM Corp. 1983, 2009 419

420 Command Reference
 Chapter 80. -START RLIMIT (DB2)
The DB2 command START RLIMIT starts the resource limit facility (governor) and
specifies a resource limit specification table for the facility to use.

| You can issue START RLIMIT even if the resource limit facility is already active.
| The resource limit specification table or the resource limit middleware table that
| you identify is used for new threads, and existing threads continue to be subject to
| the limits in the table that was active at the time they were created.

Abbreviation: -STA RLIM

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option description”
v “Example” on page 422

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

START RLIMIT

ID=id

Option description

The following keyword is optional.

© Copyright IBM Corp. 1983, 2009 421

 ID= id
Identifies the resource limit specification table for the governor to use.
id is the one or two identification character that is specified when the table is
created.
| The full name of the table is authid.DSNRLSTid or authid.DSNRLMTid, where
| authid is the value that is specified in field RESOURCE AUTHID on installation
| panel DSNTIPP.
The default ID is the value that is specified in field RLST NAME SUFFIX on
installation panel DSNTIPO.

Example

Start the resource limit facility.

-START RLIMIT ID=01

422 Command Reference

Chapter 81. -START TRACE (DB2)
The DB2 command START TRACE starts DB2 traces.

An additional option for this command and additional values for a few other
options exist. This additional information is intended for service and use under the
direction of IBM Software Support.

Abbreviation: -STA TRA

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 424
v “Option descriptions” on page 426
v “Usage notes” on page 435
v “Examples” on page 437

Environment

This command can be issued from a z/OS console, a DSN session, a DB2I panel
(DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group or local, depending on the value of the SCOPE option.

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v TRACE privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 423

 Syntax

START TRACE ( PERFM ) DEST (  GTF )

ACCTG SMF constraint block RMID COMMENT(string)
STAT SRV
AUDIT OPn
MONITOR OPX


LOCAL
SCOPE ( GROUP )

|
| constraint block:

424 Command Reference

|



| * *
, ,

PLAN(  plan-name ) PKGLOC(  package-location )

partial-plan-name partial-package-location

|


| * *
, ,

PKGCOL(  package-collection-id ) PKGPROG(  package-program name )

partial-package-collection-id partial-package-program name

|


| * * *
, , ,

AUTHID(  authorization-id ) CLASS(  integer ) TNO(  integer )

partial-authorization-id

|


| LOCATION( * ) * *
, , ,

 location-name USERID(  userid ) APPNAME(  application-name )

<luname> partial-userid partial-application-name
partial-<luname>*
ipaddr
partial-ipaddr

|


| * *
, ,

WRKSTN(  workstation-name ) CONNID(  connection-role-id )

partial-workstation-name partial-connection-role-id

|


| * * filtering block
, ,

CORRID(  correlation-id ) ROLE(  connection-role )

partial-correlation-id partial-connection-role-id

|


| * * ,
, BUFSIZE( k_bytes )
TDATA(  CORRELATION )
IFCID(  ifcid ) TRACE
CPU
DISTRIBUTED
|

|
| filtering block:

Chapter 81. -START TRACE (DB2) 425

|



| , ,

XPLAN(  plan-name ) XPKGLOC(  package-location )

partial-plan-name partial-package-location

|


| , ,

XPKGCOL(  package-collection-id ) XPKGPROG(  package-program-name )

partial-package-collection-id partial-package-program-name

|


| , , ,

XAUTHID(  authorization-id ) XLOC(  location-name ) XUSERID(  userid )

partial-authorization-id partial-location-name partial-userid
< luname >
partial-<luname>*
ipaddr
partial-ipaddr

|


| , ,

XAPPNAME(  application-name ) XWRKSTN(  workstation-name )

partial-application-name partial-workstation-name

|


| , ,

XCONNID(  connection-role-id ) XCORRID(  correlation-id )

partial-connection-role-id partial-correlation-id

|


| ,

XROLE(  connection-role )
partial-connection-role-id
|

Option descriptions

You must specify a trace type.

The options PERFM, ACCTG, STAT, AUDIT, and MONITOR identify the type of
trace that is started.
( PERFM )
Specifies a trace that is intended for performance analysis and tuning. This
trace includes records of specific events in the system.
Abbreviation: P
( ACCTG )
Specifies a trace that is intended to be used in accounting for a particular
program or authorization ID. This trace includes records that are written for
each thread.
Abbreviation: A
( STAT )
Specifies a trace that collects statistical data that is broadcast by various
components of DB2, at time intervals that can be chosen during installation.
Abbreviation: S
LOCATION cannot be specified when you choose a statistics trace.

426 Command Reference

 ( AUDIT )
Specifies a trace that collects audit data from various components of DB2.
Abbreviation: AU
( MONITOR )
Specifies a trace that collects monitor data. This option makes trace data
available to DB2 monitor application programs.
Abbreviation: MON
SCOPE
Specifies the scope of the command.
( LOCAL )
Specify to display information about procedures on the local member only.
(GROUP)
Specify to display information about procedures on all members of the
data sharing group.
COMMENT ( string )
Gives a comment that is reproduced in the trace output (except in the resident
trace tables). This option can be used to record why the command was issued.
string is any character string; it must be enclosed between apostrophes if it
includes a blank, comma, or special character.
| RMID
| Specifies resource manager identifier. You can specify up to 8 valid RMIDs,
| which are one or two digit identifiers. You cannot specify RMID for accounting
| or statistic traces.
DEST
Specifies where the trace output is to be recorded. You can use more than one
value, but do not use the same value twice. If you do not specify a value, the
trace output is sent to the default destination shown in the following table.
If the specified destination is not active or becomes inactive after you issue the
START TRACE command, you receive message DSNW133I, which indicates
that the trace data is lost. This applies for destinations GTF, SRV, and SMF. You
also receive this message for destinations OP n and OPX if START TRACE is
not issued by an application program.
Abbreviation: D
The allowable values and the default value depend on the type of trace started,
as shown in the following table.
Table 28. Allowable destinations for each trace type
Type GTF SMF SRV OP n OPX
PERFM Default Allowed Allowed Allowed Allowed
ACCTG Allowed Default Allowed Allowed Allowed
STAT Allowed Default Allowed Allowed Allowed
AUDIT Allowed Default Allowed Allowed Allowed
MONITOR Allowed Allowed Allowed Allowed Default

The meaning of each value is as follows:

Chapter 81. -START TRACE (DB2) 427

 GTF
The z/OS generalized trace facility (GTF). The record identifier for records
from DB2 is X’0FB9’.
SMF
The system management facility. The SMF record type of DB2 trace records
depends on the IFCID record, as follows:
IFCID record
SMF record type
1 (System Services Statistics)
100
2 (Database Services Statistics)
100
3 (Agent Accounting)
101
202 (Dynamic System Parameters)
100
230 (Data Sharing Global Statistics)
100
239 (AGENT ACCOUNTING OVERFLOW)
101
All Others
102
SRV
An exit to a user-written routine. For instructions and an example of how
to write such a routine, see the macro DSNWVSER in library prefix
.SDSNMACS.
OP n
A specific destination.
n can be an integer from 1 to 8.
OPX
A generic destination which uses the first free OP n slot.
Only applications that start a trace to an OP n buffer can read that buffer.
All traces to an OPX destination must be stopped before the buffer is marked
as not in use. Traces that are started to an OPX buffer that was formerly in use
write over the storage any previous traces had set.

The constraint block

The constraint block places optional constraints on the kinds of data that are
collected by the trace. The allowable constraints depend on the type of trace
started, as shown in the following table.
Table 29. Allowable constraints for each trace type
Type PLAN AUTHID CLASS LOCATION
PERFM Allowed Allowed Allowed Allowed
ACCTG Allowed Allowed Allowed Allowed
STAT NO NO Allowed NO

428 Command Reference

 Table 29. Allowable constraints for each trace type (continued)
Type PLAN AUTHID CLASS LOCATION
AUDIT Allowed Allowed Allowed Allowed
MONITOR Allowed Allowed Allowed Allowed

The meaning of each option is as follows:

PLAN( plan-name , ...)
Introduces a list of specific plans for which trace information is gathered. You
cannot use this option for a STAT trace.
The default is PLAN( * ).
(*)
Starts a trace for all plans.
plan-name
Is the name of an application plan. You can use up to eight names; a
separate trace is started for each name. If you use more than one name,
you can use only one value for AUTHID and LOCATION.
| PKGLOC
| Specifies the location name where the package is bound.
| PKGCOL
| Specifies the package collection name.
| PKGPROG
| Specifies the DBRM or program name.
AUTHID( authorization-id , ...)
Introduces a list of specific authorization IDs for which trace information is
gathered. The authorization IDs specified must be the primary authorization
IDs. You cannot use this option for a STAT trace.
The default is AUTHID( * ).
(*)
Starts a trace for all authorization IDs.
authorization-id
Specifies an authorization ID. You can use up to eight identifiers; a
separate trace is started for each identifier. If you use more than one
identifier, you can use only one value for PLAN and LOCATION.
CLASS( integer , ...)
Introduces a list of classes of data gathered. What classes are allowable, and
their meaning, depends on the type of trace started.
Abbreviation: C
When this option is omitted, all the default classes within the trace type are
activated. The default classes for each trace type are marked by asterisks (*) in
the following table.
(*)
Starts a trace for all classes of the trace type.
integer
Is any number in the following table. You can use any number of classes
that are allowed for the type of trace started.

Chapter 81. -START TRACE (DB2) 429

| Table 30. Classes for DB2 trace types
| Class Description of class Activated IFCIDs
| Accounting trace
| 1* Standard accounting data 3,106,200,239
| 2 Entry or exit from DB2 event signalling 232
| 3 Elapsed wait time in DB2 6-9,32,33,44,45,117,118,127,128,170,171,
| 174,175,213-216,226,227,242,243,321,322,329
| 4 Installation-defined accounting record1 151
| 5 Time spent processing IFI requests 187
| 6 Reserved
| 7 Entry or exit from DB2 event signalling for 232,240
| package and DBRM accounting
| 8 Wait time for a package 6-9,32,33,44,45,117,118,127,128,170,171,
| 174,175,213-216,226,227,241-243,321,322
| 10 Package detail 239
| 11 - 29 Reserved
| 30 - 32 Available for local use
| Audit trace
| 1* Access attempts denied due to inadequate 140
| authorization
| 2 Explicit GRANT and REVOKE 141
| 3 CREATE, ALTER, and DROP operations against 142
| audited tables
| 4 First change of audited object 143
| 5 First read of audited object 144
| 6 Bind time information about SQL statements that 145
| involve audited objects
| 7 Assignment or change of authorization ID 55,83,87,169,319
| 8 Utilities 23,24,25,219,220
| 9 Installation-defined audit record1 146
| 10 - 29 Reserved
| 30 - 32 Available for local use
| Statistics trace
| 1* Statistics data 1,2,105,106,202, 225
1
| 2 Installation-defined statistics record 152
| 3 Deadlock, lock escalation, group buffer pool, 172,196,250,258,261,262,313,330,337
| data set extension information, and indications
| of long-running URs and active log space
| shortages
| 4 DB2 exceptional conditions 173,191-195,203-210,235,236,238,267,268
| 5 DB2 data sharing statistics record 230
| 6 Storage usage details 225
| 7 Reserved
| 8 Data set I/O statistics 199
| 9 - 29 Reserved

430 Command Reference

| Table 30. Classes for DB2 trace types (continued)
| Class Description of class Activated IFCIDs
| 30 - 32 Available for local use
| Performance trace
| 1* Background events 1,2,31,42,43,76-79,102,103,105-107,153
| 2* Subsystem events 3,68-75,80-89,106,174,175
| 3* SQL events 22,53,55,58-66,92,95-97,106,112,173,177,
| 233,237,250,272,273,325
| 4 Reads to and writes from the buffer and EDM 6-10,29-30,105-107,127,128,226,227,321,322
| pools
| 5 Write to log; archive log 32-41,104,106,114-120,228,229
| 6 Summary lock information 20,44,45,105-107,172,196,213,214,218,337
| 7 Detailed lock information 21,105-107,223
| 8 Data scanning detail 13-18,105-107,125,221,222,231,305,311
| 9 Sort detail 26-28,95-96,106
| 10 BIND, commands, and utilities detail 23-25,90,91,105-107,108-111,201,256
| 11 Execution unit switch and latch contentions 46-52,56,57,93,94,106,113
| 12 Storage manager 98-101,106
| 13 Edit and validation exits 11,12,19,105-107
| 14 Entry from and exit to an application 67,106,121,122
1
| 15 Installation-defined performance record 154
| 16 Distributed processing 157-163,167,183
| 17 Claim and drain information 211-216
| 18 Event-based console messages 197
| 19 Reserved
| 20 Data sharing coherency summary 249-251,256-257,261,262,267,268
| 21 Data sharing coherency detail 255,259,263
| 22 Authorization exit parameters 314
| 23 - 29 Reserved
| 30 - 32 Available for local use
| Monitor trace
| 1* Standard accounting data 200
| 2 Entry or exit from DB2 event signalling 232
| 3 DB2 wait time for I/O, locks; resource usage 6-9,32,33,44,45,117,118,127,
| information 128,170,171,174,175,213,214,
| 215,216,226,227,242,243,321,322
| 4 Installation-defined monitor record1 155
| 5 Time spent processing IFI requests 187
| 6 Changes to tables created with DATA CAPTURE 185
| CHANGES
| 7 Entry or exit from DB2 event signalling for 232,240
| package and DBRM accounting

Chapter 81. -START TRACE (DB2) 431

| Table 30. Classes for DB2 trace types (continued)
| Class Description of class Activated IFCIDs
| 8 Wait time for a package 6-9,32,33,44,45,51,52,56,57,
| 117,118,127,128,170,171,174, 175,213-
| 216,226,227,241-243,321,322
| 10 Package detail 239
| 9, 11-29 Reserved
| 30 - 32 Available for local use
| Note:
| v An asterisk (*) indicates a default class for a trace type.
| v 1. For instructions on using the IFCIDs, see the topic ″Interpreting DB2 trace output″ in the DB2 for z/OS
| Administration Guide.
| v 2. DB2 does not collect statistical data for this record unless IFCID 318 is activated. IFCID 318 is not associated
| with any trace class; you must start it on its own.
|
| LOCATION( location-name , ...)
| Introduces a list of specific location names for which trace information is
| gathered. The use of the LOCATION option precludes tracing threads that
| have no distributed data relationship. LOCATION cannot be specified when
| you want to start a statistics trace.
| location-name
| Identifies the DB2 subsystems whose distributed threads you want to trace.
| Activates the DB2 trace for the remote TCP/IP or SNA location that you
| specify by location-name.
| You can specify up to eight locations; a separate trace is started for each
| one. You can specify only one location if you use more than one plan name
| or authorization ID.
| <luname>
| Activates the DB2 trace for the remote clients that are connected to DDF
| through the remote SNA LU name that you specified in luname.
| ipaddr
| Activates the DB2 trace for the remote clients that are connected to DDF
| through the remote TCP/IP host.ipaddr is the IP address.
| (*) Indicates that you want to start trace events that occur under distributed
| threads regardless of which location they are connected to. Specifying the
| local location name is equivalent to specifying LOCATION(*).
| Clients other than DB2 for z/OS: DB2 for z/OS does not receive a location
| name from clients that are not DB2 for z/OS subsystems. To start a trace
| for a client that is not a DB2 for z/OS subsystem, enter its LUNAME or IP
| address. Enclose the LUNAME by the less-than (<) and greater-than (>)
| symbols. Enter the IP address in the form nnn.nnn.nnn.nnn. For example, to
| start a trace for a client with the LUNAME of LULA, enter the following
| command:
| -START TRACE (PERFM) CLASS (*) LOCATION (<LULA>)

| To start a trace for a client with the IP address of 123.34.101.98, enter the
| following command:
| -START TRACE (PERFM) CLASS (*) LOCATION (::FFFF:123.34.101.98)

432 Command Reference

| USERID
| Specifies the userid.
| APPNAME
| Specifies the application name.
| WRKSTN
| Specifies the workstation name.
| CONNID
| Specifies the connection ID.
| CORRID
| Specifies the correlation ID.
| ROLE
| Specifies the connection roles.
| XPLAN
| Provides IFC exclude filtering for plan name.
| XPKGLOC
| Provides IFC exclude filtering for package location name.
| XPKGCOL
| Provides IFC exclude filtering for package collection ID.
| XPKGPROG
| Provides IFC exclude filtering for package program name.
| XAUTHID
| Provides IFC exclude filtering for authorization ID.
| XLOC
| Provides IFC exclude filtering for location.
| XUSERID
| Provides IFC exclude filtering for user ID.
| XAPPNAME
| Provides IFC exclude filtering for application or transaction name.
| XWRKSTN
| Provides IFC exclude filtering for workstation name.
| XCONNID
| Provides IFC exclude filtering for connection ID.
| XCORRID
| Provides IFC exclude filtering for correlation ID.
| XROLE
| Provides IFC exclude filtering for connection roles.
IFCID ( ifcid , ...)
Specifies which other IFCIDs (trace events), in addition to those IFCIDs
contained in the classes specified in the CLASS option, are to be started. To
start only those IFCIDs specified in the IFCID option, use trace classes 30-32.
These classes have no predefined IFCIDs and are available for a location to
use. See Example 1 for an example of activating only those trace events
specified in the IFCID option.
If you do not specify the IFCID option, only those IFCIDs contained in the
activated trace classes are started.

Chapter 81. -START TRACE (DB2) 433

 The maximum number of IFCIDs is 156. The range of values that are valid for
the IFCID option is 1 through 350, with the exception of: 4, 5, 185, 187, 217,
232, 234, 240, and 241. These exceptions are invalid values for the IFCID
option. IFCIDs 4 and 5 are always automatically active. Some of the other
invalid IFCIDs can be activated only by certain trace classes. The invalid
values for the IFCID option that can be started only by trace classes are:
To start...
Start...
IFCID 185
monitor trace class 6
IFCID 232
monitor trace class 2 or 7, or accounting trace class 2 or 7
IFCID 240
monitor trace class 7 or accounting trace 7
IFCID 241
monitor trace class 8 or accounting trace 8
The default is IFCID( * ).
BUFSIZE ( k_bytes , ...)
Specifies the size of an IFC managed buffer that receives the trace data. You
can specify this option only if you specified an OP n destination.
k_bytes can range from 256 KB to 16384 KB. The number must be evenly
divisible by 4. If you specify a value outside of this range, the range limit
closest to the specified value is used. To allocate a buffer size of 256 KB, you
would specify BUFSIZE(256).
The default is BUFSIZE ( * ), which is the size set when DB2 was installed.
TDATA
Specifies the product section headers to be placed into the product section of
each trace record. If you do not specify TDATA, then the type of trace
determines the type of product section header. The product section of a trace
record can contain multiple headers.
All IFC records have a standard IFC header. The correlation header is added
for accounting, performance, audit, and monitor records. The trace header is
added for serviceability records.
CORRELATION
Places a correlation header on the record.
Abbreviation: COR
TRACE
Places a trace header on the record.
Abbreviation: TRA
CPU
Places a CPU header on the record. The CPU header contains the current
processor time for the z/OS TCB or SRB executing.
DISTRIBUTED
Places a distributed header on the record.
Abbreviation: DIST

434 Command Reference

Usage notes

Number of traces: If you use one or no values for PLAN, AUTHID, or LOCATION,
the START TRACE command starts a single trace. If you use multiple values for
PLAN, AUTHID, or LOCATION, the command starts a trace for each plan,
authorization ID, or location. There can be up to 32 traces going at one time. If a
START TRACE command is entered from the console or from the DB2I panels to
an OP n or an OPX destination, message DSNW133I is issued to indicate trace data
lost.

Using the options PLAN, AUTHID, or LOCATION when starting monitor trace
class 1 has no effect on the amount of data returned on IFI READS requests.

Using the options PLAN, AUTHID, or LOCATION has no effect when starting
either accounting or monitor trace classes 2, 5, or 7.

Stopping and starting DB2: If DB2 is stopped and started after you have started a
trace, the trace is not restarted automatically.

Specifying SCOPE (GROUP): When you issue START TRACE with

SCOPE(GROUP), DB2 issues a START TRACE command on each member of the
data sharing group. The data goes to the destination as it is defined for each
member of the data sharing group. If you want to gather trace data for all
members of the data sharing group in one place, use a monitor program with IFI
READA or READS calls to collect the data.

If a trace is started with SCOPE(GROUP), and a new member joins the data
sharing group after the trace is started, the new member also writes the trace data
that is specified by the START TRACE command.

Starting a trace with SCOPE(GROUP) can generate large amounts of trace data, so
you might need to increase the size of the return area in your monitor program to
hold the extra data.

Tracing threads using the * wildcard: You can use the wildcard suffix, “*” to filter
threads. For example, if you specify “-START TRACE PLAN (A,B,C*)”, DB2 will
trace, and then return A, B, CDE, CDEFG, CDEFGH, and so on. It will trace
threads “A”, “B” and all threads starting with “C”.

Tracing threads using the positional, (_) wildcard: You can utilize the positional
wildcard, which is represented by the, “_” character, to trace threads when you
want the wildcard in the middle, or when you want to trace threads of a specific
length. For example, if you specify “-START TRACE PLAN (A_C), all threads will
be traced that are three characters that have “A” as the first character, and “C” as
the third. This command would return “ABC”, “ADC”, “AEC”, and so on. If you
want to trace the thread “A_C” then you can specify “-START TRACE PLAN
(A/_C). The “/” before the “_” tells DB2 to trace for the underscore in the search,
rather than treating it as a wildcard. The same logic applies if you are trying to
trace a thread that includes a “/” or “*” character. Because the character “/” is an
escape character, if you are trying to trace a thread that has an “/” character in it,
you can specify, for example, “-START TRACE PLAN (A//C)” to trace the thread
“A/C”. You can also specify “-START TRACE PLAN (A/*C) to trace the thread
“A*C”.

Tracing multiple threads at once using wildcards: You also have the option of
tracing multiple threads based on multiple trace qualifications. For example, you

Chapter 81. -START TRACE (DB2) 435

 can specify, “-START TRACE PLAN (A*, B*, C*) to simultaneously trace ALL
threads for plan that start with “A”, “B”, and “C”. The wildcard character, “*” will
trace all threads. You can specify more complex combinations such as, “-START
TRACE PLAN (A_B*, C*, AND C/_D*)”, which will return all threads that:
v Begin with “A”, have a one character wild card as the second character in the
thread, have a “B” as the third character in the thread, and end with any type or
number of characters (ADBIOP, AOBTYJDP,)
v begin with “C”, and end with any combination of characters (CDE, CGHKO)
v begin with “C_D” and end with any type of character combination (C_DEFGH,
C_DLMNOP)
All of the possible thread combinations listed above will be returned with the
command above.

You have the ability to filter multiple threads at the same time, setting specific
criteria for the trace. For example, you can specify “-START TRACE PLAN (A)
USERID (B). This will trace the threads where the plan thread is A, and the user ID
is B. When tracing threads, you can only specify more than one thread criteria for
one filter per “-START TRACE” command. For example, you can specify “-START
TRACE PLAN (A,B) USERID (B) WRKSTN (E),” but you cannot specify “-START
TRACE PLAN (A, B) USERID (A, B) WRKSTN (E) because, in this example, two of
the filter qualifications have two elements defined to be traced, and DB2 only
allows for one attribute to have more than one trace element to be defined per
trace.

Filtering threads using exclude functionality: When you specify an “X” with any
constraint keyword, such as “XPLAN”, when you are filtering threads, you are
using the exclude functionality for the –START TRACE command. You have the
option of excluding specific types of threads when you are running trace
commands. You can use the “X” character to exclude specific combinations of
characters when you are running a trace. For example, you can specify “-START
TRACE XPLAN(A), to trace all threads EXCEPT “A”. In this instance b, bcd, bcde,
or cd could possibly be returned.

You also have the option of excluding multiple types of threads from your trace.
For example, you can specify, “-START TRACE XPLAN (A*, B*) to trace all threads
except those starting with “A”, with any combination of characters following “A”,
and all those characters starting with “B”, with any combination of characters
following “B”. Note: Specifying XPLAN (*) will exclude all threads from your
search, and is not allowed. You also cannot use the wildcard in the middle of a
start trace command with exclude functionality, such as, “-START TRACE XPLAN
(A*C).” You can, however, specify “-START TRACE XPLAN (A_ _ C *)”, which
will return all threads except those starting with “A”, a variety of two characters
next, a “C” in the fourth space, and a variety of characters at the end. The
wildcard symbol cannot be placed in the middle of trace criteria.

You have the ability to start two traces at once, in order to help you optimize your
tracing capabilities. For example, you can specify (-START TRACE XPLAN (A, B,
C) USERID (D))”. This tells DB2 to start tracing threads for “plan” except threads
“A”, “B”, or “C”, only where the user ID = “D”.

Combining trace qualifiers: You can customize the threads you trace by
commanding DB2 to trace specific threads, while excluding other specific threads.
For example, you can specify, “-START TRACE USERID (A,B) XPLAN (C)” . This
criteria only traces threads where the user ID is equal to “A” or “B”, and plan is
not equal to “C”. In this example, a thread where the user id is “A” and the plan

436 Command Reference

 is equal to “D” would pass, and be traced, but a thread where the user ID is “A”
and plan is “C” would not pass, and would not be traced.

You can introduce multiple wildcards into your start trace commands to add more
customization to your traces. For example, you can specify “-START TRACE PLAN
(C*) USERID (Z, X) XPLAN (C, D, E)”. In this example, for the thread to be traced,
the plan must begin with C, the user ID must be equal to Z or to X, and the plan
cannot be C, D, or E. So a plan of CB, with a user ID of Z would pass, and the
thread would be traced, but plan C with a user ID of X would fail because the
command specifies not to trace threads where the plan is “C”, without additional
characters in the thread.

| Trace destination precedence: If an IFCID is associated with a class, and you

| specify that IFCID in the IFCID keyword, the destination for the class takes
| precedence. This rule affects IFCIDs in accounting classes 2, 3, 5, 7, 8, and
| monitoring classes 1, 2, 3, 5, 7, 8 because these classes have preset destinations for
| the IFCIDs.

| For example, the following command ″-START TRACE(ACCTG) CLASS (1,2,3)

| IFCID(6,7) DEST SMF,″ will not write IFCIDs 6 and 7 to SMF because they are part
| of accounting class 3, which has a preset destination. To write IFCIDs 6 and 7 to
| SMF, you need to start the trace as follows:
-START TRACE(ACCTG) CLASS(1,2,3) DEST(SMF)
-START TRACE(ACCTG) CLASS(30) IFCID(6,7) DEST(SMF)

Examples

Example 1: Start a performance trace for threads with remote activity to location
USIBMSTODB21. Only activate IFCIDs 44 (lock suspends) and 54 (lock contention).
Trace class 30 is available for installation use.
-START TRACE (PERFM)
DEST(GTF)
LOCATION(USIBMSTODB21)
CLASS(30)
IFCID(44)

Example 2: Start an accounting trace for plan DSN8BC81. Write records to SMF
(that will happen by default). Include a comment to identify the trace.
-START TRACE (ACCTG)
PLAN (DSN8BC81)
COMMENT ('ACCTG TRACE FOR DSN8BC81')

Example 3: Start the statistics trace. Write records to SMF (by default).
-START TRACE=S

Example 4: Start monitor tracing (usually done by an application program). Write

records to OPX (by default).
-START TRACE(MON)

Example 5: Start monitor tracing (usually done by an application program) on the

data sharing group. Write records to OPX (by default).
-START TRACE(MON) SCOPE(GROUP)

Example 6: Provides IFC exclude filtering for correlation ID.

Chapter 81. -START TRACE (DB2) 437

 START TRACE (A) XCORRID (*)
- 10.46.05 STC00051 DSNW150I ) EXCLUDE FOR ALL CORRID VALUES IS NOT
- ALLOWED
- 10.46.05 STC00051 DSN9023I ) DSNWVCM1 '-START TRACE' ABNORMAL COMPLETION

438 Command Reference

 Chapter 82. STOP admtproc (z/OS )
The STOP admtproc command stops the administrative task scheduler that is
specified in the admtproc parameter.

The command should only be issued to bring down the administrative task
scheduler for maintenance or to prepare for an IPL. To stop the administrative task
scheduler for other purposes, issue the command: modify admtproc,
appl=shutdown.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Examples”

Environment

This command can be issued only from a z/OS console.

Data sharing scope: Member

Authorization

The command requires an appropriate level of operating system authority.

Syntax

STOP admtproc


Option descriptions
admtproc
| Specifies the procedure name of the administrative task scheduler task that you
| want to stop.

Examples

Example: This command stops the admtproc scheduler.

Enter the following command on the system console:

stop admtproc

© Copyright IBM Corp. 1983, 2009 439

440 Command Reference
Chapter 83. /STOP (IMS)
The IMS /STOP command (with the SUBSYS parameter) prevents application
programs from accessing external subsystem resources.

The following is only a partial description of the /STOP command.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage note”

Environment

This command can be issued only from an IMS terminal.

Data sharing scope: Member

Authorization

This command requires an appropriate level of IMS authority.

Syntax

/STOP SUBSYS  subsystem-name


SUBSYS ALL

Option descriptions
SUBSYS
Specifies whether connection is to be stopped for one or more names of
external subsystems presently connected to IMS, or for all of them.
subsystem-name , ...
Specifies one or more names of external subsystems whose connection to
IMS is to be stopped.
ALL
Indicates that connection is to be stopped for all external subsystems
presently connected to IMS.

Usage note

When to use /STOP: The /STOP command allows application programs currently
accessing external resources to complete normally. When all applications have

© Copyright IBM Corp. 1983, 2009 441

 terminated, the connection to the external subsystem is also terminated. A /START
command must be issued to reestablish the connection.

The /STOP command can also be used to stop the subsystem connection in order
to change the specifications in the external subsystem’s PROCLIB member entry.
The /START command then refreshes the copy in main storage of the PROCLIB
entry with the modified entry.

442 Command Reference

Chapter 84. -STOP DATABASE (DB2)
The DB2 command STOP DATABASE makes the specified objects unavailable for
applications and closes their data sets.

The objects that can be designated are:

v Databases
v Table spaces
v Index spaces
v Physical partitions of partitioned table spaces or index spaces (including index
spaces that contains data-partitioned secondary indexes)
v Logical partitions of nonpartitioned secondary indexes

When used to stop a logical partition of a secondary index, the command does not
close any data sets that are associated with the index.

In a data sharing environment, the command applies to every member of the data
sharing group. If a GBP-dependent object is stopped with the command STOP
DATABASE, DB2 performs the necessary processing to make the object no longer
GBP-dependent.

Abbreviation: -STO DB

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 444
v “Option descriptions” on page 444
v “Usage notes” on page 447
v “Examples” on page 448

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v STOPDB privilege
v DBMAINT authority
v DBCTRL authority
v DBADM authority
v SYSCTRL authority
v SYSADM authority
© Copyright IBM Corp. 1983, 2009 443
 Error messages are produced for those specified databases for which this set does
not have the STOPDB privilege.

| For implicitly created databases, the database privilege or authority can be held on
| the implicitly created database or on DSNDB04. If the STOP DATABASE command
| is issued on specific table spaces or index spaces in an implicitly created database,
| ownership of the table spaces is sufficient to stop them. This means that the owner
| can display information about an implicitly created table space or index space if
| the command explicitly specifies that table space or index space name.

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

When data definition control is active, installation SYSOPR or installation SYSADM

authority is required to stop the database, a table space, or an index space that
contains a registration table or index.

Database DSNDB06 contains the table spaces and index spaces that are required to
check authorization. If you stop any table space or index space that is required for
the START DATABASE authorization check, installation SYSADM authority is
required to restart it.

| Syntax
|

| ,
|


STOP DATABASE (  database-name )

*
dbname1:dbname2
dbname*
*dbname
*dbname*
*dbstring1*dbstring2*

|


| ,

SPACENAM(  space-name )
* , CLONE
spacename1:spacename2
spacename* PART(  integer )
*spacename integer1:integer2
*spacename*
*spacestring1*spacestring2*

|


| AT(COMMIT)

Option descriptions

One of the following two options is required.

444 Command Reference

 ( database-name , ...)
Specifies the names of the database, or database for the table spaces or index
spaces to stop. If you use more than one name, separate names in the list by
commas.
(*) Stops all databases for which the privilege set of the process has at least
DBMAINT authority or STOPDB privilege.
| However, DSNDB01, DSNDB06, DSNRTSDB, and work file databases, such
| as DSNDB07, can be stopped only by specifying them explicitly (for
| example, STOP DATABASE(DSNDB01)). DSNRTSDB is available only in
| Version 9.1 conversion mode.

dbname and dbstring can have any of the forms in the following list (where
dbname1 and dbname2 represent any strings of from 1 to 8 characters, and
dbname represents any string of from 1 to 7 characters):
Form Stops...
dbname1:dbname2
| All databases whose names, in UNICODE, collate greater than or equal
| to dbname1 and less than or equal to dbname2
dbname*
All databases whose names begin with the string dbname
*dbname
All databases whose names end with the string dbname
*dbname*
All databases whose names contain the string dbname
*dbstring1*dbstring2*
All databases whose names contain the strings dbstring1 and dbstring2
SPACENAM( space-name , ...)
Indicates names of table spaces or indexes within the specified database to
stop.
Abbreviation: SPACE, SP
space-name
Is the name of one or more table spaces or index spaces to stop.
You can write space-name like database-name to designate:
v The name of a single table space or index space
v A range of names
v A partial name, including a beginning or ending pattern-matching
character (*), pattern-matching character between two strings, or any
combination of these uses. Consecutive pattern-matching characters (*)
are not allowed, and you cannot specify two pattern-matching characters
in the middle of a keyword string.
See the following section for instructions on how to start a table space or
index space again.
(*) Stops all table spaces and indexes of the specified database.

spacename and spacestring can have any of the forms in the following list
(where spacename1 and spacename2 represent any strings of from 1 to 8
characters, and spacename represents any string of from 1 to 7 characters):
Form Displays the status of...

Chapter 84. -STOP DATABASE (DB2) 445

 spacename1:spacename2
| All table spaces or index spaces whose names, in UNICODE,
| collate greater than or equal to spacename1 and less than or equal to
| spacename2
spacename*
All table spaces or index spaces whose names begin with the string
spacename
*spacename
All table spaces or index spaces whose names end with the string
spacename
*spacename*
All table spaces or index spaces whose names contain the string
spacename
*spacestring1*spacestring2*
All table spaces or index spaces whose names contain the strings
spacestring1 and spacestring2
PART ( integer , ...)
Indicates the partition number of one or more partitions, within the
specified table space or index, that are to be stopped. The START or STOP
state of other partitions does not change.
The integer specified must identify a valid partition number for the
corresponding space name and database name. If you specify nonvalid
partition numbers, you receive an error message for each nonvalid number,
but all valid partitions that you specified are stopped.
integer can be written to designate one of the following specifications:
v A list of one or more partitions
v A range of all partition numbers that collate greater than or equal to
integer1 and less than or equal to integer2
v A combination of lists and ranges
PART is valid with partitioned table spaces, partitioned indexes, and
nonpartitioned type 2 indexes of partitioned table spaces. If you specify
PART with a nonpartitioned table space or index on a nonpartitioned table
space, you receive an error message, and the nonpartitioned space is not
stopped. When a logical partition is stopped, the index is not closed. A
nonpartitioning index must be stopped without the use of PART to close
the index.
| CLONE
| Stops clone objects. In the absence of the CLONE keyword, base table
| objects are stopped and clone table objects are not processed. If you specify
| the CLONE keyword then only clone objects will be processed.
AT(COMMIT)
Marks the specified object as being in STOP status to prevent access from new
requesters. Currently running applications are allowed to continue access until
their next commit. After commit, further access by the committing application
is prohibited. The object is actually stopped and put in STOP status when all
jobs release their claims on it and all utilities release their drain locks on it.
Specify AT(COMMIT) to break in on threads that are bound with
RELEASE(DEALLOCATE), especially in situations where there is high thread
reuse.

446 Command Reference

 The option is ignored for declared temporary databases and table spaces
within it.

Usage notes

Explicitly stopped databases: If table spaces and indexes are stopped explicitly
(using the STOP DATABASE command with the SPACENAM option), they must
be started explicitly using the START DATABASE command. Starting the database
does not start table spaces or indexes that have been stopped explicitly.

Stopped table spaces, indexes, and partitions: Table spaces, indexes, and partitions
are physically closed when the STOP DATABASE command is issued, except for
logical partitions of a nonpartitioning index of a partitioned table space. Index
spaces for declared temporary tables cannot be stopped or started.

Operation in TSO, z/OS, and batch: When the STOP DATABASE command is
issued from a TSO or a z/OS console, the command operates asynchronously to
keep the terminal free. When the command is issued from a batch job, it operates
synchronously in case later steps depend on the database being stopped. The STOP
DATABASE command drains work in progress on the database before stopping it.
If it cannot get the drain locks on the first request, it repeatedly tries again. The
command fails if it times out more than 15 times trying to get the locks or if a
serious deadlock situation occurs.

Ensuring that all databases are stopped: When the STOP DATABASE command is
processing asynchronously, message DSN9022I might be issued before the
command completes. Message DSNT736I is issued to indicate that the
asynchronous processing of the STOP DATABASE command is complete.

Use the DISPLAY DATABASE command to check the stopped status of table
spaces and indexes in a database. A status of STOPP indicates that the object is in
the process of being stopped. A status of STOP indicates that the stop has
completed and the object is in a stopped state. An object is not stopped until all
currently active threads accessing the object are quiesced.

An object might remain in the STOP pending (STOPP) status if the STOP
DATABASE command does not successfully complete processing.

Stopping the communication database and the resource limit database: If the
communication database (CDB) and the resource limit database (RLST) are active,
they cannot be stopped. Those databases are active when created and are activated
by DB2.

Stopping DSNDB01: If you try to stop the DSNDB01 database while an application
plan or package is executing, you might receive a time out because of locking
contention on DSNDB01. This is most likely to occur when an application plan or
package is executing for the first time since DB2 was started, or if the skeleton
cursor table (SKCT) for the plan or the skeleton package table (SKPT) for the
package was swapped out of the EDM pool.

Table space in a restrictive status: If an application process requests a transaction

lock on a table space that is in a restrictive status (RECP) or has a required index
in a restrictive status, DB2 acquires the lock and does not detect the status until the
application tries to access the table space or index. The application then receives
SQLCODE -904 (“resource not available”) and should release the lock, either by
committing or rolling back (if the value of the RELEASE option is COMMIT) or by

Chapter 84. -STOP DATABASE (DB2) 447

 ending (if the value of RELEASE is DEALLOCATE). If you issue the command
STOP DATABASE for either the table space or the index space while a transaction
lock is in effect, the command is suspended. It repeatedly tries to get the locks
needed to drain the work in progress before stopping the database. If the
command times out more than 15 times trying to get the locks, it fails.

After a disk failure: Issuing the STOP DATABASE command before interrupting
the I/O interface between the failed device and DB2 can result in incomplete I/O
requests. To prevent this hang situation, create an interruption either by forcing the
device offline using the z/OS command VARY with the FORCE option, or by
setting the I/O timing interval for the device before any failures. You can set the
I/O timing interval through the IECIOSxx z/OS parmlib member or by issuing the
z/OS command:
SETIOS MIH,DEV=dddd,IOTIMING=mm:ss

Stopping a LOB table space: The STOP DATABASE command can be used to stop
LOB table spaces and indexes on auxiliary tables. LOB table spaces are stopped
independently of the base table space with which the LOB table space is
associated.

The following table summarizes the locking used by the STOP DATABASE
command.
Table 31. Locking used by the STOP DATABASE command
Command Table space type Locks acquired
STOP AT COMMIT Partitioned PART IX mass delete lock. Drain-all on partitions
specified.
IX mass delete lock. Drain-all on all partitions.
Nonpartitioned IX mass delete lock. Drain-all on table space.
STOP Partitioned PART X-lock partitions specified. Drain-all on partitions
specified.
X-lock all partitions. Drain-all on all partitions.
Nonpartitioned X-lock table space. Drain-all on table space.

Examples

Example 1: Stop table space DSN8S81E in database DSN8D81A and close the data
sets that belong to that table space.
-STOP DATABASE(DSN8D81A) SPACENAM(DSN8S81E)

Example 2: Stop all databases (except DSNDB01, DSNDB06, and work file
databases)
-STOP DATABASE(*)

Example 3: Stop all databases (except DSNDB01, DSNDB06, and work file
databases) when all jobs release their claims and all utilities release their drain
locks.
-STOP DATABASE(*) AT(COMMIT)

Example 4: Stop the first partition of XEMP2, a nonpartitioning index of a

partitioned table space in database DSN8D81A. Partition 1 is logically stopped and
cannot be accessed by applications; however, no data sets are closed because parts
of a nonpartitioning index are not associated with separate physical data sets.

448 Command Reference

 -STOP DATABASE(DSN8D81A) SPACENAM(XEMP2) PART(1)

Example 5: Stop all table spaces with names that begin with ″T″ and end with the
″IQUA03″ string in database DSN8D81A.
-STOP DATABASE(DSN8D81A) SPACENAM(T*IQUA03)

Output similar to the following output indicates that the command completed
successfully:
DSN9022I - DSNTDDIS 'STOP DATABASE' NORMAL COMPLETION
DSNT736I - ASYNCHRONOUS STOP DATABASE COMMAND HAS
COMPLETED FOR COMMAND: STOP DB(DSN8D81A) SPACE(T*IQUA03)

| Example 6: Stop clone objects.

| -STOP DATABASE(MYDB*) SPACENAM(MYDB*SP) CLONE

Chapter 84. -STOP DATABASE (DB2) 449

450 Command Reference
|

Chapter 85. -STOP DB2 (DB2)

The DB2 command STOP DB2 stops the DB2 subsystem.

Abbreviation: -STO DB2

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage notes” on page 452
v “Example” on page 452

Environment

This command can be issued from a z/OS console, a DSN session, a DB2I panel
(DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v STOPALL privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

STOP DB2

QUIESCE YES
MODE( ) CASTOUT( )
FORCE NO

Option descriptions
MODE
Indicates whether currently executing programs will be allowed to complete.
For the effects of this option on distributed threads see the description of the
MODE option of Chapter 86, “-STOP DDF (DB2),” on page 455.

© Copyright IBM Corp. 1983, 2009 451

 (QUIESCE)
| Allows currently executing programs to complete processing. No new
| program is allowed to start. If a utility starts a subtask after -STOP DB2
| MODE (QUIESCE) has been issued, message DSNU006I is issued and the
| subtask and utility might end abnormally.
(FORCE)
Terminates currently executing programs, including utilities. No new
program is allowed to start. MODE(FORCE) probably causes indoubt
situations. Some tasks, such as stored procedures tasks and DB2 service
tasks, terminate abnormally. When they terminate abnormally, you might
see dumps and messages from these failures.
CASTOUT
Specifies whether the DB2 member performs castout processing for the page
sets or partitions for which the member was last updated. The CASTOUT
option only applies in a data sharing environment.
YES
Allow group buffer pool castout processing.
NO
Skip group buffer pool castout processing.

Usage notes

MODE(QUIESCE): If MODE(QUIESCE) is used, all connected address spaces must

terminate all connections before the DB2 subsystem stops. The system operator can
tell whether any connections remain by using the DISPLAY THREAD command,
and can cancel them by using the DB2 CANCEL command or z/OS commands.

MODE(FORCE): A forced stop does not cause an immediate abend. If a connected

task is executing outside DB2, DB2 posts an exit routine to stop the task from
accessing DB2. If a task is executing in DB2, it stops when the next “suspend” or
“execution unit switch” occurs. In some cases, the delay before stopping can be
significant.

CASTOUT(NO): Consider using CASTOUT(NO) when shutting down a DB2 data

sharing member for maintenance, because the option can speed shutdown
processing in a data sharing environment. If you are shutting down multiple
members of a data sharing group with CASTOUT(NO), some changed data might
reside in the group buffer pools after the members have shut down. Therefore, if
you want consistent data on disk (for example, you are shutting down all members
to create a copy of the database to send offsite), do not use CASTOUT(NO).

With CASTOUT(NO), the DB2 member shuts down with QC status, as displayed
by the DISPLAY GROUP command, which indicates that the member quiesced
with some castout processing not completed. A retained page set or partition
P-lock is held in IX state for each object for which the DB2 member was the last
updater. Also, group buffer pool connections enter a failed-persistent state.

Example

Example 1: Stop the DB2 subsystem. Allow currently active programs to complete.
Do not allow new programs to identify to DB2.
-STOP DB2 MODE (QUIESCE)

Example 2: Stop a member of a data sharing group for maintenance.

452 Command Reference

-STOP DB2 MODE (QUIESCE) CASTOUT(NO)

Chapter 85. -STOP DB2 (DB2) 453

454 Command Reference
Chapter 86. -STOP DDF (DB2)
The DB2 command STOP DDF stops the distributed data facility (DDF) if it has
already been started; use this command to terminate the DDF interface to VTAM
or TCP/IP.

Abbreviation: -STO DDF

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions” on page 456
v “Usage notes” on page 456
v “Examples” on page 457

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

QUIESCE


STOP DDF MODE( )

FORCE
SUSPEND CANCEL(n)
WAIT(n)

© Copyright IBM Corp. 1983, 2009 455

 Option descriptions
MODE
Indicates whether currently executing active distributed threads are allowed to
complete.
(QUIESCE)
Allows active distributed threads that are using DDF to complete normally
and terminates only inactive distributed threads. If DDF THREADS
ACTIVE was specified during DB2 installation, all DDF threads are active
threads.
(FORCE)
Terminates all currently executing distributed threads.
Some tasks, such as stored procedures tasks and DB2 service tasks,
terminate abnormally. When they terminate abnormally, you might see
dumps and messages resulting from these failures.
(SUSPEND)
Suspends all DDF threads by:
v Keeping inactive DDF threads inactive until a subsequent START DDF
command is issued
v Terminating all DDF pool threads
v Preventing inbound DDF work from starting
MODE(SUSPEND) is intended to be used at a DB2 DRDA server when
locking conflicts exist between CREATE, ALTER, DROP, GRANT, or
REVOKE operations and client access to data. Requests that normally
cause work to be dispatched (including requests for new connections) are
queued. Outbound DDF processing is not affected by this command.
CANCEL ( n )
Cancels all active DDF database access threads if suspend processing
does not complete in n seconds. The range of n is 0 to 9999.
WAIT ( n )
Resumes DDF processing if suspend processing does not complete in n
seconds. The range of n is 0 to 9999.

Usage notes

MODE(QUIESCE): If MODE(QUIESCE) is used, all distributed activity must

complete before DDF stops. The operator can tell whether any distributed threads
remain by using DISPLAY THREAD with the LOCATION option. To cancel
distributed threads that are preventing DDF from stopping, see for CANCEL
THREAD, or use STOP DDF MODE(FORCE).

MODE(QUIESCE) forces any inactive threads to terminate. A requesting system

that is using two-phase commit on an inactive thread might report the terminated
thread as indoubt at the system that issued STOP DDF. The thread is not actually
indoubt (no commit or rollback is pending), and the condition is resolved when
DDF is restarted.

MODE(FORCE): If MODE(FORCE) is used, the DB2 connection to VTAM or

TCP/IP terminates. The termination forces all VTAM or TCP/IP requests to
complete immediately, indicating that a communications error has occurred and
DDF has stopped. A forced stop might take as long as three minutes to complete.

456 Command Reference

 If any applications are updating remote servers that use two-phase commit,
MODE(FORCE) might result in indoubt threads at each server.

MODE(SUSPEND): If MODE(SUSPEND) completes successfully, additional

database resources, which are not inbound DDF work, might still be held. Cancel
these additional resources with CANCEL THREAD as described in .

The following table summarizes the actions that DB2 takes when START DDF,
STOP DDF, START DB2, and STOP DB2 commands are issued with different DDF
states.
Table 32. The result of commands on the DDF status
STOP DB2 or STOP
DDF command STOP DB2 or STOP STOP DDF command
START DDF without DDF command with with
DDF status command MODE(FORCE) MODE(FORCE) MODE(SUSPEND)
Starting DSNL003I DSNL003I DSNL003I DSNL003I
Started DSNL001I DDF stops DDF forced stop DDF suspends
Stopping DSNL005I DSNL005I DSNL005I DSNL005I
Stopped DDF starts DSNL002I DSNL002I DSNL002I
Suspending DDF resumes DDF stops DDF forced stop DSNL069I
Suspended DDF resumes DDF stops DDF forced stop DSNL065I

Examples

Example 1: Stop the distributed data facility (MODE QUIESCE).

-STOP DDF

Example 2: Stop the distributed data facility (MODE FORCE).

-STOP DDF MODE(FORCE)

Example 3: Suspend distributed data facility activity (MODE SUSPEND). If

command processing continues after 600 seconds, cancel any remaining DDF
threads.
-STOP DDF MODE(SUSPEND) CANCEL(600)

Chapter 86. -STOP DDF (DB2) 457

458 Command Reference
Chapter 87. -STOP FUNCTION SPECIFIC (DB2)
The DB2 command STOP FUNCTION SPECIFIC prevents DB2 from accepting SQL
statements with invocations of the specified functions.

This command does not prevent SQL statements with invocations of the functions
from running if they have already been queued or scheduled by DB2. You cannot
use this command to stop built-in functions or user-defined functions that are
sourced on another function.

DB2 implicitly issues the command STOP FUNCTION SPECIFIC

ACTION(REJECT) for any function that exceeds the maximum abend count. That
count is set by the MAX ABEND COUNT field of installation panel DSNTIPX.

Abbreviation: -STO FUNC SPEC

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 460
v “Option descriptions” on page 460
v “Usage notes” on page 461
v “Examples” on page 461

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group or local, depending on the value of the SCOPE option.

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities for each function:
v Ownership of the function
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

If you specify STOP FUNCTION SPECIFIC *.* or schema.partial-name *, the privilege

set of the process must include one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 459

 Syntax

(*.*)


STOP FUNCTION SPECIFIC

,

(  schema.specific-function-name )
schema.partial-name*


QUEUE LOCAL
ACTION ( REJECT ) SCOPE ( GROUP )

Option descriptions
(*.*)
Stops access to all functions, including functions that DB2 applications have
not yet accessed.
If no functions are named, all functions are stopped.
schema.specific-function-name
Stops one specific function name. You cannot specify a function name as you
can in SQL; you must use the specific name. If a specific name was not
specified on the CREATE FUNCTION statement, query
SYSIBM.SYSROUTINES for the correct specific name:
SELECT SPECIFICNAME, PARM_COUNT
FROM SYSIBM.SYSROUTINES
WHERE NAME='function_name'
AND SCHEMA='schema_name';

For overloaded functions, this query can return multiple rows.

schema.partial-name *
Stops a set of functions in the specified schema. The specific names of all
functions in the set begin with partial-name and can end with any string,
including the empty string. For example, schema1.ABC* stops all functions
with specific names that begin with ABC in schema1.
ACTION
Indicates what to do with an SQL statement that invokes the function while
the function is stopped. If you issue STOP FUNCTION SPECIFIC more than
once for a given function, the action that is taken is determined by the
ACTION option on the most recent command.
(QUEUE)
Queues the request until either of the following conditions is true:
v The wait exceeds the installation timeout value.
v You issue START FUNCTION SPECIFIC command for the function.
(REJECT)
Rejects the request.
SCOPE
Specifies the scope of the command.

460 Command Reference

 (LOCAL)
Specify to stop the function on the local member only.
(GROUP)
Specify to stop the function on all members of the data sharing group.

Usage notes

Limitations of STOP FUNCTION SPECIFIC : STOP FUNCTION SPECIFIC is only

applicable to external functions that run in the WLM application environment.
STOP FUNCTION SPECIFIC cannot stop a built-in function or a user-defined
function sourced on another function.

Permanently disabling a function : A stopped function does not remain stopped if

DB2 is stopped and restarted. To disable a function permanently, you can:
v Use ALTER FUNCTION to change the LOADMOD name to a nonexistent z/OS
load module
v Rename or delete the z/OS load module

Examples

Example 1: Stop access to all functions. While the STOP FUNCTION SPECIFIC
command is in effect, DB2 queues all attempts to execute functions.
-STOP FUNCTION SPECIFIC ACTION(QUEUE)

This command produces output similar to the following output:

DSNX974I - DSNX9SP2 STOP FUNCTION SPECIFIC SUCCESSFUL FOR *.*
DSN9022I - DSNX9COM '-STOP FUNC' NORMAL COMPLETION

Example 2: Stop access to all functions. While the STOP FUNCTION SPECIFIC
command is in effect, DB2 rejects attempts to execute functions.
-STOP FUNCTION SPECIFIC ACTION(REJECT)

This command produces output similar to the following output:

DSNX974I - DSNX9SP2 STOP FUNCTION SPECIFIC SUCCESSFUL FOR *.*
DSN9022I - DSNX9COM '-STOP FUNC' NORMAL COMPLETION

Example 3: Stop functions PAYROLL.USERFN1 and PAYROLL.USERFN3. While

the STOP FUNCTION SPECIFIC command is in effect, DB2 queues all attempts to
execute functions.
-STOP FUNCTION SPECIFIC(PAYROLL.USERFN1,PAYROLL.USERFN3)

This command produces output similar to the following output:

DSNX974I - DSNX9SP2 STOP FUNCTION SPECIFIC SUCCESSFUL
FOR PAYROLL.USERFN1

DSNX974I - DSNX9SP2 STOP FUNCTION SPECIFIC SUCCESSFUL

FOR PAYROLL.USERFN3

DSN9022I - DSNX9COM '-STOP FUNC' NORMAL COMPLETION

Example 4: Stop functions PAYROLL.USERFN1 and PAYROLL.USERFN3. While

the STOP FUNCTION SPECIFIC command is in effect, DB2 rejects attempts to
execute either of these functions.
-STOP FUNCTION SPECIFIC(PAYROLL.USERFN1,PAYROLL.USERFN3) ACTION(REJECT)

Chapter 87. -STOP FUNCTION SPECIFIC (DB2) 461

 This command produces output similar to the following output:
DSNX974I - DSNX9SP2 STOP FUNCTION SPECIFIC SUCCESSFUL
FOR PAYROLL.USERFN1

DSNX974I - DSNX9SP2 STOP FUNCTION SPECIFIC SUCCESSFUL

FOR PAYROLL.USERFN3

DSN9022I - DSNX9COM '-STOP FUNC' NORMAL COMPLETION

462 Command Reference

 Chapter 88. STOP irlmproc (z/OS IRLM)
The STOP irlmproc command shuts IRLM down normally. The command is rejected
if any active DB2 subsystems are currently identified to IRLM.

Abbreviation: P

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option description”
v “Usage note”
v “Example”

Environment

This command can be issued only from a z/OS console.

Data sharing scope: Member

Authorization
The command requires an appropriate level of operating system authority.

Syntax

STOP irlmproc


Option description
irlmproc
Identifies the procedure name for the IRLM to be stopped.

Usage note

Terminating the IRLM: If IRLM does not shut down normally, issue the MODIFY
irlmproc,ABEND command to terminate the IRLM abnormally:
F irlmproc,ABEND,DUMP

| If outstanding DB2 requests are in process and IRLM does not terminate, use the
| z/OS CANCEL command. If all other means of removing the subsystem fail, issue
| the z/OS FORCE CANCEL command.

Example

Enter the following command on the system console:

P KRLM1

© Copyright IBM Corp. 1983, 2009 463

 IRLM outputs the following responses on system console:
DXR165I IR21 TERMINATED VIA IRLM MODIFY COMMAND
DXR121I IR21 END-OF-TASK CLEANUP SUCCESSFUL - HI-CSA 325K

In a data sharing environment: You cannot issue the STOP irlmproc command to
IRLM in a data sharing group until no DB2 subsystems are identified to that IRLM
and the IRLM issues the following messages:
DXR136I IR21 HAS DISCONNECTED FROM THE DATA SHARING GROUP

Any members that are still active in the group issue:

DXR137I JR21 GROUP STATUS CHANGED. IR21 233 HAS BEEN DISCONNECTED
FROM THE DATA SHARING GROUP

464 Command Reference

Chapter 89. -STOP PROCEDURE (DB2)
The DB2 command STOP PROCEDURE prevents DB2 from accepting SQL CALL
statements for one or more stored procedures.

You can qualify stored procedure names with a schema name. This command does
not prevent CALL statements from running if they have already been queued or
scheduled by DB2.

DB2 implicitly issues the command STOP PROCEDURE ACTION(REJECT) for any
stored procedure that exceeds the maximum abend count. That count is set by the
MAX ABEND COUNT field of installation panel DSNTIPX.

Abbreviation: -STO PROC

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 466
v “Option descriptions” on page 466
v “Usage notes” on page 467
v “Examples” on page 467

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group or local, depending on the value of the SCOPE option.

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v Ownership of the stored procedure
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

If you specify STOP PROCEDURE *.* or schema.partial-name *, the privilege set of

the process must include one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 465

 Syntax

(*.*)


STOP PROCEDURE

,

(  schema.procedure-name )
schema.partial-name*
procedure-name
partial-name*


QUEUE LOCAL
ACTION ( REJECT ) SCOPE ( GROUP )

Option descriptions
(*.*)
Stops access to all stored procedures in all schemas, including procedure
definitions that have not yet been accessed by DB2 applications.
( schema.procedure-name )
Identifies the fully-qualified procedure name that is to be stopped.
( schema.partial-name *)
Stops a set of stored procedures in the specified schema. The names of all
procedures in the set begin with partial-name and can end with any string,
including the empty string. For example, PAYROLL.* stops all stored
procedures in the PAYROLL schema.
procedure-name
Identifies one or more specific stored procedure names to be stopped. The
procedure name is implicitly qualified with the SYSPROC schema name.
partial-name *
Stops a set of stored procedures within the SYSPROC schema. The names of all
procedures in the set begin with partial-name and can end with any string,
including the empty string. For example, ABC* stops all stored procedures
with names that begin with ABC.
ACTION
Indicates what to do with a CALL statement that is received while the
procedure is stopped. If STOP PROCEDURE is issued more than once for a
given procedure, the action taken is determined by the ACTION option on the
most recent command.
(QUEUE)
Queues the request until either:
v The wait exceeds the installation timeout value, or
v The stored procedure is started by the command START
PROCEDURE.
(REJECT)
Rejects the request

466 Command Reference

 SCOPE
Specifies the scope of the command.
( LOCAL )
Specify to stop the procedure on the local member only.
(GROUP)
Specify to stop the procedure on all members of the data sharing group.

Usage notes

Permanently disabling a stored procedure: A stopped procedure does not remain

stopped if DB2 is stopped and restarted. To disable a stored procedure
permanently, you can:
v Drop the procedure using the DROP PROCEDURE statement.
v Use an ALTER PROCEDURE statement.
v Rename or delete the z/OS load module.

| Considerations for native SQL procedures: The STOP PROCEDURE command

| affects all versions of the native SQL procedures that you specify in the command.

Examples

Example 1: Stop access to all stored procedures, and terminate the DB2 stored
procedures address space. While the STOP PROCEDURE command is in effect,
attempts to execute stored procedures are queued.
-STOP PROCEDURE ACTION(QUEUE)
DSNX947I - DSNX9SP2 STOP PROCEDURE SUCCESSFUL FOR *.*
DSN9022I - DSNX9COM '-STOP PROC' NORMAL COMPLETION

Example 2: Stop access to all stored procedures, and terminate the DB2 stored
procedures address space. While the STOP PROCEDURE command is in effect,
attempts to execute stored procedures are rejected.
-STOP PROCEDURE ACTION(REJECT)
DSNX947I - DSNX9SP2 STOP PROCEDURE SUCCESSFUL FOR *.*
DSN9022I - DSNX9COM '-STOP PROC' NORMAL COMPLETION

Example 3: Stop stored procedures USERPRC1 and USERPRC3. While the STOP
PROCEDURE command is in effect, attempts to execute these stored procedure are
queued.
-STOP PROCEDURE(USERPRC1,USERPRC3)
DSNX947I - DSNX9SP2 STOP PROCEDURE SUCCESSFUL FOR USERPRC1
DSNX947I - DSNX9SP2 STOP PROCEDURE SUCCESSFUL FOR USERPRC3
DSN9022I - DSNX9COM '-STOP PROC' NORMAL COMPLETION

Example 4: Stop stored procedures USERPRC1 and USERPRC3. While the STOP
PROCEDURE command is in effect, attempts to execute these stored procedure are
rejected.
-STOP PROCEDURE(USERPRC1,USERPRC3) ACTION(REJECT)
DSNX947I - DSNX9SP2 STOP PROCEDURE SUCCESSFUL FOR USERPRC1
DSNX947I - DSNX9SP2 STOP PROCEDURE SUCCESSFUL FOR USERPRC3
DSN9022I - DSNX9COM '-STOP PROC' NORMAL COMPLETION

Chapter 89. -STOP PROCEDURE (DB2) 467

468 Command Reference
 Chapter 90. STOP PROFILE (DB2)
The STOP PROFILE command is used to stop or disable the profile function.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Examples”

Environment

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

| Syntax
|

|

STOP PROFILE

|

Examples

Example 1: This command is used to stop or disable the profile function.

-STOP PROFILE

© Copyright IBM Corp. 1983, 2009 469

470 Command Reference
Chapter 91. -STOP RLIMIT (DB2)
The DB2 command STOP RLIMIT stops the resource limit facility. STOP RLIMIT
resets all previously set limits to infinity and resets the accumulated time to zero.

All previously limited SQL statements (SELECT, UPDATE, DELETE, and INSERT)
executed through an SQL PREPARE or EXECUTE IMMEDIATE statement run with
no limit.

Abbreviation: -STO RLIM

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Example”

Environment

This command can be issued from a z/OS console, a DSN session under TSO, a
DB2I panel (DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Member

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following authorities:
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

Syntax

STOP RLIMIT


Example

Stop the resource limit facility.

-STOP RLIMIT

© Copyright IBM Corp. 1983, 2009 471

472 Command Reference
Chapter 92. -STOP TRACE (DB2)
The DB2 command STOP TRACE stops tracing.

One additional option to this command and additional values for a few other
options exist. This additional information is intended for service and use under the
direction of IBM Software Support.

Abbreviation: -STO TRA

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 474
v “Option descriptions” on page 476
v “Usage notes” on page 479
v “Examples” on page 482

Environment

This command can be issued from a z/OS console, a DSN session, a DB2I panel
(DB2 COMMANDS), an IMS or CICS terminal, or a program using the
instrumentation facility interface (IFI).

Data sharing scope: Group or local, depending on the value of the SCOPE option.

Authorization

To execute this command, you must use a privilege set of the process that includes
one of the following privileges or authorities:
v TRACE privilege
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

© Copyright IBM Corp. 1983, 2009 473

 Syntax

STOP TRACE ( PERFM ) DEST(  )

ACCTG GTF constraint block RMID
STAT SMF
AUDIT SRV
MONITOR OPn
*


COMMENT(string) LOCAL
SCOPE( GROUP )

|
| constraint block:

474 Command Reference

|



| * * *
, , ,

PLAN(  plan-name ) PKGLOC(  package-location ) PKGCOL(  package-collection-id )

partial-package-location partial-package-collection-id

|


| * * *
, , ,

PKGPROG(  package-program name ) AUTHID(  authorization-id ) CLASS(  integer )

partial-package-program name partial-userid

|


| * LOCATION( * ) *
, , ,

TNO(  integer )  location-name USERID(  userid )

<luname> partial-userid
partial-<luname>*
ipaddr
partial-ipaddr

|


| * *
, ,

APPNAME(  application-name ) WRKSTN(  workstation-name )

partial-application-name partial-workstation-name

|


| * *
, ,

CONNID(  connection-role-id ) CORRID(  correlation-id )

partial-connection-role-id partial-correlation-id

|


| * filtering block
,

ROLE(  connection-role )
partial-connection-role-id
|

|
| filtering block:

Chapter 92. -STOP TRACE (DB2) 475

|



| , ,

XPLAN(  plan-name ) XPKGLOC(  package-location )

partial-plan-name partial-package-location

|


| , ,

XPKGCOL(  package-collection-id ) XPKGPROG(  package-program-name )

partial-package-collection-id partial-package-program-name

|


| , , ,

XAUTHID(  authorization-id ) XLOC(  location-name ) XUSERID(  userid )

partial-authorization-id partial-location-name partial-userid
< luname >
partial-<luname>*
ipaddr
partial-ipaddr

|


| , ,

XAPPNAME(  application-name ) XWRKSTN(  workstation-name )

partial-application-name partial-workstation-name

|


| , ,

XCONNID(  connection-role-id ) XCORRID(  correlation-id )

partial-connection-role-id partial-correlation-id

|


| ,

XROLE(  connection-role )
partial-connection-role-id
|

Option descriptions

For additional descriptions of each of the following trace types, see Chapter 81,
“-START TRACE (DB2),” on page 423.
( PERFM )
Specify to stop a trace that is intended for performance analysis and tuning.
Abbreviation: P
( ACCTG )
Specify to stop an accounting trace.
Abbreviation: A
( STAT )
Specify to stop a trace that collects statistical data. The LOCATION option
cannot be specified when you choose a statistics trace.
Abbreviation: S
( AUDIT )
Specify to stop a trace that collects audit data from various components of
DB2.
Abbreviation: AU

476 Command Reference

 ( MONITOR )
Specify to stop a trace that collects monitor data.
Abbreviation: MON
(*) Specify to stop all trace activity. See “Usage notes” on page 479 for information
about using STOP TRACE (*) with traces that use monitor trace class 6.
SCOPE
Specifies the scope of the command.
( LOCAL )
Stops the trace only on the local DB2 subsystem.
(GROUP)
Stops the trace on all members of a data sharing group.
| RMID
| Specifies resource manager identifier. You can specify up to 8 valid RMIDs,
| which are one or two digit identifiers. You cannot specify RMID for accounting
| or statistic traces.
COMMENT ( string )
Gives a comment that is reproduced in the trace output record for the STOP
TRACE command (except in the resident trace tables).
string is any SQL string; it must be enclosed between apostrophes if it includes
a blank, comma, or special character.
DEST
Limits stopping to traces started for particular destinations. You can use more
than one value, but do not use the same value twice. If you do not specify a
value for DEST, DB2 does not use destination to limit which traces to stop.
Abbreviation: D
Possible values and their meanings are:
Value Trace destination
GTF The generalized trace facility
SMF The System Management Facility
SRV An exit to a user-written routine
OP n A specific destination. n can be a value from 1 to 8
See Chapter 81, “-START TRACE (DB2),” on page 423 for a list of allowable
destinations for each trace type.
PLAN( plan-name , ...)
Limits stopping to traces started for particular application plans. You can use
up to eight plan names. If you use more than one name, you can use only one
value for AUTHID, TNO, and LOCATION. Do not use this option with STAT.
The default is PLAN( * ) , which does not limit the command.
| PKGLOC
| Specifies the location name where the package is bound.
| PKGCOL
| Specifies the package collection name.
| PKGPROG
| Specifies the DBRM or program name.
AUTHID( authorization-id , ...)
Limits stopping to traces started for particular authorization identifiers. You

Chapter 92. -STOP TRACE (DB2) 477

 can use up to eight identifiers. If you use more than one identifier, you can use
only one value for PLAN, TNO, and LOCATION. Do not use this option with
STAT.
The default is AUTHID( * ) , which does not limit the command.
CLASS( integer , ...)
Limits stopping to traces started for particular classes. For descriptions of the
allowable classes, see Chapter 81, “-START TRACE (DB2),” on page 423. You
cannot specify a class if you did not specify a trace type.
Abbreviation: C
The default is CLASS( * ) , which does not limit the command.
TNO( integer , ...)
Limits stopping to particular traces, identified by their trace numbers (1 to 32,
01 to 09). You can use up to eight trace numbers. If you use more than one
number, you can use only one value each for PLAN, AUTHID, and
LOCATION.
The default is TNO( * ) , which does not limit the command.
LOCATION( location-name , ...)
Introduces a list of specific location names for which traces are stopped. Limits
the traces you can stop to those started for threads with connections to remote
locations; the use of the LOCATION option precludes stopping traces of
non-distributed threads.
You can specify up to eight location names. If you use more than one location
name, you can only use one value for PLAN, AUTHID, and TNO. You cannot
use this option with STAT.
The default is LOCATION( ), which does not limit the command.
(*) LOCATION(*) limits the command to those traces that were started with
the one or more location names specified on the LOCATION keyword of
START TRACE.
< luname >
Stops the DB2 trace for the remote clients that are connected to DDF
through the remote SNA LU that you specify in <luname>.
| ipaddr
| Stops the DB2 trace for remote clients that are connected to DDF through
| the remote TCP/IP host. ipaddr is the IP address.
Requesters other than DB2 for z/OS: DB2 does not receive a location name
from requesters that are not DB2. To display information about a requester that
is not a DB2 for z/OS subsystem, enter its LUNAME, enclosed by the less-than
(<) and greater-than (>) symbols. For example, to display information about a
requester with the LUNAME of LULA, enter the following command:
-STOP TRACE (*) LOCATION (<LULA>)
DB2 uses the <LUNAME> notation in messages displaying information about
requesters that are not DB2 for z/OS.
| USERID
| Specifies the userid.
| APPNAME
| Specifies the application name.

478 Command Reference

| WRKSTN
| Specifies the workstation name.
| CONNID
| Specifies the connection ID.
| CORRID
| Specifies the correlation ID.
| ROLE
| Specifies the connection roles.
| XPLAN
| Provides IFC exclude filtering for plan name.
| XPKGLOC
| Provides IFC exclude filtering for package location name.
| XPKGCOL
| Provides IFC exclude filtering for package collection ID.
| XPKGPROG
| Provides IFC exclude filtering for package program name.
| XAUTHID
| Provides IFC exclude filtering for authorization ID.
| XLOC
| Provides IFC exclude filtering for location.
| XUSERID
| Provides IFC exclude filtering for user ID.
| XAPPNAME
| Provides IFC exclude filtering for application or transaction name.
| XWRKSTN
| Provides IFC exclude filtering for workstation name.
| XCONNID
| Provides IFC exclude filtering for connection ID.
| XCORRID
| Provides IFC exclude filtering for correlation ID.
| XROLE
| Provides IFC exclude filtering for connection roles.

Usage notes

Stopping specific traces: Each option that you use, except TNO, limits the effect of
the command to active traces that were started using the same option, either
explicitly or by default, with exactly the same parameter values. For example, the
following command stops only the active traces that were started using the options
PERFM and CLASS (1,2):
-STOP TRACE (PERFM) CLASS (1,2)

This command does not stop, for example, any trace started using CLASS(1).

You must specify a trace type or an asterisk. For example, the following command
stops all active traces:
-STOP TRACE (*)

Chapter 92. -STOP TRACE (DB2) 479

 Traces that use monitor trace class 6: When stopping trace classes, a special
circumstance occurs if monitor trace class 6 is active. Monitor trace class 6 enables
and disables data propagation. To avoid accidentally stopping this trace class, the
commands STOP TRACE(*) and STOP TRACE(MON) CLASS(*) fail if monitor
trace class 6 is active.

To stop monitor trace class 6, you must explicitly specify it as one of the arguments
of the CLASS option of the STOP TRACE command, including any other monitor
trace classes that were started with monitor trace class 6. For example, if monitor
trace class 6 was started with the command START TRACE(MON) CLASS(1,3,6),
the following command stops it:
-STOP TRACE(MON) CLASS(1,3,6)

In the case where monitor trace class 6 was started with the command START
TRACE(MON) CLASS(*), you must explicitly specify all 32 monitor trace classes to
have monitor trace class 6 stopped:
-STOP TRACE(MON) CLASS(1,2,3,4,5,6,...32)

However, if monitor trace class 6 is not active the STOP TRACE(*) command stops
all active traces.

Traces started by a IFI/IFC program: Before you stop an active trace, ensure that
an IFI application program or the IFC Selective Dump utility (DSN1SDMP) did not
start the trace. If you stop a trace started by DSN1SDMP, the DSN1SDMP utility
abnormally terminates.

Tracing threads using the * wildcard: You can use the wildcard suffix, “*” to filter
threads. For example, if you specify “-STOP TRACE PLAN (A,B,C*)”, DB2 will
trace, and then return A, B, CDE, CDEFG, CDEFGH, and so on. It will trace
threads “A”, “B” and all threads starting with “C”.

Tracing threads using the positional, (_) wildcard: You can utilize the positional
wildcard, which is represented by the, “_” character, to trace threads when you
want the wildcard in the middle, or when you want to trace threads of a specific
length. For example, if you specify “-STOP TRACE PLAN (A_C), all threads will
be traced that are three characters that have “A” as the first character, and “C” as
the third. This command would return “ABC”, “ADC”, “AEC”, and so on. NOTE:
if you want to trace the thread “A_C” then you can specify “-STOP TRACE PLAN
(A/_C). The “/” before the “_” tells DB2 to trace for the underscore in the search,
rather than treating it as a wildcard. The same logic applies if you are trying to
trace a thread that includes a “/” or “*” character. Because the character “/” is an
escape character, if you are trying to trace a thread that has an “/” character in it,
you can specify, for example, “-STOP TRACE PLAN (A//C)” to trace the thread
“A/C”. You can also specify “-STOP TRACE PLAN (A/*C) to trace the thread
“A*C”.

Tracing multiple threads at once using wildcards: You also have the option of
tracing multiple threads based on multiple trace qualifications. For example, you
can specify, “-STOP TRACE PLAN (A*, B*, C*) to simultaneously trace ALL threads
for plan that start with “A”, “B”, and “C”. The wildcard character, “*” will trace all
threads. You can specify more complex combinations such as, “-STOP TRACE
PLAN (A_B*, C*, AND C/_D*)”, which will return all threads that:
v Begin with “A”, have a one character wild card as the second character in the
thread, have a “B” as the third character in the thread, and end with any type or
number of characters (ADBIOP, AOBTYJDP,)

480 Command Reference

v Begin with “C”, and end with any combination of characters (CDE, CGHKO)
v Begin with “C_D” and end with any type of character combination (C_DEFGH,
C_DLMNOP)
All of the possible thread combinations listed above will be returned with the
command above.

You have the ability to filter multiple threads at the same time, setting specific
criteria for the trace. For example, you can specify “-STOP TRACE PLAN (A)
USERID (B). This will trace the threads where the plan thread is A, and the user ID
is B. When tracing threads, you can only specify more than one thread criteria for
one filter per “-STOP TRACE” command. For example, you can specify “-STOP
TRACE PLAN (A,B) USERID (B) WRKSTN (E),” but you cannot specify “-STOP
TRACE PLAN (A, B) USER ID (A, B) WRKSTN (E) because, in this example, two
of the filter qualifications have two elements defined to be traced, and DB2 only
allows for one attribute to have more than one trace element to be defined per
trace.

Filtering threads using exclude functionality: When you specify an “X” with any
constraint keyword, such as “XPLAN”, when you are filtering threads, you are
using the exclude functionality for the –STOP TRACE command. You have the
option of excluding specific types of threads when you are running trace
commands. You can use the “X” character to exclude specific combinations of
characters when you are running a trace. For example, you can specify “-STOP
TRACE XPLAN(A), to trace all threads except “A”. In this instance B, BCD, BCDE,
or CD could possibly be returned.

You also have the option of excluding multiple types of threads from your trace.
For example, you can specify, “-STOP TRACE XPLAN (A*, B*) to trace all threads
except those starting with “A”, with any combination of characters following “A”,
and all those characters starting with “B”, with any combination of characters
following “B”. Note: Specifying XPLAN (*) excludes all threads from your search,
and is not allowed. You also cannot use the wildcard in the middle of a -STOP
TRACE command with exclude functionality, such as, “-STOP TRACE XPLAN
(A*C).” You can, however, specify “-STOP TRACE XPLAN (A_ _ C *)”, which will
return all threads except those starting with “A”, a variety of two characters next,
a “C” in the fourth space, and a variety of characters at the end. The wildcard
symbol cannot be placed in the middle of trace criteria.

You have the ability to stop two traces at once, in order to help you optimize your
tracing capabilities. For example, you can specify (-STOP TRACE XPLAN (A, B, C)
USERID (D))”. This tells DB2 to stop tracing all threads for plans except threads
“A”, “B”, or “C”, only where the user ID = “D”.

Combining trace qualifiers: You can customize the threads you trace by
commanding DB2 to trace specific threads, while excluding other specific threads.
For example, you can specify, “-STOP TRACE USERID (A,B) XPLAN (C)”. This
criteria only traces threads where the user ID is equal to “A” or “B”, and the plan
is not equal to “C”. In this example, a thread where the user ID is “A” and the
plan is equal to “D” would pass, and be traced, but a thread where the user ID is
“A” and plan is “C” would not pass, and would not be traced.

You can introduce wildcards into your stop trace commands to add more
customization to your traces. For example, you can specify “-STOP TRACE PLAN
(C*) USER ID (Z, X) XPLAN (C, D, E)”. In this example, for the thread to be
traced, the plan must begin with C, the user ID must be equal to Z or to X, and

Chapter 92. -STOP TRACE (DB2) 481

 the plan cannot be C, D, or E. Therefore, a plan of CB, with a user ID of Z would
pass, and the thread would be traced, but plan C with a user ID of X would fail
because the command specifies not to trace threads where the plan is “C”, without
additional characters in the thread.

Examples

Example 1: Stop all traces that have the generalized trace facility as their only
destination.
-STOP TRACE (*) DEST (GTF)

Example 2: Stop an accounting trace of all threads between the local and
USIBMSTODB21 DB2 subsystems for plan DSN8BC81. Include a comment.
-STOP TRACE (ACCTG)
PLAN (DSN8BC81)
LOCATION (USIBMSTODB21)
COMMENT('ACCTG TRACE FOR DSN8BC81')

Example 3: Stop trace number 4.

-STOP TRACE (P) TNO(4)

Example 4: Stop all active traces of any type for USIBMSTODB22.

-STOP TRACE (*) LOCATION (USIBMSTODB22)

Example 5: Stop all performance traces.

-STOP TRACE=P

Example 6: Stop all monitor tracing.

-STOP TRACE(MON)

Example 7: Stop all monitor tracing in a data sharing group.

-STOP TRACE(MON) SCOPE(GROUP)

482 Command Reference

 Chapter 93. -TERM UTILITY (DB2)
The DB2 command TERM UTILITY terminates execution of a DB2 utility job step
and releases all resources associated with the step.

When executing, a utility does not terminate until it checks to see that the TERM
UTILITY command was issued. Active utilities perform this check periodically. If
the utility is stopped, all its resources are released by the TERM UTILITY
command. An active utility can be terminated only from the DB2 on which it is
running. A stopped utility can be terminated from any active member of the data
sharing group.

Abbreviation: -TER UTIL

Subsections:
v “Environment”
v “Authorization”
v “Syntax” on page 484
v “Option descriptions” on page 484
v “Usage notes” on page 484
v “Examples” on page 485

Environment

This command can be issued from a z/OS console, a DSN session, DB2I panels
DB2 COMMANDS and DB2 UTILITIES, an IMS or CICS terminal, or a program
using the instrumentation facility interface (IFI).

Data sharing scope: Group or member. The utility is implicitly of group scope
when the utility is stopped.

Authorization

To execute this command, you must use the primary or some secondary
authorization ID of the process that originally submitted the utility job, or you
must use a privilege set of the process that includes one of the following
authorities:
v DBMAINT authority
v DBCTRL authority
v DBADM authority
v SYSOPR authority
v SYSCTRL authority
v SYSADM authority

| For utilities that run on objects in implicitly created databases, the database
| privilege or authority can be held on the implicitly created database or on
| DSNDB04. Ownership of the table spaces or index spaces on which the utility
| operates is also sufficient to terminate the utility. This means that the owner can
| display information about an implicitly created table space or index space if the
| command explicitly specifies that table space or index space name.

© Copyright IBM Corp. 1983, 2009 483

 The utilities DIAGNOSE, REPORT, and STOSPACE can be terminated only by the
job submitter or by a holder of SYSOPR, SYSCTRL, or SYSADM authority.

DB2 commands that are issued from a logged-on z/OS console or TSO SDSF can
be checked by DB2 authorization using primary and secondary authorization IDs.

For users with DBMAINT, DBCTRL, or DBADM authority, the command takes
effect only when DB2 can determine that the user has sufficient authority over
each object that the utility job accesses.

Database DSNDB06 contains the table spaces and index spaces that are required to
check authorization. If a table or index space that is required for authorization
checking is affected by a utility that you need to terminate, installation SYSADM
authority is required to terminate that utility.

Syntax

TERM UTILITY ( utility-id )


partial-utility-id*
*

Option descriptions

One of the following parameters must be specified.

( utility-id )
Is the utility identifier, or the UID parameter used when creating the utility job
step.
If utility-id was created by the DSNU CLIST by default, it has the form
tso-userid.control-file-name .
If utility-id was created by default by the EXEC statement invoking DSNUTILB,
then the token has the form userid.jobname .
( partial-utility-id* )
Terminates every utility job that begins with partial-utility-id . For example,
TERM UTILITY(ABCD*) terminates every utility job step whose utility
identifier begins with the letters ABCD. If you have a two-part utility ID, such
as ABCD.EFGH, TERM UTILITY(ABCD*) also terminates that utility.
(*)
Terminates every utility job step known to DB2 for which you are authorized.

Usage notes

Restarting utilities: A terminated utility job step cannot be restarted. You must
resubmit the step as a new utility job.

What happens to particular utilities: In some cases, terminating a utility job can
leave work in an undesirable state, requiring special processing before the job can
be resubmitted. The following list describes the effects of TERM UTILITY on jobs
for each of the utilities:
Utility Special effects of the TERM UTILITY command

484 Command Reference

CATENFM
None.
CATMAINT
Places indexes in REBUILD-pending status.
CHECK DATA
Table spaces remain in CHECK-pending status.
CHECK INDEX
None.
CHECK LOB
Places LOB table spaces and indexes in the utility read-only (UTRO) state.
COPY Inserts “T” record in SYSIBM.SYSCOPY. When you run COPY, COPY does
not allow an incremental image copy if the “T” record exists.
DIAGNOSE
None.
LOAD
MERGECOPY
None.
MODIFY RECOVERY
None.
MODIFY STATISTICS
None.
QUIESCE
None.
REBUILD INDEX
Places the object that is being rebuilt in REBUILD-pending status.
RECOVER
Places the object that is being recovered in RECOVER-pending status.
REORG INDEX
REORG TABLESPACE
REPAIR
None.
REPORT
None.
RUNSTATS
None.
STOSPACE
None.
UNLOAD
The output data set remains incomplete until you restart the utility job or
delete the data set.

Examples

Example 1: Terminate all utility jobs for which you are authorized.
-TERM UTILITY (*)

Chapter 93. -TERM UTILITY (DB2) 485

 Example 2: Terminate all utility jobs whose utility ID begins with SMITH.
-TERM UTILITY
(SMITH*)

486 Command Reference

Chapter 94. /TRACE (IMS)
The IMS /TRACE command directs and controls the IMS capabilities for tracing
internal IMS events. It also starts, stops, and defines the activity to be monitored
by the IMS Monitor.

Abbreviation: /TRA

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Examples” on page 488

Environment

This command can be issued only from an IMS terminal.

Data sharing scope: Member

Authorization

To enter this command, users must have passed the IMS security check.

The syntax diagram includes only those parameters that DB2 users need to know.

Syntax

/TRACE SET ON

OFF ALL NOLOG
TABLE SUBS OPTION LOG

Option descriptions

This topic provides information about the two parameters of the TRACE command
that are especially important for DB2 users.
SUBS
Indicates that the external subsystem trace table (containing information about
every interaction with DB2) is to be enabled or disabled. SET ON TABLE SUBS
enables the DB2 trace facility, and SET OFF TABLE SUBS disables it.
If nothing is specified with the TABLE keyword, then the default is ALL; ALL
includes SUBS, as well as other trace tables.
LOG
Specifies that traced data is to be written to the IMS system log. Because IMS
has a tracing mechanism that writes trace entries to the IMS system log, it is

© Copyright IBM Corp. 1983, 2009 487

 important that DB2 users specify SET ON and TABLE OPTION LOG.
Otherwise, the trace information that IMS provides will not be available unless
a control region dump occurs.

Examples

Example 1: This command starts IMS tracing and:

v Enables the DB2 trace
v Writes IMS trace tables to the IMS log before they wrap.
/TRACE SET ON TABLE SUBS OPTION LOG

Example 2: This command starts IMS tracing and:

v Enables all trace tables (including DB2 trace tables); (ALL is the default
parameter for the TABLE keyword)
v Writes IMS trace tables to the IMS log before they wrap.
/TRACE SET ON TABLE ALL OPTION LOG

488 Command Reference

Chapter 95. TRACE CT (z/OS IRLM)
The z/OS command TRACE CT starts, stops, or modifies a diagnostic trace for the
internal resource lock manager (IRLM) of DB2.

IRLM does not support all the options available on the TRACE command.

Subsections:
v “Environment”
v “Authorization”
v “Syntax”
v “Option descriptions”
v “Usage notes” on page 490

Environment

This command can be issued only from a z/OS console.

Data sharing scope: Member

Authorization

This command requires an appropriate level of operating system authority.

The syntax diagram and option descriptions for this command are purposely
incomplete.

Syntax

,WRAP


TRACE CT, WTRSTART=parmlibmem

,NOWRAP
WTRSTOP=jobname
ON, COMP=irlmssnm
,SUB=( DBM )
EXP
INT
SLM
XCF
XIT
OFF

Option descriptions
CT
Specifies the component trace. (Do not use other trace options available on the
z/OS TRACE command).
WTRSTART= parmlibmem
Identifies the member that contains source JCL. That JCL executes the
© Copyright IBM Corp. 1983, 2009 489
 CTRACE writer and defines the data set to which it writes the trace
buffers. This member can be a procedure cataloged in SYS1.PROCLIB or a
job.
WRAP
Specifies that when the system reaches the end of the group of data
sets, it writes over the oldest data at the beginning of the first data set
in the group. The system uses only the primary extents of the data
sets.
NOWRAP
Specifies that the system stops writing to the data sets when they are
all full. The system uses the primary and secondary extents of the data
sets.
WTRSTOP= jobname
Stops the CTRACE writer for a trace that is running. The system also
closes the data sets that the writer used.
jobname identifies the trace, either by:
v Member name, if the source JCL is a procedure
v Job name, if that appears on a JOB statement in the source JCL
ON
Turns on the trace.
COMP= irlmssnm
Gives the IRLM subsystem name.
SUB= subname
Specifies the type of sublevel trace. Traces INT, EXP, and XIT are
ON by default. You cannot turn off traces INT and EXP. If you do
not specify a subname on the TRACE command, the trace is
performed on all subnames that you control. Specifying one
subname restricts the traces to that trace plus the EXP and INT
traces.
Use: To trace:
DBM Interactions with the identified DBMS
EXP Any exception condition
INT Member and group events outside normal locking activity
SLM Interactions with the z/OS locking component
XCF All interactions with z/OS cross-system coupling services
XIT Only asynchronous interactions with the z/OS locking
component
OFF
Turns off the trace. If IRLM is connected to a CTRACE writer for the
component trace, the system disconnects it.

Usage notes

Include the IRLM load module in the z/OS link list: This command uses z/OS
component trace services. Include the IRLM load module DXRRL183, which
contains a routine for stopping and starting, in the z/OS link list.

Displaying a trace: To display a trace, use the z/OS DISPLAY command:

| D TRACE,COMP=IRLM

490 Command Reference

| The z/OS DISPLAY TRACE command output is incorrect for IRLM unless you use
| TRACE CT commands to inform z/OS of the TRACE status. IRLM initializes it’s
| own traces and writes them in CTRACE format, but IRLM has no interface to
| z/OS to inform it of the status. If you want to know the true status of the traces
| without using TRACE CT commands to inform z/OS, use the MODIFY
| irlmproc,STATUS,TRACE command.

Monitoring a trace: To monitor a trace, use the z/OS MODIFY

irlmproc,STATUS,TRACE command.

Setting the number of trace buffers: To set the number of trace buffers used by
traces, use the z/OS MODIFY irlmproc,SET command.

Sample procedure for the CTRACE writer: This procedure identifies the data set to
| which the next sample procedure writes data. The external trace writer must be
| executed at the same or higher dispatch priority as IRLM. This allows the I/O to
| keep up with the filling of the trace buffers.
//CTWTR PROC
// EXEC PGM=ITTTRCWR
//TRCOUT01 DD DSNAME=SYS1.WTR1,DISP=OLD
//TRCOUT02 DD DSNAME=SYS1.WTR2,DISP=OLD

Sample procedure to start and stop a DBM trace to the CTRACE writer: After you
enter the command TRACE CT,WTRSTART, turn the trace on and connect the
writer, using the WTR parameter in the reply for the command TRACE CT.
TRACE CT,WTRSTART=CTWTR
| TRACE
. CT,ON,COMP=IRLM,SUB=(DBM)
.
.
. (z/OS asks for a reply)
.
.
R 15,WTR=CTWTR,END
| TRACE
. CT,OFF,COMP=IRLM,SUB=(DBM)
.
.
(Wait to make sure trace buffers are externalized.)
TRACE CT,WTRSTOP=CTWTR

Sample procedure to start and stop traces in wrap-around mode: Traces captured
in this procedure are saved in a limited number of buffers that are provided by
IRLM. Each buffer is reused when the previous buffer is filled. To start the trace in
this wrap-around mode, enter the following commands:
| TRACE
. CT,ON,COMP=IRLM
.
.
. (z/OS asks for a reply)
.
.
R
. 15,END
.
.
| TRACE CT,OFF,COMP=IRLM

Impact of setting TRACE CT ON: Each active subname type requires up to 0.7 MB
of ECSA. Because IRLM initializes its own traces when it starts, the DISPLAY
TRACE command shows that all traces are off. After you issue the TRACE ON
command, the reports are accurate except for the two subname types, INT and
EXT, which cannot be turned off.

Chapter 95. TRACE CT (z/OS IRLM) 491

492 Command Reference
Part 4. Appendixes

© Copyright IBM Corp. 1983, 2009 493

494 Command Reference
 Appendix. Directory of subsystem parameters and
DSNHDECP values
Most subsystem parameters are associated with a macro and an installation panel.

The following table displays each macro parameter, and the macro where it is
located. The table also shows the name of the installation panel that is associated
with each parameter, whether each parameter can be updated online, and
corresponding topics. Online update capability does not apply to macro
DSNHDECP; therefore, update values are not listed for those parameters.

| Some parameters, when updated online, result in a change in system behavior.

| These parameters include:
v CACHEDYN
| v CACHEDYN_FREELOCAL
v MAXKEEPD
v PARTKEYU
v SYSADM/SYSADM2
v XLKUPDLT
Table 33. Directory of subsystem parameters and DSNHDECP values
Update
Parameter Macro Panel Online

ABEXP DSN6SPRM DSNTIPO Yes

ABIND DSN6SPRM DSNTIPO Yes
| ACCUMACC DSN6SYSP DSNTIPN Yes
ACCUMUID DSN6SYSP DSNTIPN Yes
| ADMTPROC DSN6SPRM — No
AEXITLIM DSN6SPRM DSNTIPP Yes
AGCCSID DSNHDECP DSNTIPF —
ALCUNIT DSN6ARVP DSNTIPA Yes
ALL/dbname DSN6SPRM DSNTIPS —
AMCCSID DSNHDECP DSNTIPF —
APPENSCH DSNHDECP DSNTIPF —
ARCPFX1 DSN6ARVP DSNTIPH Yes
ARCPFX2 DSN6ARVP DSNTIPH Yes
ARCRETN DSN6ARVP DSNTIPA Yes
ARCWRTC DSN6ARVP DSNTIPA Yes
ARCWTOR DSN6ARVP DSNTIPA Yes
ARC2FRST DSN6LOGP DSNTIPO Yes
ASCCSID DSNHDECP DSNTIPF —
ASSIST DSN6GRP DSNTIPK No
AUDITST DSN6SYSP DSNTIPN No
AUTH DSN6SPRM DSNTIPP No
AUTHCACH DSN6SPRM DSNTIPP Yes
BACKODUR DSN6SYSP DSNTIPL No
BINDNV DSN6SPRM DSNTIPP Yes
BLKSIZE DSN6ARVP DSNTIPA Yes
BMPTOUT DSN6SPRM DSNTIPI Yes
| CACHEDYN DSN6SPRM DSNTIP8 Yes

© Copyright IBM Corp. 1983, 2009 495

 Table 33. Directory of subsystem parameters and DSNHDECP values (continued)
Update
Parameter Macro Panel Online

| CACHEDYN_FREELOCAL DSN6SPRM — Yes

CACHEPAC DSN6SPRM DSNTIPP No
CACHERAC DSN6SPRM DSNTIPP No
CATALOG DSN6ARVP DSNTIPA Yes
″ DSN6SPRM DSNTIPA2 —
CDSSRDEF DSN6SPRM DSNTIP8 Yes
| CHGDC DSN6SPRM DSNTIPO Yes
CHKFREQ DSN6SYSP DSNTIPL Yes
CMTSTAT DSN6FAC DSNTIPR No
| COMCRIT DSN6SPRM — Yes
COMPACT DSN6ARVP DSNTIPA Yes
COMPAT DSNHDECP — —
COMPRESS_SPT01 DSN6SPRM — Yes
CONDBAT DSN6SYSP DSNTIPE Yes
CONTSTOR DSN6SPRM DSNTIPE Yes
COORDNTR DSN6GRP DSNTIPK No
CTHREAD DSN6SYSP DSNTIPE Yes
DBACRVW DSN6SPRM DSNTIPP Yes
DATE DSNHDECP DSNTIP4 —
DATELEN DSNHDECP DSNTIP4 —
DB2SUPLD DSNHDECP — —
DDF DSN6FAC DSNTIPR No
DEALLCT DSN6LOGP DSNTIPA Yes
DECARTH DSNHDECP DSNTIP4 —
DECDIV3 DSN6SPRM DSNTIP4 No
DECIMAL DSNHDECP DSNTIPF —
| DEF_DECFLOAT_ROUND_MODE DSNHDECP DSNTIPF —
DEFLANG DSNHDECP DSNTIPF —
DEFLTID DSN6SPRM DSNTIPP No
DELIM DSNHDECP DSNTIPF —
DESCSTAT DSN6SPRM DSNTIP4 Yes
| DISABSCL DSN6SPRM — Yes
DLDFREQ DSN6SYSP DSNTIPL Yes
DLITOUT DSN6SPRM DSNTIPI Yes
DSHARE DSN6GRP DSNTIPA1 No
DSMAX DSN6SPRM DSNTIPC Yes
DSQLDELI DSNHDECP DSNTIPF —
DSSTIME DSN6SYSP DSNTIPN Yes
DSVCI DSN6SYSP DSNTIP7 Yes
| DYNRULS DSNHDECP DSNTIP4 —
| EDM_SKELETON_POOL DSN6SPRM DSNTIPC Yes
EDMBFIT DSN6SPRM DSNTIP8 Yes
EDMDBDC DSN6SPRM DSNTIPC Yes
EDMPOOL DSN6SPRM DSNTIPC Yes
| EDMSTMTC DSN6SPRM DSNTIPC Yes
| EDPROP DSN6SPRM DSNTIPO Yes
ENSCHEME DSNHDECP DSNTIPF —
EVALUNC DSN6SPRM DSNTIP8 Yes
| EXTRAREQ DSN6SYSP DSNTIP5 Yes
| EXTRASRV DSN6SYSP DSNTIP5 Yes
EXTSEC DSN6SYSP DSNTIPR Yes

496 Command Reference

 Table 33. Directory of subsystem parameters and DSNHDECP values (continued)
Update
Parameter Macro Panel Online

GCCSID DSNHDECP DSNTIPF —

GRPNAME DSN6GRP DSNTIPK No
| HONOR_KEEPDICTIONARY DSN6SPRM — Yes
HOPAUTH DSN6SPRM DSNTIP5 No
IDBACK DSN6SYSP DSNTIPE Yes
IDFORE DSN6SYSP DSNTIPE Yes
| IDTHTOIN DSN6FAC DSNTIPR Yes
IDXBPOOL DSN6SYSP DSNTIP1 Yes
| IGNSORTN DSN6SPRM DSNTIP6 Yes
| IMMEDWRI DSN6GRP DSNTIP8 Yes
| IMPDSDEF DSN6SYSP DSNTIP7 Yes
| IMPTSCMP DSN6SYSP DSNTIP7 Yes
INLISTP DSN6SPRM — Yes
IRLMAUT DSN6SPRM DSNTIPI No
IRLMPRC DSN6SPRM DSNTIPI No
IRLMRWT DSN6SPRM DSNTIPI No
IRLMSID DSN6SPRM DSNTIPI No
IRLMSWT DSN6SPRM DSNTIPI Yes
IXQTY DSN6SYSP DSNTIP7 Yes
LBACKOUT DSN6SYSP DSNTIPL No
LC_CTYPE DSNHDECP DSNTIPF —
LEMAX DSN6SPRM DSNTIPD No
| LOBVALA DSN6SYSP DSNTIPD Yes
LOBVALS DSN6SYSP DSNTIPD Yes
LOGAPSTG DSN6SYSP DSNTIPL No
LRDRTHLD DSN6SYSP DSNTIPE Yes
| MAINTYPE DSN6SPRM DSNTIP8 Yes
| MAX_CONCURRENT_PKG_OPS DSN6SPRM — Yes
MAX_NUM_CUR DSN6SPRM DSNTIPX Yes
MAX_ST_PROC DSN6SPRM DSNTIPX Yes
| MAX_UTIL_PARTS DSN6SPRM — Yes
MAXARCH DSN6LOGP DSNTIPA No
MAXDBAT DSN6SYSP DSNTIPE Yes
| MAXKEEPD DSN6SPRM DSNTIPE Yes
| MAXOFILR DSN6SYSP DSNTIPE Yes
MAXRBLK DSN6SPRM DSNTIPC Yes
MAXRTU DSN6LOGP DSNTIPA Yes
| MAXTEMPS DSN6SPRM DSNTIP9 Yes
| MAXTYPE1 DSN6FAC DSNTIPR Yes
MCCSID DSNHDECP DSNTIPF —
MEMBNAME DSN6GRP DSNTIPK No
MGEXTSZ DSN6SYSP DSNTIP7 Yes
MINSTOR DSN6SPRM DSNTIPE Yes
MIXED DSNHDECP DSNTIPF —
MON DSN6SYSP DSNTIPN No
MONSIZE DSN6SYSP DSNTIPN No
| MXDTCACH DSN6SPRM DSNTIP8 Yes
| NEWFUN DSNHDECP DSNTIPA1 —
NPGTHRSH DSN6SPRM — Yes
NUMLKTS DSN6SPRM DSNTIPJ Yes
NUMLKUS DSN6SPRM DSNTIPJ Yes

Appendix. Directory of subsystem parameters and DSNHDECP values 497

 Table 33. Directory of subsystem parameters and DSNHDECP values (continued)
Update
Parameter Macro Panel Online

| OJPERFEH DSN6SPRM — No
OPTHINTS DSN6SPRM DSNTIP8 Yes
| OPTHYBCST DSN6SPRM — Yes
| OPTIOWGT DSN6SPRM — Yes
| OPTOIRCPF DSN6SPRM — Yes
| OTC_LICENSE DSN6SYSP — No
OUTBUFF DSN6LOGP DSNTIPL No
PADIX DSN6SPRM DSNTIPE Yes
| PADNTSTR DSNHDECP DSNTIP4 Yes
PARAMDEG DSN6SPRM DSNTIP8 Yes
| PARTKEYU DSN6SPRM DSNTIP8 Yes
PCLOSEN DSN6SYSP DSNTIPL Yes
PCLOSET DSN6SYSP DSNTIPL Yes
| PLANMGMT DSN6SPRM — Yes
| POOLINAC DSN6FAC DSNTIP5 Yes
PRIQTY DSN6ARVP DSNTIPA Yes
PROTECT DSN6ARVP DSNTIPP Yes
PTASKROL DSN6SYSP — Yes
QUIESCE DSN6ARVP DSNTIPA Yes
| RANDOMATT DSN6GRP — Yes
RECALL DSN6SPRM DSNTIPO No
RECALLD DSN6SPRM DSNTIPO Yes
| REFSHAGE DSN6SPRM DSNTIP8 Yes
| REORG_IGNORE_FREESPACE DSN6SPRM — Yes
RESTART/DEFER DSN6SPRM DSNTIPS —
| RESTORE_RECOVER_FROMDUMP DSN6SPRM DSNTIP6 Yes
| RESTORE_TAPEUNITS DSN6SPRM DSNTIP6 Yes
| RESYNC DSN6FAC DSNTIPR Yes
RETLWAIT DSN6SPRM DSNTIPI Yes
RETVLCFK DSN6SPRM DSNTIP8 Yes
RGFCOLID DSN6SPRM DSNTIPZ No
RGFDBNAM DSN6SPRM DSNTIPZ No
RGFDEDPL DSN6SPRM DSNTIPZ No
RGFDEFLT DSN6SPRM DSNTIPZ No
RGFESCP DSN6SPRM DSNTIPZ No
RGFFULLQ DSN6SPRM DSNTIPZ No
RGFINSTL DSN6SPRM DSNTIPZ No
RGFNMORT DSN6SPRM DSNTIPZ No
RGFNMPRT DSN6SPRM DSNTIPZ No
RLF DSN6SYSP DSNTIPO No
RLFAUTH DSN6SYSP DSNTIPP Yes
RLFERR DSN6SYSP DSNTIPO Yes
RLFERRD DSN6FAC DSNTIPR Yes
RLFTBL DSN6SYSP DSNTIPO Yes
ROUTCDE DSN6SYSP DSNTIPO No
RRULOCK DSN6SPRM DSNTIPI Yes
SCCSID DSNHDECP DSNTIPF —
SECQTY DSN6ARVP DSNTIPA Yes
SEQCACH DSN6SPRM DSNTIPE Yes
| SEQPRES DSN6SPRM DSNTIP6 Yes
SITETYP DSN6SPRM DSNTIPO No

498 Command Reference

 Table 33. Directory of subsystem parameters and DSNHDECP values (continued)
Update
Parameter Macro Panel Online

SJTABLES DSN6SPRM — Yes

SKIPUNCI DSN6SPRM DSNTIP8 Yes
SMF89 DSN6SYSP — Yes
SMFACCT DSN6SYSP DSNTIPN No
SMFSTAT DSN6SYSP DSNTIPN No
SMSDCFL DSN6SPRM — Yes
SMSDCIX DSN6SPRM — Yes
SQLDELI DSNHDECP DSNTIPF —
| SRTPOOL DSN6SPRM DSNTIPC Yes
SSID DSNHDECP DSNTIPM —
STARJOIN DSN6SPRM DSNTIP8 Yes
| STATCLUS DSN6SPRM DSNTIP6 Yes
| STATHIST DSN6SPRM DSNTIP6 Yes
STATIME DSN6SYSP DSNTIPN Yes
| STATROLL DSN6SPRM DSNTIP6 Yes
STATSINT DSN6SPRM DSNTIPO Yes
STDSQL DSNHDECP DSNTIP4 —
STORMXAB DSN6SYSP DSNTIPX Yes
STORTIME DSN6SYSP DSNTIPX Yes
SUPERRS DSN6SPRM DSNTIPM Yes
| SUPPRESS_TS_CONV_WARNING DSN6SPRM — Yes
SVOLARC DSN6ARVP DSNTIPA Yes
SYNCVAL DSN6SYSP DSNTIPN Yes
| SYSADM DSN6SPRM DSNTIPP Yes
| SYSADM2 DSN6SPRM DSNTIPP Yes
| SYSOPR1 DSN6SPRM DSNTIPP Yes
| SYSOPR2 DSN6SPRM DSNTIPP Yes
| SYSTEM_LEVEL_BACKUPS DSN6SPRM DSNTIP6 Yes
| TBSBP8K DSN6SYSP DSNTIP1 Yes
| TBSBP16K DSN6SYSP DSNTIP1 Yes
| TBSBP32K DSN6SYSP DSNTIP1 Yes
| TBSBPLOB DSN6SYSP DSNTIP1 Yes
TBSBPOOL DSN6SYSP DSNTIP1 Yes
| TBSBPXML DSN6SYSP DSNTIP1 Yes
| TCPALVER DSN6FAC DSNTIP5 Yes
| TCPKPALV DSN6FAC DSNTIP5 Yes
TIME DSNHDECP DSNTIP4 —
TIMELEN DSNHDECP DSNTIP4 —
TRACSTR DSN6SYSP DSNTIPN No
TRACTBL DSN6SYSP DSNTIPN No
TRKRSITE DSN6SPRM DSNTIPO No
TSQTY DSN6SYSP DSNTIP7 Yes
TSTAMP DSN6ARVP DSNTIPH Yes
TWOACTV DSN6LOGP DSNTIPH No
TWOARCH DSN6LOGP DSNTIPH No
TWOBSDS DSN6LOGP — No
UGCCSID DSNHDECP DSNTIPF —
| UIFCIDS DSN6SYSP DSNTIPN Yes
UMCCSID DSNHDECP DSNTIPF —
| UNION_COLNAME_7 DSN6SPRM — Yes
UNIT DSN6ARVP DSNTIPA Yes

Appendix. Directory of subsystem parameters and DSNHDECP values 499

 Table 33. Directory of subsystem parameters and DSNHDECP values (continued)
Update
Parameter Macro Panel Online

UNIT2 DSN6ARVP DSNTIPA Yes

URCHKTH DSN6SYSP DSNTIPL Yes
URLGWTH DSN6SYSP DSNTIPL Yes
USCCSID DSNHDECP DSNTIPF —
| UTIL_TEMP_STORCLAS DSN6SPRM — Yes
| UTILS_DUMP_CLASS_NAME DSN6SPRM DSNTIP6 Yes
| UTIMOUT DSN6SPRM DSNTIP6 Yes
| UTSORTAL DSN6SPRM DSNTIP6 Yes
| VOLTDEVT DSN6SPRM DSNTIP6 Yes
WLMENV DSN6SYSP DSNTIPX Yes
| XLKUPDLT DSN6SPRM DSNTIPI Yes
| XMLVALA DSN6SYSP DSNTIPD Yes
| XMLVALS DSN6SYSP DSNTIPD Yes
| ZOSMETRICS DSN6SPRM — No

500 Command Reference

Information resources for DB2 for z/OS and related products
Many information resources are available to help you use DB2 for z/OS and many
related products. A large amount of technical information about IBM products is
now available online in information centers or on library Web sites.

Disclaimer: Any Web addresses that are included here are accurate at the time this
information is being published. However, Web addresses sometimes change. If you
visit a Web address that is listed here but that is no longer valid, you can try to
find the current Web address for the product information that you are looking for
at either of the following sites:
v http://www.ibm.com/support/publications/us/library/index.shtml, which lists
the IBM information centers that are available for various IBM products
v http://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/
pbi.cgi, which is the IBM Publications Center, where you can download online
PDF books or order printed books for various IBM products

DB2 for z/OS product information

The primary place to find and use information about DB2 for z/OS is the
Information Management Software for z/OS Solutions Information Center
(http://publib.boulder.ibm.com/infocenter/imzic), which also contains information
about IMS, QMF™, and many DB2 and IMS Tools products. This information center
is also available as an installable information center that can run on a local system
or on an intranet server. You can order the Information Management for z/OS
Solutions Information Center DVD (SK5T-7377) for a low cost from the IBM
Publications Center (www.ibm.com/shop/publications/order).

The majority of the DB2 for z/OS information in this information center is also
available in the books that are identified in the following table. You can access
these books at the DB2 for z/OS library Web site (http://www.ibm.com/software/
data/db2/zos/library.html) or at the IBM Publications Center
(http://www.ibm.com/shop/publications/order).
Table 34. DB2 Version 9.1 for z/OS book titles
Available in Available in
Publication information Available in BookManager® Available in
Title number center PDF format printed book
DB2 Version 9.1 for z/OS SC18-9840 X X X X
Administration Guide
DB2 Version 9.1 for z/OS Application SC18-9841 X X X X
Programming & SQL Guide
DB2 Version 9.1 for z/OS Application SC18-9842 X X X X
Programming Guide and Reference for
Java
DB2 Version 9.1 for z/OS Codes GC18-9843 X X X X
DB2 Version 9.1 for z/OS Command SC18-9844 X X X X
Reference
DB2 Version 9.1 for z/OS Data Sharing: SC18-9845 X X X X
Planning and Administration

© Copyright IBM Corp. 1983, 2009 501

Table 34. DB2 Version 9.1 for z/OS book titles (continued)
Available in Available in
Publication information Available in BookManager® Available in
Title number center PDF format printed book
DB2 Version 9.1 for z/OS Diagnosis LY37-3218 X X X
Guide and Reference 1
DB2 Version 9.1 for z/OS Diagnostic LY37-3219 X
Quick Reference
DB2 Version 9.1 for z/OS Installation GC18-9846 X X X X
Guide
DB2 Version 9.1 for z/OS Introduction to SC18-9847 X X X X
DB2
DB2 Version 9.1 for z/OS Licensed GC18-9848 X X
Program Specifications
DB2 Version 9.1 for z/OS Messages GC18-9849 X X X X
DB2 Version 9.1 for z/OS ODBC Guide SC18-9850 X X X X
and Reference
DB2 Version 9.1 for z/OS Performance SC18-9851 X X X X
Monitoring and Tuning Guide
DB2 Version 9.1 for z/OS Optimization X
Service Center
DB2 Version 9.1 for z/OS Program GI10-8737 X X
Directory
DB2 Version 9.1 for z/OS RACF Access SC18-9852 X X X
Control Module Guide
DB2 Version 9.1 for z/OS Reference for SC18-9853 X X X
Remote DRDA Requesters and Servers
DB2 Version 9.1 for z/OS Reference SX26-3854 X
Summary
DB2 Version 9.1 for z/OS SQL Reference SC18-9854 X X X X
DB2 Version 9.1 for z/OS Utility Guide SC18-9855 X X X X
and Reference
DB2 Version 9.1 for z/OS What’s New? GC18-9856 X X X
DB2 Version 9.1 for z/OS XML Extender SC18-9857 X X X X
Administration and Programming
DB2 Version 9.1 for z/OS XML Guide SC18-9858 X X X X
IRLM Messages and Codes for IMS and GC19-2666 X X X
DB2 for z/OS
Note:
1. DB2 Version 9.1 for z/OS Diagnosis Guide and Reference is available in PDF and BookManager formats on the DB2
Version 9.1 for z/OS Licensed Collection kit, LK3T-7195. You can order this License Collection kit on the IBM
Publications Center site (http://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgi).
This book is also available in online format in DB2 data set DSN910.SDSNIVPD(DSNDR).

Information resources for related products

In the following table, related product names are listed in alphabetic order, and the
associated Web addresses of product information centers or library Web pages are
indicated.

502 Command Reference

Table 35. Related product information resource locations
Related product Information resources
C/C++ for z/OS Library Web site: http://www.ibm.com/software/awdtools/czos/library/

This product is now called z/OS XL C/C++.

CICS Transaction Server for Information center: http://publib.boulder.ibm.com/infocenter/cicsts/v3r1/index.jsp
z/OS
COBOL Information center: http://publib.boulder.ibm.com/infocenter/pdthelp/v1r1/index.jsp

This product is now called Enterprise COBOL for z/OS.

® ™
DB2 Connect Information center: http://publib.boulder.ibm.com/infocenter/db2luw/v9/index.jsp

This resource is for DB2 Connect 9.

DB2 Database for Linux, Information center: http://publib.boulder.ibm.com/infocenter/db2luw/v9/index.jsp
UNIX, and Windows
This resource is for DB2 9 for Linux, UNIX, and Windows.
DB2 Query Management Information center: http://publib.boulder.ibm.com/infocenter/imzic
Facility
DB2 Server for VSE & VM One of the following locations:
v For VSE: http://www.ibm.com/support/docview.wss?rs=66&uid=swg27003758
v For VM: http://www.ibm.com/support/docview.wss?rs=66&uid=swg27003759
DB2 Tools One of the following locations:
v Information center: http://publib.boulder.ibm.com/infocenter/imzic
v Library Web site: http://www.ibm.com/software/data/db2imstools/library.html

These resources include information about the following products and others:
v DB2 Administration Tool
v DB2 Automation Tool
v DB2 Log Analysis Tool
v DB2 Object Restore Tool
v DB2 Query Management Facility
v DB2 SQL Performance Analyzer
DB2 Universal Database Information center: http://www.ibm.com/systems/i/infocenter/
for iSeries®
Debug Tool for z/OS Information center: http://publib.boulder.ibm.com/infocenter/pdthelp/v1r1/index.jsp
Enterprise COBOL for Information center: http://publib.boulder.ibm.com/infocenter/pdthelp/v1r1/index.jsp
z/OS
Enterprise PL/I for z/OS Information center: http://publib.boulder.ibm.com/infocenter/pdthelp/v1r1/index.jsp
IMS Information center: http://publib.boulder.ibm.com/infocenter/imzic

Information resources for DB2 for z/OS and related products 503
 Table 35. Related product information resource locations (continued)
Related product Information resources
IMS Tools One of the following locations:
v Information center: http://publib.boulder.ibm.com/infocenter/imzic
v Library Web site: http://www.ibm.com/software/data/db2imstools/library.html

These resources have information about the following products and others:
v IMS Batch Terminal Simulator for z/OS
v IMS Connect
v IMS HALDB Conversion and Maintenance Aid
v IMS High Performance Utility products
v IMS DataPropagator™
v IMS Online Reorganization Facility
v IMS Performance Analyzer
Integrated Data Information center: http://publib.boulder.ibm.com/infocenter/idm/v2r2/index.jsp
Management products
This information center has information about the following products and others:
v IBM Data Studio
v InfoSphere™ Data Architect
v InfoSphere Warehouse
v Optim™ Database Administrator
v Optim Development Studio
v Optim Query Tuner
PL/I Information center: http://publib.boulder.ibm.com/infocenter/pdthelp/v1r1/index.jsp

This product is now called Enterprise PL/I for z/OS.

®
System z http://publib.boulder.ibm.com/infocenter/eserver/v1r2/index.jsp
| Tivoli OMEGAMONXE for Information center: http://publib.boulder.ibm.com/infocenter/tivihelp/v15r1/
| DB2 Performance Expert index.jsp?topic=/com.ibm.ko2pe.doc/ko2welcome.htm
| on z/OS
In earlier releases, this product was called DB2 Performance Expert for z/OS.
®
WebSphere Application Information center: http://publib.boulder.ibm.com/infocenter/wasinfo/v6r0/index.jsp
Server
WebSphere Message Broker Information center: http://publib.boulder.ibm.com/infocenter/wmbhelp/v6r0m0/
with Rules and Formatter index.jsp
Extension
The product is also known as WebSphere MQ Integrator Broker.
WebSphere MQ Information center: http://publib.boulder.ibm.com/infocenter/wmqv6/v6r0/index.jsp

The resource includes information about MQSeries®.

WebSphere Replication Either of the following locations:
Server for z/OS v Information center: http://publib.boulder.ibm.com/infocenter/imzic
v Library Web site: http://www.ibm.com/software/data/db2imstools/library.html

This product is also known as DB2 DataPropagator.

®
z/Architecture Library Center site: http://www.ibm.com/servers/eserver/zseries/zos/bkserv/

504 Command Reference

Table 35. Related product information resource locations (continued)
Related product Information resources
z/OS Library Center site: http://www.ibm.com/servers/eserver/zseries/zos/bkserv/

This resource includes information about the following z/OS elements and components:
v Character Data Representation Architecture
v Device Support Facilities
v DFSORT
v Fortran
v High Level Assembler
v NetView®
v SMP/E for z/OS
v SNA
v TCP/IP
v TotalStorage® Enterprise Storage Server®
v VTAM
v z/OS C/C++
v z/OS Communications Server
v z/OS DCE
v z/OS DFSMS™
v z/OS DFSMS Access Method Services
v z/OS DFSMSdss™
v z/OS DFSMShsm™
v z/OS DFSMSdfp™
v z/OS ICSF
v z/OS ISPF
v z/OS JES3
v z/OS Language Environment
v z/OS Managed System Infrastructure
v z/OS MVS
v z/OS MVS JCL
v z/OS Parallel Sysplex®
v z/OS RMF™
v z/OS Security Server
v z/OS UNIX System Services
z/OS XL C/C++ http://www.ibm.com/software/awdtools/czos/library/

The following information resources from IBM are not necessarily specific to a
single product:
v The DB2 for z/OS Information Roadmap; available at: http://www.ibm.com/
software/data/db2/zos/roadmap.html
v DB2 Redbooks® and Redbooks about related products; available at:
http://www.ibm.com/redbooks
v IBM Educational resources:
– Information about IBM educational offerings is available on the Web at:
http://www.ibm.com/software/sw-training/

Information resources for DB2 for z/OS and related products 505
 – A collection of glossaries of IBM terms in multiple languages is available on
the IBM Terminology Web site at: http://www.ibm.com/software/
globalization/terminology/index.jsp
v National Language Support information; available at the IBM Publications
Center at: http://www.elink.ibmlink.ibm.com/public/applications/publications/
cgibin/pbi.cgi
v SQL Reference for Cross-Platform Development; available at the following
developerWorks® site: http://www.ibm.com/developerworks/db2/library/
techarticle/0206sqlref/0206sqlref.html

The following information resources are not published by IBM but can be useful to
users of DB2 for z/OS and related products:
v Database design topics:
– DB2 for z/OS and OS/390® Development for Performance Volume I, by Gabrielle
Wiorkowski, Gabrielle & Associates, ISBN 0-96684-605-2
– DB2 for z/OS and OS/390 Development for Performance Volume II, by Gabrielle
Wiorkowski, Gabrielle & Associates, ISBN 0-96684-606-0
– Handbook of Relational Database Design, by C. Fleming and B. Von Halle,
Addison Wesley, ISBN 0-20111-434-8
v Distributed Relational Database Architecture™ (DRDA) specifications;
http://www.opengroup.org
v Domain Name System: DNS and BIND, Third Edition, Paul Albitz and Cricket
Liu, O’Reilly, ISBN 0-59600-158-4
v Microsoft® Open Database Connectivity (ODBC) information;
http://msdn.microsoft.com/library/
v Unicode information; http://www.unicode.org

506 Command Reference

How to obtain DB2 information
You can access the official information about the DB2 product in a number of
ways.
v “DB2 on the Web”
v “DB2 product information”
v “DB2 education” on page 508
v “How to order the DB2 library” on page 508

DB2 on the Web

Stay current with the latest information about DB2 by visiting the DB2 home page
on the Web:

www.ibm.com/software/db2zos

On the DB2 home page, you can find links to a wide variety of information
resources about DB2. You can read news items that keep you informed about the
latest enhancements to the product. Product announcements, press releases, fact
sheets, and technical articles help you plan and implement your database
management strategy.

DB2 product information

The official DB2 for z/OS information is available in various formats and delivery
methods. IBM provides mid-version updates to the information in the information
center and in softcopy updates that are available on the Web and on CD-ROM.
Information Management Software for z/OS Solutions Information Center
DB2 product information is viewable in the information center, which is
the primary delivery vehicle for information about DB2 for z/OS, IMS,
QMF, and related tools. This information center enables you to search
across related product information in multiple languages for data
management solutions for the z/OS environment and print individual
topics or sets of related topics. You can also access, download, and print
PDFs of the publications that are associated with the information center
topics. Product technical information is provided in a format that offers
more options and tools for accessing, integrating, and customizing
information resources. The information center is based on Eclipse open
source technology.
The Information Management Software for z/OS Solutions Information
Center is viewable at the following Web site:

http://publib.boulder.ibm.com/infocenter/imzic
CD-ROMs and DVD
Books for DB2 are available on a CD-ROM that is included with your
product shipment:
v DB2 V9.1 for z/OS Licensed Library Collection, LK3T-7195, in English
The CD-ROM contains the collection of books for DB2 V9.1 for z/OS in
PDF and BookManager formats. Periodically, IBM refreshes the books on
subsequent editions of this CD-ROM.
© Copyright IBM Corp. 1983, 2009 507
 The books for DB2 for z/OS are also available on the following CD-ROM
and DVD collection kits, which contain online books for many IBM
products:
v IBM z/OS Software Products Collection , SK3T-4270, in English
v IBM z/OS Software Products DVD Collection , SK3T–4271, in English
PDF format
Many of the DB2 books are available in PDF (Portable Document Format)
for viewing or printing from CD-ROM or the DB2 home page on the Web
or from the information center. Download the PDF books to your intranet
for distribution throughout your enterprise.
BookManager format
You can use online books on CD-ROM to read, search across books, print
portions of the text, and make notes in these BookManager books. Using
the IBM Softcopy Reader, appropriate IBM Library Readers, or the
BookManager Read product, you can view these books in the z/OS,
Windows, and VM environments. You can also view and search many of
the DB2 BookManager books on the Web.

DB2 education

IBM Education and Training offers a wide variety of classroom courses to help you
quickly and efficiently gain DB2 expertise. IBM schedules classes are in cities all
over the world. You can find class information, by country, at the IBM Learning
Services Web site:

www.ibm.com/services/learning

IBM also offers classes at your location, at a time that suits your needs. IBM can
customize courses to meet your exact requirements. For more information,
including the current local schedule, contact your IBM representative.

How to order the DB2 library

To order books, visit the IBM Publication Center on the Web:

www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgi

From the IBM Publication Center, you can go to the Publication Notification
System (PNS). PNS users receive electronic notifications of updated publications in
their profiles. You have the option of ordering the updates by using the
publications direct ordering application or any other IBM publication ordering
channel. The PNS application does not send automatic shipments of publications.
You will receive updated publications and a bill for them if you respond to the
electronic notification.

You can also order DB2 publications and CD-ROMs from your IBM representative
or the IBM branch office that serves your locality. If your location is within the
United States or Canada, you can place your order by calling one of the toll-free
numbers:
v In the U.S., call 1-800-879-2755.
v In Canada, call 1-800-426-4968.

To order additional copies of licensed publications, specify the SOFTWARE option.

To order additional publications or CD-ROMs, specify the PUBLICATIONS option.

508 Command Reference

Be prepared to give your customer number, the product number, and either the
feature codes or order numbers that you want.

How to obtain DB2 information 509

510 Command Reference
 How to use the DB2 library
Titles of books in the library begin with DB2 Version 9.1 for z/OS. However,
references from one book in the library to another are shortened and do not
include the product name, version, and release. Instead, they point directly to the
section that holds the information. The primary place to find and use information
about DB2 for z/OS is the Information Management Software for z/OS Solutions
Information Center (http://publib.boulder.ibm.com/infocenter/imzic).

| If you are new to DB2 for z/OS, Introduction to DB2 for z/OS provides a
| comprehensive introduction to DB2 Version 9.1 for z/OS. Topics included in this
| book explain the basic concepts that are associated with relational database
| management systems in general, and with DB2 for z/OS in particular.

The most rewarding task associated with a database management system is asking
questions of it and getting answers, the task called end use. Other tasks are also
necessary—defining the parameters of the system, putting the data in place, and so
on. The tasks that are associated with DB2 are grouped into the following major
categories.

Installation

If you are involved with installing DB2, you will need to use a variety of resources,
such as:
v DB2 Program Directory
v DB2 Installation Guide
v DB2 Administration Guide
v DB2 Application Programming Guide and Reference for Java
v DB2 Codes
v DB2 Internationalization Guide
v DB2 Messages
v DB2 Performance Monitoring and Tuning Guide
v DB2 RACF Access Control Module Guide
v DB2 Utility Guide and Reference

If you will be using data sharing capabilities you also need DB2 Data Sharing:
Planning and Administration, which describes installation considerations for data
sharing.

If you will be installing and configuring DB2 ODBC, you will need DB2 ODBC
Guide and Reference.

If you are installing IBM Spatial Support for DB2 for z/OS, you will need IBM
Spatial Support for DB2 for z/OS User’s Guide and Reference.

If you are installing IBM OmniFind® Text Search Server for DB2 for z/OS, you will
need IBM OmniFind Text Search Server for DB2 for z/OS Installation, Administration,
and Reference.

© Copyright IBM Corp. 1983, 2009 511

 End use

End users issue SQL statements to retrieve data. They can also insert, update, or
delete data, with SQL statements. They might need an introduction to SQL,
detailed instructions for using SPUFI, and an alphabetized reference to the types of
SQL statements. This information is found in DB2 Application Programming and SQL
Guide, and DB2 SQL Reference.

End users can also issue SQL statements through the DB2 Query Management
Facility (QMF) or some other program, and the library for that licensed program
might provide all the instruction or reference material they need. For a list of the
titles in the DB2 QMF library, see the bibliography at the end of this book.

Application programming

Some users access DB2 without knowing it, using programs that contain SQL
statements. DB2 application programmers write those programs. Because they
write SQL statements, they need the same resources that end users do.

Application programmers also need instructions for many other topics:

v How to transfer data between DB2 and a host program—written in Java™, C, or
COBOL, for example
v How to prepare to compile a program that embeds SQL statements
v How to process data from two systems simultaneously, for example, DB2 and
IMS or DB2 and CICS
v How to write distributed applications across operating systems
v How to write applications that use Open Database Connectivity (ODBC) to
access DB2 servers
| v How to write applications that use JDBC and SQLJ with the Java programming
| language to access DB2 servers
| v How to write applications to store XML data on DB2 servers and retrieve XML
| data from DB2 servers.

The material needed for writing a host program containing SQL is in DB2
Application Programming and SQL Guide.

| The material needed for writing applications that use JDBC and SQLJ to access
| DB2 servers is in DB2 Application Programming Guide and Reference for Java. The
| material needed for writing applications that use DB2 CLI or ODBC to access DB2
| servers is in DB2 ODBC Guide and Reference. The material needed for working with
| XML data in DB2 is in DB2 XML Guide. For handling errors, see DB2 Messages and
| DB2 Codes.

If you are a software vendor implementing DRDA clients and servers, you will
need DB2 Reference for Remote DRDA Requesters and Servers.

Information about writing applications across operating systems can be found in

IBM DB2 SQL Reference for Cross-Platform Development.

System and database administration

Administration covers almost everything else. DB2 Administration Guide divides

some of those tasks among the following sections:

512 Command Reference

v DB2 concepts: Introduces DB2 structures, the DB2 environment, and high
availability.
v Designing a database: Discusses the decisions that must be made when
designing a database and tells how to implement the design by creating and
altering DB2 objects, loading data, and adjusting to changes.
v Security and auditing: Describes ways of controlling access to the DB2 system
and to data within DB2, to audit aspects of DB2 usage, and to answer other
security and auditing concerns.
v Operation and recovery: Describes the steps in normal day-to-day operation and
discusses the steps one should take to prepare for recovery in the event of some
failure.

DB2 Performance Monitoring and Tuning Guide explains how to monitor the
performance of the DB2 system and its parts. It also lists things that can be done to
make some parts run faster.

If you will be using the RACF access control module for DB2 authorization
checking, you will need DB2 RACF Access Control Module Guide.

If you are involved with DB2 only to design the database, or plan operational
procedures, you need DB2 Administration Guide. If you also want to carry out your
own plans by creating DB2 objects, granting privileges, running utility jobs, and so
on, you also need:
v DB2 SQL Reference, which describes the SQL statements you use to create, alter,
and drop objects and grant and revoke privileges
v DB2 Utility Guide and Reference, which explains how to run utilities
v DB2 Command Reference, which explains how to run commands

If you will be using data sharing, you need DB2 Data Sharing: Planning and
Administration, which describes how to plan for and implement data sharing.

Additional information about system and database administration can be found in

DB2 Messages and DB2 Codes, which list messages and codes issued by DB2, with
explanations and suggested responses.

Diagnosis

Diagnosticians detect and describe errors in the DB2 program. They might also
recommend or apply a remedy. The documentation for this task is in DB2 Diagnosis
Guide and Reference, DB2 Messages, and DB2 Codes.

How to use the DB2 library 513

514 Command Reference
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 or send inquiries, in writing, to:

Intellectual Property Licensing

Legal and Intellectual Property Law
IBM Japan, Ltd.
3-2-12, Roppongi, Minato-ku
Tokyo 106-8711
Japan

The following paragraph does not apply to the United Kingdom or any other
country 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.

Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.

© Copyright IBM Corp. 1983, 2009 515

 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 which has been exchanged, should contact:

IBM Corporation
J46A/G4
555 Bailey Avenue
San Jose, CA 95141-1003
U.S.A.

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.

This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which

illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs. The sample
programs are provided ″AS IS″, without warranty of any kind. IBM shall not be
liable for any damages arising out of your use of the sample programs.

If you are viewing this information softcopy, the photographs and color
illustrations may not appear.

Programming Interface Information

This information is intended to help you to plan for and administer DB2 Version
9.1 for z/OS. This information also documents General-use Programming Interface
and Associated Guidance Information and Product-sensitive Programming
Interface and Associated Guidance Information provided by DB2 Version 9.1 for
z/OS.

516 Command Reference

 Product-sensitive Programming Interface and Associated
Guidance Information
Product-sensitive Programming Interfaces allow the customer installation to
perform tasks such as diagnosing, modifying, monitoring, repairing, tailoring, or
tuning of this IBM software product. Use of such interfaces creates dependencies
on the detailed design or implementation of the IBM software product.
Product-sensitive Programming Interfaces should be used only for these
specialized purposes. Because of their dependencies on detailed design and
implementation, it is to be expected that programs written to such interfaces may
need to be changed in order to run with new product releases or versions, or as a
result of service.

Product-sensitive Programming Interface and Associated Guidance Information is

identified where it occurs by the following markings:

PSPI Product-sensitive Programming Interface and Associated Guidance

Information... PSPI

Trademarks
IBM, the IBM logo, and ibm.com® are trademarks or registered marks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at http://www.ibm.com/
legal/copytrade.shtml.

Linux is a registered trademark of Linus Torvalds in the United States, other

countries, or both.

Microsoft, Windows, Windows NT®, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other
countries.

Java and all Java-based trademarks and logos are trademarks of Sun Microsystems,
Inc. in the United States, other countries, or both.

Notices 517
518 Command Reference
 Glossary
abend See abnormal end of task. aggregate function
An operation that derives its result by
abend reason code
using values from one or more rows.
A 4-byte hexadecimal code that uniquely
Contrast with scalar function.
identifies a problem with DB2.
| alias An alternative name that can be used in
abnormal end of task (abend)
| SQL statements to refer to a table or view
Termination of a task, job, or subsystem
| in the same or a remote DB2 subsystem.
because of an error condition that
| An alias can be qualified with a schema
recovery facilities cannot resolve during
| qualifier and can thereby be referenced by
execution.
| other users. Contrast with synonym.
access method services
allied address space
| The facility that is used to define, alter,
An area of storage that is external to DB2
| delete, print, and reproduce VSAM
and that is connected to DB2. An allied
| key-sequenced data sets.
address space can request DB2 services.
access path See also address space.
The path that is used to locate data that is
allied agent
specified in SQL statements. An access
An agent that represents work requests
path can be indexed or sequential.
that originate in allied address spaces. See
active log also system agent.
The portion of the DB2 log to which log
allied thread
records are written as they are generated.
A thread that originates at the local DB2
The active log always contains the most
subsystem and that can access data at a
recent log records. See also archive log.
remote DB2 subsystem.
address space
allocated cursor
| A range of virtual storage pages that is
A cursor that is defined for a stored
| identified by a number (ASID) and a
procedure result set by using the SQL
| collection of segment and page tables that
ALLOCATE CURSOR statement.
| map the virtual pages to real pages of the
| computer’s memory. ambiguous cursor
A database cursor for which DB2 cannot
address space connection
determine whether it is used for update
The result of connecting an allied address
or read-only purposes.
space to DB2. See also allied address
space and task control block. APAR See authorized program analysis report.
address space identifier (ASID) APF See authorized program facility.
A unique system-assigned identifier for
API See application programming interface.
an address space.
APPL A VTAM network definition statement
| AFTER trigger
that is used to define DB2 to VTAM as an
| A trigger that is specified to be activated
application program that uses SNA LU
| after a defined trigger event (an insert,
6.2 protocols.
| update, or delete operation on the table
| that is specified in a trigger definition). application
| Contrast with BEFORE trigger and A program or set of programs that
| INSTEAD OF trigger. performs a task; for example, a payroll
application.
agent In DB2, the structure that associates all
processes that are involved in a DB2 unit application plan
of work. See also allied agent and system The control structure that is produced
agent. during the bind process. DB2 uses the

© Copyright IBM Corp. 1983, 2009 519

 application plan to process SQL authorized program analysis report (APAR)
statements that it encounters during A report of a problem that is caused by a
statement execution. suspected defect in a current release of an
IBM supplied program.
application process
The unit to which resources and locks are authorized program facility (APF)
allocated. An application process involves | A facility that allows an installation to
the execution of one or more programs. | identify system or user programs that can
| use sensitive system functions.
application programming interface (API)
A functional interface that is supplied by automatic bind
the operating system or by a separately (More correctly automatic rebind.) A
orderable licensed program that allows an process by which SQL statements are
application program that is written in a bound automatically (without a user
high-level language to use specific data or issuing a BIND command) when an
functions of the operating system or application process begins execution and
licensed program. the bound application plan or package it
requires is not valid.
application requester
The component on a remote system that automatic query rewrite
generates DRDA requests for data on A process that examines an SQL statement
behalf of an application. that refers to one or more base tables or
materialized query tables, and, if
application server
appropriate, rewrites the query so that it
The target of a request from a remote
performs better.
application. In the DB2 environment, the
application server function is provided by auxiliary index
the distributed data facility and is used to | An index on an auxiliary table in which
access DB2 data from remote applications. | each index entry refers to a LOB or XML
| document.
archive log
The portion of the DB2 log that contains auxiliary table
log records that have been copied from A table that contains columns outside the
the active log. See also active log. actual table in which they are defined.
Auxiliary tables can contain either LOB or
ASCII An encoding scheme that is used to
XML data.
represent strings in many environments,
typically on PCs and workstations. backout
Contrast with EBCDIC and Unicode. The process of undoing uncommitted
changes that an application process made.
ASID See address space identifier.
A backout is often performed in the event
attachment facility of a failure on the part of an application
An interface between DB2 and TSO, IMS, process, or as a result of a deadlock
CICS, or batch address spaces. An situation.
attachment facility allows application
backward log recovery
programs to access DB2.
The final phase of restart processing
attribute during which DB2 scans the log in a
A characteristic of an entity. For example, backward direction to apply UNDO log
in database design, the phone number of records for all aborted changes.
an employee is an attribute of that
base table
employee.
A table that is created by the SQL
authorization ID CREATE TABLE statement and that holds
| A string that can be verified for persistent data. Contrast with clone table,
| connection to DB2 and to which a set of materialized query table, result table,
| privileges is allowed. An authorization ID temporary table, and transition table.
| can represent an individual or an
base table space
| organizational group.
A table space that contains base tables.

520 Command Reference

| basic row format | v A form of character data. Binary data is
| A row format in which values for | generally more highly recommended
| columns are stored in the row in the | than character-for-bit data.
| order in which the columns are defined
BLOB See binary large object.
| by the CREATE TABLE statement.
| Contrast with reordered row format. block fetch
| A capability in which DB2 can retrieve, or
basic sequential access method (BSAM)
| fetch, a large set of rows together. Using
An access method for storing or retrieving
| block fetch can significantly reduce the
data blocks in a continuous sequence,
| number of messages that are being sent
using either a sequential-access or a
| across the network. Block fetch applies
direct-access device.
| only to non-rowset cursors that do not
| BEFORE trigger | update data.
| A trigger that is specified to be activated
bootstrap data set (BSDS)
| before a defined trigger event (an insert,
A VSAM data set that contains name and
| an update, or a delete operation on the
status information for DB2 and RBA
| table that is specified in a trigger
range specifications for all active and
| definition). Contrast with AFTER trigger
archive log data sets. The BSDS also
| and INSTEAD OF trigger.
contains passwords for the DB2 directory
binary large object (BLOB) and catalog, and lists of conditional
| A binary string data type that contains a restart and checkpoint records.
| sequence of bytes that can range in size
BSAM
| from 0 bytes to 2 GB, less 1 byte. This
See basic sequential access method.
| string does not have an associated code
| page and character set. BLOBs can BSDS See bootstrap data set.
| contain, for example, image, audio, or
buffer pool
| video data. In general, BLOB values are
| An area of memory into which data pages
| used whenever a binary string might
| are read, modified, and held during
| exceed the limits of the VARBINARY
| processing.
| type.
built-in data type
binary string
| A data type that IBM supplies. Among
| A sequence of bytes that is not associated
| the built-in data types for DB2 for z/OS
| with a CCSID. Binary string data type can
| are string, numeric, XML, ROWID, and
| be further classified as BINARY,
| datetime. Contrast with distinct type.
| VARBINARY, or BLOB.
built-in function
| bind A process by which a usable control
| A function that is generated by DB2 and
| structure with SQL statements is
| that is in the SYSIBM schema. Contrast
| generated; the structure is often called an
| with user-defined function. See also
| access plan, an application plan, or a
| function, cast function, external function,
| package. During this bind process, access
| sourced function, and SQL function.
| paths to the data are selected, and some
| authorization checking is performed. See business dimension
| also automatic bind. A category of data, such as products or
time periods, that an organization might
bit data
want to analyze.
| v Data with character type CHAR or
| VARCHAR that is defined with the cache structure
| FOR BIT DATA clause. Note that using A coupling facility structure that stores
| BINARY or VARBINARY rather than data that can be available to all members
| FOR BIT DATA is highly of a Sysplex. A DB2 data sharing group
| recommended. uses cache structures as group buffer
pools.
| v Data with character type CHAR or
| VARCHAR that is defined with the CAF See call attachment facility.
| FOR BIT DATA clause.

DB2 glossary 521

call attachment facility (CAF) central processor (CP)
A DB2 attachment facility for application The part of the computer that contains the
programs that run in TSO or z/OS batch. sequencing and processing facilities for
The CAF is an alternative to the DSN instruction execution, initial program
command processor and provides greater load, and other machine operations.
control over the execution environment.
CFRM See coupling facility resource
Contrast with Recoverable Resource
management.
Manager Services attachment facility.
CFRM policy
call-level interface (CLI)
The allocation rules for a coupling facility
A callable application programming
structure that are declared by a z/OS
interface (API) for database access, which
administrator.
is an alternative to using embedded SQL.
character conversion
cascade delete
The process of changing characters from
A process by which DB2 enforces
one encoding scheme to another.
referential constraints by deleting all
descendent rows of a deleted parent row. Character Data Representation Architecture
(CDRA)
CASE expression
An architecture that is used to achieve
An expression that is selected based on
consistent representation, processing, and
the evaluation of one or more conditions.
interchange of string data.
cast function
character large object (CLOB)
A function that is used to convert
| A character string data type that contains
instances of a (source) data type into
| a sequence of bytes that represent
instances of a different (target) data type.
| characters (single-byte, multibyte, or both)
castout | that can range in size from 0 bytes to 2
The DB2 process of writing changed | GB, less 1 byte. In general, CLOB values
pages from a group buffer pool to disk. | are used whenever a character string
| might exceed the limits of the VARCHAR
castout owner
| type.
The DB2 member that is responsible for
casting out a particular page set or character set
partition. A defined set of characters.
catalog character string
In DB2, a collection of tables that contains | A sequence of bytes that represent bit
descriptions of objects such as tables, | data, single-byte characters, or a mixture
views, and indexes. | of single-byte and multibyte characters.
| Character data can be further classified as
catalog table
| CHARACTER, VARCHAR, or CLOB.
Any table in the DB2 catalog.
check constraint
CCSID
A user-defined constraint that specifies
See coded character set identifier.
the values that specific columns of a base
CDB See communications database. table can contain.
CDRA check integrity
See Character Data Representation The condition that exists when each row
Architecture. in a table conforms to the check
constraints that are defined on that table.
CEC See central processor complex.
check pending
central electronic complex (CEC)
A state of a table space or partition that
See central processor complex.
prevents its use by some utilities and by
central processor complex (CPC) some SQL statements because of rows
A physical collection of hardware that that violate referential constraints, check
consists of main storage, one or more constraints, or both.
central processors, timers, and channels.

522 Command Reference

 checkpoint | have separate underlying VSAM data
A point at which DB2 records status | sets, which are identified by their data set
information on the DB2 log; the recovery | instance numbers. Contrast with base
process uses this information if DB2 | table.
abnormally terminates.
closed application
child lock An application that requires exclusive use
For explicit hierarchical locking, a lock of certain statements on certain DB2
that is held on either a table, page, row, objects, so that the objects are managed
or a large object (LOB). Each child lock solely through the external interface of
has a parent lock. See also parent lock. that application.
CI See control interval. clustering index
An index that determines how rows are
CICS Represents (in this information): CICS
physically ordered (clustered) in a table
Transaction Server for z/OS: Customer
space. If a clustering index on a
Information Control System Transaction
partitioned table is not a partitioning
Server for z/OS.
index, the rows are ordered in cluster
CICS attachment facility sequence within each data partition
| A facility that provides a multithread instead of spanning partitions.
| connection to DB2 to allow applications
| CM See conversion mode.
| that run in the CICS environment to
| execute DB2 statements. | CM* See conversion mode*.
claim A notification to DB2 that an object is C++ member
being accessed. Claims prevent drains A data object or function in a structure,
from occurring until the claim is released, union, or class.
which usually occurs at a commit point.
C++ member function
Contrast with drain.
An operator or function that is declared
claim class as a member of a class. A member
A specific type of object access that can be function has access to the private and
one of the following isolation levels: protected data members and to the
v Cursor stability (CS) member functions of objects in its class.
Member functions are also called
v Repeatable read (RR)
methods.
v Write
C++ object
class of service A region of storage. An object is created
A VTAM term for a list of routes through when a variable is defined or a new
a network, arranged in an order of function is invoked.
preference for their use.
An instance of a class.
clause In SQL, a distinct part of a statement,
such as a SELECT clause or a WHERE coded character set
clause. A set of unambiguous rules that establish
a character set and the one-to-one
CLI See call-level interface. relationships between the characters of
client See requester. the set and their coded representations.

CLOB See character large object. coded character set identifier (CCSID)
A 16-bit number that uniquely identifies a
| clone object coded representation of graphic
| An object that is associated with a clone characters. It designates an encoding
| table, including the clone table itself and scheme identifier and one or more pairs
| check constraints, indexes, and BEFORE that consist of a character set identifier
| triggers on the clone table. and an associated code page identifier.
| clone table code page
| A table that is structurally identical to a A set of assignments of characters to code
| base table. The base and clone table each

DB2 glossary 523

 points. Within a code page, each code operator or an IMS subsystem user to
point has only one specific meaning. In route DB2 commands to specific DB2
EBCDIC, for example, the character A is subsystems.
assigned code point X’C1’, and character
command scope
B is assigned code point X’C2’.
The scope of command operation in a
code point data sharing group.
In CDRA, a unique bit pattern that
commit
represents a character in a code page.
The operation that ends a unit of work by
code unit releasing locks so that the database
The fundamental binary width in a changes that are made by that unit of
computer architecture that is used for work can be perceived by other processes.
representing character data, such as 7 bits, Contrast with rollback.
8 bits, 16 bits, or 32 bits. Depending on
commit point
the character encoding form that is used,
A point in time when data is considered
each code point in a coded character set
consistent.
can be represented by one or more code
units. common service area (CSA)
| In z/OS, a part of the common area that
coexistence
| contains data areas that are addressable
During migration, the period of time in
| by all address spaces. Most DB2 use is in
which two releases exist in the same data
| the extended CSA, which is above the
sharing group.
| 16-MB line.
cold start
communications database (CDB)
A process by which DB2 restarts without
A set of tables in the DB2 catalog that are
processing any log records. Contrast with
used to establish conversations with
warm start.
remote database management systems.
collection
comparison operator
A group of packages that have the same
A token (such as =, >, or <) that is used
qualifier.
to specify a relationship between two
column values.
The vertical component of a table. A
compatibility mode
column has a name and a particular data
| See conversion mode.
type (for example, character, decimal, or
integer). compatibility mode* (CM*)
See conversion mode*.
column function
See aggregate function. composite key
| An ordered set of key columns or
″come from″ checking
| expressions of the same table.
An LU 6.2 security option that defines a
list of authorization IDs that are allowed compression dictionary
to connect to DB2 from a partner LU. The dictionary that controls the process of
compression and decompression. This
command
dictionary is created from the data in the
A DB2 operator command or a DSN
table space or table space partition.
subcommand. A command is distinct
from an SQL statement. concurrency
The shared use of resources by more than
command prefix
one application process at the same time.
A 1- to 8-character command identifier.
The command prefix distinguishes the conditional restart
command as belonging to an application A DB2 restart that is directed by a
or subsystem rather than to z/OS. user-defined conditional restart control
record (CRCR).
command recognition character (CRC)
A character that permits a z/OS console

524 Command Reference

connection data; the converted string is shorter
In SNA, the existence of a communication because the shift codes are removed.
path between two partner LUs that allows
control interval (CI)
information to be exchanged (for example,
two DB2 subsystems that are connected v A unit of information that VSAM
and communicating by way of a transfers between virtual and auxiliary
conversation). storage.
v In a key-sequenced data set or file, the
connection context
set of records that an entry in the
In SQLJ, a Java object that represents a
sequence-set index record points to.
connection to a data source.
conversation
connection declaration clause
Communication, which is based on LU
In SQLJ, a statement that declares a
6.2 or Advanced Program-to-Program
connection to a data source.
Communication (APPC), between an
connection handle application and a remote transaction
The data object containing information program over an SNA logical
that is associated with a connection that unit-to-logical unit (LU-LU) session that
DB2 ODBC manages. This includes allows communication while processing a
general status information, transaction transaction.
status, and diagnostic information.
| conversion mode (CM)
connection ID | The first stage of the version-to-version
An identifier that is supplied by the | migration process. In a DB2 data sharing
attachment facility and that is associated | group, members in conversion mode can
with a specific address space connection. | coexist with members that are still at the
| prior version level. Fallback to the prior
consistency token
| version is also supported. When in
A timestamp that is used to generate the
| conversion mode, the DB2 subsystem
version identifier for an application. See
| cannot use most new functions of the new
also version.
| version. Contrast with conversion mode*,
constant | enabling-new-function mode,
A language element that specifies an | enabling-new-function mode*, and
unchanging value. Constants are classified | new-function mode.
as string constants or numeric constants.
| Previously known as compatibility mode
Contrast with variable.
| (CM).
constraint
| conversion mode* (CM*)
A rule that limits the values that can be
| A stage of the version-to-version
inserted, deleted, or updated in a table.
| migration process that applies to a DB2
See referential constraint, check constraint,
| subsystem or data sharing group that was
and unique constraint.
| in enabling-new-function mode (ENFM),
context | enabling-new-function mode* (ENFM*), or
An application’s logical connection to the | new-function mode (NFM) at one time.
data source and associated DB2 ODBC | Fallback to a prior version is not
connection information that allows the | supported. When in conversion mode*, a
application to direct its operations to a | DB2 data sharing group cannot coexist
data source. A DB2 ODBC context | with members that are still at the prior
represents a DB2 thread. | version level. Contrast with conversion
| mode, enabling-new-function mode,
contracting conversion
| enabling-new-function mode*, and
A process that occurs when the length of
| new-function mode.
a converted string is smaller than that of
the source string. For example, this | Previously known as compatibility mode*
process occurs when an EBCDIC | (CM*).
mixed-data string that contains DBCS
coordinator
characters is converted to ASCII mixed
The system component that coordinates

DB2 glossary 525

 the commit or rollback of a unit of work column of the DSN_STATEMNT_TABLE
that includes work that is done on one or when a statement is explained.
more other systems.
coupling facility
coprocessor | A special PR/SM logical partition (LPAR)
See SQL statement coprocessor. | that runs the coupling facility control
| program and provides high-speed
copy pool
| caching, list processing, and locking
| A collection of names of storage groups
| functions in a Parallel Sysplex.
| that are processed collectively for fast
| replication operations. coupling facility resource management (CFRM)
A component of z/OS that provides the
copy target
services to manage coupling facility
A named set of SMS storage groups that
resources in a Parallel Sysplex. This
are to be used as containers for copy pool
management includes the enforcement of
volume copies. A copy target is an SMS
CFRM policies to ensure that the coupling
construct that lets you define which
facility and structure requirements are
storage groups are to be used as
satisfied.
containers for volumes that are copied by
using FlashCopy functions. CP See central processor.
copy version CPC See central processor complex.
A point-in-time FlashCopy copy that is
CRC See command recognition character.
managed by HSM. Each copy pool has a
version parameter that specifies the created temporary table
number of copy versions to be maintained A persistent table that holds temporary
on disk. data and is defined with the SQL
statement CREATE GLOBAL
correlated columns
TEMPORARY TABLE. Information about
A relationship between the value of one
created temporary tables is stored in the
column and the value of another column.
DB2 catalog and can be shared across
correlated subquery application processes. Contrast with
A subquery (part of a WHERE or declared temporary table. See also
HAVING clause) that is applied to a row temporary table.
or group of rows of a table or view that is
cross-system coupling facility (XCF)
named in an outer subselect statement.
A component of z/OS that provides
correlation ID functions to support cooperation between
An identifier that is associated with a authorized programs that run within a
specific thread. In TSO, it is either an Sysplex.
authorization ID or the job name.
cross-system extended services (XES)
correlation name A set of z/OS services that allow multiple
| An identifier that is specified and used instances of an application or subsystem,
| within a single SQL statement as the running on different systems in a Sysplex
| exposed name for objects such as a table, environment, to implement
| view, table function reference, nested table high-performance, high-availability data
| expression, or result of a data change sharing by using a coupling facility.
| statement. Correlation names are useful in
CS See cursor stability.
| an SQL statement to allow two distinct
| references to the same base table and to CSA See common service area.
| allow an alternative name to be used to
CT See cursor table.
| represent an object.
current data
cost category
Data within a host structure that is
A category into which DB2 places cost
current with (identical to) the data within
estimates for SQL statements at the time
the base table.
the statement is bound. The cost category
is externalized in the COST_CATEGORY

526 Command Reference

 current status rebuild database descriptor (DBD)
The second phase of restart processing An internal representation of a DB2
during which the status of the subsystem database definition, which reflects the
is reconstructed from information on the data definition that is in the DB2 catalog.
log. The objects that are defined in a database
descriptor are table spaces, tables,
cursor A control structure that an application
indexes, index spaces, relationships, check
program uses to point to a single row or
constraints, and triggers. A DBD also
multiple rows within some ordered set of
contains information about accessing
rows of a result table. A cursor can be
tables in the database.
used to retrieve, update, or delete rows
from a result table. database exception status
In a data sharing environment, an
cursor sensitivity
indication that something is wrong with a
The degree to which database updates are
database.
visible to the subsequent FETCH
statements in a cursor. database identifier (DBID)
An internal identifier of the database.
cursor stability (CS)
The isolation level that provides database management system (DBMS)
maximum concurrency without the ability A software system that controls the
to read uncommitted data. With cursor creation, organization, and modification of
stability, a unit of work holds locks only a database and the access to the data that
on its uncommitted changes and on the is stored within it.
current row of each of its cursors. See also
database request module (DBRM)
read stability, repeatable read, and
A data set member that is created by the
uncommitted read.
DB2 precompiler and that contains
cursor table (CT) information about SQL statements.
| The internal representation of a cursor. DBRMs are used in the bind process.
cycle A set of tables that can be ordered so that database server
each table is a descendent of the one The target of a request from a local
before it, and the first table is a application or a remote intermediate
descendent of the last table. A database server.
self-referencing table is a cycle with a
data currency
single member. See also referential cycle.
The state in which the data that is
database retrieved into a host variable in a
A collection of tables, or a collection of program is a copy of the data in the base
table spaces and index spaces. table.
database access thread (DBAT) data dictionary
A thread that accesses data at the local A repository of information about an
subsystem on behalf of a remote organization’s application programs,
subsystem. databases, logical data models, users, and
authorizations.
database administrator (DBA)
An individual who is responsible for data partition
designing, developing, operating, A VSAM data set that is contained within
safeguarding, maintaining, and using a a partitioned table space.
database.
data-partitioned secondary index (DPSI)
database alias A secondary index that is partitioned
The name of the target server if it is according to the underlying data.
different from the location name. The Contrast with nonpartitioned secondary
database alias is used to provide the index.
name of the database server as it is
| data set instance number
known to the network.
| A number that indicates the data set that
| contains the data for an object.

DB2 glossary 527

data sharing DBCS See double-byte character set.
A function of DB2 for z/OS that enables
DBD See database descriptor.
applications on different DB2 subsystems
to read from and write to the same data DB2I See DB2 Interactive.
concurrently.
DBID See database identifier.
data sharing group
DB2 Interactive (DB2I)
A collection of one or more DB2
An interactive service within DB2 that
subsystems that directly access and
facilitates the execution of SQL
change the same data while maintaining
statements, DB2 (operator) commands,
data integrity.
and programmer commands, and the
data sharing member invocation of utilities.
A DB2 subsystem that is assigned by XCF
DBMS
services to a data sharing group.
See database management system.
data source
DBRM
A local or remote relational or
See database request module.
non-relational data manager that is
capable of supporting data access via an DB2 thread
ODBC driver that supports the ODBC | The database manager structure that
APIs. In the case of DB2 for z/OS, the | describes an application’s connection,
data sources are always relational | traces its progress, processes resource
database managers. | functions, and delimits its accessibility to
| the database manager resources and
data type
| services. Most DB2 for z/OS functions
An attribute of columns, constants,
| execute under a thread structure.
variables, parameters, special registers,
and the results of functions and DCLGEN
expressions. See declarations generator.
data warehouse DDF See distributed data facility.
A system that provides critical business
deadlock
information to an organization. The data
Unresolvable contention for the use of a
warehouse system cleanses the data for
resource, such as a table or an index.
accuracy and currency, and then presents
the data to decision makers so that they declarations generator (DCLGEN)
can interpret and use it effectively and A subcomponent of DB2 that generates
efficiently. SQL table declarations and COBOL, C, or
PL/I data structure declarations that
DBA See database administrator.
conform to the table. The declarations are
DBAT See database access thread. generated from DB2 system catalog
information.
DB2 catalog
A collection of tables that are maintained declared temporary table
by DB2 and contain descriptions of DB2 A non-persistent table that holds
objects, such as tables, views, and temporary data and is defined with the
indexes. SQL statement DECLARE GLOBAL
TEMPORARY TABLE. Information about
DBCLOB
declared temporary tables is not stored in
See double-byte character large object.
the DB2 catalog and can be used only by
DB2 command the application process that issued the
An instruction to the DB2 subsystem that DECLARE statement. Contrast with
a user enters to start or stop DB2, to created temporary table. See also
display information on current users, to temporary table.
start or stop databases, to display
default value
information on the status of databases,
| A predetermined value, attribute, or
and so on.
| option that is assumed when no other

528 Command Reference

| value is specified. A default value can be table space) of its parent. See also parent
| defined for column data in DB2 tables by row, parent table, and parent table space.
| specifying the DEFAULT keyword in an
dependent row
| SQL statement that changes data (such as
A row that contains a foreign key that
| INSERT, UPDATE, and MERGE).
matches the value of a primary key in the
deferred embedded SQL parent row.
SQL statements that are neither fully
dependent table
static nor fully dynamic. These statements
A table that is a dependent in at least one
are embedded within an application and
referential constraint.
are prepared during the execution of the
application. descendent
An object that is a dependent of an object
deferred write
or is the dependent of a descendent of an
The process of asynchronously writing
object.
changed data pages to disk.
descendent row
degree of parallelism
A row that is dependent on another row,
The number of concurrently executed
or a row that is a descendent of a
operations that are initiated to process a
dependent row.
query.
descendent table
delete hole
A table that is a dependent of another
The location on which a cursor is
table, or a table that is a descendent of a
positioned when a row in a result table is
dependent table.
refetched and the row no longer exists on
the base table. See also update hole. deterministic function
A user-defined function whose result is
delete rule
dependent on the values of the input
The rule that tells DB2 what to do to a
arguments. That is, successive invocations
dependent row when a parent row is
with the same input values produce the
deleted. Delete rules include CASCADE,
same answer. Sometimes referred to as a
RESTRICT, SET NULL, or NO ACTION.
not-variant function. Contrast with
delete trigger nondeterministic function (sometimes
A trigger that is defined with the called a variant function).
triggering delete SQL operation.
dimension
delimited identifier A data category such as time, products, or
A sequence of characters that are enclosed markets. The elements of a dimension are
within escape characters such as double referred to as members. See also
quotation marks (″). dimension table.
delimiter token dimension table
A string constant, a delimited identifier, The representation of a dimension in a
an operator symbol, or any of the special star schema. Each row in a dimension
characters that are shown in DB2 syntax table represents all of the attributes for a
diagrams. particular member of the dimension. See
also dimension, star schema, and star join.
denormalization
The intentional duplication of columns in directory
multiple tables to increase data The DB2 system database that contains
redundancy. Denormalization is internal objects such as database
sometimes necessary to minimize descriptors and skeleton cursor tables.
performance problems. Contrast with
disk A direct-access storage device that records
normalization.
data magnetically.
dependent
distinct type
An object (row, table, or table space) that
A user-defined data type that is
has at least one parent. The object is also
represented as an existing type (its source
said to be a dependent (row, table, or

DB2 glossary 529

 type), but is considered to be a separate national languages such as Japanese and
and incompatible type for semantic Chinese, that have more symbols than can
purposes. be represented by a single byte. Each
character is 2 bytes in length. Contrast
distributed data
with single-byte character set and
Data that resides on a DBMS other than
multibyte character set.
the local system.
double-precision floating point number
distributed data facility (DDF)
A 64-bit approximate representation of a
A set of DB2 components through which
real number.
DB2 communicates with another
relational database management system. DPSI See data-partitioned secondary index.
Distributed Relational Database Architecture drain The act of acquiring a locked resource by
(DRDA) quiescing access to that object. Contrast
A connection protocol for distributed with claim.
relational database processing that is used
drain lock
by IBM relational database products.
A lock on a claim class that prevents a
DRDA includes protocols for
claim from occurring.
communication between an application
and a remote relational database DRDA
management system, and for See Distributed Relational Database
communication between relational Architecture.
database management systems. See also
DRDA access
DRDA access.
An open method of accessing distributed
DNS See domain name server. data that you can use to connect to
another database server to execute
| DOCID
packages that were previously bound at
| See document ID.
the server location.
| document ID
DSN
| A value that uniquely identifies a row
| that contains an XML column. This value v The default DB2 subsystem name.
| is stored with the row and never changes. v The name of the TSO command
processor of DB2.
domain
The set of valid values for an attribute. v The first three characters of DB2
module and macro names.
domain name
The name by which TCP/IP applications dynamic cursor
refer to a TCP/IP host within a TCP/IP A named control structure that an
network. application program uses to change the
size of the result table and the order of its
domain name server (DNS) rows after the cursor is opened. Contrast
A special TCP/IP network server that with static cursor.
manages a distributed directory that is
used to map TCP/IP host names to IP dynamic dump
addresses. A dump that is issued during the
execution of a program, usually under the
double-byte character large object (DBCLOB) control of that program.
| A graphic string data type in which a
| sequence of bytes represent double-byte dynamic SQL
| characters that range in size from 0 bytes | SQL statements that are prepared and
| to 2 GB, less 1 byte. In general, DBCLOB | executed at run time. In dynamic SQL,
| values are used whenever a double-byte | the SQL statement is contained as a
| character string might exceed the limits of | character string in a host variable or as a
| the VARGRAPHIC type. | constant, and it is not precompiled.

double-byte character set (DBCS) EA-enabled table space

A set of characters, which are used by A table space or index space that is
enabled for extended addressability and

530 Command Reference

 that contains individual partitions (or An enclave is similar to a program or run
pieces, for LOB table spaces) that are unit. See also WLM enclave.
greater than 4 GB.
encoding scheme
EB See exabyte. A set of rules to represent character data
(ASCII, EBCDIC, or Unicode).
EBCDIC
Extended binary coded decimal | ENFM See enabling-new-function mode.
interchange code. An encoding scheme
ENFM*
that is used to represent character data in
| See enabling-new-function mode*.
the z/OS, VM, VSE, and iSeries
environments. Contrast with ASCII and | entity A person, object, or concept about which
Unicode. | information is stored. In a relational
| database, entities are represented as
embedded SQL
| tables. A database includes information
SQL statements that are coded within an
| about the entities in an organization or
application program. See static SQL.
| business, and their relationships to each
| enabling-new-function mode (ENFM) | other.
| A transitional stage of the
enumerated list
| version-to-version migration process
A set of DB2 objects that are defined with
| during which the DB2 subsystem or data
a LISTDEF utility control statement in
| sharing group is preparing to use the new
which pattern-matching characters (*, %;,
| functions of the new version. When in
_, or ?) are not used.
| enabling-new-function mode, a DB2 data
| sharing group cannot coexist with environment
| members that are still at the prior version A collection of names of logical and
| level. Fallback to a prior version is not physical resources that are used to
| supported, and most new functions of the support the performance of a function.
| new version are not available for use in
environment handle
| enabling-new-function mode. Contrast
| A handle that identifies the global context
| with conversion mode, conversion mode*,
| for database access. All data that is
| enabling-new-function mode*, and
| pertinent to all objects in the environment
| new-function mode.
| is associated with this handle.
| enabling-new-function mode* (ENFM*)
equijoin
| A transitional stage of the
A join operation in which the
| version-to-version migration process that
join-condition has the form expression =
| applies to a DB2 subsystem or data
expression. See also join, full outer join,
| sharing group that was in new-function
inner join, left outer join, outer join, and
| mode (NFM) at one time. When in
right outer join.
| enabling-new-function mode*, a DB2
| subsystem or data sharing group is error page range
| preparing to use the new functions of the A range of pages that are considered to be
| new version but cannot yet use them. A physically damaged. DB2 does not allow
| data sharing group that is in users to access any pages that fall within
| enabling-new-function mode* cannot this range.
| coexist with members that are still at the
escape character
| prior version level. Fallback to a prior
The symbol, a double quotation (″) for
| version is not supported. Contrast with
example, that is used to enclose an SQL
| conversion mode, conversion mode*,
delimited identifier.
| enabling-new-function mode, and
| new-function mode. exabyte
A unit of measure for processor, real and
enclave
virtual storage capacities, and channel
In Language Environment , an
volume that has a value of 1 152 921 504
independent collection of routines, one of
606 846 976 bytes or 260.
which is designated as the main routine.

DB2 glossary 531

 exception exposed name
| An SQL operation that involves the A correlation name or a table or view
| EXCEPT set operator, which combines name for which a correlation name is not
| two result tables. The result of an specified.
| exception operation consists of all of the
expression
| rows that are in only one of the result
An operand or a collection of operators
| tables.
and operands that yields a single value.
exception table
Extended Recovery Facility (XRF)
A table that holds rows that violate
A facility that minimizes the effect of
referential constraints or check constraints
failures in z/OS, VTAM, the host
that the CHECK DATA utility finds.
processor, or high-availability applications
exclusive lock during sessions between high-availability
A lock that prevents concurrently applications and designated terminals.
executing application processes from This facility provides an alternative
reading or changing data. Contrast with subsystem to take over sessions from the
share lock. failing subsystem.
executable statement Extensible Markup Language (XML)
An SQL statement that can be embedded A standard metalanguage for defining
in an application program, dynamically markup languages that is a subset of
prepared and executed, or issued Standardized General Markup Language
interactively. (SGML).
execution context external function
In SQLJ, a Java object that can be used to | A function that has its functional logic
control the execution of SQL statements. | implemented in a programming language
| application that resides outside the
exit routine
| database, in the file system of the
A user-written (or IBM-provided default)
| database server. The association of the
program that receives control from DB2 to
| function with the external code
perform specific functions. Exit routines
| application is specified by the EXTERNAL
run as extensions of DB2.
| clause in the CREATE FUNCTION
expanding conversion | statement. External functions can be
A process that occurs when the length of | classified as external scalar functions and
a converted string is greater than that of | external table functions. Contrast with
the source string. For example, this | sourced function, built-in function, and
process occurs when an ASCII mixed-data | SQL function.
string that contains DBCS characters is
external procedure
converted to an EBCDIC mixed-data
| A procedure that has its procedural logic
string; the converted string is longer
| implemented in an external programming
because shift codes are added.
| language application. The association of
explicit hierarchical locking | the procedure with the external
Locking that is used to make the | application is specified by a CREATE
parent-child relationship between | PROCEDURE statement with a
resources known to IRLM. This kind of | LANGUAGE clause that has a value other
locking avoids global locking overhead | than SQL and an EXTERNAL clause that
when no inter-DB2 interest exists on a | implicitly or explicitly specifies the name
resource. | of the external application. Contrast with
| external SQL procedure and native SQL
explicit privilege
| procedure.
| A privilege that has a name and is held as
| the result of an SQL GRANT statement external routine
| and revoked as the result of an SQL A user-defined function or stored
| REVOKE statement. For example, the procedure that is based on code that is
| SELECT privilege. written in an external programming
language.

532 Command Reference

| external SQL procedure | orientation (for example, NEXT ROWSET,
| An SQL procedure that is processed using | LAST ROWSET, or ROWSET STARTING
| a generated C program that is a | AT ABSOLUTE n).
| representation of the procedure. When an
field procedure
| external SQL procedure is called, the C
A user-written exit routine that is
| program representation of the procedure
designed to receive a single value and
| is executed in a stored procedures address
transform (encode or decode) it in any
| space. Contrast with external procedure
way the user can specify.
| and native SQL procedure.
| file reference variable
failed member state
| A host variable that is declared with one
A state of a member of a data sharing
| of the derived data types (BLOB_FILE,
group in which the member’s task,
| CLOB_FILE, DBCLOB_FILE); file
address space, or z/OS system terminates
| reference variables direct the reading of a
before the state changes from active to
| LOB from a file or the writing of a LOB
quiesced.
| into a file.
fallback
filter factor
| The process of returning to a previous
A number between zero and one that
| release of DB2 after attempting or
estimates the proportion of rows in a
| completing migration to a current release.
table for which a predicate is true.
| Fallback is supported only from a
| subsystem that is in conversion mode. fixed-length string
| A character, graphic, or binary string
false global lock contention
| whose length is specified and cannot be
A contention indication from the coupling
| changed. Contrast with varying-length
facility that occurs when multiple lock
| string.
names are hashed to the same indicator
and when no real contention exists. FlashCopy
| A function on the IBM Enterprise Storage
fan set
| Server that can, in conjunction with the
A direct physical access path to data,
| BACKUP SYSTEM utility, create a
which is provided by an index, hash, or
| point-in-time copy of data while an
link; a fan set is the means by which DB2
| application is running.
supports the ordering of data.
foreign key
federated database
A column or set of columns in a
The combination of a DB2 server (in
dependent table of a constraint
Linux, UNIX, and Windows
relationship. The key must have the same
environments) and multiple data sources
number of columns, with the same
to which the server sends queries. In a
descriptions, as the primary key of the
federated database system, a client
parent table. Each foreign key value must
application can use a single SQL
either match a parent key value in the
statement to join data that is distributed
related parent table or be null.
across multiple database management
systems and can view the data as if it forest An ordered set of subtrees of XML nodes.
were local.
forward log recovery
fetch orientation The third phase of restart processing
| The specification of the desired placement during which DB2 processes the log in a
| of the cursor as part of a FETCH forward direction to apply all REDO log
| statement. The specification can be before records.
| or after the rows of the result table (with
free space
| BEFORE or AFTER). The specification can
The total amount of unused space in a
| also have either a single-row fetch
page; that is, the space that is not used to
| orientation (for example, NEXT, LAST, or
store records or control information is free
| ABSOLUTE n) or a rowset fetch
space.

DB2 glossary 533

 full outer join buffer pool. Either read/write interest is
The result of a join operation that active among DB2 subsystems for this
includes the matched rows of both tables page set, or the page set has changed
that are being joined and preserves the pages in the group buffer pool that have
unmatched rows of both tables. See also not yet been cast out to disk.
join, equijoin, inner join, left outer join,
generalized trace facility (GTF)
outer join, and right outer join.
A z/OS service program that records
| fullselect significant system events such as I/O
| A subselect, a fullselect in parentheses, or interrupts, SVC interrupts, program
| a number of both that are combined by interrupts, or external interrupts.
| set operators. Fullselect specifies a result
generic resource name
| table. If a set operator is not used, the
A name that VTAM uses to represent
| result of the fullselect is the result of the
several application programs that provide
| specified subselect or fullselect.
the same function in order to handle
fully escaped mapping session distribution and balancing in a
A mapping from an SQL identifier to an Sysplex environment.
XML name when the SQL identifier is a
getpage
column name.
An operation in which DB2 accesses a
function data page.
A mapping, which is embodied as a
global lock
program (the function body) that is
A lock that provides concurrency control
invocable by means of zero or more input
within and among DB2 subsystems. The
values (arguments) to a single value (the
scope of the lock is across all DB2
result). See also aggregate function and
subsystems of a data sharing group.
scalar function.
global lock contention
Functions can be user-defined, built-in, or
Conflicts on locking requests between
generated by DB2. (See also built-in
different DB2 members of a data sharing
function, cast function, external function,
group when those members are trying to
sourced function, SQL function, and
serialize shared resources.
user-defined function.)
governor
function definer
See resource limit facility.
The authorization ID of the owner of the
schema of the function that is specified in graphic string
the CREATE FUNCTION statement. | A sequence of DBCS characters. Graphic
| data can be further classified as
function package
| GRAPHIC, VARGRAPHIC, or DBCLOB.
A package that results from binding the
DBRM for a function program. | GRECP
| See group buffer pool recovery pending.
function package owner
The authorization ID of the user who gross lock
binds the function program’s DBRM into The shared, update, or exclusive mode locks
a function package. on a table, partition, or table space.
function signature group buffer pool duplexing
The logical concatenation of a fully The ability to write data to two instances
qualified function name with the data of a group buffer pool structure: a
types of all of its parameters. primary group buffer pool and a
secondary group buffer pool. z/OS
GB Gigabyte. A value of (1 073 741 824 bytes).
publications refer to these instances as the
GBP See group buffer pool. “old” (for primary) and “new” (for
secondary) structures.
GBP-dependent
The status of a page set or page set group buffer pool (GBP)
partition that is dependent on the group A coupling facility cache structure that is

534 Command Reference

 used by a data sharing group to cache hole A row of the result table that cannot be
data and to ensure that the data is accessed because of a delete or an update
consistent for all members. that has been performed on the row. See
also delete hole and update hole.
| group buffer pool recovery pending (GRECP)
| The state that exists after the buffer pool home address space
| for a data sharing group is lost. When a The area of storage that z/OS currently
| page set is in this state, changes that are recognizes as dispatched.
| recorded in the log must be applied to the
host The set of programs and resources that
| affected page set before the page set can
are available on a given TCP/IP instance.
| be used.
host expression
group level
A Java variable or expression that is
The release level of a data sharing group,
referenced by SQL clauses in an SQLJ
which is established when the first
application program.
member migrates to a new release.
host identifier
group name
A name that is declared in the host
The z/OS XCF identifier for a data
program.
sharing group.
host language
group restart
A programming language in which you
A restart of at least one member of a data
can embed SQL statements.
sharing group after the loss of either locks
or the shared communications area. host program
An application program that is written in
GTF See generalized trace facility.
a host language and that contains
handle embedded SQL statements.
In DB2 ODBC, a variable that refers to a
host structure
data structure and associated resources.
In an application program, a structure
See also statement handle, connection
that is referenced by embedded SQL
handle, and environment handle.
statements.
help panel
host variable
A screen of information that presents
In an application program written in a
tutorial text to assist a user at the
host language, an application variable
workstation or terminal.
that is referenced by embedded SQL
heuristic damage statements.
The inconsistency in data between one or
host variable array
more participants that results when a
An array of elements, each of which
heuristic decision to resolve an indoubt
corresponds to a value for a column. The
LUW at one or more participants differs
dimension of the array determines the
from the decision that is recorded at the
maximum number of rows for which the
coordinator.
array can be used.
heuristic decision
IBM System z9 Integrated Processor (zIIP)
A decision that forces indoubt resolution
| A specialized processor that can be used
at a participant by means other than
| for some DB2 functions.
automatic resynchronization between
coordinator and participant. IDCAMS
An IBM program that is used to process
| histogram statistics
access method services commands. It can
| A way of summarizing data distribution.
be invoked as a job or jobstep, from a
| This technique divides up the range of
TSO terminal, or from within a user’s
| possible values in a data set into intervals,
application program.
| such that each interval contains
| approximately the same percentage of the
| values. A set of statistics are collected for
| each interval.

DB2 glossary 535

 IDCAMS LISTCAT index A set of pointers that are logically ordered
A facility for obtaining information that is by the values of a key. Indexes can
contained in the access method services provide faster access to data and can
catalog. enforce uniqueness on the rows in a table.
identity column index-controlled partitioning
| A column that provides a way for DB2 to A type of partitioning in which partition
| automatically generate a numeric value boundaries for a partitioned table are
| for each row. Identity columns are controlled by values that are specified on
| defined with the AS IDENTITY clause. the CREATE INDEX statement. Partition
| Uniqueness of values can be ensured by limits are saved in the LIMITKEY column
| defining a unique index that contains of the SYSIBM.SYSINDEXPART catalog
| only the identity column. A table can table.
| have no more than one identity column.
index key
IFCID See instrumentation facility component The set of columns in a table that is used
identifier. to determine the order of index entries.
IFI See instrumentation facility interface. index partition
A VSAM data set that is contained within
IFI call
a partitioning index space.
An invocation of the instrumentation
facility interface (IFI) by means of one of index space
its defined functions. A page set that is used to store the entries
of one index.
image copy
An exact reproduction of all or part of a indicator column
table space. DB2 provides utility A 4-byte value that is stored in a base
programs to make full image copies (to table in place of a LOB column.
copy the entire table space) or incremental
indicator variable
image copies (to copy only those pages
A variable that is used to represent the
that have been modified since the last
null value in an application program. If
image copy).
the value for the selected column is null,
IMS attachment facility a negative value is placed in the indicator
A DB2 subcomponent that uses z/OS variable.
subsystem interface (SSI) protocols and
indoubt
cross-memory linkage to process requests
A status of a unit of recovery. If DB2 fails
from IMS to DB2 and to coordinate
after it has finished its phase 1 commit
resource commitment.
processing and before it has started phase
in-abort 2, only the commit coordinator knows if
A status of a unit of recovery. If DB2 fails an individual unit of recovery is to be
after a unit of recovery begins to be rolled committed or rolled back. At restart, if
back, but before the process is completed, DB2 lacks the information it needs to
DB2 continues to back out the changes make this decision, the status of the unit
during restart. of recovery is indoubt until DB2 obtains
this information from the coordinator.
in-commit
More than one unit of recovery can be
A status of a unit of recovery. If DB2 fails
indoubt at restart.
after beginning its phase 2 commit
processing, it ″knows,″ when restarted, indoubt resolution
that changes made to data are consistent. The process of resolving the status of an
Such units of recovery are termed indoubt logical unit of work to either the
in-commit. committed or the rollback state.
independent inflight
An object (row, table, or table space) that A status of a unit of recovery. If DB2 fails
is neither a parent nor a dependent of before its unit of recovery completes
another object. phase 1 of the commit process, it merely

536 Command Reference

 backs out the updates of its unit of instrumentation facility component identifier
recovery at restart. These units of (IFCID)
recovery are termed inflight. A value that names and identifies a trace
record of an event that can be traced. As a
inheritance
parameter on the START TRACE and
The passing downstream of class
MODIFY TRACE commands, it specifies
resources or attributes from a parent class
that the corresponding event is to be
in the class hierarchy to a child class.
traced.
initialization file
instrumentation facility interface (IFI)
For DB2 ODBC applications, a file
A programming interface that enables
containing values that can be set to adjust
programs to obtain online trace data
the performance of the database manager.
about DB2, to submit DB2 commands,
inline copy and to pass data to DB2.
A copy that is produced by the LOAD or
Interactive System Productivity Facility (ISPF)
REORG utility. The data set that the inline
An IBM licensed program that provides
copy produces is logically equivalent to a
interactive dialog services in a z/OS
full image copy that is produced by
environment.
running the COPY utility with read-only
access (SHRLEVEL REFERENCE). inter-DB2 R/W interest
A property of data in a table space, index,
inner join
or partition that has been opened by more
The result of a join operation that
than one member of a data sharing group
includes only the matched rows of both
and that has been opened for writing by
tables that are being joined. See also join,
at least one of those members.
equijoin, full outer join, left outer join,
outer join, and right outer join. intermediate database server
The target of a request from a local
inoperative package
application or a remote application
A package that cannot be used because
requester that is forwarded to another
one or more user-defined functions or
database server.
procedures that the package depends on
were dropped. Such a package must be internal resource lock manager (IRLM)
explicitly rebound. Contrast with invalid A z/OS subsystem that DB2 uses to
package. control communication and database
locking.
insensitive cursor
A cursor that is not sensitive to inserts, internationalization
updates, or deletes that are made to the The support for an encoding scheme that
underlying rows of a result table after the is able to represent the code points of
result table has been materialized. characters from many different
geographies and languages. To support all
insert trigger
geographies, the Unicode standard
A trigger that is defined with the
requires more than 1 byte to represent a
triggering SQL operation, an insert.
single character. See also Unicode.
install The process of preparing a DB2
| intersection
subsystem to operate as a z/OS
| An SQL operation that involves the
subsystem.
| INTERSECT set operator, which combines
| INSTEAD OF trigger | two result tables. The result of an
| A trigger that is associated with a single | intersection operation consists of all of the
| view and is activated by an insert, | rows that are in both result tables.
| update, or delete operation on the view
invalid package
| and that can define how to propagate the
A package that depends on an object
| insert, update, or delete operation on the
(other than a user-defined function) that
| view to the underlying tables of the view.
is dropped. Such a package is implicitly
| Contrast with BEFORE trigger and
rebound on invocation. Contrast with
| AFTER trigger.
inoperative package.

DB2 glossary 537

 IP address | columns, or an expression that is
| A value that uniquely identifies a TCP/IP | identified in the description of a table,
| host. | index, or referential constraint. The same
| column or expression can be part of more
IRLM See internal resource lock manager.
| than one key.
isolation level
key-sequenced data set (KSDS)
The degree to which a unit of work is
A VSAM file or data set whose records
isolated from the updating operations of
are loaded in key sequence and controlled
other units of work. See also cursor
by an index.
stability, read stability, repeatable read,
and uncommitted read. KSDS See key-sequenced data set.
ISPF See Interactive System Productivity large object (LOB)
Facility. A sequence of bytes representing bit data,
single-byte characters, double-byte
iterator
characters, or a mixture of single- and
In SQLJ, an object that contains the result
double-byte characters. A LOB can be up
set of a query. An iterator is equivalent to
to 2 GB minus 1 byte in length. See also
a cursor in other host languages.
binary large object, character large object,
iterator declaration clause and double-byte character large object.
In SQLJ, a statement that generates an
last agent optimization
iterator declaration class. An iterator is an
An optimized commit flow for either
object of an iterator declaration class.
presumed-nothing or presumed-abort
JAR See Java Archive. protocols in which the last agent, or final
participant, becomes the commit
Java Archive (JAR)
coordinator. This flow saves at least one
A file format that is used for aggregating
message.
many files into a single file.
latch A DB2 mechanism for controlling
JDBC A Sun Microsystems database application
concurrent events or the use of system
programming interface (API) for Java that
resources.
allows programs to access database
management systems by using callable LCID See log control interval definition.
SQL.
LDS See linear data set.
join A relational operation that allows retrieval
leaf page
of data from two or more tables based on
An index page that contains pairs of keys
matching column values. See also
and RIDs and that points to actual data.
equijoin, full outer join, inner join, left
Contrast with nonleaf page.
outer join, outer join, and right outer join.
left outer join
KB Kilobyte. A value of 1024 bytes.
The result of a join operation that
Kerberos includes the matched rows of both tables
A network authentication protocol that is that are being joined, and that preserves
designed to provide strong authentication the unmatched rows of the first table. See
for client/server applications by using also join, equijoin, full outer join, inner
secret-key cryptography. join, outer join, and right outer join.
Kerberos ticket limit key
A transparent application mechanism that The highest value of the index key for a
transmits the identity of an initiating partition.
principal to its target. A simple ticket
linear data set (LDS)
contains the principal’s identity, a session
A VSAM data set that contains data but
key, a timestamp, and other information,
no control information. A linear data set
which is sealed using the target’s secret
can be accessed as a byte-addressable
key.
string in virtual storage.
| key A column, an ordered collection of

538 Command Reference

linkage editor local lock
A computer program for creating load A lock that provides intra-DB2
modules from one or more object concurrency control, but not inter-DB2
modules or load modules by resolving concurrency control; that is, its scope is a
cross references among the modules and, single DB2.
if necessary, adjusting addresses.
local subsystem
link-edit The unique relational DBMS to which the
The action of creating a loadable user or application program is directly
computer program using a linkage editor. connected (in the case of DB2, by one of
the DB2 attachment facilities).
list A type of object, which DB2 utilities can
process, that identifies multiple table location
spaces, multiple index spaces, or both. A The unique name of a database server. An
list is defined with the LISTDEF utility application uses the location name to
control statement. access a DB2 database server. A database
alias can be used to override the location
list structure
name when accessing a remote server.
A coupling facility structure that lets data
be shared and manipulated as elements of location alias
a queue. Another name by which a database server
identifies itself in the network.
L-lock See logical lock.
Applications can use this name to access a
load module DB2 database server.
A program unit that is suitable for
lock A means of controlling concurrent events
loading into main storage for execution.
or access to data. DB2 locking is
The output of a linkage editor.
performed by the IRLM.
LOB See large object.
lock duration
LOB locator The interval over which a DB2 lock is
A mechanism that allows an application held.
program to manipulate a large object
lock escalation
value in the database system. A LOB
The promotion of a lock from a row, page,
locator is a fullword integer value that
or LOB lock to a table space lock because
represents a single LOB value. An
the number of page locks that are
application program retrieves a LOB
concurrently held on a given resource
locator into a host variable and can then
exceeds a preset limit.
apply SQL operations to the associated
LOB value using the locator. locking
The process by which the integrity of data
LOB lock
is ensured. Locking prevents concurrent
A lock on a LOB value.
users from accessing inconsistent data.
LOB table space See also claim, drain, and latch.
A table space that contains all the data for
lock mode
a particular LOB column in the related
A representation for the type of access
base table.
that concurrently running programs can
local A way of referring to any object that the have to a resource that a DB2 lock is
local DB2 subsystem maintains. A local holding.
table, for example, is a table that is
lock object
maintained by the local DB2 subsystem.
The resource that is controlled by a DB2
Contrast with remote.
lock.
locale The definition of a subset of a user’s
lock promotion
environment that combines a CCSID and
The process of changing the size or mode
characters that are defined for a specific
of a DB2 lock to a higher, more restrictive
language and country.
level.

DB2 glossary 539

lock size logical recovery pending (LRECP)
The amount of data that is controlled by a The state in which the data and the index
DB2 lock on table data; the value can be a keys that reference the data are
row, a page, a LOB, a partition, a table, or inconsistent.
a table space.
logical unit (LU)
lock structure An access point through which an
A coupling facility data structure that is application program accesses the SNA
composed of a series of lock entries to network in order to communicate with
support shared and exclusive locking for another application program. See also LU
logical resources. name.
log A collection of records that describe the logical unit of work identifier (LUWID)
events that occur during DB2 execution A name that uniquely identifies a thread
and that indicate their sequence. The within a network. This name consists of a
information thus recorded is used for fully-qualified LU network name, an
recovery in the event of a failure during LUW instance number, and an LUW
DB2 execution. sequence number.
log control interval definition logical unit of work
A suffix of the physical log record that The processing that a program performs
tells how record segments are placed in between synchronization points.
the physical control interval.
log initialization
logical claim The first phase of restart processing
A claim on a logical partition of a during which DB2 attempts to locate the
nonpartitioning index. current end of the log.
logical index partition log record header (LRH)
The set of all keys that reference the same A prefix, in every log record, that contains
data partition. control information.
logical lock (L-lock) log record sequence number (LRSN)
The lock type that transactions use to An identifier for a log record that is
control intra- and inter-DB2 data associated with a data sharing member.
concurrency between transactions. DB2 uses the LRSN for recovery in the
Contrast with physical lock (P-lock). data sharing environment.
logically complete log truncation
A state in which the concurrent copy A process by which an explicit starting
process is finished with the initialization RBA is established. This RBA is the point
of the target objects that are being copied. at which the next byte of log data is to be
The target objects are available for written.
update.
LPL See logical page list.
logical page list (LPL)
LRECP
A list of pages that are in error and that
See logical recovery pending.
cannot be referenced by applications until
the pages are recovered. The page is in LRH See log record header.
logical error because the actual media
LRSN See log record sequence number.
(coupling facility or disk) might not
contain any errors. Usually a connection LU See logical unit.
to the media has been lost.
LU name
logical partition Logical unit name, which is the name by
A set of key or RID pairs in a which VTAM refers to a node in a
nonpartitioning index that are associated network.
with a particular partition.
LUW See logical unit of work.

540 Command Reference

LUWID physical and logical characteristics and
See logical unit of work identifier. attributes of a session.
mapping table modify locks
A table that the REORG utility uses to An L-lock or P-lock with a MODIFY
map the associations of the RIDs of data attribute. A list of these active locks is
records in the original copy and in the kept at all times in the coupling facility
shadow copy. This table is created by the lock structure. If the requesting DB2
user. subsystem fails, that DB2 subsystem’s
modify locks are converted to retained
mass delete
locks.
The deletion of all rows of a table.
multibyte character set (MBCS)
materialize
A character set that represents single
v The process of putting rows from a characters with more than a single byte.
view or nested table expression into a UTF-8 is an example of an MBCS.
work file for additional processing by a Characters in UTF-8 can range from 1 to 4
query. bytes in DB2. Contrast with single-byte
v The placement of a LOB value into character set and double-byte character
contiguous storage. Because LOB set. See also Unicode.
values can be very large, DB2 avoids
multidimensional analysis
materializing LOB data until doing so
The process of assessing and evaluating
becomes absolutely necessary.
an enterprise on more than one level.
materialized query table
Multiple Virtual Storage (MVS)
A table that is used to contain information
An element of the z/OS operating system.
that is derived and can be summarized
This element is also called the Base
from one or more source tables. Contrast
Control Program (BCP).
with base table.
multisite update
MB Megabyte (1 048 576 bytes).
Distributed relational database processing
MBCS See multibyte character set. in which data is updated in more than
one location within a single unit of work.
member name
The z/OS XCF identifier for a particular multithreading
DB2 subsystem in a data sharing group. Multiple TCBs that are executing one
copy of DB2 ODBC code concurrently
menu A displayed list of available functions for
(sharing a processor) or in parallel (on
selection by the operator. A menu is
separate central processors).
sometimes called a menu panel.
MVS See Multiple Virtual Storage.
metalanguage
A language that is used to create other | native SQL procedure
specialized languages. | An SQL procedure that is processed by
| converting the procedural statements to a
migration
| native representation that is stored in the
The process of converting a subsystem
| database directory, as is done with other
with a previous release of DB2 to an
| SQL statements. When a native SQL
updated or current release. In this
| procedure is called, the native
process, you can acquire the functions of
| representation is loaded from the
the updated or current release without
| directory, and DB2 executes the
losing the data that you created on the
| procedure. Contrast with external
previous release.
| procedure and external SQL procedure.
mixed data string
nested table expression
A character string that can contain both
A fullselect in a FROM clause
single-byte and double-byte characters.
(surrounded by parentheses).
mode name
network identifier (NID)
A VTAM name for the collection of
The network ID that is assigned by IMS

DB2 glossary 541

 or CICS, or if the connection type is forward direction. Nonscrollable cursors
RRSAF, the RRS unit of recovery ID are sometimes called forward-only cursors
(URID). or serial cursors.
| new-function mode (NFM) normalization
| The normal mode of operation that exists A key step in the task of building a
| after successful completion of a logical relational database design.
| version-to-version migration. At this Normalization helps you avoid
| stage, all new functions of the new redundancies and inconsistencies in your
| version are available for use. A DB2 data data. An entity is normalized if it meets a
| sharing group cannot coexist with set of constraints for a particular normal
| members that are still at the prior version form (first normal form, second normal
| level, and fallback to a prior version is form, and so on). Contrast with
| not supported. Contrast with conversion denormalization.
| mode, conversion mode*,
not-variant function
| enabling-new-function mode, and
See deterministic function.
| enabling-new-function mode*.
NPSI See nonpartitioned secondary index.
| NFM See new-function mode.
NUL The null character (’\0’), which is
NID See network identifier.
represented by the value X’00’. In C, this
| node ID index character denotes the end of a string.
| See XML node ID index.
null A special value that indicates the absence
nondeterministic function of information.
A user-defined function whose result is
null terminator
not solely dependent on the values of the
| In C, the value that indicates the end of a
input arguments. That is, successive
| string. For EBCDIC, ASCII, and Unicode
invocations with the same argument
| UTF-8 strings, the null terminator is a
values can produce a different answer.
| single-byte value (X’00’). For Unicode
This type of function is sometimes called
| UTF-16 or UCS-2 (wide) strings, the null
a variant function. Contrast with
| terminator is a double-byte value
deterministic function (sometimes called a
| (X’0000’).
not-variant function).
ODBC
nonleaf page
See Open Database Connectivity.
A page that contains keys and page
numbers of other pages in the index ODBC driver
(either leaf or nonleaf pages). Nonleaf A dynamically-linked library (DLL) that
pages never point to actual data. Contrast implements ODBC function calls and
with leaf page. interacts with a data source.
nonpartitioned index | OLAP See online analytical processing.
An index that is not physically
| online analytical processing (OLAP)
partitioned. Both partitioning indexes and
| The process of collecting data from one or
secondary indexes can be nonpartitioned.
| many sources; transforming and
nonpartitioned secondary index (NPSI) | analyzing the consolidated data quickly
An index on a partitioned table space that | and interactively; and examining the
is not the partitioning index and is not | results across different dimensions of the
partitioned. Contrast with | data by looking for patterns, trends, and
data-partitioned secondary index. | exceptions within complex relationships
| of that data.
nonpartitioning index
See secondary index. Open Database Connectivity (ODBC)
A Microsoft database application
nonscrollable cursor
programming interface (API) for C that
A cursor that can be moved only in a
allows access to database management
systems by using callable SQL. ODBC

542 Command Reference

 does not require the use of an SQL | BIND PACKAGE or REBIND PACKAGE
preprocessor. In addition, ODBC provides | command. An SQL procedural language
an architecture that lets users add | package is created by a CREATE or
modules called database drivers, which link | ALTER PROCEDURE statement for a
the application to their choice of database | native SQL procedure. The name of a
management systems at run time. This | package consists of a location name, a
means that applications no longer need to | collection ID, a package ID, and a version
be directly linked to the modules of all | ID.
the database management systems that
| page A unit of storage within a table space (4
are supported.
| KB, 8 KB, 16 KB, or 32 KB) or index space
ordinary identifier | (4 KB, 8 KB, 16 KB, or 32 KB). In a table
An uppercase letter followed by zero or | space, a page contains one or more rows
more characters, each of which is an | of a table. In a LOB or XML table space, a
uppercase letter, a digit, or the underscore | LOB or XML value can span more than
character. An ordinary identifier must not | one page, but no more than one LOB or
be a reserved word. | XML value is stored on a page.
ordinary token page set
A numeric constant, an ordinary Another way to refer to a table space or
identifier, a host identifier, or a keyword. index space. Each page set consists of a
collection of VSAM data sets.
originating task
In a parallel group, the primary agent page set recovery pending (PSRCP)
that receives data from other execution A restrictive state of an index space. In
units (referred to as parallel tasks) that are this case, the entire page set must be
executing portions of the query in recovered. Recovery of a logical part is
parallel. prohibited.
outer join panel A predefined display image that defines
The result of a join operation that the locations and characteristics of display
includes the matched rows of both tables fields on a display surface (for example, a
that are being joined and preserves some menu panel).
or all of the unmatched rows of the tables
parallel complex
that are being joined. See also join,
A cluster of machines that work together
equijoin, full outer join, inner join, left
to handle multiple transactions and
outer join, and right outer join.
applications.
overloaded function
parallel group
A function name for which multiple
A set of consecutive operations that
function instances exist.
execute in parallel and that have the same
package number of parallel tasks.
An object containing a set of SQL
parallel I/O processing
statements that have been statically
A form of I/O processing in which DB2
bound and that is available for
initiates multiple concurrent requests for a
processing. A package is sometimes also
single user query and performs I/O
called an application package.
processing concurrently (in parallel) on
package list multiple data partitions.
An ordered list of package names that
parallelism assistant
may be used to extend an application
In Sysplex query parallelism, a DB2
plan.
subsystem that helps to process parts of a
package name parallel query that originates on another
| The name of an object that is used for an DB2 subsystem in the data sharing group.
| application package or an SQL procedure
| package. An application package is a
| bound version of a database request
| module (DBRM) that is created by a

DB2 glossary 543

 parallelism coordinator parent table space
In Sysplex query parallelism, the DB2 A table space that contains a parent table.
subsystem from which the parallel query A table space containing a dependent of
originates. that table is a dependent table space.
Parallel Sysplex participant
A set of z/OS systems that communicate An entity other than the commit
and cooperate with each other through coordinator that takes part in the commit
certain multisystem hardware components process. The term participant is
and software services to process customer synonymous with agent in SNA.
workloads.
partition
parallel task | A portion of a page set. Each partition
The execution unit that is dynamically | corresponds to a single, independently
created to process a query in parallel. A | extendable data set. The maximum size of
parallel task is implemented by a z/OS | a partition depends on the number of
service request block. | partitions in the partitioned page set. All
| partitions of a given page set have the
parameter marker
| same maximum size.
| A question mark (?) that appears in a
| statement string of a dynamic SQL | partition-by-growth table space
| statement. The question mark can appear | A table space whose size can grow to
| where a variable could appear if the | accommodate data growth. DB2 for z/OS
| statement string were a static SQL | manages partition-by-growth table spaces
| statement. | by automatically adding new data sets
| when the database needs more space to
parameter-name
| satisfy an insert operation. Contrast with
| An SQL identifier that designates a
| range-partitioned table space. See also
| parameter in a routine that is written by a
| universal table space.
| user. Parameter names are required for
| SQL procedures and SQL functions, and partitioned data set (PDS)
| they are used in the body of the routine | A data set in disk storage that is divided
| to refer to the values of the parameters. | into partitions, which are called members.
| Parameter names are optional for external | Each partition can contain a program,
| routines. | part of a program, or data. A program
| library is an example of a partitioned data
parent key
| set.
A primary key or unique key in the
parent table of a referential constraint. partitioned index
The values of a parent key determine the An index that is physically partitioned.
valid values of the foreign key in the Both partitioning indexes and secondary
referential constraint. indexes can be partitioned.
parent lock partitioned page set
For explicit hierarchical locking, a lock A partitioned table space or an index
that is held on a resource that might have space. Header pages, space map pages,
child locks that are lower in the hierarchy. data pages, and index pages reference
A parent lock is usually the table space data only within the scope of the
lock or the partition intent lock. See also partition.
child lock.
partitioned table space
parent row | A table space that is based on a single
A row whose primary key value is the | table and that is subdivided into
foreign key value of a dependent row. | partitions, each of which can be processed
| independently by utilities. Contrast with
parent table
| segmented table space and universal table
A table whose primary key is referenced
| space.
by the foreign key of a dependent table.
partitioning index
An index in which the leftmost columns

544 Command Reference

 are the partitioning columns of the table. decimal number (called the size in the C
The index can be partitioned or language). In the C language, the number
nonpartitioned. of digits to the right of the decimal point
(called the scale in SQL). The DB2
partner logical unit
information uses the SQL terms.
An access point in the SNA network that
is connected to the local DB2 subsystem precompilation
by way of a VTAM conversation. A processing of application programs
containing SQL statements that takes
path See SQL path.
place before compilation. SQL statements
PDS See partitioned data set. are replaced with statements that are
recognized by the host language compiler.
physical consistency
Output from this precompilation includes
The state of a page that is not in a
source code that can be submitted to the
partially changed state.
compiler and the database request
physical lock (P-lock) module (DBRM) that is input to the bind
A type of lock that DB2 acquires to process.
provide consistency of data that is cached
predicate
in different DB2 subsystems. Physical
An element of a search condition that
locks are used only in data sharing
expresses or implies a comparison
environments. Contrast with logical lock
operation.
(L-lock).
prefix A code at the beginning of a message or
physically complete
record.
The state in which the concurrent copy
process is completed and the output data preformat
set has been created. | The process of preparing a VSAM linear
| data set for DB2 use, by writing specific
piece A data set of a nonpartitioned page set.
| data patterns.
plan See application plan.
prepare
plan allocation The first phase of a two-phase commit
The process of allocating DB2 resources to process in which all participants are
a plan in preparation for execution. requested to prepare for commit.
plan member prepared SQL statement
The bound copy of a DBRM that is A named object that is the executable
identified in the member clause. form of an SQL statement that has been
processed by the PREPARE statement.
plan name
The name of an application plan. primary authorization ID
The authorization ID that is used to
P-lock See physical lock.
identify the application process to DB2.
point of consistency
primary group buffer pool
A time when all recoverable data that an
For a duplexed group buffer pool, the
application accesses is consistent with
structure that is used to maintain the
other data. The term point of consistency
coherency of cached data. This structure
is synonymous with sync point or commit
is used for page registration and
point.
cross-invalidation. The z/OS equivalent is
policy See CFRM policy. old structure. Compare with secondary
group buffer pool.
postponed abort UR
A unit of recovery that was inflight or primary index
in-abort, was interrupted by system An index that enforces the uniqueness of
failure or cancellation, and did not a primary key.
complete backout during restart.
primary key
precision In a relational database, a unique, nonnull
In SQL, the total number of digits in a key that is part of the definition of a

DB2 glossary 545

 table. A table cannot be defined as a PSRCP
parent unless it has a unique key or See page set recovery pending.
primary key.
PTF See program temporary fix.
principal
QSAM
An entity that can communicate securely
See queued sequential access method.
with another entity. In Kerberos,
principals are represented as entries in the query A component of certain SQL statements
Kerberos registry database and include that specifies a result table.
users, servers, computers, and others.
query block
principal name The part of a query that is represented by
The name by which a principal is known one of the FROM clauses. Each FROM
to the DCE security services. clause can have multiple query blocks,
depending on DB2 processing of the
privilege
query.
The capability of performing a specific
function, sometimes on a specific object. query CP parallelism
See also explicit privilege. Parallel execution of a single query, which
is accomplished by using multiple tasks.
privilege set
See also Sysplex query parallelism.
| v For the installation SYSADM ID, the set
| of all possible privileges. query I/O parallelism
Parallel access of data, which is
| v For any other authorization ID,
accomplished by triggering multiple I/O
| including the PUBLIC authorization ID,
requests within a single query.
| the set of all privileges that are
| recorded for that ID in the DB2 catalog. queued sequential access method (QSAM)
An extended version of the basic
process
sequential access method (BSAM). When
In DB2, the unit to which DB2 allocates
this method is used, a queue of data
resources and locks. Sometimes called an
blocks is formed. Input data blocks await
application process, a process involves the
processing, and output data blocks await
execution of one or more programs. The
transfer to auxiliary storage or to an
execution of an SQL statement is always
output device.
associated with some process. The means
of initiating and terminating a process are quiesce point
dependent on the environment. A point at which data is consistent as a
result of running the DB2 QUIESCE
program
utility.
A single, compilable collection of
executable statements in a programming RACF Resource Access Control Facility. A
language. component of the z/OS Security Server.
program temporary fix (PTF) | range-partitioned table space
A solution or bypass of a problem that is | A type of universal table space that is
diagnosed as a result of a defect in a | based on partitioning ranges and that
current unaltered release of a licensed | contains a single table. Contrast with
program. An authorized program analysis | partition-by-growth table space. See also
report (APAR) fix is corrective service for | universal table space.
an existing problem. A PTF is preventive
RBA See relative byte address.
service for problems that might be
encountered by other users of the RCT See resource control table.
product. A PTF is temporary, because a
| RDO See resource definition online.
permanent fix is usually not incorporated
into the product until its next release. read stability (RS)
An isolation level that is similar to
protected conversation
repeatable read but does not completely
A VTAM conversation that supports
isolate an application process from all
two-phase commit flows.
other concurrently executing application

546 Command Reference

 processes. See also cursor recovery log
stabilityrepeatable read, and uncommitted A collection of records that describes the
read. events that occur during DB2 execution
and indicates their sequence. The
rebind
recorded information is used for recovery
The creation of a new application plan for
in the event of a failure during DB2
an application program that has been
execution.
bound previously. If, for example, you
have added an index for a table that your recovery manager
application accesses, you must rebind the A subcomponent that supplies
application in order to take advantage of coordination services that control the
that index. interaction of DB2 resource managers
during commit, abort, checkpoint, and
rebuild
restart processes. The recovery manager
The process of reallocating a coupling
also supports the recovery mechanisms of
facility structure. For the shared
other subsystems (for example, IMS) by
communications area (SCA) and lock
acting as a participant in the other
structure, the structure is repopulated; for
subsystem’s process for protecting data
the group buffer pool, changed pages are
that has reached a point of consistency.
usually cast out to disk, and the new
structure is populated only with changed A coordinator or a participant (or both),
pages that were not successfully cast out. in the execution of a two-phase commit,
that can access a recovery log that
record The storage representation of a row or
maintains the state of the logical unit of
other data.
work and names the immediate upstream
record identifier (RID) coordinator and downstream participants.
A unique identifier that DB2 uses to
recovery pending (RECP)
identify a row of data in a table. Compare
A condition that prevents SQL access to a
with row identifier.
table space that needs to be recovered.
record identifier (RID) pool
recovery token
An area of main storage that is used for
An identifier for an element that is used
sorting record identifiers during
in recovery (for example, NID or URID).
list-prefetch processing.
RECP See recovery pending.
record length
The sum of the length of all the columns redo A state of a unit of recovery that indicates
in a table, which is the length of the data that changes are to be reapplied to the
as it is physically stored in the database. disk media to ensure data integrity.
Records can be fixed length or varying
reentrant code
length, depending on how the columns
Executable code that can reside in storage
are defined. If all columns are
as one shared copy for all threads.
fixed-length columns, the record is a
Reentrant code is not self-modifying and
fixed-length record. If one or more
provides separate storage areas for each
columns are varying-length columns, the
thread. See also threadsafe.
record is a varying-length record.
referential constraint
Recoverable Resource Manager Services
The requirement that nonnull values of a
attachment facility (RRSAF)
designated foreign key are valid only if
A DB2 subcomponent that uses Resource
they equal values of the primary key of a
Recovery Services to coordinate resource
designated table.
commitment between DB2 and all other
resource managers that also use RRS in a | referential cycle
z/OS system. | A set of referential constraints such that
| each base table in the set is a descendent
recovery
| of itself. The tables that are involved in a
The process of rebuilding databases after
| referential cycle are ordered so that each
a system failure.

DB2 glossary 547

| table is a descendent of the one before it, remigration
| and the first table is a descendent of the The process of returning to a current
| last table. release of DB2 following a fallback to a
previous release. This procedure
referential integrity
constitutes another migration process.
The state of a database in which all
values of all foreign keys are valid. remote
Maintaining referential integrity requires Any object that is maintained by a remote
the enforcement of referential constraints DB2 subsystem (that is, by a DB2
on all operations that change the data in a subsystem other than the local one). A
table on which the referential constraints remote view, for example, is a view that is
are defined. maintained by a remote DB2 subsystem.
Contrast with local.
referential structure
A set of tables and relationships that remote subsystem
includes at least one table and, for every Any relational DBMS, except the local
table in the set, all the relationships in subsystem, with which the user or
which that table participates and all the application can communicate. The
tables to which it is related. subsystem need not be remote in any
physical sense, and might even operate
refresh age
on the same processor under the same
The time duration between the current
z/OS system.
time and the time during which a
materialized query table was last reoptimization
refreshed. The DB2 process of reconsidering the
access path of an SQL statement at run
registry
time; during reoptimization, DB2 uses the
See registry database.
values of host variables, parameter
registry database markers, or special registers.
A database of security information about
| reordered row format
principals, groups, organizations,
| A row format that facilitates improved
accounts, and security policies.
| performance in retrieval of rows that have
relational database | varying-length columns. DB2 rearranges
A database that can be perceived as a set | the column order, as defined in the
of tables and manipulated in accordance | CREATE TABLE statement, so that the
with the relational model of data. | fixed-length columns are stored at the
| beginning of the row and the
relational database management system
| varying-length columns are stored at the
(RDBMS)
| end of the row. Contrast with basic row
A collection of hardware and software
| format.
that organizes and provides access to a
relational database. REORG pending (REORP)
A condition that restricts SQL access and
| relational schema
most utility access to an object that must
| See SQL schema.
be reorganized.
relationship
REORP
A defined connection between the rows of
See REORG pending.
a table or the rows of two tables. A
relationship is the internal representation repeatable read (RR)
of a referential constraint. The isolation level that provides
maximum protection from other executing
relative byte address (RBA)
application programs. When an
The offset of a data record or control
application program executes with
interval from the beginning of the storage
repeatable read protection, rows that the
space that is allocated to the data set or
program references cannot be changed by
file to which it belongs.
other programs until the program reaches

548 Command Reference

 a commit point. See also cursor stability, | definition data set. In earlier releases of
read stability, and uncommitted read. | CICS, resources were defined by using the
| resource control table (RCT), which is no
repeating group
| longer supported.
A situation in which an entity includes
multiple attributes that are inherently the resource limit facility (RLF)
same. The presence of a repeating group A portion of DB2 code that prevents
violates the requirement of first normal dynamic manipulative SQL statements
form. In an entity that satisfies the from exceeding specified time limits. The
requirement of first normal form, each resource limit facility is sometimes called
attribute is independent and unique in its the governor.
meaning and its name. See also
resource limit specification table (RLST)
normalization.
A site-defined table that specifies the
replay detection mechanism limits to be enforced by the resource limit
A method that allows a principal to detect facility.
whether a request is a valid request from
resource manager
a source that can be trusted or whether an
untrustworthy entity has captured v A function that is responsible for
information from a previous exchange managing a particular resource and that
and is replaying the information exchange guarantees the consistency of all
to gain access to the principal. updates made to recoverable resources
within a logical unit of work. The
request commit resource that is being managed can be
The vote that is submitted to the prepare physical (for example, disk or main
phase if the participant has modified data storage) or logical (for example, a
and is prepared to commit or roll back. particular type of system service).
requester v A participant, in the execution of a
The source of a request to access data at a two-phase commit, that has recoverable
remote server. In the DB2 environment, resources that could have been
the requester function is provided by the modified. The resource manager has
distributed data facility. access to a recovery log so that it can
commit or roll back the effects of the
resource
logical unit of work to the recoverable
The object of a lock or claim, which could
resources.
be a table space, an index space, a data
partition, an index partition, or a logical restart pending (RESTP)
partition. A restrictive state of a page set or
partition that indicates that restart
resource allocation
(backout) work needs to be performed on
The part of plan allocation that deals
the object.
specifically with the database resources.
RESTP
resource control table
See restart pending.
| A construct of previous versions of the
| CICS attachment facility that defines result set
| authorization and access attributes for The set of rows that a stored procedure
| transactions or transaction groups. returns to a client application.
| Beginning in CICS Transaction Server
result set locator
| Version 1.3, resources are defined by
A 4-byte value that DB2 uses to uniquely
| using resource definition online instead of
identify a query result set that a stored
| the resource control table. See also
procedure returns.
| resource definition online.
result table
resource definition online (RDO)
The set of rows that are specified by a
| The recommended method of defining
SELECT statement.
| resources to CICS by creating resource
| definitions interactively, or by using a retained lock
| utility, and then storing them in the CICS A MODIFY lock that a DB2 subsystem

DB2 glossary 549

 was holding at the time of a subsystem | of the cursor as part of a FETCH
failure. The lock is retained in the | statement, with respect to a single row
coupling facility lock structure across a | (for example, NEXT, LAST, or ABSOLUTE
DB2 for z/OS failure. | n). Contrast with rowset-positioned fetch
| orientation.
RID See record identifier.
rowset
RID pool
A set of rows for which a cursor position
See record identifier pool.
is established.
right outer join
rowset cursor
The result of a join operation that
A cursor that is defined so that one or
includes the matched rows of both tables
more rows can be returned as a rowset
that are being joined and preserves the
for a single FETCH statement, and the
unmatched rows of the second join
cursor is positioned on the set of rows
operand. See also join, equijoin, full outer
that is fetched.
join, inner join, left outer join, and outer
join. rowset-positioned fetch orientation
| The specification of the desired placement
RLF See resource limit facility.
| of the cursor as part of a FETCH
RLST See resource limit specification table. | statement, with respect to a rowset (for
| example, NEXT ROWSET, LAST
| role A database entity that groups together
| ROWSET, or ROWSET STARTING AT
| one or more privileges and that can be
| ABSOLUTE n). Contrast with
| assigned to a primary authorization ID or
| row-positioned fetch orientation.
| to PUBLIC. The role is available only in a
| trusted context. row trigger
A trigger that is defined with the trigger
rollback
granularity FOR EACH ROW.
The process of restoring data that was
changed by SQL statements to the state at RRSAF
its last commit point. All locks are freed. See Recoverable Resource Manager
Contrast with commit. Services attachment facility.
root page RS See read stability.
The index page that is at the highest level
savepoint
(or the beginning point) in an index.
A named entity that represents the state
routine of data and schemas at a particular point
| A database object that encapsulates in time within a unit of work.
| procedural logic and SQL statements, is
SBCS See single-byte character set.
| stored on the database server, and can be
| invoked from an SQL statement or by SCA See shared communications area.
| using the CALL statement. The main
scalar function
| classes of routines are procedures and
An SQL operation that produces a single
| functions.
value from another value and is
row The horizontal component of a table. A expressed as a function name, followed
row consists of a sequence of values, one by a list of arguments that are enclosed in
for each column of the table. parentheses.
row identifier (ROWID) scale In SQL, the number of digits to the right
A value that uniquely identifies a row. of the decimal point (called the precision
This value is stored with the row and in the C language). The DB2 information
never changes. uses the SQL definition.
row lock schema
A lock on a single row of data. The organization or structure of a
database.
row-positioned fetch orientation
| The specification of the desired placement

550 Command Reference

 A collection of, and a way of qualifying, statements such as COMMIT,
database objects such as tables, views, ROLLBACK, and some SET statements do
routines, indexes or triggers that define a not use a section.
database. A database schema provides a
| security label
logical classification of database objects.
| A classification of users’ access to objects
scrollability | or data rows in a multilevel security
The ability to use a cursor to fetch in | environment.″
either a forward or backward direction.
segment
The FETCH statement supports multiple
A group of pages that holds rows of a
fetch orientations to indicate the new
single table. See also segmented table
position of the cursor. See also fetch
space.
orientation.
segmented table space
scrollable cursor
A table space that is divided into
A cursor that can be moved in both a
equal-sized groups of pages called
forward and a backward direction.
segments. Segments are assigned to tables
search condition so that rows of different tables are never
A criterion for selecting rows from a table. stored in the same segment. Contrast with
A search condition consists of one or partitioned table space and universal table
more predicates. space.
secondary authorization ID self-referencing constraint
An authorization ID that has been A referential constraint that defines a
associated with a primary authorization relationship in which a table is a
ID by an authorization exit routine. dependent of itself.
secondary group buffer pool self-referencing table
For a duplexed group buffer pool, the A table with a self-referencing constraint.
structure that is used to back up changed
sensitive cursor
pages that are written to the primary
A cursor that is sensitive to changes that
group buffer pool. No page registration or
are made to the database after the result
cross-invalidation occurs using the
table has been materialized.
secondary group buffer pool. The z/OS
equivalent is new structure. sequence
A user-defined object that generates a
secondary index
sequence of numeric values according to
A nonpartitioning index that is useful for
user specifications.
enforcing a uniqueness constraint, for
clustering data, or for providing access sequential data set
paths to data for queries. A secondary A non-DB2 data set whose records are
index can be partitioned or organized on the basis of their successive
nonpartitioned. See also data-partitioned physical positions, such as on magnetic
secondary index (DPSI) and tape. Several of the DB2 database utilities
nonpartitioned secondary index (NPSI). require sequential data sets.
section sequential prefetch
The segment of a plan or package that A mechanism that triggers consecutive
contains the executable structures for a asynchronous I/O operations. Pages are
single SQL statement. For most SQL fetched before they are required, and
statements, one section in the plan exists several pages are read with a single I/O
for each SQL statement in the source operation.
program. However, for cursor-related
serialized profile
statements, the DECLARE, OPEN,
A Java object that contains SQL
FETCH, and CLOSE statements reference
statements and descriptions of host
the same section because they each refer
variables. The SQLJ translator produces a
to the SELECT statement that is named in
serialized profile for each connection
the DECLARE CURSOR statement. SQL
context.

DB2 glossary 551

 server The target of a request from a remote process by an attachment facility to
requester. In the DB2 environment, the enable DB2 to verify that it is authorized
server function is provided by the to use DB2 resources.
distributed data facility, which is used to
simple page set
access DB2 data from remote applications.
A nonpartitioned page set. A simple page
service class set initially consists of a single data set
An eight-character identifier that is used (page set piece). If and when that data set
by the z/OS Workload Manager to is extended to 2 GB, another data set is
associate user performance goals with a created, and so on, up to a total of 32
particular DDF thread or stored data sets. DB2 considers the data sets to
procedure. A service class is also used to be a single contiguous linear address
classify work on parallelism assistants. space containing a maximum of 64 GB.
Data is stored in the next available
service request block
location within this address space without
| A unit of work that is scheduled to
regard to any partitioning scheme.
| execute.
simple table space
session
A table space that is neither partitioned
A link between two nodes in a VTAM
nor segmented. Creation of simple table
network.
spaces is not supported in DB2 Version
session protocols 9.1 for z/OS. Contrast with partitioned
The available set of SNA communication table space, segmented table space, and
requests and responses. universal table space.
| set operator single-byte character set (SBCS)
| The SQL operators UNION, EXCEPT, and A set of characters in which each
| INTERSECT corresponding to the character is represented by a single byte.
| relational operators union, difference, and Contrast with double-byte character set or
| intersection. A set operator derives a multibyte character set.
| result table by combining two other result
single-precision floating point number
| tables.
A 32-bit approximate representation of a
shared communications area (SCA) real number.
A coupling facility list structure that a
SMP/E
DB2 data sharing group uses for
See System Modification
inter-DB2 communication.
Program/Extended.
share lock
SNA See Systems Network Architecture.
A lock that prevents concurrently
executing application processes from SNA network
changing data, but not from reading data. The part of a network that conforms to
Contrast with exclusive lock. the formats and protocols of Systems
Network Architecture (SNA).
shift-in character
A special control character (X’0F’) that is socket A callable TCP/IP programming interface
used in EBCDIC systems to denote that that TCP/IP network applications use to
the subsequent bytes represent SBCS communicate with remote TCP/IP
characters. See also shift-out character. partners.
shift-out character sourced function
A special control character (X’0E’) that is | A function that is implemented by
used in EBCDIC systems to denote that | another built-in or user-defined function
the subsequent bytes, up to the next | that is already known to the database
shift-in control character, represent DBCS | manager. This function can be a scalar
characters. See also shift-in character. | function or an aggregate function; it
| returns a single value from a set of values
sign-on
A request that is made on behalf of an
individual CICS or IMS application

552 Command Reference

| (for example, MAX or AVG). Contrast SQLDA
| with built-in function, external function, See SQL descriptor area.
| and SQL function.
SQL descriptor area (SQLDA)
source program A structure that describes input variables,
A set of host language statements and output variables, or the columns of a
SQL statements that is processed by an result table.
SQL precompiler.
SQL escape character
source table The symbol that is used to enclose an
A table that can be a base table, a view, a SQL delimited identifier. This symbol is
table expression, or a user-defined table the double quotation mark (″). See also
function. escape character.
source type SQL function
An existing type that DB2 uses to | A user-defined function in which the
represent a distinct type. | CREATE FUNCTION statement contains
| the source code. The source code is a
space A sequence of one or more blank
| single SQL expression that evaluates to a
characters.
| single value. The SQL user-defined
special register | function can return the result of an
| A storage area that DB2 defines for an | expression. See also built-in function,
| application process to use for storing | external function, and sourced function.
| information that can be referenced in SQL
SQL ID
| statements. Examples of special registers
See SQL authorization ID.
| are SESSION_USER and CURRENT
| DATE. SQLJ Structured Query Language (SQL) that is
embedded in the Java programming
specific function name
language.
A particular user-defined function that is
known to the database manager by its SQL path
specific name. Many specific user-defined An ordered list of schema names that are
functions can have the same function used in the resolution of unqualified
name. When a user-defined function is references to user-defined functions,
defined to the database, every function is distinct types, and stored procedures. In
assigned a specific name that is unique dynamic SQL, the SQL path is found in
within its schema. Either the user can the CURRENT PATH special register. In
provide this name, or a default name is static SQL, it is defined in the PATH bind
used. option.
SPUFI See SQL Processor Using File Input. SQL procedure
| A user-written program that can be
SQL See Structured Query Language.
| invoked with the SQL CALL statement.
SQL authorization ID (SQL ID) | An SQL procedure is written in the SQL
The authorization ID that is used for | procedural language. Two types of SQL
checking dynamic SQL statements in | procedures are supported: external SQL
some situations. | procedures and native SQL procedures.
| See also external procedure and native
SQLCA
| SQL procedure.
See SQL communication area.
SQL processing conversation
SQL communication area (SQLCA)
Any conversation that requires access of
A structure that is used to provide an
DB2 data, either through an application or
application program with information
by dynamic query requests.
about the execution of its SQL statements.
SQL Processor Using File Input (SPUFI)
SQL connection
A facility of the TSO attachment
An association between an application
subcomponent that enables the DB2I user
process and a local or remote application
server or database server.

DB2 glossary 553

 to execute SQL statements without information. Each statement handle is
embedding them in an application associated with the connection handle.
program.
statement string
SQL return code For a dynamic SQL statement, the
Either SQLCODE or SQLSTATE. character string form of the statement.
SQL routine statement trigger
A user-defined function or stored A trigger that is defined with the trigger
procedure that is based on code that is granularity FOR EACH STATEMENT.
written in SQL.
static cursor
| SQL schema A named control structure that does not
| A collection of database objects such as change the size of the result table or the
| tables, views, indexes, functions, distinct order of its rows after an application
| types, schemas, or triggers that defines a opens the cursor. Contrast with dynamic
| database. An SQL schema provides a cursor.
| logical classification of database objects.
static SQL
SQL statement coprocessor | SQL statements, embedded within a
An alternative to the DB2 precompiler | program, that are prepared during the
that lets the user process SQL statements | program preparation process (before the
at compile time. The user invokes an SQL | program is executed). After being
statement coprocessor by specifying a | prepared, the SQL statement does not
compiler option. | change (although values of variables that
| are specified by the statement might
SQL string delimiter
| change).
A symbol that is used to enclose an SQL
string constant. The SQL string delimiter storage group
is the apostrophe (’), except in COBOL | A set of storage objects on which DB2 for
applications, where the user assigns the | z/OS data can be stored. A storage object
symbol, which is either an apostrophe or | can have an SMS data class, a
a double quotation mark (″). | management class, a storage class, and a
| list of volume serial numbers.
SRB See service request block.
stored procedure
stand-alone
A user-written application program that
An attribute of a program that means that
can be invoked through the use of the
it is capable of executing separately from
SQL CALL statement. Stored procedures
DB2, without using DB2 services.
are sometimes called procedures.
star join
string See binary string, character string, or
A method of joining a dimension column
graphic string.
of a fact table to the key column of the
corresponding dimension table. See also strong typing
join, dimension, and star schema. A process that guarantees that only
user-defined functions and operations that
star schema
are defined on a distinct type can be
The combination of a fact table (which
applied to that type. For example, you
contains most of the data) and a number
cannot directly compare two currency
of dimension tables. See also star join,
types, such as Canadian dollars and U.S.
dimension, and dimension table.
dollars. But you can provide a
statement handle user-defined function to convert one
In DB2 ODBC, the data object that currency to the other and then do the
contains information about an SQL comparison.
statement that is managed by DB2 ODBC.
structure
This includes information such as
dynamic arguments, bindings for
dynamic arguments and columns, cursor
information, result values, and status

554 Command Reference

 v A name that refers collectively to two 16-bit code units, in which the first
different types of DB2 objects, such as value of the pair is a high-surrogate code
tables, databases, views, indexes, and unit in the range U+D800 through
table spaces. U+DBFF, and the second value is a
v A construct that uses z/OS to map and low-surrogate code unit in the range
manage storage on a coupling facility. U+DC00 through U+DFFF. Surrogate
See also cache structure, list structure, pairs provide an extension mechanism for
or lock structure. encoding 917 476 characters without
requiring the use of 32-bit characters.
Structured Query Language (SQL)
A standardized language for defining and SVC dump
manipulating data in a relational A dump that is issued when a z/OS or a
database. DB2 functional recovery routine detects
an error.
structure owner
In relation to group buffer pools, the DB2 sync point
member that is responsible for the See commit point.
following activities: syncpoint tree
v Coordinating rebuild, checkpoint, and The tree of recovery managers and
damage assessment processing resource managers that are involved in a
v Monitoring the group buffer pool logical unit of work, starting with the
threshold and notifying castout owners recovery manager, that make the final
when the threshold has been reached commit decision.

subcomponent synonym
A group of closely related DB2 modules | In SQL, an alternative name for a table or
that work together to provide a general | view. Synonyms can be used to refer only
function. | to objects at the subsystem in which the
| synonym is defined. A synonym cannot
subject table | be qualified and can therefore not be used
The table for which a trigger is created. | by other users. Contrast with alias.
When the defined triggering event occurs
on this table, the trigger is activated. Sysplex
See Parallel Sysplex.
subquery
A SELECT statement within the WHERE Sysplex query parallelism
or HAVING clause of another SQL Parallel execution of a single query that is
statement; a nested SQL statement. accomplished by using multiple tasks on
more than one DB2 subsystem. See also
subselect query CP parallelism.
| That form of a query that includes only a
| SELECT clause, FROM clause, and system administrator
| optionally a WHERE clause, GROUP BY The person at a computer installation
| clause, HAVING clause, ORDER BY who designs, controls, and manages the
| clause, or FETCH FIRST clause. use of the computer system.

substitution character system agent

A unique character that is substituted A work request that DB2 creates such as
during character conversion for any prefetch processing, deferred writes, and
characters in the source program that do service tasks. See also allied agent.
not have a match in the target coding | system authorization ID
representation. | The primary DB2 authorization ID that is
subsystem | used to establish a trusted connection. A
A distinct instance of a relational database | system authorization ID is derived from
management system (RDBMS). | the system user ID that is provided by an
| external entity, such as a middleware
surrogate pair | server.
A coded representation for a single
character that consists of a sequence of

DB2 glossary 555

 system conversation v The set contains a base table and
The conversation that two DB2 associated auxiliary tables.
subsystems must establish to process
A table space set can contain both types
system messages before any distributed
of relationships.
processing can begin.
task control block (TCB)
System Modification Program/Extended (SMP/E)
A z/OS control block that is used to
A z/OS tool for making software changes
communicate information about tasks
in programming systems (such as DB2)
within an address space that is connected
and for controlling those changes.
to a subsystem. See also address space
Systems Network Architecture (SNA) connection.
The description of the logical structure,
TB Terabyte. A value of 1 099 511 627 776
formats, protocols, and operational
bytes.
sequences for transmitting information
through and controlling the configuration TCB See task control block.
and operation of networks.
TCP/IP
table A named data object consisting of a A network communication protocol that
specific number of columns and some computer systems use to exchange
number of unordered rows. See also base information across telecommunication
table or temporary table. Contrast with links.
auxiliary table, clone table, materialized
TCP/IP port
query table, result table, and transition
A 2-byte value that identifies an end user
table.
or a TCP/IP network application within a
table-controlled partitioning TCP/IP host.
A type of partitioning in which partition
template
boundaries for a partitioned table are
A DB2 utilities output data set descriptor
controlled by values that are defined in
that is used for dynamic allocation. A
the CREATE TABLE statement.
template is defined by the TEMPLATE
table function utility control statement.
A function that receives a set of
temporary table
arguments and returns a table to the SQL
A table that holds temporary data.
statement that references the function. A
Temporary tables are useful for holding
table function can be referenced only in
or sorting intermediate results from
the FROM clause of a subselect.
queries that contain a large number of
table locator rows. The two types of temporary table,
| A mechanism that allows access to trigger which are created by different SQL
| tables in SQL or from within user-defined statements, are the created temporary
| functions. A table locator is a fullword table and the declared temporary table.
| integer value that represents a transition Contrast with result table. See also created
| table. temporary table and declared temporary
table.
table space
A page set that is used to store the thread See DB2 thread.
records in one or more tables. See also
threadsafe
partitioned table space, segmented table
A characteristic of code that allows
space, and universal table space.
multithreading both by providing private
table space set storage areas for each thread, and by
A set of table spaces and partitions that properly serializing shared (global)
should be recovered together for one of storage areas.
the following reasons:
three-part name
v Each of them contains a table that is a The full name of a table, view, or alias. It
parent or descendent of a table in one
of the others.

556 Command Reference

 consists of a location name, a schema new state. Contrast with auxiliary table,
name, and an object name, separated by a base table, clone table, and materialized
period. query table.
time A three-part value that designates a time transition variable
of day in hours, minutes, and seconds. A variable that contains a column value
of the affected row of the subject table in
timeout
its state before or after the triggering
Abnormal termination of either the DB2
event occurs. Triggered SQL statements in
subsystem or of an application because of
the trigger definition can reference the set
the unavailability of resources. Installation
of old values or the set of new values.
specifications are set to determine both
the amount of time DB2 is to wait for tree structure
IRLM services after starting, and the A data structure that represents entities in
amount of time IRLM is to wait if a nodes, with a most one parent node for
resource that an application requests is each node, and with only one root node.
unavailable. If either of these time
trigger
specifications is exceeded, a timeout is
| A database object that is associated with a
declared.
| single base table or view and that defines
Time-Sharing Option (TSO) | a rule. The rule consists of a set of SQL
An option in z/OS that provides | statements that run when an insert,
interactive time sharing from remote | update, or delete database operation
terminals. | occurs on the associated base table or
| view.
timestamp
A seven-part value that consists of a date trigger activation
and time. The timestamp is expressed in The process that occurs when the trigger
years, months, days, hours, minutes, event that is defined in a trigger
seconds, and microseconds. definition is executed. Trigger activation
consists of the evaluation of the triggered
trace A DB2 facility that provides the ability to
action condition and conditional
monitor and collect DB2 monitoring,
execution of the triggered SQL statements.
auditing, performance, accounting,
statistics, and serviceability (global) data. trigger activation time
An indication in the trigger definition of
| transaction
whether the trigger should be activated
| An atomic series of SQL statements that
before or after the triggered event.
| make up a logical unit of work. All of the
| data modifications made during a trigger body
| transaction are either committed together The set of SQL statements that is executed
| as a unit or rolled back as a unit. when a trigger is activated and its
triggered action condition evaluates to
transaction lock
true. A trigger body is also called
A lock that is used to control concurrent
triggered SQL statements.
execution of SQL statements.
trigger cascading
transaction program name
The process that occurs when the
In SNA LU 6.2 conversations, the name of
triggered action of a trigger causes the
the program at the remote logical unit
activation of another trigger.
that is to be the other half of the
conversation. triggered action
The SQL logic that is performed when a
transition table
trigger is activated. The triggered action
A temporary table that contains all the
consists of an optional triggered action
affected rows of the subject table in their
condition and a set of triggered SQL
state before or after the triggering event
statements that are executed only if the
occurs. Triggered SQL statements in the
condition evaluates to true.
trigger definition can reference the table
of changed rows in the old state or the

DB2 glossary 557

 triggered action condition | trusted context
An optional part of the triggered action. | A database security object that enables the
This Boolean condition appears as a | establishment of a trusted relationship
WHEN clause and specifies a condition | between a DB2 database management
that DB2 evaluates to determine if the | system and an external entity.
triggered SQL statements should be
| trusted context default role
executed.
| A role associated with a trusted context.
triggered SQL statements | The privileges granted to the trusted
The set of SQL statements that is executed | context default role can be acquired only
when a trigger is activated and its | when a trusted connection based on the
triggered action condition evaluates to | trusted context is established or reused.
true. Triggered SQL statements are also
| trusted context user
called the trigger body.
| A user ID to which switching the current
trigger granularity | user ID on a trusted connection is
In SQL, a characteristic of a trigger, which | permitted.
determines whether the trigger is
| trusted context user-specific role
activated:
| A role that is associated with a specific
v Only once for the triggering SQL | trusted context user. It overrides the
statement | trusted context default role if the current
v Once for each row that the SQL | user ID on the trusted connection matches
statement modifies | the ID of the specific trusted context user.
triggering event | trusted relationship
| The specified operation in a trigger | A privileged relationship between two
| definition that causes the activation of | entities such as a middleware server and
| that trigger. The triggering event is | a database server. This relationship allows
| comprised of a triggering operation | for a unique set of interactions between
| (insert, update, or delete) and a subject | the two entities that would be impossible
| table or view on which the operation is | otherwise.
| performed.
TSO See Time-Sharing Option.
triggering SQL operation
TSO attachment facility
| The SQL operation that causes a trigger to
A DB2 facility consisting of the DSN
| be activated when performed on the
command processor and DB2I.
| subject table or view.
Applications that are not written for the
trigger package CICS or IMS environments can run under
A package that is created when a the TSO attachment facility.
CREATE TRIGGER statement is executed.
typed parameter marker
The package is executed when the trigger
A parameter marker that is specified
is activated.
along with its target data type. It has the
| trust attribute general form:
| An attribute on which to establish trust. A CAST(? AS data-type)
| trusted relationship is established based
| on one or more trust attributes. type 2 indexes
Indexes that are created on a release of
| trusted connection DB2 after Version 7 or that are specified
| A database connection whose attributes as type 2 indexes in Version 4 or later.
| match the attributes of a unique trusted
| context defined at the DB2 database UCS-2 Universal Character Set, coded in 2 octets,
| server. which means that characters are
represented in 16-bits per character.
| trusted connection reuse
| The ability to switch the current user ID UDF See user-defined function.
| on a trusted connection to a different user UDT User-defined data type. In DB2 for z/OS,
| ID.

558 Command Reference

 the term distinct type is used instead of | universal table space
user-defined data type. See distinct type. | A table space that is both segmented and
| partitioned. Contrast with partitioned
uncommitted read (UR)
| table space, segmented table space,
The isolation level that allows an
| partition-by-growth table space, and
application to read uncommitted data. See
| range-partitioned table space.
also cursor stability, read stability, and
repeatable read. unlock
The act of releasing an object or system
underlying view
resource that was previously locked and
The view on which another view is
returning it to general availability within
directly or indirectly defined.
DB2.
undo A state of a unit of recovery that indicates
untyped parameter marker
that the changes that the unit of recovery
A parameter marker that is specified
made to recoverable DB2 resources must
without its target data type. It has the
be backed out.
form of a single question mark (?).
Unicode
updatability
A standard that parallels the ISO-10646
The ability of a cursor to perform
standard. Several implementations of the
positioned updates and deletes. The
Unicode standard exist, all of which have
updatability of a cursor can be influenced
the ability to represent a large percentage
by the SELECT statement and the cursor
of the characters that are contained in the
sensitivity option that is specified on the
many scripts that are used throughout the
DECLARE CURSOR statement.
world.
update hole
| union An SQL operation that involves the
The location on which a cursor is
| UNION set operator, which combines the
positioned when a row in a result table is
| results of two SELECT statements. Unions
fetched again and the new values no
| are often used to merge lists of values
longer satisfy the search condition. See
| that are obtained from two tables.
also delete hole.
unique constraint
update trigger
An SQL rule that no two values in a
A trigger that is defined with the
primary key, or in the key of a unique
triggering SQL operation update.
index, can be the same.
UR See uncommitted read.
unique index
An index that ensures that no identical user-defined data type (UDT)
key values are stored in a column or a set See distinct type.
of columns in a table.
user-defined function (UDF)
unit of recovery (UOR) A function that is defined to DB2 by
A recoverable sequence of operations using the CREATE FUNCTION statement
within a single resource manager, such as and that can be referenced thereafter in
an instance of DB2. Contrast with unit of SQL statements. A user-defined function
work. can be an external function, a sourced
function, or an SQL function. Contrast
unit of work (UOW)
with built-in function.
A recoverable sequence of operations
within an application process. At any user view
time, an application process is a single In logical data modeling, a model or
unit of work, but the life of an application representation of critical information that
process can involve many units of work the business requires.
as a result of commit or rollback
UTF-8 Unicode Transformation Format, 8-bit
operations. In a multisite update
encoding form, which is designed for ease
operation, a single unit of work can
of use with existing ASCII-based systems.
include several units of recovery. Contrast
The CCSID value for data in UTF-8
with unit of recovery.

DB2 glossary 559

 format is 1208. DB2 for z/OS supports | v A version of a record is a copy of the
UTF-8 in mixed data fields. | record at a point in time.
UTF-16 | view A logical table that consists of data that is
Unicode Transformation Format, 16-bit | generated by a query. A view can be
encoding form, which is designed to | based on one or more underlying base
provide code values for over a million | tables or views, and the data in a view is
characters and a superset of UCS-2. The | determined by a SELECT statement that is
CCSID value for data in UTF-16 format is | run on the underlying base tables or
1200. DB2 for z/OS supports UTF-16 in | views.
graphic data fields.
Virtual Storage Access Method (VSAM)
value The smallest unit of data that is | An access method for direct or sequential
manipulated in SQL. | processing of fixed- and varying-length
| records on disk devices.
variable
A data element that specifies a value that Virtual Telecommunications Access Method
can be changed. A COBOL elementary (VTAM)
data item is an example of a host An IBM licensed program that controls
variable. Contrast with constant. communication and the flow of data in an
SNA network (in z/OS).
variant function
See nondeterministic function. volatile table
A table for which SQL operations choose
varying-length string
index access whenever possible.
| A character, graphic, or binary string
| whose length varies within set limits. VSAM
| Contrast with fixed-length string. See Virtual Storage Access Method.
version VTAM
| A member of a set of similar programs, See Virtual Telecommunications Access
| DBRMs, packages, or LOBs. Method.
| v A version of a program is the source warm start
| code that is produced by precompiling The normal DB2 restart process, which
| the program. The program version is involves reading and processing log
| identified by the program name and a records so that data that is under the
| timestamp (consistency token). control of DB2 is consistent. Contrast with
| v A version of an SQL procedural cold start.
| language routine is produced by
WLM application environment
| issuing the CREATE or ALTER
A z/OS Workload Manager attribute that
| PROCEDURE statement for a native
is associated with one or more stored
| SQL procedure.
procedures. The WLM application
| v A version of a DBRM is the DBRM environment determines the address
| that is produced by precompiling a space in which a given DB2 stored
| program. The DBRM version is procedure runs.
| identified by the same program name
| and timestamp as a corresponding | WLM enclave
| program version. | A construct that can span multiple
| dispatchable units (service request blocks
| v A version of an application package is
| and tasks) in multiple address spaces,
| the result of binding a DBRM within a
| allowing them to be reported on and
| particular database system. The
| managed by WLM as part of a single
| application package version is
| work request.
| identified by the same program name
| and consistency token as the DBRM. write to operator (WTO)
| v A version of a LOB is a copy of a LOB An optional user-coded service that
| value at a point in time. The version allows a message to be written to the
| number for a LOB is stored in the system console operator informing the
| auxiliary index entry for the LOB.

560 Command Reference

 operator of errors and unusual system | kind tests, that describe a path within an
conditions that might need to be corrected | XML document in an XML column. The
(in z/OS). | pattern is a restrictive form of path
| expressions, and it selects nodes that
WTO See write to operator.
| match the specifications. XML patterns are
WTOR | specified to create indexes on XML
Write to operator (WTO) with reply. | columns in a database.
XCF See cross-system coupling facility. XML publishing function
| A function that returns an XML value
XES See cross-system extended services.
| from SQL values. An XML publishing
XML See Extensible Markup Language. | function is also known as an XML
| constructor.
XML attribute
A name-value pair within a tagged XML | XML schema
element that modifies certain features of | In XML, a mechanism for describing and
the element. | constraining the content of XML files by
| indicating which elements are allowed
| XML column
| and in which combinations. XML schemas
| A column of a table that stores XML
| are an alternative to document type
| values and is defined using the data type
| definitions (DTDs) and can be used to
| XML. The XML values that are stored in
| extend functionality in the areas of data
| XML columns are internal representations
| typing, inheritance, and presentation.
| of well-formed XML documents.
| XML schema repository (XSR)
| XML data type
| A repository that allows the DB2 database
| A data type for XML values.
| system to store XML schemas. When
XML element | registered with the XSR, these objects
A logical structure in an XML document | have a unique identifier and can be used
that is delimited by a start and an end | to validate XML instance documents.
tag. Anything between the start tag and
| XML serialization function
the end tag is the content of the element.
| A function that returns a serialized XML
| XML index | string from an XML value.
| An index on an XML column that
| XML table
| provides efficient access to nodes within
| An auxiliary table that is implicitly
| an XML document by providing index
| created when an XML column is added to
| keys that are based on XML patterns.
| a base table. This table stores the XML
| XML lock | data, and the column in the base table
| A column-level lock for XML data. The | points to it.
| operation of XML locks is similar to the
| XML table space
| operation of LOB locks.
A table space that is implicitly created
XML node when an XML column is added to a base
The smallest unit of valid, complete table. The table space stores the XML
structure in a document. For example, a table. If the base table is partitioned, one
node can represent an element, an partitioned table space exists for each
attribute, or a text string. XML column of data.
| XML node ID index X/Open
| An implicitly created index, on an XML An independent, worldwide open systems
| table that provides efficient access to XML organization that is supported by most of
| documents and navigation among the world’s largest information systems
| multiple XML data rows in the same suppliers, user organizations, and
| document. software companies. X/Open’s goal is to
increase the portability of applications by
| XML pattern
combining existing and emerging
| A slash-separated list of element names,
standards.
| an optional attribute name (at the end), or

DB2 glossary 561

 XRF See Extended Recovery Facility.
| XSR See XML schema repository.
| zIIP See IBM System z9 Integrated Processor.
z/OS An operating system for the System z
product line that supports 64-bit real and
virtual storage.
z/OS Distributed Computing Environment (z/OS
DCE) A set of technologies that are provided by
the Open Software Foundation to
implement distributed computing.

562 Command Reference

Index
Special characters administrative task scheduler
commands
, (comma) in DB2 commands 16 MODIFY admtproc, APPL=SHUTDOWN option 311
: (colon) in DB2 commands 16 MODIFY admtproc, APPL=TRACE option 313
’ (apostrophe) in DB2 commands 16 START admtproc 385
″ (quotation mark) in DB2 commands 16 STOP admtproc 439
( ) (parentheses) in DB2 commands 16 starting
* (asterisk) an administrative task scheduler 385
DISPLAY THREAD command 227 stopping
FREE PACKAGE command 307 an administrative task scheduler 439
in DB2 commands 16 Administrative task scheduler commands 12
REBIND PACKAGE command 114 ADVISORY option of DISPLAY DATABASE command 169
*.* (asterisk) AFTER option of DISPLAY DATABASE command 167
DISPLAY PROCEDURE command 216 ALL keyword of MODIFY irlmproc,DIAG command 318
START PROCEDURE command 416 ALLD option of MODIFY irlmproc,STATUS command of
STOP FUNCTION SPECIFIC command 460 z/OS 326
STOP PROCEDURE command 466 ALLI option of MODIFY irlmproc,STATUS command of
= (equal sign) in DB2 commands 16 z/OS 326
ALTER BUFFERPOOL command
description 51
A example 56
ABEND subcommand of DSN 257 Option descriptions 52
ACCESS DATABASE command ALTER GROUPBUFFERPOOL command
example 49 description 57
Option descriptions 48 example 60
ACCESS option Option descriptions 58
START DATABASE command 393 ALTER UTILITY command
START DB2 command 400 description 61
accessibility example 63
keyboard x ambiguous cursor 90
shortcut keys x APOST option
accounting DCLGEN subcommand 141
audit trace, class descriptions 430 DSNH command 286
trace APOSTSQL option of DSNH command 292
displaying 241 application plan
starting 423 binding 79
stopping 473 deleting 309
ACCTG option maximum size 5
DISPLAY TRACE command 244 rebinding, changing plans 341
MODIFY TRACE command 334 application program
START TRACE command 426 START command 387
STOP TRACE command 476 testing 257
ACQUIRE option application program, preparing for DSNH CLIST
BIND PLAN subcommand 85 processing 275
DSNH command 294 APPNAME option
REBIND PLAN subcommand 85 START TRACE command 246, 433, 478
ACTION option ARCHIVE LOG command
BIND PACKAGE subcommand 86 description 65
BIND PLAN subcommand 86 example 69
DCLGEN subcommand 139 option descriptions 66
DSNH command 294 ASMLIB option of DSNH command 281
RECOVER INDOUBT command 352 ASMLOAD option of DSNH command 281
STOP FUNCTION SPECIFIC command 460 asterisk (*.*)
STOP PROCEDURE command 466 DISPLAY PROCEDURE command 216
ACTIVE option START PROCEDURE command 416
DISPLAY BUFFERPOOL command 154 STOP FUNCTION SPECIFIC command 460
DISPLAY DATABASE command 167 STOP PROCEDURE command 466
ADD option asterisk (*)
DCLGEN subcommand 139 DISPLAY THREAD command 227
DSNH command 297 FREE PACKAGE command 307
in DB2 commands 16

© Copyright IBM Corp. 1983, 2009 563

asterisk (*) (continued) CANCEL THREAD command (continued)
REBIND PACKAGE command 114 example 133
ASUSER option option descriptions 129
DSN command 258 canceling threads, description 129
AT option of DCLGEN subcommand 139 CASTOUT option of STOP DB2 command 452
AT(COMMIT) option of STOP DATABASE command 446 CATENFM utility, effects of TERM command 485
AUDIT option CATMAINT utility, effects of TERM command 485
DISPLAY TRACE command 244 CCLINK option of DSNH command 281
MODIFY TRACE command 334 CCLLIB option of DSNH command 281
START TRACE command 427 CCLOAD option of DSNH command 281
STOP TRACE command 476 CCMSGS option of DSNH command 281
audit trace CCOLIB option of DSNH command 281
class descriptions 430 CCPLIB option of DSNH command 281
displaying 241 CCPMSGS option of DSNH command 281
starting 423 CCSID option of DSNH command 281
stopping 473 CCSLIB option of DSNH command 281
AUTHID option CD-ROM, books on 507
DISPLAY TRACE command 245 CHANGE command of IMS
START TRACE command 429 description 135
STOP TRACE command 477 example 136
authorization ID CHECK DATA utility, effects of TERM command 485
secondary privileges 3 CHECK INDEX utility, effects of TERM command 485
SQL, privileges exercised by 3 CHECK LOB utility, effects of TERM command 485
trusted context 3 CHKTIME option of SET LOG command 376
AUTOREC option of ALTER GROUPBUFFERPOOL CICS
command 58 commands
DSNC 261
DSNC DISCONNECT 263
B DSNC DISPLAY 265
DSNC MODIFY 269
BDBRMLIB option of DSNH command 295
DSNC STOP 271
BDMEM option of DSNH command 294
DSNC STRT 273
BIND PACKAGE subcommand of DSN
option of BIND and REBIND subcommands 101
description 71
option of DSNH command 295
example 76
translation step in DSNH processing 275
option descriptions 85
CICS commands 11
BIND PLAN subcommand of DSN
CICSCOB option of DSNH command 282
description 79
CICSLLIB option of DSNH command 282
example 82
CICSOPT option of DSNH command 282
option descriptions 85
CICSPLIB option of DSNH command 282
binding
CICSPRE option of DSNH command 282
DSNH processing 275
CICSVER option of DSNH command 282
initiating 71, 79
CICSXLAT option of DSNH command 282
options for 85
CLAIMERS option of DISPLAY DATABASE command 165
blank characters in DB2 command 16
CLASS option
BLIB option of DSNH command 294
DISPLAY TRACE command 245
BMEM option of DSNH command 294
IFCIDs activated by trace class 429
BnLIB option of DSNH command 294
MODIFY TRACE command 334
BSDS (bootstrap data set), recovery 349
START TRACE command 429
buffer pool
STOP TRACE command 478
active and inactive 51, 153
CLASST option of ALTER GROUPBUFFERPOOL
altering attributes 51
command 59
displaying current status 153
CLIB option of DSNH command 282
parallel sequential steal threshold (VPSEQT) 53
CLONE option
BUFSIZE option of START TRACE command 434
START DATABASE command 393
STOP DATABASE command 446
CnLIB option of DSNH command 282
C COB2CICS option of DSNH command 283
C option of DCLGEN subcommand 140 COB2LIB option of DSNH command 283
CACHESIZE option COB2LOAD option of DSNH command 283
BIND PLAN subcommand 87 COBICOMP option of DSNH command 282
DSNH command 295 COBILINK option of DSNH command 282
REBIND PLAN subcommand 87 COBIPLNK option of DSNH command 282
CANCEL OFFLOAD option of ARCHIVE LOG command 68 COBIPMSG option of DSNH command 283
CANCEL option of RECOVER POSTPONED command 356 COBLIB option of DSNH command 283
CANCEL THREAD command COBLOAD option of DSNH command 283
description 129 COBSOM option of DSNH command 283

564 Command Reference

code, return 259 CPPLINK option of DSNH command 284
collection, package CPPLLIB option of DSNH command 284
BIND PACKAGE subcommand 113 CPPPMSGS option of DSNH command 284
REBIND PACKAGE subcommand 113 CPPSLIB option of DSNH command 284
REBIND TRIGGER PACKAGE subcommand 346 CPPUTIL option of DSNH command 284
COLSUFFIX option of DCLGEN subcommand 141 CPU option of START TRACE command 434
column name, as a field name 141 CRC (command recognition character), description 15
comma option of DSNH command 285 CURRENTDATA option
command continuation character 19 BIND PACKAGE subcommand 90
command output 23 BIND PLAN subcommand 90
command prefix DSNH command 295, 297
description 15 REBIND PACKAGE subcommand 90
multiple subsystems 401 REBIND PLAN subcommand 90
part of a command 15 REBIND TRIGGER PACKAGE subcommand 90
command recognition character (CRC) 15 CURRENTSERVER option
commands, scope 21 DSNH command 295
comment cursor, ambiguous 90
DCLGEN subcommand output 142 CYLINDER option of DSNH command 292
DSN subcommands 257
COMMENT option
DISPLAY TRACE command 244
MODIFY TRACE command 335
D
data sharing
START TRACE command 427
delays, diagnosing 317
STOP TRACE command 477
displaying
commit point, terminating utility 483
archive log information 151
COMP option of TRACE CT command 490
information about groups 189
COMPILE option of DSNH command 283
status of members 189
COMPLETE XMLSCHEMA command
identifying members with utility jobs 252
example 38, 39
scope of commands 21
conditional restart
starting members 402
control record, effect on restart 401
database
CONNECT option of DSN command 283
displaying status 161
connection
reserved names 447
DB2
starting 389
GROUP option of DSN command 258
stopping 443
RETRY option of DSN command 258
DATE
displaying
option of DSNH command 284
connection information 225
DB2 books online 507
group buffer pool 203
DB2 commands
IRLM subsystem status 327
command names 15
status 147
commands
DSNC DISPLAY command 266
ACCESS DATABASE 47
terminating 441
ALTER BUFFERPOOL 51
CONNID option
ALTER GROUPBUFFERPOOL 57
START TRACE command 246, 433, 479
ALTER UTILITY 61
CONNLIST option of DISPLAY GROUPBUFFERPOOL
ARCHIVE LOG 65
command 197
CANCEL THREAD 129
CONTROL option of DSNH command 283
DISPLAY ARCHIVE 151
COPTION option of DSNH command 283
DISPLAY BUFFERPOOL 153
COPY option
DISPLAY DATABASE 161
BIND PACKAGE subcommand 88
DISPLAY DDF 181
DSNH command 297
DISPLAY GROUP 189
COPY utility, effects of TERM command 485
DISPLAY GROUPBUFFERPOOL 195
COPYVER option
DISPLAY LOCATION 209
BIND PACKAGE subcommand 88, 93
DISPLAY LOG 213
DSNH command 297
DISPLAY PROCEDURE 215
correlation ID
DISPLAY PROFILE 221
recovering threads 352
DISPLAY RLIMIT 223
CORRELATION option of START TRACE command 434
DISPLAY THREAD 225
CORRID option
DISPLAY TRACE 241
START TRACE command 246, 433, 479
DISPLAY UTILITY 251
COUNT option of SET ARCHIVE command 372
MODIFY TRACE 333
CP option of RUN subcommand 368
RECOVER BSDS 349
CPP option of DCLGEN subcommand 140
RECOVER INDOUBT 351, 354
CPPCLASS option of DSNH command 284
RECOVER POSTPONED 355
CPPCLLIB option of DSNH command 284
REFRESH DB2,EARLY 359
CPPCSLIB option of DSNH command 284
RESET INDOUBT 363

Index 565
DB2 commands (continued) DEGREE option (continued)
commands (continued) REBIND PACKAGE subcommand 93
SET SYSPARM 379 REBIND PLAN subcommand 93
START DATABASE 389 DELAY
START DB2 399 keyword of MODIFY irlmproc,DIAG command 317
START DDF 403 DELAY option of ALTER UTILITY command 63
START FUNCTION SPECIFIC 405 deleting, IMS units of recovery 135
START PROCEDURE 415 DELIMIT option of DSNH command 286
START PROFILE 419 DEPLOY option
START RLIMIT 421 BIND PACKAGE subcommand 93
START TRACE 423 deregistering IRLM 316
STOP DATABASE 443 DEST option
STOP DB2 451 DISPLAY TRACE command 244
STOP DDF 455 START TRACE command 427
STOP FUNCTION SPECIFIC 459 STOP TRACE command 477
STOP PROCEDURE 465 DESTINATION option of DSNC MODIFY command 269
STOP PROFILE 469 DETAIL option
STOP RLIMIT 471 DISPLAY BUFFERPOOL command 154
STOP TRACE 473 DISPLAY GROUP command 190
TERM UTILITY 483 DISPLAY LOCATION command 210
completion messages 10 DISPLAY THREAD command 230
description of 15 DISPLAY TRACE command 244
DISPLAY FUNCTION SPECIFIC 185 detail report of DISPLAY BUFFERPOOL command 157
entering from supported environments 10 DIAG keyword of MODIFY irlmproc,DIAG command 317
scope 21 DIAGNOSE utility, TERM command effects 485
separator 15 diagnostic dumps, IRLM 317
DB2 Information Center for z/OS solutions 507 disability x
DB2 precompiler 15 DISABLE option
DBM1 option of START DB2 command 401 BIND PACKAGE subcommand 100
DBPROTOCOL option BIND PLAN subcommand 100
BIND PACKAGE subcommand 91 DSNH command 295
BIND PLAN subcommand 91 REBIND PACKAGE subcommand 100
DSNH command 295 REBIND PLAN subcommand 100
REBIND PACKAGE subcommand 91 disabling a function permanently 461
REBIND PLAN subcommand 91 DISCONNECT option
DBRM (database request module) BIND PLAN subcommand 95
BIND PLAN subcommand 110 DSNH command 295
maximum number in plan 5 REBIND PLAN subcommand 95
DBRMLIB option of DSNH command 285 DISPLAY ARCHIVE command 151
DCLGEN subcommand of DSN 142 DISPLAY BUFFERPOOL command
declaring an indicator variable array 142 description 153
description 137 Option descriptions 154
example 144 Output 156
forming field names 141 DISPLAY command of IMS
option descriptions 138 description 147
DDF (distributed data facility), displaying 181 example 149
DEADLINE option of ALTER UTILITY command 62 Option descriptions 147
DEADLOK option of START irlmproc command 410 DISPLAY DATABASE command
DECARTH option of DSNH command 285 description 161
DECIMAL example 172
option of DSNH command 285 Option descriptions 164
DECOMPOSE XML DOCUMENT command DISPLAY DDF command
example 39, 41 description 181
DEFAULT option of SET ARCHIVE command 372 example 182
DEFER Option descriptions 181
option of BIND PLAN subcommand 92 Output 182
DEFER option DISPLAY FUNCTION SPECIFIC command
BIND PACKAGE subcommand 92 description 185
BIND PLAN subcommand 92 Examples 188
DSNH command 295 Output 187
REBIND PACKAGE subcommand 92 DISPLAY GROUP command
REBIND PLAN subcommand 92 description 189
degree of parallel processing 93 Examples 192
DEGREE option IRLM information 190
BIND PACKAGE subcommand 93 DISPLAY GROUPBUFFERPOOL command
BIND PLAN subcommand 93 description 195
DSNH command 295 option descriptions 196

566 Command Reference

DISPLAY GROUPBUFFERPOOL command (continued) DSN command of TSO (continued)
Output 198 description 257
summary report example 203 example 260
DISPLAY LOCATION command Option descriptions 258
description 209 parsing subcommands 19
example 211 return codes 259
option descriptions 210 subcommands
DISPLAY LOG command ABEND 257
description 213 BIND PACKAGE 71
example 214 BIND PLAN 79
DISPLAY NET command of VTAM 132 DCLGEN 137
DISPLAY PROCEDURE command END 303
description 215 FREE PACKAGE 305
example 218 FREE PLAN 309
Option descriptions 216 REBIND PACKAGE 337
Output 217 REBIND PLAN 341
DISPLAY PROFILE command REBIND TRIGGER PACKAGE 345
example 222 RUN 367
DISPLAY RLIMIT command 223 SPUFI 381
DISPLAY THREAD command DSN commands 9
description 225 DSN subcommands 9
example 234 DSNC command of CICS 261
Option descriptions 227 DSNC DISCONNECT command of CICS
Output 232 description 263
DISPLAY TRACE command Example 264
description 241 DSNC DISPLAY command of CICS
example 249 description 265
Option descriptions 243 example 268
output 249, 250 Option descriptions 265
DISPLAY UTILITY command Output 266
description 251 DSNC MODIFY command of CICS
example 254 description 269
option descriptions 251 example 270
Output 252 Option descriptions 269
displaying DSNC STOP command of CICS
information about description 271
archive logs 151 Example 272
communications database and resource limit Option descriptions 271
facility 169 DSNC STRT command of CICS
data sharing group 189 description 273
data-partitioned secondary indexes 170 example 273
DB2 functions 185 option descriptions 273
DB2 threads 225 DSNDB01 database, authority needed to start 390
DDF 181 DSNDB06 database, authority needed to start 390
logical partitions 170 DSNH command of TSO
logs 213 data set names 280
resource limit facility (governor) 223 description 275
restricted objects 169 example 300
stored procedures 215 option descriptions 277
threads with remote locations 209 DSNHDECP load module
trace activity 241 list of parameters 495
status of DSNZPARM
buffer pools 153 list of parameters 495
DB2 databases 161 option of START DB2 command 400
DB2 utilities 251 DUMP option
group buffer pools 195 CANCEL THREAD command 130
DIST option of START DB2 command 401 MODIFY irlmproc,ABEND command 315
DISTRIBUTED option of START TRACE command 434 dump, IRLM diagnostic 317
DLIBATCH option DWQT option of ALTER BUFFERPOOL command 53
BIND and REBIND subcommands 101 DYNAMICRULES option
DSNH command 295 BIND PACKAGE subcommand 96
DSN command BIND PLAN subcommand 96
ASUSER option 258 DSNH command 295
GROUP option 258 REBIND PACKAGE subcommand 96
TEST option 258 REBIND PLAN subcommand 96
DSN command of TSO
abbreviations 19

Index 567
E GBPCHKPT option of ALTER GROUPBUFFERPOOL
command 59
EARLY GBPOOLT option of ALTER GROUPBUFFERPOOL
option of REFRESH DB2 command 360 command 59
EARLY option of START DB2 command 360 GDETAIL option of DISPLAY GROUPBUFFERPOOL
ENABLE option command 197
BIND PACKAGE subcommand 100 GLOBAL option of START irlmproc command 412
BIND PLAN subcommand 100 GRAPHIC option of DSNH command 286
DSNH command 295 group buffer pool RECOVER-pending (GRECP)
REBIND PACKAGE subcommand 100 status,removing using START DATABASE command 394
REBIND PLAN subcommand 100 group detail report of DISPLAY GROUPBUFFERPOOL
ENCODING option command 198
BIND PACKAGE subcommand 103 GROUP option
BIND PLAN subcommand 103 DSN command 258
REBIND PACKAGE subcommand 103 group, scope of command 21
REBIND PLAN subcommand 103 GTF option
END subcommand of DSN DISPLAY TRACE command 245
description 303 START TRACE command 427
Example 303 STOP TRACE command 477
ENTRY option of DSNH command 286
escape character
APOST option of DCLGEN subcommand 141
QUOTE option of DCLGEN subcommand 141 H
establishing connections between IMS and a subsystem 387 HOST option of DSNH command 287
EXPLAIN option
BIND PACKAGE subcommand 104
BIND PLAN subcommand 104 I
DSNH command 295, 298 I/O processing, parallel, DEGREE option of bind
REBIND PACKAGE subcommand 104 subcommands 93
REBIND PLAN subcommand 104 IBMCOB option of DCLGEN subcommand 140
REBIND TRIGGER PACKAGE subcommand 104 ID option
extended MCS consoles, DB2 support of 10 RECOVER INDOUBT command 352
START RLIMIT command 422
IFCID (instrumentation facility component identifier),
F identifiers by trace class 429
FLAG option IFCID option
BIND PACKAGE subcommand 105 MODIFY TRACE command 334
BIND PLAN subcommand 105 START TRACE command 433
DSNH command 286, 295 IFI
FREE PACKAGE subcommand 307 issuing commands 25
FREE PLAN subcommand 310 IMMEDWRITE option
REBIND PACKAGE subcommand 105 BIND PACKAGE subcommand 106
REBIND PLAN subcommand 105 BIND PLAN subcommand 106
REBIND TRIGGER PACKAGE subcommand 105 REBIND PACKAGE subcommand 106
FORCE option REBIND PLAN subcommand 106
DSNC STOP command 271 IMS
RESET INDOUBT command 364 commands
START DATABASE command 393 CHANGE 135
STOP DB2 command 452 DISPLAY 147
STOP DDF command 456 SSR 383
FORTLIB option of DSNH command 286 START 387
FORTLOAD option of DSNH command 286 STOP 441
FREE PACKAGE subcommand of DSN TRACE 487
description 305 facilities, events tracing 487
example 307 IMS commands 11
Option descriptions 306 IMSBMP option
FREE PLAN subcommand of DSN BIND and REBIND subcommands 101
description 309 DSNH command 295
Example 310 IMSMPP option
Option descriptions 310 BIND and REBIND subcommands 102
functions, displaying information about 185 DSNH command 296
IMSPRE option of DSNH command 287
INACTIVE option
G DISPLAY THREAD command 228
INCLUDE statement of DCLGEN subcommand output 142
GBPCACHE option of ALTER GROUPBUFFERPOOL indicator variable, array declaration in DCLGEN 142
command 58

568 Command Reference

INDOUBT option
DISPLAY THREAD command 228
L
indoubt thread, recovering 351 LABEL option of DCLGEN subcommand 141
INDVAR option of DCLGEN subcommand 142 LANGUAGE option of DCLGEN subcommand 140
INPUT option of DSNH command 287 LEAVE option of DSNH command 293
INTERVAL option of DISPLAY BUFFERPOOL command 155 library 507
invalidated plans and packages 105 LIBRARY option
IPADDR option BIND PACKAGE subcommand 110
DISPLAY LOCATION command 210 BIND PLAN subcommand 110
RESET INDOUBT command 365 DCLGEN subcommand 139
IRLM (internal resource lock manager) RUN subcommand 368
commands LIGHT option, START DB2 command 400
MODIFY irlmproc,ABEND 315 light restart, with ARM 401
MODIFY irlmproc,DIAG 317 LIMIT option
MODIFY irlmproc,PURGE option 319 DISPLAY THREAD command 230
MODIFY irlmproc,SET option 321 LIMIT option of DISPLAY DATABASE command 167
MODIFY irlmproc,STATUS option 325 LINECOUNT option of DSNH command 287
START irlmproc 409 LINK option of DSNH command 287
STOP irlmproc 463 link-editing, processing 275
TRACE CT 489 LIST option of DISPLAY BUFFERPOOL command 155
CSA LLIB option of DSNH command 287
setting maximum amount of 321 LnLIB option of DSNH command 287
delays, diagnosing 317 LOAD option
deregistering 315 DSNH command 287
diagnostic dumps 317 SET SYSPARM command 379
DISPLAY GROUP command output 190 LOAD utility, effects of TERM command 485
locks, releasing 319 LOCAL option
modifying, diagnostic trace 489 CANCEL THREAD command 129
restarting LOCAL option of START irlmproc command 412
effect on CSA value 323 location name
starting BIND PACKAGE subcommand 102, 113
an IRLM component 409 DISPLAY LOCATION command 210
diagnostic trace 489 REBIND PACKAGE subcommand 102, 113
status REBIND TRIGGER PACKAGE subcommand 346
checking 321 LOCATION option
status, checking 325 DISPLAY THREAD command 229
stopping DISPLAY TRACE command 245
diagnostic trace 489 RESET INDOUBT command 364
normal 463 START TRACE command 432
terminating STOP TRACE command 478
abnormal 315 LOCKS option of DISPLAY DATABASE command 166
normal 463 LOCKTABL option of START irlmproc command 411
trace buffers, setting number of 321 LOG option of TRACE command 487
IRLM commands 12 logical page list (LPL) 394
IRLMGRP option of START irlmproc command 410 logical partitions, displaying 170
IRLMID option of START irlmproc command 410 LOGLOAD option of SET LOG command 376
IRLMNM option of START irlmproc command 411 LONGLOG option of ALTER UTILITY option 63
ISOLATION LOPTION option of DSNH command 287
option of BIND PLAN subcommand LPL (logical page list)
description 107 option of DISPLAY DATABASE command 166
ISOLATION option recovering pages
BIND PACKAGE subcommand 107 using START DATABASE command 394
DSNH command 296 LSTATS option of DISPLAY BUFFERPOOL command 155
REBIND PACKAGE subcommand 107 LTE option of MODIFY irlmproc,SET command of z/OS 322
REBIND PLAN subcommand 107 LTE option of START irlmproc command 411
REBIND TRIGGER PACKAGE subcommand 107 LUNAME option
DISPLAY LOCATION command 210
RESET INDOUBT command 364
LUWID option
K DISPLAY THREAD command 230
KEEPDYNAMIC option RECOVER INDOUBT command 353
BIND PACKAGE subcommand 109 RESET INDOUBT command 365
BIND PLAN subcommand 109
DSNH command 296
REBIND PACKAGE subcommand 109
REBIND PLAN subcommand 109
keywords 17

Index 569
M MODE option (continued)
STOP DDF command 456
MACRO option of DSNH command 288 Mode option of ACCESS DATABASE command 49
MAINT option of MODIFY irlmproc,STATUS command of MODIFY admtproc
z/OS 326 shutdown 311
MAINT option of START DB2 command 400 Trace 313
MAXCSA option of START irlmproc command 411 MODIFY admtproc command of z/OS
MAXRO option of ALTER UTILITY command 63 Examples 313
MAXUSRS option of START irlmproc command 411 MODIFY admtproc,,APPL=SHUTDOWN command of z/OS
MCS consoles, scope of commands 21 description 311
MDETAIL option of DISPLAY GROUPBUFFERPOOL MODIFY admtproc,,APPL=TRACE command of z/OS
command 197 description 313
member detail report of DISPLAY GROUPBUFFERPOOL MODIFY admtproc,APPL=SHUTDOWN command of z/OS
command 199 Examples 311
MEMBER option MODIFY irlmproc,ABEND command of z/OS
BIND PACKAGE subcommand 110 description 315
BIND PLAN subcommand 110 Example 316
DISPLAY UTILITY command 252 MODIFY irlmproc,DIAG command of z/OS
member, scope of command 21 description 317
MERGECOPY utility, effects of TERM command 485 Example 318
message MODIFY irlmproc,PURGE command of z/OS
DB2 commands 10 description 319
DCLGEN subcommand 140 Example 320
DISPLAY UTILITY command 252 MODIFY irlmproc,SET command of z/OS
DSN command of TSO 259 description 321
DSNH command 286 example 323
FLAG option of bind subcommands 105 option descriptions 319, 322
FREE PACKAGE subcommand 307 MODIFY irlmproc,STATUS command of z/OS
FREE PLAN subcommand 310 description 325
MODIFY irlmproc,STATUS command 327 example 327
RUN subcommand 369 Option descriptions 325
message by identifier MODIFY RECOVERY utility, effects of TERM command 485
DSN7106I 190 MODIFY STATISTICS utility, effects of TERM command 485
DSN9022I 10 MODIFY TRACE command
DSN9023I 10 description 333
DSNB411I 157 Example 335
DSNB412I 158 MONITOR option
DSNB413I 158 DISPLAY TRACE command 244
DSNB414I 158 MODIFY TRACE command 334
DSNB415I 158 START TRACE command 427
DSNB420I 158 STOP TRACE command 477
DSNB421I 158 monitor trace
DSNI021I 396 class descriptions 431
DSNJ315I 68 displaying 241
DSNJ316I 68 starting 423
DSNJ317I 68 stopping 473
DSNJ318I 68 MSTR option of START DB2 command 401
DSNL440I to DSNL449I 365
DSNL448I 364
DSNL450I 131
DSNT392I 171 N
DSNT500I 172 NAMES option of DCLGEN subcommand 140
DSNT501I 172 NEWFUN option of DSNH command 288
DSNT736I 447 NID (network ID) option of RECOVER INDOUBT
DSNT753I 221 command 353
DSNU100I 252 NO LIMIT option of SET ARCHIVE command 372
DSNU105I 252 NO option
DSNU106I 252 START DB2 command 400
DSNV413I 232 START irlmproc command 412
DSNW133I 427 NOBACKOUT option of CANCEL THREAD command 130
DSNX943I 218 NODEFER option
DSNX950I 218 BIND PACKAGE subcommand 92
messages BIND PLAN subcommand 92
DISPLAY TRACE command 249, 250, 251 DSNH command 296
MLT option of MODIFY irlmproc,SET command of z/OS 322 REBIND PACKAGE subcommand 92
MODE option REBIND PLAN subcommand 92
ARCHIVE LOG command 66 NODISCON option of START irlmproc command 412
STOP DB2 command 451

570 Command Reference

NODUMP option of MODIFY irlmproc,ABEND PART option (continued)
command 315 START DATABASE command 393
NOFOR option of DSNH command 288 STOP DATABASE command 446
NOINDOUBTS option partial-location name, DISPLAY LOCATION command 210
START DB2 command 399 PASS option of DSNH command 288
NONE keyword of MODIFY irlmproc,DIAG command 318 PATH option
NOWRAP option of TRACE CT command 490 BIND PACKAGE subcommand 115
BIND PLAN subcommand 115
DSNH command 296
O REBIND PACKAGE subcommand 115
REBIND PLAN subcommand 115
OASN option
PATHDEFAULT option
CHANGE command 135
REBIND PACKAGE subcommand 116
DISPLAY command 148
REBIND PLAN subcommand 116
online 507
PBIND option of DSNH command 297
online books 507
PC option of START irlmproc command 412
ONLY option of DISPLAY DATABASE command 166
PCICS option of DSNH command 297
OP option
PCLOAD option of DSNH command 288
START TRACE command 427
PDBPROTOCOL option of DSNH command 297
STOP TRACE command 477
PDBRMLIB option of DSNH command 297
operands, DB2 commands 15
PDEFER option of DSNH command 297
OPTHINT option
PDEGREE option of DSNH command 297
BIND PACKAGE subcommand 111
PDISABLE option of DSNH command 297
BIND PLAN subcommand 111
PDLIBATCH option of DSNH command 297
DSNH command 296
PDMEM option of DSNH command 297
REBIND PACKAGE subcommand 111
PDYNAMICRULES option of DSNH command 298
REBIND PLAN subcommand 111
PENABLE option of DSNH command 298
OPTIONS option
PERFM option
BIND PACKAGE subcommand 112
DISPLAY TRACE command 244
DSNH command 288
MODIFY TRACE command 334
OUTNAME option of DSNH command 288
START TRACE command 426
output size 23
STOP TRACE command 476
OVERVIEW option of DISPLAY DATABASE command 167
performance trace
OWNER option
displaying 241
BIND PACKAGE subcommand 112
stopping 473
BIND PLAN subcommand 112
performance, trace
DCLGEN subcommand 139
class descriptions 431
DSNH command 296
starting 423
REBIND PACKAGE subcommand 112
PFLAG option of DSNH command 298
REBIND PLAN subcommand 112
PGPROT option of START irlmproc command 412
PGSTEAL option of ALTER BUFFERPOOL command 54
phases of execution for DSNH processing 275
P PIMSBMP option of DSNH command 298
P irlmproc command. 463 PIMSMPP option of DSNH command 298
package PISOLATION option of DSNH command 298
binding, initiating 71 PKEEPDYNAMIC option of DSNH command 298
identifier PKGCOL option
BIND PACKAGE subcommand 113 START TRACE command 245, 429, 477
REBIND TRIGGER PACKAGE subcommand 346 PKGLOC option
rebinding 337 START TRACE command 245, 429, 477
rebinding trigger 345 PKGPROG option
replacing version of 87 START TRACE command 245, 429, 477
PACKAGE option of DSNH command 298 PKLIST option
PACTION option of DSNH command 297 BIND PLAN subcommand 116
parallel processing DSNH command 296
DEGREE option of bind subcommands 93 REBIND PLAN subcommand 116
VPPSEQT option of ALTER BUFFERPOOL command 53 PL/I application program, macro processing step for
parameter, passing to application program 368 DSNH 275
parameters 17 PLAN
PARM option of START DB2 command 400 option of DSNH command 288
PARMS option PLAN option
DSNH command 288 BIND PLAN subcommand 117
RUN subcommand 368 DISPLAY TRACE command 245
parsing rules, DB2 commands 15 DSNC DISPLAY command 265
PART option DSNH command 296
ACCESS DATABASE command 48 REBIND PLAN subcommand 117
DISPLAY DATABASE command 166 RUN subcommand 368

Index 571
PLAN option (continued)
START TRACE command 429
R
STOP TRACE command 477 RATIO option of ALTER GROUPBUFFERPOOL command 58
PLANMGMT option RCTERM option of DSNH command 290
REBIND PACKAGE subcommand 119 REBIND PACKAGE subcommand of DSN
REBIND TRIGGER PACKAGE subcommand 119 description 337
PLANMGMTSCOPE option example 340
FREE PACKAGE subcommand 307 option descriptions 85
PLI option of DCLGEN subcommand 140 REBIND PLAN subcommand of DSN
PLI2LIB option of DSNH command 289 description 341
PLIB option of DSNH command 289 Example 344
PLILIB option of DSNH command 289 option descriptions 85
PLILOAD option of DSNH command 289 REBIND TRIGGER PACKAGE subcommand of DSN
PLIPLNK option of DSNH command 289 description 345
PLIPMSG option of DSNH command 289 example 347
PLOCK keyword of MODIFY irlmproc,DIAG command 318 option descriptions 85
PnLIB option of DSNH command 289 rebinding
PNODEFER option of DSNH command 298 initiating 337, 341
POPTHINT option of DSNH command 298 options for 85
POPTION option of DSNH command 289 REBUILD INDEX utility, TERM command effects 485
POSTPONED option recognition character 15
DISPLAY THREAD command 228 RECOVER BSDS command
postponed units of recovery, recovering 355 description 349
POWNER option of DSNH command 298 Example 350
PPATH option of DSNH command 298 RECOVER INDOUBT command
PQUALIFIER option of DSNH command 298 description 351
PRECOMP option of DSNH command 289 example 354
precompiler Option descriptions 352
DSNH command options 288 RECOVER POSTPONED command
invoking DSNH 275 description 355
producing members for 110 Example 356
PRELEASE option of DSNH command 298 RECOVER utility, TERM command effects 485
PRELINK option of DSNH command 289 recovery
PREOPT option of DSNH command 298 BSDS 349
PRINT option of DSNH command 290 indoubt threads 351
privilege set of a process 3 postponed units of recovery 355
PROC option REFRESH DB2 command
DISPLAY THREAD command 229 example 360
processing, parallel REFRESH DB2, EARLY DB2 command
VPPSEQT option of ALTER BUFFERPOOL command 53 description 359
product-sensitive programming information, described 517 REFRESH DB2,EARLY command
PROGRAM option of RUN subcommand 367 Option descriptions 360
programming interface information, described 517 REGISTER XMLSCHEMA command
PSECSPAC option of DSNH command 290 example 41
PSPACE option of DSNH command 290 REJECT option of STOP FUNCTION SPECIFIC 460, 461
PSPI symbols 517 RELEASE option
PVALIDATE option of DSNH command 299 BIND PACKAGE subcommand 120
PVT option of MODIFY irlmproc,SET command of z/OS 322 BIND PLAN subcommand
description 120
DSNH command 296
REBIND PACKAGE subcommand 120
Q REBIND PLAN subcommand 120
QUALIFIER option REBIND TRIGGER PACKAGE subcommand 120
BIND PACKAGE subcommand 118 RELOAD option of SET SYSPARM command 379
BIND PLAN subcommand 118 REMOTE option of DSNH command 298
DSNH command 296 REMOVE XMLSCHEMA command
REBIND PACKAGE subcommand 118 example 42
REBIND PLAN subcommand 118 REOPT option
QUEUE option of STOP FUNCTION SPECIFIC 460, 461 BIND PACKAGE subcommand 121, 123
QUIESCE option BIND PLAN subcommand 121, 123
DSNC STOP command 271 DSNH command 296
STOP DB2 command 452 REBIND PACKAGE subcommand 121, 123
STOP DDF command 456 REBIND PLAN subcommand 121, 123
QUIESCE utility, effects of TERM command 485 REORG INDEX utility, effects of TERM command 485
QUOTE option REORG TABLESPACE utility, effects of TERM command 485
DCLGEN subcommand 141 REPAIR utility, effects of TERM command 485
DSNH command 286 REPLACE option
DCLGEN subcommand 140

572 Command Reference

REPLACE option (continued) schema.partial-name option
DSNH command 294, 297 DISPLAY FUNCTION SPECIFIC command 186
replacing, version of a package 87 START FUNCTION SPECIFIC command 406
REPLVER option STOP FUNCTION SPECIFIC command 460
BIND PACKAGE subcommand 86 schema.specific-function-name option
DSNH command 299 DISPLAY FUNCTION SPECIFIC command 186
effect of 87 START FUNCTION SPECIFIC command 406
REPORT utility, effects of TERM command 485 STOP FUNCTION SPECIFIC command 460
reports schema.specific-function-name option of DISPLAY FUNCTION
detail report 157 SPECIFIC command 186
group detail report 198 scope of commands 21
member detail report 199 SCOPE option
summary report ARCHIVE LOG command 67
DISPLAY BUFFERPOOL command 156 DISPLAY FUNCTION SPECIFIC command 186
DISPLAY GROUPBUFFERPOOL command 203 DISPLAY PROCEDURE command 216
RES option of STOP TRACE command 477 DISPLAY THREAD command 227
RESET GENERICLU command DISPLAY TRACE command 244
description 361 START FUNCTION SPECIFIC command 406
example 362 START irlmproc command 412
Option descriptions 362 START PROCEDURE command 416
RESET INDOUBT command STOP FUNCTION SPECIFIC command 460
description 363 STOP PROCEDURE command 467
Option descriptions 364 STOP TRACE command 477
RESET option of CHANGE command 136 secondary authorization ID 3
resource limit facility SET ARCHIVE command
displaying 169 description 371
restarting example 373
CICS attachment facility 271 Option descriptions 372
connections between IMS and a subsystem 387 SET LOG command
status of DB2 resources 359, 399 description 375
terminated utility job steps 484 example 377
RESTRICT option of DISPLAY DATABASE command 167 Option descriptions 376
RESUME option of SET LOG command 376 SET SYSPARM command
RETAIN option description 379
BIND PLAN subcommand 86 example 380
DSNH command 296 Option descriptions 379
retained locks 166 shortcut keys
RETRY option keyboard x
DSN command 258 SMF option
return code DISPLAY TRACE command 245
DSN command 259 START TRACE command 427
RUN subcommand of DSN 259 STOP TRACE command 477
RMARGIN option of DCLGEN subcommand 142 softcopy publications 507
RMID option SOMDLLI option of DSNH command 291
DISPLAY TRACE command 245 SOURCE option of DSNH command 291
START TRACE command 427, 477 SPACENAM option
RO option of START DATABASE command 393 ACCESS DATABASE command 48
ROLE option DISPLAY DATABASE command 164
START TRACE command 246, 433, 479 START DATABASE command 392
RRSURID option of DISPLAY THREAD command 230 STOP DATABASE command 445
RUN SPACEUN option of DSNH command 292
subcommand of DSN SPUFI, description 381
description 367 SQL option of DSNH command 292
example 369 SQLDELIM option of DSNH command 292
Option descriptions 367 SQLERROR option
return codes 259 BIND PACKAGE subcommand 124
RUN option DSNH command 299
DSNH command parameters 291 SQLRULES option
RUNIN option of DSNH command 291 BIND PLAN subcommand 125
running DSNH processing 275 REBIND PLAN subcommand 125
RUNOUT option of DSNH command 291 SQLRULES option of DSNH command 296
RUNSTATS utility, effects of TERM command 485 SRC (subsystem recognition character) 15
RW option of START DATABASE command 393 SRV option
DISPLAY TRACE command 245
START TRACE command 427
S STOP TRACE command 477
SSR command of IMS, description 383
scanning rules, DB2 commands 15

Index 573
START admtproc command of z/OS STOP DDF command
description 385 description 455
Examples 386 example 457
START command of IMS 387 STOP FUNCTION SPECIFIC command
START DATABASE command description 459
description 389 Examples 461
example 396 limitations of 461
Option descriptions 391 Option descriptions 460
recovering object in group buffer pool 394 STOP irlmproc command of z/OS 463
recovering pages on logical page list 394 STOP PROCEDURE command
START DB2 command description 465
description 399 example 467
example 402 Option descriptions 466
Option descriptions 400 STOP PROFILE command
START DDF command 403 example 469
START FUNCTION SPECIFIC command STOP RLIMIT command 471
description 405 STOP TRACE command
example 407 description 473
Option descriptions 406 example 482
START irlmproc command of z/OS Option descriptions 476
description 409 STOR option of MODIFY irlmproc,STATUS command of
Examples 413 z/OS 326
Option descriptions 410 stored procedure
START PROCEDURE command displaying status 215
description 415 starting 415
example 417 stopping 465
Option descriptions 416 STOSPACE utility, effects of TERM command 485
START PROFILE command string, delimiter
example 419 COBOL 141
START RLIMIT command SQL 141
description 421 STRUCTURE option of DCLGEN subcommand 140
Example 422 SUB option of TRACE CT command 490
START TRACE command SUBS option of TRACE command 487
description 423 SUBSYS option
example 437 CHANGE command 135
Option descriptions 426 DISPLAY command 147
STARTUP option of SET SYSPARM command 380 START command 387
STAT option STOP command 441
DISPLAY TRACE command 244 subsystem parameters
MODIFY TRACE command 334 list 495
START TRACE command 426 SUFFIX option of DSNH command 292
STOP TRACE command 476 summary report
STATISTICS option of DSNC DISPLAY command 266 DISPLAY BUFFERPOOL command 156
statistics trace DISPLAY GROUPBUFFERPOOL command 197, 203
stopping 473 SUSPEND option
statistics, trace SET LOG command 376
class descriptions 430 STOP DDF command 456
displaying 241 SWITCH option
starting 423 REBIND PACKAGE subcommand 125
status REBIND TRIGGER PACKAGE subcommand 125
checking, IRLM 325 syntax diagram
cross-system coupling facility (XCF), status of how to read xi
members 190 SYSTEM option
shown by DISPLAY DATABASE 171 DISPLAY THREAD command 229
shown by DISPLAY PROFILE 221 DSN command 258
STDSQL option of DSNH command 292 DSNH command 292
STOP admtproc command of z/OS
description 439
Examples 439
STOP command of IMS 441
T
TABLE option of DCLGEN subcommand 138
STOP DATABASE command
TDATA option of START TRACE command 434
description 443
TERM option of DSNH command 293
example 448
TERM UTILITY command
Option descriptions 445
description 483
STOP DB2 command
example 485
description 451
terminating
Example 452
connections between IMS and a subsystem 441

574 Command Reference

terminating (continued) UNLOAD utility, effects of TERM command 485
databases 443 USE option of DISPLAY DATABASE command 165
DB2, description 451 USERID option
IRLM START TRACE command 246, 247, 433, 478, 479
abnormal 315 UT option of START DATABASE command 393
normal 463 utilities
stored procedures 465 displaying status 251
trace activity 473 identifier 484
utilities, description 483 terminating 483
TEST option
DSN command 258
thread
ACTIVE option
V
VALIDATE option
DISPLAY THREAD command 225
BIND PACKAGE subcommand 126
canceling 129
BIND PLAN subcommand 126
displaying 225
DSNH command 296
message
REBIND PACKAGE subcommand 126
DISPLAY THREAD with ACTIVE 225
REBIND PLAN subcommand 126
TIME option
VDWQT option of ALTER BUFFERPOOL command 53
ARCHIVE LOG command 67
version of a package
DSNH command 293
BIND PACKAGE subcommand 113
SET ARCHIVE command 372
REBIND PACKAGE subcommand 113
TIMEOUT option of MODIFY irlmproc,SET command of
VERSION option of DSNH command 293
z/OS 322
VPPSEQT option of ALTER BUFFERPOOL command 53
TNO option
VPSEQT option of ALTER BUFFERPOOL command 52
DISPLAY TRACE command 245
VPSIZE option of ALTER BUFFERPOOL command 52
MODIFY TRACE command 334
VPXPSEQT option of ALTER BUFFERPOOL command 53
trace
VSAM (virtual storage access method) password, DCLGEN
changing active traces 333
subcommand 139
displaying 241
VTAM (Virtual Telecommunications Access Method), DISPLAY
events 487
NET command 132
IFCIDs activated by trace class 429
starting 423
stopping 473
TRACE command of IMS W
description 487 WAIT option of ARCHIVE LOG command 67
example 488 WEPR option of DISPLAY DATABASE command 166
TRACE CT command of z/OS WORKUNIT option of DSNH command 293
description 489 WRAP option of TRACE CT command 490
example 491 WRKSTN option
Option descriptions 489 START TRACE command 246, 433, 479
TRACE option WSECPAC option of DSNH command 293
MODIFY irlmproc,SET command of z/OS 322 WSPACE option of DSNH command 293
MODIFY irlmproc,STATUS command of z/OS 327 WTRSTART option of TRACE CT command 489
START irlmproc command 412 WTRSTOP option of TRACE CT command 490
START TRACE command 434
TRACK option of DSNH 292
TRANSACTION option
DSNC DISPLAY command 265
X
XAPPNAME option
DSNC MODIFY command 270
START TRACE command 247, 433, 479
trusted context
XAUTHID option
authorization IDs 4
START TRACE command 247, 433, 479
TSO CLIST commands 12
XCF (cross-system coupling facility), status of members 190
TSO CLISTs of DSNH 275
XLIB option of DSNH command 293
TSO option of DSNH command 291
XLOC option
TYPE option
START TRACE command 247, 433, 479
DISPLAY GROUPBUFFERPOOL command 196
XPKGCOL option
DISPLAY THREAD command 228
START TRACE command 246, 433, 479
XPKGLOC option
START TRACE command 246, 433, 479
U XPKGPROG option
unit of recovery, in IMS 148 START TRACE command 246, 433, 479
unit of work XPLAN option
displaying an outstanding 147 START TRACE command 246, 433, 479
resetting XREF option of DSNH command 293
IMS 135 XUSERID option
indoubt 135 START TRACE command 247, 433, 479

Index 575
XWRKSTN option
START TRACE command 247, 433, 479

Y
YES option
START DB2 command 400
START irlmproc command 413

Z
z/OS commands 311, 313
MODIFY irlmproc,ABEND 315
MODIFY irlmproc,DIAG 317
MODIFY irlmproc,PURGE 319
MODIFY irlmproc,SET 321
MODIFY irlmproc,STATUS 325
START admtproc 385
START irlmproc 409
STOP admtproc 439
STOP irlmproc 463
TRACE CT 489

576 Command Reference




Program Number: 5635-DB2

Printed in USA

SC18-9844-04
Spine information:

DB2 Version 9.1 for z/OS Command Reference