schema

package
Version: v0.8.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 25, 2022 License: Apache-2.0 Imports: 6 Imported by: 15

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrLocked = errors.New("sql/schema: lock is held by other session")

ErrLocked is returned on Lock calls which have failed to obtain the lock.

Functions

func IsNotExistError

func IsNotExistError(err error) bool

IsNotExistError reports if an error is a NotExistError.

func ReplaceOrAppend added in v0.3.8

func ReplaceOrAppend(attrs *[]Attr, v Attr)

ReplaceOrAppend searches an attribute of the same type as v in the list and replaces it. Otherwise, v is appended to the list.

Types

type AddAttr

type AddAttr struct {
	A Attr
}

AddAttr describes an attribute addition.

type AddCheck added in v0.2.0

type AddCheck struct {
	C *Check
}

AddCheck describes a CHECK constraint creation change.

type AddColumn

type AddColumn struct {
	C *Column
}

AddColumn describes a column creation change.

type AddForeignKey

type AddForeignKey struct {
	F *ForeignKey
}

AddForeignKey describes a foreign-key creation change.

type AddIndex

type AddIndex struct {
	I *Index
}

AddIndex describes an index creation change.

type AddSchema added in v0.2.0

type AddSchema struct {
	S     *Schema
	Extra []Clause // Extra clauses and options.
}

AddSchema describes a schema (named database) creation change. Unlike table creation, schemas and their elements are described with separate changes. For example, "AddSchema" and "AddTable"

type AddTable

type AddTable struct {
	T     *Table
	Extra []Clause // Extra clauses and options.
}

AddTable describes a table creation change.

type Attr

type Attr interface {
	// contains filtered or unexported methods
}

Attr represents the interface that all attributes implement.

func RemoveAttr added in v0.8.2

func RemoveAttr[T Attr](attrs []Attr) []Attr

RemoveAttr returns a new slice where all attributes of type T are filtered.

type BinaryOption added in v0.2.0

type BinaryOption func(*BinaryType)

BinaryOption allows configuring BinaryType using functional options.

func BinarySize added in v0.2.0

func BinarySize(size int) BinaryOption

BinarySize configures the size of the binary type.

type BinaryType

type BinaryType struct {
	T    string
	Size *int
}

BinaryType represents a type that stores a binary data.

type BoolType

type BoolType struct {
	T string
}

BoolType represents a boolean type.

type Change

type Change interface {
	// contains filtered or unexported methods
}

A Change represents a schema change. The types below implement this interface and can be used for describing schema changes.

The Change interface can also be implemented outside this package as follows:

type RenameType struct {
	schema.Change
	From, To string
}

var t schema.Change = &RenameType{From: "old", To: "new"}

type ChangeKind

type ChangeKind uint

A ChangeKind describes a change kind that can be combined using a set of flags. The zero kind is no change.

const (
	// NoChange holds the zero value of a change kind.
	NoChange ChangeKind = 0

	// ChangeAttr describes attributes change of an element.
	// For example, a table CHECK was added or changed.
	ChangeAttr ChangeKind = 1 << (iota - 1)
	// ChangeCharset describes character-set change.
	ChangeCharset
	// ChangeCollate describes collation/encoding change.
	ChangeCollate
	// ChangeComment describes comment chang (of any element).
	ChangeComment

	// ChangeNull describe a change to the NULL constraint.
	ChangeNull
	// ChangeType describe a column type change.
	ChangeType
	// ChangeDefault describe a column default change.
	ChangeDefault
	// ChangeGenerated describe a change to the generated expression.
	ChangeGenerated

	// ChangeUnique describes a change to the uniqueness constraint.
	// For example, an index was changed from non-unique to unique.
	ChangeUnique
	// ChangeParts describes a change to one or more of the index parts.
	// For example, index keeps its previous name, but the columns order
	// was changed.
	ChangeParts

	// ChangeColumn describes a change to the foreign-key (child) columns.
	ChangeColumn
	// ChangeRefColumn describes a change to the foreign-key (parent) columns.
	ChangeRefColumn
	// ChangeRefTable describes a change to the foreign-key (parent) table.
	ChangeRefTable
	// ChangeUpdateAction describes a change to the foreign-key update action.
	ChangeUpdateAction
	// ChangeDeleteAction describes a change to the foreign-key delete action.
	ChangeDeleteAction
)

func (ChangeKind) Is

func (k ChangeKind) Is(c ChangeKind) bool

Is reports whether c is match the given change kind.

func (ChangeKind) String added in v0.8.2

func (i ChangeKind) String() string

type Changes added in v0.3.8

type Changes []Change

Changes is a list of changes allow for searching and mutating changes.

func (Changes) IndexAddColumn added in v0.3.8

func (c Changes) IndexAddColumn(name string) int

IndexAddColumn returns the index of the first AddColumn in the changes with the given name, or -1 if there is no such change in the Changes.

func (Changes) IndexAddIndex added in v0.3.8

func (c Changes) IndexAddIndex(name string) int

IndexAddIndex returns the index of the first AddIndex in the changes with the given name, or -1 if there is no such change in the Changes.

func (Changes) IndexAddTable added in v0.3.8

func (c Changes) IndexAddTable(name string) int

IndexAddTable returns the index of the first AddTable in the changes with the given name, or -1 if there is no such change in the Changes.

func (Changes) IndexDropColumn added in v0.3.8

func (c Changes) IndexDropColumn(name string) int

IndexDropColumn returns the index of the first DropColumn in the changes with the given name, or -1 if there is no such change in the Changes.

func (Changes) IndexDropIndex added in v0.3.8

func (c Changes) IndexDropIndex(name string) int

IndexDropIndex returns the index of the first DropIndex in the changes with the given name, or -1 if there is no such change in the Changes.

func (Changes) IndexDropTable added in v0.3.8

func (c Changes) IndexDropTable(name string) int

IndexDropTable returns the index of the first DropTable in the changes with the given name, or -1 if there is no such change in the Changes.

func (*Changes) RemoveIndex added in v0.3.8

func (c *Changes) RemoveIndex(indexes ...int)

RemoveIndex removes elements in the given indexes from the Changes.

type Charset

type Charset struct {
	V string
}

Charset describes a column or a table character-set setting.

type Check added in v0.2.0

type Check struct {
	Name  string // Optional constraint name.
	Expr  string // Actual CHECK.
	Attrs []Attr // Additional attributes (e.g. ENFORCED).
}

Check describes a CHECK constraint.

func NewCheck added in v0.3.0

func NewCheck() *Check

NewCheck creates a new check.

func (*Check) AddAttrs added in v0.3.0

func (c *Check) AddAttrs(attrs ...Attr) *Check

AddAttrs adds additional attributes to the check constraint.

func (*Check) SetExpr added in v0.3.0

func (c *Check) SetExpr(expr string) *Check

SetExpr configures the expression of the check constraint.

func (*Check) SetName added in v0.3.0

func (c *Check) SetName(name string) *Check

SetName configures the name of the check constraint.

type Clause added in v0.2.0

type Clause interface {
	// contains filtered or unexported methods
}

Clause carries additional information that can be added to schema changes. The Clause interface can be implemented outside this package as follows:

type Authorization struct {
	schema.Clause
	UserName string
}

var c schema.Clause = &Authorization{UserName: "a8m"}

type Collation

type Collation struct {
	V string
}

Collation describes a column or a table collation setting.

type Column

type Column struct {
	Name    string
	Type    *ColumnType
	Default Expr
	Attrs   []Attr
	Indexes []*Index
	// Foreign keys that this column is
	// part of their child columns.
	ForeignKeys []*ForeignKey
}

A Column represents a column definition.

func NewBinaryColumn added in v0.2.0

func NewBinaryColumn(name, typ string, opts ...BinaryOption) *Column

NewBinaryColumn creates a new BinaryType column.

func NewBoolColumn added in v0.2.0

func NewBoolColumn(name, typ string) *Column

NewBoolColumn creates a new BoolType column.

func NewColumn added in v0.2.0

func NewColumn(name string) *Column

NewColumn creates a new column with the given name.

func NewDecimalColumn added in v0.2.0

func NewDecimalColumn(name, typ string, opts ...DecimalOption) *Column

NewDecimalColumn creates a new DecimalType column.

func NewEnumColumn added in v0.2.0

func NewEnumColumn(name string, opts ...EnumOption) *Column

NewEnumColumn creates a new EnumType column.

func NewFloatColumn added in v0.2.0

func NewFloatColumn(name, typ string, opts ...FloatOption) *Column

NewFloatColumn creates a new FloatType column.

func NewIntColumn added in v0.2.0

func NewIntColumn(name, typ string) *Column

NewIntColumn creates a new IntegerType column.

func NewJSONColumn added in v0.2.0

func NewJSONColumn(name, typ string) *Column

NewJSONColumn creates a new JSONType column.

func NewNullBinaryColumn added in v0.2.0

func NewNullBinaryColumn(name, typ string, opts ...BinaryOption) *Column

NewNullBinaryColumn creates a new nullable BinaryType column.

func NewNullBoolColumn added in v0.2.0

func NewNullBoolColumn(name, typ string) *Column

NewNullBoolColumn creates a new nullable BoolType column.

func NewNullColumn added in v0.2.0

func NewNullColumn(name string) *Column

NewNullColumn creates a new nullable column with the given name.

func NewNullDecimalColumn added in v0.2.0

func NewNullDecimalColumn(name, typ string, opts ...DecimalOption) *Column

NewNullDecimalColumn creates a new nullable DecimalType column.

func NewNullEnumColumn added in v0.2.0

func NewNullEnumColumn(name string, opts ...EnumOption) *Column

NewNullEnumColumn creates a new nullable EnumType column.

func NewNullFloatColumn added in v0.2.0

func NewNullFloatColumn(name, typ string, opts ...FloatOption) *Column

NewNullFloatColumn creates a new nullable FloatType column.

func NewNullIntColumn added in v0.2.0

func NewNullIntColumn(name, typ string) *Column

NewNullIntColumn creates a new nullable IntegerType column.

func NewNullJSONColumn added in v0.2.0

func NewNullJSONColumn(name, typ string) *Column

NewNullJSONColumn creates a new nullable JSONType column.

func NewNullSpatialColumn added in v0.2.0

func NewNullSpatialColumn(name, typ string) *Column

NewNullSpatialColumn creates a new nullable SpatialType column.

func NewNullStringColumn added in v0.2.0

func NewNullStringColumn(name, typ string, opts ...StringOption) *Column

NewNullStringColumn creates a new nullable StringType column.

func NewNullTimeColumn added in v0.2.0

func NewNullTimeColumn(name, typ string) *Column

NewNullTimeColumn creates a new nullable TimeType column.

func NewNullUintColumn added in v0.2.0

func NewNullUintColumn(name, typ string) *Column

NewNullUintColumn creates a new nullable unsigned IntegerType column.

func NewSpatialColumn added in v0.2.0

func NewSpatialColumn(name, typ string) *Column

NewSpatialColumn creates a new SpatialType column.

func NewStringColumn added in v0.2.0

func NewStringColumn(name, typ string, opts ...StringOption) *Column

NewStringColumn creates a new StringType column.

func NewTimeColumn added in v0.2.0

func NewTimeColumn(name, typ string, opts ...TimeOption) *Column

NewTimeColumn creates a new TimeType column.

func NewUintColumn added in v0.2.0

func NewUintColumn(name, typ string) *Column

NewUintColumn creates a new unsigned IntegerType column.

func (*Column) AddAttrs added in v0.2.0

func (c *Column) AddAttrs(attrs ...Attr) *Column

AddAttrs adds additional attributes to the column.

func (*Column) SetCharset added in v0.2.0

func (c *Column) SetCharset(v string) *Column

SetCharset sets or appends the Charset attribute to the column with the given value.

func (*Column) SetCollation added in v0.2.0

func (c *Column) SetCollation(v string) *Column

SetCollation sets or appends the Collation attribute to the column with the given value.

func (*Column) SetComment added in v0.2.0

func (c *Column) SetComment(v string) *Column

SetComment sets or appends the Comment attribute to the column with the given value.

func (*Column) SetDefault added in v0.2.0

func (c *Column) SetDefault(x Expr) *Column

SetDefault configures the default of the column

func (*Column) SetGeneratedExpr added in v0.3.8

func (c *Column) SetGeneratedExpr(x *GeneratedExpr) *Column

SetGeneratedExpr sets or appends the GeneratedExpr attribute.

func (*Column) SetNull added in v0.2.0

func (c *Column) SetNull(b bool) *Column

SetNull configures the nullability of the column

func (*Column) SetType added in v0.2.0

func (c *Column) SetType(t Type) *Column

SetType configures the type of the column

func (*Column) UnsetCharset added in v0.3.0

func (c *Column) UnsetCharset() *Column

UnsetCharset unsets the Charset attribute.

func (*Column) UnsetCollation added in v0.3.0

func (c *Column) UnsetCollation() *Column

UnsetCollation the Collation attribute.

type ColumnType

type ColumnType struct {
	Type Type
	Raw  string
	Null bool
}

ColumnType represents a column type that is implemented by the dialect.

type Comment

type Comment struct {
	Text string
}

Comment describes a schema element comment.

type DecimalOption added in v0.2.0

type DecimalOption func(*DecimalType)

DecimalOption allows configuring DecimalType using functional options.

func DecimalPrecision added in v0.2.0

func DecimalPrecision(precision int) DecimalOption

DecimalPrecision configures the precision of the decimal type.

func DecimalScale added in v0.2.0

func DecimalScale(scale int) DecimalOption

DecimalScale configures the scale of the decimal type.

func DecimalUnsigned added in v0.3.4

func DecimalUnsigned(unsigned bool) DecimalOption

DecimalUnsigned configures the unsigned of the float type.

type DecimalType

type DecimalType struct {
	T         string
	Precision int
	Scale     int
	Unsigned  bool
}

DecimalType represents a fixed-point type that stores exact numeric values.

type Differ

type Differ interface {
	// RealmDiff returns a diff report for migrating a realm
	// (or a database) from state "from" to state "to". An error
	// is returned if such step is not possible.
	RealmDiff(from, to *Realm) ([]Change, error)

	// SchemaDiff returns a diff report for migrating a schema
	// from state "from" to state "to". An error is returned
	// if such step is not possible.
	SchemaDiff(from, to *Schema) ([]Change, error)

	// TableDiff returns a diff report for migrating a table
	// from state "from" to state "to". An error is returned
	// if such step is not possible.
	TableDiff(from, to *Table) ([]Change, error)
}

Differ is the interface implemented by the different drivers for comparing and diffing schema top elements.

type DropAttr

type DropAttr struct {
	A Attr
}

DropAttr describes an attribute removal.

type DropCheck added in v0.2.0

type DropCheck struct {
	C *Check
}

DropCheck describes a CHECK constraint removal change.

type DropColumn

type DropColumn struct {
	C *Column
}

DropColumn describes a column removal change.

type DropForeignKey

type DropForeignKey struct {
	F *ForeignKey
}

DropForeignKey describes a foreign-key removal change.

type DropIndex

type DropIndex struct {
	I *Index
}

DropIndex describes an index removal change.

type DropSchema added in v0.2.0

type DropSchema struct {
	S     *Schema
	Extra []Clause // Extra clauses and options.
}

DropSchema describes a schema (named database) removal change.

type DropTable

type DropTable struct {
	T     *Table
	Extra []Clause // Extra clauses.
}

DropTable describes a table removal change.

type EnumOption added in v0.2.0

type EnumOption func(*EnumType)

EnumOption allows configuring EnumType using functional options.

func EnumName added in v0.2.0

func EnumName(name string) EnumOption

EnumName configures the name of the name. This option is useful for databases like PostgreSQL that supports user-defined types for enums.

func EnumSchema added in v0.6.0

func EnumSchema(s *Schema) EnumOption

EnumSchema configures the schema of the enum.

func EnumValues added in v0.2.0

func EnumValues(values ...string) EnumOption

EnumValues configures the values of the enum.

type EnumType

type EnumType struct {
	T      string   // Optional type.
	Values []string // Enum values.
	Schema *Schema  // Optional schema.
}

EnumType represents an enum type.

type ExecQuerier

type ExecQuerier interface {
	QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error)
	ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)
}

ExecQuerier wraps the two standard sql.DB methods.

type Expr

type Expr interface {
	// contains filtered or unexported methods
}

Expr defines an SQL expression in schema DDL.

type FloatOption added in v0.2.0

type FloatOption func(*FloatType)

FloatOption allows configuring FloatType using functional options.

func FloatPrecision added in v0.2.0

func FloatPrecision(precision int) FloatOption

FloatPrecision configures the precision of the float type.

func FloatUnsigned added in v0.3.4

func FloatUnsigned(unsigned bool) FloatOption

FloatUnsigned configures the unsigned of the float type.

type FloatType

type FloatType struct {
	T         string
	Unsigned  bool
	Precision int
}

FloatType represents a floating-point type that stores approximate numeric values.

type ForeignKey

type ForeignKey struct {
	Symbol     string
	Table      *Table
	Columns    []*Column
	RefTable   *Table
	RefColumns []*Column
	OnUpdate   ReferenceOption
	OnDelete   ReferenceOption
}

A ForeignKey represents an index definition.

func NewForeignKey added in v0.2.0

func NewForeignKey(symbol string) *ForeignKey

NewForeignKey creates a new foreign-key with the given constraints/symbol name.

func (*ForeignKey) AddColumns added in v0.2.0

func (f *ForeignKey) AddColumns(columns ...*Column) *ForeignKey

AddColumns appends columns to the child-table columns.

func (*ForeignKey) AddRefColumns added in v0.2.0

func (f *ForeignKey) AddRefColumns(columns ...*Column) *ForeignKey

AddRefColumns appends columns to the parent-table columns.

func (*ForeignKey) Column

func (f *ForeignKey) Column(name string) (*Column, bool)

Column returns the first column that matches the given name.

func (*ForeignKey) RefColumn

func (f *ForeignKey) RefColumn(name string) (*Column, bool)

RefColumn returns the first referenced column that matches the given name.

func (*ForeignKey) SetOnDelete added in v0.2.0

func (f *ForeignKey) SetOnDelete(o ReferenceOption) *ForeignKey

SetOnDelete sets the ON DELETE constraint action.

func (*ForeignKey) SetOnUpdate added in v0.2.0

func (f *ForeignKey) SetOnUpdate(o ReferenceOption) *ForeignKey

SetOnUpdate sets the ON UPDATE constraint action.

func (*ForeignKey) SetRefTable added in v0.2.0

func (f *ForeignKey) SetRefTable(t *Table) *ForeignKey

SetRefTable configures the referenced/parent table.

func (*ForeignKey) SetTable added in v0.2.0

func (f *ForeignKey) SetTable(t *Table) *ForeignKey

SetTable configures the table that holds the foreign-key (child table).

type GeneratedExpr added in v0.3.8

type GeneratedExpr struct {
	Expr string
	Type string // Optional type. e.g. STORED or VIRTUAL.
}

GeneratedExpr describes the expression used for generating the value of a generated/virtual column.

type IfExists added in v0.2.0

type IfExists struct{}

IfExists represents a clause in a schema change that is commonly supported by multiple statements (e.g. DROP TABLE or DROP SCHEMA).

type IfNotExists added in v0.2.0

type IfNotExists struct{}

IfNotExists represents a clause in a schema change that is commonly supported by multiple statements (e.g. CREATE TABLE or CREATE SCHEMA).

type Index

type Index struct {
	Name   string
	Unique bool
	Table  *Table
	Attrs  []Attr
	Parts  []*IndexPart
}

An Index represents an index definition.

func NewIndex added in v0.2.0

func NewIndex(name string) *Index

NewIndex creates a new index with the given name.

func NewPrimaryKey added in v0.2.0

func NewPrimaryKey(columns ...*Column) *Index

NewPrimaryKey creates a new primary-key index for the given columns.

func NewUniqueIndex added in v0.2.0

func NewUniqueIndex(name string) *Index

NewUniqueIndex creates a new unique index with the given name.

func (*Index) AddAttrs added in v0.2.0

func (i *Index) AddAttrs(attrs ...Attr) *Index

AddAttrs adds additional attributes to the index.

func (*Index) AddColumns added in v0.2.0

func (i *Index) AddColumns(columns ...*Column) *Index

AddColumns adds the columns to index parts.

func (*Index) AddExprs added in v0.2.0

func (i *Index) AddExprs(exprs ...Expr) *Index

AddExprs adds the expressions to index parts.

func (*Index) AddParts added in v0.2.0

func (i *Index) AddParts(parts ...*IndexPart) *Index

AddParts appends the given parts.

func (*Index) SetComment added in v0.3.0

func (i *Index) SetComment(v string) *Index

SetComment sets or appends the Comment attribute to the index with the given value.

func (*Index) SetName added in v0.2.0

func (i *Index) SetName(name string) *Index

SetName configures the name of the index.

func (*Index) SetTable added in v0.2.0

func (i *Index) SetTable(t *Table) *Index

SetTable configures the table of the index.

func (*Index) SetUnique added in v0.2.0

func (i *Index) SetUnique(b bool) *Index

SetUnique configures the uniqueness of the index.

type IndexPart

type IndexPart struct {
	// SeqNo represents the sequence number of the key part
	// in the index.
	SeqNo int
	// Desc indicates if the key part is stored in descending
	// order. All databases use ascending order as default.
	Desc  bool
	X     Expr
	C     *Column
	Attrs []Attr
}

An IndexPart represents an index part that can be either an expression or a column.

func NewColumnPart added in v0.3.2

func NewColumnPart(c *Column) *IndexPart

NewColumnPart creates a new index part with the given column.

func NewExprPart added in v0.3.2

func NewExprPart(x Expr) *IndexPart

NewExprPart creates a new index part with the given expression.

func NewIndexPart added in v0.2.0

func NewIndexPart() *IndexPart

NewIndexPart creates a new index part.

func (*IndexPart) AddAttrs added in v0.2.0

func (p *IndexPart) AddAttrs(attrs ...Attr) *IndexPart

AddAttrs adds and additional attributes to the index-part.

func (*IndexPart) SetColumn added in v0.2.0

func (p *IndexPart) SetColumn(c *Column) *IndexPart

SetColumn sets the column of the index-part.

func (*IndexPart) SetDesc added in v0.3.2

func (p *IndexPart) SetDesc(b bool) *IndexPart

SetDesc configures the "DESC" attribute of the key part.

func (*IndexPart) SetExpr added in v0.2.0

func (p *IndexPart) SetExpr(x Expr) *IndexPart

SetExpr sets the expression of the index-part.

type InspectMode added in v0.3.8

type InspectMode uint

An InspectMode controls the amount and depth of information returned on inspection.

const (
	// InspectSchemas enables schema inspection.
	InspectSchemas InspectMode = 1 << iota

	// InspectTables enables schema tables inspection including
	// all its child resources (e.g. columns or indexes).
	InspectTables
)

func (InspectMode) Is added in v0.3.8

func (m InspectMode) Is(i InspectMode) bool

Is reports whether the given mode is enabled.

type InspectOptions

type InspectOptions struct {
	// Mode defines the amount of information returned by InspectSchema.
	// If zero, InspectSchema inspects whole resources in the schema.
	Mode InspectMode

	// Tables to inspect. Empty means all tables in the schema.
	Tables []string

	// Exclude defines a list of glob patterns used to filter resources from inspection.
	// The syntax used by the different drivers is implemented as follows:
	//
	//	t   // exclude table 't'.
	//	*   // exclude all tables.
	//	t.c // exclude column, index and foreign-key named 'c' in table 't'.
	//	t.* // the last item defines the filtering; all resources under 't' are excluded.
	//	*.c // the last item defines the filtering; all resourced named 'c' are excluded in all tables.
	//	*.* // the last item defines the filtering; all resourced under all tables are excluded.
	//
	Exclude []string
}

InspectOptions describes options for Inspector.

type InspectRealmOption

type InspectRealmOption struct {
	// Mode defines the amount of information returned by InspectRealm.
	// If zero, InspectRealm inspects all schemas and their child resources.
	Mode InspectMode

	// Schemas to inspect. Empty means all schemas in the realm.
	Schemas []string

	// Exclude defines a list of glob patterns used to filter resources from inspection.
	// The syntax used by the different drivers is implemented as follows:
	//
	//	s     // exclude schema 't'.
	//	*     // exclude all schemas.
	//	s.t   // exclude table 't' under schema 's'.
	//	s.*   // the last item defines the filtering; all tables under 's' are excluded.
	//	*.t   // the last item defines the filtering; all tables named 't' are excluded in all schemas.
	//	*.*   // the last item defines the filtering; all tables under all schemas are excluded.
	//	*.*.c // the last item defines the filtering; all resourced named 'c' are excluded in all tables.
	//	*.*.* // the last item defines the filtering; all resources are excluded in all tables.
	//
	Exclude []string
}

InspectRealmOption describes options for RealmInspector.

type Inspector

type Inspector interface {
	// InspectSchema returns the schema description by its name. An empty name means the
	// "attached schema" (e.g. SCHEMA() in MySQL or CURRENT_SCHEMA() in PostgreSQL).
	// A NotExistError error is returned if the schema does not exist in the database.
	InspectSchema(ctx context.Context, name string, opts *InspectOptions) (*Schema, error)

	// InspectRealm returns the description of the connected database.
	InspectRealm(ctx context.Context, opts *InspectRealmOption) (*Realm, error)
}

Inspector is the interface implemented by the different database drivers for inspecting schema or databases.

type IntegerType

type IntegerType struct {
	T        string
	Unsigned bool
	Attrs    []Attr
}

IntegerType represents an int type.

type JSONType

type JSONType struct {
	T string
}

JSONType represents a JSON type.

type Literal

type Literal struct {
	V string
}

Literal represents a basic literal expression like 1, or '1'. String literals are usually quoted with single or double quotes.

type Locker added in v0.3.8

type Locker interface {
	// Lock acquires a named "advisory lock", using the given timeout. Negative value means no timeout,
	// and the zero value means a "try lock" mode. i.e. return immediately if the lock is already taken.
	// The returned unlock function is used to release the advisory lock acquired by the session.
	//
	// An ErrLocked is returned if the operation failed to obtain the lock in all different timeout modes.
	Lock(ctx context.Context, name string, timeout time.Duration) (UnlockFunc, error)
}

Locker is an interface that is optionally implemented by the different drivers for obtaining an "advisory lock" with the given name.

type ModifyAttr

type ModifyAttr struct {
	From, To Attr
}

ModifyAttr describes a change that modifies an element attribute.

type ModifyCheck added in v0.2.0

type ModifyCheck struct {
	From, To *Check
	Change   ChangeKind
}

ModifyCheck describes a change that modifies a check.

type ModifyColumn

type ModifyColumn struct {
	From, To *Column
	Change   ChangeKind
}

ModifyColumn describes a change that modifies a column.

type ModifyForeignKey

type ModifyForeignKey struct {
	From, To *ForeignKey
	Change   ChangeKind
}

ModifyForeignKey describes a change that modifies a foreign-key.

type ModifyIndex

type ModifyIndex struct {
	From, To *Index
	Change   ChangeKind
}

ModifyIndex describes an index modification.

type ModifySchema added in v0.2.0

type ModifySchema struct {
	S       *Schema
	Changes []Change
}

ModifySchema describes a modification change for schema attributes.

type ModifyTable

type ModifyTable struct {
	T       *Table
	Changes []Change
}

ModifyTable describes a table modification change.

type Normalizer added in v0.3.6

type Normalizer interface {
	// NormalizeSchema returns the normal representation of a schema.
	NormalizeSchema(context.Context, *Schema) (*Schema, error)

	// NormalizeRealm returns the normal representation of a database.
	NormalizeRealm(context.Context, *Realm) (*Realm, error)
}

Normalizer is the interface implemented by the different database drivers for "normalizing" schema objects. i.e. converting schema objects defined in natural form to their representation in the database. Thus, two schema objects are equal if their normal forms are equal.

type NotExistError

type NotExistError struct {
	Err error
}

A NotExistError wraps another error to retain its original text but makes it possible to the migrator to catch it.

func (NotExistError) Error

func (e NotExistError) Error() string

type RawExpr

type RawExpr struct {
	X string
}

RawExpr represents a raw expression like "uuid()" or "current_timestamp()". Unlike literals, raw expression are usually inlined as is on migration.

type Realm

type Realm struct {
	Schemas []*Schema
	Attrs   []Attr
}

A Realm or a database describes a domain of schema resources that are logically connected and can be accessed and queried in the same connection (e.g. a physical database instance).

func NewRealm added in v0.3.4

func NewRealm(schemas ...*Schema) *Realm

NewRealm creates a new Realm.

func (*Realm) AddSchemas added in v0.6.0

func (r *Realm) AddSchemas(schemas ...*Schema) *Realm

AddSchemas adds and links the given schemas to the realm.

func (*Realm) Schema added in v0.2.0

func (r *Realm) Schema(name string) (*Schema, bool)

Schema returns the first schema that matched the given name.

func (*Realm) SetCharset added in v0.3.4

func (r *Realm) SetCharset(v string) *Realm

SetCharset sets or appends the Charset attribute to the realm with the given value.

func (*Realm) SetCollation added in v0.3.4

func (r *Realm) SetCollation(v string) *Realm

SetCollation sets or appends the Collation attribute to the realm with the given value.

func (*Realm) UnsetCharset added in v0.3.4

func (r *Realm) UnsetCharset() *Realm

UnsetCharset unsets the Charset attribute.

func (*Realm) UnsetCollation added in v0.3.4

func (r *Realm) UnsetCollation() *Realm

UnsetCollation the Collation attribute.

type ReferenceOption

type ReferenceOption string

ReferenceOption for constraint actions.

const (
	NoAction   ReferenceOption = "NO ACTION"
	Restrict   ReferenceOption = "RESTRICT"
	Cascade    ReferenceOption = "CASCADE"
	SetNull    ReferenceOption = "SET NULL"
	SetDefault ReferenceOption = "SET DEFAULT"
)

Reference options (actions) specified by ON UPDATE and ON DELETE subclauses of the FOREIGN KEY clause.

type RenameColumn added in v0.3.8

type RenameColumn struct {
	From, To *Column
}

RenameColumn describes a column rename change.

type RenameIndex added in v0.3.8

type RenameIndex struct {
	From, To *Index
}

RenameIndex describes an index rename change.

type RenameTable added in v0.3.8

type RenameTable struct {
	From, To *Table
}

RenameTable describes a table rename change.

type Schema

type Schema struct {
	Name   string
	Realm  *Realm
	Tables []*Table
	Attrs  []Attr // Attrs and options.
}

A Schema describes a database schema (i.e. named database).

func New added in v0.2.0

func New(name string) *Schema

New creates a new Schema.

func (*Schema) AddAttrs added in v0.2.0

func (s *Schema) AddAttrs(attrs ...Attr) *Schema

AddAttrs adds additional attributes to the schema.

func (*Schema) AddTables added in v0.2.0

func (s *Schema) AddTables(tables ...*Table) *Schema

AddTables adds and links the given tables to the schema.

func (*Schema) SetCharset added in v0.2.0

func (s *Schema) SetCharset(v string) *Schema

SetCharset sets or appends the Charset attribute to the schema with the given value.

func (*Schema) SetCollation added in v0.2.0

func (s *Schema) SetCollation(v string) *Schema

SetCollation sets or appends the Collation attribute to the schema with the given value.

func (*Schema) SetComment added in v0.2.0

func (s *Schema) SetComment(v string) *Schema

SetComment sets or appends the Comment attribute to the schema with the given value.

func (*Schema) SetRealm added in v0.2.0

func (s *Schema) SetRealm(r *Realm) *Schema

SetRealm sets the database/realm of the schema.

func (*Schema) Table

func (s *Schema) Table(name string) (*Table, bool)

Table returns the first table that matched the given name.

func (*Schema) UnsetCharset added in v0.3.0

func (s *Schema) UnsetCharset() *Schema

UnsetCharset unsets the Charset attribute.

func (*Schema) UnsetCollation added in v0.3.0

func (s *Schema) UnsetCollation() *Schema

UnsetCollation the Collation attribute.

type SpatialType

type SpatialType struct {
	T string
}

SpatialType represents a spatial/geometric type.

type StringOption added in v0.2.0

type StringOption func(*StringType)

StringOption allows configuring StringType using functional options.

func StringSize added in v0.2.0

func StringSize(size int) StringOption

StringSize configures the size of the string type.

type StringType

type StringType struct {
	T    string
	Size int
}

StringType represents a string type.

type Table

type Table struct {
	Name        string
	Schema      *Schema
	Columns     []*Column
	Indexes     []*Index
	PrimaryKey  *Index
	ForeignKeys []*ForeignKey
	Attrs       []Attr // Attrs, constraints and options.
}

A Table represents a table definition.

func NewTable added in v0.2.0

func NewTable(name string) *Table

NewTable creates a new Table.

func (*Table) AddAttrs added in v0.2.0

func (t *Table) AddAttrs(attrs ...Attr) *Table

AddAttrs adds and additional attributes to the table.

func (*Table) AddChecks added in v0.2.0

func (t *Table) AddChecks(checks ...*Check) *Table

AddChecks appends the given checks to the attribute list.

func (*Table) AddColumns added in v0.2.0

func (t *Table) AddColumns(columns ...*Column) *Table

AddColumns appends the given columns to the table column list.

func (*Table) AddForeignKeys added in v0.2.0

func (t *Table) AddForeignKeys(fks ...*ForeignKey) *Table

AddForeignKeys appends the given foreign-keys to the table foreign-key list.

func (*Table) AddIndexes added in v0.2.0

func (t *Table) AddIndexes(indexes ...*Index) *Table

AddIndexes appends the given indexes to the table index list.

func (*Table) Column

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

Column returns the first column that matched the given name.

func (*Table) ForeignKey

func (t *Table) ForeignKey(symbol string) (*ForeignKey, bool)

ForeignKey returns the first foreign-key that matched the given symbol (constraint name).

func (*Table) Index

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

Index returns the first index that matched the given name.

func (*Table) SetCharset added in v0.2.0

func (t *Table) SetCharset(v string) *Table

SetCharset sets or appends the Charset attribute to the table with the given value.

func (*Table) SetCollation added in v0.2.0

func (t *Table) SetCollation(v string) *Table

SetCollation sets or appends the Collation attribute to the table with the given value.

func (*Table) SetComment added in v0.2.0

func (t *Table) SetComment(v string) *Table

SetComment sets or appends the Comment attribute to the table with the given value.

func (*Table) SetPrimaryKey added in v0.2.0

func (t *Table) SetPrimaryKey(pk *Index) *Table

SetPrimaryKey sets the primary-key of the table.

func (*Table) SetSchema added in v0.2.0

func (t *Table) SetSchema(s *Schema) *Table

SetSchema sets the schema (named-database) of the table.

func (*Table) UnsetCharset added in v0.3.0

func (t *Table) UnsetCharset() *Table

UnsetCharset unsets the Charset attribute.

func (*Table) UnsetCollation added in v0.3.0

func (t *Table) UnsetCollation() *Table

UnsetCollation the Collation attribute.

type TimeOption added in v0.3.2

type TimeOption func(*TimeType)

TimeOption allows configuring TimeType using functional options.

func TimePrecision added in v0.3.2

func TimePrecision(precision int) TimeOption

TimePrecision configures the precision of the time type.

type TimeType

type TimeType struct {
	T         string
	Precision *int
}

TimeType represents a date/time type.

type Type

type Type interface {
	// contains filtered or unexported methods
}

A Type represents a database type. The types below implements this interface and can be used for describing schemas.

The Type interface can also be implemented outside this package as follows:

type SpatialType struct {
	schema.Type
	T string
}

var t schema.Type = &SpatialType{T: "point"}

type UnlockFunc added in v0.3.8

type UnlockFunc func() error

UnlockFunc is returned by the Locker to explicitly release the named "advisory lock".

type UnsupportedType

type UnsupportedType struct {
	T string
}

UnsupportedType represents a type that is not supported by the drivers.

Jump to

Keyboard shortcuts

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