database

Documentation

Overview

Package database is a plugin that manages the badger database (e.g. garbage collection).

Index

• Constants
• Variables
• func GetKVStore(chainID *isc.ChainID) kvstore.KVStore
• func GetOrCreateKVStore(chainID *isc.ChainID) kvstore.KVStore
• func GetRegistryKVStore() kvstore.KVStore
• type ParametersDatabase

Constants

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

Variables

var (
	CoreComponent *app.CoreComponent
)

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

ErrDBVersionIncompatible is returned when the database has an unexpected version.

var ParamsDatabase = &ParametersDatabase{}

Functions

func GetKVStore

func GetKVStore(chainID *isc.ChainID) kvstore.KVStore

func GetOrCreateKVStore

func GetOrCreateKVStore(chainID *isc.ChainID) kvstore.KVStore

func GetRegistryKVStore

func GetRegistryKVStore() kvstore.KVStore

Types

type ParametersDatabase

type ParametersDatabase struct {
	InMemory  bool   `default:"false" usage:"whether the database is only kept in memory and not persisted"`
	Directory string `default:"waspdb" usage:"path to the database folder"`
}