sqlx

package
v0.29.1 Latest Latest
Warning

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

 Go to latest Published: Dec 18, 2024 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var NoChange = schema.Change(nil)

NoChange can be returned by DiffDriver methods to indicate that no change is needed.

View Source 
var NoRows schema.ExecQuerier = (*noRows)(nil)

NoRows to be used by differs and planners without a connection.

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 AttrOr added in v0.22.0 

func AttrOr[T schema.Attr](attrs []schema.Attr, t T) T

AttrOr returns the first attribute of the given type, or the given default value.

func BodyDefChanged added in v0.17.0 

func BodyDefChanged(from, to string) bool

BodyDefChanged reports if the body definition of a function, procedure, view, or trigger has changed. There is a small task here that normalizes the indentation, which might be added during inspection or by the user.

func Charset added in v0.12.1 

func Charset(attr, parent []schema.Attr) (string, bool)

Charset reports if the attribute contains the "charset" attribute, and it needs to be defined explicitly on the schema. This is true, in case the element charset is different from its parent charset.

func CheckChangesScope added in v0.6.0 

func CheckChangesScope(opts migrate.PlanOptions, changes []schema.Change) error

CheckChangesScope checks that changes can be applied on a schema scope (connection).

func CheckDiff added in v0.2.0 

func CheckDiff(from, to *schema.Table, compare ...func(c1, c2 *schema.Check) bool) []schema.Change

CheckDiff computes the change diff between the 2 tables. A compare function is provided to check if a Check object was modified.

func CheckDiffMode added in v0.29.0 

func CheckDiffMode(from, to *schema.Table, mode schema.DiffMode, compare ...func(c1, c2 *schema.Check) bool) []schema.Change

CheckDiffMode is like CheckDiff, but compares also expressions if the schema.DiffMode is equal to schema.DiffModeNormalized.

func Collate added in v0.12.1 

func Collate(attr, parent []schema.Attr) (string, bool)

Collate reports if the attribute contains the "collation"/"collate" attribute, and it needs to be defined explicitly on the schema. This is true, in case the element collation is different from its parent collation.

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 

func CommentDiff(from, to []schema.Attr) schema.Change

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 

func DefaultValue(c *schema.Column) (string, bool)

DefaultValue returns the string represents the DEFAULT of a column.

func DetachCycles 

func DetachCycles(changes []schema.Change) ([]schema.Change, error)

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 ExprLastIndex added in v0.3.8 

func ExprLastIndex(expr string) int

ExprLastIndex scans the first expression in the given string until its end and returns its last index.

func Has 

func Has(elements, target any) bool

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 

func IsLiteralBool(s string) bool

IsLiteralBool reports if the given string is a valid literal bool.

func IsLiteralNumber added in v0.2.0 

func IsLiteralNumber(s string) bool

IsLiteralNumber reports if the given string is a literal number.

func IsQuoted added in v0.2.0 

func IsQuoted(s string, q ...byte) bool

IsQuoted reports if the given string is quoted with one of the given quotes (e.g. ', ", `).

func IsUint added in v0.13.1 

func IsUint(s string) bool

IsUint reports whether the string represents an unsigned integer.

func LinkSchemaTables 

func LinkSchemaTables(schemas []*schema.Schema)

LinkSchemaTables links foreign-key stub tables/columns to actual elements.

func MayWrap added in v0.3.7 

func MayWrap(s string) string

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 P added in v0.6.4 

func P[T any](v T) *T

P returns a pointer to v.

func ReverseChanges added in v0.4.1 

func ReverseChanges(c []schema.Change)

ReverseChanges reverses the order of the changes.

func SameSchema added in v0.23.0 

func SameSchema(s1, s2 *schema.Schema) bool

SameSchema reports if the given schemas are the same. Objects can be different as they might reside in two different states (current and desired).

func SameTable added in v0.22.0 

func SameTable(t1, t2 *schema.Table) bool

SameTable reports if the two objects represent the same table.

func SameView added in v0.26.1 

func SameView(v1, v2 *schema.View) bool

SameView reports if the two objects represent the same view.

func ScanNullBool added in v0.3.8 

func ScanNullBool(rows *sql.Rows) (sql.NullBool, error)

ScanNullBool scans one sql.NullBool record and closes the rows at the end.

func ScanOne added in v0.3.1 

func ScanOne(rows *sql.Rows, dest ...any) error

ScanOne scans one record and closes the rows at the end.

func ScanStrings 

func ScanStrings(rows *sql.Rows) ([]string, error)

ScanStrings scans sql.Rows into a slice of strings and closes it at the end.

func SchemaFKs added in v0.3.7 

func SchemaFKs(s *schema.Schema, rows *sql.Rows) error

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 SetReversible added in v0.9.0 

func SetReversible(p *migrate.Plan) error

SetReversible sets the Reversible field to true if all planned changes are reversible.

func SingleQuote added in v0.3.0 

func SingleQuote(s string) (string, error)

SingleQuote quotes the given string with single quote.

func SortChanges added in v0.16.0 

func SortChanges(changes []schema.Change, opts *SortOptions) []schema.Change

SortChanges is a helper function to sort to level changes based on their priority.

func TrimViewExtra added in v0.12.1 

func TrimViewExtra(s string) string

TrimViewExtra trims the extra unnecessary characters from the view definition.

func TypedSchemaFKs added in v0.14.0 

func TypedSchemaFKs[T ScanStringer](s *schema.Schema, rows *sql.Rows, attr ...*FKAttrScanner) error

TypedSchemaFKs is a version of SchemaFKs that allows to specify the type of used to scan update and delete actions from the database.

func Unquote added in v0.3.0 

func Unquote(s string) (string, error)

Unquote single or double quotes.

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 

func ValuesEqual(v1, v2 []string) bool

ValuesEqual checks if the 2 string slices are equal (including their order).

Types

type ApplyError added in v0.8.3 

type ApplyError struct {
	// contains filtered or unexported fields
}

ApplyError is an error that exposes an information for getting how any changes were applied before encountering the failure.

func (*ApplyError) Applied added in v0.8.3 

func (e *ApplyError) Applied() int

Applied reports how many changes were applied before getting an error. In case the first change was failed, Applied() returns 0.

func (*ApplyError) Error added in v0.8.3 

func (e *ApplyError) Error() string

Error implements the error interface.

type Builder 

type Builder struct {
	bytes.Buffer
	QuoteOpening byte    // quoting identifiers
	QuoteClosing byte    // quoting identifiers
	Schema       *string // schema qualifier
	Indent       string  // indentation string
	// contains filtered or unexported fields
}

A Builder provides a syntactic sugar API for writing SQL statements.

func (*Builder) Clone added in v0.2.0 

func (b *Builder) Clone() *Builder

Clone returns a duplicate of the builder.

func (*Builder) Comma 

func (b *Builder) Comma() *Builder

Comma writes a comma in case the buffer is not empty, or replaces the last char if it is a whitespace.

func (*Builder) Func added in v0.15.0 

func (b *Builder) Func(f *schema.Func) *Builder

Func writes the function identifier to the builder, prefixed with the schema name if exists.

func (*Builder) FuncCall added in v0.16.0 

func (b *Builder) FuncCall(f *schema.Func, args ...string) *Builder

FuncCall writes the function identifier to the builder as a function call,

func (*Builder) Ident 

func (b *Builder) Ident(s string) *Builder

Ident writes the given string quoted as an SQL identifier.

func (*Builder) IndentIn added in v0.10.0 

func (b *Builder) IndentIn() *Builder

IndentIn adds one indentation in.

func (*Builder) IndentOut added in v0.10.0 

func (b *Builder) IndentOut() *Builder

IndentOut removed one indentation level.

func (*Builder) Int64 added in v0.16.0 

func (b *Builder) Int64(v int64) *Builder

Int64 writes the given value to the builder in base 10.

func (*Builder) MapComma 

func (b *Builder) MapComma(x any, f func(i int, b *Builder)) *Builder

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 

func (b *Builder) MapCommaErr(x any, f func(i int, b *Builder) error) error

MapCommaErr is like MapComma, but returns an error if f returns an error.

func (*Builder) MapIndent added in v0.10.0 

func (b *Builder) MapIndent(x any, f func(i int, b *Builder)) *Builder

MapIndent is like MapComma, but writes a new line before each element.

func (*Builder) MapIndentErr added in v0.10.0 

func (b *Builder) MapIndentErr(x any, f func(i int, b *Builder) error) error

MapIndentErr is like MapCommaErr, but writes a new line before each element.

func (*Builder) NL added in v0.10.0 

func (b *Builder) NL() *Builder

NL adds line break and prefix the new line with indentation in case indentation is enabled.

func (*Builder) P 

func (b *Builder) P(phrases ...string) *Builder

P writes a list of phrases to the builder separated and suffixed with whitespace.

func (*Builder) Proc added in v0.15.0 

func (b *Builder) Proc(p *schema.Proc) *Builder

Proc writes the procedure identifier to the builder, prefixed with the schema name if exists.

func (*Builder) ProcCall added in v0.16.0 

func (b *Builder) ProcCall(p *schema.Proc, args ...string) *Builder

ProcCall writes the procedure identifier to the builder as a procedure call,

func (*Builder) Quote added in v0.12.1 

func (b *Builder) Quote(prefix string, fn func(b *Builder)) *Builder

Quote wraps the given function with a single quote and a prefix

func (*Builder) SchemaResource added in v0.16.0 

func (b *Builder) SchemaResource(s *schema.Schema, name string) *Builder

SchemaResource writes the schema resource identifier to the builder, prefixed with the schema name if exists.

func (*Builder) String 

func (b *Builder) String() string

String overrides the Buffer.String method and ensure no spaces pad the returned statement.

func (*Builder) Table 

func (b *Builder) Table(t *schema.Table) *Builder

Table writes the table identifier to the builder, prefixed with the schema name if exists.

func (*Builder) TableColumn added in v0.16.0 

func (b *Builder) TableColumn(t *schema.Table, c *schema.Column) *Builder

TableColumn writes the table's resource identifier to the builder, prefixed with the schema name if exists.

func (*Builder) TableResource added in v0.12.1 

func (b *Builder) TableResource(t *schema.Table, r any) *Builder

TableResource writes the table resource identifier to the builder, prefixed with the schema name if exists.

func (*Builder) View added in v0.12.1 

func (b *Builder) View(v *schema.View) *Builder

View writes the view identifier to the builder, prefixed with the schema name if exists.

func (*Builder) ViewResource added in v0.28.0 

func (b *Builder) ViewResource(v *schema.View, r any) *Builder

ViewResource writes the view resource identifier to the builder, prefixed with the schema name if exists.

func (*Builder) Wrap 

func (b *Builder) Wrap(f func(b *Builder)) *Builder

Wrap wraps the written string with parentheses.

func (*Builder) WrapErr added in v0.16.0 

func (b *Builder) WrapErr(f func(b *Builder) error) error

WrapErr wraps the written string with parentheses

func (*Builder) WrapIndent added in v0.10.0 

func (b *Builder) WrapIndent(f func(b *Builder)) *Builder

WrapIndent is like Wrap but with extra level of indentation.

func (*Builder) WrapIndentErr added in v0.23.0 

func (b *Builder) WrapIndentErr(f func(b *Builder) error) error

WrapIndentErr is like WrapErr but with extra level of indentation.

type ChangesAnnotator added in v0.11.0 

type ChangesAnnotator interface {
	AnnotateChanges([]schema.Change, *schema.DiffOptions) error
}

ChangesAnnotator is an optional interface allows DiffDriver to annotate changes with additional driver-specific attributes before they are returned.

type Depender added in v0.16.0 

type Depender interface {
	DependsOn(change, other schema.Change) bool
	DependencyOf(change, other schema.Change) bool
}

Depender can be implemented by an object to determine if a change to it depends on other change, or if other change depends on it. For example: A table creation depends on type creation, and a type deletion depends on table deletion.

type DevDriver added in v0.3.7 

type DevDriver struct {
	// A Driver connected to the dev database.
	Driver interface {
		migrate.Driver
		migrate.CleanChecker
		migrate.Snapshoter
	}
	// PathObject allows providing a custom function to patch
	// objects that hold a schema reference.
	PatchObject func(*schema.Schema, schema.Object)
}

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.

func (*DevDriver) NormalizeSchema added in v0.3.7 

func (d *DevDriver) NormalizeSchema(ctx context.Context, s *schema.Schema) (*schema.Schema, error)

NormalizeSchema returns the normal representation of the given database. See NormalizeRealm for more info.

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 

func (d *Diff) RealmDiff(from, to *schema.Realm, options ...schema.DiffOption) ([]schema.Change, error)

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 

func (d *Diff) SchemaDiff(from, to *schema.Schema, options ...schema.DiffOption) ([]schema.Change, error)

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.

func (*Diff) TableDiff 

func (d *Diff) TableDiff(from, to *schema.Table, options ...schema.DiffOption) ([]schema.Change, error)

TableDiff implements the schema.TableDiffer 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 {
	// RealmObjectDiff returns a changeset for migrating realm (database) objects
	// from one state to the other. For example, adding extensions or users.
	RealmObjectDiff(from, to *schema.Realm) ([]schema.Change, error)

	// 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

	// SchemaObjectDiff returns a changeset for migrating schema objects from
	// one state to the other. For example, changing schema custom types.
	SchemaObjectDiff(from, to *schema.Schema, _ *schema.DiffOptions) ([]schema.Change, error)

	// 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.DiffOptions) ([]schema.Change, error)

	// ViewAttrChanges returns the changes between the two view attributes.
	ViewAttrChanges(from, to *schema.View) []schema.Change

	// ColumnChange returns the schema changes (if any) for migrating one column to the other.
	ColumnChange(fromT *schema.Table, from, to *schema.Column, _ *schema.DiffOptions) (schema.Change, 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 part's attributes at position "i"
	// were changed. For example, an index-part collation.
	IndexPartAttrChanged(from, to *schema.Index, i int) 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

	// ForeignKeyAttrChanged reports if any of the foreign-key attributes were changed.
	ForeignKeyAttrChanged(from, to []schema.Attr) 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 DropSchemaChanger added in v0.16.0 

type DropSchemaChanger interface {
	DropSchemaChange(*schema.Schema) []schema.Change
}

DropSchemaChanger is an optional interface allows DiffDriver to drop schema objects before dropping the schema itself.

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 FKAttrScanner added in v0.28.0 

type FKAttrScanner struct {
	Columns  func() []any
	ScanFunc func(*schema.ForeignKey, []any) error
}

FKAttrScanner allows extending foreign-keys scanning with extra attributes.

type Normalizer 

type Normalizer interface {
	Normalize(from, to *schema.Table, opts *schema.DiffOptions) error
}

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 ProcFuncsDiffer added in v0.15.0 

type ProcFuncsDiffer interface {
	// ProcFuncsDiff returns a changeset for migrating functions and procedures
	// from one schema state to the other.
	ProcFuncsDiff(from, to *schema.Schema, opts *schema.DiffOptions) ([]schema.Change, error)
}

ProcFuncsDiffer is an optional interface allows DiffDriver to diff functions and procedures.

type RowTyper added in v0.28.0 

type RowTyper interface {
	RowType() *schema.Table
}

RowTyper can be implemented by a type to determine if its source is a regular table (e.g., row types).

type ScanStringer added in v0.14.0 

type ScanStringer interface {
	fmt.Stringer
	sql.Scanner
}

ScanStringer groups the fmt.Stringer and sql.Scanner interfaces.

type SortOptions added in v0.23.0 

type SortOptions struct {
	// FuncDepT reports if a function depends on the given table.
	FuncDepT func(*schema.Func, *schema.Table) bool
	// FuncDepV reports if a function depends on the given view.
	FuncDepV func(*schema.Func, *schema.View) bool
	// FuncDepO reports if a function depends on the given object.
	FuncDepO func(*schema.Func, schema.Object) bool
	// DefaultSchema defines the default schema (also known as "search_path") that
	// is used by the database to search for objects if no qualifier is provided.
	DefaultSchema string
}

SortOptions allows drivers to customize the behavior of the SortChanges function.

type TableFinder added in v0.9.1 

type TableFinder interface {
	FindTable(*schema.Schema, string) (*schema.Table, error)
}

TableFinder wraps the FindTable method, providing more control to the DiffDriver on how tables are matched.

type TriggerDiffer added in v0.16.0 

type TriggerDiffer interface {
	// TriggerDiff returns a changeset for migrating triggers from
	// one state to the other. For example, changing action time.
	TriggerDiff(from, to *schema.Trigger) ([]schema.Change, error)
}

TriggerDiffer is an optional interface allows DiffDriver to diff triggers.

type UnsupportedTypeError 

type UnsupportedTypeError struct {
	schema.Type
}

UnsupportedTypeError describes an unsupported type error.

func (UnsupportedTypeError) Error 

func (e UnsupportedTypeError) Error() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.