dbutil

Documentation

Index

• func BulkQuery[T any](ctx context.Context, tx Queryer, query string, structs []T) error
• func BulkSQL[T any](tx Queryer, sql string, structs []T) (string, []any, error)
• func IsUniqueViolation(err error) bool
• func NewQueryErrorf(cause error, sql string, sqlArgs []any, message string, msgArgs ...any) error
• func ScanAllMap[K comparable, V any](rows *sql.Rows, m map[K]V) error
• func ScanAllSlice[V any](rows *sql.Rows, s []V) ([]V, error)
• func ScanAndValidateJSON(rows *sql.Rows, destination any) error
• func ScanJSON(rows *sql.Rows, destination any) error
• func ToValidUTF8(s string) string
• type QueryError
  • func AsQueryError(err error) *QueryError
  • func (e *QueryError) Error() string
  • func (e *QueryError) Query() (string, []any)
  • func (e *QueryError) Unwrap() error
• type Queryer

Functions

func BulkQuery

func BulkQuery[T any](ctx context.Context, tx Queryer, query string, structs []T) error

BulkQuery runs the query as a bulk operation with the given structs

func BulkSQL

func BulkSQL[T any](tx Queryer, sql string, structs []T) (string, []any, error)

BulkSQL takes a query which uses VALUES with struct bindings and rewrites it as a bulk operation. It returns the new SQL query and the args to pass to it.

func IsUniqueViolation

func IsUniqueViolation(err error) bool

IsUniqueViolation returns true if the given error is a violation of unique constraint

func NewQueryErrorf

func NewQueryErrorf(cause error, sql string, sqlArgs []any, message string, msgArgs ...any) error

func ScanAllMap

func ScanAllMap[K comparable, V any](rows *sql.Rows, m map[K]V) error

ScanAllMap scans a key and value from each two column row into the given map

func ScanAllSlice

func ScanAllSlice[V any](rows *sql.Rows, s []V) ([]V, error)

ScanAllSlice scans a single value from each single column row into the given slice

func ScanAndValidateJSON

func ScanAndValidateJSON(rows *sql.Rows, destination any) error

ScanAndValidateJSON scans a row which is JSON into a destination struct and validates it

func ScanJSON

func ScanJSON(rows *sql.Rows, destination any) error

ScanJSON scans a row which is JSON into a destination struct

func ToValidUTF8

func ToValidUTF8(s string) string

ToValidUTF8 replaces invalid UTF-8 sequences with � characters and also strips NULL characters, which whilst being valid UTF-8, can't be saved to PostgreSQL.

Types

type QueryError

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

QueryError is an error type for failed SQL queries

func AsQueryError

func AsQueryError(err error) *QueryError

func (*QueryError) Error

func (e *QueryError) Error() string

func (*QueryError) Query

func (e *QueryError) Query() (string, []any)

func (*QueryError) Unwrap

func (e *QueryError) Unwrap() error

type Queryer

type Queryer interface {
	Rebind(query string) string
	QueryxContext(ctx context.Context, query string, args ...any) (*sqlx.Rows, error)
}

Queryer is the DB/TX functionality needed for operations in this package