IBM Books

Command Reference

db2exfmt - Explain Table Format Tool

Formats the contents of the explain tables.

Authorization

Read access to the explain tables being formatted.

Required Connection

None

Command Syntax 



>>-db2exfmt---+-----------------+--+-----------------+--+-----+->
              +--d-+--------+---+  +--e-+--------+---+  +--h--+
                   +-dbname-+           +-schema-+
 
>--+---------------+--+------------------+--+-----------------+->
   +--n-+------+---+  +--o-+---------+---+  +--s-+--------+---+
        +-name-+           +-outfile-+           +-schema-+
 
>--+-----+--+--------------------+--+------------------+-------><
   +--t--+  +--w-+-----------+---+  +--#-+---------+---+
                 +-timestamp-+           +-sectnbr-+

Command Parameters

-d dbname
Name of the database containing packages.
-e schema
Explain table schema.
-h
Display help information. When this option is specified, all other options are ignored, and only the help information is displayed.
-n name
Name of the source of the explain request (SOURCE_NAME).
-o outfile
Output file name.
-s schema
Schema or qualifier of the source of the explain request (SOURCE_SCHEMA).
-t
Direct the output to the terminal.
-w timestamp
Explain time stamp.
-# sectnbr
Section number in the source. Use zero for all sections.

Usage Notes

Users are prompted for any parameter values that are not supplied, or that are incompletely specified, except in the case of the -h option.

If an Explain table schema is not provided, the value of the environment variable USER is used as the default. If this variable is not found, the user is prompted for an Explain table schema.

Source name, source schema, and Explain time stamp may be supplied in LIKE predicate form, which allows the percent sign (%) and the underscore (_) to be used as pattern matching characters to select multiple sources with one invocation. For the latest explained statement, the explain time can be specified as -1.

If -o is specified without a file name, and -t is not specified, the user is prompted for a file name (the default name is db2exfmt.out). If neither -o nor -t is specified, the user is prompted for a file name (the default option is terminal output). If -o and -t are both specified, the output is directed to the terminal.

For more information about db2exfmt, see the Administration Guide.

See Also

db2expln - DB2 SQL Explain Tool.

[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]

[ DB2 List of Books | Search the DB2 Books ]