migrator

Documentation

Index

• func BSONSingleFieldIndexKeyEquals(key bson.D, field string, direction int32) bool
• func DefaultOwnerID(hostname string) string
• func IsMongoDuplicateKeyError(err error) bool
• func TargetVersion(list []Migration) int64
• type LockAcquireInfo
• type Locker
  • func NewLocker(db *mongo.Database, lockKey, owner string, leaseFor time.Duration) *Locker
  • func (l *Locker) Release(ctx context.Context) error
  • func (l *Locker) Renew(ctx context.Context) error
  • func (l *Locker) TryAcquire(ctx context.Context) (bool, error)
  • func (l *Locker) TryAcquireWithInfo(ctx context.Context) (LockAcquireInfo, error)
• type Manager
  • func NewManager(db *mongo.Database, owner string, cfg ManagerConfig) *Manager
  • func (m *Manager) LastError() string
  • func (m *Manager) Ready() bool
  • func (m *Manager) Run(ctx context.Context, list []Migration) error
• type ManagerConfig
• type Migration
  • func ValidateAndSort(list []Migration) ([]Migration, error)
• type MongoIndexInfo
  • func ListMongoIndexes(ctx context.Context, col *mongo.Collection) ([]MongoIndexInfo, error)
• type MongoIndexState
  • func MongoSingleFieldIndexState(indexes []MongoIndexInfo, field string, direction int32, desiredName string) (state MongoIndexState, existingName string, err error)
• type MongoUniqueStringFieldDiagnostics
  • func DiagnoseMongoUniqueStringField(ctx context.Context, col *mongo.Collection, field string, limit int) (MongoUniqueStringFieldDiagnostics, error)

Functions

func BSONSingleFieldIndexKeyEquals

func BSONSingleFieldIndexKeyEquals(key bson.D, field string, direction int32) bool

func DefaultOwnerID

func DefaultOwnerID(hostname string) string

func IsMongoDuplicateKeyError

func IsMongoDuplicateKeyError(err error) bool

func TargetVersion

func TargetVersion(list []Migration) int64

Types

type LockAcquireInfo

type LockAcquireInfo struct {
	Acquired       bool
	Created        bool
	Takeover       bool
	PrevOwner      string
	PrevLeaseUntil time.Time
	NewOwner       string
	NewLeaseUntil  time.Time
}

type Locker

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

func NewLocker

func NewLocker(db *mongo.Database, lockKey, owner string, leaseFor time.Duration) *Locker

func (*Locker) Release

func (l *Locker) Release(ctx context.Context) error

func (*Locker) Renew

func (l *Locker) Renew(ctx context.Context) error

func (*Locker) TryAcquire

func (l *Locker) TryAcquire(ctx context.Context) (bool, error)

func (*Locker) TryAcquireWithInfo

func (l *Locker) TryAcquireWithInfo(ctx context.Context) (LockAcquireInfo, error)

type Manager

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

func NewManager

func NewManager(db *mongo.Database, owner string, cfg ManagerConfig) *Manager

func (*Manager) LastError

func (m *Manager) LastError() string

func (*Manager) Ready

func (m *Manager) Ready() bool

func (*Manager) Run

func (m *Manager) Run(ctx context.Context, list []Migration) error

type ManagerConfig

type ManagerConfig struct {
	LockKey          string // e.g. identityservice:migrations
	LeaseFor         time.Duration
	PollInterval     time.Duration
	OpTimeout        time.Duration // OpTimeout (locks, reads/writes)
	MigrationTimeout time.Duration // MigrationTimeout (long-running migrations)

	Logger *logrus.Entry

	FailFast      bool // true — Run error
	WaitForLeader bool // true — not ready, while leader not accept target
}

type Migration

type Migration struct {
	Version int64
	Name    string
	Up      func(ctx context.Context, db *mongo.Database) error
}

func ValidateAndSort

func ValidateAndSort(list []Migration) ([]Migration, error)

type MongoIndexInfo

type MongoIndexInfo struct {
	Name   string `bson:"name"`
	Key    bson.D `bson:"key"`
	Unique bool   `bson:"unique,omitempty"`
}

func ListMongoIndexes

func ListMongoIndexes(ctx context.Context, col *mongo.Collection) ([]MongoIndexInfo, error)

type MongoIndexState

type MongoIndexState int

const (
	MongoIndexAbsent MongoIndexState = iota
	MongoIndexUnique
	MongoIndexNonUnique
)

func MongoSingleFieldIndexState

func MongoSingleFieldIndexState(indexes []MongoIndexInfo, field string, direction int32, desiredName string) (state MongoIndexState, existingName string, err error)

MongoSingleFieldIndexState: index with other desiredName, but other key-spec -> error, if exists by {field: direction}:

• unique -> MongoIndexUnique
• not unique -> MongoIndexNonUnique

type MongoUniqueStringFieldDiagnostics

type MongoUniqueStringFieldDiagnostics struct {
	DuplicateStrings []bson.M
	NullCount        int64
}

func DiagnoseMongoUniqueStringField

func DiagnoseMongoUniqueStringField(ctx context.Context, col *mongo.Collection, field string, limit int) (MongoUniqueStringFieldDiagnostics, error)

DiagnoseMongoUniqueStringField:

• field duplicates (limit)
• documents with field=null