db

Documentation

Overview

Package db implements several CometBFT DB backends.

Index

• func GetBackendName() string
• func GetProvider() (node.DBProvider, error)
• func New(fn string, noSuffix bool) (dbm.DB, error)
• func WithCloser(db dbm.DB, closer *Closer) dbm.DB
• type Closer
  • func NewCloser() *Closer
  • func (c *Closer) Close()

Functions

func GetBackendName

func GetBackendName() string

GetBackendName returns the currently configured CometBFT database backend.

func GetProvider

func GetProvider() (node.DBProvider, error)

GetProvider returns the currently configured CometBFT DBProvider.

func New

func New(fn string, noSuffix bool) (dbm.DB, error)

New constructs a new CometBFT DB with the configured backend.

func WithCloser

func WithCloser(db dbm.DB, closer *Closer) dbm.DB

WithCloser wraps a CometBFT Core database instance so that it can only be closed by the given closer instance. Direct attempts to close the returned database instance will be ignored.

Types

type Closer

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

Closer manages closing of multiple CometBFT Core databases.

func NewCloser

func NewCloser() *Closer

NewCloser creates a new empty database closer.

func (*Closer) Close

func (c *Closer) Close()

Close closes all the managed databases.