Schema Statements › AREA Statement › Parameters

Parameters

AREa name is area-name

Identifies the area description. Area-name is a 1- to 16-character name that is the same as a physical area name. Apply the following considerations when selecting area names:

• Area-name must not be the same as the schema name or the name of any other component (including synonyms) within the schema.
• Because area-name will be copied into DML programs, it must not be the name of a keyword known to either the DML precompiler or the host programming language.

SAMe AS area base-area-name

Copies the entire area description from an area in another schema into the current schema. Base-area-name must identify an existing area.

of base-schema-name

Identifies the schema that contains base-area-name. The base schema must have a status of VALID (see the VALIDATE statement in this chapter).

version-specification

Qualifies the schema that contains base-area-name with a version number. The default version for existing schemas is the current session option.

Note: Expanded syntax for version-specification is presented in Chapter 13, “Parameter Expansions".

If the highest version of base-schema-name does not contain base-area-name, the schema compiler issues an error message; the compiler does not search for the highest schema version that contains base-area-name. Likewise, if the lowest version number assigned to base-schema-name does not contain base-area-name, the schema compiler issues an error message; the compiler does not search for the lowest schema version that contains base-area-name.

SAME AS AREA must not be specified for an area to which database procedures already are assigned. Consequently, placement of the SAME AS AREA clause is restricted as follows:

• ADD operation—When used in an ADD operation, SAME AS AREA must precede all other optional clauses.
• MODIFY operation—SAME AS AREA cannot be used in a MODIFY operation unless the area was added with no optional clauses.

As stated earlier, SAME AS AREA copies all information from the copied area to the new area description; the schema compiler treats all subsequent clauses as MODIFY operations.

CALl procedure-name

Requests that a system-provided or user-defined database procedure be called at specified times during runtime processing.

Procedure-name is the CSECT name or entry point of an existing procedure. If, at runtime, the procedure is link edited alone for dynamic loading, procedure-name must also be the load library member name.

BEFore

Calls a database procedure before a runtime READY, FINISH, COMMIT, or ROLLBACK function is performed against the area.

AFTer

Calls a database procedure after a runtime READY, FINISH, COMMIT, or ROLLBACK function is performed against the area.

on ERRor during

Calls a database procedure when an error occurs during a runtime READY, FINISH, COMMIT, or ROLLBACK function performed against the area. The DBMS detects an error when the error status is not 0000.

function-option

Specifies the database function that invokes the database procedure. If no function is specified, the procedure is called for every DML function performed against the area.

REAdy

Invokes the database procedure when the runtime system encounters a READY statement.

EXCLUSive

Invokes the database procedure for those runtime READY statements that include either the EXCLUSIVE UPDATE or EXCLUSIVE RETRIEVAL usage mode.

EXCLUSive UPDate

Invokes the database procedure for those runtime READY statements that include the EXCLUSIVE UPDATE usage mode.

EXCLUSive RETrieval

Invokes the database procedure for those runtime READY statements that include the EXCLUSIVE RETRIEVAL usage mode.

PROtected

Invokes the database procedure for those runtime READY statements that include either the PROTECTED UPDATE or PROTECTED RETRIEVAL usage mode.

PROtected UPDate

Invokes the database procedure for those runtime READY statements that include the PROTECTED UPDATE usage mode.

PROTected RETrieval

Invokes the database procedure for those runtime READY statements that include the PROTECTED RETRIEVAL usage mode.

SHAred

Invokes the database procedure for those runtime READY statements that include either the SHARED UPDATE or SHARED RETRIEVAL usage mode.

SHAred UPDate

Invokes the database procedure for those runtime READY statements that include the SHARED RETRIEVAL usage mode.

SHAred RETrieval

Invokes the database procedure for those runtime READY statements that include the SHARED RETRIEVAL usage mode.

UPDate

Invokes the database procedure for those runtime READY statements that include any UPDATE usage mode.

RETrieval

Invokes the database procedure for those runtime READY statements that include any RETRIEVAL usage mode.

FINish

Invokes the database procedure when the runtime system encounters a FINISH statement.

COMmit

Invokes the database procedure when the runtime system encounters a COMMIT statement.

ROLlback

Invokes the database procedure when the runtime system encounters a ROLLBACK statement.

EXClude ALL CALls

Negates any previously assigned CALL clauses for the area.

ESTimated pages is page-count

Specifies an estimated page count for the area. Page-number is an integer in the range 0 through 1073741822. The default is 0.

Code this option if your transaction performs SQL against a non-SQL database. The value you enter helps the SQL optimizer determine the best way to retrieve records; for example, using an area sweep, an index, and so on.

DETails

Displays or punches with the following information about the area:

• All database procedures assigned to the area
• The type and name of each symbol associated with the area

ALL

Displays or punches the entire area description.

NONe

Displays or punches only the area name.