Documentation ¶
Index ¶
- Constants
- Variables
- func FilesLastIndex(files []File, f func(File) bool) int
- func LogIntro(l Logger, revs []*Revision, files []File) error
- func Validate(dir Dir) error
- func WriteSumFile(dir Dir, sum HashFile) error
- type Change
- type CleanChecker
- type Dir
- type Driver
- type Executor
- func (e *Executor) Execute(ctx context.Context, m File) (err error)
- func (e *Executor) ExecuteN(ctx context.Context, n int) (err error)
- func (e *Executor) ExecuteTo(ctx context.Context, version string) (err error)
- func (e *Executor) Pending(ctx context.Context) ([]File, error)
- func (e *Executor) Replay(ctx context.Context, r StateReader, opts ...ReplayOption) (_ *schema.Realm, err error)
- type ExecutorOption
- type File
- type Formatter
- type HashFile
- type HistoryChangedError
- type LocalDir
- type LocalFile
- type LogDone
- type LogEntry
- type LogError
- type LogExecution
- type LogFile
- type LogStmt
- type Logger
- type MemDir
- type MissingMigrationError
- type NopLogger
- type NopRevisionReadWriter
- func (NopRevisionReadWriter) DeleteRevision(context.Context, string) error
- func (NopRevisionReadWriter) Ident() *TableIdent
- func (NopRevisionReadWriter) ReadRevision(context.Context, string) (*Revision, error)
- func (NopRevisionReadWriter) ReadRevisions(context.Context) ([]*Revision, error)
- func (NopRevisionReadWriter) WriteRevision(context.Context, *Revision) error
- type NotCleanError
- type Plan
- type PlanApplier
- type PlanOption
- type PlanOptions
- type Planner
- type PlannerOption
- type ReplayOption
- type RestoreFunc
- type Revision
- type RevisionReadWriter
- type RevisionType
- type Snapshoter
- type StateReader
- type StateReaderFunc
- type Stmt
- type TableIdent
- type TemplateFormatter
Constants ¶
const HashFileName = "atlas.sum"
HashFileName of the migration directory integrity sum file.
Variables ¶
var ( // ErrChecksumFormat is returned from Validate if the sum files format is invalid. ErrChecksumFormat = errors.New("checksum file format invalid") // ErrChecksumMismatch is returned from Validate if the hash sums don't match. ErrChecksumMismatch = errors.New("checksum mismatch") // ErrChecksumNotFound is returned from Validate if the hash file does not exist. ErrChecksumNotFound = errors.New("checksum file not found") )
var ( // WithFormatter calls PlanFormat. // Deprecated: use PlanFormat instead. WithFormatter = PlanFormat // DisableChecksum calls PlanWithChecksum(false). // Deprecated: use PlanWithoutChecksum instead. DisableChecksum = func() PlannerOption { return PlanWithChecksum(false) } )
var ( // ErrNoPendingFiles is returned if there are no pending migration files to execute on the managed database. ErrNoPendingFiles = errors.New("sql/migrate: execute: nothing to do") // ErrSnapshotUnsupported is returned if there is no Snapshoter given. ErrSnapshotUnsupported = errors.New("sql/migrate: driver does not support taking a database snapshot") // ErrCleanCheckerUnsupported is returned if there is no CleanChecker given. ErrCleanCheckerUnsupported = errors.New("sql/migrate: driver does not support checking if database is clean") // ErrRevisionNotExist is returned if the requested revision is not found in the storage. ErrRevisionNotExist = errors.New("sql/migrate: revision not found") )
var ( // DefaultFormatter is a default implementation for Formatter. DefaultFormatter = TemplateFormatter{ { N: template.Must(template.New("").Funcs(templateFuncs).Parse( "{{ with .Version }}{{ . }}{{ else }}{{ now }}{{ end }}{{ with .Name }}_{{ . }}{{ end }}.sql", )), C: template.Must(template.New("").Parse( `{{ range .Changes }}{{ with .Comment }}-- {{ println . }}{{ end }}{{ printf "%s;\n" .Cmd }}{{ end }}`, )), }, } )
var ErrNoPlan = errors.New("sql/migrate: no plan for matched states")
ErrNoPlan is returned by Plan when there is no change between the two states.
Functions ¶
func FilesLastIndex ¶ added in v0.6.0
FilesLastIndex returns the index of the last file satisfying f(i), or -1 if none do.
func LogIntro ¶ added in v0.6.0
LogIntro gathers some meta information from the migration files and stored revisions to log some general information prior to actual execution.
func Validate ¶ added in v0.3.7
Validate checks if the migration dir is in sync with its sum file. If they don't match ErrChecksumMismatch is returned.
func WriteSumFile ¶ added in v0.3.8
WriteSumFile writes the given HashFile to the Dir. If the file does not exist, it is created.
Types ¶
type Change ¶
type Change struct { // Cmd or statement to execute. Cmd string // Args for placeholder parameters in the statement above. Args []any // A Comment describes the change. Comment string // Reverse contains the "reversed" statement(s) if // the command is reversible. Reverse any // string | []string // The Source that caused this change, or nil. Source schema.Change }
A Change of migration.
func (*Change) ReverseStmts ¶ added in v0.9.0
ReverseStmts returns the reverse statements of a Change, if any.
type CleanChecker ¶ added in v0.6.0
type CleanChecker interface { // CheckClean checks if the connected realm or schema does not contain any resources besides the // revision history table. A NotCleanError is returned in case the connection is not-empty. CheckClean(context.Context, *TableIdent) error }
CleanChecker wraps the single CheckClean method.
type Dir ¶
type Dir interface { fs.FS // WriteFile writes the data to the named file. WriteFile(string, []byte) error // Files returns a set of files stored in this Dir to be executed on a database. Files() ([]File, error) // Checksum returns a HashFile of the migration directory. Checksum() (HashFile, error) }
Dir wraps the functionality used to interact with a migration directory.
type Driver ¶
type Driver interface { schema.Differ schema.ExecQuerier schema.Inspector PlanApplier }
The Driver interface must be implemented by the different dialects to support database migration authoring/planning and applying. ExecQuerier, Inspector and Differ, provide basic schema primitives for inspecting database schemas, calculate the difference between schema elements, and executing raw SQL statements. The PlanApplier interface wraps the methods for generating migration plan for applying the actual changes on the database.
type Executor ¶ added in v0.3.8
type Executor struct {
// contains filtered or unexported fields
}
Executor is responsible to manage and execute a set of migration files against a database.
func NewExecutor ¶ added in v0.3.8
func NewExecutor(drv Driver, dir Dir, rrw RevisionReadWriter, opts ...ExecutorOption) (*Executor, error)
NewExecutor creates a new Executor with default values.
func (*Executor) Execute ¶ added in v0.3.8
Execute executes the given migration file on the database. If it sees a file, that has been partially applied, it will continue with the next statement in line.
func (*Executor) ExecuteN ¶ added in v0.4.2
ExecuteN executes n pending migration files. If n<=0 all pending migration files are executed.
func (*Executor) ExecuteTo ¶ added in v0.8.0
ExecuteTo executes all pending migration files up to and including version.
func (*Executor) Pending ¶ added in v0.4.2
Pending returns all pending (not fully applied) migration files in the migration directory.
func (*Executor) Replay ¶ added in v0.6.0
func (e *Executor) Replay(ctx context.Context, r StateReader, opts ...ReplayOption) (_ *schema.Realm, err error)
Replay the migration directory and invoke the state to get back the inspection result.
type ExecutorOption ¶ added in v0.3.8
ExecutorOption allows configuring an Executor using functional arguments.
func WithAllowDirty ¶ added in v0.6.0
func WithAllowDirty(b bool) ExecutorOption
WithAllowDirty defines if we can start working on a non-clean database in the first migration execution.
func WithBaselineVersion ¶ added in v0.6.0
func WithBaselineVersion(v string) ExecutorOption
WithBaselineVersion allows setting the baseline version of the database on the first migration. Hence, all versions up to and including this version are skipped.
func WithFromVersion ¶ added in v0.6.0
func WithFromVersion(v string) ExecutorOption
WithFromVersion allows passing a file version as a starting point for calculating pending migration scripts. It can be useful for skipping specific files.
func WithLogger ¶ added in v0.4.1
func WithLogger(log Logger) ExecutorOption
WithLogger sets the Logger of an Executor.
func WithOperatorVersion ¶ added in v0.6.4
func WithOperatorVersion(v string) ExecutorOption
WithOperatorVersion sets the operator version to save on the revisions when executing migration files.
type File ¶ added in v0.3.4
type File interface { // Name returns the name of the migration file. Name() string // Desc returns the description of the migration File. Desc() string // Version returns the version of the migration File. Version() string // Bytes returns the read content of the file. Bytes() []byte // Stmts returns the set of SQL statements this file holds. Stmts() ([]string, error) // StmtDecls returns the set of SQL statements this file holds alongside its preceding comments. StmtDecls() ([]*Stmt, error) }
File represents a single migration file.
type Formatter ¶ added in v0.3.4
type Formatter interface { // Format formats the given Plan into one or more migration files. Format(*Plan) ([]File, error) }
Formatter wraps the Format method.
type HashFile ¶ added in v0.3.7
type HashFile []struct{ N, H string }
HashFile represents the integrity sum file of the migration dir.
func NewHashFile ¶ added in v0.9.0
NewHashFile computes and returns a HashFile from the given directory's files.
func (HashFile) MarshalText ¶ added in v0.3.7
MarshalText implements encoding.TextMarshaler.
func (HashFile) SumByName ¶ added in v0.7.1
SumByName returns the hash for a migration file by its name.
func (*HashFile) UnmarshalText ¶ added in v0.3.7
UnmarshalText implements encoding.TextUnmarshaler.
type HistoryChangedError ¶ added in v0.6.0
HistoryChangedError is returned if between two execution attempts already applied statements of a file have changed.
func (HistoryChangedError) Error ¶ added in v0.6.0
func (e HistoryChangedError) Error() string
type LocalDir ¶ added in v0.3.4
type LocalDir struct {
// contains filtered or unexported fields
}
LocalDir implements Dir for a local migration directory with default Atlas formatting.
func NewLocalDir ¶ added in v0.3.4
NewLocalDir returns a new the Dir used by a Planner to work on the given local path.
func (*LocalDir) Checksum ¶ added in v0.6.2
Checksum implements Dir.Checksum. By default, it calls Files() and creates a checksum from them.
func (*LocalDir) Files ¶ added in v0.3.8
Files implements Dir.Files. It looks for all files with .sql suffix and orders them by filename.
type LocalFile ¶ added in v0.3.8
type LocalFile struct {
// contains filtered or unexported fields
}
LocalFile is used by LocalDir to implement the Scanner interface.
func NewLocalFile ¶ added in v0.4.3
NewLocalFile returns a new local file.
func (LocalFile) Directive ¶ added in v0.9.1
Directive returns the (global) file directives that match the provided name. File directives are located at the top of the file and should not be associated with any statement. Hence, double new lines are used to separate file directives from its content.
func (LocalFile) StmtDecls ¶ added in v0.6.4
StmtDecls returns the all statement declarations exist in the local file.
type LogEntry ¶ added in v0.4.1
type LogEntry interface {
// contains filtered or unexported methods
}
LogEntry marks several types of logs to be passed to a Logger.
type LogExecution ¶ added in v0.4.1
type LogExecution struct { // From what version. From string // To what version. To string // Migration Files to be executed. Files []File }
LogExecution is sent once when execution of multiple migration files has been started. It holds the filenames of the pending migration files.
type LogFile ¶ added in v0.4.1
type LogFile struct { // The File being executed. File File // Version executed. // Deprecated: Use File.Version() instead. Version string // Desc of migration executed. // Deprecated: Use File.Desc() instead. Desc string // Skip holds the number of stmts of this file that will be skipped. // This happens, if a migration file was only applied partially and will now continue to be applied. Skip int }
LogFile is sent if a new migration file is executed.
type LogStmt ¶ added in v0.4.1
type LogStmt struct {
SQL string
}
LogStmt is sent if a new SQL statement is executed.
type Logger ¶ added in v0.4.1
type Logger interface {
Log(LogEntry)
}
A Logger logs migration execution.
type MemDir ¶ added in v0.9.0
type MemDir struct {
// contains filtered or unexported fields
}
MemDir provides an in-memory Dir implementation.
func OpenMemDir ¶ added in v0.9.1
OpenMemDir opens an in-memory directory and registers it in the process namespace with the given name. Hence, calling OpenMemDir with the same name will return the same directory. The directory is deleted when the last reference of it is closed.
func (*MemDir) Files ¶ added in v0.9.0
Files returns a set of files stored in-memory to be executed on a database.
type MissingMigrationError ¶ added in v0.7.1
type MissingMigrationError struct{ Version, Description string }
MissingMigrationError is returned if a revision is partially applied but the matching migration file is not found in the migration directory.
func (MissingMigrationError) Error ¶ added in v0.7.1
func (e MissingMigrationError) Error() string
Error implements error.
type NopLogger ¶ added in v0.6.0
type NopLogger struct{}
NopLogger is a Logger that does nothing. It is useful for one-time replay of the migration directory.
type NopRevisionReadWriter ¶ added in v0.4.2
type NopRevisionReadWriter struct{}
NopRevisionReadWriter is a RevisionReadWriter that does nothing. It is useful for one-time replay of the migration directory.
func (NopRevisionReadWriter) DeleteRevision ¶ added in v0.7.1
func (NopRevisionReadWriter) DeleteRevision(context.Context, string) error
DeleteRevision implements RevisionsReadWriter.DeleteRevision.
func (NopRevisionReadWriter) Ident ¶ added in v0.6.0
func (NopRevisionReadWriter) Ident() *TableIdent
Ident implements RevisionsReadWriter.TableIdent.
func (NopRevisionReadWriter) ReadRevision ¶ added in v0.6.0
ReadRevision implements RevisionsReadWriter.ReadRevision.
func (NopRevisionReadWriter) ReadRevisions ¶ added in v0.4.2
func (NopRevisionReadWriter) ReadRevisions(context.Context) ([]*Revision, error)
ReadRevisions implements RevisionsReadWriter.ReadRevisions.
func (NopRevisionReadWriter) WriteRevision ¶ added in v0.4.2
func (NopRevisionReadWriter) WriteRevision(context.Context, *Revision) error
WriteRevision implements RevisionsReadWriter.WriteRevision.
type NotCleanError ¶ added in v0.5.0
type NotCleanError struct {
Reason string // reason why the database is considered not clean
}
NotCleanError is returned when the connected dev-db is not in a clean state (aka it has schemas and tables). This check is done to ensure no data is lost by overriding it when working on the dev-db.
func (*NotCleanError) Error ¶ added in v0.5.0
func (e *NotCleanError) Error() string
type Plan ¶
type Plan struct {
// Version and Name of the plan. Provided by the user or auto-generated.
Version, Name string
// Reversible describes if the changeset is reversible.
Reversible bool
// Transactional describes if the changeset is transactional.
Transactional bool
// Changes defines the list of changeset in the plan.
Changes []*Change
}
A Plan defines a planned changeset that its execution brings the database to the new desired state. Additional information is calculated by the different drivers to indicate if the changeset is transactional (can be rolled-back) and reversible (a down file can be generated to it).
type PlanApplier ¶
type PlanApplier interface { // PlanChanges returns a migration plan for applying the given changeset. PlanChanges(context.Context, string, []schema.Change, ...PlanOption) (*Plan, error) // ApplyChanges is responsible for applying the given changeset. // An error may return from ApplyChanges if the driver is unable // to execute a change. ApplyChanges(context.Context, []schema.Change, ...PlanOption) error }
PlanApplier wraps the methods for planning and applying changes on the database.
type PlanOption ¶ added in v0.6.0
type PlanOption func(*PlanOptions)
PlanOption allows configuring a drivers' plan using functional arguments.
type PlanOptions ¶ added in v0.6.0
type PlanOptions struct { // PlanWithSchemaQualifier allows setting a custom schema to prefix // tables and other resources. An empty string indicates no qualifier. SchemaQualifier *string }
PlanOptions holds the migration plan options to be used by PlanApplier.
type Planner ¶ added in v0.3.4
type Planner struct {
// contains filtered or unexported fields
}
Planner can plan the steps to take to migrate from one state to another. It uses the enclosed Dir to write those changes to versioned migration files.
func NewPlanner ¶ added in v0.3.7
func NewPlanner(drv Driver, dir Dir, opts ...PlannerOption) *Planner
NewPlanner creates a new Planner.
func (*Planner) Plan ¶ added in v0.3.4
Plan calculates the migration Plan required for moving the current state (from) state to the next state (to). A StateReader can be a directory, static schema elements or a Driver connection.
func (*Planner) PlanSchema ¶ added in v0.6.0
PlanSchema is like Plan but limits its scope to the schema connection. Note, the operation fails in case the connection was not set to a schema.
type PlannerOption ¶ added in v0.3.7
type PlannerOption func(*Planner)
PlannerOption allows managing a Planner using functional arguments.
func PlanFormat ¶ added in v0.6.0
func PlanFormat(fmt Formatter) PlannerOption
PlanFormat sets the Formatter of a Planner.
func PlanWithChecksum ¶ added in v0.6.0
func PlanWithChecksum(b bool) PlannerOption
PlanWithChecksum allows setting if the hash-sum functionality for the migration directory is enabled or not.
func PlanWithSchemaQualifier ¶ added in v0.6.0
func PlanWithSchemaQualifier(q string) PlannerOption
PlanWithSchemaQualifier allows setting a custom schema to prefix tables and other resources. An empty string indicates no prefix.
Note, this options require the changes to be scoped to one schema and returns an error otherwise.
type ReplayOption ¶ added in v0.8.0
type ReplayOption func(*replayConfig)
ReplayOption configures a migration directory replay behavior.
func ReplayToVersion ¶ added in v0.8.0
func ReplayToVersion(v string) ReplayOption
ReplayToVersion configures the last version to apply when replaying the migration directory.
type RestoreFunc ¶ added in v0.5.0
RestoreFunc is returned by the Snapshoter to explicitly restore the database state.
type Revision ¶ added in v0.3.8
type Revision struct { Version string `json:"Version"` // Version of the migration. Description string `json:"Description"` // Description of this migration. Type RevisionType `json:"Type"` // Type of the migration. Applied int `json:"Applied"` // Applied amount of statements in the migration. Total int `json:"Total"` // Total amount of statements in the migration. ExecutedAt time.Time `json:"ExecutedAt"` // ExecutedAt is the starting point of execution. ExecutionTime time.Duration `json:"ExecutionTime"` // ExecutionTime of the migration. Error string `json:"Error,omitempty"` // Error of the migration, if any occurred. ErrorStmt string `json:"ErrorStmt,omitempty"` // ErrorStmt is the statement that raised Error. Hash string `json:"-"` // Hash of migration file. PartialHashes []string `json:"-"` // PartialHashes is the hashes of applied statements. OperatorVersion string `json:"OperatorVersion"` // OperatorVersion that executed this migration. }
A Revision denotes an applied migration in a deployment. Used to track migration executions state of a database.
type RevisionReadWriter ¶ added in v0.3.8
type RevisionReadWriter interface { // Ident returns an object identifies this history table. Ident() *TableIdent // ReadRevisions returns all revisions. ReadRevisions(context.Context) ([]*Revision, error) // ReadRevision returns a revision by version. // Returns ErrRevisionNotExist if the version does not exist. ReadRevision(context.Context, string) (*Revision, error) // WriteRevision saves the revision to the storage. WriteRevision(context.Context, *Revision) error // DeleteRevision deletes a revision by version from the storage. DeleteRevision(context.Context, string) error }
A RevisionReadWriter wraps the functionality for reading and writing migration revisions in a database table.
type RevisionType ¶ added in v0.6.0
type RevisionType uint
RevisionType defines the type of the revision record in the history table.
const ( // RevisionTypeUnknown represents an unknown revision type. // This type is unexpected and exists here to only ensure // the type is not set to the zero value. RevisionTypeUnknown RevisionType = 0 // RevisionTypeBaseline represents a baseline revision. Note that only // the first record can represent a baseline migration and most of its // fields are set to the zero value. RevisionTypeBaseline RevisionType = 1 << (iota - 1) // RevisionTypeExecute represents a migration that was executed. RevisionTypeExecute // RevisionTypeResolved represents a migration that was resolved. A migration // script that was script executed and then resolved should set its Type to // RevisionTypeExecute | RevisionTypeResolved. RevisionTypeResolved )
func (RevisionType) Has ¶ added in v0.8.0
func (r RevisionType) Has(f RevisionType) bool
Has returns if the given flag is set.
func (RevisionType) MarshalText ¶ added in v0.8.0
func (r RevisionType) MarshalText() ([]byte, error)
MarshalText implements encoding.TextMarshaler.
func (RevisionType) String ¶ added in v0.8.0
func (r RevisionType) String() string
String implements fmt.Stringer.
type Snapshoter ¶ added in v0.5.0
type Snapshoter interface { // Snapshot takes a snapshot of the current database state and returns a function that can be called to restore // that state. Snapshot should return an error, if the current state can not be restored completely, e.g. if // there is a table already containing some rows. Snapshot(context.Context) (RestoreFunc, error) }
Snapshoter wraps the Snapshot method.
type StateReader ¶
StateReader wraps the method for reading a database/schema state. The types below provides a few builtin options for reading a state from a migration directory, a static object (e.g. a parsed file).
func Realm ¶
func Realm(r *schema.Realm) StateReader
Realm returns a StateReader for the static Realm object.
func RealmConn ¶ added in v0.6.0
func RealmConn(drv Driver, opts *schema.InspectRealmOption) StateReader
RealmConn returns a StateReader for a Driver connected to a database.
func Schema ¶
func Schema(s *schema.Schema) StateReader
Schema returns a StateReader for the static Schema object.
func SchemaConn ¶ added in v0.6.0
func SchemaConn(drv Driver, name string, opts *schema.InspectOptions) StateReader
SchemaConn returns a StateReader for a Driver connected to a schema.
type StateReaderFunc ¶
The StateReaderFunc type is an adapter to allow the use of ordinary functions as state readers.
type Stmt ¶ added in v0.6.4
type Stmt struct { Pos int // statement position Text string // statement text Comments []string // associated comments }
Stmt represents a scanned statement text along with its position in the file and associated comments group.
type TableIdent ¶ added in v0.6.0
TableIdent describes a table identifier returned by the revisions table.
type TemplateFormatter ¶ added in v0.3.4
TemplateFormatter implements Formatter by using templates.
func NewTemplateFormatter ¶ added in v0.3.4
func NewTemplateFormatter(templates ...*template.Template) (TemplateFormatter, error)
NewTemplateFormatter creates a new Formatter working with the given templates.
migrate.NewTemplateFormatter( template.Must(template.New("").Parse("{{now.Unix}}{{.Name}}.sql")), // name template template.Must(template.New("").Parse("{{range .Changes}}{{println .Cmd}}{{end}}")), // content template )