storage

Documentation

Index

• Variables
• type DB
  • func NewDB(cfg configloader.ConnectionConfig) (DB, error)
• type DBAdapter
• type MSSQLAdapter
  • func (m MSSQLAdapter) ConvertGenericPlaceholders(query string, argsCount int) string
  • func (m MSSQLAdapter) CreateDSN(cfg configloader.ConnectionConfig) string
  • func (m MSSQLAdapter) DatabaseName(executor sqlExecutor) (string, error)
  • func (m MSSQLAdapter) TableExists(executor sqlExecutor, tableName string) (bool, error)
• type MySQLAdapter
  • func (m MySQLAdapter) ConvertGenericPlaceholders(query string, argsCount int) string
  • func (m MySQLAdapter) CreateDSN(cfg configloader.ConnectionConfig) string
  • func (m MySQLAdapter) DatabaseName(executor sqlExecutor) (string, error)
  • func (m MySQLAdapter) TableExists(executor sqlExecutor, tableName string) (bool, error)
• type PostgresqlAdapter
  • func (p PostgresqlAdapter) ConvertGenericPlaceholders(query string, argsCount int) string
  • func (p PostgresqlAdapter) CreateDSN(cfg configloader.ConnectionConfig) string
  • func (p PostgresqlAdapter) DatabaseName(executor sqlExecutor) (string, error)
  • func (p PostgresqlAdapter) TableExists(executor sqlExecutor, tableName string) (bool, error)
• type SqlDB
  • func (db SqlDB) Close() error
  • func (db SqlDB) Exec(query string, args ...any) (sql.Result, error)
  • func (db SqlDB) Query(query string, args ...any) (*sql.Rows, error)
  • func (db SqlDB) QueryRow(query string, args ...any) *sql.Row
  • func (db SqlDB) TableExists(tableName string) (bool, error)
  • func (db SqlDB) Tx(fn TxFunc) error
• type SqliteAdapter
  • func (s SqliteAdapter) ConvertGenericPlaceholders(query string, argsCount int) string
  • func (s SqliteAdapter) CreateDSN(cfg configloader.ConnectionConfig) string
  • func (s SqliteAdapter) DatabaseName(executor sqlExecutor) (string, error)
  • func (s SqliteAdapter) TableExists(executor sqlExecutor, tableName string) (bool, error)
• type TxFunc

Variables

var (
	ErrMalformedConnectionString = errors.New(
		"malformed database connection parameters provided",
	)
	ErrUnableToConnect   = errors.New("unable to open connection to database")
	ErrUnsupportedDriver = fmt.Errorf(
		"unsupported driver, supported drivers are %s",
		[]string{
			postgresqlDriverName,
			mysqlDriverName,
			mssqlDriverName,
			sqliteDriverName,
		},
	)
)

Types

type DB

type DB interface {
	Exec(query string, args ...interface{}) (sql.Result, error)
	Query(query string, args ...interface{}) (*sql.Rows, error)
	QueryRow(query string, args ...interface{}) *sql.Row
	Tx(fn TxFunc) error
	Close() error
	TableExists(tableName string) (bool, error)
}

func NewDB

func NewDB(cfg configloader.ConnectionConfig) (DB, error)

NewDB establishes a connection to the database using the connection configuration.

The following errors may be returned:

• ErrMalformedConnectionString: The provided connection parameters are not in a valid format.
• ErrUnableToConnect: Unable to make a connection to the database with the provided connection parameters.
• ErrUnsupportedDriver: The provided driver is not supported.

type DBAdapter

type DBAdapter interface {
	// ConvertGenericPlaceholders replaces any generic `?` placeholders
	// in `query` for the database driver specific placeholders and returns
	// the updated query.
	ConvertGenericPlaceholders(query string, argsCount int) string
	// TableExists checks if the tableName exists within the
	// database currently connected to.
	TableExists(executor sqlExecutor, tableName string) (bool, error)
	// DatabaseName retrieves the currently selected database name.
	DatabaseName(executor sqlExecutor) (string, error)
	// CreateDSN creates a DSN to be used with sql.Open in the database
	// driver specific format.
	CreateDSN(cfg configloader.ConnectionConfig) string
}

type MSSQLAdapter

type MSSQLAdapter struct{}

func (MSSQLAdapter) ConvertGenericPlaceholders

func (m MSSQLAdapter) ConvertGenericPlaceholders(
	query string,
	argsCount int,
) string

func (MSSQLAdapter) CreateDSN

func (m MSSQLAdapter) CreateDSN(cfg configloader.ConnectionConfig) string

func (MSSQLAdapter) DatabaseName

func (m MSSQLAdapter) DatabaseName(executor sqlExecutor) (string, error)

func (MSSQLAdapter) TableExists

func (m MSSQLAdapter) TableExists(
	executor sqlExecutor,
	tableName string,
) (bool, error)

type MySQLAdapter

type MySQLAdapter struct{}

func (MySQLAdapter) ConvertGenericPlaceholders

func (m MySQLAdapter) ConvertGenericPlaceholders(query string, argsCount int) string

func (MySQLAdapter) CreateDSN

func (m MySQLAdapter) CreateDSN(cfg configloader.ConnectionConfig) string

func (MySQLAdapter) DatabaseName

func (m MySQLAdapter) DatabaseName(executor sqlExecutor) (string, error)

func (MySQLAdapter) TableExists

func (m MySQLAdapter) TableExists(
	executor sqlExecutor,
	tableName string,
) (bool, error)

type PostgresqlAdapter

type PostgresqlAdapter struct{}

func (PostgresqlAdapter) ConvertGenericPlaceholders

func (p PostgresqlAdapter) ConvertGenericPlaceholders(
	query string,
	argsCount int,
) string

func (PostgresqlAdapter) CreateDSN

func (p PostgresqlAdapter) CreateDSN(cfg configloader.ConnectionConfig) string

func (PostgresqlAdapter) DatabaseName

func (p PostgresqlAdapter) DatabaseName(executor sqlExecutor) (string, error)

func (PostgresqlAdapter) TableExists

func (p PostgresqlAdapter) TableExists(
	executor sqlExecutor,
	tableName string,
) (bool, error)

type SqlDB

type SqlDB struct {
	// contains filtered or unexported fields
}

func (SqlDB) Close

func (db SqlDB) Close() error

Close closes the database connection. Any further queries will result in errors, and you should call NewDB again after if you'd like to run more.

func (SqlDB) Exec

func (db SqlDB) Exec(query string, args ...any) (sql.Result, error)

Exec is a wrapper around the sql.DB Exec.

func (SqlDB) Query

func (db SqlDB) Query(query string, args ...any) (*sql.Rows, error)

Query is a wrapper around the sql.DB Query.

func (SqlDB) QueryRow

func (db SqlDB) QueryRow(query string, args ...any) *sql.Row

QueryRow is a wrapper around the sql.DB QueryRow.

func (SqlDB) TableExists

func (db SqlDB) TableExists(tableName string) (bool, error)

TableExists checks if the tableName exists within the database currently connected to.

func (SqlDB) Tx

func (db SqlDB) Tx(fn TxFunc) error

Tx executes fn within a transaction block. If fn returns an error, the transaction will be rolled back. Otherwise, it will be committed.

type SqliteAdapter

type SqliteAdapter struct{}

func (SqliteAdapter) ConvertGenericPlaceholders

func (s SqliteAdapter) ConvertGenericPlaceholders(
	query string,
	argsCount int,
) string

func (SqliteAdapter) CreateDSN

func (s SqliteAdapter) CreateDSN(cfg configloader.ConnectionConfig) string

func (SqliteAdapter) DatabaseName

func (s SqliteAdapter) DatabaseName(executor sqlExecutor) (string, error)

func (SqliteAdapter) TableExists

func (s SqliteAdapter) TableExists(
	executor sqlExecutor,
	tableName string,
) (bool, error)

type TxFunc

type TxFunc func(db DB) error