goose

package module

Go to main page

Versions in this module

v3

v3.17.2

Jan 23, 2024

Changes in this version

type ProviderOption

+ func WithDeallocateStatementCache(f func(context.Context, *sql.Conn) error) ProviderOption

+ func WithLogger(logger Logger) ProviderOption

v3.17.1

Jan 17, 2024

Changes in this version

+ const DefaultTablename

+ var ErrAlreadyApplied = errors.New("migration already applied")

+ var ErrNoMigrationFiles = errors.New("no migration files found")

+ var ErrNoMigrations = errors.New("no migrations found")

+ var ErrNotApplied = errors.New("migration not applied")

+ var ErrVersionNotFound = errors.New("version not found")

+ func ResetGlobalMigrations()

+ func SetGlobalMigrations(migrations ...*Migration) error

+ type Dialect = database.Dialect

+ const DialectClickHouse

+ const DialectMSSQL

+ const DialectMySQL

+ const DialectPostgres

+ const DialectRedshift

+ const DialectSQLite3

+ const DialectTiDB

+ const DialectVertica

+ const DialectYdB

+ type GoFunc struct

+ Mode TransactionMode

+ RunDB func(ctx context.Context, db *sql.DB) error

+ RunTx func(ctx context.Context, tx *sql.Tx) error

type Migration

+ Type MigrationType

+ func NewGoMigration(version int64, up, down *GoFunc) *Migration

+ type MigrationResult struct

+ Direction string

+ Duration time.Duration

+ Empty bool

+ Error error

+ Source *Source

+ func (m *MigrationResult) String() string

+ type MigrationStatus struct

+ AppliedAt time.Time

+ Source *Source

+ State State

+ type MigrationType string

+ const TypeGo

+ const TypeSQL

+ type PartialError struct

+ Applied []*MigrationResult

+ Err error

+ Failed *MigrationResult

+ func (e *PartialError) Error() string

+ type Provider struct

+ func NewProvider(dialect Dialect, db *sql.DB, fsys fs.FS, opts ...ProviderOption) (*Provider, error)

+ func (p *Provider) ApplyVersion(ctx context.Context, version int64, direction bool) (*MigrationResult, error)

+ func (p *Provider) Close() error

+ func (p *Provider) Down(ctx context.Context) (*MigrationResult, error)

+ func (p *Provider) DownTo(ctx context.Context, version int64) ([]*MigrationResult, error)

+ func (p *Provider) GetDBVersion(ctx context.Context) (int64, error)

+ func (p *Provider) ListSources() []*Source

+ func (p *Provider) Ping(ctx context.Context) error

+ func (p *Provider) Status(ctx context.Context) ([]*MigrationStatus, error)

+ func (p *Provider) Up(ctx context.Context) ([]*MigrationResult, error)

+ func (p *Provider) UpByOne(ctx context.Context) (*MigrationResult, error)

+ func (p *Provider) UpTo(ctx context.Context, version int64) ([]*MigrationResult, error)

+ type ProviderOption interface

+ func WithAllowOutofOrder(b bool) ProviderOption

+ func WithDisableGlobalRegistry(b bool) ProviderOption

+ func WithDisableVersioning(b bool) ProviderOption

+ func WithExcludeNames(excludes []string) ProviderOption

+ func WithExcludeVersions(versions []int64) ProviderOption

+ func WithGoMigrations(migrations ...*Migration) ProviderOption

+ func WithSessionLocker(locker lock.SessionLocker) ProviderOption

+ func WithStore(store database.Store) ProviderOption

+ func WithVerbose(b bool) ProviderOption

+ type Source struct

+ Path string

+ Type MigrationType

+ Version int64

+ type State string

+ const StateApplied

+ const StatePending

+ type TransactionMode int

+ const TransactionDisabled

+ const TransactionEnabled

+ func (m TransactionMode) String() string

v3.12.2

May 8, 2023

retracted

v3.12.1

May 8, 2023

retracted

v3.12.0

May 8, 2023

retracted

Changes in this version

+ func AddMigrationContext(up, down GoMigrationContext)

+ func AddMigrationNoTxContext(up, down GoMigrationNoTxContext)

+ func AddNamedMigrationContext(filename string, up, down GoMigrationContext)

+ func AddNamedMigrationNoTxContext(filename string, up, down GoMigrationNoTxContext)

+ func DownContext(ctx context.Context, db *sql.DB, dir string, opts ...OptionsFunc) error

+ func DownToContext(ctx context.Context, db *sql.DB, dir string, version int64, ...) error

+ func EnsureDBVersionContext(ctx context.Context, db *sql.DB) (int64, error)

+ func GetDBVersionContext(ctx context.Context, db *sql.DB) (int64, error)

+ func RedoContext(ctx context.Context, db *sql.DB, dir string, opts ...OptionsFunc) error

+ func ResetContext(ctx context.Context, db *sql.DB, dir string, opts ...OptionsFunc) error

+ func RunContext(ctx context.Context, command string, db *sql.DB, dir string, args ...string) error

+ func RunWithOptionsContext(ctx context.Context, command string, db *sql.DB, dir string, args []string, ...) error

+ func StatusContext(ctx context.Context, db *sql.DB, dir string, opts ...OptionsFunc) error

+ func UpByOneContext(ctx context.Context, db *sql.DB, dir string, opts ...OptionsFunc) error

+ func UpContext(ctx context.Context, db *sql.DB, dir string, opts ...OptionsFunc) error

+ func UpToContext(ctx context.Context, db *sql.DB, dir string, version int64, ...) error

+ func VersionContext(ctx context.Context, db *sql.DB, dir string, opts ...OptionsFunc) error

+ type GoMigrationContext func(ctx context.Context, tx *sql.Tx) error

+ type GoMigrationNoTxContext func(ctx context.Context, db *sql.DB) error

type Migration

+ DownFnContext GoMigrationContext

+ DownFnNoTxContext GoMigrationNoTxContext

+ UpFnContext GoMigrationContext

+ UpFnNoTxContext GoMigrationNoTxContext

+ func (m *Migration) DownContext(ctx context.Context, db *sql.DB) error

+ func (m *Migration) UpContext(ctx context.Context, db *sql.DB) error

v3.9.1

Feb 1, 2023

Changes in this version

+ const VERSION

+ var ErrNoCurrentVersion = errors.New("no current version found")

+ var ErrNoNextVersion = errors.New("no next version found")

+ var MaxVersion int64 = math.MaxInt64

+ func AddMigration(up, down GoMigration)

+ func AddMigrationNoTx(up, down GoMigrationNoTx)

+ func AddNamedMigration(filename string, up, down GoMigration)

+ func AddNamedMigrationNoTx(filename string, up, down GoMigrationNoTx)

+ func Create(db *sql.DB, dir, name, migrationType string) error

+ func CreateVersionTable(db *sql.DB) error

+ func CreateWithTemplate(db *sql.DB, dir string, tmpl *template.Template, name, migrationType string) error

+ func Down(db *sql.DB, dir string, opts ...OptionsFunc) error

+ func DownTo(db *sql.DB, dir string, version int64, opts ...OptionsFunc) error

+ func EnsureDBVersion(db *sql.DB) (int64, error)

+ func Fix(dir string) error

+ func GetDBVersion(db *sql.DB) (int64, error)

+ func NumericComponent(name string) (int64, error)

+ func OpenDBWithDriver(driver string, dbstring string) (*sql.DB, error)

+ func Redo(db *sql.DB, dir string, opts ...OptionsFunc) error

+ func Reset(db *sql.DB, dir string, opts ...OptionsFunc) error

+ func Run(command string, db *sql.DB, dir string, args ...string) error

+ func RunWithOptions(command string, db *sql.DB, dir string, args []string, options ...OptionsFunc) error

+ func SetBaseFS(fsys fs.FS)

+ func SetDialect(d string) error

+ func SetLogger(l Logger)

+ func SetSequential(s bool)

+ func SetTableName(n string)

+ func SetVerbose(v bool)

+ func Status(db *sql.DB, dir string, opts ...OptionsFunc) error

+ func TableName() string

+ func Up(db *sql.DB, dir string, opts ...OptionsFunc) error

+ func UpByOne(db *sql.DB, dir string, opts ...OptionsFunc) error

+ func UpTo(db *sql.DB, dir string, version int64, opts ...OptionsFunc) error

+ func Version(db *sql.DB, dir string, opts ...OptionsFunc) error

+ type ClickHouseDialect struct

+ type GoMigration func(tx *sql.Tx) error

+ type GoMigrationNoTx func(db *sql.DB) error

+ type Logger interface

+ Fatal func(v ...interface{})

+ Fatalf func(format string, v ...interface{})

+ Print func(v ...interface{})

+ Printf func(format string, v ...interface{})

+ Println func(v ...interface{})

+ func NopLogger() Logger

+ type Migration struct

+ DownFn GoMigration

+ DownFnNoTx GoMigrationNoTx

+ Next int64

+ Previous int64

+ Registered bool

+ Source string

+ UpFn GoMigration

+ UpFnNoTx GoMigrationNoTx

+ UseTx bool

+ Version int64

+ func (m *Migration) Down(db *sql.DB) error

+ func (m *Migration) String() string

+ func (m *Migration) Up(db *sql.DB) error

+ type MigrationRecord struct

+ IsApplied bool

+ TStamp time.Time

+ VersionID int64

+ type Migrations []*Migration

+ func CollectMigrations(dirpath string, current, target int64) (Migrations, error)

+ func (ms Migrations) Current(current int64) (*Migration, error)

+ func (ms Migrations) Last() (*Migration, error)

+ func (ms Migrations) Len() int

+ func (ms Migrations) Less(i, j int) bool

+ func (ms Migrations) Next(current int64) (*Migration, error)

+ func (ms Migrations) Previous(current int64) (*Migration, error)

+ func (ms Migrations) String() string

+ func (ms Migrations) Swap(i, j int)

+ type MySQLDialect struct

+ type OptionsFunc func(o *options)

+ func WithAllowMissing() OptionsFunc

+ func WithNoColor(b bool) OptionsFunc

+ func WithNoVersioning() OptionsFunc

+ type PostgresDialect struct

+ type RedshiftDialect struct

+ type SQLDialect interface

+ func GetDialect() SQLDialect

+ type SqlServerDialect struct

+ type Sqlite3Dialect struct

+ type TiDBDialect struct

+ type VerticaDialect struct

Other modules containing this package

github.com/piiano/goose

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