FIND / GET Using Storage Key

Commands and Syntax › FIND / GET Using Storage Key

FIND / GET Using Storage Key

FIND/GET using storage key retrieves records based on their CALC key or dbkey value.

Access mode: The syntax below is invalid when the access switch is set to IDMS.

FIND locates database records but does not retrieve them into the report file. GET locates database records and does retrieve them into the report file.

Syntax:

►►─┬─ FINd ─┬─┬──────────────────────────────┬────────────────────────────────►
   └─ GET ──┘ ├─ FIRst ◄ ─┬────────────────┬─┤
              │           └─ record-count ─┘ │
              ├─ NEXt ─┬────────────────┬────┤
              │        └─ record-count ─┘    │
              └─ ALL ────────────────────────┘

 ►─┬────────────┬─ record-name ─┬────────────────┬─ records ──────────────────►
   └─ view-id. ─┘               └─ (field-list) ─┘

 ►─── WHEre ─┬─┬─ CALckey ─────────┬─ = ─┬─┬───────────┬─ field-name ─┬─┬─────►
             │ └─ calc-field-name ─┘     │ └─ record. ─┘              │ │
             │                           │ ┌──────── , ───────┐       │ │
             │                           └─▼- calc-key-value ─┴───────┘ │
             │             ┌──────────── , ───────────┐                 │
             ├─ CALckey = -▼- concatenated-key-value ─┴─────────────────┤
             └─ DBKey = ─┬─┬───────────┬─ field-name ─┬─────────────────┘
                         │ └─ record. ─┘              │
                         │ ┌─────── , ──────┐         │
                         └─▼- db-key-value ─┴─────────┘

 ►─┬────────────────┬─────────────────────────────────────────────────────────►◄
   └─ AND criteria ─┘
►►─── REPeat with ─┬────────────────────────────┬─────────────────────────────►
                   ├─ FIRst ─┬────────────────┬─┤
                   │         └─ record-count ─┘ │
                   ├─ NEXt ─┬────────────────┬──┤
                   │        └─ record-count ─┘  │
                   └─ ALL ──────────────────────┘

 ►─┬────────────┬─ record-name ─┬────────────────┬─ records ──────────────────►
   └─ view-id. ─┘               └─ (field-list) ─┘

 ►─┬──────────────────────────────────────────────────────────────────────────►─
   └─ WHEre ─┬─┬─ CALckey ─────────┬─ = ─┬─┬───────────┬─ field-name ─┬─┬─────
             │ └─ calc-field-name ─┘     │ └─ record. ─┘              │ │
             │                           │ ┌──────── , ───────┐       │ │
             │                           └─▼- calc-key-value ─┴───────┘ │
             │             ┌──────────── , ───────────┐                 │
             ├─ CALckey = -▼- concatenated-key-value ─┴─────────────────┤
             └─ DBKey = ─┬─┬───────────┬─ field-name ─┬─────────────────┘
                         │ └─ record. ─┘              │
                         │ ┌─────── , ──────┐         │
                         └─▼- db-key-value ─┴─────────┘

─►────────────────────┬───────────────────────────────────────────────────────►◄
  ─┬────────────────┬─┘
   └─ AND criteria ─┘

Expansion of record

►►─┬────────────┬─ record-name ─┬────────────────┬────────────────────────────►◄
   └─ view-id. ─┘               └─ (occurrence) ─┘

Parameters:

FIRST record-count

Retrieves the first n (where n defaults to 1) records in the database that have the specified key value. Multiple records with the same CALC key are known as duplicates. Multiple records with the same dbkey value are not allowed.

NEXT record-count

Retrieves the next n (where n defaults to 1) records in the database that have the specified key value.

ALL

Retrieves all records in the database that have the specified key value.

view-id

The qualifying ID for the record or logical record name. Use view-id when you are signed on to multiple subschemas. View-id refers to the subschema where the record (or logical record) can be found.

record-name

The record type to be retrieved (required). If a database record name is the same as a CA OLQ keyword, the name should be enclosed in quotation marks.

(field-list)—The fields within record-name to be in the report file. Field-list must be enclosed in parentheses.

WHERE

Specifies the criteria for selecting records:

CALCKEY= —The CALC key used for record retrieval. For duplicate CALC keys, the order of retrieval depends on the DUPLICATES specification in the schema record description.
Note: If the CALC key defined for the named record type is a group item, all subordinate fields must be specified.
calc-field-name=—The field within record-name containing the CALC key, or the name of any field in the record that redefines the CALC key.
- record—The qualifying record name for a field-name. Expanded syntax can be found following the REPEAT parameters.
- field-name—The field containing the CALC key value.
- calc-key-value—The associated values of the CALC key or calc-field-name used for record retrieval. Separate multiple values with blanks or commas.
CALCKEY=—A concatenated CALC key value used for record retrieval.
- concatenated-key-value—The concatenated key value of the record to be retrieved. Separate each of the partial key values with blanks or commas.
DBKEY=—A dbkey value used for record retrieval:
- record—The qualifying record name for a field-name. Expanded syntax can be found following the REPEAT parameters.
- field-name—The field name containing the dbkey value.
- dbkey-value—The dbkey value of the record to be retrieved.
Separate multiple values with blanks or commas.

Note: The NEXT ordinal clauses cannot be specified for dbkey value retrieval.

AND criteria

Specifies selection criteria used for retrieving record occurrences.

REPEAT

Duplicates an immediately preceding FIND/GET using storage key (or REPEAT for FIND/GET using storage key) command.

FIRST record-count

Specifies the retrieval of the first n record occurrences.

NEXT record-count

Specifies the retrieval of the next n record occurrences.

ALL

Specifies the retrieval of all record occurrences.

view-id

record-name

Specifies the database record name.

(field-list)—The fields to be retrieved

WHERE

Specifies criteria used in selecting records:

CALCKEY= —The CALC key is used for record retrieval For duplicate CALC keys, the order of retrieval depends on the DUPLICATES specification in the schema record description.
Note: If the CALC key defined for the named record type is a group item, all subordinate fields must be specified.
calc-field-name=—The field within record-name containing the CALC key, or the name of any field in the record that redefines the CALC key.
record—Specifies the database record that qualifies field-name. Expanded syntax for record following the REPEAT parameter.
field-name—The name of the field containing the CALC key value.
calc-key-value—The associated values of the CALC key or calc-field-name used for record retrieval. Separate multiple values with commas or blanks.
CALCKEY=—A concatenated CALC key value is used for record retrieval.
- concatenated-key-value—The concatenated key value of the record retrieved. Separate each of the partial key values with blanks or commas.
DBKEY=—A dbkey value is used for record retrieval:
- record—The qualifying record name for a field-name. Expanded syntax can be found following the REPEAT parameters.
- field-name—The name of the field containing the dbkey value.
- dbkey-value—The dbkey value of the record retrieved.
Separate multiple values with blanks or commas.

Note: The NEXT ordinal clauses cannot be specified for dbkey value retrieval.

AND criteria

Specifies criteria used in selecting record occurrences.

If no parameters are specified and the last retrieval was performed by database-key, the same record is retrieved. The CALC key or database key does not change unless a change is specified in the REPEAT command; any new key value replaces the previous value.

record

view-id—The qualifying ID for the record or logical record name.Use view-id when you are signed on to multiple subschemas. View-id refers to the subschema where the record (or logical record) can be found.
record-name (occurrence)—The record in the path where the field-name occurs.
If the field-name occurs in more than one record, use record-name.

If the record occurs more than once in the same path, use occurrence. If a database record name is the same as a CA OLQ keyword, the name should be enclosed in quotation marks.

Examples:

The following examples illustrate the use of FIND/GET using storage key and associated REPEAT commands, based on the set occurrence diagram shown below:

Illustrate the use of FIND/GET using storage key and associated REPEAT commands, based on the set occurrence diagram

Get Using Storage Key

A GET using storage key command retrieves the first DEPARTMENT record with a dbkey value of 5007108:1:

get first department (dept-id-0410,dept-name-0410) where calckey=200

  DEPARTMENT
    DEPT-ID-0410     :   2000
    DEPT-NAME-0410   :  ACCOUNTING AND PAYROLL
  END OF RECORD

Repeat Get

A REPEAT command with a WHERE clause retrieves the same fields as the previous command for the new database-key value:

repeat with department where calckey=1000

  DEPARTMENT
    DEPT-ID-0410     :   1000
    DEPT-NAME-0410   :  PERSONNEL
  END OF RECORD

For more information:

Coding Considerations

Global Syntax