syst_instances


Description

Defines known application instances and provides their configuration settings.

Columns

Column Type Size Nulls Auto Default Children Parents Comments
id uuid 2147483647 uuid_generate_v7()
syst_access_account_instance_assocs.instance_id syst_access_account_instance_assocs_instances_fk C
syst_instance_contexts.instance_id syst_instance_contexts_instances_fk C
syst_instance_network_rules.instance_id syst_instance_network_rules_instance_fk C
syst_instances.owning_instance_id syst_instances_owning_instance_fk R

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.

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.

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.

application_id uuid 2147483647 null
syst_applications.id syst_instances_applications_fk R

Indicates an instance of which application is being described by the record.

instance_type_id uuid 2147483647 null
syst_enum_items.id syst_instances_enum_instance_type_fk R

Indicates the type of the instance. This can designate instances as being production or non-production, or make other functional differences between instances created for different reasons based on the assigned instance type.

instance_state_id uuid 2147483647 null
syst_enum_items.id syst_instances_enum_instance_state_fk R

Establishes the current life-cycle state of the instance record. This can determine functionality such as if the instance is usable, visible, or if it may be purged from the database completely.

owner_id uuid 2147483647 null
syst_owners.id syst_instances_owners_fk R

Identifies the owner of the instance. The owner is the entity which commissioned the instance and is the “user” of the instance. Owners have nominal management rights over their instances, such as which access accounts and which credential types are allowed to be used to authenticate to the owner’s instances.

owning_instance_id uuid 2147483647 null
syst_instances.id syst_instances_owning_instance_fk R

In some cases, an instance is considered subordinate to another instance. For example, consider a production environment and a related sandbox environment. The existence of the sandbox doesn’t have real meaning without being associated with some sort of production instance where the real work is performed. This kind of association becomes clearer in SaaS environments where a primary instance is contracted for, but other supporting instances, such as a sandbox, should follow certain account related actions of the primary.

dbserver_name text 2147483647 null

Identifies on which database server the instance is hosted. If empty, no server has been assigned and the instance is unstartable.

instance_code bytea 2147483647 null

This is a random sequence of bytes intended for use in certain algorithmic credential generation routines.

General Usage

Note that losing this value may prevent the Instance from being started due to bad credentials; there may be other consequences as well.

instance_options jsonb 2147483647 null

A key/value store of values which define application or instance specific options.

diag_timestamp_created timestamptz 35,6 now()

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.

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.

diag_timestamp_modified timestamptz 35,6 now()

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.

diag_wallclock_modified timestamptz 35,6 clock_timestamp()

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.

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.

diag_row_version int8 19 1

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.

Direct Usage

This column is frequently used by by application logic to resolve the “dirty write” issues which can arise from concurrent data changes. As such any administrative override of automatic system maintenance of this value should consider the ramifications on application function.

diag_update_count int8 19 0

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.

Indexes

Constraint Name Type Sort Column(s)
syst_instances_pk Primary key Asc id
syst_instances_display_name_udx Must be unique Asc display_name
syst_instances_internal_name_udx Must be unique Asc internal_name

Check Constraints

Constraint Name Constraint
syst_instances_self_ownership_chk (((owning_instance_id IS NULL) OR (owning_instance_id <> id)))

Relationships