db2cat - System catalog analysis command
Analyzes the contents of packed descriptors.
Given a database name and other qualifying information, this command
will query the system catalogs for information and format the results.
It must be issued on the server.
Authorization
None
Required Connection
None
Command syntax
Command parameters
- -d dbname
- dbname is the name of the database for which the command will query the system catalogs.
- -h
- Displays usage information.
- -l
- Turns on case sensitivity for the object name.
- -n name
- Specifies the name of the object.
- -o outfile
- Specifies the name of the output file.
- -p descriptor
- Specifies the name of the packed descriptor (pd) to display where descriptor is
one of the following values:
- check
- Display table check constraints packed descriptor.
- controls
- Displays packed descriptors for all enabled permissions and masks for a given table.
- rel
- Display referential integrity constraint packed descriptor.
- table
- Display table packed descriptor. This includes the inline length if at least one exists for the table.
- summary
- Display summary table packed descriptor.
- syscontrols
- Displays the packed descriptor for a given mask or permission.
- trig
- Display table trigger packed descriptor.
- view
- Display view packed descriptor.
- variable
- Display global variable packed descriptor.
- remote
- Display remote non-relational data sources packed descriptor.
- ast
- Display materialized query table packed descriptor.
- routine
- Display routine packed descriptor.
- sysplan
- Display package packed descriptor.
- datatype
- Display structured type packed descriptor.
- sequence
- Display sequence packed descriptor.
- esri
- Display key transformation thread and index extension packed descriptor.
- event
- Display event monitor packed descriptor.
- server
- Display server packed descriptor.
- auth
- Display privileges held by this grantee on this object.
- workload
- Helps dump workload. See usage notes below.
- threshold
- Helps dump threshold packed descriptors. See usage notes below.
- -vi versionID
- Specifies the version ID of the package packed descriptor. -vi is only valid when -p sysplan is specified. If versionID is omitted, the default is the empty string.
- -s schema
- Specifies the name of the object schema. See usage notes below.
- -t
- Displays terminal output.
- -tn tenant
- Specifies the name of the tenant you want to use for this invocation. If not specified, the default SYSTEM tenant is assumed.
- -v
- Validates packed descriptor. This parameter is only valid for table packed descriptors.
- -x
- Validates table space extent size in catalogs (does not require a table name).
- -cb
- Cleans orphan rows from
SYSCAT.BUFFERPOOLDBPARTITIONS(does not require a table name).
Examples
- Example 1
-
The following command prints the packed descriptor information for the table splt_tb1 with schema raguk from database testdb to terminal:
db2cat -d testdb -s raguk -t -n splt_tb1
- Example 2
-
The following commands use the percent sign (%) in conjunction with -n to dump all packed descriptors:
db2cat -d testdb -p workload -n %db2cat -d testdb -p threshold -n %
- Example 3
-
The following commands use workload or threshold with -n to dump the packed descriptor for a specific workload or threshold:
db2cat -d testdb -p workload -n MYWORKLOADdb2cat -d testdb -p threshold -n MYTHRESHOLD
Usage notes
- The options -d and -n are mandatory when executing the db2cat command.
- Table name and table schema may be supplied in
LIKEpredicate form, which allows percent sign (%) and underscore (_) to be used as pattern matching characters to select multiple sources with one invocation. - Prompting will occur for all fields that are not supplied or are incompletely specified (except for the -h and -l options).
- If -o is specified without a file name, and -t is not specified, you will be prompted for a file name (the default name is db2cat.out).
- If neither -o nor -t is specified, you will be prompted for a file name (the default is terminal output).
- If -o and -t are both specified, the output will be directed to the terminal.
- Providing a workload name or threshold name with -n will dump the packed descriptor for the output.
- The percent sign (%) should be used in conjunction with -n to dump all the packed descriptors.