migrations

Documentation

Overview

Package migrations runs versioned schema migrations against the relay package's embedded bbolt key-value store, tracking the applied version in a dedicated bucket.

Index

• Variables
• type Manager
  • func NewManager(db *bolt.DB, opts ...ManagerOption) *Manager
  • func (m *Manager) GetCurrentVersion() (uint64, error)
  • func (m *Manager) Register(migration Migration)
  • func (m *Manager) Run() error
  • func (m *Manager) SetVersion(tx *bolt.Tx, version uint64) error
• type ManagerOption
  • func WithLogger(logger zerolog.Logger) ManagerOption
• type Migration
• type ResetVerificationCacheMigration
  • func (m *ResetVerificationCacheMigration) Description() string
  • func (m *ResetVerificationCacheMigration) Down(tx *bolt.Tx) error
  • func (m *ResetVerificationCacheMigration) Up(tx *bolt.Tx) error
  • func (m *ResetVerificationCacheMigration) Version() uint64

Variables

var (
	// Bucket to store migration version
	MIGRATIONS_BUCKET = []byte("_migrations")
	// Key to store the current version
	VERSION_KEY = []byte("version")
)

Types

type Manager

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

func NewManager

func NewManager(db *bolt.DB, opts ...ManagerOption) *Manager

func (*Manager) GetCurrentVersion

func (m *Manager) GetCurrentVersion() (uint64, error)

func (*Manager) Register

func (m *Manager) Register(migration Migration)

func (*Manager) Run

func (m *Manager) Run() error

func (*Manager) SetVersion

func (m *Manager) SetVersion(tx *bolt.Tx, version uint64) error

type ManagerOption

type ManagerOption func(*Manager)

ManagerOption mutates a Manager at construction time.

func WithLogger

func WithLogger(logger zerolog.Logger) ManagerOption

WithLogger configures the logger used for migration progress logging. Defaults to zerolog.Nop() (silent).

type Migration

type Migration interface {
	Version() uint64
	Description() string
	Up(tx *bolt.Tx) error
	Down(tx *bolt.Tx) error
}

type ResetVerificationCacheMigration

type ResetVerificationCacheMigration struct {
	MetricsBucket []byte
}

func (*ResetVerificationCacheMigration) Description

func (m *ResetVerificationCacheMigration) Description() string

func (*ResetVerificationCacheMigration) Down

func (m *ResetVerificationCacheMigration) Down(tx *bolt.Tx) error

func (*ResetVerificationCacheMigration) Up

func (m *ResetVerificationCacheMigration) Up(tx *bolt.Tx) error

func (*ResetVerificationCacheMigration) Version

func (m *ResetVerificationCacheMigration) Version() uint64