Documentation
¶
Index ¶
- func ApplyChanges(ctx context.Context, changes []schema.Change, p execPlanner, ...) error
- func CheckChangesScope(changes []schema.Change) error
- func CheckDiff(from, to *schema.Table, compare ...func(c1, c2 *schema.Check) bool) []schema.Change
- func CommentChange(from, to []schema.Attr) schema.ChangeKind
- func CommentDiff(from, to []schema.Attr) schema.Change
- func DefaultValue(c *schema.Column) (string, bool)
- func DetachCycles(changes []schema.Change) ([]schema.Change, error)
- func ExcludeRealm(r *schema.Realm, patterns []string) (*schema.Realm, error)
- func ExcludeSchema(s *schema.Schema, patterns []string) (*schema.Schema, error)
- func ExprLastIndex(expr string) int
- func Has(elements, target any) bool
- func IsLiteralBool(s string) bool
- func IsLiteralNumber(s string) bool
- func IsQuoted(s string, q ...byte) bool
- func LinkSchemaTables(schemas []*schema.Schema)
- func MayWrap(s string) string
- func ModeInspectRealm(o *schema.InspectRealmOption) schema.InspectMode
- func ModeInspectSchema(o *schema.InspectOptions) schema.InspectMode
- func P[T any](v T) *T
- func ReverseChanges(c []schema.Change)
- func ScanNullBool(rows *sql.Rows) (sql.NullBool, error)
- func ScanOne(rows *sql.Rows, dest ...any) error
- func ScanStrings(rows *sql.Rows) ([]string, error)
- func SchemaFKs(s *schema.Schema, rows *sql.Rows) error
- func SingleQuote(s string) (string, error)
- func Unquote(s string) (string, error)
- func V[T any](p *T) (v T)
- func ValidString(s sql.NullString) bool
- func ValuesEqual(v1, v2 []string) bool
- type Builder
- func (b *Builder) Clone() *Builder
- func (b *Builder) Comma() *Builder
- func (b *Builder) Ident(s string) *Builder
- func (b *Builder) MapComma(x any, f func(i int, b *Builder)) *Builder
- func (b *Builder) MapCommaErr(x any, f func(i int, b *Builder) error) error
- func (b *Builder) P(phrases ...string) *Builder
- func (b *Builder) String() string
- func (b *Builder) Table(t *schema.Table) *Builder
- func (b *Builder) Wrap(f func(b *Builder)) *Builder
- type DevDriver
- type Diff
- type DiffDriver
- type ExecQueryCloser
- type Normalizer
- type UnsupportedTypeError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ApplyChanges ¶ added in v0.2.0
func ApplyChanges(ctx context.Context, changes []schema.Change, p execPlanner, opts ...migrate.PlanOption) error
ApplyChanges is a helper used by the different drivers to apply changes.
func CheckChangesScope ¶ added in v0.6.0
CheckChangesScope checks that changes can be applied on a schema scope (connection).
func CheckDiff ¶ added in v0.2.0
CheckDiff computes the change diff between the 2 tables. A compare function is provided to check if a Check object was modified.
func CommentChange ¶
func CommentChange(from, to []schema.Attr) schema.ChangeKind
CommentChange reports if the element comment was changed.
func CommentDiff ¶ added in v0.3.0
CommentDiff computes the comment diff between the 2 attribute list. Note that, the implementation relies on the fact that both PostgreSQL and MySQL treat empty comment as "no comment" and a way to clear comments.
func DefaultValue ¶ added in v0.2.0
DefaultValue returns the string represents the DEFAULT of a column.
func DetachCycles ¶
DetachCycles takes a list of schema changes, and detaches references between changes if there is at least one circular reference in the changeset. More explicitly, it postpones fks creation, or deletes fks before deletes their tables.
func ExcludeRealm ¶ added in v0.6.0
ExcludeRealm filters resources in the realm based on the given patterns.
func ExcludeSchema ¶ added in v0.6.0
ExcludeSchema filters resources in the schema based on the given patterns.
func ExprLastIndex ¶ added in v0.3.8
ExprLastIndex scans the first expression in the given string until its end and returns its last index.
func Has ¶
Has finds the first element in the elements list that matches target, and if so, sets target to that attribute value and returns true.
func IsLiteralBool ¶ added in v0.2.0
IsLiteralBool reports if the given string is a valid literal bool.
func IsLiteralNumber ¶ added in v0.2.0
IsLiteralNumber reports if the given string is a literal number.
func IsQuoted ¶ added in v0.2.0
IsQuoted reports if the given string is quoted with one of the given quotes (e.g. ', ", `).
func LinkSchemaTables ¶
LinkSchemaTables links foreign-key stub tables/columns to actual elements.
func MayWrap ¶ added in v0.3.7
MayWrap ensures the given string is wrapped with parentheses. Used by the different drivers to turn strings valid expressions.
func ModeInspectRealm ¶ added in v0.3.8
func ModeInspectRealm(o *schema.InspectRealmOption) schema.InspectMode
ModeInspectRealm returns the InspectMode or its default.
func ModeInspectSchema ¶ added in v0.3.8
func ModeInspectSchema(o *schema.InspectOptions) schema.InspectMode
ModeInspectSchema returns the InspectMode or its default.
func ReverseChanges ¶ added in v0.4.1
ReverseChanges reverses the order of the changes.
func ScanNullBool ¶ added in v0.3.8
ScanNullBool scans one sql.NullBool record and closes the rows at the end.
func ScanStrings ¶
ScanStrings scans sql.Rows into a slice of strings and closes it at the end.
func SchemaFKs ¶ added in v0.3.7
SchemaFKs scans the rows and adds the foreign-key to the schema table. Reference elements are added as stubs and should be linked manually by the caller.
func SingleQuote ¶ added in v0.3.0
SingleQuote quotes the given string with single quote.
func V ¶ added in v0.6.4
func V[T any](p *T) (v T)
V returns the value p is pointing to. If p is nil, the zero value is returned.
func ValidString ¶
func ValidString(s sql.NullString) bool
ValidString reports if the given string is not null and valid.
func ValuesEqual ¶
ValuesEqual checks if the 2 string slices are equal (including their order).
Types ¶
type Builder ¶
type Builder struct {
bytes.Buffer
QuoteChar byte // quoting identifiers
Schema *string // schema qualifier
}
A Builder provides a syntactic sugar API for writing SQL statements.
func (*Builder) Comma ¶
Comma writes a comma in case the buffer is not empty, or replaces the last char if it is a whitespace.
func (*Builder) MapComma ¶
MapComma maps the slice x using the function f and joins the result with a comma separating between the written elements.
func (*Builder) MapCommaErr ¶ added in v0.2.0
MapCommaErr is like MapComma, but returns an error if f returns an error.
func (*Builder) P ¶
P writes a list of phrases to the builder separated and suffixed with whitespace.
func (*Builder) String ¶
String overrides the Buffer.String method and ensure no spaces pad the returned statement.
type DevDriver ¶ added in v0.3.7
type DevDriver struct {
// A Driver connected to the dev database.
migrate.Driver
// MaxNameLen configures the max length of object names in
// the connected database (e.g. 64 in MySQL). Longer names
// are trimmed and suffixed with their hash.
MaxNameLen int
// DropClause holds optional clauses that
// can be added to the DropSchema change.
DropClause []schema.Clause
// PatchColumn allows providing a custom function to patch
// columns that hold a schema reference.
PatchColumn func(*schema.Schema, *schema.Column)
}
DevDriver is a driver that provides additional functionality to interact with the development database.
func (*DevDriver) NormalizeRealm ¶ added in v0.3.7
func (d *DevDriver) NormalizeRealm(ctx context.Context, r *schema.Realm) (nr *schema.Realm, err error)
NormalizeRealm implements the schema.Normalizer interface.
The implementation converts schema objects in "natural form" (e.g. HCL or DSL) to their "normal presentation" in the database, by creating them temporarily in a "dev database", and then inspects them from there.
type Diff ¶
type Diff struct {
DiffDriver
}
A Diff provides a generic schema.Differ for diffing schema elements.
The DiffDriver is required for supporting database/dialect specific diff capabilities, like diffing custom types or attributes.
func (*Diff) RealmDiff ¶ added in v0.2.0
RealmDiff implements the schema.Differ for Realm objects and returns a list of changes that need to be applied in order to move a database from the current state to the desired.
func (*Diff) SchemaDiff ¶
SchemaDiff implements the schema.Differ interface and returns a list of changes that need to be applied in order to move from one state to the other.
type DiffDriver ¶
type DiffDriver interface {
// SchemaAttrDiff returns a changeset for migrating schema attributes
// from one state to the other. For example, changing schema collation.
SchemaAttrDiff(from, to *schema.Schema) []schema.Change
// TableAttrDiff returns a changeset for migrating table attributes from
// one state to the other. For example, dropping or adding a `CHECK` constraint.
TableAttrDiff(from, to *schema.Table) ([]schema.Change, error)
// ColumnChange returns the schema changes (if any) for migrating one column to the other.
ColumnChange(fromT *schema.Table, from, to *schema.Column) (schema.ChangeKind, error)
// IndexAttrChanged reports if the index attributes were changed.
// For example, an index type or predicate (for partial indexes).
IndexAttrChanged(from, to []schema.Attr) bool
// IndexPartAttrChanged reports if the index-part attributes were
// changed. For example, an index-part collation.
IndexPartAttrChanged(from, to *schema.IndexPart) bool
// IsGeneratedIndexName reports if the index name was generated by the database
// for unnamed INDEX or UNIQUE constraints. In such cases, the differ will look
// for unnamed schema.Indexes on the desired state, before tagging the index as
// a candidate for deletion.
IsGeneratedIndexName(*schema.Table, *schema.Index) bool
// ReferenceChanged reports if the foreign key referential action was
// changed. For example, action was changed from RESTRICT to CASCADE.
ReferenceChanged(from, to schema.ReferenceOption) bool
}
A DiffDriver wraps all required methods for diffing elements that may have database-specific diff logic. See sql/schema/mysql/diff.go for an implementation example.
type ExecQueryCloser ¶ added in v0.3.8
type ExecQueryCloser interface {
schema.ExecQuerier
io.Closer
}
ExecQueryCloser is the interface that groups Close with the schema.ExecQuerier methods.
func SingleConn ¶ added in v0.3.8
func SingleConn(ctx context.Context, conn schema.ExecQuerier) (ExecQueryCloser, error)
SingleConn returns a closable single connection from the given ExecQuerier. If the ExecQuerier is already bound to a single connection (e.g. Tx, Conn), the connection will return as-is with a NopCloser.
type Normalizer ¶
A Normalizer wraps the Normalize method for normalizing the from and to tables before running diffing. The "from" usually represents the inspected database state (current), and the second represents the desired state.
If the DiffDriver implements the Normalizer interface, TableDiff normalizes its table inputs before starting the diff process.
type UnsupportedTypeError ¶
UnsupportedTypeError describes an unsupported type error.
func (UnsupportedTypeError) Error ¶
func (e UnsupportedTypeError) Error() string
Source Files