database

package

v1.0.0-beta.5 Latest Latest Go to latest Published: Aug 9, 2022 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/iotaledger/inx-indexer

Links

Open Source Insights

Documentation ¶

Index ¶

func DatabaseExists(dbPath string) (bool, error)
func DatabaseWithDefaultSettings(path string, createDatabaseIfNotExists bool, log *logger.Logger) (*gorm.DB, error)
type Engine

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DatabaseExists ¶

func DatabaseExists(dbPath string) (bool, error)

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

func DatabaseWithDefaultSettings ¶

func DatabaseWithDefaultSettings(path string, createDatabaseIfNotExists bool, log *logger.Logger) (*gorm.DB, error)

Types ¶

type Engine ¶

type Engine string

const (
	EngineUnknown Engine = "unknown"
	EngineAuto    Engine = "auto"
	EngineSQLite  Engine = "sqlite"
)

func CheckDatabaseEngine ¶

func CheckDatabaseEngine(dbPath string, createDatabaseIfNotExists bool, dbEngine ...Engine) (Engine, error)

CheckDatabaseEngine 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 DatabaseEngineAllowed ¶

func DatabaseEngineAllowed(dbEngine Engine, allowedEngines ...Engine) (Engine, error)

DatabaseEngineAllowed checks if the database engine is allowed.

func DatabaseEngineFromString ¶

func DatabaseEngineFromString(engineStr string) (Engine, error)

DatabaseEngineFromString parses an engine from a string. Returns an error if the engine is unknown.

func DatabaseEngineFromStringAllowed ¶

func DatabaseEngineFromStringAllowed(dbEngineStr string, allowedEngines ...Engine) (Engine, error)

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

func LoadDatabaseEngineFromFile ¶

func LoadDatabaseEngineFromFile(path string) (Engine, error)

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

Source Files ¶

View all Source files

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