| Column | Type | Size | Nulls | Auto | Default | Children | Parents | Comments |
|---|---|---|---|---|---|---|---|---|
| id | uuid | 2147483647 | √ | null |
|
|
The record’s primary key. The definitive identifier of the record in the system. General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| internal_name | text | 2147483647 | √ | null |
|
|
A candidate key useful for programmatic references to individual records. General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| display_name | text | 2147483647 | √ | null |
|
|
A friendly name and candidate key for the record, suitable for use in user interactions General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| external_name | text | 2147483647 | √ | null |
|
|
A non-unique/non-key value used to display to users and external parties where uniqueness is less of a concern than specific end user presentation. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| enum_id | uuid | 2147483647 | √ | null |
|
|
The enumeration record with which the value is associated. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| functional_type_id | uuid | 2147483647 | √ | null |
|
|
If the enumeration requires a functional type, this column references the functional type associated with the enumeration value record. General Usage Note that not all enumerations require functional types. If syst_enum_functional_types records exist for an enumeration, then this column will be required for any values of that enumeration; if there are no functional types defined for an enumeration, the this column must remain NULL. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| enum_default | bool | 1 | √ | null |
|
|
If true, indicates that this value is the default selection from all values defined for the enumerations. General Usage Note that if a record is inserted or updated in this table with enum_default set true, and another record already exists for the enumeration with its enum_default set true, the newly inserted/updated record will take precedence and the value record previously set to be default will have its enum_default setting set to false. If false then the value record has no special significance relative to defaulting. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| functional_type_default | bool | 1 | √ | null |
|
|
If true, the value record is the default selection for any of a specific fucntional type. This is helpful in situations where a progression of state is automatically processed by the system and the state is represented by an enumeration. General Usage Note that if a record is inserted or updated in this table with its functional_type_default set true, and another record already exists for the enumeration/functional type combination with its functional_type_default set true, the newly inserted/updated record will take precedence and the value record previously set to be default will have its functional_type_default setting set to false. In cases where there are no functional types, this value should simply remain false. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| syst_defined | bool | 1 | √ | null |
|
|
Values of General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| user_maintainable | bool | 1 | √ | null |
|
|
If a record is system defined (see the General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| syst_description | text | 2147483647 | √ | null |
|
|
A system defined description indicating the purpose and use cases of a given record. Text defined in this column is system maintained and should not be changed under normal circumstances. General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| user_description | text | 2147483647 | √ | null |
|
|
An optional user defined description of the record and its use cases. If this value is not Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| sort_order | int2 | 5 | √ | null |
|
|
Indicates the sort ordering of the particular value record with the lowest value sorting first. General Usage When a value record for an enumeration is inserted or updated and this column is being set to a value which equals another enumeration value record for the same enumeration, the system assumes that the new record is being set to precede the existing record and it will be set to sort after the newly inserted/updated enumeration value. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| syst_options | jsonb | 2147483647 | √ | null |
|
|
Extended options and metadata which describe the behavior and meaning of the specific value within the enumeration. General Usage The owning syst_enums record’s default_syst_options column will indicate what syst_options are required or available and establishes default values for them. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| user_options | jsonb | 2147483647 | √ | null |
|
|
Extended user defined options, similar to syst_options, but for the purpose of driving custom functionality. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| diag_timestamp_created | timestamptz | 35,6 | √ | null |
|
|
The database server date/time when the transaction which created the record started. General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| diag_role_created | text | 2147483647 | √ | null |
|
|
The database role which created the record. General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| diag_timestamp_modified | timestamptz | 35,6 | √ | null |
|
|
The database server date/time when the transaction which modified the record started. This field will be the same as diag_timestamp_created for inserted records. General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| diag_wallclock_modified | timestamptz | 35,6 | √ | null |
|
|
The database server date/time at the moment the record was actually modified. For long running transactions this time may be significantly later than the value of diag_timestamp_modified. General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| diag_role_modified | text | 2147483647 | √ | null |
|
|
The database role which modified the record. General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| diag_row_version | int8 | 19 | √ | null |
|
|
The current version of the row. The value here indicates how many actual data changes have been made to the row. If an update of the row leaves all data fields the same, disregarding the updates to the diag_* columns, the row version is not updated, nor are any updates made to the other diag_* columns other than diag_update_count. General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
|
| diag_update_count | int8 | 19 | √ | null |
|
|
Records the number of times the record has been updated regardless as to if the update actually changed any data. In this way needless or redundant record updates can be found. This row starts at 0 and therefore may be the same as the diag_row_version - 1. General Usage This column is system maintained and should be considered read only in normal operations. Data Requirements
User Defined Record Supported Operations
System Defined Record Supported Operations
|
SELECT id, internal_name, display_name, external_name, enum_id, functional_type_id, enum_default, functional_type_default, syst_defined, user_maintainable, syst_description, user_description, sort_order, syst_options, user_options, diag_timestamp_created, diag_role_created, diag_timestamp_modified, diag_wallclock_modified, diag_role_modified, diag_row_version, diag_update_count FROM ms_syst_data.syst_enum_items;