migrate

Oct 1, 2024

Changes in this version

+ func CheckVersion(v string) error

type Executor

+ func (e *Executor) ExecuteFiles(ctx context.Context, files []File) error

type MemDir

+ func (d *MemDir) Path() string

+ func (d *MemDir) SetPath(path string)

type PlannerOption

+ func PlanWithExclude(patterns ...string) PlannerOption

+ type StmtExecError struct

+ Err error

+ Stmt *Stmt

+ Version string

+ func (e *StmtExecError) Error() string

+ func (e *StmtExecError) Unwrap() error

Aug 26, 2024

Changes in this version

type LogStmt

+ Stmt *Stmt

Aug 8, 2024

Changes in this version

type MemDir

+ func (d *MemDir) CopyFiles(fs []File) error

type TemplateFormatter

+ func (t TemplateFormatter) FormatFile(p *Plan) (File, error)

+ func (t TemplateFormatter) FormatTo(plan *Plan, w io.Writer) error

Jul 8, 2024

Changes in this version

+ func NewVersion() string

Jun 14, 2024

Changes in this version

type PlanMode

+ const PlanModeUnsortedDump

type ScannerOptions

+ BackslashEscapes bool

+ EscapedStringExt bool

Apr 30, 2024

Changes in this version

+ func ArchiveDirTo(w io.Writer, dir Dir) error

type Dir

+ func UnarchiveDirFrom(r io.Reader) (Dir, error)

Feb 25, 2024

Changes in this version

+ type ChecksumError struct

+ File string

+ Line int

+ Pos int

+ Reason Reason

+ Total int

+ func (err ChecksumError) Error() string

+ func (err ChecksumError) Is(target error) bool

+ type Reason uint

+ const ReasonAdded

+ const ReasonEdited

+ const ReasonRemoved

+ func (r Reason) String() string

Feb 2, 2024

Changes in this version

type Executor

+ func (e *Executor) ValidateDir(context.Context) error

+ type LogCheck struct

+ Error error

+ Stmt string

+ type LogChecks struct

+ Name string

+ Stmts []string

+ type LogChecksDone struct

+ Error error

Dec 19, 2023

Changes in this version

+ func FileStmts(drv Driver, f File) ([]string, error)

+ type ExecOrder uint

+ const ExecOrderLinear

+ const ExecOrderLinearSkip

+ const ExecOrderNonLinear

type ExecutorOption

+ func WithExecOrder(o ExecOrder) ExecutorOption

+ type HistoryNonLinearError struct

+ OutOfOrder []File

+ Pending []File

+ func (e HistoryNonLinearError) Error() string

type NotCleanError

+ State *schema.Realm

type Scanner

+ func (s *Scanner) Scan(input string) ([]*Stmt, error)

+ type ScannerOptions struct

+ MatchBegin bool

+ MatchBeginAtomic bool

+ MatchDollarQuote bool

type Stmt

+ func FileStmtDecls(drv Driver, f File) ([]*Stmt, error)

+ type StmtScanner interface

+ ScanStmts func(input string) ([]*Stmt, error)

Aug 23, 2023

Changes in this version

+ var ErrCheckpointNotFound = errors.New("no checkpoint found")

+ var ErrNotCheckpoint = errors.New("not a checkpoint file")

+ type CheckpointDir interface

+ CheckpointFiles func() ([]File, error)

+ FilesFromCheckpoint func(string) ([]File, error)

+ WriteCheckpoint func(name, tag string, content []byte) error

+ type CheckpointFile interface

+ CheckpointTag func() (string, error)

+ IsCheckpoint func() bool

type File

+ func FilesFromLastCheckpoint(dir Dir) ([]File, error)

+ func SkipCheckpointFiles(all []File) []File

type LocalDir

+ func (d *LocalDir) CheckpointFiles() ([]File, error)

+ func (d *LocalDir) FilesFromCheckpoint(name string) ([]File, error)

+ func (d *LocalDir) WriteCheckpoint(name, tag string, b []byte) error

type LocalFile

+ func (f *LocalFile) AddDirective(name string, args ...string)

+ func (f *LocalFile) CheckpointTag() (string, error)

+ func (f *LocalFile) IsCheckpoint() bool

type MemDir

+ func (d *MemDir) CheckpointFiles() ([]File, error)

+ func (d *MemDir) FilesFromCheckpoint(name string) ([]File, error)

+ func (d *MemDir) WriteCheckpoint(name, tag string, b []byte) error

type Planner

+ func (p *Planner) Checkpoint(ctx context.Context, name string) (*Plan, error)

+ func (p *Planner) CheckpointSchema(ctx context.Context, name string) (*Plan, error)

+ func (p *Planner) WriteCheckpoint(plan *Plan, tag string) error

Jul 26, 2023

Changes in this version

type MemDir

+ func (d *MemDir) Reset()

+ func (d *MemDir) SyncWrites(fs ...func(string, []byte) error)

+ type PlanMode uint8

+ const PlanModeDeferred

+ const PlanModeDump

+ const PlanModeInPlace

+ const PlanModeUnset

+ func (m PlanMode) Is(m1 PlanMode) bool

type PlanOptions

+ Mode PlanMode

type PlannerOption

+ func PlanWithMode(m PlanMode) PlannerOption

May 8, 2023

Changes in this version

+ func LogNoPendingFiles(l Logger, revs []*Revision)

type PlannerOption

+ func PlanWithDiffOptions(opts ...schema.DiffOption) PlannerOption

Mar 15, 2023

Changes in this version

+ func ArchiveDir(dir Dir) ([]byte, error)

type Dir

+ func UnarchiveDir(arc []byte) (Dir, error)

type PlanOptions

+ Indent string

type PlannerOption

+ func PlanWithIndent(indent string) PlannerOption

Feb 28, 2023

Changes in this version

type LocalFile

+ func (f LocalFile) Directive(name string) (ds []string)

type MemDir

+ func OpenMemDir(name string) *MemDir

+ func (d *MemDir) Close() error

Jan 6, 2023

Changes in this version

type Change

+ func (c *Change) ReverseStmts() (cmd []string, err error)

type HashFile

+ func NewHashFile(files []File) (HashFile, error)

+ type MemDir struct

+ func (d *MemDir) Checksum() (HashFile, error)

+ func (d *MemDir) Files() ([]File, error)

+ func (d *MemDir) Open(name string) (fs.File, error)

+ func (d *MemDir) WriteFile(name string, data []byte) error

Oct 20, 2022

Changes in this version

type Executor

+ func (e *Executor) ExecuteTo(ctx context.Context, version string) (err error)

type LogError

+ SQL string

type LogFile

+ File File

+ type ReplayOption func(*replayConfig)

+ func ReplayToVersion(v string) ReplayOption

type Revision

+ ErrorStmt string

type RevisionType

+ func (r RevisionType) Has(f RevisionType) bool

+ func (r RevisionType) MarshalText() ([]byte, error)

+ func (r RevisionType) String() string

Sep 25, 2022

Changes in this version

type File

+ StmtDecls func() ([]*Stmt, error)

type HashFile

+ func (f HashFile) SumByName(n string) (string, error)

+ type MissingMigrationError struct

+ Description string

+ Version string

+ func (e MissingMigrationError) Error() string

type NopRevisionReadWriter

+ func (NopRevisionReadWriter) DeleteRevision(context.Context, string) error

type Plan

+ Version string

type RevisionReadWriter

+ DeleteRevision func(context.Context, string) error

type Stmt

+ func Stmts(input string) ([]*Stmt, error)

Sep 7, 2022

Changes in this version

type Stmt

+ Pos int

+ func (s *Stmt) Directive(name string) (ds []string)

Aug 31, 2022

Changes in this version

type ExecutorOption

+ func WithOperatorVersion(v string) ExecutorOption

type LocalFile

+ func (f LocalFile) StmtDecls() ([]*Stmt, error)

+ type Stmt struct

+ Comments []string

+ Text string

Aug 22, 2022

Changes in this version

type Dir

+ Checksum func() (HashFile, error)

type LocalDir

+ func (d *LocalDir) Checksum() (HashFile, error)

Aug 11, 2022

Changes in this version

+ var ErrCleanCheckerUnsupported = errors.New("sql/migrate: driver does not support checking if database is clean")

+ var ErrRevisionNotExist = errors.New("sql/migrate: revision not found")

+ func FilesLastIndex(files []File, f func(File) bool) int

+ func LogIntro(l Logger, revs Revisions, files []File) error

+ type CleanChecker interface

+ CheckClean func(context.Context, *TableIdent) error

type Dir

+ Files func() ([]File, error)

type Executor

+ func (e *Executor) Replay(ctx context.Context, r StateReader) (_ *schema.Realm, err error)

type ExecutorOption

+ func WithAllowDirty(b bool) ExecutorOption

+ func WithBaselineVersion(v string) ExecutorOption

+ func WithFromVersion(v string) ExecutorOption

type File

+ Desc func() string

+ Stmts func() ([]string, error)

+ Version func() string

+ type HistoryChangedError struct

+ File string

+ Stmt int

+ func (e HistoryChangedError) Error() string

type LocalFile

+ func (f LocalFile) Desc() string

+ func (f LocalFile) Stmts() ([]string, error)

+ func (f LocalFile) Version() string

+ type LogError struct

+ Error error

type LogFile

+ Skip int

+ type NopLogger struct

+ func (NopLogger) Log(LogEntry)

type NopRevisionReadWriter

+ func (NopRevisionReadWriter) Ident() *TableIdent

+ func (NopRevisionReadWriter) ReadRevision(context.Context, string) (*Revision, error)

+ type PlanOption func(*PlanOptions)

+ type PlanOptions struct

+ SchemaQualifier *string

type Planner

+ func (p *Planner) PlanSchema(ctx context.Context, name string, to StateReader) (*Plan, error)

type PlannerOption

+ func PlanFormat(fmt Formatter) PlannerOption

+ func PlanWithChecksum(b bool) PlannerOption

+ func PlanWithSchemaQualifier(q string) PlannerOption

type Revision

+ Applied int

+ PartialHashes []string

+ Total int

+ Type RevisionType

+ func (r *Revision) Complete() error

type RevisionReadWriter

+ Ident func() *TableIdent

+ ReadRevision func(context.Context, string) (*Revision, error)

+ type RevisionType uint

+ const RevisionTypeBaseline

+ const RevisionTypeExecute

+ const RevisionTypeResolved

+ const RevisionTypeUnknown

type StateReader

+ func RealmConn(drv Driver, opts *schema.InspectRealmOption) StateReader

+ func SchemaConn(drv Driver, name string, opts *schema.InspectOptions) StateReader

+ type TableIdent struct

+ Name string

+ Schema string

Jul 13, 2022

Changes in this version

+ const StateError

+ const StateOK

+ const StateOngoing

+ var ErrSnapshotUnsupported = errors.New("sql/migrate: driver does not support taking a database snapshot")

+ type DirtyError struct

+ State string

+ Version string

+ func (e DirtyError) Error() string

+ type NotCleanError struct

+ Reason string

+ func (e NotCleanError) Error() string

+ type RestoreFunc func(context.Context) error

+ type Snapshoter interface

+ Snapshot func(context.Context) (RestoreFunc, error)

Jul 10, 2022

Changes in this version

+ const HashFileName

+ func Clean(ctx context.Context, drv Driver) error

+ func IsClean(ctx context.Context, drv Driver) error

type File

+ Bytes func() []byte

type LocalDir

+ func (d *LocalDir) Path() string

type LocalFile

+ func NewLocalFile(path string, data []byte) *LocalFile

+ func (f LocalFile) Bytes() []byte

Jun 8, 2022

Changes in this version

type Executor

+ func (e *Executor) ExecuteN(ctx context.Context, n int) error

+ func (e *Executor) Lock(ctx context.Context) (schema.UnlockFunc, error)

+ func (e *Executor) Pending(ctx context.Context) ([]File, error)

+ type LogDone struct

type LogExecution

+ From string

+ To string

+ type NopRevisionReadWriter struct

+ func (NopRevisionReadWriter) ReadRevisions(context.Context) (Revisions, error)

+ func (NopRevisionReadWriter) WriteRevision(context.Context, *Revision) error

type RevisionReadWriter

+ WriteRevision func(context.Context, *Revision) error

May 19, 2022

Changes in this version

+ var ErrLockUnsupported = errors.New("sql/migrate: driver does not support locking")

+ var ErrNotClean = errors.New("sql/migrate: connected database is not clean")

type Executor

+ func (e *Executor) ReadState(ctx context.Context) (realm *schema.Realm, err error)

type ExecutorOption

+ func WithLogger(log Logger) ExecutorOption

+ type LogEntry interface

+ type LogExecution struct

+ Files []string

+ type LogFile struct

+ Desc string

+ Version string

+ type LogStmt struct

+ SQL string

+ type Logger interface

+ Log func(LogEntry)

+ type NoopRevisionReadWriter struct

+ func (NoopRevisionReadWriter) ReadRevisions(context.Context) (Revisions, error)

+ func (NoopRevisionReadWriter) WriteRevisions(context.Context, Revisions) error

May 11, 2022

Changes in this version

+ var ErrChecksumFormat = errors.New("checksum file format invalid")

+ var ErrChecksumNotFound = errors.New("checksum file not found")

+ var ErrNoPendingFiles = errors.New("sql/migrate: execute: nothing to do")

+ func WriteSumFile(dir Dir, sum HashFile) error

+ type Executor struct

+ func NewExecutor(drv Driver, dir Dir, rrw RevisionReadWriter, opts ...ExecutorOption) (*Executor, error)

+ func (e *Executor) Execute(ctx context.Context, n int) (err error)

+ type ExecutorOption func(*Executor) error

type LocalDir

+ func (d *LocalDir) Desc(f File) (string, error)

+ func (d *LocalDir) Files() ([]File, error)

+ func (d *LocalDir) Stmts(f File) ([]string, error)

+ func (d *LocalDir) Version(f File) (string, error)

+ type LocalFile struct

+ func (f LocalFile) Name() string

+ func (f LocalFile) Read(buf []byte) (int, error)

+ type Revision struct

+ Description string

+ Error string

+ ExecutedAt time.Time

+ ExecutionState string

+ ExecutionTime time.Duration

+ Hash string

+ Meta map[string]string

+ OperatorVersion string

+ Version string

+ type RevisionReadWriter interface

+ ReadRevisions func(context.Context) (Revisions, error)

+ WriteRevisions func(context.Context, Revisions) error

+ type Revisions []*Revision

+ type Scanner interface

+ Desc func(File) (string, error)

+ Files func() ([]File, error)

+ Stmts func(File) ([]string, error)

+ Version func(File) (string, error)

type StateReader

+ func Conn(drv Driver, opts *schema.InspectRealmOption) StateReader

Mar 8, 2022

Changes in this version

+ var ErrChecksumMismatch = errors.New("checksum mismatch")

+ func Validate(dir Dir) error

+ type HashFile []struct

+ func HashSum(dir Dir) (HashFile, error)

+ func (s *HashFile) UnmarshalText(b []byte) error

+ func (s HashFile) MarshalText() ([]byte, error)

+ func (s HashFile) Sum() string

type Planner

+ func NewPlanner(drv Driver, dir Dir, opts ...PlannerOption) *Planner

+ type PlannerOption func(*Planner)

+ func DisableChecksum() PlannerOption

+ func WithFormatter(fmt Formatter) PlannerOption

+ func WithStateReader(dsr StateReader) PlannerOption

type StateReaderFunc

+ func GlobStateReader(dir Dir, drv Driver, glob string) StateReaderFunc

Feb 17, 2022

Changes in this version

type Dir

+ WriteFile func(string, []byte) error

type LocalDir

+ func (d *LocalDir) GlobStateReader(drv Driver, glob string) StateReaderFunc

+ func (d *LocalDir) WriteFile(name string, b []byte) error

Feb 13, 2022

Changes in this version

+ var DefaultFormatter = &TemplateFormatter

type Dir

+ Open func(name string) (io.ReadWriteCloser, error)

+ type File interface

+ Name func() string

+ type Formatter interface

+ Format func(*Plan) ([]File, error)

+ type LocalDir struct

+ func NewLocalDir(path string) (*LocalDir, error)

+ func (d *LocalDir) Open(name string) (File, error)

+ type Planner struct

+ func New(drv Driver, dir Dir, fmt Formatter) *Planner

+ func (p *Planner) Plan(ctx context.Context, name string, from StateReader, to StateReader) (*Plan, error)

+ func (p *Planner) WritePlan(plan *Plan) error

+ type TemplateFormatter struct

+ func NewTemplateFormatter(templates ...*template.Template) (*TemplateFormatter, error)

+ func (t *TemplateFormatter) Format(plan *Plan) ([]File, error)

Jan 6, 2022

Changes in this version

+ var ErrNoPlan = errors.New("sql/migrate: no plan for matched states")

+ var TemplateFuncs = template.FuncMap

+ type Change struct

+ Args []interface{}

+ Cmd string

+ Comment string

+ Reverse string

+ Source schema.Change

+ type Dir struct

+ func NewDir(opts ...DirOption) (*Dir, error)

+ func (d *Dir) Compact(ctx context.Context, name string, n int) error

+ func (d *Dir) Plan(ctx context.Context, name string, to StateReader) (*Plan, error)

+ func (d *Dir) ReadState(ctx context.Context) (*schema.Realm, error)

+ func (d *Dir) WritePlan(p *Plan) error

+ type DirOption func(*Dir) error

+ func DirConn(conn Driver) DirOption

+ func DirFS(fs fs.FS) DirOption

+ func DirGlob(pattern string) DirOption

+ func DirPath(path string) DirOption

+ func DirTemplates(nameFileTmpl ...string) DirOption

+ type Driver interface

+ type FileRemoveWriter interface

+ RemoveFile func(name string) error

+ WriteFile func(name string, data []byte, perm fs.FileMode) error

+ type Plan struct

+ Changes []*Change

+ Name string

+ Reversible bool

+ Transactional bool

+ type PlanApplier interface

+ ApplyChanges func(context.Context, []schema.Change) error

+ PlanChanges func(context.Context, string, []schema.Change) (*Plan, error)

+ type StateReader interface

+ ReadState func(ctx context.Context) (*schema.Realm, error)

+ func Realm(r *schema.Realm) StateReader

+ func Schema(s *schema.Schema) StateReader

+ type StateReaderFunc func(ctx context.Context) (*schema.Realm, error)

+ func (f StateReaderFunc) ReadState(ctx context.Context) (*schema.Realm, error)