Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pgxkit

package module

Go to main page

Versions in this module

v2

v2.2.0

May 6, 2026

v2.1.1

May 6, 2026

v2.1.0

May 6, 2026

Changes in this version

type DB

+ func (db *DB) AssertPlan(t *testing.T, testName string)

+ type GoldenOption func(*transcriptRecorder)

+ func WithGoldenNormalizer(fn func(any) (any, bool)) GoldenOption

type TestDB

+ func (tdb *TestDB) EnableAssertPlan(testName string) *DB

v2.0.0

Jan 22, 2026

Changes in this version

+ const TxCommit

+ const TxRollback

+ var ErrTxFinalized = errors.New("transaction already finalized")

+ func CleanupGolden(testName string) error

+ func CleanupTestData(sqlStatements ...string)

+ func FromPgxBool(b pgtype.Bool) *bool

+ func FromPgxBoolToBool(b pgtype.Bool) bool

+ func FromPgxDate(d pgtype.Date) *time.Time

+ func FromPgxFloat4(f pgtype.Float4) *float32

+ func FromPgxFloat8(f pgtype.Float8) *float64

+ func FromPgxInt2(i pgtype.Int2) *int16

+ func FromPgxInt4(i pgtype.Int4) *int32

+ func FromPgxInt4ToInt(i pgtype.Int4) *int

+ func FromPgxInt8(i pgtype.Int8) *int64

+ func FromPgxInt8Array(a pgtype.Array[pgtype.Int8]) []int64

+ func FromPgxNumeric(n pgtype.Numeric) *float64

+ func FromPgxText(t pgtype.Text) *string

+ func FromPgxTextArray(a pgtype.Array[pgtype.Text]) []string

+ func FromPgxTextToString(t pgtype.Text) string

+ func FromPgxTime(t pgtype.Time) *time.Time

+ func FromPgxTimestamp(t pgtype.Timestamp) *time.Time

+ func FromPgxTimestamptz(t pgtype.Timestamptz) time.Time

+ func FromPgxTimestamptzPtr(t pgtype.Timestamptz) *time.Time

+ func FromPgxUUID(pgxID pgtype.UUID) uuid.UUID

+ func FromPgxUUIDToPtr(pgxID pgtype.UUID) *uuid.UUID

+ func GetDSN() string

+ func IsRetryableError(err error) bool

+ func RetryOperation(ctx context.Context, operation func(context.Context) error, ...) error

+ func Retry[T any](ctx context.Context, fn func(context.Context) (T, error), opts ...RetryOption) (T, error)

+ func ToPgxBool(b *bool) pgtype.Bool

+ func ToPgxBoolFromBool(b bool) pgtype.Bool

+ func ToPgxDate(t *time.Time) pgtype.Date

+ func ToPgxFloat4(f *float32) pgtype.Float4

+ func ToPgxFloat8(f *float64) pgtype.Float8

+ func ToPgxInt2(i *int16) pgtype.Int2

+ func ToPgxInt4(i *int32) pgtype.Int4

+ func ToPgxInt4FromInt(i *int) pgtype.Int4

+ func ToPgxInt8(i *int64) pgtype.Int8

+ func ToPgxInt8Array(s []int64) pgtype.Array[pgtype.Int8]

+ func ToPgxNumeric(f *float64) pgtype.Numeric

+ func ToPgxText(s *string) pgtype.Text

+ func ToPgxTextArray(s []string) pgtype.Array[pgtype.Text]

+ func ToPgxTextFromString(s string) pgtype.Text

+ func ToPgxTime(t *time.Time) pgtype.Time

+ func ToPgxTimestamp(t *time.Time) pgtype.Timestamp

+ func ToPgxTimestamptz(t *time.Time) pgtype.Timestamptz

+ func ToPgxUUID(id uuid.UUID) pgtype.UUID

+ func ToPgxUUIDFromPtr(id *uuid.UUID) pgtype.UUID

+ type ConnectOption func(*connectConfig)

+ func WithAfterOperation(fn HookFunc) ConnectOption

+ func WithAfterTransaction(fn HookFunc) ConnectOption

+ func WithBeforeOperation(fn HookFunc) ConnectOption

+ func WithBeforeTransaction(fn HookFunc) ConnectOption

+ func WithMaxConnIdleTime(d time.Duration) ConnectOption

+ func WithMaxConnLifetime(d time.Duration) ConnectOption

+ func WithMaxConns(n int32) ConnectOption

+ func WithMinConns(n int32) ConnectOption

+ func WithOnAcquire(fn func(context.Context, *pgx.Conn) error) ConnectOption

+ func WithOnConnect(fn func(*pgx.Conn) error) ConnectOption

+ func WithOnDisconnect(fn func(*pgx.Conn)) ConnectOption

+ func WithOnRelease(fn func(*pgx.Conn)) ConnectOption

+ func WithOnShutdown(fn HookFunc) ConnectOption

+ func WithReadMaxConns(n int32) ConnectOption

+ func WithReadMinConns(n int32) ConnectOption

+ func WithWriteMaxConns(n int32) ConnectOption

+ func WithWriteMinConns(n int32) ConnectOption

+ type DB struct

+ func NewDB() *DB

+ func (db *DB) AssertGolden(t *testing.T, testName string)

+ func (db *DB) BeginTx(ctx context.Context, txOptions pgx.TxOptions) (*Tx, error)

+ func (db *DB) Connect(ctx context.Context, dsn string, opts ...ConnectOption) error

+ func (db *DB) ConnectReadWrite(ctx context.Context, readDSN, writeDSN string, opts ...ConnectOption) error

+ func (db *DB) Exec(ctx context.Context, sql string, args ...interface{}) (pgconn.CommandTag, error)

+ func (db *DB) HealthCheck(ctx context.Context) error

+ func (db *DB) IsReady(ctx context.Context) bool

+ func (db *DB) Query(ctx context.Context, sql string, args ...interface{}) (pgx.Rows, error)

+ func (db *DB) QueryRow(ctx context.Context, sql string, args ...interface{}) pgx.Row

+ func (db *DB) ReadPool() *pgxpool.Pool

+ func (db *DB) ReadQuery(ctx context.Context, sql string, args ...interface{}) (pgx.Rows, error)

+ func (db *DB) ReadQueryRow(ctx context.Context, sql string, args ...interface{}) pgx.Row

+ func (db *DB) ReadStats() *pgxpool.Stat

+ func (db *DB) Shutdown(ctx context.Context) error

+ func (db *DB) Stats() *pgxpool.Stat

+ func (db *DB) WritePool() *pgxpool.Pool

+ type DatabaseError struct

+ Entity string

+ Err error

+ Operation string

+ func NewDatabaseError(entity, operation string, err error) *DatabaseError

+ func (e *DatabaseError) Error() string

+ func (e *DatabaseError) Unwrap() error

+ type Executor interface

+ Exec func(ctx context.Context, sql string, args ...interface{}) (pgconn.CommandTag, error)

+ Query func(ctx context.Context, sql string, args ...interface{}) (pgx.Rows, error)

+ QueryRow func(ctx context.Context, sql string, args ...interface{}) pgx.Row

+ type HookFunc func(ctx context.Context, sql string, args []interface{}, operationErr error) error

+ type HookType int

+ const AfterOperation

+ const AfterTransaction

+ const BeforeOperation

+ const BeforeTransaction

+ const OnShutdown

+ type NotFoundError struct

+ Entity string

+ Identifier interface{}

+ func NewNotFoundError(entity string, identifier interface{}) *NotFoundError

+ func (e *NotFoundError) Error() string

+ type QueryPlan struct

+ ExecutionMS float64

+ Plan []map[string]interface{}

+ PlanningMS float64

+ Query int

+ SQL string

+ type RetryOption func(*retryConfig)

+ func WithBackoffMultiplier(m float64) RetryOption

+ func WithBaseDelay(d time.Duration) RetryOption

+ func WithMaxDelay(d time.Duration) RetryOption

+ func WithMaxRetries(n int) RetryOption

+ type TestDB struct

+ func NewTestDB() *TestDB

+ func RequireDB(t *testing.T) *TestDB

+ func (tdb *TestDB) Clean() error

+ func (tdb *TestDB) EnableGolden(testName string) *DB

+ func (tdb *TestDB) Setup() error

+ type Tx struct

+ func (t *Tx) Commit(ctx context.Context) error

+ func (t *Tx) Exec(ctx context.Context, sql string, args ...interface{}) (pgconn.CommandTag, error)

+ func (t *Tx) IsFinalized() bool

+ func (t *Tx) Query(ctx context.Context, sql string, args ...interface{}) (pgx.Rows, error)

+ func (t *Tx) QueryRow(ctx context.Context, sql string, args ...interface{}) pgx.Row

+ func (t *Tx) Rollback(ctx context.Context) error

+ func (t *Tx) Tx() pgx.Tx

+ type ValidationError struct

+ Entity string

+ Err error

+ Field string

+ Operation string

+ Reason string

+ func NewValidationError(entity, operation, field, reason string, err error) *ValidationError

+ func (e *ValidationError) Error() string

+ func (e *ValidationError) Unwrap() error

Other modules containing this package

github.com/nhalm/pgxkit