Skip to main content

Module system_config

Module system_config 

Source
Expand description

Database-backed runtime system configuration store.

Aster products share the same system_config table shape and persistence rules: system definitions are seeded from a product registry, custom values are stored as scalar strings, public/authenticated custom values can be exposed to clients, and startup repairs system metadata without overwriting user-provided values. Product crates still own their configuration definitions, validation callbacks, audit records, and API presentation.

Structs§

ActiveModel
Generated by sea-orm-macros
ColumnIter
An iterator over the variants of Column
Entity
Generated by sea-orm-macros
Model
Runtime system configuration SeaORM model.
PresentedSystemConfig
API-facing representation of a stored system configuration row.
PrimaryKeyIter
An iterator over the variants of PrimaryKey
RelationIter
An iterator over the variants of Relation
SystemConfigCursorSlice
Page slice returned by cursor-style repository queries.
SystemConfigDbBinding
Product binding for the shared system config store.
SystemConfigDbStore
SeaORM-backed system configuration store.
SystemConfigUpsert
Product request to upsert one system or custom configuration value.

Enums§

Column
Generated by sea-orm-macros
PrimaryKey
Generated by sea-orm-macros
Relation

Constants§

SYSTEM_CONFIG_CATEGORY_COLUMN
Product category column.
SYSTEM_CONFIG_DESCRIPTION_COLUMN
Product description column.
SYSTEM_CONFIG_ID_COLUMN
Stable row id column.
SYSTEM_CONFIG_IS_SENSITIVE_COLUMN
Sensitive-value marker column.
SYSTEM_CONFIG_KEY_COLUMN
Stable configuration key column.
SYSTEM_CONFIG_KEY_UNIQUE_INDEX
Unique index name for configuration keys.
SYSTEM_CONFIG_NAMESPACE_COLUMN
Optional product namespace column.
SYSTEM_CONFIG_REQUIRES_RESTART_COLUMN
Restart-required marker column.
SYSTEM_CONFIG_SOURCE_COLUMN
System/custom source column.
SYSTEM_CONFIG_TABLE
Shared system configuration table name.
SYSTEM_CONFIG_UPDATED_AT_COLUMN
Last update timestamp column.
SYSTEM_CONFIG_UPDATED_BY_COLUMN
Optional actor user id column.
SYSTEM_CONFIG_VALUE_COLUMN
Storage value column.
SYSTEM_CONFIG_VALUE_TYPE_COLUMN
Storage value type column.
SYSTEM_CONFIG_VISIBILITY_COLUMN
Consumer visibility column.

Functions§

create_system_config_key_unique_index
Builds the unique index for stable configuration keys.
create_system_config_table
Builds the shared system_config table creation statement.
delete_by_key
Deletes a custom row.
delete_deprecated_keys
Deletes deprecated system keys configured by the product.
drop_system_config_table
Builds the shared system_config table drop statement.
ensure_defaults
Ensures default rows exist and repairs metadata for existing system rows.
ensure_system_value_if_missing
Inserts one system value if no row exists.
find_all
Lists all rows by stable id order.
find_by_key
Finds one row by key.
find_cursor
Lists one id-cursor page by stable id order.
find_visible_custom
Lists visible custom rows ordered by key.
lock_by_key
Locks one row by key where the database supports row locks.
present_system_config
Converts a stored system config row into an API-facing presentation row.
upsert
Upserts one row using registry metadata for known system keys.