Previous Topic: SyntaxNext Topic: Usage


Parameters

SUBschema name is subschema-name

Identifies the subschema description to the dictionary. Subschema-name specifies the name of the subschema. Subschema-name must be a 1- to 8-character alphanumeric value.

of SCHema name is schema-name

Associates the subschema with a previously compiled schema. Schema-name is the name of a valid schema for which the named subschema represents a program view. This clause is required for ADD operations; it is required for all other operations if the subschema name is not unique in the dictionary.

version-specification

Specifies the version number of the schema. The version number defaults to the current session option for existing versions.

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

user-specification

Identifies the user using the subschema description.

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

subschema DEScription is description-text

Optionally specifies a name that is more descriptive than the 8-character subschema name required by CA IDMS/DB, but can be used to store any type of information; SUBSCHEMA DESCRIPTION is purely documentational. Description-text is a 1- to 40-character alphanumeric field; if it contains spaces or delimiters, it must be enclosed in quotes.

For CA OLQ users, the descriptive information appears on the CA OLQ screen to select subschemas.

PROgram REGistration REQuired/AUThorization is ON

Specifies that programs must be registered with the named subschema in order to be compiled against the subschema. AUTHORIZATION is a synonym for PROGRAM REGISTRATION REQUIRED.

To register a program with a subschema, use the IDD DDDL PROGRAM statement. A program naming the subschema is not eligible for compilation by the DML precompilers unless it is registered with the subschema.

PROgram REGistration REQuired/AUThorization is OFF

Specifies that programs do not have to be registered with the named subschema to be compiled against the subschema. AUTHORIZATION is a synonym for PROGRAM REGISTRATION REQUIRED. OFF is the default. Any program naming the subschema can be compiled by the DML precompilers.

USAge is DML

Specifies that programs using the subschema can access database records only. Attempts to access logical records will result in the return of an error-status code of 2010 to the requesting program.

USAge is LR

Specifies that programs using the subschema can access logical records only. Attempts to access database records will result in the return of an error-status code of nn10 to the requesting program.

USAge is MIXed

Specifies that programs using the subschema can access both database records and logical records. MIXED is the default.

statistics-transfer-specification

Transfers compile-time program statistics from the current subschema to another subschema. Statistics can be transferred for all programs associated with the current subschema or for a specific program. Statistics can be viewed in standard dictionary (DREPORTs) activity reports (see the CA IDMS Reports Guide), as follows:

TRAnsfer statistics to SUBschema name subschema-name

Identifies the subschema to receive the transferred statistics.

of SCHema name is schema-name

Identifies the schema with which the subschema receiving the transferred statistics is associated; this clause is required if subschema-name is not unique.

version-specification

Uniquely qualifies schema-name with a version number. The default is the current session option for existing versions.

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

FOR PROgram name is program-name

Identifies a program for which statistics have been collected under the current subschema. The statistics for and registration of the named program are transferred to the subschema named in the TRANSFER STATISTICS clause. If this clause is omitted, the statistics for all programs associated with the subschema will be transferred.

version-specification

Uniquely qualifies program-name with a version number. The default is the current session option for existing versions.

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

LR CURrency RESet

For subschemas containing logical-record definitions, specifies that the CA IDMS Logical Record Facility (LRF) is to reset currency and restore the logical record's program variable storage area before iterating a path. RESET is the default.

LRF sets the currency to that which existed at the termination of the previous execution of the path and restores the logical record's variable storage area with the records obtained during the previous execution of the path. LRF resets currency by issuing FINDs by DBKEY for all logical-record elements previously located up to, but not including, that element at which iteration is to commence. LRF restores storage by additionally issuing GETs for those elements retrieved as well as located during the previous execution of the path.

LR CURrency NO RESet

Specifies that LRF is not to reset currency or restore variable storage.

INClude USEr is user-id

Associates a user with the subschema description. User-id must be the name of a user as defined in the dictionary.

user-options-specification

Registers the user to access the subschema description, places security on the subschema description, and documents the user's association with the subschema. The options available with this clause are valid for INCLUDE only.

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

PUBlic ACCess is allowed for

Specifies which operations are available, for the current subschema and its components, for public access (that is, to all users who can sign on to the subschema compiler. When coded, the keyword ALLOWED can be abbreviated to no fewer than four characters (ALLO).

DELete

Allows unregistered users to DELETE, DISPLAY, and PUNCH the subschema and its components.

DISplay

Allows unregistered users to DISPLAY and PUNCH the subschema and its components.

MODify

Allows unregistered users to MODIFY, DISPLAY, and PUNCH the subschema and its components.

UPDate

Allows unregistered users to ADD, MODIFY, DELETE, DISPLAY, and PUNCH the subschema and its components. Unlike ALL, UPDATE does not allow unregistered users to change the subschema's PUBLIC ACCESS specification.

ALL

Allows unregistered users to ADD, MODIFY, DELETE, DISPLAY, and PUNCH the subschema and its components. Additionally, ALL allows all users to change the subschema's PUBLIC ACCESS specification, thus enabling them to change security for the subschema.

NONe

Prohibits unregistered users from accessing the subschema.

INClude class-name is attribute-name

Provides a way for the DBA to classify the subschema for documentational purposes by associating an attribute with the subschema.

Class-name must be the name of a class as defined in the dictionary through the IDD DDDL compiler. If the dictionary entry for the class specifies that attributes must be added manually, attribute-name must be the name of an attribute already associated with class-name; if not, attribute-name can be any 1- to 40-character value, enclosed in quotes if it contains spaces or delimiters.

Note: For instruction in defining classes and attributes, see the CA IDMS IDD DDDL Reference Guide.

EXClude class-name is attribute-name

Dissociates an attribute with the subschema. Class-name must be the name of a class for which an attribute already is associated with the subschema; attribute-name names the attribute in order to be dissociated from the subschema.

TEXT is user-text

On INCLUDE class-name operations, supplies additional documentation of the assignment of a specific attribute to the subschema. User-text is 1 to 40 characters of text; if it contains spaces or delimiters, it must be enclosed in quotes.

COMments/comment-key is comment-text/NULl

Provides a way for the DBA to maintain comments about the subschema. Comment-key is the value assigned in the USER DEFINED COMMENTS clause of the IDD DDDL MODIFY ENTITY statement. NULl disassociates text from the current subschema.

Note: Coding rules for comment-text are presented in 10.5.4, "Coding Comment Text".

ALL COMment TYPes

Displays and punches all comment entries (COMMENTS, DEFINITIONS, ELEMENT DEFINITIONS, CULPRIT HEADERS, OLQ HEADERS, REMARKS, and user-defined comment keys) associated with the requested subschema.

AREas

Displays and punches all areas included in the subschema.

ATTributes

Displays and punches all classes and attributes assigned to the subschema.

COMments

Displays and punches all COMMENTS clauses included both in the SUBSCHEMA statement and in all logical-record definitions in the subschema.

DEFinitions

Displays and punches all definitions associated with the subschema.

DETails

Displays and punches the following information about the subschema:

ELements

Displays and punches the following information:

HIStory

Displays and punches the date and time that the subschema was created or last modified.

LRS

Displays and punches all logical records included in the subschema.

PATh-groups

Displays and punches all logical-record path groups included in the subschema.

PROgrams

Displays and punches all programs associated with the subschema.

RECords

Displays and punches all database records included in the subschema.

SETs

Displays and punches all sets included in the subschema.

USEr DEFINED COMments/UCDS

For subschema with user-defined comment keys only, displays and punches all user-defined comment keys associated with the requested subschema.

USErs

Displays and punches all users associated with the subschema, including the REGISTRATION, RESPONSIBILITY, and PUBLIC ACCESS clauses.

ALL

Displays and punches the entire subschema description.

NONe

Displays and punches only the subschema name and associated schema name and version number.