db

Documentation

Index

• func Connect(ctx context.Context, dsn string, attempts int32) (*pgxpool.Pool, error)
• func CreateDsn(dsn *cfg.DBConfig) string
• func DBTearDown(conf *cfg.Config) error
• func InitDB(conf *cfg.DBConfig, log *zerolog.Logger) error
• func IsNotNull(value interface{}) bool
• func Migrate(ctx context.Context, log *zerolog.Logger, conf *cfg.Config, paths ...string) error
• func Sanitize(s []string) []string
• func SerialParametrizedUnaryTx(ctx context.Context, conn *pgxpool.Pool, qName, sql string, errorInput any, ...) error
• func SerializableParametrizedTx[T any](ctx context.Context, conn *pgxpool.Pool, qName, sql string, ...) (dest []T, err error)
• func TxErr(action string, input interface{}, err error) error
• type Connection
• type Connector
• type MaybeSeq

Functions

func Connect

func Connect(ctx context.Context, dsn string, attempts int32) (*pgxpool.Pool, error)

Currently only postgres is supported, as we try to stick to YAGNI and convetion over configuration.

func CreateDsn

func CreateDsn(dsn *cfg.DBConfig) string

func DBTearDown

func DBTearDown(conf *cfg.Config) error

DBTearDown is a helper function to clean up the test database

func InitDB

func InitDB(conf *cfg.DBConfig, log *zerolog.Logger) error

func IsNotNull

func IsNotNull(value interface{}) bool

IsNotNull returns true if a value is not "nullish" falsity is not considered nullish

func Migrate

func Migrate(ctx context.Context, log *zerolog.Logger, conf *cfg.Config, paths ...string) error

Migrate runs the migrations located in the migrations folder paths is a variadic argument, meaning that if no specific path(s) are provided, the program will try to run all of them Otherwise the arguments to path should only include the containing directory name for each migration, e.g. "000001-fix-missing-timestamps"

func Sanitize

func Sanitize(s []string) []string

func SerialParametrizedUnaryTx

func SerialParametrizedUnaryTx(
	ctx context.Context,
	conn *pgxpool.Pool,
	qName, sql string,
	errorInput any,
	params ...any,
) error

like SerializableParametrizedTx, but doesn't scan into anything, instead simply returning an error

func SerializableParametrizedTx

func SerializableParametrizedTx[T any](
	ctx context.Context,
	conn *pgxpool.Pool,
	qName, sql string,
	errorHandlerInput any,
	params ...any) (dest []T, err error)

func TxErr

func TxErr(action string, input interface{}, err error) error

Types

type Connection

type Connection struct {
	Conn *pgxpool.Pool
}

type Connector

type Connector interface {
	Get(ctx context.Context, into any, query string, args ...any) error
}

type MaybeSeq

type MaybeSeq interface {
	any | []any
}