BOUTLOAD statements

The statement formats of the BOUTLOAD utility routine conform to the SDF rules (System Dialog Facility, see the manuals "SDF Dialog Interface" and "Commands").

The data types used in SDF formats are described in table 5 on "SDF syntax representation".

Overview of statements for BOUTLOAD

Statement	Meaning
COPY-RECORD  RECORD-NAME = *ALL / list-poss(20): <record-name> /                *ALL-EXCEPT(...)  ,REALM-NAME = *ALL / <realm-name>  ,SET-INFORMATION = YES / NO ,CSV-OUTPUT = *NO / *YES (...)	Copy all records of the specified record types to output files
END	Terminate BOUTLOAD
EXPORT-RECORD  RECORD-NAME = *ALL / list-poss(20): <record-name> /                *ALL-EXCEPT(...) ,SET-INFORMATION = YES / NO	Unload all records of the specified record types to output files
OPEN-DATABASE  DATABASE-NAME = <dbname>  ,COPY-NAME = *NONE / <copyname>  ,USER-IDENTIFICATION = *OWN / <userid>	Assign the database
REMOVE-RECORD  RECORD-NAME = *ALL / list-poss(20): <record-name> /                *ALL-EXCEPT(...)	Delete all records of the specified record types

Table 26: Statements for BOUTLOAD 

COPY-RECORD (Copying records to output files)

This statement is used to copy all records of the specified record types to output files. It is also possible to get the output in CSV format. The database key values are output in the same form in which they exist in the database, i.e. BOUTLOAD does not convert them from the short form to the long form, and vice versa. The database itself remains unchanged.

COPY-RECORD

RECORD-NAME = *ALL / list-poss(20): <record-name> / *ALL-EXCEPT(...)
	*ALL-EXCEPT(...)
		|	EXCEPT-NAME= list-poss(20):<recordname>
,REALM-NAME = *ALL / <realm-name>
,SET-INFORMATION = YES / NO
,CSV-OUTPUT = *NO/ *YES (...)
	*YES(...)
		|	OUTPUT = *STD / *FULL / *CSV-COMPATIBLE

RECORD-NAME = *ALL / list-poss(20): <record-name>/ *ALL-EXCEPT(...)

*ALL
With this specification only this one function is permitted in the BOUTLOAD run, i.e. the END statement must follow.
All records of all record types are copied.

<record-name>
All records of the specified record type(s) are copied.

*ALL-EXCEPT(...)
With this specification only this one function is permitted in the BOUTLOAD run, i.e. the END statement must follow.
All records with the exception of the specified record types are copied.

EXCEPT-NAME= list-poss(20): <recordname>
Names of the record types which are not to be copied.

REALM-NAME = *ALL / <realm-name>

*ALL
All records of the specified record type are copied from all realms in which they can occur.

<realm-name>
If a single realm has been specified, only the records of that realm are copied to output files.

With this specification only this one function is permitted in the BOUTLOAD run, i.e. the END statement must follow.

SET-INFORMATION = YES / NO
Determines whether set information is to be stored in the corresponding output file for every record and whether statements for BINILOAD are to be written to SYSLST.

Before copying the database is not checked as to whether it contains records which can be copied. If no such records exist, the associated output file is either invalidated, if it has been created by the user, or deleted, if it has been created by BOUTLOAD.

CSV-OUTPUT = *NO / *YES

*NO
BOUTLOAD outputs the data to output files, but not in CSV format.

*YES (...)
BOUTLOAD additionally outputs the data in CSV format.

OUTPUT = *STD / *FULL / *CSV-COMPATIBLE

*STD and *FULL produce a full CSV output. *CSV-COMPATIBLE produces an output that only consists of the header line (containing the field names, without the entry FIELD) and the data lines (without the entry RECORD).

 

END (Terminating the BOUTLOAD run)

This statement is used to terminate the BOUTLOAD run. It must be the last statement you enter.

END                                         

This statement has no operands. 

EXPORT-RECORD (Unloading records to output files)

This statement is used to unload all records of the specified record types from the database to output files. The database key values are output in the same form in which they exist in the database, i.e. BOUTLOAD does not convert them from the short form to the long form, and vice versa.

This statement may only be used if BOUTLOAD has been loaded under the identification under which the database is cataloged.

EXPORT-RECORD

RECORD-NAME = *ALL / list-poss(20): <record-name>/ *ALL-EXCEPT(...)
	*ALL-EXCEPT(...)
		|	EXCEPT-NAME= list-poss(20):<recordname>
,SET-INFORMATION = YES / NO

RECORD-NAME = *ALL / list-poss(20): <record-name>/ *ALL-EXCEPT(...)

*ALL
Implies that this is the only function permitted in the BOUTLOAD run; i.e. the END statement must follow.The database is reformatted; all realms have to be available.

<record-name>
All records of the specified record type are copied and deleted from the database.

*ALL-EXCEPT(...)
With this specification only this one function is permitted in the BOUTLOAD run, i.e. the END statement must follow.
All records with the exception of the specified record types are copied and deleted in the database.

EXCEPT-NAME= list-poss(20): <recordname>
Names of the record types which are not to be copied and are to be deleted in the database.

SET-INFORMATION = YES / NO

Determines whether set information is to be stored in the corresponding output file for every record and whether statements for BINILOAD are to be written to SYSLST.
When BOUTLOAD outputs set information for the individual records, the BOUTLOAD log, which contains the statements for a subsequent BINILOAD run, indicates the length of the database key values (length “4” for a 2-Kbyte database and length “8” for a 4-Kbyte or 8-Kbyte database).

Record types may be copied with SET-INFORMATION=NO even if the database is inconsistent.

Before copying the database is not checked as to whether it contains records which can be copied. If no such records exist, the associated output file is either invalidated, if it has been created by the user, or deleted, if it has been created by BOUTLOAD.

When entering the record types, the hierarchical structure of the database schema must be observed; i.e. the member record types must be unloaded either before or together with the owner record types.
If the entries are incorrect, the BOUTLOAD run is aborted.

If you store records in the database subsequently, the assignment of the DB keys begins again at RSQ=1. The DB keys can now also be used (once) if they are locked for reuse by the DBH by means of the BMODTT statement KEEP. An additional BMODTT run with the REMOVE statement is not required.

OPEN-DATABASE (Assigning the database)

This statement is used to assign the database.

You must enter it first if you have not assigned the database with:

/ADD-FILE-LINK LINK-NAME=DATABASE,FILE-NAME=dbname.DBDIR

If the SET-FILE-LINK command has been entered, an OPEN-DATABASE statement is rejected as invalid.

OPEN-DATABASE

DATABASE-NAME = <dbname>

,COPYNAME = *NONE / <copyname>

,USER-IDENTIFICATION = *OWN / <userid>

DATABASE-NAME = <dbname>
Name of the database. A user can edit only databases that are in his or her userid. A database from another userid can only be processed using the TSOS identification of the system administrator.

COPY-NAME = *NONE / <copyname>

*NONE
The original database is opened.

<copyname>
The shadow database is opened.

USER-IDENTIFICATION = *OWN / <userid>

*OWN
The database is in the user’s userid.

<userid>
The database is in another userid. This specification is permitted only from the TSOS identification.

The link name DATABASE remains in effect until it is canceled with the REMOVE-FILE-LINK command.

The OPEN-DATABASE statement remains in effect up to completion of the BOUTLOAD run. 

REMOVE-RECORD (Deleting records)

This statement is used to delete all records of the specified record types from the database.

This statement may only be used if BOUTLOAD has been loaded under the identification under which the database is cataloged.

REMOVE-RECORD

RECORD-NAME = *ALL / list-poss(20): <record-name> *ALL-EXCEPT(...)
	*ALL-EXCEPT(...)
		|	EXCEPT-NAME= list-poss(20):<recordname>

RECORD-NAME = *ALL / list-poss(20): <record-name>/ *ALL-EXCEPT(...)

*ALL
Implies that this is the only function permitted in the BOUTLOAD run; i.e. the END statement must follow.
The database is reformatted; all realms have to be available.
This statement is also allowed for an inconsistent database (with the system break bit set).

<record-name>
All records of the specified record type are deleted from the database.

*ALL-EXCEPT(...)
With this specification only this one function is permited in the BOUTLOAD run, i.e. the END must follow.
All records with the exception of the specified record types are copied and deleted in the database.

EXCEPT-NAME= list-poss(20): <recordname>
Names of the record types which are not to be deleted.

When entering the record types, the hierarchical structure of the database schema must be observed; i.e. the member record types must be deleted either before or together with the owner record types.
If the entries are incorrect, the BOUTLOAD run is aborted.
If you store records in the database subsequently, the assignment of the DB keys begins again at RSQ=1. The DB keys can now also be used (once) if they are locked for reuse by the DBH by means of the BMODTT statement KEEP. An additional BMODTT run with the REMOVE statement is not required.