database

Documentation

Index

• 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 EngineFromString(engineStr string) (Engine, error)
  • func EngineFromStringAllowed(dbEngineStr string, allowedEngines ...Engine) (Engine, error)
  • func LoadEngineFromFile(path string) (Engine, error)
  • func NewWithDefaultSettings(dbParams Params, createDatabaseIfNotExists bool, log *logger.Logger) (*gorm.DB, Engine, error)
• type Params

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"
	EngineSQLite     Engine = "sqlite"
	EnginePostgreSQL Engine = "postgresql"
)

func CheckEngine

func CheckEngine(dbPath string, createDatabaseIfNotExists bool, dbEngine ...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 EngineFromString

func EngineFromString(engineStr string) (Engine, error)

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

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) (Engine, error)

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

func NewWithDefaultSettings

func NewWithDefaultSettings(dbParams Params, createDatabaseIfNotExists bool, log *logger.Logger) (*gorm.DB, Engine, error)

type Params

type Params struct {
	Engine   Engine
	Path     string
	Host     string
	Port     uint
	Database string
	Username string
	Password string
}