schema

package

Go to main page

Versions in this module

v0

v0.2.1

Jun 6, 2026

v0.2.0

Jun 5, 2026

Changes in this version

type Column

+ OnDeleteAction string

+ VisibleToSource map[string]string

+ func (c *Column) OnDelete(action string) *Column

+ func (c *Column) RoleSeesFrom(slug, migrationID string) *Column

type ExposeBuilder

+ func (e *ExposeBuilder) Relationship(name string, fn func(*RelationshipExposure))

type GraphQLOperation

+ Relationships []RelationshipExposureDef

type Migration

+ func (m *Migration) RawSQL(sql string)

type Operation

+ SQL string

+ type RelationshipExposure struct

+ func (r *RelationshipExposure) Cost(cost int)

+ func (r *RelationshipExposure) MaxPageSize(size int)

+ type RelationshipExposureDef struct

+ CostValue int

+ MaxPageSizeValue int

+ Name string

type Table

+ CompositePrimaryKeys []string

+ Indexes []*Index

+ func (t *Table) PrimaryKey(cols ...string)

type TableOperation

+ const OpRawSQL

v0.1.0

Mar 26, 2026

Changes in this version

+ type Column struct

+ DefaultValue any

+ FKMetadataOnly bool

+ ForeignKeyColumn string

+ ForeignKeyTable string

+ HasDefault bool

+ IsEncrypted bool

+ IsNullable bool

+ IsOwnerColumn bool

+ IsOwnerSees bool

+ IsPrimaryKey bool

+ IsPublic bool

+ IsSealed bool

+ IsUnique bool

+ IsUnsafePublic bool

+ Length int

+ Name string

+ Precision int

+ Scale int

+ Type ColumnType

+ VisibleTo map[string]bool

+ func (c *Column) Default(value any) *Column

+ func (c *Column) Encrypted() *Column

+ func (c *Column) ForeignKey(table, column string) *Column

+ func (c *Column) IsOwner() *Column

+ func (c *Column) NotNull() *Column

+ func (c *Column) Nullable() *Column

+ func (c *Column) OwnerSees() *Column

+ func (c *Column) PrimaryKey() *Column

+ func (c *Column) Public() *Column

+ func (c *Column) RoleSees(slug string) *Column

+ func (c *Column) Sealed() *Column

+ func (c *Column) Unique() *Column

+ func (c *Column) UnsafePublic() *Column

+ type ColumnType int

+ const BigInteger

+ const Binary

+ const Boolean

+ const Date

+ const Decimal

+ const Double

+ const Float

+ const Integer

+ const JSONB

+ const String

+ const Text

+ const Time

+ const Timestamp

+ const UUID

+ func (t ColumnType) String() string

+ type ControllerActionDef struct

+ Handler interface{}

+ Name string

+ type DriverCapabilities struct

+ AdvisoryLocks bool

+ ConcurrentIndexing bool

+ EmbeddedDocs bool

+ ForeignKeys bool

+ JSONBSupport bool

+ SecondaryIndex bool

+ TransactionalDDL bool

+ UUIDNativeType bool

+ UniqueIndex bool

+ func DriverCaps(driver string) DriverCapabilities

+ type ExposeBuilder struct

+ func (e *ExposeBuilder) All()

+ func (e *ExposeBuilder) Create()

+ func (e *ExposeBuilder) Delete()

+ func (e *ExposeBuilder) List()

+ func (e *ExposeBuilder) RemoveCreate()

+ func (e *ExposeBuilder) RemoveDelete()

+ func (e *ExposeBuilder) RemoveList()

+ func (e *ExposeBuilder) RemoveShow()

+ func (e *ExposeBuilder) RemoveUpdate()

+ func (e *ExposeBuilder) Show()

+ func (e *ExposeBuilder) Update()

+ type ExposedOperation struct

+ Type string

+ type GraphQLOperation struct

+ Action *ControllerActionDef

+ Model string

+ Ops []ExposedOperation

+ Type string

+ type GraphQLPolicy struct

+ Operations []GraphQLOperation

+ func (p *GraphQLPolicy) AlterExpose(model string, fn func(*ExposeBuilder))

+ func (p *GraphQLPolicy) ControllerAction(name string, handler interface{})

+ func (p *GraphQLPolicy) Expose(model string, fn func(*ExposeBuilder))

+ func (p *GraphQLPolicy) GetOperations() []GraphQLOperation

+ func (p *GraphQLPolicy) RemoveAction(name string)

+ func (p *GraphQLPolicy) Reset()

+ func (p *GraphQLPolicy) Transactional() bool

+ func (p *GraphQLPolicy) Unexpose(model string)

+ type Index struct

+ Columns []string

+ Table string

+ Unique bool

+ type Migration struct

+ Operations []Operation

+ func (m *Migration) AddColumn(table string, fn func(*Table))

+ func (m *Migration) AddIndex(table string, columns ...string)

+ func (m *Migration) AddUniqueIndex(table string, columns ...string)

+ func (m *Migration) AlterTable(name string, fn func(*Table))

+ func (m *Migration) Connection() string

+ func (m *Migration) CreateTable(name string, fn func(*Table))

+ func (m *Migration) CreateView(name string, fn func(*View))

+ func (m *Migration) DropColumn(table, column string)

+ func (m *Migration) DropTableIfExists(name string)

+ func (m *Migration) DropView(name string)

+ func (m *Migration) GetOperations() []Operation

+ func (m *Migration) RenameColumn(table, oldName, newName string)

+ func (m *Migration) RenameTable(oldName, newName string)

+ func (m *Migration) Reset()

+ func (m *Migration) Transactional() bool

+ type Operation struct

+ ColumnDef func(*Table)

+ ColumnName string

+ Index *Index

+ NewName string

+ OldName string

+ Table string

+ TableDef *Table

+ Type TableOperation

+ ViewDef *View

+ type Policy struct

+ Operations []RoleOperation

+ func (p *Policy) AlterRole(slug string) *RoleBuilder

+ func (p *Policy) CreateRole(slug string) *RoleBuilder

+ func (p *Policy) DropRole(slug string)

+ func (p *Policy) GetOperations() []RoleOperation

+ func (p *Policy) Reset()

+ func (p *Policy) Transactional() bool

+ type Relationship struct

+ ChildTable *Table

+ IsCollection bool

+ IsTopLevel bool

+ Name string

+ ParentTable string

+ Type RelationshipType

+ func (r *Relationship) Collection() *Relationship

+ func (r *Relationship) TopLevelModel() *Relationship

+ type RelationshipType int

+ const RelHasMany

+ const RelHasOne

+ type RoleBuilder struct

+ func (b *RoleBuilder) Can(actions ...string) *RoleBuilder

+ func (b *RoleBuilder) Default() *RoleBuilder

+ func (b *RoleBuilder) Manages() *RoleBuilder

+ func (b *RoleBuilder) Name(name string) *RoleBuilder

+ func (b *RoleBuilder) RemoveDefault() *RoleBuilder

+ func (b *RoleBuilder) RemoveManages() *RoleBuilder

+ func (b *RoleBuilder) RevokeCan(actions ...string) *RoleBuilder

+ type RoleDefinition struct

+ Actions []string

+ DisplayName string

+ IsDefault bool

+ IsManages bool

+ RemoveDefault bool

+ RemoveManages bool

+ RevokeActions []string

+ Slug string

+ type RoleOperation struct

+ Role RoleDefinition

+ Type string

+ type Table struct

+ Columns []*Column

+ Connection string

+ HasSoftDelete bool

+ IsAppendOnly bool

+ IsImmutable bool

+ Name string

+ Relationships []*Relationship

+ func (t *Table) AppendOnly()

+ func (t *Table) BigInteger(name string) *Column

+ func (t *Table) Binary(name string) *Column

+ func (t *Table) Boolean(name string) *Column

+ func (t *Table) Date(name string) *Column

+ func (t *Table) Decimal(name string, precision, scale int) *Column

+ func (t *Table) Double(name string) *Column

+ func (t *Table) Float(name string) *Column

+ func (t *Table) HasMany(name string, fn func(*Table)) *Relationship

+ func (t *Table) HasOne(name string, fn func(*Table)) *Relationship

+ func (t *Table) Immutable()

+ func (t *Table) Integer(name string) *Column

+ func (t *Table) JSONB(name string) *Column

+ func (t *Table) SoftDeletes()

+ func (t *Table) String(name string, length ...int) *Column

+ func (t *Table) Text(name string) *Column

+ func (t *Table) Time(name string) *Column

+ func (t *Table) Timestamp(name string) *Column

+ func (t *Table) Timestamps()

+ func (t *Table) UUID(name string) *Column

+ type TableOperation int

+ const OpAddColumn

+ const OpAddIndex

+ const OpAddUniqueIndex

+ const OpCreateTable

+ const OpCreateView

+ const OpDropColumn

+ const OpDropTableIfExists

+ const OpDropView

+ const OpRenameColumn

+ const OpRenameTable

+ type View struct

+ Columns []*ViewColumn

+ GroupByCols []string

+ Name string

+ Sources []ViewSource

+ func (v *View) Column(ref string, alias ...string)

+ func (v *View) From(table, alias string)

+ func (v *View) GroupBy(columns ...string)

+ func (v *View) Join(table, alias, on string)

+ func (v *View) LeftJoin(table, alias, on string)

+ func (v *View) SelectRaw(name, expr string) *ViewColumn

+ type ViewColumn struct

+ OutputAlias string

+ RawExpr string

+ SourceAlias string

+ SourceColumn string

+ func (vc *ViewColumn) BigInteger() *ViewColumn

+ func (vc *ViewColumn) BooleanType() *ViewColumn

+ func (vc *ViewColumn) Decimal(precision, scale int) *ViewColumn

+ func (vc *ViewColumn) IntegerType() *ViewColumn

+ func (vc *ViewColumn) JSONBType() *ViewColumn

+ func (vc *ViewColumn) OutputName() string

+ func (vc *ViewColumn) StringType(length ...int) *ViewColumn

+ func (vc *ViewColumn) TextType() *ViewColumn

+ func (vc *ViewColumn) TimestampType() *ViewColumn

+ func (vc *ViewColumn) UUIDType() *ViewColumn

+ type ViewSource struct

+ Alias string

+ JoinCondition string

+ JoinType string

+ Table string

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