Formatting a database component (BST05FOR)

Introduction

The program BST05FOR formats the unformatted space of a database component.

If the specified dataset does not yet exist (for example, spool file of type model or installation with new database), BST05FOR invokes IDCAMS internally to allocate the dataset first and then formats it.

Note: Because IDCAMS is invoked internally, the DD card SYSPRINT must be coded in the JCL of the batch job or in the JCL of the STC.

Formatting added space

When you enlarge a database component that already contains valid data, only the added space is formatted.

Note: The keyword EXTEND, which was previously coded when formatting added space, is now obsolete and will be ignored if present.

Specifying volume, space etc.

BST05FOR uses the values that are stored in the database definition file when it invokes IDCAMS to allocate a new database component. You can also code values using the appropriate BQLIN keywords, which will override the corresponding values of the database definition file.

When you allocate and format the database definition file, you must code the keyword DEFFILE and specify the space, volume etc. using the BQLIN keywords.

Syntax DD BQLIN

+------------------------------------------------------------+
|FORMAT FILE -|
| SNAME(shortname) | DSNAME dsname | DSN dsname -|
| [ CISIZE(n) | CSI(n) ] -|
| [ VOLUME(volume) ] -|
| [ SPACE(cyl[,cyl]) ] -|
| [ STORAGECLASS(name) ] -|
| [ MANAGEMENTCLASS(name) ] -|
| [ DATACLASS(name) ] -|
| [ DEFFILE ] -|
| [ NOSPEED ] |
+------------------------------------------------------------+

Keywords DD BQLIN

FORMAT FILE

Introduces the format command

Use either SNAME(shortname), DSNAME dsname, or DSN dsname to specify which database component to format.

SNAME(shortname)

Short name (logical name) of the database component

DSNAME dsname
DSN dsname

Dataset name of the database component

Note on SYSVAR support: If you code a dataset name instead of a short name, you must use exactly the same notation as in the database definition file. If the dataset name contains a static system symbol, you must specify the name of this symbol (&sysvar.).

CISIZE(n)
CSI(n)

Control interval size of the VSAM dataset

n must be a multiple of 4096, and it must be <= 28672 (28K).

Note: The recommended CIsize is 4096 (4K). Because 4K is the standard value, the documentation often uses "number of 4K blocks" when a value refers to the CIsize.

VOLUME(volume|SMS)

Volume to be used for the VSAM dataset. When SMS managed files are used, SMS must be entered rather than the volume name.

SPACE(n) | SPACE(n,n)

Size of the VSAM dataset in cylinders

For example, SPACE(10) means that the primary space is 10 cyl. SPACE(10,5) means that 10 cyl will be used as primary space, and 5 cyl will be used as secondary space if the database is extended (see "Dynamic database extension").

STORAGECLASS(name)

Name of the storage class (when using SMS managed files)

MANAGEMENTCLASS
(name)

Name of the management class (when using SMS managed files)

DATACLASS(name)

Name of the data class (when using SMS managed files)

DEFFILE

This keyword must be coded when formatting the database definition file.

EXTEND

This keyword is obsolete.

NOSPEED

When this keyword is present, the dataset will be preformatted by VSAM (which means that performance will be slower and formatting will take longer). As default, this parameter is inactive.