syst_enum_items


Description

The list of values provided by an Enumeration as well as related behavioral and informational metadata.

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE
  • DELETE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - See column comments for applicable restrictions.

Columns

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

  • Required?: false
  • Unique Values Required?: true
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
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

  • Required?: true
  • Unique Values Required?: true
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
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

  • Required?: true
  • Unique Values Required?: true
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Only user maintainable records.
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

  • Required?: true
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Only user maintainable records.
enum_id uuid 2147483647 √ null

The enumeration record with which the value is associated.

Data Requirements

  • Required?: true
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT

System Defined Record Supported Operations

  • SELECT
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

  • Required?: false
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
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

  • Required?: false
  • Unique Values Required?: false
  • Default Value: FALSE

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Only user maintainable records.
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

  • Required?: false
  • Unique Values Required?: false
  • Default Value: FALSE

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Only user maintainable records.
syst_defined bool 1 √ null

Values of TRUE in this column indicate that the record is considered a “System Defined” record, a record which is created and primarily maintained by the system using automated processes. A value of FALSE indicates that the record is considered a “User Defined” record which is maintained by user actions in the application.

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: FALSE

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
user_maintainable bool 1 √ null

If a record is system defined (see the syst_defined column), there may be some user data maintenance operations permitted in some cases. If the value of this column for a record is TRUE and the record is also “System Defined”, then permitted user maintenance operations are available for the record. If the record is system defined and the value of this column is FALSE, no user maintenance is allowed. If the record is not system defined, the value in this column will have no meaning or effect; user defined records may set this value TRUE as a simple information point indicating that the record is user maintainable.

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: TRUE

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
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

  • Required?: false
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
user_description text 2147483647 √ null

An optional user defined description of the record and its use cases. If this value is not NULL, the value will override any syst_description defined text in application user interfaces and other presentations.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Always updatable, even when not otherwise user maintainable.
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

  • Required?: true
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Only user maintainable records.
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

  • Required?: false
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
user_options jsonb 2147483647 √ null

Extended user defined options, similar to syst_options, but for the purpose of driving custom functionality.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Always updatable, even when not otherwise user maintainable.
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

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
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

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
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

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
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

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
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

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
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

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
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

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT

Relationships

Close relationships within degrees of separation

View Definition

Possibly Referenced Tables/Views