Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

schema

package

Go to main page

Versions in this module

v0

v0.14.8

Nov 10, 2024

v0.14.7

Nov 10, 2024

v0.14.6

Nov 10, 2024

v0.14.5

Nov 9, 2024

v0.14.3

Oct 30, 2024

v0.14.2

Oct 15, 2024

v0.14.1

Oct 14, 2024

Changes in this version

+ const DefaultStringLen

+ const MaxTypes

+ const ModeInspect

+ const ModeReplay

+ const Null

+ const PrimaryKey

+ const TypeTable

+ const UniqueKey

+ func Diff(ctx context.Context, u, name string, tables []*Table, opts ...MigrateOption) (err error)

+ type Applier interface

+ Apply func(context.Context, dialect.ExecQuerier, *migrate.Plan) error

+ type ApplyFunc func(context.Context, dialect.ExecQuerier, *migrate.Plan) error

+ func (f ApplyFunc) Apply(ctx context.Context, conn dialect.ExecQuerier, plan *migrate.Plan) error

+ type ApplyHook func(Applier) Applier

+ type Atlas struct

+ func NewMigrate(drv dialect.Driver, opts ...MigrateOption) (*Atlas, error)

+ func NewMigrateURL(u string, opts ...MigrateOption) (*Atlas, error)

+ func (a *Atlas) Create(ctx context.Context, tables ...*Table) (err error)

+ func (a *Atlas) Diff(ctx context.Context, tables ...*Table) error

+ func (a *Atlas) NamedDiff(ctx context.Context, name string, tables ...*Table) error

+ func (a *Atlas) StateReader(tables ...*Table) migrate.StateReaderFunc

+ func (a *Atlas) VerifyTableRange(ctx context.Context, tables []*Table) error

+ type ChangeKind uint

+ const AddCheck

+ const AddColumn

+ const AddForeignKey

+ const AddIndex

+ const AddSchema

+ const AddTable

+ const DropCheck

+ const DropColumn

+ const DropForeignKey

+ const DropIndex

+ const DropSchema

+ const DropTable

+ const ModifyCheck

+ const ModifyColumn

+ const ModifyForeignKey

+ const ModifyIndex

+ const ModifySchema

+ const ModifyTable

+ const NoChange

+ func (k ChangeKind) Is(c ChangeKind) bool

+ type Column struct

+ Attr string

+ Collation string

+ Comment string

+ Default any

+ Enums []string

+ Increment bool

+ Key string

+ Name string

+ Nullable bool

+ SchemaType map[string]string

+ Size int64

+ Type field.Type

+ Unique bool

+ func (c *Column) ConvertibleTo(d *Column) bool

+ func (c *Column) PrimaryKey() bool

+ func (c *Column) ScanDefault(value string) error

+ func (c *Column) UniqueKey() bool

+ func (c Column) FloatType() bool

+ func (c Column) IntType() bool

+ func (c Column) UintType() bool

+ type CreateFunc func(context.Context, ...*Table) error

+ func (f CreateFunc) Create(ctx context.Context, tables ...*Table) error

+ type Creator interface

+ Create func(context.Context, ...*Table) error

+ type DiffFunc func(current, desired *schema.Schema) ([]schema.Change, error)

+ func (f DiffFunc) Diff(current, desired *schema.Schema) ([]schema.Change, error)

+ type DiffHook func(Differ) Differ

+ type Differ interface

+ Diff func(current, desired *schema.Schema) ([]schema.Change, error)

+ type DirWriter struct

+ Dir migrate.Dir

+ Formatter migrate.Formatter

+ func (d *DirWriter) Change(comment string)

+ func (d *DirWriter) Flush(name string) error

+ func (d *DirWriter) FlushChange(name, comment string) error

+ func (d *DirWriter) Write(p []byte) (int, error)

+ type Expr string

+ type ForeignKey struct

+ Columns []*Column

+ OnDelete ReferenceOption

+ OnUpdate ReferenceOption

+ RefColumns []*Column

+ RefTable *Table

+ Symbol string

+ func (fk ForeignKey) DSL() *sql.ForeignKeyBuilder

+ type Hook func(Creator) Creator

+ type Index struct

+ Annotation *entsql.IndexAnnotation

+ Columns []*Column

+ Name string

+ Unique bool

+ func (i *Index) Builder(table string) *sql.IndexBuilder

+ func (i *Index) DropBuilder(table string) *sql.DropIndexBuilder

+ type Indexes []*Index

+ type InspectOption func(inspect *Inspector)

+ func WithSchema(schema string) InspectOption

+ type Inspector struct

+ func NewInspect(d dialect.Driver, opts ...InspectOption) (*Inspector, error)

+ func (i *Inspector) Tables(ctx context.Context) ([]*Table, error)

+ type Migrate struct

+ func (m *Migrate) Create(ctx context.Context, tables ...*Table) error

+ type MigrateOption func(*Atlas)

+ func DisableChecksum() MigrateOption

+ func WithApplyHook(hooks ...ApplyHook) MigrateOption

+ func WithAtlas(b bool) MigrateOption

+ func WithDialect(d string) MigrateOption

+ func WithDiffHook(hooks ...DiffHook) MigrateOption

+ func WithDiffOptions(opts ...schema.DiffOption) MigrateOption

+ func WithDir(dir migrate.Dir) MigrateOption

+ func WithDropColumn(b bool) MigrateOption

+ func WithDropIndex(b bool) MigrateOption

+ func WithErrNoPlan(b bool) MigrateOption

+ func WithFixture(b bool) MigrateOption

+ func WithForeignKeys(b bool) MigrateOption

+ func WithFormatter(fmt migrate.Formatter) MigrateOption

+ func WithGlobalUniqueID(b bool) MigrateOption

+ func WithHooks(hooks ...Hook) MigrateOption

+ func WithIndent(indent string) MigrateOption

+ func WithMigrationMode(mode Mode) MigrateOption

+ func WithSkipChanges(skip ChangeKind) MigrateOption

+ func WithSumFile() MigrateOption

+ type Mode uint

+ type MySQL struct

+ type Postgres struct

+ type ReferenceOption string

+ const Cascade

+ const NoAction

+ const Restrict

+ const SetDefault

+ const SetNull

+ func (r ReferenceOption) ConstName() string

+ type SQLite struct

+ WithForeignKeys bool

+ func (d *SQLite) Tx(ctx context.Context) (dialect.Tx, error)

+ type SQLiteTx struct

+ func (tx *SQLiteTx) Commit() error

+ func (tx *SQLiteTx) Rollback() error

+ type Table struct

+ Annotation *entsql.Annotation

+ Columns []*Column

+ Comment string

+ ForeignKeys []*ForeignKey

+ Indexes []*Index

+ Name string

+ PrimaryKey []*Column

+ Schema string

+ View bool

+ func CopyTables(tables []*Table) ([]*Table, error)

+ func NewTable(name string) *Table

+ func NewTypesTable() *Table

+ func NewView(name string) *Table

+ func (t *Table) AddColumn(c *Column) *Table

+ func (t *Table) AddForeignKey(fk *ForeignKey) *Table

+ func (t *Table) AddIndex(name string, unique bool, columns []string) *Table

+ func (t *Table) AddPrimary(c *Column) *Table

+ func (t *Table) Column(name string) (*Column, bool)

+ func (t *Table) HasColumn(name string) bool

+ func (t *Table) Index(name string) (*Index, bool)

+ func (t *Table) SetAnnotation(ant *entsql.Annotation) *Table

+ func (t *Table) SetComment(c string) *Table

+ func (t *Table) SetSchema(s string) *Table

+ type WriteDriver struct

+ FormatFunc func(string) (string, error)

+ func NewWriteDriver(dialect string, w io.Writer) *WriteDriver

+ func (w *WriteDriver) Exec(_ context.Context, query string, args, res any) error

+ func (w *WriteDriver) Query(ctx context.Context, query string, args, res any) error

+ func (w *WriteDriver) Tx(context.Context) (dialect.Tx, error)