BLDINDEX Command (VSAM Build Index) shown by TSO HELP - z/OS 1.4
Function -
The BLDINDEX command is used to build one or more VSAM alternate
indexes over a VSAM base cluster. Both the base cluster and
alternate index must have been previously defined. The base
cluster must not be empty and the alternate index must either
be empty or have been defined with the reusable attribute.
The base cluster may either be a key-sequenced data set or an
entry-sequenced data set.
Syntax -
BLDINDEX INFILE('dname/password') ¦
INDATASET('entryname/password')
OUTFILE('dname/password' ...) ¦
OUTDATASET('entryname/password' ...)
EXTERNALSORT ¦ INTERNALSORT
WORKFILES('dname' 'dname')
CATALOG('catname/password')
SORTCALL ¦ NOSORTCALL
SORTMESSAGELEVEL('ALL¦CRITICAL¦NONE')
SORTMESSAGEDD('ddname')
SORTDEVICETYPE('device type')
SORTFILENUMBER('file number')
Required - INFILE or INDATASET
OUTFILE or OUTDATASET
Defaults - INTERNALSORT
SORTCALL
SORTMESSAGELEVEL(CRITICAL)
SORTMESSAGEDD(SYSOUT)
Abbreviations -
Note - In addition to normal TSO short forms, these are accepted:
BLDINDEX BIX
INFILE IFILE
INDATASET IDS
OUTFILE OFILE
OUTDATASET ODS
EXTERNALSORT ESORT
INTERNALSORT ISORT
WORKFILES WFILE,WFILES,WORKFILE
SORTMESSAGEDD SORTMDD,SMDD
SORTMESSAGELEVEL SORTML,SML
SORTDEVICETYPE SORTDVT,SDVT
SORTFILENUMBER SORTFN,SFN
Operands -
INFILE('dname/password')
- Identifies the base cluster via ddname
'dname' - Names the DD statement that identifies the base
cluster or a path that points to the base cluster.
'password'
- Read (or higher level) password of the object identified
via 'dname'; i.e., the base cluster or path over the
base cluster.
Required - 'dname'
INDATASET('entryname/password')
- Identifies the base cluster via dsname
'entryname'
- Names the base cluster or a path that points to
the base cluster. When you specify INDATASET, the base
cluster's volume is dynamically allocated.
'password'
- Read (or higher level) password of the object identified
via 'entryname'; i.e., the base cluster or path over the
base cluster.
Required - 'entryname'
OUTFILE('dname/password' ...)
- Identifies the alternate index via DDNAME
'dname' - Names the DD statement that identifies the alternate
index or a path that points to the alternate index.
'password'
- Update (or higher level) password of the object
identified via 'dname'; i.e., the alternate index
or a path over the alternate index.
Required - 'dname'
OUTDATASET('entryname/password' ...)
- Identifies the alternate index via dsname
'entryname'
- Names the alternate index or a path that points to
the alternate index. When you specify OUTDATASET,
the alternate index's volume is dynamically allocated.
'password'
- Update (or higher level) password of the object
identified via 'entryname'; i.e., the alternate
index or a path over the alternate index.
Required - 'entryname'
INTERNALSORT
- Specifies that the key-pointer pairs created by
BLDINDEX are to be sorted entirely within user-
provided virtual storage if enough is available.
If the required amount of virtual storage is not
available, BLDINDEX will attempt to perform an
external sort.
EXTERNALSORT
- Specifies that the key=pointer pairs created by
BLDINDEX are to be sorted using two external
sort workfiles that are dynamically defined as
two VSAM entry-sequenced data sets. If an
external sort is to be performed, two DD statements
that describe the external sort workfiles must
be provided.
WORKFILES('dname' 'dname')
- Names the DD statements that identify the workfiles
to be used by BLDINDEX if an external sort of the
key-pointer pairs is required. If the DD statements
are identified with the standard dnames of IDCUT1
and IDCUT2, The workfiles parameter is not required.
required parameters on the DD statements are: data set
name, volume containing VSAM data space, unit, DISP=OLD,
and AMP='AMORG'.
CATALOG('catname/password')
- Specifies the name of the catalog in which the two sort
workfiles are to be defined as VSAM entry-sequenced
data sets in the event an external sort is performed
by BLDINDEX.
'catname'
- Name of the catalog in which the two sort workfiles
are to be defined.
'password'
- Master level password of the catalog.
Required - Required if an external sort is to be performed and the
define of the sort workfiles is to be directed to a
specific catalog and/or the catalog to be used
is password protected.
SORTCALL
- Specifies that DFSORT (or an equivalent product)
will be used to sort the alternate index.
NOSORTCALL
- Specifies that DFSORT (or an equivalent product)
will not be used to sort the alternate index.
SORTMESSAGELEVEL('ALL¦CRITICAL¦NONE')
- Identifies the level of DFSORT (or equivalent
product) messages to return.
This parameter is not allowed if NOSORTCALL is specified.
'ALL'
- Specifies that all DFSORT (or equivalent product)
messages and control statements will be returned.
'CRITICAL'
- Specifies that only critical level DFSORT
(or equivalent product) messages will be returned.
'NONE'
- Specifies that no DFSORT (or equivalent product)
messages will be returned.
SORTMESSAGEDD('ddname')
- Identifies the DFSORT (or equivalent product)
message data set. This parameter is not allowed
if NOSORTCALL is specified.
'ddname'
- Specifies the ddname that describes the DFSORT
(or equivalent product) message data set.
Required - 'ddname'
SORTDEVICETYPE('device type')
- Identifies the DASD device type to be used by DFSORT
(or an equivalent product). This parameter is not
allowed if NOSORTCALL is specified.
'device type'
- Specifies the DASD device type to be used by
DFSORT (or an equivalent product) for their
sort work files.
Required - 'device type'
SORTFILENUMBER('file number')
- Identifies the number of files to be used by DFSORT
(or an equivalent product). This parameter
is not allowed if NOSORTCALL is specified.
'file number'
- Specifies the number of files to be used by
DFSORT for their sort work files.
Required - 'file number'