manager

Documentation

Index

• func SortDescending(dbs []*VersionedDatabase)
• type Manager
  • func New(dbDirPath string, log logging.Logger, currentVersion version.Version, ...) (Manager, error)
  • func NewDefaultMemDBManager() Manager
  • func NewManagerFromDBs(dbs []*VersionedDatabase) (Manager, error)
• type VersionedDatabase
  • func (db *VersionedDatabase) Close() error

Functions

func SortDescending

func SortDescending(dbs []*VersionedDatabase)

Types

type Manager

type Manager interface {
	// Current returns the database with the current database version.
	Current() *VersionedDatabase

	// Previous returns the database prior to the current database and true if a
	// previous database exists.
	Previous() (*VersionedDatabase, bool)

	// GetDatabases returns all the managed databases in order from current to
	// the oldest version.
	GetDatabases() []*VersionedDatabase

	// Close all of the databases controlled by the manager.
	Close() error

	// NewPrefixDBManager returns a new database manager with each of its
	// databases prefixed with [prefix].
	NewPrefixDBManager(prefix []byte) Manager

	// NewNestedPrefixDBManager returns a new database manager where each of its
	// databases has the nested prefix [prefix] applied to it.
	NewNestedPrefixDBManager(prefix []byte) Manager

	// NewMeterDBManager returns a new database manager with each of its
	// databases wrapped with a meterdb instance to support metrics on database
	// performance.
	NewMeterDBManager(namespace string, registerer prometheus.Registerer) (Manager, error)

	// NewCompleteMeterDBManager wraps each database instance with a meterdb
	// instance. The namespace is concatenated with the version of the database.
	// Note: calling this more than once with the same [namespace] will cause a
	// conflict error for the [registerer].
	NewCompleteMeterDBManager(namespace string, registerer prometheus.Registerer) (Manager, error)
}

func New

func New(
	dbDirPath string,
	log logging.Logger,
	currentVersion version.Version,
	includePreviousVersions bool,
) (Manager, error)

New creates a database manager at [filePath] by creating a database instance from each directory with a version <= [currentVersion]. If [includePreviousVersions], opens previous database versions and includes them in the returned Manager.

func NewDefaultMemDBManager

func NewDefaultMemDBManager() Manager

NewDefaultMemDBManager returns a database manager with a single memdb instance with the current database version

func NewManagerFromDBs

func NewManagerFromDBs(dbs []*VersionedDatabase) (Manager, error)

NewManagerFromDBs

type VersionedDatabase

type VersionedDatabase struct {
	Database database.Database
	Version  version.Version
}

func (*VersionedDatabase) Close

func (db *VersionedDatabase) Close() error

Close the underlying database