Data Definition Language (DDL) Reference Manual (G06.24+)

Dictionary Database Structure
Data Definition Language (DDL) Reference Manual—426798-002
D-10
DICTKDF Fields
•
KEYTAG-STRING−a 2-character string used when the Enscribe key specifier is
declared as two ASCII characters.
KEYTAG-STRING redefines KEYTAG-VALUE as a 2-byte string.
•
KEYTAG-OBJECT−if the keytag value is defined by a constant, contains the object
number of the constant.
•
FIELD−a group containing the OFFSET and ELEMENT-SIZE values from the OBL
record that describes this key field.
°
OFFSET−the offset of this key field within the record that contains it.
°
This field is copied from OFFSET in DICTOBL; it is duplicated here for efficient
access.
°
ELEMENT-SIZE−the size in bytes of the key field.
°
This field is copied from SIZE in DICTOBL; it is duplicated here for efficient
access.
°
NULL-VALUE−a value that indicates whether the field has been initialized.
•
If NULL-VALUE contains the null value specified by the user, then the field has not
been initialized. This field is currently used by the Enform product when producing
reports and by FUP when producing a FUP source file. An alternate key field filled
with null values is not added to an alternate key file.
•
NULL-VALUE-SPECIFIED−contains the ASCII character Y (yes) or N (no) to
indicate whether the user specified a null value for this item. The default for this
field is N.
•
KEY-CLASS−indicates the type of key this record defines. KEY-CLASS is one of
the following:
The default for this field is PRI.
•
KEY-UNIQUE−contains the ASCII character Y (yes) or N (no) to indicate whether
the key that defines this record is unique. The default for this field is Y.
•
KEY-UPDATE−contains the ASCII character Y (yes) or N (no) to indicate if the key
might be updated. The default for this field is Y.
•
KEY-FILE-NAME−contains the actual Guardian file name to be used for the key.
The name is stored in external form and may be a network name. For example,
\NEWYORK.$MARKET.DATAFILE.FILE1.
Code Meaning
PRI Primary key
ALT Alternate Key
DSF Descending sort order
ASF Ascending sort order