dbal

Documentation

Index

• Constants
• Variables
• func Canonicalize(database string) string
• func IsMemorySQLite(dsn string) bool
• func IsSQLite(dsn string) bool
• func MustCanonicalize(database string) string
• func RegisterDriver(d func() Driver)
• type Driver
  • func GetDriverFor(dsn string) (Driver, error)

Constants

const (
	// DriverMySQL is the mysql driver name.
	DriverMySQL = "mysql"

	// DriverPostgreSQL is the postgres driver name.
	DriverPostgreSQL = "postgres"

	// DriverCockroachDB is the cockroach driver name.
	DriverCockroachDB = "cockroach"

	// UnknownDriver is the driver name if the driver is unknown.
	UnknownDriver = "unknown"
)

const (
	SQLiteInMemory       = "sqlite://file::memory:?_fk=true"
	SQLiteSharedInMemory = "sqlite://file::memory:?_fk=true&cache=shared"
)

Variables

var (

	// ErrNoResponsibleDriverFound is returned when no driver was found for the provided DSN.
	ErrNoResponsibleDriverFound = errors.New("dsn value requested an unknown driver")
	ErrSQLiteSupportMissing     = errors.New(`the DSN connection string looks like a SQLite connection, but SQLite support was not built into the binary. Please check if you have downloaded the correct binary or are using the correct Docker Image. Binary archives and Docker Images indicate SQLite support by appending the -sqlite suffix`)
)

Functions

func Canonicalize

func Canonicalize(database string) string

Canonicalize returns constants DriverMySQL, DriverPostgreSQL, DriverCockroachDB, UnknownDriver, depending on `database`.

func IsMemorySQLite

func IsMemorySQLite(dsn string) bool

SQLite can be written in different styles depending on the use case - just in memory - shared connection - shared but unique in the same process see: https://sqlite.org/inmemorydb.html

func IsSQLite

func IsSQLite(dsn string) bool

IsSQLite returns true if the connection is a SQLite string.

func MustCanonicalize

func MustCanonicalize(database string) string

MustCanonicalize returns constants DriverMySQL, DriverPostgreSQL, DriverCockroachDB or fatals.

func RegisterDriver

func RegisterDriver(d func() Driver)

RegisterDriver registers a driver

Types

type Driver

type Driver interface {
	// CanHandle returns true if the driver is capable of handling the given DSN or false otherwise.
	CanHandle(dsn string) bool

	// Ping returns nil if the driver has connectivity and is healthy or an error otherwise.
	Ping() error
}

Driver represents a driver

func GetDriverFor

func GetDriverFor(dsn string) (Driver, error)

GetDriverFor returns a driver for the given DSN or ErrNoResponsibleDriverFound if no driver was found.