migrate

Documentation

Index

• type Command
• type Migration
• type MigrationFunc
  • func NewSQLMigrationFunc(fsys fs.FS, name string) MigrationFunc
• type Migrations
  • func NewMigrations(opts ...MigrationsOption) *Migrations
  • func (m *Migrations) CreateGo(ctx context.Context, db *bun.DB, name string) error
  • func (m *Migrations) CreateSQL(ctx context.Context, db *bun.DB, name string) error
  • func (m *Migrations) Discover(fsys fs.FS) error
  • func (m *Migrations) DiscoverCaller() error
  • func (m *Migrations) Init(ctx context.Context, db *bun.DB) error
  • func (m *Migrations) Lock(ctx context.Context, db *bun.DB) error
  • func (m *Migrations) MarkCompleted(ctx context.Context, db *bun.DB) error
  • func (m *Migrations) Migrate(ctx context.Context, db *bun.DB) error
  • func (m *Migrations) Migrations() []Migration
  • func (m *Migrations) MustRegister(up, down MigrationFunc)
  • func (m *Migrations) Register(up, down MigrationFunc) error
  • func (m *Migrations) Rollback(ctx context.Context, db *bun.DB) error
  • func (m *Migrations) Status(ctx context.Context, db *bun.DB) error
  • func (m *Migrations) Unlock(ctx context.Context, db *bun.DB) error
• type MigrationsOption
  • func WithLocksTableName(table string) MigrationsOption
  • func WithTableName(table string) MigrationsOption

Types

type Command

type Command struct {
	Name string
}

type Migration

type Migration struct {
	bun.BaseModel `bun:"alias:m"`

	ID         int64
	Name       string
	GroupID    int64
	MigratedAt time.Time `bun:",notnull,default:current_timestamp"`

	Up   MigrationFunc `bun:"-"`
	Down MigrationFunc `bun:"-"`
}

type MigrationFunc

type MigrationFunc func(ctx context.Context, db *bun.DB) error

func NewSQLMigrationFunc

func NewSQLMigrationFunc(fsys fs.FS, name string) MigrationFunc

type Migrations

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

func NewMigrations

func NewMigrations(opts ...MigrationsOption) *Migrations

func (*Migrations) CreateGo

func (m *Migrations) CreateGo(ctx context.Context, db *bun.DB, name string) error

func (*Migrations) CreateSQL

func (m *Migrations) CreateSQL(ctx context.Context, db *bun.DB, name string) error

func (*Migrations) Discover

func (m *Migrations) Discover(fsys fs.FS) error

func (*Migrations) DiscoverCaller

func (m *Migrations) DiscoverCaller() error

func (*Migrations) Init

func (m *Migrations) Init(ctx context.Context, db *bun.DB) error

func (*Migrations) Lock

func (m *Migrations) Lock(ctx context.Context, db *bun.DB) error

func (*Migrations) MarkCompleted

func (m *Migrations) MarkCompleted(ctx context.Context, db *bun.DB) error

func (*Migrations) Migrate

func (m *Migrations) Migrate(ctx context.Context, db *bun.DB) error

func (*Migrations) Migrations

func (m *Migrations) Migrations() []Migration

func (*Migrations) MustRegister

func (m *Migrations) MustRegister(up, down MigrationFunc)

func (*Migrations) Register

func (m *Migrations) Register(up, down MigrationFunc) error

func (*Migrations) Rollback

func (m *Migrations) Rollback(ctx context.Context, db *bun.DB) error

func (*Migrations) Status

func (m *Migrations) Status(ctx context.Context, db *bun.DB) error

func (*Migrations) Unlock

func (m *Migrations) Unlock(ctx context.Context, db *bun.DB) error

type MigrationsOption

type MigrationsOption func(m *Migrations)

func WithLocksTableName

func WithLocksTableName(table string) MigrationsOption

func WithTableName

func WithTableName(table string) MigrationsOption