Syntax and options of the QUIESCE control statement

The QUIESCE utility control statement, with its multiple options, defines the function that the utility job performs.

You can create a control statement with the ISPF/PDF edit function. After you create the statement, save it in a sequential or partitioned data set. When you create the JCL for running the job, use the SYSIN DD statement to specify the name of the data set that contains the utility control statement.

Syntax diagram

>>-QUIESCE------------------------------------------------------>

>--+-LIST--listdef-name-------------------------------------------------------+-->
   | .----------------------------------------------------------------------. |   
   | V                                                                      | |   
   '---+-TABLESPACE-+----------------+-table-space-name-+---------------+-+-+-'   
       |            '-database-name.-'                  '-PART--integer-' |       
       '-TABLESPACESET-+------------+-+----------------+-table-space-name-'       
                       '-TABLESPACE-' '-database-name.-'                          

              .-WRITE--YES-.   
>--+-------+--+------------+-----------------------------------><
   '-CLONE-'  '-WRITE--NO--'

Option descriptions

The purpose of most of the QUIESCE control statement options is to specify which objects to quiesce. You can specify as many objects in your QUIESCE job as allowed by available memory in the batch address space and in the DB2® DBM1 address space. If you specify a table space more than once, utility processing continues, and the table space is quiesced only once. QUIESCE issues return code 4 and warning message DSNU533I to alert you of the duplication.

Use the following options to specify which objects to quiesce:

LIST listdef-name

Specifies the name of a previously defined LISTDEF list name that contains only table spaces. The utility allows one LIST keyword for each QUIESCE control statement. Do not specify LIST with the TABLESPACE or TABLESPACESET keyword. QUIESCE is invoked once for the entire list. For the QUIESCE utility, the related index spaces are considered to be list items for the purposes of OPTIONS ITEMERROR processing. You can alter the utility behavior during processing of related indexes with the OPTIONS ITEMERROR statement. This utility processes clone data only if the CLONE keyword is specified. The use of CLONED YES on the LISTDEF statement is not sufficient.

Start of change The partitions or partition ranges can be specified in a list. End of change

TABLESPACE database-name.table-space-name

For QUIESCE TABLESPACE, specifies the table space that is to be quiesced.

For QUIESCE TABLESPACESET, specifies a table space in the table space set that is to be quiesced. For QUIESCE TABLESPACESET, the TABLESPACE keyword is optional.

database-name

Optionally specifies the name of the database to which the table space belongs.

The default value is DSNDB04.

table-space-name

Specifies the name of the table space that is to be quiesced. You can specify DSNDB01.SYSUTILX, but do not include that name in a list with other table spaces that are to be quiesced. If a point-in-time recovery is planned for the catalog and directory, DSNDB06.SYSCOPY must be quiesced separately after all other catalog and directory table spaces.

Start of change All table spaces that are involved in a versioning relationship are quiesced when QUIESCE is run on either the system-period temporal table or the history table space. Auxiliary LOB and XML table spaces on both system-period temporal table spaces and history table spaces are included. End of change

PART integer

Identifies a partition that is to be quiesced.

Start of change integer is the physical partition number. It must be in the range from 1 to the number of partitions that are defined for the table space. The maximum is 4096. End of change

If you specify the same table space twice in a list and use PART n in one specification and PART m in the other specification, each partition is quiesced once.

TABLESPACESET

Indicates that all of the referentially related table spaces in the table space set are to be quiesced. For the purposes of the QUIESCE utility, a table space set includes the following sets of objects:

A group of table spaces that are related through referential constraints
A base table space with all of its LOB table spaces
A base table space with all of its XML table spaces
A table space with a system-period temporal table and the table space with the related history table

Each table space set that you specify is expanded into a list of these related table spaces.

Related information:

Common quiesce points

CLONE

Indicates that QUIESCE is to create a quiesce point for only the specified clone table space. This utility processes clone data only if the CLONE keyword is specified. The use of CLONED YES on the LISTDEF statement is not sufficient.

Use the following option to control the behavior of QUIESCE:

WRITE

Specifies whether the changed pages from the table spaces and index spaces are to be written to disk.

YES: Establishes a quiesce point and writes the changed pages from the table spaces and index spaces to disk.
NO: Establishes a quiesce point but does not write the changed pages from the table spaces and index spaces to disk.
Table spaces with the NOT LOGGED attribute are not quiesced.