database

Documentation

Index

• Variables
• func Exists(dbPath string) (bool, error)
• type Engine
  • func CheckEngine(dbPath string, createDatabaseIfNotExists bool, dbEngine Engine, ...) (Engine, error)
  • func EngineAllowed(dbEngine Engine, allowedEngines []Engine) (Engine, error)
  • func EngineFromStringAllowed(dbEngineStr string, allowedEngines []Engine) (Engine, error)
  • func LoadEngineFromFile(path string, allowedEngines []Engine) (Engine, error)

Variables

var (
	ErrEngineMismatch = errors.New("database engine mismatch")
)

Functions

func Exists

func Exists(dbPath string) (bool, error)

Exists checks if the database folder exists and is not empty.

Types

type Engine

type Engine string

const (
	EngineUnknown Engine = "unknown"
	EngineAuto    Engine = "auto"
	EngineBadger  Engine = "badger"
	EngineDebug   Engine = "debug"
	EngineMapDB   Engine = "mapdb"
	EnginePebble  Engine = "pebble"
	EngineRocksDB Engine = "rocksdb"
)

func CheckEngine

func CheckEngine(dbPath string, createDatabaseIfNotExists bool, dbEngine Engine, allowedEngines []Engine) (Engine, error)

CheckEngine checks if the correct database engine is used. This function stores a so called "database info file" in the database folder or checks if an existing "database info file" contains the correct engine. Otherwise the files in the database folder are not compatible.

func EngineAllowed

func EngineAllowed(dbEngine Engine, allowedEngines []Engine) (Engine, error)

EngineAllowed checks if the database engine is allowed.

func EngineFromStringAllowed

func EngineFromStringAllowed(dbEngineStr string, allowedEngines []Engine) (Engine, error)

EngineFromStringAllowed parses an engine from a string and checks if the database engine is allowed.

func LoadEngineFromFile

func LoadEngineFromFile(path string, allowedEngines []Engine) (Engine, error)

LoadEngineFromFile returns the engine from the "database info file".