database

Documentation

Overview

Package database provides support for accessing the database.

Index

• Variables
• func NamedExec(log *zerolog.Logger, db sqlx.Ext, query string, data any) (err error)
• func NamedQuerySlice[T any](log *zerolog.Logger, db sqlx.Ext, query string, data any, dest *[]T) (err error)
• func NamedQueryStruct(log *zerolog.Logger, db sqlx.Ext, query string, data any, dest any) (err error)
• func Open(cfg Config) (*sqlx.DB, error)
• func Ping(ctx context.Context, db *sqlx.DB) error
• func WithinTran(log *zerolog.Logger, db *sqlx.DB, fn func(*sqlx.Tx) error) error
• type Config

Variables

var (
	ErrNotFound        = sql.ErrNoRows
	ErrUniqueViolation = errors.New("duplicated entry")
	ErrUndefinedTable  = errors.New("undefined table")
)

Set of error variables for CRUD operations.

Functions

func NamedExec

func NamedExec(log *zerolog.Logger, db sqlx.Ext, query string, data any) (err error)

func NamedQuerySlice

func NamedQuerySlice[T any](log *zerolog.Logger, db sqlx.Ext, query string, data any, dest *[]T) (err error)

func NamedQueryStruct

func NamedQueryStruct(log *zerolog.Logger, db sqlx.Ext, query string, data any, dest any) (err error)

func Open

func Open(cfg Config) (*sqlx.DB, error)

Open knows how to open a database connection based on the configuration.

func Ping

func Ping(ctx context.Context, db *sqlx.DB) error

Ping returns nil if it can successfully talk to the database. It returns a non-nil error otherwise.

func WithinTran

func WithinTran(log *zerolog.Logger, db *sqlx.DB, fn func(*sqlx.Tx) error) error

WithinTran runs passed function and do commit/rollback at the end.

Types

type Config

type Config struct {
	User         string
	Password     string
	Host         string
	Name         string
	MaxIdleConns int
	MaxOpenConns int
	DisableTLS   bool
}