dbwrapper

README

A simple, mockable wrapper for working with postgresql database in golang.

Documentation

Index

• Variables
• type ConnectionPool
  • func Connect(ctx context.Context, url string) (ConnectionPool, error)
• type Querier
• type Sqlizer
• type Tx

Variables

var ErrNotSlice = errors.New("GetList dest must be a slice")

ErrNotSlice is returned when dest passed to Query.GetList is not a slice.

var ErrToSQLFail = errors.New("can't convert to raw sql query")

ErrToSQLFail is returned when query builder fails to convert query to raw sql

Types

type ConnectionPool

type ConnectionPool interface {
	Querier
	// Close closes all DB connections in the connection pool.
	Close()
}

func Connect

func Connect(ctx context.Context, url string) (ConnectionPool, error)

Connect establishes a connection to the database and initializes a connection pool.

type Querier

type Querier interface {
	// Get retrieves a single row.
	Get(ctx context.Context, qb Sqlizer, dest any) error
	// GetList retrieves multiple rows.
	GetList(ctx context.Context, qb Sqlizer, dest any) error
	// Exec executes a query.
	Exec(ctx context.Context, qb Sqlizer) error
	// BeginTx begins a transaction.
	BeginTx(ctx context.Context) (Tx, error)
}

Querier runs db queries.

type Sqlizer

type Sqlizer interface {
	ToSql() (sqlQuery string, args []any, err error)
}

Sqlizer defines interface for converter from a query builder to sql query with args.

type Tx

type Tx interface {
	Querier
	// Rollback rolls back the transaction.
	Rollback(ctx context.Context) error
	// Commit commits the transaction.
	Commit(ctx context.Context) error
}

Tx runs queries in transaction.