Previous Topic: Successful Execution Requirements and ControlsNext Topic: Example JCL - Native Key Sequence


How to Use

You can execute this command in either Single User or with the MUF active. In Simplify mode, however, to provide current accurate information and to control (prevent) inappropriate executions, MUF is always intended to run enabled. If MUF is not enabled, it is a best practice to allow it to enable using the DELAY68= option of the DBSIDPR module. For details about the DBSIDPR module, see the CA Datacom/DB Database and System Administration Guide. If you know that the MUF is not enabled, and if you do not intend to enable it, and if you must force the execution of this BACKUP, declare the MUF is not to be used either by performing the BACKUP after another function that executes only with MUF down, or by following a function to establish that environment using SET OPTION1=MUF_NOT_ENABLED, which disables any DELAY68= and forces execution with MUF not enabled.

To create a backup of a data area, execute DBUTLTY using the following command. You can code multiple EXCLUDE= or INCLUDE= keywords.

Back Up All Areas in Database Native (z/OS)

►►─ BACKUP ─┬──────────────────┬─ DBID=n,DDNAME=bbbbbbb ──────────────────────►
            └─ BLKSIZE=nnnnn, ─┘

 ►─┬───────────────────────┬─┬────────────────────┬─┬────────────────┬────────►
   └─ ,CMPRS= ─┬─ YES ◄ ─┬─┘ │ ┌────────────────┐ │ └─ ,SEQBUFS=nnn ─┘
               └─ NO ────┘   ├─▼─ ,EXCLUDE=ccc ─┴─┤
                             │ ┌────────────────┐ │
                             └─▼─ ,INCLUDE=ccc ─┴─┘

 ►─ ,SEQ=NATIVE ──────────────────────────────────────────────────────────────►◄

Back Up Single Area in Database Native (z/OS)

►►─ BACKUP ─ AREA=aaa, ─┬──────────────────┬─ DBID=n,DDNAME=bbbbbbb ──────────►
                        └─ BLKSIZE=nnnnn, ─┘

 ►─┬───────────────────────┬─┬────────────────────┬─┬───────────────┬─────────►
   └─ ,CMPRS= ─┬─ YES ◄ ─┬─┘ │ ┌────────────────┐ │ └─ ,FIRSTKEY=n ─┘
               └─ NO ────┘   ├─▼─ ,EXCLUDE=ccc ─┴─┤
                             │ ┌────────────────┐ │
                             └─▼─ ,INCLUDE=ccc ─┴─┘

 ►─┬──────────────┬─┬───────────────────────┬─┬────────────────┬──────────────►
   └─ ,LASTKEY=n ─┘ └─ ,MULTUSE= ─┬─ NO ──┬─┘ └─ ,SEQBUFS=nnn ─┘
                                  └─ YES ─┘

 ►─ ,SEQ=NATIVE ──────────────────────────────────────────────────────────────►◄

Back Up Data Area Physical (z/OS)

►►─ BACKUP ─┬─────────────┬─┬──────────────────┬─ DBID=n,DDNAME=bbbbbbb ──────►
            └─ AREA=aaa, ─┘ └─ BLKSIZE=nnnnn, ─┘

 ►─┬───────────────────────┬─┬────────────────────┬───────────────────────────►
   └─ ,CMPRS= ─┬─ YES ◄ ─┬─┘ │ ┌────────────────┐ │
               └─ NO ────┘   ├─▼─ ,EXCLUDE=ccc ─┴─┤
                             │ ┌────────────────┐ │
                             └─▼─ ,INCLUDE=ccc ─┴─┘

 ►─┬────────────────────────────┬─┬──────────────────────┬────────────────────►
   └─ ,IOERROR= ─┬─ NOSKIP ◄ ─┬─┘ └─ ,RECID= ─┬─ NO ◄ ─┬─┘
                 └─ SKIP ─────┘               └─ YES ──┘

 ►─┬────────────────┬─ ,SEQ=PHYSICAL ─┬───────────────────────┬───────────────►◄
   └─ ,SEQBUFS=nnn ─┘                 └─ ,UPDATE= ─┬─ NO ◄ ─┬─┘
                                                   └─ YES ──┘

Command

BACKUP

Invokes the BACKUP function.

Required Keywords

DBID=

Identifies the database for the area to be read.

Valid Entries:

Valid DATACOM-ID of an existing database

Default Value:

(No default)

,DDNAME=

Specifies the JCL DDname for the output data set. This name must match the corresponding name in your JCL.

A DDNAME is not acceptable for sequential input or output files if it is a name reserved for a CA Datacom area. Names with the following patterns are therefore not acceptable for DDNAME=:

Optional Keywords

AREA=

Identifies the data area to be backed up. If you omit this keyword, each area in the database is opened, backed up, and closed, in turn.

Note: If you specify MULTUSE=, you must also specify an area name.

Valid Entries:

A 3-character name of an area

Default Value:

(No default)

BLKSIZE=

Indicates the block size for the output data set.

If you specify a block size with this parameter, the utility ignores any BLKSIZE parameter in the JCL. If you do not specify a block size with this parameter, the utility uses the BLKSIZE specified in the JCL if one exists. In the absence of either this parameter or a specification in the JCL, the utility uses a default as specified in the following.

Note: If the block size is not large enough to contain the largest record in the area (see formula below), DBUTLTY terminates abnormally.

Calculate the minimum block size for the output data set as follows:

A + C + 30

Where:
A is the length of the largest record in the area,
C is 0, if the data is not compressed, or
C = (A/128) + 1, if the data is compressed.

Valid Entries:

A 1- to 5-digit number

Default Value:

The default for BLKSIZE= when running z/OS is 0 (zero), which defaults to the z/OS default. That default is large and optimized for the particular device type, that is, the most optimal default for sites executing this operating system.

,CMPRS=

Specifies, for compressed tables, whether the output is to remain compressed or is to be expanded. This parameter has no effect on tables that are not defined with compression.

YES

Specifies that DBUTLTY write the data "as is" from the area to the sequential output file. That is, a compressed table remains compressed on the output data set.

NO

Specifies that DBUTLTY write the data in expanded form to the sequential output file. The NO option should be used only when the data being produced is intended to be used as input to a user-written program or if the table is to be redefined with a different combination of CA Datacom/DB compression and user compression options than the current definition.

Note: You must not specify CMPRS=NO and RECID=YES.

Valid Entries:

NO or YES

Default Value:

YES

,EXCLUDE=

Specifies the name of the table that is not to be backed up. To indicate more than one table, code the EXCLUDE= parameter more than once.

Tables that are excluded lose their data when DBUTLTY reloads from that backup. Use the EXTRACT function instead of the BACKUP function for single table recovery.

This parameter is mutually exclusive with the INCLUDE= parameter.

If neither EXCLUDE= nor INCLUDE= is specified, all the tables are backed up.

Valid Entries:

Specify a table name within the area (or database if omitting AREA=)

Default Value:

(No default)

,FIRSTKEY= and/or ,LASTKEY=

These keywords allow you to select a segment of a table or area by Native Key (SEQ=NATIVE) value to be processed for BACKUP. The BACKUP function normally defaults to include the full Native Key range from low values to high values. FIRSTKEY= overrides the default starting position while LASTKEY= overrides the default ending position, limiting the records retrieved for output to the BACKUP file. If one keyword is specified and the other is not specified, a default value is selected for the missing keyword. Normal CA Datacom key lengths are from 1 through 180 bytes. The key value data entered for FIRSTKEY= and LASTKEY= can be from 0 (zero) through 59 bytes long. You only need to code the number of positions of the key value that are significant to you, but be aware that the value coded is left justified regardless of key field data type. The utility pads the low order or remaining positions of the key value with low values on FIRSTKEY= and high values on LASTKEY=. To back up the entire area in one step, specify neither FIRSTKEY= nor LASTKEY=. Alternately, you could specify FIRSTKEY=00 and/or LASTKEY=00 which causes processing to start at low values and end at high values. The length of zero indicates that the padded key values (low values and high values) are to be used.

The data is not edited or interpreted. Therefore, if the key value data you need to enter is in binary, you must set up the JCL using a hexadecimal mode display and enter the key value data in hexadecimal. This data can contain blanks, commas, and any other special characters. CA Datacom/DB cannot edit this data for syntax, so the control statement can look invalid, especially when it includes blanks or commas or key value data containing English words. For example, FIRSTKEY=12121212121212 means the length is 12, key value is 121212121212. Another example, FIRSTKEY=10FIRSTKEY10 means the length is 10, key value is FIRSTKEY10.

Valid Entries:

A 2-byte length (in the range of 00 through 59) followed by a character string of key value bytes (for the length specified) that represents the key value.

Default Value:

The starting/ending position of the full Native Key range from low values to high values.

,INCLUDE=

Specifies the name of a table to be backed up. To indicate more than one table, code the INCLUDE= parameter more than once.

This parameter is mutually exclusive with the EXCLUDE= parameter.

If neither INCLUDE= nor EXCLUDE= is specified, the entire area is backed up.

Valid Entries:

Any table name within the area

Default Value:

(No default)

,IOERROR=

(Not valid if AREA= keyword is omitted.) Specifies how CA Datacom/DB is to handle I/O errors during a backup. Specify this option only for a physical sequence backup.

A value of SKIP causes CA Datacom/DB to issue a console message, produce a Master List dump, and skip the block in which an I/O error occurs when the utility encounters an I/O error while reading a data block.

The utility does not skip I/O errors to other data sets or the control block of the data area. When an I/O error does occur and the SKIP value is in force, the utility exits with a good completion code since this value overrides the error condition.

If an I/O error does not occur and the value SKIP is in force, DBUTLTY issues a warning message at the end of the execution. The utility abends with a user 4 abend code. This prevents accidental skipping of records.

In either case, the backup is a correct, complete backup. If a skip does occur during the backup, the Master List dump and warning message provide a basis for reconstructing the missing information.

Note: IOERROR=SKIP is not recommended and exists only to assist you in salvaging as much data as possible, if all backup tapes are defective. Frequent backups eliminate the risk associated with lost data and are preferable to the IOERROR option.

Valid Entries:

SKIP or NOSKIP

Default Value:

NOSKIP

,LASTKEY=

See the description of FIRSTKEY=/LASTKEY= given previously.

If DEVICE=TAPE (either TAPE or the Snnn form), LABEL= specifies whether tape labels are to be processed. We recommended that labeled tapes always be used.

Note: LABEL= has no effect when DEVICE=DISK.

Valid Entries:

NO or YES

Default Value:

YES

,MULTUSE=

(For area level DBUTLTY control only.) If you specify MULTUSE=, you must also specify an area name.

For more information about area level DBUTLTY control, see Area Level DBUTLTY Control.

Valid Entries:

NO or YES

Default Value:

NO

,RECID=

Specifies whether the record location information is to be backed up as part of each output record.

To create a physical sequence backup that can later be used with a forward recovery operation, specify RECID=YES.

Note the following:

Valid Entries:

NO or YES

Default Value:

NO

If DEVICE=TAPE (either TAPE or the Snnn form), YES indicates the tape is to be rewound before OPEN and after CLOSE. NO indicates no rewind before OPEN or after CLOSE. NO allows the stacking of backups on one tape.

Note: REWIND= has no effect when DEVICE=DISK.

Valid Entries:

NO or YES

Default Value:

YES

,SEQ=

Indicates the sequence in which the input data is to be processed and written to the backup data set. For details on retrieval sequence, see Backup Format.

NATIVE

Specifies that DBUTLTY read the Index and retrieve the data in Native Key sequence. When using SEQ=NATIVE, you can use the FIRSTKEY=/LASTKEY= optional keywords to select only a portion of the table or area. One of the uses of FIRSTKEY=/LASTKEY= involves doing parallel backups.

PHYSICAL

Specifies that DBUTLTY not read the Index. The output has no logical sequence but does follow the physical track sequence.

Note: Do not specify SEQ=PHYSICAL if you specify MULTUSE=.

Valid Entries:

NATIVE or PHYSICAL

Default Value:

NATIVE

,SEQBUFS=

With MULTUSE=YES specified, if necessary to ensure best performance DBUTLTY overrides the SEQBUFS= value either specified or defaulted. If SEQBUFS= is omitted (invoking the default value) or specified as a value 0-128 (even numbers only), the MUF treats this as though 128 was specified (or defaulted). This directs the MUF to allocate 128 private sequential buffers for use by this function. If SEQBUFS= is specified as a number 130-256 (even numbers only) the MUF treats this as though 256 was specified and uses the common data pools (64 blocks per I/O).

When MULTUSE= is omitted or specified as NO, SEQBUFS= is edited and ignored, and DBUTLTY executes with the best performance by using either the available data buffers (specified with the DATANO= parameter in the DBMSTLST macro) or available private sequential buffers.

Valid Entries:

0 to 256 (even numbers only)

Default Value:

128

,UPDATE=

Indicates whether the database can be open for update at the start or during the backup.

Note: Only valid if SEQ=PHYSICAL.

NO

Allows tables in the database to be updated and allows the INIT or LOAD functions on the data area during the backup.

YES

Specifies that CA Datacom/DB determines that the data area is loaded with a loaded Index and that the database is not open for update. During the backup, the database may not be opened for update.

Valid Entries:

NO or YES

Default Value:

NO