db_migrator

Jan 14, 2025

Changes in this version

type ManagerOption

+ func WithLogger(logger *slog.Logger) ManagerOption

Feb 27, 2024

Changes in this version

type DbDependency

+ Strict bool

Sep 11, 2023

Changes in this version

type ServiceInfo

+ ConnectFunc func() *gorm.DB

+ Db *gorm.DB

+ DisconnectFunc func(db *gorm.DB)

+ TargetVersion Version

Sep 11, 2023

Changes in this version

type MigrationManager

+ func (m *MigrationManager) GetServiceInfoUnsafe(name string) (*ServiceInfo, bool)

Sep 11, 2023

Changes in this version

+ type DbDependency struct

+ Name string

+ Version string

type Migration

+ CheckSum func(db *sql.DB) string

+ Dependency []DbDependency

+ Description string

+ Down string

+ DownF func(db *sql.DB) error

+ Identifier uint32

+ IsAllowFailure bool

+ IsTransactional bool

+ MigrationType MigrationType

+ RepeatUnconditional bool

+ Up string

+ UpF func(db *sql.DB) error

+ Version string

type MigrationManager

+ func (m *MigrationManager) Register(serviceName string, migrationsStruct ...Migration) error

+ func (m *MigrationManager) RegisterService(name string, connectFunc func() *gorm.DB, disconnectFunc func(db *gorm.DB), ...) error

+ type ServiceInfo struct

Mar 17, 2023

Changes in this version

type MigrationLite

+ CheckSum func() string

+ Description string

+ Down string

+ DownF func(db *sql.DB) error

+ Identifier uint32

+ IsAllowFailure bool

+ IsTransactional bool

+ MigrationType MigrationType

+ RepeatUnconditional bool

+ Up string

+ UpF func(db *sql.DB) error

+ Version string

Mar 4, 2023

Changes in this version

+ var ErrHasFailedMigrations = errors.New("found failed migrations, consider fixing your db")

+ var ErrHasForthcomingMigrations = errors.New("found not completed forthcoming migrations, consider migrating")

+ var ErrTargetVersionNotLatest = errors.New("target version falls behind migrations, consider raising target version")

+ type ManagerOption func(*MigrationManager)

+ func WithLogFlags(flags int) ManagerOption

+ func WithLogWriter(w io.Writer) ManagerOption

+ type Migration struct

+ func NewBaselineMigration(migrator Migrator) *Migration

+ func NewRepeatableMigration(migrator RepeatableMigrator, opts ...RepeatableMigratorOption) *Migration

+ func NewVersionedMigration(migrator VersionedMigrator) *Migration

+ type MigrationLite struct

+ type MigrationManager struct

+ func NewMigrationsManager(dsn string, targetVersion string, opts ...ManagerOption) (*MigrationManager, error)

+ func (m *MigrationManager) CheckFulfillment() (reasonErr error, ok bool, err error)

+ func (m *MigrationManager) Downgrade() (err error)

+ func (m *MigrationManager) HasFailedMigrations() (bool, error)

+ func (m *MigrationManager) HasForthcomingMigrations() (bool, error)

+ func (m *MigrationManager) Migrate() error

+ func (m *MigrationManager) RegisterLite(migrationsStruct ...MigrationLite)

+ func (m *MigrationManager) RegisterMigration(migration *Migration, opts ...MigrationOption)

+ func (m *MigrationManager) TargetVersionNotLatest() (bool, error)

+ type MigrationOption func(*Migration)

+ func WithTransaction(useTransaction bool) MigrationOption

+ type MigrationType string

+ const TypeBaseline

+ const TypeRepeatable

+ const TypeVersioned

+ type Migrator interface

+ Description func() string

+ Migrate func(db *gorm.DB) error

+ Version func() Version

+ type RepeatableMigrator interface

+ Checksum func() string

+ type RepeatableMigratorOption func(*Migration)

+ func WithRepeatUnconditional() RepeatableMigratorOption

+ type Version struct

+ Major int

+ Minor int

+ Patch int

+ PreRelease int

+ func (v Version) Equals(version Version) bool

+ func (v Version) LessOrEqual(version Version) bool

+ func (v Version) LessThan(version Version) bool

+ func (v Version) MoreOrEqual(version Version) bool

+ func (v Version) MoreThan(version Version) bool

+ func (v Version) String() string

+ type VersionedMigrator interface

+ Downgrade func(db *gorm.DB) error