migration

Documentation

Index

• Variables
• func MigrateIfNeeded(ctx context.Context, targetDB db.DB, network *utils.Network, ...) error
• func SchemaMetadata(targetDB db.DB) (schemaMetadata, error)
• type BucketMigrator
  • func NewBucketMigrator(target db.Bucket, do BucketMigratorDoFunc) *BucketMigrator
  • func NewBucketMover(source, destination db.Bucket) *BucketMigrator
  • func (m *BucketMigrator) Before(_ []byte) error
  • func (m *BucketMigrator) Migrate(ctx context.Context, txn db.Transaction, network *utils.Network, ...) ([]byte, error)
  • func (m *BucketMigrator) WithBatchSize(batchSize uint) *BucketMigrator
  • func (m *BucketMigrator) WithBefore(before func()) *BucketMigrator
  • func (m *BucketMigrator) WithKeyFilter(keyFilter BucketMigratorKeyFilter) *BucketMigrator
• type BucketMigratorDoFunc
• type BucketMigratorKeyFilter
• type Migration
• type MigrationFunc
  • func (f MigrationFunc) Before(_ []byte) error
  • func (f MigrationFunc) Migrate(_ context.Context, txn db.Transaction, network *utils.Network, ...) ([]byte, error)

Variables

var ErrCallWithNewTransaction = errors.New("call with new transaction")

Functions

func MigrateIfNeeded

func MigrateIfNeeded(ctx context.Context, targetDB db.DB, network *utils.Network, log utils.SimpleLogger) error

func SchemaMetadata

func SchemaMetadata(targetDB db.DB) (schemaMetadata, error)

SchemaMetadata retrieves metadata about a database schema from the given database.

Types

type BucketMigrator

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

func NewBucketMigrator

func NewBucketMigrator(target db.Bucket, do BucketMigratorDoFunc) *BucketMigrator

func NewBucketMover

func NewBucketMover(source, destination db.Bucket) *BucketMigrator

func (*BucketMigrator) Before

func (m *BucketMigrator) Before(_ []byte) error

func (*BucketMigrator) Migrate

func (m *BucketMigrator) Migrate(ctx context.Context, txn db.Transaction, network *utils.Network, log utils.SimpleLogger) ([]byte, error)

func (*BucketMigrator) WithBatchSize

func (m *BucketMigrator) WithBatchSize(batchSize uint) *BucketMigrator

func (*BucketMigrator) WithBefore

func (m *BucketMigrator) WithBefore(before func()) *BucketMigrator

func (*BucketMigrator) WithKeyFilter

func (m *BucketMigrator) WithKeyFilter(keyFilter BucketMigratorKeyFilter) *BucketMigrator

type BucketMigratorDoFunc

type BucketMigratorDoFunc func(t db.Transaction, b1, b2 []byte, n *utils.Network) error

type BucketMigratorKeyFilter

type BucketMigratorKeyFilter func([]byte) (bool, error)

type Migration

type Migration interface {
	Before(intermediateState []byte) error
	// Migration should return intermediate state whenever it requests new txn or detects cancelled ctx.
	Migrate(context.Context, db.Transaction, *utils.Network, utils.SimpleLogger) ([]byte, error)
}

type MigrationFunc

type MigrationFunc func(db.Transaction, *utils.Network) error

func (MigrationFunc) Before

func (f MigrationFunc) Before(_ []byte) error

Before is a no-op.

func (MigrationFunc) Migrate

func (f MigrationFunc) Migrate(_ context.Context, txn db.Transaction, network *utils.Network, _ utils.SimpleLogger) ([]byte, error)

Migrate returns f(txn).