DBIndex - Index definition
The index definition defines the order rules for the index of a collection. Indexes can be defined for local and global collections. The collection should be a typed or weak-typed collection. For untyped collections, only the __IDENTITY index may be defined, which orders the collection by local object identity (LOID).
The index definition refers to a key name, which must be a key name defined for the complex data type the collection is based on. Key names that do not require key definitions are __IDENTITY and __UNORDERED. __UNORDERED allows defining user or application defined orders. Each collection may contain only one __UNORDERED index.
Several options can be defined in order to declare case sensitivity, persistence, unique options and others.
Specific index definition is the unordered index. Each collection may get one unordered index, which contains an empty key name. When an unordered index is marked as unique, instances stored within the index must have different primary key values. When no primary key has been defined for the data type, instances stored in the collection must have unique LOIDs.
- keyname - Key name for index
- key_definition - Key definition
- field_definition - Field definition
- org_type - Internal index organization type
- unique - UNIQUE option
- temporary - TEMPORARY option
- generic - Generic index
- no_empty - Not storing empty keys or attributes
- main_index - MAIN_ORDER option
- max_count - Maximum number of entries in the index
- set_type - Collection type
- GetKeyName - Get key name for index
- GetKeySMCB - - internal feature (not documented)
- GetMaxCount - Get maximum number of entries in index
- GetOrgTyp - Get index organization type
- IsLarge - LARGE option
- get_field_def - Get field definition
- get_generic - Is index generic?
- get_key_def - Get key definition
- get_no_empty - Get not-empty option
- get_temporary - Is index a temporary index?
- get_unique - Does index require unique key values?