database

package

v0.0.0-...-64c530f Latest Latest Go to latest Published: Jun 29, 2023 License: Apache-2.0, BSD-2-Clause Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/iotaledger/hive.go

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

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

Functions ¶

This section is 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".

Source Files ¶

View all Source files

engine.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL