Documentation
¶
Overview ¶
Package extensionstore owns ordinary declared infrastructure models for typed metadata, translations and settings. Public packages own their APIs.
Index ¶
- Variables
- func MetadataIndex(q orm.Query[Meta]) rows.Query[Meta, MetaIndex]
- func SettingStates(q orm.Query[Setting]) rows.Query[Setting, SettingState]
- func TranslationsIndex(q orm.Query[Translation]) rows.Query[Translation, TranslationIndex]
- type Meta
- type MetaIndex
- type MetaTable
- type Setting
- type SettingState
- type SettingTable
- type Translation
- type TranslationIndex
- type TranslationTable
Constants ¶
This section is empty.
Variables ¶
var Metadata = orm.Define("foundry_model_metadata", func(b orm.Builder[Meta], m *Meta) MetaTable { table := orm.TableOf(b, &m.Key) return MetaTable{Table: table, KeyColumn: orm.TextKey(table.Key()), Owner: orm.TextOf(b, &m.Owner), Scope: orm.TextOf(b, &m.Scope), SubjectKey: orm.TextOf(b, &m.SubjectKey), Identity: orm.JSONOf(b, &m.Identity), Name: orm.TextOf(b, &m.Name), Version: orm.NumberOf(b, &m.Version), Value: orm.JSONOf(b, &m.Value), CreatedAt: orm.CreatedAtOf(b, &m.CreatedAt), UpdatedAt: orm.UpdatedAtOf(b, &m.UpdatedAt)} })
Metadata owns the immutable Meta declaration. Example: orm.First(ctx, tx, Metadata.Query()).
var Settings = orm.Define("foundry_settings", func(b orm.Builder[Setting], m *Setting) SettingTable { table := orm.TableOf(b, &m.Name) return SettingTable{Table: table, Name: orm.TextKey(table.Key()), Version: orm.NumberOf(b, &m.Version), Value: orm.JSONOf(b, &m.Value), Kind: orm.TextOf(b, &m.Kind), Parameters: orm.JSONOf(b, &m.Parameters), GroupName: orm.TextOf(b, &m.GroupName), Label: orm.TextOf(b, &m.Label), Description: orm.TextOf(b, &m.Description), SortOrder: orm.NumberOf(b, &m.SortOrder), IsPublic: orm.ColumnOf(b, &m.IsPublic), PresentationDeclared: orm.ColumnOf(b, &m.PresentationDeclared), CreatedAt: orm.CreatedAtOf(b, &m.CreatedAt), UpdatedAt: orm.UpdatedAtOf(b, &m.UpdatedAt)} })
Settings owns the immutable Setting declaration. Example: orm.First(ctx, tx, Settings.Query()).
var Translations = orm.Define("foundry_model_translations", func(b orm.Builder[Translation], m *Translation) TranslationTable { table := orm.TableOf(b, &m.Key) return TranslationTable{Table: table, KeyColumn: orm.TextKey(table.Key()), Owner: orm.TextOf(b, &m.Owner), Scope: orm.TextOf(b, &m.Scope), SubjectKey: orm.TextOf(b, &m.SubjectKey), Identity: orm.JSONOf(b, &m.Identity), Field: orm.TextOf(b, &m.Field), Locale: orm.TextOf(b, &m.Locale), Value: orm.TextOf(b, &m.Value), CreatedAt: orm.CreatedAtOf(b, &m.CreatedAt), UpdatedAt: orm.UpdatedAtOf(b, &m.UpdatedAt)} })
Translations owns the immutable Translation declaration. Example: orm.First(ctx, tx, Translations.Query()).
Functions ¶
func MetadataIndex ¶
MetadataIndex selects only the declared MetaIndex fields. Example: MetadataIndex(Metadata.Query()).All(ctx,tx).
func SettingStates ¶
SettingStates selects only the declared SettingState fields. Example: SettingStates(Settings.Query()).All(ctx,tx).
func TranslationsIndex ¶
func TranslationsIndex(q orm.Query[Translation]) rows.Query[Translation, TranslationIndex]
TranslationsIndex selects only the declared TranslationIndex fields. Example: TranslationsIndex(Translations.Query()).All(ctx,tx).
Types ¶
type Meta ¶
type Meta struct {
Key string
Owner string
Scope string
SubjectKey string
Identity value.JSON[model.Identity]
Name string
Version uint32
Value value.JSON[json.RawMessage]
// CreatedAt preserves explicit input; persistence supplies the owning clock when omitted.
CreatedAt temporal.DateTime
// UpdatedAt is refreshed from the owning clock after before-write hooks and before mutators.
UpdatedAt temporal.DateTime
}
type MetaIndex ¶
type MetaIndex struct {
Key string
Owner string
Scope string
SubjectKey string
Identity value.JSON[model.Identity]
Name string
Version uint32
}
Maintenance selects ownership/index columns only, never extension payloads.
type MetaTable ¶
type MetaTable struct {
// Table provides model queries and writes. Example: orm.First(ctx, tx, Metadata.Query()).
orm.Table[Meta, string]
// KeyColumn binds Meta.Key.
// Example: orm.TextSet(Metadata.KeyColumn, key).
KeyColumn orm.TextLookupKey[Meta, string]
// Owner binds Meta.Owner.
// Example: orm.TextSet(Metadata.Owner, owner).
Owner orm.Text[Meta, string]
// Scope binds Meta.Scope.
// Example: orm.TextSet(Metadata.Scope, scope).
Scope orm.Text[Meta, string]
// SubjectKey binds Meta.SubjectKey.
// Example: orm.TextSet(Metadata.SubjectKey, subjectKey).
SubjectKey orm.Text[Meta, string]
// Identity binds Meta.Identity.
// Example: encoded, err := value.NewJSON(identity); if err == nil { _ = orm.JSONSet(Metadata.Identity, encoded) }.
Identity orm.JSON[Meta, model.Identity]
// Name binds Meta.Name.
// Example: orm.TextSet(Metadata.Name, name).
Name orm.Text[Meta, string]
// Version binds Meta.Version.
// Example: orm.NumberSet(Metadata.Version, version).
Version orm.Number[Meta, uint32]
// Value binds Meta.Value.
// Example: encoded, err := value.NewJSON(value); if err == nil { _ = orm.JSONSet(Metadata.Value, encoded) }.
Value orm.JSON[Meta, json.RawMessage]
// CreatedAt preserves an explicit creation time; the owning clock supplies omitted values.
// Example: orm.TimeSet(Metadata.CreatedAt, createdAt).
CreatedAt orm.CreatedAt[Meta, temporal.DateTime]
// UpdatedAt is replaced by the owning clock after before-write hooks and before mutators.
// Example: orm.TimeSet(Metadata.UpdatedAt, updatedAt).
UpdatedAt orm.UpdatedAt[Meta, temporal.DateTime]
}
MetaTable binds the persisted Meta columns. Example: Metadata.Query().Limit(10).
type Setting ¶
type Setting struct {
Name string
Version uint32
Value value.JSON[json.RawMessage]
Kind string
Parameters value.JSON[json.RawMessage]
GroupName string
Label string
Description string
SortOrder int32
IsPublic bool
// PresentationDeclared is true while the presentation follows the key's
// declaration; Configure sets it false to keep an explicit presentation.
PresentationDeclared bool
// CreatedAt preserves explicit input; persistence supplies the owning clock when omitted.
CreatedAt temporal.DateTime
// UpdatedAt is refreshed from the owning clock after before-write hooks and before mutators.
UpdatedAt temporal.DateTime
}
type SettingState ¶
type SettingState struct {
Name string
Version uint32
Kind string
Parameters value.JSON[json.RawMessage]
GroupName string
Label string
Description string
SortOrder int32
IsPublic bool
PresentationDeclared bool
}
SettingState selects version and presentation columns only, never values.
type SettingTable ¶
type SettingTable struct {
// Table provides model queries and writes. Example: orm.First(ctx, tx, Settings.Query()).
orm.Table[Setting, string]
// Name binds Setting.Name.
// Example: orm.TextSet(Settings.Name, name).
Name orm.TextLookupKey[Setting, string]
// Version binds Setting.Version.
// Example: orm.NumberSet(Settings.Version, version).
Version orm.Number[Setting, uint32]
// Value binds Setting.Value.
// Example: encoded, err := value.NewJSON(value); if err == nil { _ = orm.JSONSet(Settings.Value, encoded) }.
Value orm.JSON[Setting, json.RawMessage]
// Kind binds Setting.Kind.
// Example: orm.TextSet(Settings.Kind, kind).
Kind orm.Text[Setting, string]
// Parameters binds Setting.Parameters.
// Example: encoded, err := value.NewJSON(parameters); if err == nil { _ = orm.JSONSet(Settings.Parameters, encoded) }.
Parameters orm.JSON[Setting, json.RawMessage]
// GroupName binds Setting.GroupName.
// Example: orm.TextSet(Settings.GroupName, groupName).
GroupName orm.Text[Setting, string]
// Label binds Setting.Label.
// Example: orm.TextSet(Settings.Label, label).
Label orm.Text[Setting, string]
// Description binds Setting.Description.
// Example: orm.TextSet(Settings.Description, description).
Description orm.Text[Setting, string]
// SortOrder binds Setting.SortOrder.
// Example: orm.NumberSet(Settings.SortOrder, sortOrder).
SortOrder orm.Number[Setting, int32]
// IsPublic binds Setting.IsPublic.
// Example: orm.ColumnSet(Settings.IsPublic, isPublic).
IsPublic orm.Column[Setting, bool]
// PresentationDeclared binds Setting.PresentationDeclared.
// Example: orm.ColumnSet(Settings.PresentationDeclared, presentationDeclared).
PresentationDeclared orm.Column[Setting, bool]
// CreatedAt preserves an explicit creation time; the owning clock supplies omitted values.
// Example: orm.TimeSet(Settings.CreatedAt, createdAt).
CreatedAt orm.CreatedAt[Setting, temporal.DateTime]
// UpdatedAt is replaced by the owning clock after before-write hooks and before mutators.
// Example: orm.TimeSet(Settings.UpdatedAt, updatedAt).
UpdatedAt orm.UpdatedAt[Setting, temporal.DateTime]
}
SettingTable binds the persisted Setting columns. Example: Settings.Query().Limit(10).
type Translation ¶
type Translation struct {
Key string
Owner string
Scope string
SubjectKey string
Identity value.JSON[model.Identity]
Field string
Locale string
Value string
// CreatedAt preserves explicit input; persistence supplies the owning clock when omitted.
CreatedAt temporal.DateTime
// UpdatedAt is refreshed from the owning clock after before-write hooks and before mutators.
UpdatedAt temporal.DateTime
}
type TranslationIndex ¶
type TranslationTable ¶
type TranslationTable struct {
// Table provides model queries and writes. Example: orm.First(ctx, tx, Translations.Query()).
orm.Table[Translation, string]
// KeyColumn binds Translation.Key.
// Example: orm.TextSet(Translations.KeyColumn, key).
KeyColumn orm.TextLookupKey[Translation, string]
// Owner binds Translation.Owner.
// Example: orm.TextSet(Translations.Owner, owner).
Owner orm.Text[Translation, string]
// Scope binds Translation.Scope.
// Example: orm.TextSet(Translations.Scope, scope).
Scope orm.Text[Translation, string]
// SubjectKey binds Translation.SubjectKey.
// Example: orm.TextSet(Translations.SubjectKey, subjectKey).
SubjectKey orm.Text[Translation, string]
// Identity binds Translation.Identity.
// Example: encoded, err := value.NewJSON(identity); if err == nil { _ = orm.JSONSet(Translations.Identity, encoded) }.
Identity orm.JSON[Translation, model.Identity]
// Field binds Translation.Field.
// Example: orm.TextSet(Translations.Field, field).
Field orm.Text[Translation, string]
// Locale binds Translation.Locale.
// Example: orm.TextSet(Translations.Locale, locale).
Locale orm.Text[Translation, string]
// Value binds Translation.Value.
// Example: orm.TextSet(Translations.Value, value).
Value orm.Text[Translation, string]
// CreatedAt preserves an explicit creation time; the owning clock supplies omitted values.
// Example: orm.TimeSet(Translations.CreatedAt, createdAt).
CreatedAt orm.CreatedAt[Translation, temporal.DateTime]
// UpdatedAt is replaced by the owning clock after before-write hooks and before mutators.
// Example: orm.TimeSet(Translations.UpdatedAt, updatedAt).
UpdatedAt orm.UpdatedAt[Translation, temporal.DateTime]
}
TranslationTable binds the persisted Translation columns. Example: Translations.Query().Limit(10).