crdbpgx

README

crdbpgx is a wrapper around the logic for issuing SQL transactions which performs retries (as required by CockroachDB) when using github.com/jackc/pgx in standalone-library mode. pgx versions below v4 are not supported.

Note: use crdbpgxv5 for pgx/v5 support

If you're using pgx just as a driver for the standard database/sql package, use the parent crdb package instead.

Documentation

Index

• func ExecuteTx(ctx context.Context, conn Conn, txOptions pgx.TxOptions, fn func(pgx.Tx) error) error
• type Conn

Functions

func ExecuteTx

func ExecuteTx(
	ctx context.Context, conn Conn, txOptions pgx.TxOptions, fn func(pgx.Tx) error,
) error

ExecuteTx runs fn inside a transaction and retries it as needed. On non-retryable failures, the transaction is aborted and rolled back; on success, the transaction is committed.

See crdb.ExecuteTx() for more information.

conn can be a pgx.Conn or a pgxpool.Pool.

Types

type Conn

type Conn interface {
	Begin(context.Context) (pgx.Tx, error)
	BeginTx(context.Context, pgx.TxOptions) (pgx.Tx, error)
}

Conn abstracts pgx transactions creators: pgx.Conn and pgxpool.Pool.