badger

Documentation

Index

• func MigrateLatest(db *badger.DB, id string) error
• func Open(opts badger.Options) (*badgerStore, error)
• type Migration
  • func (m *Migration) Migrate(db *badger.DB) error
• type MigrationError
  • func (err MigrationError) Error() string
• type MigrationStep

Functions

func MigrateLatest

func MigrateLatest(db *badger.DB, id string) error

MigrateLatest converts the database to the latest version that we know of.

func Open

func Open(opts badger.Options) (*badgerStore, error)

Open returns a store.Store implementation using Badger as the storage driver. The store should be (*badgerStore).Close()'d after use.

Types

type Migration

type Migration struct {
	// StartVersion is the minimum version that is supported by the migration.
	StartVersion int
	// LatestVersion is the final version that we should expect after running migrations.
	LatestVersion int
	// Steps are the migration steps for transforming the database state across versions when run in sequence.
	Steps []MigrationStep
	// DatabaseID is an identifier for the database being migrated (e.g. opts.Dir), used for more descriptive errors.
	DatabaseID string
}

Migration handles transforming the database state to the newest version.

func (*Migration) Migrate

func (m *Migration) Migrate(db *badger.DB) error

Migrate performs the migration sequence.

type MigrationError

type MigrationError struct {
	OldVersion int
	NewVersion int
	Path       string
	Cause      error
}

MigrationError is returned when the database is opened with an outdated version and migation fails.

func (MigrationError) Error

func (err MigrationError) Error() string

type MigrationStep

type MigrationStep func(txn *badger.Txn) error

MigrationStep is called within an update transaction with the current version. It should update the database state to the next version. The migration step should update the database version with each step.