pgxatomic

README

pgxatomic

pgxatomic is a library of tools that allow you to implement transfer of clean control to transactions to a higher level by adding transaction in a context.Context using pgx driver.

Example Usage

1. You can use pgxatomic.Pool within repository implementation. It's simple wrapper around pgxpool.Pool which is wrapping Query, QueryRow and Exec methods with pgxatomic query functions.

type orderRepo struct {
    pool *pgxatomic.Pool // pgxpool.Pool wrapper
}

type order struct {
    ID uuid.UUID
    Cost int
}

func (r *orderRepo) Insert(ctx context.Context, cost int) order {
    rows, _ := r.pool.Query(ctx, "insert into order(cost) values ($1) RETURNING id, cost", cost)
    o, _ := pgx.CollectOneRow(rows, pgx.RowToStructByPos[order])
    return o
}

Or you can use Query, QueryRow, Exec functions directly from the library.

1. Run wrapped usecase method calls within txFunc using pgxatomic.runner.Run function

conf, _ := pgxpool.ParseConfig("postgres://user:pass@localhost:5432/postgres")
pool, _ := pgxpool.NewWithConfig(context.Background(), conf)

r, _ := pgxatomic.NewRunner(pool, pgx.TxOptions{})

_ = r.Run(context.Background(), func(txCtx context.Context) error {
    _ = orderService.Create(txCtx)
    _ = balanceService.Withdraw(txCtx)
    return nil
})

Error handling is omitted on purpose, handle all errors!

Credits

• Clean transactions in Golang hexagon

Documentation

Index

• func Exec(ctx context.Context, db executor, sql string, args ...any) (pgconn.CommandTag, error)
• func Query(ctx context.Context, db querier, sql string, args ...any) (pgx.Rows, error)
• func QueryRow(ctx context.Context, db queryRower, sql string, args ...any) pgx.Row
• func TxFromContext(ctx context.Context) pgx.Tx
• func WithTx(ctx context.Context, tx pgx.Tx) context.Context
• type Pool
  • func NewPool(p *pgxpool.Pool) (Pool, error)
  • func (p Pool) Exec(ctx context.Context, sql string, args ...any) (pgconn.CommandTag, error)
  • func (p Pool) Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
  • func (p Pool) QueryRow(ctx context.Context, sql string, args ...any) pgx.Row
• type Runner
  • func NewRunner(db txStarter, opts pgx.TxOptions) (Runner, error)
  • func (r Runner) Run(ctx context.Context, txFunc func(ctx context.Context) error) error

Functions

func Exec

func Exec(ctx context.Context, db executor, sql string, args ...any) (pgconn.CommandTag, error)

Exec is a wrapper around pgx Exec method.

func Query

func Query(ctx context.Context, db querier, sql string, args ...any) (pgx.Rows, error)

Query is a wrapper around pgx Query method.

func QueryRow

func QueryRow(ctx context.Context, db queryRower, sql string, args ...any) pgx.Row

QueryRow is a wrapper around pgx QueryRow method.

func TxFromContext

func TxFromContext(ctx context.Context) pgx.Tx

TxFromContext return pgx.Tx from context or nil if not found.

func WithTx

func WithTx(ctx context.Context, tx pgx.Tx) context.Context

WithTx sets pgx.Tx into context.

Types

type Pool

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

Pool wraps pgxpool.Pool query methods with pgxatomic corresponding functions which injects pgx.Tx into context.

func NewPool

func NewPool(p *pgxpool.Pool) (Pool, error)

func (Pool) Exec

func (p Pool) Exec(ctx context.Context, sql string, args ...any) (pgconn.CommandTag, error)

func (Pool) Query

func (p Pool) Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)

func (Pool) QueryRow

func (p Pool) QueryRow(ctx context.Context, sql string, args ...any) pgx.Row

type Runner

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

Runner starts transaction in Run method by wrapping txFunc using db, pgx.Conn and pgxpool.Pool implements db.

func NewRunner

func NewRunner(db txStarter, opts pgx.TxOptions) (Runner, error)

func (Runner) Run

func (r Runner) Run(ctx context.Context, txFunc func(ctx context.Context) error) error

Run wraps txFunc in pgx.BeginTxFunc with injected pgx.Tx into context and runs it.