pgxutil

README

pgxutil

Go jackc/pgx helper to write proper transactions.

Features

• Simple API.

Install

Go version 1.17+

go get github.com/cristalhq/pgxutil

Example

// create jackc/pgx pool
var pool *pgxpool.Pool

db, err := pgxutil.New(pool)
if err != nil {
	panic(err)
}

ctx := context.Background()

// to make transaction with a given isolation level
level := pgx.Serializable
errTx := db.InWriteTx(ctx, level, func(tx pgx.Tx) error {
	// TODO: good query with tx
	return nil
})
if errTx != nil {
	panic(errTx)
}

// to make read-only transaction with a read committed isolation level
errRead := db.InReadTx(ctx, func(tx pgx.Tx) error {
	// TODO: good read-only query with tx
	return nil
})
if errRead != nil {
	panic(errRead)
}	

Also see examples: examples_test.go.

Documentation

See these docs.

License

MIT License.

Documentation

Overview

Example

var pool *pgxpool.Pool

db, err := pgxutil.New(pool)
if err != nil {
	panic(err)
}

ctx := context.Background()

// to make transaction with a given isolation level
level := pgx.Serializable
errTx := db.InWriteTx(ctx, level, func(tx pgx.Tx) error {
	// TODO: good query with tx
	return nil
})
if errTx != nil {
	panic(errTx)
}

// to make read-only transaction with a read committed isolation level
errRead := db.InReadTx(ctx, func(tx pgx.Tx) error {
	// TODO: good read-only query with tx
	return nil
})
if errRead != nil {
	panic(errRead)
}

Index

• func Exec(ctx context.Context, db *DB, b builq.Builder) error
• func ExecRead[T Scannable](ctx context.Context, db *DB, b builq.Builder, dst T) error
• func Read[T Scannable](ctx context.Context, db *DB, b builq.Builder, dst T) error
• func ReadMany[T Scannable](ctx context.Context, db *DB, b builq.Builder, dst *[]T) error
• type DB
  • func New(pool *pgxpool.Pool) (*DB, error)
  • func (db *DB) InReadTx(ctx context.Context, fn func(tx pgx.Tx) error) error
  • func (db *DB) InWriteTx(ctx context.Context, level pgx.TxIsoLevel, fn func(tx pgx.Tx) error) error
• type Int64
  • func (s *Int64) Scan(row pgx.Row) error
• type Scannable
• type String
  • func (s *String) Scan(row pgx.Row) error

Examples

• Package

Functions

func Exec

func Exec(ctx context.Context, db *DB, b builq.Builder) error

func ExecRead

func ExecRead[T Scannable](ctx context.Context, db *DB, b builq.Builder, dst T) error

func Read

func Read[T Scannable](ctx context.Context, db *DB, b builq.Builder, dst T) error

func ReadMany

func ReadMany[T Scannable](ctx context.Context, db *DB, b builq.Builder, dst *[]T) error

Types

type DB

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

func New

func New(pool *pgxpool.Pool) (*DB, error)

New creates a new wrapper for pgx.

func (*DB) InReadTx

func (db *DB) InReadTx(ctx context.Context, fn func(tx pgx.Tx) error) error

InReadTx runs the given function within a read-only transaction with read commited isolation level.

func (*DB) InWriteTx

func (db *DB) InWriteTx(ctx context.Context, level pgx.TxIsoLevel, fn func(tx pgx.Tx) error) error

InWriteTx runs the given function within a transaction with a given isolation level.

type Int64

type Int64 int64

func (*Int64) Scan

func (s *Int64) Scan(row pgx.Row) error

type Scannable

type Scannable interface {
	Scan(pgx.Row) error
}

type String

type String string

func (*String) Scan

func (s *String) Scan(row pgx.Row) error