database

Documentation

Index

• Constants
• Variables
• func CleanupBadgerInstance(log *logger.Logger)
• func GetBadgerInstance() *badger.DB
• type Database
  • func Get(dbPrefix byte, optionalBadger ...*badger.DB) (Database, error)
• type Entry
• type Key
• type KeyOnlyEntry
• type KeyPrefix
• type Value

Constants

const (
	DBPrefixApprovers byte = iota
	DBPrefixTransaction
	DBPrefixBundle
	DBPrefixTransactionMetadata
	DBPrefixAddressTransactions
	DBPrefixAutoPeering
	DBPrefixDatabaseVersion
)

const (
	CFG_DIRECTORY = "database.directory"
)

const (
	// DBVersion defines the version of the database schema this version of GoShimmer supports.
	// everytime there's a breaking change regarding the stored data, this version flag should be adjusted.
	DBVersion = 1
)

Variables

var (
	ErrDBVersionIncompatible = errors.New("database version is not compatible. please delete your database folder and restart")
)

var (
	ErrKeyNotFound = database.ErrKeyNotFound
)

Functions

func CleanupBadgerInstance

func CleanupBadgerInstance(log *logger.Logger)

func GetBadgerInstance

func GetBadgerInstance() *badger.DB

Types

type Database

type Database = database.Database

func Get

func Get(dbPrefix byte, optionalBadger ...*badger.DB) (Database, error)

type Entry

type Entry = database.Entry

type Key

type Key = database.Key

type KeyOnlyEntry

type KeyOnlyEntry = database.KeyOnlyEntry

type KeyPrefix

type KeyPrefix = database.KeyPrefix

type Value

type Value = database.Value