database

Documentation

Index

• Constants
• Variables
• type ParametersDatabase

Constants

const (
	// CfgTangleDeleteDatabase defines whether to delete the database at startup.
	CfgTangleDeleteDatabase = "deleteDatabase"
	// CfgTangleDeleteAll defines whether to delete the database and snapshots at startup.
	CfgTangleDeleteAll = "deleteAll"

	// TangleDatabaseDirectoryName defines the subfolder for the tangle database.
	TangleDatabaseDirectoryName = "tangle"
	// UTXODatabaseDirectoryName defines the subfolder for the UTXO database.
	UTXODatabaseDirectoryName = "utxo"
)

Variables

var (
	CoreComponent *app.CoreComponent
)

var ParamsDatabase = &ParametersDatabase{}

Types

type ParametersDatabase

type ParametersDatabase struct {
	// Engine defines the used database engine (pebble/rocksdb/mapdb).
	Engine string `default:"rocksdb" usage:"the used database engine (pebble/rocksdb/mapdb)"`
	// Path defines the path to the database folder.
	Path string `default:"shimmer/database" usage:"the path to the database folder"`
	// AutoRevalidation defines whether to automatically start revalidation on startup if the database is corrupted.
	AutoRevalidation bool `default:"false" usage:"whether to automatically start revalidation on startup if the database is corrupted"`
	// Debug defines whether to ignore the check for corrupted databases (should only be used for debug reasons).
	Debug bool `default:"false" usage:"ignore the check for corrupted databases (should only be used for debug reasons)"`
	// CheckLedgerStateOnStartup defines whether to check if the ledger state matches the total supply on startup
	CheckLedgerStateOnStartup bool `default:"false" usage:"whether to check if the ledger state matches the total supply on startup"`
}

ParametersDatabase contains the definition of the parameters used by the ParametersDatabase.