Museum

 The character string literal "Toliver" appears in the following
 expression:

 E IN EMPLOYEES WITH LAST_NAME IN E = "Toliver"

Numeric lit

 A numeric literal is a string of digits that interprets as a decimal
 number.  A numeric literal may be:

  o  A decimal string consisting of digits and an optional decimal
     point.  The maximum length, not counting the decimal point, is 19
     digits.

  o  A decimal number in scientific notation (E-format), consisting of a
     decimal string mantissa and a signed integer exponent, separated by
     the letter D (for double), E (for E-format) or Q (for H_floating).


 CDO allows you to use unary plus and minus in numeric expressions.  You
 can also use any form of decimal notation.  CDO does not allow you to
 embed spaces in E notation.  The following are valid numeric strings:

     123

     34.9

     -123

     0.33889909

     6.03 E+23

     6.03 E -23


 The following expressions are *not* valid numeric strings.  Valid
 numeric strings must start and end with a numeral and cannot contain
 hexadecimal digits.  Including a zero before .25 and after 123.  in the
 following invalid strings would them valid strings.

 38ACFF
 .25
 123.

 If you use a numeric literal to assign a value to a field or a
 variable, the data type of the field or variable determines the maximum
 value you can assign.

 Because a period at the end of a data definition command line
 terminates the command, do not use a decimal point to terminate a
 number if you want to include more data definition clauses in the
 statement.  The period terminates the definition in the following data
 definition clause:

 COMPUTED BY X * 2.

 If you want to include more data definition clauses, include a zero
 after the decimal point, or place the value expression in parentheses:

 COMPUTED BY X * 2.0
 COMPUTED BY (X * 2.)

Additional information available:

 The numeric literal 40000 appears in the following expression:

 S IN SALARY_HISTORY WITH SALARY_AMOUNT IN S > 40000

Statistical expr

 Statistical expressions calculate values based on a value expression
 for every record in a record stream.  Statistical expressions are
 sometimes called "aggregate expressions" because they calculate a
 single value for a collection of records.  When you use a statistical
 expression (except for COUNT), you specify a value expression and an
 RSE.  A layered product evaluates the value expression for each record
 in the record stream formed by the RSE.  Then the product calculates a
 single value based on the results of the first step.

 statistical-expr =

   ───────┬──> 
M
A
X ─────┬──> value-expr ──┬──> 
O
F ──> rse ──>
          ├──> 
M
I
N ─────┤                 │
          ├──> 
T
O
T
A
L ───┤                 │
          ├──> 
A
V
E
R
A
G
E ─┘                 │
          └──> 
C
O
U
N
T ─────────────────────┘

Additional information available:

value-exprrseExamples

value-expr

 A value expression.  A value expression is a symbol or string of
 symbols used to calculate a value.

rse

 A record selection expression.

Examples

 The following AVERAGE expression uses the RSE to form a record stream
 of records where the SALARY_AMOUNT field is greater than 50000.  The
 average of the values in the SALARY_AMOUNT field for the records in the
 record stream is calculated by the product reading the expression.

 AVERAGE SALARY_AMOUNT IN CS OF CS IN SALARY WITH SALARY_AMOUNT IN CS GT
 50000

 The COUNT expression differs from the other statistical operators in
 that it operates on the record stream defined by the RSE rather than on
 values in that record stream.  It returns the number of records in the
 record stream.  In the following expression, the number of employees
 working in New Hampshire is returned:

 COUNT OF E IN EMPLOYEES WITH STATE IN E = "NH"

 The following MAX expression finds the highest paid employee in the
 company:

 MAX SALARY_AMOUNT IN CS OF SAL IN CURRENT_SALARY WITH SALARY IN SAL =
 MAX

 The following MIN expression finds the lowest paid employee in the
 company:

 MIN SALARY_AMOUNT IN CS OF SAL IN CURRENT_SALARY WITH SALARY IN SAL =
 MIN

 The following TOTAL expression finds the total annual payroll of the
 company:

 TOTAL SALARY_AMOUNT IN CS OF CS IN CURRENT_SALARY

Arithmetic expr

 An arithmetic expression combines value expressions and arithmetic
 operators.  When you use an arithmetic expression in a value
 expression, the product using the CDO expression calculates the value
 associated with the expression and uses that value when executing the
 statement.  Therefore, an arithmetic expression must be reducible to a
 value.

 arith-expr =

 ───> value-expr ────┬──> typebox (+) ──┬────> value-expr ─────>
                     ├──> - ──┤
                     ├──> typebox (*) ──┤
                     └──> typebox (/) ──┘

Additional information available:

cond-exprvalue-expr1value-expr2operatorbetween-clausecontaining-clause
matching-clausemissing-clausestarting-with-clauseExamples

value-expr

 A value expression.  A value expression is a string of symbols used to
 calculate a value.

Examples

 The following example shows an arithmetic expression that adds two
 numeric literals:

 8 + 7

 The following example is an arithmetic expression that is evaluated as
 11:

 8 + 14 / 2 - 4

 The following example is an arithmetic expression that is evaluated as
 7:

 (8 + 14) / 2 - 4

 The following example is an arithmetic expression that is evaluated as
 1:

 8 + 14 / (2 - 4)

Concatenated expr

 A concatenated expression is a value expression that combines two other
 value expressions by joining the second to the end of the first.
 Concatenated expressions use the concatenate operator (|).  You can
 combine value expressions of any kind, including numeric expressions,
 string expressions, and literals.

 concat-expr =

   ───> value-expr ───>  |  ───> value-expr ───>

Additional information available:

value-exprExample

value-expr

 A symbol or string of symbols used to calculate a value.

Example

 The following example defines the field NAME using the FIRST_NAME,
 MIDDLE_INITIAL, and LAST_NAME fields.  The space between each pair of
 quotation marks will appear in the output of the NAME field:

 DEFINE FIELD NAME
 COMPUTED BY FIRST_NAME | ' ' | MIDDLE_INITIAL | ' ' | LAST_NAME.

 Output is:
 JOHN Q PUBLIC

FIRST FROM expr

 The FIRST FROM expression works in two steps:

 1.  It forms the record stream as specified by the record selection
     expression.

 2.  If at least one record matches the RSE, the values stored in the
     first record of the record stream are used to evaluate the value
     expression.

 first-from-expr =

   ───> 
F
I
R
S
T ───> value-expr ───> 
F
R
O
M ───> rse ───>

Additional information available:

value-exprrseExample

value-expr

 A symbol or string of symbols used to calculate a value.

rse

 A clause that VAX Information Architecture products use at run time to
 include specific records for processing.

Example

 The following example finds the salary of the first employee who works
 in the ZK02 facility:

 FIRST SALARY IN E FROM E IN EMPLOYEES
 WITH LOCATION IN E = "ZK02"

conditional expr

 A conditional expression, sometimes called a Boolean expression,
 represents the relationship between two value expressions.  You can use
 conditional expressions in CDO as objects for the WITH clause or VALID
 IF clause of the record selection expression or the VALID IF clause in
 field definitions.  A conditional expression has a value of true,
 false, or missing.

 Conditional expressions consist of value expressions, relational
 operators, and logical operators:

  o  Relational operators control the comparison of value expressions.
     For information, go to the "relational_operators" subtopic under
     the top-level topic "expressions".

  o  Logical operators (AND, OR, NOT) let you join two or more
     conditional expressions and optionally reverse the value of a
     conditional expression.  The result of using a logical operator is
     another conditional expression.

 The following diagram shows the types of conditional expressions.

 cond-expr=

 ──┬─> cond-expr ────────> 
A
N
D ──> cond-expr ────────────────────────┬─>
   ├─> cond-expr ────────> 
O
R ───> cond-expr ────────────────────────┤
   ├─────────────────────> 
N
O
T ──> cond-expr ────────────────────────┤
   ├─> value-expr1 ──┬──────>───────────┬─> operator ─> value-expr2 ─┤
   │                 └> 
C
A
S
E
S
E
N
S
I
T
I
V
E ─┘                            │
   ├─> between-clause ───────────────────────────────────────────────┤
   ├─> containing-clause ────────────────────────────────────────────┤
   ├─> matching-clause ──────────────────────────────────────────────┤
   ├─> missing-clause ───────────────────────────────────────────────┤
   └─> starting-with-clause  ────────────────────────────────────────┘

Additional information available:

cond-expr

 A conditional expression.  This subtopic describes conditional
 expressions.

value-expr1

 A value expression.  If either value expression in a condition
 evaluates to null, the condition evaluates to null.

value-expr2

 A value expression.  If either value expression in a condition
 evaluates to null, the condition evaluates to null.

operator

 One of the following mathematical relational operators:

      =     EQ
      <>    NE
      >     GT
      >=    GE
      <     LT
      <=    LE

between-clause

 A relational clause that tests whether or not a value lies between two
 values.

 The product using CDO evaluates a BETWEEN clause as true, if the first
 value is between two values.

 If you use the keyword NOT, the product using CDO evaluates the clause
 as true, if the first value is not between two values.

 between-clause =

 ────> value-expr1 ────┬───>──────┬───> 
B
E
T
W
E
E
N ────┐
                       └──> 
N
O
T ──┘                 │
      ┌─────────────────────────────────────────────┘
      └───> value-expr2 ───> 
A
N
D ───> value-expr3 ───────>

Additional information available:

value-expr1value-expr2value-expr3Examples

value-expr1

 A value expression.  If either value expression in a condition
 evaluates to null, the condition evaluates to null.  For more
 information and a diagram, see the subtopic "value-expr" under the
 top-level topic "expressions".

value-expr2

 A value expression.  If either value expression in a condition
 evaluates to null, the condition evaluates to null.  For more
 information and a diagram, see the subtopic "value-expr" under the
 top-level topic "expressions".

value-expr3

 A value expression.  If either value expression in a condition
 evaluates to null, the condition evaluates to null.  For more
 information and a diagram, see the subtopic "value-expr" under the
 top-level topic "expressions".

Examples

 In the following example, if SALARY_AMOUNT is 20000, CDO evaluates the
 BETWEEN clause as true:

 SALARY_AMOUNT BETWEEN 10000 AND 30000

 In the following example, if SALARY_AMOUNT is 40000, CDO evaluates the
 BETWEEN clause as true:

 SALARY_AMOUNT NOT BETWEEN 10000 AND 30000

containing-clause

 A relational clause that tests for substring matches.  This operation
 is not case sensitive.

 The product using CDO evaluates a CONTAINING clause as true, if the
 first string expression contains the string that the second string
 expression specifies.

 If you use the keyword NOT, the product using CDO evaluates the clause
 as true, if the first string expression does not contain the string
 that the second string expression specifies.

 containing-clause =

 ──> value-expr1 ──┬─────>────┬──> 
C
O
N
T
A
I
N
I
N
G ──> value-expr2 ──>
                   └──> 
N
O
T ──┘

Additional information available:

value-expr1value-expr2Examples

value-expr1

 A value expression.  If either value expression in a condition
 evaluates to null, the condition evaluates to null.  For more
 information and a diagram, see the subtopic "value-expr" under the
 top-level topic "expressions".

value-expr2

 A value expression.  If either value expression in a condition
 evaluates to null, the condition evaluates to null.  For more
 information and a diagram, see the subtopic "value-expr" under the
 top-level topic "expressions".

Examples

 In the following example, if LAST_NAME has the string "ITH", CDO
 evaluates the CONTAINING clause as true:

 LAST_NAME CONTAINING "ith"

 In the following example, if LAST_NAME does not contain "ith", CDO
 evaluates the CONTAINING clause as true:

 LAST_NAME NOT CONTAINING "ITH"

matching-clause

 A relational clause that tests for substring matches.  By using
 wildcard characters, you can specify the position of the substring.
 This operation is not case sensitive.

 The product using CDO evaluates a MATCHING clause as true, if the
 second expression matches a substring of the first value expression.

 If you use the keyword NOT, the product using CDO evaluates the clause
 as true, if the second expression does not match a substring of the
 first value expression.

 matching-clause =

 ───> value-expr ───┬─────>────┬─> 
M
A
T
C
H
I
N
G ───> match-expr ────>
                    └──> 
N
O
T ──┘

Additional information available:

value-expr1match-exprExamples

value-expr1

 A value expression.  If either value expression in a condition
 evaluates to null, the condition evaluates to null.  For more
 information and a diagram, see the subtopic "value-expr" under the
 top-level topic "expressions".

match-expr

 A value expression in quotation marks.

Examples

 In the following example, the MATCHING clause finds those EMPLOYEE
 records that have "ON" as the last two letters in the field LAST_NAME:

 LAST_NAME MATCHING "*ON "

 In the following example, the MATCHING clause finds those EMPLOYEE
 records that have "ON" as the second and third letters in the field
 LAST_NAME:

 LAST_NAME MATCHING "%ON "

 You can also use the MATCHING clause with numeric data types.  In the
 following example, the MATCHING clause finds all the salaries that
 start with the number 4:
 SALARY_AMOUNT MATCHING "4*"

 Another way of stating the same condition in the preceding example is
 by using the BETWEEN clause, as the following example shows:
 SALARY_AMOUNT BETWEEN 40000 AND 49999

missing-clause

 A relational clause that tests for a null record or field expression.

 The product using CDO evaluates a MISSING clause as true, if the record
 or field expression is null.

 If you use the keyword NOT, the product using CDO evaluates the clause
 as true, if the record or field expression is not null.

 missing-clause=

 ─> field-or-record ──┬───>───┬─> 
M
I
S
S
I
N
G ──>
                      └> 
N
O
T ─┘

Additional information available:

field-or-recordExamples

field-or-record

 Specifies the name of a field or record in the database, consisting of
 a field or record name and a directory name or context variable.  For a
 description and diagram, see the subtopic "FIELD_OR_RECORD-expr" under
 the subtopic "value_expr" of the top-level topic "expressions".

Examples

 In the following example, CDO evaluates the field expression as true,
 when the LAST_NAME field from the FULL_NAME record of the EMPLOYEES
 relation is alphabetic:

 LAST_NAME IN FULL_NAME IN E ALPHABETIC

 In the following example, CDO evaluates the field expression as true,
 when the SALARY_AMOUNT field has a value that is not null:

 SALARY_AMOUNT NOT MISSING

starting-with-clause

 A relational clause that tests for beginning substring matches.  This
 operation is case sensitive.

 The product using CDO evaluates a STARTING WITH clause as true, if the
 first characters of the first string expression match the characters in
 the second string expression.

 If you use the keyword NOT, the product using CDO evaluates the clause
 as true, if the first string does not contain the string that the
 second string expression specifies.

 starting-with-clause =

 ──> value-expr1 ──┬────>───┬──> 
S
T
A
R
T
I
N
G 
W
I
T
H ──> value-expr2 ──>
                   └─> 
N
O
T ─┘

Additional information available:

value-expr1value-expr2Examples

value-expr1

 A value expression.  If either value expression in a condition
 evaluates to null, the condition evaluates to null.  For more
 information and a diagram, see the subtopic "value-expr" under the
 top-level topic "expressions".

value-expr2

 A value expression.  If either value expression in a condition
 evaluates to null, the condition evaluates to null.  For more
 information and a diagram, see the subtopic "value-expr" under the
 top-level topic "expressions".

Examples

 In the following example, if LAST_NAME has the string "ith", CDO
 evaluates the CONTAINING clause as true:

 LAST_NAME CONTAINING "ith"

 In the following example, if LAST_NAME does not contain "ith", CDO
 evaluates the CONTAINING clause as true:

 LAST_NAME NOT CONTAINING "ITH"

Examples

 The GT (>) operator compares two values.  The following expression is
 true if the value in the SALARY_AMOUNT field of the SALARY_HISTORY
 record is greater than 50000.  When this expression is evaluated, the
 relationship between the two value expressions, SALARY_AMOUNT IN SH and
 50000, is examined.

 SALARY_AMOUNT IN SH > 50000

 In the following example, the following conditional expression is true
 if the value in the SALARY_AMOUNT field from the SALARY_RECORD is 50000
 or greater:

 NOT SALARY_AMOUNT IN SH < 50000

 The following example show two commands.  The first command, DEFINE
 FIELD uses a case sensitive relational operator in its VALID IF clause
 to test whether the code to be entered in the SEX field definition is
 either "M" or "F".

 The second command, SHOW FIELD displays the brief form of the SEX field
 definition:

 CDO> DEFINE FIELD SEX
 cont> VALID IF SEX CASE_SENSITIVE EQ "M" OR "F".

 CDO> SHOW FIELD SEX
 Definition of field SEX
 |   Valid if                 ((SEX EQ "M") CASE_SENSITIVE OR "F")

relational operators

 Relational operators specify the relationship of value expressions and
 perform the following kinds of operations:

  o  Comparing a value with a range

  o  Matching a pattern

  o  Testing for missing fields


 CDO uses two kinds of relational operators in its conditional
 expressions.  They are mathematical relational operators and pattern
 testing relational operators.

 The mathematical relational operators are symbols that allow you to
 compare values.  Pattern testing relational operators are keywords that
 allow you to test for a pattern of values.  Unlike the mathematical
 relational operators, each pattern testing relational operator has its
 own unique syntax.

Additional information available:

mathematical relational operatorspattern testing relational operators

mathematical relational operators

 The following table lists the mathematical relational operators.  In
 all cases, if either operand in a conditional expression is null, the
 value of the condition is null.

 Permitted Symbols  Relational Operation

 EQ  =              True if the two value expressions are equal.

 NE  <>             True if the two value expressions are not equal.

 GT  >              True if the first value expression is greater than
                    the second.

 GE  >=             True if the first value expression is greater than
                    or equal to the second.

 LT  <              True if the first value expression is less than the
                    second.

 LE  <=             True if the first value expression is less than or
                    equal to the second.

 Use either the alphabetic symbol or the mathematical symbol from the
 Permitted Symbols column, but do not use both consecutively when you
 specify a relational operator.  For example, both X = 5 and X EQ 5 are
 legal expressions, but X =EQ 5 is not.  Using two consecutive symbols
 is not legal.

 See the documentation for VAX languages and products that use the
 dictionary to determine how that product evaluates character string
 literals.  In some cases, character string literals are compared
 according to the ASCII collating sequence.  Thus, lowercase letters are
 considered to have a greater value than uppercase letters, and the
 letters near the beginning of the alphabet are considered to have a
 lesser value than those near the end.

 For products that compare character string literals according to the
 ASCII collating sequence, the following statements are true:

     "a" > "A"

     "a" < "z"

     "A" < "Z"



 NOTE:  The NOT operator applies to conditional expressions.  Do not use
 the NOT operator and an equal sign instead of the NE or <> relational
 operators.  The following statement is not legal:

              WITH SALARY_AMOUNT IN S NOT = 30000

 Use one of the following alternatives:

              WITH NOT (SALARY_AMOUNT IN S = 30000)
              WITH SALARY_AMOUNT IN S NE 30000
              WITH SALARY_AMOUNT IN S <> 30000

pattern testing relational operators

 The following table lists the pattern testing relational operators.

 Permitted Symbols  Relational Operation

 BETWEEN            True if the first value expression is less than
                    or equal to the second and greater than or equal
                    to the third.

 CONTAINING         True if the string specified by the second string
                    expression is found within the string specified
                    by the first. CONTAINING is not case sensitive.

 MATCHING           True if the second expression matches a substring
                    of the first value expression. MATCHING is not
                    case sensitive.  It uses the wildcard characters:

                      * Matches any string of zero or more characters
                      % Matches any single character in that position

 MISSING            True if the value expression is null.

 STARTING WITH      True if the first characters of the first string
                    expression match the second string expression.
                    STARTING WITH is case sensitive.

record sel expr

 A record selection expression (RSE) is a clause that VAX Information
 Architecture products use at run time to include specific records for
 processing, based on a set of conditions described by the RSE.

 rse =

 ──┬───────────────────┬───> relation-clause ──┬──────────────────┬─┐
   └──> first-clause ──┘                       └─> cross-clause ──┘ │
                                                                    │
  ┌─────────────────────────────────────────────────────────────────┘
  └┬──────────────────┬─┬────────────────────┬─┬──────────────────┬──>
   └──> with-clause ──┘ └──> reduced-clause ─┘ └──> sort-clause ──┘

Additional information available:

first-clauserelation-clausecross-clausewith-clausereduced-clause
sort-clause

first-clause

 The FIRST clause specifies how many records are in the record stream
 formed by the record selection expression.  The record stream cannot
 contain more records than the number specified by the value expression.

 first-clause=

  ───────> 
F
I
R
S
T ──────> value-expr ───────>

Additional information available:

value-exprExample

value-expr

 A symbol or string of symbols used to calculate a value.  The value
 expression in a FIRST clause must be either be a positive integer or a
 value expression that evaluates to a positive integer.

Example

 You can use FIRST and SORTED BY to find the maximum values for a field.
 You could use the MAX statistical function to find the highest paid
 employee, but you can use a statement such as the following to find the
 five highest paid employees:

 FIRST 5 C IN CURRENT_SALARY
 SORTED BY DESCENDING SALARY_AMOUNT IN C

relation-clause

 The RELATION clause is used to declare context variables for a record
 stream or a loop.  A context variable is a temporary name that
 identifies the record stream to the layered product evaluating the
 clause.

 relation-clause =

 ──> context-var ───> 
I
N ────> relation-name ──>

Additional information available:

context-varrelation-nameExamples

context-var

 A context variable.

relation-name

 The name of the relation from which the records in the record stream
 will be taken.

Examples

 The following RSE retrieves all of the records from the EMPLOYEES
 relation:

 E IN EMPLOYEES

 The following example declares E as the context variable for the record
 stream of records from the EMPLOYEES relation:

 COUNT OF E IN EMPLOYEES WITH STATE IN E = "NY"

cross-clause

 The CROSS clause of the record selection expression lets you combine
 records from two or more record streams.  You can join these records in
 combinations based on the relationship between the values of fields in
 the separate record streams.  This combining of records is called a
 relational join.

 cross-clause =

 ─┬─> 
C
R
O
S
S ──> relation-clause ───┬──>
  └───────────────<────────────────┘

Additional information available:

relation-clauseExamples

relation-clause

 The RELATION clause is used to declare context variables for a record
 stream or loop.  For more information, see the subtopic
 "record_sel_expr" under the top-level topic "expressions".

Examples

 The following example finds all the employees for whom data is stored
 in the JOB_HISTORY relation:

 E IN EMPLOYEES CROSS JH IN JOB_HISTORY
 WITH EMP_ID IN E = EMP_ID IN JH

 The following example retrieves information on all employees and their
 job descriptions:

 E IN EMPLOYEES CROSS J IN JOBS

with-clause

 The WITH clause contains a conditional expression that allows you to
 specify conditions that must be true for a record to be included in a
 record stream.

 with-clause=

 ──────> 
W
I
T
H ───> cond-expr ───>

Additional information available:

cond-exprExample

cond-expr

 A record becomes part of a record stream only when its values satisfy
 the conditions you specified in the conditional-expr (that is, only
 when the conditional expression is "true").  If the conditional
 expression evaluates to false or missing for a record, that record is
 not included in the record stream.

Example

 The following RSE returns all employees whose JOB_CODE = "R":

 E IN EMPLOYEES WITH JOB_CODE IN E = "R"

reduced-clause

 The REDUCED clause of the record selection expression lets you
 eliminate duplicate values for fields in a record stream.  You can use
 this expression to eliminate redundancy in the results of a query and
 to group the records in a relation according to unique field values.
 However, merely using the REDUCED clause does not guarantee the
 resulting order of the resulting record stream; to ensure a specific
 order, use the SORTED BY clause.

 reduced-clause =

 ───────> 
R
E
D
U
C
E
D 
T
O ───┬──> value-expr ─────┬───>
                        └───────── , <───────┘

Additional information available:

value-exprExample

value-expr

 A symbol or string of symbols used to calculate a value.

Example

 The following expression lists all the currently active job codes only
 once:

 REDUCED TO JOB_CODE IN J

sort-clause

 The SORTED BY clause of the record selection expression lets you sort
 the records in the record stream by the values of specific fields.  You
 can sort the records according to a value expression called a sort key,
 which determines the order in which records are returned.

 sort-clause =

 ───> 
S
O
R
T
E
D 
B
Y ───┬─┬────────────────┬──> value-expr ──┬──>
                   │ ├──> 
A
S
C
E
N
D
I
N
G ──┤                 │
                   │ └──> 
D
E
S
C
E
N
D
I
N
G ─┘                 │
                   └────────────── , <──────────────────┘

Additional information available:

relational operatorsExamples

value-expr

 A value expression specifying the value to sort by.  This is called the
 sort key.

Examples

 The following expression sorts EMPLOYEES by ID Number:

 EMPLOYEES SORTED BY EMPLOYEE_ID IN E

 In the following example, records are sorted first first by STATUS_CODE
 in descending order.  Within each STATUS_CODE group, the records are
 sorted by LAST_NAME in ascending order.  Finally, within groups of
 employees with the same last name, records are sorted by EMPLOYEE_ID.
 The order for this last sort is also ascending because it adopts the
 order from the previous sort key.

 SORTED BY DESCENDING STATUS_CODE IN E
 ASCENDING LAST_NAME IN E, EMPLOYEE_ID IN E

precedence ordering

 The following table shows the order in which CDD/Plus interprets
 symbols used in a CDD/Plus expression.  The first line of the table
 shows the first part of an expression to be evaluated (a symbol or
 group of symbols surrounded by parentheses).  The second line of the
 table shows the next part of an expression to be evaluated (the
 multiplication and division symbols).  Symbols on the same line in the
 table have equal precedence; CDD/Plus evaluates them in the order they
 appear in an expression.  The items on any line of the table have lower
 precedence than the items on the line above them.  The final line in
 the table is the logical operator OR.  This is the last part of a
 CDD/Plus expression to be evaluated.


            Precedence Ordering within Expressions


 (symbols)                       A Symbol or Symbols within Parentheses

 *  /                            Multiplication and Division Symbols

 +  -                            Addition and Subtraction Symbols

 <  >  <=  >=  =  <>             See subtopic "relational_operators"

 NOT                             Logical Operator

 AND                             Logical Operator

 OR                              Logical Operator

Additional information available:

relational operators

 The following table shows equivalent symbols for the relational
 operators shown in the Precedence Ordering within Expressions table:


 Relational          Equivalent
 Operator            Symbol                 Meaning

 <                     LT                   "Less than"
 >                     GT                   "Greater than"
 <=                    LE                   "Less than or equal to"
 >=                    GE                   "Greater than or equal to"
 =                     EQ                   "Equal to"
 <>                    NE                   "Not equal to"

Examples

 CDO evaluates the following expression's value as 3:

 (6 + 12)/6

 CDO evaluates the following expression's value as 8:

 6 + 12/6

 In the following expression, CDO evaluates X as a value between 2
 through 4 or 11 through 20:

 IF (X GE 2 AND X LE 4) OR (X GE 11 AND X LE 20) THEN 1 ELSE 0

field-attr

 Field attributes define the characteristics of the data you store in
 fields.  The following diagram shows the valid CDO field attributes:

 field-attributes=

 ──────────────┬─> array-type ────────────────────────────────────┬──>
               ├─> 
A
U
D
I
T typebox (I)typebox (S) typebox (/)typebox (*)  text  */ ─────────────────────────┤
               ├─> 
B
A
S
E
D 
O
N field-name ───────────────────────────┤
               ├─> computed-by-clause ────────────────────────────┤
               ├─> 
D
A
T
A
T
Y
P
E typebox (I)typebox (S) data-type ─────────────────────────┤
               ├───┬─────>──────┬> 
E
D
I
T
S
T
R
I
N
G typebox (I)typebox (S) edit-string ────┤
               │   └> language ─┘                                 │
               ├─> 
F
I
L
L
E
R ────────────────────────────────────────┤
               ├─> 
I
N
I
T
I
A
L
V
A
L
U
E typebox (I)typebox (S) ──> value-expr ───────────────┤
               ├─> 
J
U
S
T
I
F
I
E
D ───> justified-option ───────────────┤
               ├─> 
M
I
S
S
I
N
G
V
A
L
U
E typebox (I)typebox (S) ──> value-expr ───────────────┤
               ├─> 
N
A
M
E Ftypebox (O)typebox (R) language IS name ─────────────────────┤
               ├─> occurs-phrase ─────────────────────────────────┤
               ├─> 
Q
U
E
R
Y
H
E
A
D
E
R typebox (I)typebox (S) ─┬─> quoted-string ─┬──────────┤
               │                    └───────── , <─────┘          │
               ├─> 
Q
U
E
R
Y
N
A
M
E typebox (I)typebox (S) ──┬─> quoted-string ──┬──────────┤
               │                   └─> query-name ─────┘          │
               └─> 
V
A
L
I
D 
I
F conditional-expr ─────────────────────┘

 To remove a field attribute from a field definition, you use the CHANGE
 FIELD command and add the prefix "NO" to the name of the attribute you
 want to remove.  The following diagram shows the keywords that are used
 to remove field attributes from a field definition:

 cancel-field-attributes=

 ───────────────────┬───> 
N
O
A
R
R
A
Y ────────────────────┬───────>
                    ├───> 
N
O
B
A
S
E
D 
O
N ─────────────────┤
                    ├───> 
N
O
C
O
M
P
U
T
E
D 
B
Y ──────────────┤
                    ├───> 
N
O
D
A
T
A
T
Y
P
E ─────────────────┤
                    ├─┬─────>─────┬─> 
N
O
E
D
I
T
S
T
R
I
N
G ──┤
                    │ └>language ─┘                   │
                    ├───> 
N
O
I
N
I
T
I
A
L
V
A
L
U
E ────────────┤
                    ├───> 
N
O
J
U
S
T
I
F
I
E
D ────────────────┤
                    ├───> 
N
O
M
I
S
S
I
N
G
V
A
L
U
E ────────────┤
                    ├───> 
N
O
N
A
M
E Ftypebox (O)typebox (R) language ────────┤
                    ├───> 
N
O
O
C
C
U
R
S ───────────────────┤
                    ├───> 
N
O
Q
U
E
R
Y
H
E
A
D
E
R ─────────────┤
                    ├───> 
N
O
Q
U
E
R
Y
N
A
M
E ───────────────┤
                    └───> 
N
O
V
A
L
I
D 
I
F ─────────────────┘

Additional information available:

ARRAYAUDITBASEDDATATYPEEDIT_STRINGFILLER
INITIAL_VALUEJUSTIFIEDMISSING_VALUENAMEOCCURS
QUERY_HEADERQUERY_NAMEVALID

computed-by-clauselanguage

ARRAY

 Declares single- or multi-dimensional arrays.  The syntax and function
 of the ARRAY field attribute are the same as for the ARRAY record
 attribute.


 array-type=

  ─┬────────>───────┬─> 
A
R
R
A
Y ─┬─┬───>───┬─> n2 ─┬─>
   ├> 
R
O
W
M
A
J
O
R ────┤          │ └> n1: ─┘       │
   └> 
C
O
L
U
M
N
M
A
J
O
R ─┘          └─────────<───────┘

Additional information available:

n1n2Examples

n1

 The lower bound of the subscript.  Replace n1 with a signed integer.

n2

 The upper bound of the subscript.  Replace n2 with a signed integer.

Examples

 In the following example, the ARRAY clause declares 20 instances of
 SUPPLIER (from 0 to 19) where each instance is four 30-character
 strings.

 CDO> DEFINE FIELD SUPPLIER
 cont> ARRAY 0:19 1:4
 cont> DATATYPE IS TEXT
 cont> SIZE IS 30 CHARACTERS.
 CDO>

 The following command removes the ARRAY clause from field SUPPLIER:

 CDO> CHANGE FIELD SUPPLIER
 cont> NOARRAY.
 CDO>

AUDIT

 Allows you to enter comments that will appear in a history list entry
 to a field definition.


 ───> 
A
U
D
I
T typebox (I)typebox (S) typebox (/)typebox (*)  text  */ ───────────────>

Additional information available:

textExamples

text

 Comments that will be included in a history list entry for the field
 definition.

Examples

 The following example shows two commands.  The first command creates
 the field definition ZIP_CODE.  The DESCRIPTION clause explains what
 the field's value should be.  The AUDIT clause is used to indicate that
 the field will be changed in the future.  The second command shows the
 history list entry for the field definition after the first command
 executes:

 CDO> DEFINE FIELD ZIP_CODE
 cont> DESCRIPTION IS /* A 5 DIGIT POSTAL CODE */
 cont> AUDIT IS /* WILL BE CHANGED TO 9 DIGITS EVENTUALLY */
 cont> DATATYPE IS UNSIGNED LONGWORD
 cont> SIZE IS 5 DIGITS.

 CDO> SHOW FIELD/ALL ZIP_CODE
 Definition of field ZIP_CODE
 |   acl                      (IDENTIFIER=[VCD,RICK],ACCESS=READ+WRITE+
 MODIFY+ERASE+SHOW+DEFINE+CHANGE+DELETE+CONTROL+OPERATOR+ADMINISTRATOR)
 (IDENTIFIER=[*,*],ACCESS=READ+WRITE+MODIFY+ERASE+SHOW+OPERATOR+ADMINIS
 TRATOR)
 |   Created time             10-JUN-1987 15:02:41.84
 |   Description              ' A 5 DIGIT POSTAL CODE '
 |   Modified time            10-JUN-1987 15:02:41.84
 |   Owner                    RICK
 |   Datatype                 unsigned longword 5 digits
 |   |   History entered by RICK ([VCD,RICK])
 |   |          using CDO V1.0
 |   |          to CREATE definition on 10-JUN-1987 15:02:31.73
 |   |          Explanation:
 |   |                   WILL BE CHANGED TO 9 DIGITS EVENTUALLY
 CDO>

 The following example shows two commands.  The first command changes
 the value allowed for the ZIP_CODE field.  The second command shows the
 history list entries for the field definition after the first command
 executes:

 CDO> CHANGE FIELD ZIP_CODE
 cont> DESCRIPTION IS /* A 9 DIGIT POSTAL CODE */
 cont> AUDIT IS /* NEW POSTAL CODE IS NOW IN EFFECT */
 cont> DATATYPE IS UNSIGNED LONGWORD
 cont> SIZE IS 9 DIGITS.

 CDO> SHOW FIELD/AUDIT ZIP_CODE
 Definition of field ZIP_CODE
 |   |   History entered by RICK ([VCD,RICK])
 |   |          using CDO V1.0
 |   |          to CREATE definition on 10-JUN-1987 14:20:47.53
 |   |          Explanation:
 |   |                   WILL BE CHANGED TO 9 DIGITS EVENTUALLY
 |   |   History entered by RICK ([VCD,RICK])
 |   |          using CDO V1.0
 |   |          to MODIFY on 10-JUN-1987 14:22:10.95
 |   |          Explanation:
 |   |                   NEW POSTAL CODE IS NOW IN EFFECT
 CDO>

 The following example shows the history list entry that would have been
 created for the field definition ZIP_CODE if no AUDIT clause had been
 specified during the creation or modification of the object:

 CDO> SHOW FIELD/AUDIT ZIP_CODE
 Definition of field ZIP_CODE
 |   |   History entered by RICK ([VCD,RICK])
 |   |          using CDO V1.0
 |   |          to CREATE definition on 10-JUN-1987 14:27:58.82
 |   |   History entered by RICK ([VCD,RICK])
 |   |          using CDO V1.0
 |   |          to MODIFY on 10-JUN-1987 14:28:52.96
 CDO>

BASED

 BASED ON is used to define a field that shares the attributes of a
 field already defined.


 ──> 
B
A
S
E
D 
O
N ─────────> field-name ───────────────────────────────>

Additional information available:

field-nameExamples

field-name

 The name of the field definition whose attributes will be used in the
 field you are defining.

Examples

 The following group of examples shows how the BASED ON clause can be
 used to define several fields that contain the attributes of the base
 field.

 The following command creates the BADGE NUMBER field:

 CDO> DEFINE FIELD BADGE_NUMBER
 cont> DATATYPE PACKED DECIMAL 8.
 CDO>

 The following command creates the SUPERVISOR_BADGE_NUMBER field.
 Because the BASED ON clause is used, CDO reads the attributes of the
 BADGE_NUMBER field and applies them to the SUPERVISOR_BADGE_NUMBER
 field.  If you want the new field to have additional attributes not
 found in the base field, you can specify the additional attributes when
 you define the based on field, or later with the CHANGE FIELD command.
 In this example, the VALID IF clause is used to specify an additional
 attribute in the SUPERVISOR_BADGE_NUMBER field.  The VALID IF clause
 ensures that only badge numbers higher than 500 will be accepted in the
 SUPERVISOR_BADGE_NUMBER field:

 CDO> DEFINE FIELD SUPERVISOR_BADGE_NUMBER
 cont> BASED ON BADGE_NUMBER
 cont> VALID IF SUPERVISOR_BADGE_NUMBER > 500.
 CDO>

 The following command creates the MANAGER_BADGE_NUMBER field, which is
 based on the SUPERVISOR_BADGE_NUMBER field.  CDO determines the
 attributes not explicitly specified in SUPERVISOR_BADGE_NUMBER by
 reading BADGE_NUMBER and then applies those attributes to
 MANAGER_BADGE_NUMBER.  CDO does not apply the VALID IF clause in
 SUPERVISOR_BADGE_NUMBER to MANAGER_BADGE_NUMBER because the VALID IF
 clause specified in MANAGER_BADGE_NUMBER supersedes the VALID IF clause
 in SUPERVISOR_BADGE_NUMBER:

 CDO> DEFINE FIELD MANAGER_BADGE_NUMBER
 cont> BASED ON SUPERVISOR_BADGE_NUMBER
 cont> VALID IF MANAGER_BADGE_NUMBER > 1000.
 CDO>

 You can use the CHANGE FIELD to change the value of an attribute in a
 field definition based on another field definition.  For example, after
 the following command executes, the MANAGER_BADGE_NUMBER field will
 only accept values greater than 1500:

 CDO> CHANGE FIELD MANAGER_BADGE_NUMBER
 cont> VALID IF MANAGER_BADGE_NUMBER > 1500
 CDO>

 The following examples show how to use the BASED ON clause to give
 individual names to field definitions that share the same attributes.

 The following command defines the field SSAN:

 CDO> DEFINE FIELD SSAN
 cont> DATATYPE IS PACKED DECIMAL 9.
 CDO>

 Because a social security number does not change, the attributes in a
 field that is based on field SSAN shares the same attributes as SSAN.
 The following command defines the field SUPERVISOR_SSAN:

 CDO> DEFINE FIELD SUPERVISOR_SSAN
 cont> BASED ON SSAN.
 CDO>

 By giving different names to otherwise identical field descriptions,
 you can refer to each field uniquely when you define a record.  The
 following command defines a record named EMPLOYEE_RECORD:

 CDO> DEFINE RECORD EMPLOYEE_RECORD.
 cont>   SSAN.
 cont>   SUPERVISOR_SSAN.
 cont>   DEPT.
 cont>   LAST_NAME.
 cont>   MIDDLE_INITIAL.
 cont>   FIRST_NAME.
 cont>   STREET.
 cont>   CITY.
 cont>   ZIP.
 cont> END RECORD.
 CDO>


 The following example shows two commands.  The first command defines
 the field MANAGER_SSAN based on field SSAN and gives MANAGER_SSAN the
 "MANAGER SSAN" query header.  The second command removes the BASED ON
 attribute from the field MANAGER_SSAN:

 CDO> DEFINE FIELD MANAGER_SSAN
 cont> BASED ON SSAN
 cont> QUERY_HEADER IS "MANAGER SSAN".

 CDO> CHANGE FIELD MANAGER_SSAN
 cont> NOBASED ON.
 CDO>

computed-by-clause

 Allows the value of a field to be determined by evaluating an
 expression at run-time.


 computed-by-clause=

 ─> 
C
O
M
P
U
T
E
D 
B
Y ─┬─> value-expr ─────────────┬─>
                 └─> conditional-value-expr ─┘

Additional information available:

value-exprconditional-value-exprExamples

value-expr

 An expression used to calculate the field's value.

conditional-value-expr

 A value expression whose value is dependent on the value of a
 conditional (Boolean) expression.  As part of the COMPUTED BY clause,
 it allows you to define a field that is equivalent to a COBOL 88 level
 condition.

 conditional-value-expr=

 ─> 
I
F cond-expr THEN value-expr ─┬─────────>─────────┬─>
                                  └> 
E
L
S
E value-expr ─┘

Additional information available:

cond-exprvalue-exprExamples

cond-expr

 An expression that represents the relationship between two value
 expressions.  The value of a conditional expression is true, false, or
 null.  For more information on conditional expressions, see the
 subtopic "conditional_expr" under the top-level topic "expressions."

value-expr

 A symbol or string of symbols used to calculate a value.  For more
 information on value expressions, see the subtopic "value_expr" under
 the top-level topic "expressions."

Examples

 The following group of examples show how to create equivalent CDO
 definitions for a COBOL record containing level 88 definitions.  The
 following example shows the COBOL syntax for a record containing level
 88 definitions:

 01  COB88.
     03  C              USAGE IS COMP PIC 9(4).
     88  C_ONE          VALUE 1.
     88  C_FIVE_TEN     VALUES ARE 5 THRU 10.
     88  C_OTHER        VALUES ARE 2 THRU 4
                                   11 THRU 20.

 The following example shows how to define the COBOL record in the
 previous example with level 88 definitions using CDO syntax.  First,
 each of the fields that will be used in the record COB88 is defined,
 then the record itself is defined:

 CDO> DEFINE FIELD C
 cont> DATATYPE SIGNED WORD.

 CDO> DEFINE FIELD C_ONE
 cont> COMPUTED BY IF C EQ 1 THEN 1 ELSE 0.

 CDO> DEFINE FIELD C_FIVE_TEN
 cont> NAME FOR COBOL IS C_5_10
 cont> COMPUTED BY IF C GE 5 AND C LE 10 THEN 1 ELSE 0.

 CDO> DEFINE FIELD C_OTHER
 cont> COMPUTED BY
 cont> IF (C GE 2 AND C LE 4)
 cont> OR (C GE 11 AND C LE 20)
 cont> THEN 1 ELSE 0.

 CDO> DEFINE RECORD COB88.
 cont>  C.
 cont>  C_ONE.
 cont>  C_FIVE_TEN.
 cont> END RECORD.

Examples

 In the following example, no storage has been allocated for
 TOTAL_PRICE.  Instead, the expression UNIT_PRICE * QUANTITY is used to
 calculate the value of TOTAL_PRICE at run time.

 CDO> DEFINE FIELD TOTAL_PRICE
 cont> COMPUTED BY UNIT_PRICE * QUANTITY.
 CDO>

 The following command removes the COMPUTED BY attribute from the field
 TOTAL_PRICE:

 CDO> CHANGE FIELD TOTAL_PRICE
 cont> NOCOMPUTED BY.
 CDO>

 The COMPUTED BY clause can be used in fields that will be used in CDO
 definitions that are equivalent to COBOL records containing level 88
 definitions.  The first example below shows the COBOL syntax for a
 record containing level 88 definitions; the remaining examples show
 equivalent CDO definitions for this COBOL record:

 01  COB88.
     03  C              USAGE IS COMP PIC 9(4).
     88  C_ONE          VALUE 1.
     88  C_FIVE_TEN     VALUES ARE 5 THRU 10.
     88  C_OTHER        VALUES ARE 2 THRU 4
                                   11 THRU 20.

 The following examples show the equivalent CDO syntax for the COBOL
 record in the previous example.  Each individual field that will be
 used in the record COB88 is defined, then the record itself is defined:

 CDO> DEFINE FIELD C
 cont> DATATYPE SIGNED WORD.

 CDO> DEFINE FIELD C_ONE
 cont> COMPUTED BY IF C EQ 1 THEN 1 ELSE 0.

 CDO> DEFINE FIELD C_FIVE_TEN
 cont> NAME FOR COBOL IS C_5_10
 cont> COMPUTED BY IF C GE 5 AND C LE 10 THEN 1 ELSE 0.

 CDO> DEFINE FIELD C_OTHER
 cont> COMPUTED BY IF (C GE 2 AND C LE 4) OR (C GE 11 AND C LE 20)
 cont> THEN 1 ELSE 0.

 CDO> DEFINE RECORD COB88.
 cont>  C.
 cont>  C_ONE.
 cont>  C_FIVE_TEN.
 cont>  C_OTHER.
 cont> END RECORD.
 CDO>

DATATYPE

 Declares the type and size of a field.  Some valid CDO data types may
 not be supported by the languages or language processors which will use
 the CDO field definition.  Be sure that the data type you specify is
 valid for the language processors that will use the field definition.


 data-type=

 ─┬> 
A
L
P
H
A
B
E
T
I
C ──────> typebox (S)typebox (I)typebox (Z)typebox (E) typebox (I)typebox (S) ─> numeric-literal case  CHARACTERS ───┬─>
  ├> 
B
I
T ─────────────> typebox (S)typebox (I)typebox (Z)typebox (E) typebox (I)typebox (S) ─> numeric-literal ────────────────────┤
  ├> 
D
A
T
E ─────────────────────────────────────────────────────────────┤
  ├> decimal-string-dtypes ────────────────────────────────────────────┤
  ├> fixed-point-dtypes ───────────────────────────────────────────────┤
  ├> floating-point-dtypes ────────────────────────────────────────────┤
  ├> 
P
O
I
N
T
E
R ──────┬─────────────────────>─────────────────────┬───────┤
  │                └─> typebox (T)typebox (O) name ─────────┬─┬─────────────┬─┬────┘       │
  │                                     │ └─> 
I
N name ──┘ │            │
  │                                     └─────────<───────┘            │
  ├> 
R
E
A
L ─────────────────────────────────────────────────────────────┤
  ├> 
S
E
G
M
E
N
T
E
D 
S
T
R
I
N
G ─┬───────────────────────>───────────────────┬─┐ │
  │                    └> 
S
E
G
M
E
N
T
L
E
N
G
T
H typebox (I)typebox (S) numeric-literal BYTES ─┘ │ │
  │                        ┌───────────────────<─────────────────────┘ │
  │                        └┬───────────────>───────────────┬──────────┤
  │                         └> 
S
E
G
M
E
N
T
T
Y
P
E typebox (I)typebox (S) string-type ─┘          │
  ├> 
T
E
X
T ────────────> typebox (S)typebox (I)typebox (Z)typebox (E) typebox (I)typebox (S) ─> numeric-literal case CHARACTERS ────┤
  ├> 
U
N
S
P
E
C
I
F
I
E
D ─────> typebox (S)typebox (I)typebox (Z)typebox (E) typebox (I)typebox (S) ─> numeric-literal BYTES ──────────────┤
  └> 
V
A
R
Y
I
N
G 
S
T
R
I
N
G ──> typebox (S)typebox (I)typebox (Z)typebox (E) typebox (I)typebox (S) ─> numeric-literal case CHARACTERS ────┘

Additional information available:

casedecimal-string-dtypesfloating-point-dtypesfixed-point-dtypes
numeric-literalSEGMENT LENGTH valuesSEGMENT TYPE values
nameExamples

case

 Specifies whether the letters in a string data type are uppercase,
 lowercase, or neither.


 ──┬──> 
C
A
S
E
I
N
S
E
N
S
I
T
I
V
E  ─┬──>
   ├──> 
L
O
W
E
R
C
A
S
E ─────────┤
   └──> 
U
P
P
E
R
C
A
S
E ─────────┘

Additional information available:

Examples

 The following example shows two commands.  In the first command, the
 DEFINE FIELD command specifies an ALPHABETIC data type field attribute
 for the field definition LAST_NAME, which consists of 26 uppercase
 letters.

 In the second command, the SHOW FIELD command displays the data type
 for the field definition LAST_NAME.


 CDO> DEFINE FIELD LAST_NAME
 cont> DATATYPE IS ALPHABETIC
 cont> SIZE IS 26 UPPERCASE CHARACTERS

 CDO> SHOW FIELD LAST_NAME
 Definition of field LAST_NAME
 |   Datatype                 alphabetic size is 26 uppercase characters

 The following example shows two commands.  In the first command, the
 DEFINE FIELD command specifies VARYING STRING data type field attribute
 for the field definition ADDRESS which consists of 50 upper and
 lowercase letters.

 In the second command, the SHOW FIELD command displays the data type
 for the field definition ADDRESS.

 CDO> DEFINE FIELD STREET_ADDRESS
 cont> DATATYPE VARYING STRING
 cont> SIZE 50 CASE_INSENSITIVE CHARACTERS.

 CDO> SHOW FIELD STREET_ADDRESS
 Definition of field STREET_ADDRESS
 |   Datatype              varying string size is 50 case_insensitive characters

decimal-string-dtypes

 decimal-string-dtypes=

 ───────────┬─> 
L
E
F
T ──┬────────┬> 
S
E
P
A
R
A
T
E 
N
U
M
E
R
I
C ────┬┬────┐
            ├─> 
R
I
G
H
T ─┘        └> 
O
V
E
R
P
U
N
C
H
E
D 
N
U
M
E
R
I
C ─┘│    │
            ├─> 
P
A
C
K
E
D 
D
E
C
I
M
A
L ──────────────────────────┤    │
            ├─> 
Z
O
N
E
D 
N
U
M
E
R
I
C ───────────────────────────┤    │
            └─> 
U
N
S
I
G
N
E
D 
N
U
M
E
R
I
C ────────────────────────┘    │
       ┌─────────────────────<────────────────────────────────┘
       └┬───────────────────>─────────────────┬──┬─────>─────┬─>
        └> typebox (S)typebox (I)typebox (Z)typebox (E) typebox (I)typebox (S) ─> numeric-literal DIGITS ─┘  └> 
S
C
A
L
E n ─┘

Additional information available:

nnumeric-literalExample

n

 A signed integer in the range -128 to 127.  You can specify a SCALE as
 an implied exponent.  The SCALE specification indicates the number of
 places to shift the decimal point when the field is evaluated.
 Negative n indicates a shift of n places to the left, and positive n
 indicates a shift of n places to the right.

numeric-literal

 The number of DIGITS that will be allowed in the field.  The number of
 digits must be greater than 0 and less than 32.

Example

 The following command defines a field ACCOUNT_BALANCE with the SIGNED
 NUMERIC data type:

 CDO> DEFINE FIELD ACCOUNT_BALANCE
 cont> DATATYPE IS SIGNED NUMERIC
 cont> SIZE IS 9 DIGITS.
 CDO>

floating-point-dtypes

 floating-point-dtypes=

 ─┬─> 
D
F
L
O
A
T
I
N
G ─┬───┬──────>─────┬──┬────────>──────┬───>
  ├─> 
F
F
L
O
A
T
I
N
G ─┤   └─> 
C
O
M
P
L
E
X ─┘  └─> 
S
C
A
L
E ─> n ─┘
  ├─> 
G
F
L
O
A
T
I
N
G ─┤
  └─> 
H
F
L
O
A
T
I
N
G ─┘

Additional information available:

nExample

n

 A signed integer in the range -128 to 127.  You can specify a SCALE as
 an implied exponent.  The SCALE specification indicates the number of
 places to shift the decimal point when the field is evaluated.
 Negative n indicates a shift of n places to the left, and positive n
 indicates a shift of n places to the right.

Example

 The following example defines the field STANDARD_DEVIATION with the
 H_FLOATING data type:

 CDO> DEFINE FIELD STANDARD_DEVIATION
 cont> DATATYPE IS H_FLOATING.
 CDO>

fixed-point-dtypes

 fixed-point-dtypes=

 ──────────────┬─────>───────┬───┬─> 
B
Y
T
E ─────┬────────┐
               ├─> 
S
I
G
N
E
D ───┤   ├─> 
W
O
R
D ─────┤        │
               └─> 
U
N
S
I
G
N
E
D ─┘   ├─> 
L
O
N
G
W
O
R
D ─┤        │
                                 ├─> 
Q
U
A
D
W
O
R
D ─┤        │
                                 └─> 
O
C
T
A
W
O
R
D ─┘        │
 ┌────────────────────────<─────────────────────────────┘
 └┬─────────────────>───────────────────┬──┬───────>───────┬─>
  └> typebox (S)typebox (I)typebox (Z)typebox (E) typebox (I)typebox (S) ─> numeric-literal DIGITS ─┘  └─> 
S
C
A
L
E ─> n ─┘

Additional information available:

nnumeric-literalExample

n

 A signed integer in the range -128 to 127.  You can specify a SCALE as
 an implied exponent.  The SCALE specification indicates the number of
 places to shift the decimal point when the field is evaluated.
 Negative n indicates a shift of n places to the left, and positive n
 indicates a shift of n places to the right.

numeric-literal

 The number of DIGITS that will be allowed in the field.  The number of
 digits must be greater than 0 and less than 32.

Example

 The following command defines a field NEW_MEMBERS with the UNSIGNED
 LONGWORD data type:

 CDO> DEFINE FIELD NEW_MEMBERS
 cont> DATATYPE IS UNSIGNED LONGWORD 3.
 CDO>

numeric-literal

 The number of characters or bytes in the field being defined, or the
 number of bytes in a string segment in a field with a data type of
 SEGMENTED STRING.  In a SEGMENT_TYPE clause, a number representing the
 segment type.

 The SEGMENTED STRING data type is supported by DSRI-compliant
 databases.

SEGMENT LENGTH values

 The maximum size of a string segment is 64K bytes.  If you do not
 specify a SEGMENT_LENGTH, the default segment length is 512 bytes.
 SEGMENT_LENGTH corresponds to RDB$LENGTH.

SEGMENT TYPE values

 The following table shows valid values for SEGMENT_TYPE.

 +----------------+--------------------------------------+
 |   Value        | Meaning                              |
 +----------------+--------------------------------------+
 | 0              | The contents of the segmented string |
 |                | are unspecified.                     |
 | 1              | The segmented string contains text.  |
 | 2              | The segmented string contains Binary |
 |                | Language Representation statements.  |
 | Greater than 2 | Reserved for use by Digital.         |
 | Less than 0    | Reserved for use by customers.       |
 +----------------+--------------------------------------+

 SEGMENT_TYPE corresponds to RDB$VALUE.

name

 The name of a structure that is used to provide a path to an entity.

Examples

 The following command defines a field BEST_SELLER with the TEXT data
 type:

 CDO> DEFINE FIELD BEST_SELLER
 cont> DATATYPE IS TEXT 40.
 CDO>

 The following command removes the DATATYPE attribute from the field
 BEST_SELLER:

 CDO> CHANGE FIELD BEST_SELLER
 cont> NODATATYPE.
 CDO>

EDIT_STRING

 Provides a format that is followed when a field's value is displayed.


 ───┬───────>─────┬──>  
E
D
I
T
S
T
R
I
N
G typebox (I)typebox (S) ─────> edit-string ────>
    └> language ──┘

 language=

 ─────┬───> 
C
O
B
O
L ───┬────>
      ├───> 
D
T
R ─────┤
      ├───> 
P
L
I ─────┤
      └───> 
R
P
G ─────┘

Additional information available:

edit-stringlanguageExamples

edit-string

 An edit string.  See the the top-level topic "edit-str" for a
 description of valid CDO edit strings.

language

 A language that can be specified in a language-specific edit string.
 If you do not specify a language, a generic edit string is created.
 For more information on language-specific edit strings and generic edit
 strings, see the subtopic "more_info".

Additional information available:

more info

 A generic edit string is used by all of the languages that support edit
 strings (COBOL, DATATRIEVE, PL/I, and RPG).

 A language-specific edit string is used only by the language you
 specify.  A COBOL edit string, for example, is used only by COBOL.
 DATATRIEVE, PL/I, and RPG ignore a COBOL edit string.

 You should create a language-specific edit string if:

 1.  One or more characters in the generic edit string cannot be
     translated into valid edit string characters for a language that
     uses the generic edit string.  See the top-level topic "edit-str"
     for a table that shows how CDO translates characters in a generic
     edit string for COBOL, DATATRIEVE, PL/I, and RPG.

 2.  A language that uses the generic edit string does not support the
     data type of the field definition that contains the generic edit
     string.


 When you specify a language-specific edit string for a field definition
 that already contains a generic edit string, the language-specific edit
 overrides the generic edit string for the specified language.  For
 example, if a generic edit string exists and you specify a COBOL
 language-specific edit string, COBOL will always use the COBOL
 language-specific edit string, not the generic edit string.

 If you define only language-specific edit strings, those languages for
 which you do not specify a language-specific edit string will not have
 edit strings.

 Should your programs fail to compile because of edit string or data
 type errors, the language may not support the generic edit string.  In
 such cases, you should create a language-specific edit string to
 exclude this language from accessing the generic edit string.

 To remove a language-specific edit string, the language keyword must
 precede the NOEDIT_STRING keyword.

Examples

 In the following example, the EDIT_STRING attribute clause determines
 that the TRANS_DATE field will be displayed as a series of three
 2-digit numbers in the format month/day/year.

 CDO> DEFINE FIELD TRANS_DATE
 cont> DATATYPE IS DATE
 cont> EDIT_STRING IS NN"/"DD"/"YY.
 CDO>

 The following command removes the EDIT_STRING attribute from the field
 TRANS_DATE:

 CDO> CHANGE FIELD TRANS_DATE
 cont> NOEDIT_STRING.
 CDO>

 In the following example, COBOL and DATATRIEVE programs use the field
 definition DTR_FIELD.  In this case, the user specified a DATATRIEVE
 language-specific edit string because COBOL does not support an edit
 string for dates.

 The output from this DATATRIEVE language-specific edit string displays
 the date in a month/day/year format.

 CDO> DEFINE FIELD DTR_FIELD
 cont> DATATYPE IS DATE
 cont> DTR EDIT_STRING IS NN"/"DD"/"YY.
 CDO>

 In the following example, the SHOW FIELD command displays the
 DATATRIEVE edit string for the field definition DTR_FIELD:

 CDO> SHOW FIELD DTR_FIELD
 Definition of field DTR_FIELD
 |   Datatype                 date
 |   DTR Edit_string          NN"/"DD"/"YY
 CDO>

 In the following example, the DTR NOEDIT_STRING keywords remove the
 language-specific DATATRIEVE EDIT_STRING field attribute from the field
 definition DTR_FIELD:

 CDO> CHANGE FIELD DTR_FIELD
 cont> DTR NOEDIT_STRING
 CDO>

FILLER

 The FILLER field attribute is used to create an unnamed field
 definition.

 ─> 
F
I
L
L
E
R ──>

 Unnamed field attributes are similar to FILLER fields in COBOL.  You
 can use them to format print records or to reserve space in a record
 for future additions.

 When you specify the FILLER field attribute, the value of the field
 definition's processing name (CDD$PROCESSING_NAME) attribute is left
 null.  For more information on the CDD$PROCESSING_NAME attribute, see
 the VAX CDD/Plus Call Interface Manual.

Additional information available:

 The following command creates an unnamed field definition by using the
 FILLER keyword:

 CDO> DEFINE FIELD BLANKS
 cont> DATATYPE IS TEXT 30 FILLER.
 CDO>

INITIAL_VALUE

 Declares a field's value when the field is first allocated.


 ──> 
I
N
I
T
I
A
L
V
A
L
U
E typebox (I)typebox (S) ────> value-expr ──────────────>

Additional information available:

value-expr

 Must be a valid expression for the layered product that will evaluate
 it.  See the help on the subtopic "value_expr" under the top-level
 topic "expressions" for a description and diagram of CDO value
 expressions.

Examples

 The following example shows how to give the field AMOUNT an
 INITIAL_VALUE of 0:

 CDO> DEFINE FIELD AMOUNT
 CDO> DATATYPE IS UNSIGNED NUMERIC
 cont> SIZE IS 8 DIGITS
 cont> INITIAL_VALUE IS 0.
 CDO>

 The following command removes the INITIAL_VALUE attribute from field
 AMOUNT:

 CDO> CHANGE FIELD AMOUNT
 cont> NOINITIAL_VALUE.
 CDO>

JUSTIFIED

 Specifies how text fills the storage space allocated to a field.


 ────> 
J
U
S
T
I
F
I
E
D  ────> justified-option ───>

 justified-option=

 ───┬> 
R
I
G
H
T ──┬──>
    ├> 
L
E
F
T ───┤
    └> 
C
E
N
T
E
R ─┘

Additional information available:

justified-optionExamples

justified-option

 One of the following options of the JUSTIFIED field attribute:


  o  RIGHT, which truncates or fills a TEXT field from the left.

  o  LEFT, which truncates or fills a TEXT field from the right.

  o  CENTER, which centers a TEXT field.


 Only VAX COBOL supports the JUSTIFIED RIGHT attribute clause.  Other
 language processors ignore it.  For fields with the JUSTIFIED RIGHT
 clause, VAX COBOL stores as much of the right portion of the string as
 it can.  If there is remaining storage space to the left of the string,
 VAX COBOL fills it with blanks.

Examples

 The following command allocates space for 15 characters of text that
 will be right-justified by COBOL:

 CDO> DEFINE FIELD STREET
 cont> DATATYPE IS TEXT 15
 cont> NAME FOR COBOL IS C_STREET
 cont> JUSTIFIED RIGHT.
 CDO>

 The following example shows how COBOL stores the strings "137
 Smithsonian Avenue," "15 Maple Street", and "6 Oak Street" in the field
 STREET from the previous example (the underscores represent blanks that
 COBOL enters to fill the 15 characters allocated for field STREET):

 thsonian Avenue
 15 Maple Street
 ___6 Oak Street

 The following command deletes the RIGHT_JUSTIFIED attribute from the
 field STREET:

 CDO> CHANGE FIELD STREET
 cont> NOJUSTIFIED.
 CDO>

MISSING_VALUE

 Specifies a value to use if a field has not been assigned a meaningful
 value.  A language processor uses this value in reports or displays
 only when the field does not contain a meaningful value.

 See the DATATRIEVE or Rdb/VMS documentation for more information on how
 those products interpret MISSING_VALUE clauses.


 ──> 
M
I
S
S
I
N
G
V
A
L
U
E typebox (I)typebox (S) ────> value-expr ──────────>

Additional information available:

query-namequoted-stringExamples

value-expr

 A value expression.  This must be a valid expression for the product
 that will evaluate it.  See the subtopic "value_expr" under the
 top-level topic "expressions" for a description and diagram of CDO
 value expressions.

Examples

 The following example assigns a missing value of 0 to the field PRICE.
 A PRICE of 0 indicates that the value for PRICE is missing; fields with
 PRICE equal to 0 are ignored when calculations are performed involving
 the PRICE field.

 CDO> DEFINE FIELD PRICE
 cont> DATATYPE IS SIGNED NUMERIC
 cont> SIZE IS 8 DIGITS
 cont> MISSING_VALUE IS 0.
 CDO>

 The following command removes the MISSING_VALUE attribute from the
 field PRICE:

 CDO> CHANGE FIELD PRICE
 cont> NOMISSING_VALUE.
 CDO>

language

 A language that can be specified in a language-specific edit string.
 If you do not specify a language, a generic edit string is created.
 For more information on language-specific edit strings and generic edit
 strings, see the subtopic "more_info".

 language=

 ──┬─> 
C
O
B
O
L ───┬─────>
   ├─> 
D
T
R ─────┤
   ├─> 
P
L
I ─────┤
   └─> 
R
P
G ─────┘

Additional information available:

more info

 A generic edit string is used by all of the languages that support edit
 strings (COBOL, DATATRIEVE, PL/I, and RPG).

 A language-specific edit string is used only by the language you
 specify.  A COBOL edit string, for example, is used only by COBOL.
 DATATRIEVE, PL/I, and RPG ignore a COBOL edit string.

 You should create a language-specific edit string if:

 1.  One or more characters in the generic edit string cannot be
     translated into valid edit string characters for a language that
     uses the generic edit string.  See the top-level topic "edit-str"
     for a table that shows how CDO translates characters in a generic
     edit string for COBOL, DATATRIEVE, PL/I, and RPG.

 2.  A language that uses the generic edit string does not support the
     data type of the field definition that contains the generic edit
     string.


 When you specify a language-specific edit string for a field definition
 that already contains a generic edit string, the language-specific edit
 overrides the generic edit string for the specified language.  For
 example, if a generic edit string exists and you specify a COBOL
 language-specific edit string, COBOL will always use the COBOL
 language-specific edit string, not the generic edit string.

 If you define only language-specific edit strings, those languages for
 which you do not specify a language-specific edit string will not have
 edit strings.

 Should your programs fail to compile because of edit string or data
 type errors, the language may not support the generic edit string.  In
 such cases, you should create a language-specific edit string to
 exclude this language from accessing the generic edit string.

 To remove a language-specific edit string, the language keyword must
 precede the NOEDIT_STRING keyword.

NAME

 Declares a facility-specific name for a field.  The specified language
 or language processor then recognizes only this name for the field.
 The NAME field attribute clause has the same syntax and function as the
 NAME record attribute clause.




 ───────────────> 
N
A
M
E 
F
O
R language IS name ───────────────>


 language=

 ──────────┬──> 
B
A
S
I
C ────┬────────────────────────────────>
           ├──> 
C
O
B
O
L ────┤
           ├──> 
P
L
I ──────┤
           └──> 
R
P
G ──────┘

Additional information available:

nameExamples

name

 The facility-specific field name.

Examples

 The following example provides a VAX COBOL name for the ORDER_NUMBER
 field.  Because of the NAME clause, VAX COBOL recognizes the field only
 by the name ORDER-NUMBER:

 CDO> DEFINE FIELD ORDER_NUMBER
 cont> DATATYPE IS UNSIGNED NUMERIC
 cont> SIZE IS 10 DIGITS
 cont> NAME FOR COBOL IS ORDER-NUMBER.
 CDO>

 The following command removes the NAME FOR COBOL attribute from the
 field ORDER_NUMBER:

 CDO> CHANGE FIELD ORDER_NUMBER
 cont> NONAME FOR COBOL.
 CDO>

OCCURS

 Declares fixed-length, one-dimensional arrays.


 occurs-phrase=

 ──> 
O
C
C
U
R
S ───> n ──> typebox (T)typebox (I)typebox (M)typebox (E)typebox (S) ─────────────>

Additional information available:

nExamples

n

 The number of occurrences of the array.

Examples

 The following command defines a field MULTIPLE that occurs 3 times:

 CDO> DEFINE FIELD MULTIPLE
 cont> OCCURS 3 TIMES
 cont> DATATYPE IS SIGNED LONGWORD.
 CDO>

 The following command removes the OCCURS attribute from the field
 MULTIPLE:

 CDO> CHANGE FIELD MULTIPLE
 cont> NOOCCURS.
 CDO>

QUERY_HEADER

 Provides a label to be used as a column heading for a field in
 printouts and reports.


 ──> 
Q
U
E
R
Y
H
E
A
D
E
R typebox (I)typebox (S) ──────────┬─> quoted-string ──┬───────>
                               └───────── , <──────┘

Additional information available:

quoted-stringExamples

quoted-string

 The query header.

Examples

 The following command provides the query header TOTAL PRICE for the
 field TOTAL_PRICE:

 CDO> DEFINE FIELD TOTAL_PRICE
 cont> DATATYPE IS UNSIGNED LONGWORD
 cont> COMPUTED BY UNIT_PRICE * QUANTITY
 cont> QUERY_HEADER IS "TOTAL PRICE".
 CDO>

 The following command changes the query header in the TOTAL_PRICE field
 to "TOTAL."

 CDO> CHANGE FIELD TOTAL_PRICE
 cont> QUERY_HEADER IS "TOTAL".
 CDO>

 The following command removes the QUERY_HEADER attribute from the field
 TOTAL_PRICE:

 CDO> CHANGE FIELD TOTAL_PRICE
 cont> NOQUERY_HEADER.
 CDO>

QUERY_NAME

 Provides an alternate reference name for a field.  Currently, this
 clause is used only by VAX DATATRIEVE.


 ──> 
Q
U
E
R
Y
N
A
M
E typebox (I)typebox (S) ──┬─> quoted-string ──┬──────────>
                     └─> query-name ─────┘

Additional information available:

query-name

 A string that you want to use as a query name.

quoted-string

 A string that you want to use as a query name.  The string itself (not
 the quotation marks that enclose it) will be used as a query name.

Examples

 In the following example, the QUERY_NAME clause specifies TP as an
 alternate name for the field TOTAL_PRICE:

 CDO> DEFINE FIELD TOTAL_PRICE
 cont> DATATYPE IS UNSIGNED LONGWORD
 cont> COMPUTED BY UNIT_PRICE * QUANTITY
 cont> QUERY_NAME IS "TP".
 CDO>

 You could also have specified TP as an alternate name for the field
 TOTAL_PRICE without using quotation marks around the alternate name:

 CDO> DEFINE FIELD TOTAL_PRICE
 cont> DATATYPE IS UNSIGNED LONGWORD
 cont> COMPUTED BY UNIT_PRICE * QUANTITY
 cont> QUERY_NAME IS TP.
 CDO>

 The following command changes the query name in the field TOTAL_PRICE
 to "TOT."

 CDO> CHANGE FIELD TOTAL_PRICE
 cont> QUERY_NAME IS "TOT".
 CDO>

 The following command removes the QUERY_NAME attribute from the field
 TOTAL_PRICE:

 CDO> CHANGE FIELD TOTAL_PRICE
 cont> NOQUERY_NAME.
 CDO>

VALID

 VALID IF checks values assigned to a field to ensure that they are in
 the acceptable range for the field.


 ──> 
V
A
L
I
D 
I
F ─────> cond-expr ────────>

Additional information available:

cond-exprExamples

cond-expr

 The conditional expression that forms the validation expression.  The
 conditional expression must be a valid expression for the product that
 will be evaluating it.  See the subtopic "conditional_expr" under the
 top-level topic "expressions" for a description and diagram of CDO
 conditional expressions.

Examples

 The VALID IF clause in the following command specifies that only values
 greater than zero can be assigned to field AMOUNT_OWED.

 CDO> DEFINE FIELD AMOUNT_OWED
 cont> DATATYPE IS UNSIGNED WORD
 cont> VALID IF AMOUNT_OWED > 0.
 CDO>

 The following command removes the VALID IF attribute from the field
 AMOUNT_OWED:

 CDO> CHANGE FIELD AMOUNT_OWED
 cont> NOVALID IF.
 CDO>

file-def-attr

 Define file characteristics and certain run-time options.  For a
 description and valid values for each of the keywords in the following
 diagram, see the reference manual for the VAX Record Management
 Services in the VAX/VMS documentation set.

 file-definition-attributes=

 ─┬─> 
A
L
L
O
C
A
T
I
O
N numeric-literal ────────────────────────────────┬─>
  ├─> 
B
U
C
K
E
T
S
I
Z
E numeric-literal ───────────────────────────────┤
  ├─> 
M
T
B
L
O
C
K
S
I
Z
E numeric-literal ─────────────────────────────┤
  ├─> 
G
L
O
B
A
L
B
U
F
F
E
R
C
O
U
N
T numeric-literal ───────────────────────┤
  ├─> 
M
A
X
R
E
C
O
R
D
N
U
M
B
E
R numeric-literal ─────────────────────────┤
  ├─> 
M
A
X
R
E
C
O
R
D
S
I
Z
E numeric-literal ───────────────────────────┤
  ├─> 
F
I
L
E
P
R
O
C
E
S
S
I
N
G
O
P
T
I
O
N
S ─┬─┬─────────────>───────────────┬─┤
  ├─> 
F
O
P ─────────────────────┘ └┬> file-processing-options ─┬┘ │
  │                               └──────────── , <───────────┘  │
  ├─> 
O
R
G
A
N
I
Z
A
T
I
O
N file-organization-options ────────────────────┤
  └─> file-access-block-attributes ──────────────────────────────┘

Additional information available:

numeric-literalfile-processing-optionsfile-organization-optionsfile-access-block-attributes
TableExamples

numeric-literal

 A positive integer.  See the reference manual for VAX Record Management
 Services in the VAX/VMS documentation set for the valid values for a
 particular keyword from the syntax diagram.  For a mapping of keywords
 to the corresponding RMS Symbolic Field Offset see the subtopic
 "Table".

file-processing-options

 Define optional file specifications for a program.  The file processing
 options fall into the following seven functional categories:

  o  Allocation and extension options.  See the subtopic
     "allocation_table" for a list of these options.

  o  File disposition options.  See the subtopic "file_disp_table" for a
     list of these options.

  o  File name parsing modifiers.  See the subtopic "file_name_table"
     for a list of these options.

  o  Magnetic tape processing options.  See the subtopic
     "magnetic_table" for a list of these options.

  o  Nonstandard processing options.  See the subtopic
     "nonstandard_table" for a list of these options.

  o  Performance options.  See the subtopic "performance_table" for a
     list of these options.

  o  Reliability options.  See the subtopic "reliability_table" for a
     list of these options.

Additional information available:

allocation tablefile disp tablefile name tablemagnetic table
nonstandard tableperformance tablereliability table

allocation table

 The following table shows the mapping of CDO Allocation and Extension
 Options to RMS Symbolic Bit Offsets:

 Name of CDO Option            RMS Symbolic Bit Offset

 BEST_TRY_CONTIGUOUS           FAB$V_CBT
 CONTIGUOUS                    FAB$V_CTG
 TRUNCATE_ON_CLOSE             FAB$V_TEF

 The following area attributes will override the file processing options
 BEST_TRY_CONTIGUOUS and CONTIGUOUS, should you specify both:

  o  XAB$V_CBT (BEST_TRY_CONTIGUOUS) overrides FAB$V_CBT
     (BEST_TRY_CONTIGUOUS).

  o  XAB$V_CTG (CONTIGUOUS) overrides FAB$V_CTG (CONTIGUOUS).

Additional information available:

 The following example shows the file processing option
 BEST_TRY_CONTIGUOUS for the RMS database definition EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE EMPLOYEE_INFO DESCRIPTION IS "INFORMATION ON"
 cont> "CURRENT EMPLOYEE".
 cont>      RECORD EMPLOYEE_REC.
 cont>         FILE_DEFINITION
 cont>            FILE_PROCESSING_OPTIONS BEST_TRY_CONTIGUOUS
        .
        .
        .
 cont> END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

file disp table

 The following table shows the mapping of CDO File Disposition Options
 to RMS Symbolic Bit Offsets:

 Name of CDO Option            RMS Symbolic Bit Offset

 DELETE_ON_CLOSE               FAB$V_DLT
 PRINT_ON_CLOSE                FAB$V_SPL
 SUBMIT_ON_CLOSE               FAB$V_SCF
 TEMPORARY                     FAB$V_TMD
 NO_DIRECTORY_ENTRY            FAB$V_TMP

file name table

 The following table shows the mapping of CDO File Name Parsing
 Modifiers to RMS Symbolic Bit Offsets:

 Name of CDO Option            RMS Symbolic Bit Offset

 CREATE_IF                     FAB$V_CIF
 MAXIMIZE_VERSION              FAB$V_MXV
 SUPERSEDE                     FAB$V_SUP

Additional information available:

 The following example shows the file processing options CREATE_IF and
 DEFERRED_WRITE for the RMS database definition MORE_EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE MORE_EMPLOYEE_INFO DESCRIPTION IS "DATA ON"
 cont> "CURRENT EMPLOYEES".
 cont>      RECORD EMPLOYEE_REC.
 cont>          FILE_DEFINITION
 cont>              FOP CREATE_IF, DEFERRED_WRITE
        .
        .
        .
 cont> END MORE_EMPLOYEE_INFO RMS_DATABASE.
 CDO>

magnetic table

 The following table shows the mapping of CDO Magnetic Tape Processing
 Options to RMS Symbolic Bit Offsets:

 Name of CDO Option            RMS Symbolic Bit Offset

 MT_NOT_EOF                    FAB$V_NEF
 MT_CURRENT_POSITION           FAB$V_POS
 MT_CLOSE_REWIND               FAB$V_RWC
 MT_OPEN_REWIND                FAB$V_RWO

nonstandard table

 The following table shows the mapping of CDO Nonstandard Processing
 Options to RMS Symbolic Bit Offsets:

 Name of CDO Option            RMS Symbolic Bit Offset

 NON_FILE_STRUCTURED           FAB$V_NFS
 USER_FILE_OPEN                FAB$V_UFO

performance table

 The following table shows the mapping of CDO Performance Options to RMS
 Symbolic Bit Offsets:

 Name of CDO Option            RMS Symbolic Bit Offset

 DEFERRED_WRITE                FAB$V_DFW
 SEQUENTIAL_ONLY               FAB$V_SQO

Additional information available:

 The following example shows the file processing options CREATE_IF and
 DEFERRED_WRITE for the RMS database definition MORE_EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE MORE_EMPLOYEE_INFO DESCRIPTION IS "DATA ON"
 cont> "CURRENT EMPLOYEES".
 cont>      RECORD EMPLOYEE_REC.
 cont>          FILE_DEFINITION
 cont>              FOP CREATE_IF, DEFERRED_WRITE
        .
        .
        .
 cont> END MORE_EMPLOYEE_INFO RMS_DATABASE.
 CDO>

reliability table

 The following table shows the mapping of CDO Reliability Options to RMS
 Symbolic Bit Offsets:

 Name of CDO Option            RMS Symbolic Bit Offset

 READ_CHECK                    FAB$V_RCK
 WRITE_CHECK                   FAB$V_WCK

file-organization-options

 Define the organization of the file.  For a description and valid
 values for each of the keywords in the following diagram, see the
 reference manual for the VAX Record Management Services in the VAX/VMS
 documentation set.  For a mapping of keywords to the corresponding
 FAB$B_ORG Symbolic Constant, see the subtopic "Table".

 file-organization-options=

 ─┬─> 
I
N
D
E
X
E
D  ───┬─>
  ├─> 
R
E
L
A
T
I
V
E  ──┤
  └─> 
S
E
Q
U
E
N
T
I
A
L ─┘

Additional information available:

numeric-literalaccess-modefile-access-control-optionscarriage-control-options
record-format-optionsshare-optionsTableExamples

Table

 The following table shows the mapping of CDO File Organization Options
 to FAB$B_ORG Symbolic Constants:

 Name of CDO Option            FAB$B_ORG Symbolic Constant

 INDEXED                       FAB$C_INX
 RELATIVE                      FAB$C_REL
 SEQUENTIAL                    FAB$C_SEQ

 The default option is SEQUENTIAL.

Examples

 The following example shows the file organization option INDEXED for
 the RMS database definition EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE EMPLOYEE_INFO DESCRIPTION IS "INFORMATION ON"
 cont> "CURRENT EMPLOYEE".
 cont>      RECORD EMPLOYEE_REC.
 cont>         FILE_DEFINITION
 cont>            ORGANIZATION INDEXED
        .
        .
        .
 cont> END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

 The following example shows the file organization option INDEXED for
 the RMS database definition MORE_EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE MORE_EMPLOYEE_INFO DESCRIPTION IS "DATA ON"
 cont> "CURRENT EMPLOYEES".
 cont>      RECORD EMPLOYEE_REC.
 cont>          FILE_DEFINITION
 cont>              ORGANIZATION INDEXED
        .
        .
        .
 cont> END MORE_EMPLOYEE_INFO RMS_DATABASE.
 CDO>

file-access-block-attributes

 Specify file access characteristics and certain run-time options.  For
 a description and valid values for each of the keywords in the
 following diagram, see the reference manual for the VAX Record
 Management Services in the VAX/VMS documentation set.  For a mapping of
 keywords to the corresponding RMS Symbolic Field Offset see the
 subtopic "Table".

 file-access-block-attributes=

 ─┬─> 
E
X
T
E
N
S
I
O
N numeric-literal ────────────────────┬─>
  ├─> 
C
O
N
T
R
O
L
F
I
E
L
D
S
I
Z
E numeric-literal ───────────┤
  ├─> 
L
O
G
I
C
A
L
N
A
M
E
M
O
D
E access-mode ────────────────┤
  ├─> 
W
I
N
D
O
W
S
I
Z
E numeric-literal ──────────────────┤
  ├─> 
C
H
A
N
N
E
L
A
C
C
E
S
S
M
O
D
E access-mode ──────────────┤
  ├─> 
A
C
C
E
S
S ─┬─┬─────────────────>────────────────┬┤
  ├─> 
F
A
C ────┘ └─┬> file-access-control-options ─┬┘│
  │               └────────────── , <─────────────┘ │
  ├─> 
C
A
R
R
I
A
G
E
C
O
N
T
R
O
L carriage-control-options ────┤
  ├─> 
B
L
O
C
K
S
P
A
N  ──────────────────────────────────┤
  ├─> 
F
O
R
M
A
T record-format-options ─────────────────┤
  └─> 
S
H
A
R
I
N
G ───┬──────────>─────────┬─────────────┘
                 └┬> share-options ─┬─┘
                  └─────── , <──────┘

Additional information available:

numeric-literal

 A positive integer.  See the reference manual for VAX Record Management
 Services in the VAX/VMS documentation set for the valid values for a
 particular keyword from the syntax diagram.  For a mapping of keywords
 to the corresponding RMS Symbolic Field Offset see the subtopic
 "Table".

access-mode

 Defines an access mode for a channel.  For a description and valid
 values for each of the keywords in the following diagram, see the
 reference manual for the VAX Record Management Services in the VAX/VMS
 documentation set.  For a mapping of Access Mode Options to the
 corresponding RMS Symbolic Constants, see the subtopic "Table".

 access-mode=

  ─┬─>  
N
O
N
E ───────┬─>
   ├─>  
E
X
E
C
U
T
I
V
E ──┤
   ├─>  
S
U
P
E
R ──────┤
   └─>  
U
S
E
R ───────┘

Additional information available:

TableExample

Table

 The following table shows the mapping of CDO Access Mode Options to
 FAB$V_CHAN_MODE Symbolic Constants:

 Name of CDO Option             Symbolic Constant

 NONE (default)                      0
 EXECUTIVE                      PSL$C_EXEC
 SUPER                          PSL$C_SUPER
 USER                           PSL$C_USER

 NONE is the default value which is interpreted by RMS as the executive
 mode.

Example

 The following example shows the access mode option SUPER for the
 CHANNEL_ACCESS_MODE attribute in the RMS database definition
 EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE EMPLOYEE_INFO DESCRIPTION IS "INFORMATION ON"
 cont> "CURRENT EMPLOYEE".
 cont>      RECORD EMPLOYEE_REC.
 cont>         FILE_DEFINITION
 cont>            CHANNEL_ACCESS_MODE SUPER
        .
        .
        .
 cont> END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

file-access-control-options

 Define the type of record-access operations that a program can perform.
 For a description and valid values for each of the keywords in the
 following diagram, see the reference manual for the VAX Record
 Management Services in the VAX/VMS documentation set.  For a mapping of
 File Access Control Options to the corresponding FAB$B_FAC Symbolic
 Constants, see the subtopic "Table".

 file-access-control-options=

 ─┬─> 
B
L
O
C
K
I
O ──┬─>
  ├─> 
R
E
C
O
R
D
I
O ─┤
  ├─> 
D
E
L
E
T
E ────┤
  ├─> 
G
E
T ───────┤
  ├─> 
P
U
T ───────┤
  ├─> 
T
R
U
N
C
A
T
E ──┤
  └─> 
U
P
D
A
T
E ────┘

Additional information available:

Table

 The following table shows the mapping of CDO File Access Control
 Options to FAB$B_FAC Symbolic Constants:

 Name of CDO Option             FAB$B_FAC Symbolic Constant

 BLOCK_IO                       FAB$V_BIO
 DELETE                         FAB$V_DEL
 GET                            FAV$V_GET
 PUT                            FAV$V_PUT
 RECORD_IO                      FAV$V_BRO
 TRUNCATE                       FAV$V_TRN
 UPDATE                         FAV$V_UPD

Examples

 The following example shows the file access control option RECORD_IO
 for the RMS database definition EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE EMPLOYEE_INFO DESCRIPTION IS "INFORMATION ON"
 cont> "CURRENT EMPLOYEE".
 cont>      RECORD EMPLOYEE_REC.
 cont>         FILE_DEFINITION
 cont>            ACCESS  RECORD_IO
        .
        .
        .
 cont> END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

 The following example shows the file access control option GET for the
 RMS database definition MORE_EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE MORE_EMPLOYEE_INFO DESCRIPTION IS "DATA ON"
 cont> "CURRENT EMPLOYEES".
 cont>      RECORD EMPLOYEE_REC.
 cont>          FILE_DEFINITION
 cont>              ACCESS GET
        .
        .
        .
 cont> END MORE_EMPLOYEE_INFO RMS_DATABASE.
 CDO>

carriage-control-options

 Define the type of record control information for a record.  For a
 description and valid values for each of the keywords in the following
 diagram, see the reference manual for the VAX Record Management
 Services in the VAX/VMS documentation set.  For a mapping of Carriage
 Control Options to the corresponding RMS Symbolic Bit Offsets, see the
 subtopic "Table".

 carriage-control-options=

 ─┬─> 
C
A
R
R
I
A
G
E
R
E
T
U
R
N ─┬─>
  ├─> 
F
O
R
T
R
A
N ─────────┤
  └─> 
P
R
I
N
T ───────────┘

Additional information available:

TableExample

Table

 The following table shows the mapping of CDO Carriage Control Options
 to FAB$B_RAT Symbolic Bit Offsets:

 Name of CDO Option             FAB$B_RAT Symbolic Bit Offset

 CARRIAGE_RETURN (default)      FAB$V_CR
 FORTRAN                        FAB$V_FTN
 PRINT                          FAB$V_PRN

 CARRIAGE_RETURN is the default value for most VAX/VMS programs.

Example

 The following example shows the carriage control option CARRIAGE_RETURN
 for the RMS database definition EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE EMPLOYEE_INFO DESCRIPTION IS "INFORMATION ON"
 cont> "CURRENT EMPLOYEE".
 cont>      RECORD EMPLOYEE_REC.
 cont>         FILE_DEFINITION
 cont>            CARRIAGE_CONTROL CARRIAGE_RETURN
        .
        .
        .
 cont> END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

record-format-options

 Define the format for all the records in a file.  For a description and
 valid values for each of the keywords in the following diagram, see the
 reference manual for the VAX Record Management Services in the VAX/VMS
 documentation set.  For a mapping of keywords to the corresponding
 FAB$B_RFM Symbolic Constant, see the subtopic "Table".

 record-format-options=

 ─┬─> 
F
I
X
E
D  ────┬─>
  ├─> 
S
T
R
E
A
M  ───┤
  ├─> 
S
T
R
E
A
M
C
R ─┤
  ├─> 
S
T
R
E
A
M
L
F ─┤
  ├─> 
U
N
D
E
F
I
N
E
D ─┤
  ├─> 
V
A
R
I
A
B
L
E  ─┤
  └─> 
V
F
C  ──────┘

Additional information available:

Table

 The following table shows the mapping of CDO Record Format Options to
 FAB$B_RFM Symbolic Constants:

 Name of CDO Option            FAB$B_RFM Symbolic Constant

 FIXED                         FAB$C_FIX
 STREAM                        FAB$C_STM
 STREAM_CR                     FAB$C_STMCR
 STREAM_LF                     FAB$C_STMLF
 UNDEFINED                     FAB$C_UDF
 VARIABLE                      FAB$C_VAR
 VFC                           FAB$C_VFC

Examples

 The following example shows the record format option VARIABLE for the
 RMS database definition EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE EMPLOYEE_INFO DESCRIPTION IS "INFORMATION ON"
 cont> "CURRENT EMPLOYEE".
 cont>      RECORD EMPLOYEE_REC.
 cont>         FILE_DEFINITION
 cont>            FORMAT VARIABLE
        .
        .
        .
 cont> END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

 The following example shows the record format option FIXED for the RMS
 database definition MORE_EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE MORE_EMPLOYEE_INFO DESCRIPTION IS "DATA ON"
 cont> "CURRENT EMPLOYEES".
 cont>      RECORD EMPLOYEE_REC.
 cont>          FILE_DEFINITION
 cont>              FORMAT FIXED
        .
        .
        .
 cont> END MORE_EMPLOYEE_INFO RMS_DATABASE.
 CDO>

share-options

 Define the type of record operations that a program will allow other
 programs sharing access to this file to perform.  For a description and
 valid values for each of the keywords in the following diagram, see the
 reference manual for the VAX Record Management Services in the VAX/VMS
 documentation set.  For a mapping of keywords to the corresponding
 FAB$B_SHR Symbolic Bit Offset, see the subtopic "Table".

 share-options=

 ─┬─> 
D
E
L
E
T
E ─────────┬─>
  ├─> 
G
E
T ────────────┤
  ├─> 
M
U
L
T
I
S
T
R
E
A
M  ───┤
  ├─> 
P
R
O
H
I
B
I
T  ──────┤
  ├─> 
P
U
T  ───────────┤
  ├─> 
U
P
D
A
T
E  ────────┤
  └─> 
U
S
E
R
I
N
T
E
R
L
O
C
K ─┘

Additional information available:

area-numbernumeric-literalnull-valuewithin-name-clauseTable
Examples

Table

 The following table shows the mapping of CDO Share Options to FAB$B_SHR
 Symbolic Bit Offsets:

 Name of CDO Option            FAB$B_SHR Symbolic Bit Offset

 DELETE                        FAB$V_SHRDEL
 GET                           FAB$V_SHRGET
 MULTISTREAM                   FAB$V_MSE
 PROHIBIT                      FAB$V_NIL
 PUT                           FAB$V_SHRPUT
 UPDATE                        FAB$V_SHRUPD
 USER_INTERLOCK                FAB$V_UPI

Examples

 The following example shows the share options GET and USER_INTERLOCK
 for the RMS database definition EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE EMPLOYEE_INFO DESCRIPTION IS "INFORMATION ON"
 cont> "CURRENT EMPLOYEE".
 cont>      RECORD EMPLOYEE_REC.
 cont>         FILE_DEFINITION
 cont>            SHARING GET, USER_INTERLOCK
        .
        .
        .
 cont> END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

 The following example shows the share option GET for the RMS database
 definition MORE_EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE MORE_EMPLOYEE_INFO DESCRIPTION IS "DATA ON"
 cont> "CURRENT EMPLOYEES".
 cont>      RECORD EMPLOYEE_REC.
 cont>          FILE_DEFINITION
 cont>              SHARING GET
        .
        .
        .
 cont> END MORE_EMPLOYEE_INFO RMS_DATABASE.
 CDO>

Table

 The following table shows the mapping of keywords for file access block
 (FAB) attributes:

 Name of CDO Attribute          RMS Symbolic Field Offset

 ACCESS                         FAB$B_FAC
 BLOCK_SPAN                     FAB$V_BLK
 CARRIAGE_CONTROL               FAB$B_RAT
 CHANNEL_ACCESS_MODE            FAB$V_CHAN_MODE
 CONTROL_FIELD_SIZE             FAB$B_FSZ
 EXTENSION                      FAB$W_DEQ
 FAC                            FAB$B_FAC
 FORMAT                         FAB$B_RFM
 LOGICAL_NAME_MODE              FAB$V_LNM_MODE
 SHARING                        FAB$B_SHR
 WINDOW_SIZE                    FAB$B_RTV

 The attribute EXTENSION (FAB$W_DEQ) will be overridden by the area
 attribute EXTENSION (XAB$W_DEQ), should you specify both.

Examples

 The following example shows the file access block attributes for the
 RMS database definition EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE EMPLOYEE_INFO DESCRIPTION IS "INFORMATION ON"
 cont> "CURRENT EMPLOYEE".
 cont>      RECORD EMPLOYEE_REC.
 cont>         FILE_DEFINITION
 cont>            CHANNEL_ACCESS_MODE SUPER
 cont>            CARRIAGE_CONTROL CARRIAGE_RETURN
 cont>            ACCESS  RECORD_IO
 cont>            FORMAT VARIABLE
 cont>            SHARING GET, USER_INTERLOCK.
        .
        .
        .
 cont> END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

 The following example shows the file access block attributes for the
 RMS database definition MORE_EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE MORE_EMPLOYEE_INFO DESCRIPTION IS "DATA ON"
 cont>     CURRENT EMPLOYEES".
 cont>         RECORD EMPLOYEE_REC.
 cont>            FILE DEFINITION
        .
        .
        .
 cont>             ACCESS GET
 cont>             SHARING GET
 cont>             BLOCK_SPAN
 cont>             FORMAT FIXED.
        .
        .
        .
 cont> END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

Table

 The following table shows the mapping of keywords for file definition
 attributes:

 Name of CDO Attribute         RMS Symbolic Field Offset

 ALLOCATION                    FAB$L_ALQ
 BUCKET_SIZE                   FAB$B_BKS
 FILE_PROCESSING_OPTIONS       FAB$L_FOP
 FOP                           FAB$L_FOP
 GLOBAL_BUFFER_COUNT           FAB$W_GBC
 MAX_RECORD_NUMBER             FAB$L_MRN
 MAX_RECORD_SIZE               FAB$W_MRS
 MT_BLOCK_SIZE                 FAB$W_BLS
 ORGANIZATION                  FAB$B_ORG

 The attribute BUCKET_SIZE (FAB$B_BKS) will be overridden by the area
 attribute BUCKET_SIZE (XAB$B_BKZ), should you specify both.

Examples

 The following example shows the file definition attributes for the RMS
 database definition EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE EMPLOYEE_INFO DESCRIPTION IS "INFORMATION ON"
 cont> "CURRENT EMPLOYEE".
 cont>      RECORD EMPLOYEE_REC.
 cont>         FILE_DEFINITION
 cont>            ORGANIZATION INDEXED
 cont>            FILE_PROCESSING_OPTIONS BEST_TRY_CONTIGUOUS
          .
          .
          .
 cont>  END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

 The following example shows the file definition attributes for the RMS
 database definition MORE_EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE MORE_EMPLOYEE_INFO DESCRIPTION IS "DATA ON"
 cont>     CURRENT EMPLOYEES".
 cont>         RECORD EMPLOYEE_REC.
 cont>             FILE_DEFINITION
 cont>             ORGANIZATION INDEXED
 cont>             FOP CREATE_IF, DEFERRED_WRITE
          .
          .
          .
 cont>  END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

key-attributes

 Define the characteristics of a key in an indexed file.

 See the reference manual for VAX Record Management Services in the
 VAX/VMS documentation set for the valid values for a particular keyword
 from the syntax diagram.  For a mapping of keywords to the
 corresponding RMS Symbolic Field Offset see the subtopic "Table".

 key-attributes=

 ─┬─> 
D
U
P
L
I
C
A
T
E
S  ───────────────────────┬─>
  ├─> 
C
H
A
N
G
E
S  ──────────────────────────┤
  ├─> 
N
U
L
L
K
E
Y ──────────────────────────┤
  ├─> 
N
U
L
L
V
A
L
U
E null-value ─────────────┤
  ├─> 
D
A
T
A
A
R
E
A area-number ─────────────┤
  ├─> 
D
A
T
A
F
I
L
L numeric-literal ─────────┤
  ├─> 
D
A
T
A
K
E
Y
C
O
M
P
R
E
S
S
I
O
N ──────────────┤
  ├─> 
D
A
T
A
R
E
C
O
R
D
C
O
M
P
R
E
S
S
I
O
N ───────────┤
  ├─> 
I
N
D
E
X
A
R
E
A area-number ────────────┤
  ├─> 
I
N
D
E
X
C
O
M
P
R
E
S
S
I
O
N ─────────────────┤
  ├─> 
I
N
D
E
X
F
I
L
L numeric-literal ────────┤
  ├─> 
L
E
V
E
L
1
I
N
D
E
X
A
R
E
A area-number ─────┤
  ├─> 
N
O
D
A
T
A
K
E
Y
C
O
M
P
R
E
S
S
I
O
N ────────────┤
  ├─> 
N
O
D
A
T
A
R
E
C
O
R
D
C
O
M
P
R
E
S
S
I
O
N ─────────┤
  ├─> 
N
O
I
N
D
E
X
C
O
M
P
R
E
S
S
I
O
N ───────────────┤
  ├─> 
P
R
O
L
O
G numeric-literal ────────────┤
  └─> 
S
E
G
M
E
N
T within-name-clause ────────┘

 A segment must be specified for each key you define.  A segmented key
 can contain up to 8 segments.  A key with only 1 segment can point to a
 field that has any allowable RMS datatype.  For keys with more than 1
 segment, each segment must point to a field that has a text datatype.
 See the reference manual for VAX Record Management Services in the
 VAX/VMS documentation set for the valid RMS datatypes.

 When defining a SEGMENT, you cannot use a field that is in the variant
 portion of a record.

 Keys should be defined in numerical order, starting with 0.  By
 default, Key 0 always has a DATA_AREA 0.

 If you specify NULL_VALUE without specifying NULL_KEY, CDO
 automatically specifies NULL_KEY.

 If you specify NULL_KEY without specifying NULL_VALUE, the default
 value for NULL_VALUE is 0.

Additional information available:

area-number

 A positive integer that corresponds to the number of a previously
 defined area.

numeric-literal

 A positive integer.  See the reference manual for VAX Record Management
 Services in the VAX/VMS documentation set for the valid values for a
 particular keyword from the syntax diagram.  For a mapping of keywords
 to the corresponding RMS Symbolic Field Offset see the subtopic
 "Table".

null-value

 Specifies a null key value for an alternate index.  This value must be
 either an integer or a single character within quotation marks.

within-name-clause

 Specifies the name of the field or fields that are part of a segmented
 key.

 within-name-clause=

 ─> name ─┬───────>───────┬──>
          └┬> 
I
N  name  ─┬┘
           └──────<──────┘

 Every key must have at least one segment defined.  A segmented key
 allows you to define a key that accesses non-contiguous fields in a
 record.  You can specify from 2 to 8 segments for each segmented key in
 an indexed file.  For example, you can specify:

  o  A field in a record

  o  A field in a record that is in a record

  o  A field in a structure in a record


 The field definition or definitions specified by the keyword SEGMENT in
 the key-attributes clause determines the datatype of a key.

 A segment must be specified for each key you define.  A segmented key
 contain up to 8 segments.  A key with only one segment can point to a
 field that has any allowable RMS datatype.  For keys with more than one
 segment, each segment must point to a field tha has a text datatype.
 See the reference manual for VAX Record Management Services in the
 VAX/VMS documentation set for the valid RMS datatypes.

 Each segment can contain up to 255 characters, and the sum of all of
 the characters for all of the segment for a key must not exceed 255
 characters.

Additional information available:

nameExamples

name

 Name of an existing field in a record or structure that you want to
 define as part of a segmented key.  The first name you specify must be
 the name of a field and the last name must be the name of a record.
 The record should be the same one that was used to define the data
 structure of the RMS database in the DEFINE RMS_DATABASE command.

Examples

 The following example shows the within-name-clause EMP_ID and LAST_NAME
 for the RMS database definition EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE EMPLOYEE_INFO DESCRIPTION IS "INFORMATION ON"
 cont> "CURRENT EMPLOYEE".
         .
         .
         .
 cont>         KEYS.
 cont>             KEY 0
 cont>                 DATA_AREA 0
 cont>                 INDEX_AREA 0
 cont>                 SEGMENT EMP_ID.
 cont>             KEY 1
 cont>                 DUPLICATES
 cont>                 DATA_AREA 1
 cont>                 INDEX_AREA 1
 cont>                 SEGMENT LAST_NAME.
 cont>         END KEYS.
 cont> END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

 The following example shows the within-name-clause LAST_NAME IN
 FULL_NAME and EMP_ID for the RMS database definition EMPLOYEE_DATABANK.
 LAST_NAME is a field in the record FULL_NAME in the record
 EMPLOYEE_DATA.

 CDO>   DEFINE RMS_DATABASE EMPLOYEE_DATABANK
 cont>  AUDIT IS "INFORMATION ON CURRENT EMPLOYEES".
 cont>      RECORD EMPLOYEE_DATA.
         .
         .
         .
 cont>          KEYS.
 cont>              KEY 0
         .
         .
         .
 cont>                  SEGMENT EMP_ID
 cont>              KEY 1
         .
         .
         .
 cont>                  SEGMENT LAST_NAME IN FULL_NAME.
 cont>  END KEYS.
 cont> END EMPLOYEE_DATABANK RMS_DATABASE.
 CDO>

Table

 The following table shows the mapping of CDO key attributes to the
 corresponding RMS Symbolic Field Offset:

 Name of CDO Attribute          RMS Symbolic Field Offset

 DUPLICATES                     XAB$V_DUP
 CHANGES                        XAB$V_CHG
 NULL_KEY                       XAB$V_NUL
 DATA_AREA                      XAB$B_DAN
 DATA_FILL                      XAB$W_DFL
 DATA_KEY_COMPRESSION           XAB$V_KEY_NCMPR
 DATA_RECORD_COMPRESSION        XAB$V_DAT_NCMPR
 INDEX_AREA                     XAB$B_IAN
 INDEX_COMPRESSION              XAB$V_IDX_NCMPR
 INDEX_FILL                     XAB$W_IFL
 LEVEL1_INDEX_AREA              XAB$B_LAN
 NODATA_KEY_COMPRESSION         XAB$V_KEY_NCMPR
 NODATA_RECORD_COMPRESSION      XAB$V_DAT_NCMPR
 NOINDEX_COMPRESSION            XAB$V_IDX_NCMPR
 PROLOG                         XAB$_PROLOG

Examples

 The following example shows the key attributes for the RMS database
 definition EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE EMPLOYEE_INFO DESCRIPTION IS "INFORMATION ON"
 cont> "CURRENT EMPLOYEE".
         .
         .
         .
 cont>         KEYS.
 cont>             KEY 0
 cont>                 DATA_AREA 0
 cont>                 INDEX_AREA 0
 cont>                 SEGMENT EMP_ID IN EMPLOYEE_REC.
 cont>             KEY 1
 cont>                 DUPLICATES
 cont>                 DATA_AREA 1
 cont>                 INDEX_AREA 2
 cont>                 SEGMENT LAST_NAME IN EMPLOYEE_REC.
 cont>         END KEYS.
 cont> END EMPLOYEE_INFO RMS_DATABASE.
 CDO>

 The following example shows the key attributes for the RMS database
 definition MORE_EMPLOYEE_INFO:

 CDO>  DEFINE RMS_DATABASE MORE_EMPLOYEE_INFO DESCRIPTION IS "DATA ON"
 cont> "CURRENT EMPLOYEES".
         .
         .
         .
 cont>          KEYS.
 cont>              KEY 0
 cont>                  DATA_AREA 0
 cont>                  INDEX_AREA 0
 cont>                  SEGMENT EMP_ID IN EMPLOYEE_REC.
 cont>              KEY 1
 cont>                  DUPLICATES
 cont>                  CHANGES
 cont>                  DATA_AREA 1
 cont>                  INDEX_AREA 2
 cont>                  SEGMENT LAST_NAME IN EMPLOYEE_REC.
 cont>          END KEYS.
 cont> END MORE_EMPLOYEE_INFO RMS_DATABASE.
 CDO>

record-attr

 Record attributes are used in the definition of records.  The following
 diagram shows the valid CDO record attributes.

 record-attributes=

 ──┬─> array-type ────────────────────────────────────┬─────>
   ├─> 
A
U
D
I
T typebox (I)typebox (S) typebox (/)typebox (*) text */ ───────────────────────────┤
   ├─> 
N
A
M
E 
F
O
R language IS name ─────────────────────┤
   └─> occurs-depending-clause ───────────────────────┘

 To remove a record attribute from a record definition, use the CHANGE
 RECORD command and add the prefix NO to the name of the attribute to be
 removed.  The following diagram shows the valid keywords to remove
 record attributes.

 cancel-record-attributes=

 ────────┬─> 
N
O
A
R
R
A
Y ─────────────┬───>
         ├─> 
N
O
N
A
M
E Ftypebox (O)typebox (R) language ─┤
         └─> 
N
O
O
C
C
U
R
S ────────────┘

Additional information available:

ARRAYAUDITNAMEOCCURS...DEPENDING

ARRAY

 Declares multidimensional or one-dimensional arrays.

 array-type=

  ─┬────────>───────┬─> 
A
R
R
A
Y ─┬─┬───>───┬─> n2 ─┬─>
   ├> 
R
O
W
M
A
J
O
R ────┤          │ └> n1: ─┘       │
   └> 
C
O
L
U
M
N
M
A
J
O
R ─┘          └─────────<───────┘

Additional information available:

n1n2Examples

n1

 The lower bound of the subscript.  Replace n1 with a signed integer.

n2

 The upper bound of the subscript.  Replace n2 with a signed integer.

Examples

 In the following example, the ARRAY clause defines the record
 SUPPLIER_REC as an array:

 CDO> DEFINE RECORD SUPPLIER_REC
 cont> ROW_MAJOR ARRAY 1:20.
 cont> END RECORD.
 CDO>

 The following command removes the ARRAY clause from record
 SUPPLIER_REC:

 CDO> CHANGE RECORD SUPPLIER_REC
 cont> NOARRAY.
 cont> END RECORD.
 CDO>

AUDIT

 Allows you to enter comments that will appear in a history list entry
 to a record definition.

 ───> 
A
U
D
I
T typebox (I)typebox (S) typebox (/)typebox (*)  text  */ ───────────────>

Additional information available:

textExamples

text

 Comments that will be included in a history list entry for the record
 definition.

Examples

 The following example shows two commands.  The first command creates
 the record definition PART_RECORD.  The DESCRIPTION clause explains the
 record's purpose.  The AUDIT clause is used to indicate that the record
 will be changed in the future.  The second command shows the history
 list entry for the record definition after the first command executes:

 CDO> DEFINE RECORD PART_RECORD
 cont> DESCRIPTION IS /* SHOWS IF A PART IS IN STOCK */
 cont> AUDIT IS /* THIS IS A TEST RECORD */.
 cont>   PART_NUMBER.
 cont>   IN_STOCK.
 cont> END RECORD.
 CDO>

 CDO> SHOW RECORD/ALL PART_RECORD
 cont> Definition of record PART_RECORD
 cont> |   acl                     (IDENTIFIER=[VCD,RICK],ACCESS=READ
 cont> +WRITE+MODIFY+ERASE+SHOW+DEFINE+CHANGE+DELETE+CONTROL+OPERATOR+
 cont> ADMINISTRATOR)
 cont> (IDENTIFIER=[*,*],ACCESS=READ+WRITE+MODIFY+ERASE+SHOW+OPERATOR+
 cont> ADMINISTRATOR)
 cont> |   Created time             10-JUN-1987 17:00:01.83
 cont> |   Description              ' SHOWS IF A PART IS IN STOCK '
 cont> |   Modified time            10-JUN-1987 17:00:01.83
 cont> |   Owner                    RICK
 cont> |   |   History entered by RICK ([VCD,RICK])
 cont> |   |    using CDO V1.0
 cont> |   |    to CREATE definition on 10-JUN-1987 16:59:58.67
 cont> |   |    Explanation:
 cont> |   |             THIS IS A TEST RECORD
 cont> |   Contains field           PART_NUMBER
 cont> |   |   Datatype                 unsigned longword 6 digits
 cont> |   |   |   History entered by RICK ([VCD,RICK])
 cont> |   |   |        using CDO V1.0
 cont> |   |   |        to CREATE definition on 10-JUN-1987 16:59:38.43
 cont> |   Contains field           IN_STOCK
 cont> |   |   Datatype                 text size is 1 characters
 cont> |   |   |   History entered by RICK ([VCD,RICK])
 cont> |   |   |        using CDO V1.0
 cont> |   |   |        to CREATE definition on 10-JUN-1987 16:59:44.54
 cont> |   |   Valid if                 ((IN_STOCK EQ "Y") OR "N")
 CDO>

 The following example shows two commands.  The first command adds a
 field definition BACK_ORDER to the record PART_RECORD.  The second
 command shows the history list entry for the record definition after
 the first command executes:

 CDO> CHANGE RECORD PART_RECORD
 cont> DESCRIPTION IS /* SHOWS IF A PART IS IN STOCK OR ON ORDER */
 cont> AUDIT IS /* ADDING A NEW FIELD */.
 cont>   DEFINE BACK_ORDER.
 cont>   END BACK_ORDER DEFINE.
 cont> END RECORD.

 CDO> SHOW RECORD/AUDIT PART_RECORD
 cont> Definition of record PART_RECORD
 cont> |   |   History entered by RICK ([VCD,RICK])
 cont> |   |    using CDO V1.0
 cont> |   |    to CREATE definition on 10-JUN-1987 16:59:58.67
 cont> |   |    Explanation:
 cont> |   |             THIS IS A TEST RECORD
 cont> |   |   History entered by RICK ([VCD,RICK])
 cont> |   |    using CDO V1.0
 cont> |   |    to MODIFY on 10-JUN-1987 17:18:05.66
 cont> |   |    Explanation:
 cont> |   |             ADDING A NEW FIELD
 CDO>

 The following example shows the history list entry that would have been
 created for the record definition PART_RECORD if no AUDIT clause had
 been specified during the creation or modification of the object:

 CDO> SHOW RECORD/AUDIT PART_RECORD
 cont> Definition of record PART_RECORD
 cont> |   |   History entered by RICK ([VCD,RICK])
 cont> |   |    using CDO V1.0
 cont> |   |    to CREATE definition on 10-JUN-1987 17:23:25.52
 cont> |   |   History entered by RICK ([VCD,RICK])
 cont> |   |    using CDO V1.0
 cont> |   |    to MODIFY on 10-JUN-1987 17:24:11.74
 CDO>

NAME

 Declares a facility-specific name for a record.  The specified language
 or language processor then recognizes only this name for the record.
 The NAME record attribute clause has the same syntax and function as
 the NAME field attribute clause.



 ───────────────> 
N
A
M
E 
F
O
R language IS name ───────────────>


 language=

 ──────────┬──> 
B
A
S
I
C ────┬────────────────────────────────>
           ├──> 
C
O
B
O
L ────┤
           ├──> 
P
L
I ──────┤
           └──> 
R
P
G ──────┘

Additional information available:

nameExamples

name

 The facility-specific record name.

Examples

 The following command provides a VAX COBOL name for the record
 SUPPLIER_REC.  Because of the NAME clause, VAX COBOL recognizes the
 record only by the name SUPPLIER-REC:

 CDO> DEFINE RECORD SUPPLIER_REC
 cont> ROW_MAJOR ARRAY 1:20
 cont> NAME FOR COBOL IS SUPPLIER-REC.
 cont> END RECORD.
 CDO>

 The following command removes the VAX COBOL name from the record
 SUPPLIER_REC:

 CDO> CHANGE RECORD SUPPLIER_REC
 cont> NONAME FOR COBOL.
 cont> END RECORD.
 CDO>

OCCURS...DEPENDING

 Declares a variable-length, one-dimensional array.

 occurs-depending-clause=

 ─> 
O
C
C
U
R
S ─> n1 ─┬> 
T
O n2 TIMES ─> 
D
E
P
E
N
D
I
N
G typebox (O)typebox (N) ─────────┐
                  │     ┌─────────────────────────────────┘
                  │     └───> name1 ─┬┬───────>────┬┬──────┬───┐
                  │                  │└> 
I
N name2 ─┘│      │   │
                  │                  └───────<──────┘      │   │
                  └>
T
I
M
E
S ──────────────────>──────────────┘   │
               ┌───────────────────────<───────────────────────┘
               └──┬─────────────>──────────────┬───>
                  └──> 
I
N
D
E
X
E
D typebox (B)typebox (Y) index-name ──┘

Additional information available:

n1n2name1name2index-nameExamples

n1

 Start of the range for the number of occurrences.

n2

 End of the range for the number of occurrences.

name1

 The tag variable field, whose value determines the actual number of
 occurrences.

name2

 The name of the entity in which the tag variable field can be found.

index-name

 A VAX COBOL index name.

Examples

 The following command determines how many times a record named
 VACATION_PAY occurs based on the run-time value of the tag variable
 field EXCESS_VACATION in the record EMPLOYEE_BENEFITS:

 CDO> DEFINE RECORD VACATION_PAY OCCURS 1 TO 2 TIMES
 cont> DEPENDING ON EXCESS_VACATION IN EMPLOYEE_BENEFITS.
 cont> EMP_SSAN.
 cont> WEEKLY_SALARY.
 cont> END RECORD.
 CDO>

 The following command removes the OCCURS...DEPENDING clause from the
 record VACATION_PAY:

 CDO> CHANGE RECORD VACATION_PAY
 cont> NOOCCURS.
 cont> END RECORD.
 CDO>

system-attr

 System-specified attributes are those attributes that CDO automatically
 creates for every CDO entity you define.  System-specified attributes
 include the following:

  o  Access control list

  o  Created time

  o  Modified time

  o  Owner


 Compare this to user-defined attributes, explained under the top-level
 topic "user-attr".

Additional information available:

 In the following example, the SHOW FIELD/ALL command displays both the
 user and system-specified attributes for FIELD_B.  Only the datatype
 attribute was specified by the user.

 CDO> SHOW FIELD FIELD_B/ALL
 Definition of field FIELD_B
 |   acl                      (IDENTIFIER=[VCD,MCGUIRE],ACCESS=READ+
 |   WRITE+MODIFY+ERASE+SHOW+DEFINE+CHANGE+DELETE+CONTROL+OPERATOR+ADMINIS
 TRATOR)
 |                            (IDENTIFIER=[*,*],ACCESS=READ+WRITE+MODIFY+E
 RASE+SHOW+OPERATOR+ADMINISTRATOR)
 |   Created time             2-FEB-1988 12:25:00.83
 |   Modified time            2-FEB-1988 12:25:00.83
 |   Owner                    MCGUIRE
 |   Datatype                 signed longword
 |   |   History entered by MCGUIRE ([VCD,MCGUIRE])
 |   |          using CDO V1.0
 |   |          to CREATE definition on  2-FEB-1988 12:24:59.71
 CDO>

user-attr

 User-supplied attributes are those characteristics that you specify
 when you are defining a CDO entity.  The data type attribute is an
 example.  Compare this to system-supplied attributes, explained under
 the top-level topic "system-attr".

Additional information available: