Dictionary Record -- Entity Section


Indices Array

Entity Indices {type: array (obj: Entity Index)}
Usage:
The panel contains a list of Entity Index objects used to define alternate keys (keys in addition to the Primary Key) for the Entity. Alternate keys are generally used to speed data retrievals and provide alternate retrieval paths in large datasets.

Alternate key constraints work entirely within an Entity whereas foreign key constraints rely on a reference to another (foreign) Entity.

Entity Indices Panel
Image 1: Entity Indices Panel


Entity Index Object

  • Name {type: string; max length: none; default: empty}
    Usage:
    The code name of the Index used in the dictionary schema.

  • Attributes {type: codelist (Attributes defined in the current Entity); extensible: YES; multi-value: YES; default: empty}
    Usage:
    Choose the attribute (or collection of attributes) from the current entity that will act as the alternate key.

  • Duplicates {type: Boolean; default: FALSE}
    Usage:
    TRUE if duplicates are permitted in the index. FALSE if duplicates are not permitted.

results matching ""

    No results matching ""