kv

Documentation

Index

• Constants
• type Config
• type Store
  • func NewKVStore(ctx context.Context, dirPath string, config *Config) (*Store, error)
  • func (s *Store) ClearDB() error
  • func (s *Store) Close() error
  • func (s *Store) ConsensusInfo(ctx context.Context, epoch uint64) (*eventTypes.MinimalEpochConsensusInfo, error)
  • func (s *Store) ConsensusInfos(fromEpoch uint64) ([]*eventTypes.MinimalEpochConsensusInfo, error)
  • func (s *Store) DatabasePath() string
  • func (s *Store) LatestSavedEpoch() (uint64, error)
  • func (s *Store) SaveConsensusInfo(ctx context.Context, consensusInfo *eventTypes.MinimalEpochConsensusInfo) error
  • func (s *Store) SaveLatestEpoch(ctx context.Context) error

Constants

const (
	// ConsensusInfosCacheSize with 1024 consensus infos will be 1.5MB.
	ConsensusInfosCacheSize = 1 << 10
	// OrchestratorNodeDbDirName is the name of the directory containing the orchestrator node database.
	OrchestratorNodeDbDirName = "orchestrator"
	// DatabaseFileName is the name of the orchestrator node database.
	DatabaseFileName = "orchestrator.db"
)

Types

type Config

type Config struct {
	InitialMMapSize int
}

Config for the bolt db kv store.

type Store

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

func NewKVStore

func NewKVStore(ctx context.Context, dirPath string, config *Config) (*Store, error)

NewKVStore initializes a new boltDB key-value store at the directory path specified, creates the kv-buckets based on the schema, and stores an open connection db object as a property of the Store struct.

func (*Store) ClearDB

func (s *Store) ClearDB() error

ClearDB removes the previously stored database in the data directory.

func (*Store) Close

func (s *Store) Close() error

Close closes the underlying BoltDB database.

func (*Store) ConsensusInfo

func (s *Store) ConsensusInfo(ctx context.Context, epoch uint64) (*eventTypes.MinimalEpochConsensusInfo, error)

ConsensusInfo

func (*Store) ConsensusInfos

func (s *Store) ConsensusInfos(fromEpoch uint64) (
	[]*eventTypes.MinimalEpochConsensusInfo, error,
)

ConsensusInfos

func (*Store) DatabasePath

func (s *Store) DatabasePath() string

DatabasePath at which this database writes files.

func (*Store) LatestSavedEpoch

func (s *Store) LatestSavedEpoch() (uint64, error)

LatestSavedEpoch

func (*Store) SaveConsensusInfo

func (s *Store) SaveConsensusInfo(
	ctx context.Context,
	consensusInfo *eventTypes.MinimalEpochConsensusInfo,
) error

SaveConsensusInfo

func (*Store) SaveLatestEpoch

func (s *Store) SaveLatestEpoch(ctx context.Context) error

SaveLatestEpoch