Formatting user realms with BFORMAT

Formatting of the user realms is carried out by the BFORMAT utility routine. BFORMAT

• adds information on the user realms to the SIA,

• stores in every realm an act-key-0 page, an act-key-N page and at least one FPA page and formats the DBTT and CALC pages,

• stores the note ’BFORMAT EXECUTED’ in the DBDIR.

Figure 12: System environment for BFORMAT

BFORMAT must be called in the user ID under which the database is cataloged.

If the user realms have not yet been set up, they must be set up before the BFORMAT run (see section "Setting up the user realms").

When required, BFORMAT automatically extends the realms of the processed database (provided the realms are extendable). For details, please see the "Database Operation" manual, Automatic realm extension by means of utility routines.

At startup BFORMAT takes into account any assigned UDS/SQL pubset declaration (see the "Database Operation" manual, Pubset declaration job variable). Faulty assignment leads to the program aborting.

Statements for BFORMAT

The BFORMAT statement REALM identifies the realms which are to be formatted. Realms can be formatted in several BFORMAT runs, but each realm can only be formatted once.

Database creation cannot be continued until all realms have been formatted.

Statement	Default value	Meaning
REALM NAME IS {ALL [EXCEPT realm-name1,..] |  realm-name1,.. }	ALL	Optional; The specified realms are/are not to be formatted ALL all realms defined in the Schema DDL are to be formatted ALL EXCEPT realm-name exclusion list, i.e. all realms other than those specified are to be formatted realm-name specifies a user realm
END	-	Mandatory; Terminates statement input

Table 15: Statements for BFORMAT

It is advisable to format realms one at a time. If a BFORMAT run formatting more than one realm aborts without the normal termination procedures owing to an operating system failure, realms that have already been successfully formatted will also be affected. The BFORMAT run will then have to be repeated for them.

The BFORMAT run executes very quickly, since it only formats hash areas and FPA and DBTT pages.

Command sequence to start BFORMAT

It is assumed for the command sequence described here that UDS/SQL was installed with IMON (see section "START commands for the UDS/SQL programs").

01 /CREATE-FILE FILE-NAME=dbname.realm-name ...

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

03 /SELECT-PRODUCT-VERSION PRODUCT-NAME=UDS-SQL,VERSION=version,SCOPE=*TASK

04 /START-UDS-BFORMAT

05 [bformat-statement]

06 END

01	See section "Setting up the user realms".
03	The specified version of BFORMAT is selected. It is generally recommended that you specify the version since it is possible for several UDS/SQL versions to be installed in parallel.
04	The UDS/SQL utility routine can also be started with the alias BFORMAT.
05	If the REALM statement is omitted, all realms are formatted

Example

/CREATE-FILE FILE-NAME=TRAVEL.TRAVEL-RLM,SUPPORT=PUBLIC-DISK(SPACE=RELATIVE -
/    (PRIMARY-ALLOCATION=220,SECONDARY-ALLOCATION=60))
/ADD-FILE-LINK LINK-NAME=DATABASE,FILE-NAME=TRAVEL.DBDIR
/SELECT-PRODUCT-VERSION PRODUCT-NAME=UDS-SQL,    VERSION=02.9B00 
/START-UDS-BFORMAT
***** START        BFORMAT      (UDS/SQL  V2.9 1801 )    2019-01-29   09:26:56
* VERSION RECORDS EXPANDED  
REALM NAME IS ALL 
END   
* TRAVEL-RLM SUCCESSFULLY FORMATTED 
* QUERY-RLM INITIALISED IN DBDIR  
* BFORMAT-CONTROL-RECORD WRITTEN TO DBDIR 
***** ALL REALMS FORMATTED 
    
***** DIAGNOSTIC SUMMARY OF BFORMAT
    
              NO WARNINGS 
              NO ERRORS   
              NO SYSTEM-ERRORS 
  
***** END OF DIAGNOSTIC SUMMARY 
***** NR OF DATABASE ACCESSES  :          120  
***** NORMAL END   BFORMAT      (UDS/SQL  V2.9 1801 )     2019-01-29   09:26:59