schema

package

Go to main page

Versions in this module

v0

v0.23.0

Aug 28, 2026

Changes in this version

type BodyProperty

+ MapValue string

type Field

+ func Map(name string, value Type) *Field

type FieldDesc

+ MapValue Type

type Type

+ const TypeMap

v0.22.0

Aug 28, 2026

Changes in this version

type FieldDesc

+ ScopeName string

type Query

+ Returns []*Field

v0.21.0

Aug 28, 2026

Changes in this version

type BodyProperty

+ Max *float64

+ Min *float64

+ Pattern string

type ColumnManifest

+ Max *float64

+ Min *float64

+ Pattern string

type Field

+ func (f *Field) Max(v float64) *Field

+ func (f *Field) Min(v float64) *Field

+ func (f *Field) Pattern(expr string) *Field

type FieldDesc

+ Max *float64

+ Min *float64

+ Pattern string

type RefManifest

+ Schema string

type TableDef

+ func (t *TableDef) ModelsIn(pkg string) *TableDef

+ func (t *TableDef) ModelsPackage() string

v0.20.0

Aug 26, 2026

Changes in this version

+ const CRUD

+ const DefaultExpandLimit

+ const ManifestVersion

+ const Reads

+ func CheckIdent(name string) error

+ func IsArrayElement(t Type) bool

+ func Register(t *TableDef)

+ func SetWireCase(c WireCase)

+ func SortTerm(term string) (name string, desc bool, err error)

+ func Validate() error

+ func WriteManifest(path string) error

+ type Action struct

+ Body []*Field

+ Description string

+ Name string

+ Path string

+ Returns []*Field

+ Summary string

+ Touches []string

+ Writes []string

+ func (a Action) FullPath(resource string) string

+ func (a Action) IsCollection() bool

+ type ActionManifest struct

+ Body []BodyProperty

+ Method string

+ Name string

+ Path string

+ Returns []BodyProperty

+ Summary string

+ Touches []string

+ Writes []string

+ type ActionProperty = BodyProperty

+ type Auto string

+ const AutoIdentity

+ const AutoIdentityAlways

+ const AutoSerial

+ const NotAuto

+ func (a Auto) Identity() bool

+ type BodyProperty struct

+ Enum []string

+ Name string

+ Nullable bool

+ Type string

+ type Check struct

+ Expr string

+ Name string

+ type ColumnManifest struct

+ Array bool

+ Capabilities []string

+ Comment string

+ Computed bool

+ Enum []string

+ GoType string

+ HasDefault bool

+ Immutable bool

+ Name string

+ Needs []string

+ Nullable bool

+ ReadOnly bool

+ References *RefManifest

+ Scoped bool

+ SoftDelete bool

+ SortNulls string

+ Type string

+ Wire string

+ WriteOnly bool

+ type ComputedExpr struct

+ func FromSQL(sql string) ComputedExpr

+ type Default struct

+ Raw string

+ Value any

+ func Expr(sql string) *Default

+ func GenUUIDv4() *Default

+ func GenUUIDv7() *Default

+ func Now() *Default

+ func Value(v any) *Default

+ type Deferrable string

+ const DeferrableCheck

+ const DeferredCheck

+ const NotDeferrable

+ func (d Deferrable) Suffix() string

+ func (d Deferrable) Valid() bool

+ type Diagnostic struct

+ Column string

+ Fix string

+ Message string

+ Rule string

+ Severity Severity

+ Table string

+ func (d Diagnostic) String() string

+ type Diagnostics []Diagnostic

+ func Lint() Diagnostics

+ func (ds Diagnostics) String() string

+ func (ds Diagnostics) Warnings() Diagnostics

+ type Error struct

+ Column string

+ Msg string

+ Table string

+ func (e Error) Error() string

+ type Exclusion struct

+ Elements string

+ Name string

+ Using string

+ Where string

+ func ParseExclusion(def string) (Exclusion, bool)

+ func (e Exclusion) Def() string

+ type Field struct

+ func BigInt(name string) *Field

+ func BigSerial(name string) *Field

+ func Body(specs ...FieldSpec) []*Field

+ func Bool(name string) *Field

+ func Bytes(name string) *Field

+ func Computed(name string, t Type, e ComputedExpr) *Field

+ func Date(name string) *Field

+ func Enum(name string, values ...string) *Field

+ func ExternalRef(relation, target string) *Field

+ func Float(name string) *Field

+ func Int(name string) *Field

+ func JSON(name string) *Field

+ func Numeric(name string, precision ...int) *Field

+ func Real(name string) *Field

+ func Ref(name string, target *TableDef) *Field

+ func Result(specs ...FieldSpec) []*Field

+ func Serial(name string) *Field

+ func SmallInt(name string) *Field

+ func SmallSerial(name string) *Field

+ func Text(name string) *Field

+ func Time(name string) *Field

+ func Timestamp(name string) *Field

+ func UUID(name string) *Field

+ func UUIDv7(name string) *Field

+ func Varchar(name string, size int) *Field

+ func Vector(name string, dim int) *Field

+ func (f *Field) Array() *Field

+ func (f *Field) CheckNamed(name string) *Field

+ func (f *Field) Comment(s string) *Field

+ func (f *Field) ConstraintNamed(name string) *Field

+ func (f *Field) Default(d *Default) *Field

+ func (f *Field) Deferred() *Field

+ func (f *Field) Desc() *FieldDesc

+ func (f *Field) Enforced() *Field

+ func (f *Field) Expandable() *Field

+ func (f *Field) Filterable() *Field

+ func (f *Field) Hidden() *Field

+ func (f *Field) Identity() *Field

+ func (f *Field) IdentityAlways() *Field

+ func (f *Field) Immutable() *Field

+ func (f *Field) Indexed() *Field

+ func (f *Field) Inverse(name string) *Field

+ func (f *Field) InverseExpandable(opts ...InverseOption) *Field

+ func (f *Field) LookupKey() *Field

+ func (f *Field) Name() string

+ func (f *Field) Named(column string) *Field

+ func (f *Field) Needs(keys ...string) *Field

+ func (f *Field) NotNull() *Field

+ func (f *Field) Nullable() *Field

+ func (f *Field) OfType(t Type) *Field

+ func (f *Field) OnDelete(a RefAction) *Field

+ func (f *Field) OnUpdate(a RefAction) *Field

+ func (f *Field) PrimaryKey() *Field

+ func (f *Field) ReadOnly() *Field

+ func (f *Field) RenamedFrom(old string) *Field

+ func (f *Field) Scoped() *Field

+ func (f *Field) Searchable() *Field

+ func (f *Field) Serial() *Field

+ func (f *Field) SharedAs(name string) *Field

+ func (f *Field) Sortable(nulls ...Nulls) *Field

+ func (f *Field) Unique() *Field

+ func (f *Field) WriteOnly() *Field

+ type FieldDesc struct

+ Array bool

+ Auto Auto

+ CheckName string

+ Comment string

+ ConstraintName string

+ Default *Default

+ Dim int

+ EnumValues []string

+ Expandable bool

+ Expr string

+ Filterable bool

+ Hidden bool

+ Immutable bool

+ LookupKey bool

+ Name string

+ Needs []string

+ Nullable bool

+ PrimaryKey bool

+ ReadOnly bool

+ Ref *Reference

+ RenamedFrom string

+ Scale int

+ Scoped bool

+ Searchable bool

+ SharedAs string

+ Size int

+ SoftDelete bool

+ SortNulls Nulls

+ Sortable bool

+ Type Type

+ Unique bool

+ UniqueDeferrable Deferrable

+ WriteOnly bool

+ func (d *FieldDesc) Capabilities() string

+ func (d *FieldDesc) Computed() bool

+ func (d *FieldDesc) DatabaseSupplied() bool

+ func (d *FieldDesc) GoType() string

+ func (d *FieldDesc) IndexWanted() bool

+ func (d *FieldDesc) Placeholders() int

+ func (d *FieldDesc) Volatile() bool

+ type FieldSpec interface

+ type Group []*Field

+ func SoftDelete() Group

+ func Timestamps() Group

+ type Index struct

+ Columns []string

+ Method string

+ Name string

+ Opclasses map[string]string

+ Orders map[string]IndexOrder

+ Unique bool

+ Where string

+ With map[string]string

+ type IndexManifest struct

+ Columns []string

+ Method string

+ Name string

+ Unique bool

+ type IndexOrder struct

+ Desc bool

+ Nulls Nulls

+ func (o IndexOrder) Suffix() string

+ type InverseManifest struct

+ Column string

+ Expandable bool

+ Limit int

+ Name string

+ OneToOne bool

+ Order string

+ Table string

+ type InverseOption func(*Reference)

+ func ExpandLimit(n int) InverseOption

+ func ExpandOrder(column string) InverseOption

+ type InverseRelation struct

+ Column string

+ Expandable bool

+ Limit int

+ Name string

+ OneToOne bool

+ Order string

+ Table *TableDef

+ func (i InverseRelation) Cap() int

+ type Manifest struct

+ Module string

+ Operators []OperatorDoc

+ Params []ParamDoc

+ Tables []TableManifest

+ Version string

+ WireCase string

+ func BuildManifest() *Manifest

+ func (m *Manifest) JSON() ([]byte, error)

+ type Nulls string

+ const NullsDefault

+ const NullsFirst

+ const NullsLast

+ type Op uint8

+ const OpCreate

+ const OpDelete

+ const OpList

+ const OpRead

+ const OpSingleton

+ const OpUpdate

+ func (o Op) Has(op Op) bool

+ func (o Op) String() string

+ type OperatorDoc struct

+ Applies string

+ Form string

+ Name string

+ type ParamDoc struct

+ Form string

+ Name string

+ type Query struct

+ Description string

+ Name string

+ Params []*Field

+ Path string

+ Reads []*TableDef

+ Summary string

+ func (q Query) FullPath(resource string) string

+ type REST struct

+ CreateInput []*Field

+ DefaultPageSize int

+ DefaultSort []string

+ MaxFilters int

+ MaxOffset int

+ MaxPageSize int

+ MaxSortTerms int

+ Ops Op

+ Path string

+ Tag string

+ type RESTManifest struct

+ Actions []ActionManifest

+ CreateInput []BodyProperty

+ DefaultPageSize int

+ DefaultSort []string

+ Examples []string

+ Expandable []string

+ Filterable []string

+ MaxFilters int

+ MaxOffset int

+ MaxPageSize int

+ MaxSortTerms int

+ Operations []string

+ Path string

+ Searchable []string

+ Sortable []string

+ type RefAction string

+ const Cascade

+ const NoAction

+ const Restrict

+ const SetDefault

+ const SetNull

+ type RefManifest struct

+ Column string

+ Enforced bool

+ External bool

+ OnDelete string

+ Relation string

+ Table string

+ Target string

+ type Reference struct

+ Column string

+ Enforced bool

+ External bool

+ Inverse string

+ InverseExpandable bool

+ InverseLimit int

+ InverseOrder string

+ Name string

+ OnDelete RefAction

+ OnUpdate RefAction

+ Table *TableDef

+ Target string

+ func (r *Reference) EnforcedTarget() (table, column string, ok bool)

+ type Registry struct

+ func DefaultRegistry() *Registry

+ func NewModule(name string) *Registry

+ func NewRegistry() *Registry

+ func (r *Registry) Add(t *TableDef)

+ func (r *Registry) BuildManifest() *Manifest

+ func (r *Registry) Exposed() []*TableDef

+ func (r *Registry) Get(name string) *TableDef

+ func (r *Registry) Inverses(t *TableDef) []InverseRelation

+ func (r *Registry) Lint() Diagnostics

+ func (r *Registry) Module() string

+ func (r *Registry) Qualify(local string) string

+ func (r *Registry) Table(name string, specs ...FieldSpec) *TableDef

+ func (r *Registry) Tables() []*TableDef

+ func (r *Registry) Validate() error

+ func (r *Registry) View(name, query string, cols ...FieldSpec) *TableDef

+ func (r *Registry) Views() []*TableDef

+ func (r *Registry) Wire() WireCase

+ func (r *Registry) WireCase(c WireCase) *Registry

+ type Severity string

+ const SeverityInfo

+ const SeverityWarn

+ type TableDef struct

+ func Get(name string) *TableDef

+ func Table(name string, specs ...FieldSpec) *TableDef

+ func Tables() []*TableDef

+ func View(name, query string, cols ...FieldSpec) *TableDef

+ func (t *TableDef) Actions() []Action

+ func (t *TableDef) AddAction(a Action) *TableDef

+ func (t *TableDef) AddExclude(e Exclusion) *TableDef

+ func (t *TableDef) AddField(f *Field) *Field

+ func (t *TableDef) AddFields(specs ...FieldSpec) []*Field

+ func (t *TableDef) AddIndex(idx Index) *TableDef

+ func (t *TableDef) AddQuery(q Query) *TableDef

+ func (t *TableDef) AddUnique(u Unique) *TableDef

+ func (t *TableDef) Check(name, expr string) *TableDef

+ func (t *TableDef) Checks() []Check

+ func (t *TableDef) Comment() string

+ func (t *TableDef) CompositeKey() []string

+ func (t *TableDef) Describe(s string) *TableDef

+ func (t *TableDef) Exclusions() []Exclusion

+ func (t *TableDef) Expose(r REST) *TableDef

+ func (t *TableDef) Field(name string) *Field

+ func (t *TableDef) Fields() []*Field

+ func (t *TableDef) Index(columns ...string) *TableDef

+ func (t *TableDef) IndexNamed(name string, columns ...string) *TableDef

+ func (t *TableDef) Indexes() []Index

+ func (t *TableDef) IsView() bool

+ func (t *TableDef) LocalName() string

+ func (t *TableDef) Module() string

+ func (t *TableDef) Name() string

+ func (t *TableDef) PrimaryKey() *Field

+ func (t *TableDef) PrimaryKeyColumns(columns ...string) *TableDef

+ func (t *TableDef) PrimaryKeyName() string

+ func (t *TableDef) PrimaryKeyNamed(name string) *TableDef

+ func (t *TableDef) Queries() []Query

+ func (t *TableDef) Relations() []*Field

+ func (t *TableDef) RenamedFrom(local string) *TableDef

+ func (t *TableDef) RenamedFromName() string

+ func (t *TableDef) ReplaceCheckExpr(name, expr string) bool

+ func (t *TableDef) ReplaceExclusion(name, using, elements, where string) bool

+ func (t *TableDef) ReplaceIndexWhere(name, expr string) bool

+ func (t *TableDef) Rest() *REST

+ func (t *TableDef) StoredField(name string) *Field

+ func (t *TableDef) StoredFields() []*Field

+ func (t *TableDef) TypeName(name string) *TableDef

+ func (t *TableDef) TypeNameOverride() string

+ func (t *TableDef) Unique(columns ...string) *TableDef

+ func (t *TableDef) UniqueIndex(columns ...string) *TableDef

+ func (t *TableDef) UniqueIndexNamed(name string, columns ...string) *TableDef

+ func (t *TableDef) UniqueNamed(name string, columns ...string) *TableDef

+ func (t *TableDef) Uniques() []Unique

+ func (t *TableDef) ViewQuery() string

+ type TableManifest struct

+ CollectedBy []InverseManifest

+ Columns []ColumnManifest

+ Comment string

+ Indexes []IndexManifest

+ LocalName string

+ Module string

+ Name string

+ PrimaryKey string

+ REST *RESTManifest

+ type TargetDefault struct

+ Builtin string

+ Canonical string

+ Helper string

+ Since int

+ func TargetDefaults() []TargetDefault

+ type Type string

+ const TypeBigInt

+ const TypeBool

+ const TypeBytes

+ const TypeDate

+ const TypeEnum

+ const TypeFloat

+ const TypeInt

+ const TypeJSON

+ const TypeNumeric

+ const TypeReal

+ const TypeSmallInt

+ const TypeText

+ const TypeTime

+ const TypeTimestamp

+ const TypeUUID

+ const TypeVarchar

+ const TypeVector

+ func Types() []Type

+ func (t Type) GoType() string

+ type Unique struct

+ Columns []string

+ Deferrable Deferrable

+ Name string

+ type WireCase string

+ const Camel

+ const Verbatim

+ func (c WireCase) ColumnName(wire string) string

+ func (c WireCase) WireName(column string) string

v0.19.0

Aug 26, 2026

v0.18.0

Aug 25, 2026

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL