kvledger

Documentation

Index

• Variables
• func BlockStorePath(rootFSPath string) string
• func BookkeeperDBPath(rootFSPath string) string
• func ClearPreResetHeight(rootFSPath string, ledgerIDs []string) error
• func CompletedSnapshotsPath(snapshotRootDir string) string
• func ConfigHistoryDBPath(rootFSPath string) string
• func HistoryDBPath(rootFSPath string) string
• func InProgressSnapshotsPath(snapshotRootDir string) string
• func LedgerProviderPath(rootFSPath string) string
• func LoadPreResetHeight(rootFSPath string, ledgerIDs []string) (map[string]uint64, error)
• func PauseChannel(rootFSPath, ledgerID string) error
• func PvtDataStorePath(rootFSPath string) string
• func RebuildDBs(config *ledger.Config) error
• func ResetAllKVLedgers(rootFSPath string) error
• func ResumeChannel(rootFSPath, ledgerID string) error
• func RollbackKVLedger(rootFSPath, ledgerID string, blockNum uint64) error
• func SnapshotDirForLedgerHeight(snapshotRootDir, ledgerID string, snapshotHeight uint64) string
• func SnapshotsDirForLedger(snapshotRootDir, ledgerID string) string
• func StateDBPath(rootFSPath string) string
• func UpgradeDBs(config *ledger.Config) error
• func UpgradeIDStoreFormat(t *testing.T, rootFSPath string)
• type Provider
  • func NewProvider(initializer *ledger.Initializer) (pr *Provider, e error)
  • func (p *Provider) Close()
  • func (p *Provider) Create(genesisBlock *common.Block) (ledger.PeerLedger, error)
  • func (p *Provider) Exists(ledgerID string) (bool, error)
  • func (p *Provider) List() ([]string, error)
  • func (p *Provider) Open(ledgerID string) (ledger.PeerLedger, error)

Variables

var (
	// ErrLedgerIDExists is thrown by a CreateLedger call if a ledger with the given id already exists
	ErrLedgerIDExists = errors.New("LedgerID already exists")
	// ErrNonExistingLedgerID is thrown by an OpenLedger call if a ledger with the given id does not exist
	ErrNonExistingLedgerID = errors.New("LedgerID does not exist")
	// ErrLedgerNotOpened is thrown by a CloseLedger call if a ledger with the given id has not been opened
	ErrLedgerNotOpened = errors.New("ledger is not opened yet")
	// ErrInactiveLedger is thrown by an OpenLedger call if a ledger with the given id is not active
	ErrInactiveLedger = errors.New("Ledger is not active")
)

Functions

func BlockStorePath

func BlockStorePath(rootFSPath string) string

BlockStorePath returns the absolute path of block storage

func BookkeeperDBPath

func BookkeeperDBPath(rootFSPath string) string

BookkeeperDBPath return the absolute path of bookkeeper DB

func ClearPreResetHeight

func ClearPreResetHeight(rootFSPath string, ledgerIDs []string) error

ClearPreResetHeight removes the prereset height recorded in the file system for the specified ledgers.

func CompletedSnapshotsPath

func CompletedSnapshotsPath(snapshotRootDir string) string

CompletedSnapshotsPath returns the absolute path that is used for persisting the snapshots

func ConfigHistoryDBPath

func ConfigHistoryDBPath(rootFSPath string) string

ConfigHistoryDBPath returns the absolute path of configHistory DB

func HistoryDBPath

func HistoryDBPath(rootFSPath string) string

HistoryDBPath returns the absolute path of history DB

func InProgressSnapshotsPath

func InProgressSnapshotsPath(snapshotRootDir string) string

InProgressSnapshotsPath returns the dir path that is used temporarily during the genration of the snapshots for a ledger

func LedgerProviderPath

func LedgerProviderPath(rootFSPath string) string

LedgerProviderPath returns the absolute path of ledgerprovider

func LoadPreResetHeight

func LoadPreResetHeight(rootFSPath string, ledgerIDs []string) (map[string]uint64, error)

LoadPreResetHeight returns the prereset height for the specified ledgers.

func PauseChannel

func PauseChannel(rootFSPath, ledgerID string) error

PauseChannel updates the channel status to inactive in ledgerProviders.

func PvtDataStorePath

func PvtDataStorePath(rootFSPath string) string

PvtDataStorePath returns the absolute path of pvtdata storage

func RebuildDBs

func RebuildDBs(config *ledger.Config) error

RebuildDBs drops existing ledger databases. Dropped database will be rebuilt upon server restart

func ResetAllKVLedgers

func ResetAllKVLedgers(rootFSPath string) error

ResetAllKVLedgers resets all ledger to the genesis block.

func ResumeChannel

func ResumeChannel(rootFSPath, ledgerID string) error

ResumeChannel updates the channel status to active in ledgerProviders

func RollbackKVLedger

func RollbackKVLedger(rootFSPath, ledgerID string, blockNum uint64) error

RollbackKVLedger rollbacks a ledger to a specified block number

func SnapshotDirForLedgerHeight

func SnapshotDirForLedgerHeight(snapshotRootDir, ledgerID string, snapshotHeight uint64) string

SnapshotDirForLedgerHeight returns the absolute path for a particular snapshot for a ledger

func SnapshotsDirForLedger

func SnapshotsDirForLedger(snapshotRootDir, ledgerID string) string

SnapshotsDirForLedger returns the absolute path of the dir for the snapshots for a specified ledger

func StateDBPath

func StateDBPath(rootFSPath string) string

StateDBPath returns the absolute path of state level DB

func UpgradeDBs

func UpgradeDBs(config *ledger.Config) error

UpgradeDBs upgrades existing ledger databases to the latest formats. It checks the format of idStore and does not drop any databases if the format is already the latest version. Otherwise, it drops ledger databases and upgrades the idStore format.

func UpgradeIDStoreFormat

func UpgradeIDStoreFormat(t *testing.T, rootFSPath string)

UpgradeIDStoreFormat updates ledger idStore to current format

Types

type Provider

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

Provider implements interface ledger.PeerLedgerProvider

func NewProvider

func NewProvider(initializer *ledger.Initializer) (pr *Provider, e error)

NewProvider instantiates a new Provider. This is not thread-safe and assumed to be synchronized by the caller

func (*Provider) Close

func (p *Provider) Close()

Close implements the corresponding method from interface ledger.PeerLedgerProvider

func (*Provider) Create

func (p *Provider) Create(genesisBlock *common.Block) (ledger.PeerLedger, error)

Create implements the corresponding method from interface ledger.PeerLedgerProvider This functions sets a under construction flag before doing any thing related to ledger creation and upon a successful ledger creation with the committed genesis block, removes the flag and add entry into created ledgers list (atomically). If a crash happens in between, the 'recoverUnderConstructionLedger' function is invoked before declaring the provider to be usable

func (*Provider) Exists

func (p *Provider) Exists(ledgerID string) (bool, error)

Exists implements the corresponding method from interface ledger.PeerLedgerProvider

func (*Provider) List

func (p *Provider) List() ([]string, error)

List implements the corresponding method from interface ledger.PeerLedgerProvider

func (*Provider) Open

func (p *Provider) Open(ledgerID string) (ledger.PeerLedger, error)

Open implements the corresponding method from interface ledger.PeerLedgerProvider