crdbpgx

package module

Go to main page

Versions in this module

v1

v1.1.1

Oct 17, 2026

Changes in this version

type Hook

+ OnPoolCreated func(*Pool) func()

type HooksDefaults

+ func (HooksDefaults) OnPoolCreated(*Pool) func()

v1.1.0

Oct 17, 2026

Changes in this version

+ type Executor interface

+ ExecFunc func(ctx context.Context, ...) error

+ InTxFunc func(context.Context, pgx.TxOptions, func(Tx) error) error

+ QueryFunc func(ctx context.Context, rowsFunc func(context.Context, pgx.Rows) error, ...) error

+ QueryRowFunc func(ctx context.Context, rowFunc func(context.Context, pgx.Row) error, sql string, ...) error

+ type HealthUpdateData struct

+ Healthy bool

+ HealthyNodes int

+ NodeID uint32

+ type Hook interface

+ OnHealthUpdate func(HealthUpdateData)

+ OnNodeSwitchEnd func(context.Context, NodeSwitchEndData)

+ OnNodeSwitchStart func(context.Context, NodeSwitchStartData)

+ OnOperationEnd func(context.Context, OperationEndData)

+ OnRebalanceEnd func(context.Context, RebalanceEndData)

+ type HooksDefaults struct

+ func (HooksDefaults) OnHealthUpdate(HealthUpdateData)

+ func (HooksDefaults) OnNodeSwitchEnd(context.Context, NodeSwitchEndData)

+ func (HooksDefaults) OnNodeSwitchStart(context.Context, NodeSwitchStartData)

+ func (HooksDefaults) OnOperationEnd(context.Context, OperationEndData)

+ func (HooksDefaults) OnRebalanceEnd(context.Context, RebalanceEndData)

+ func (HooksDefaults) TraceQueryEnd(context.Context, *pgx.Conn, pgx.TraceQueryEndData)

+ func (HooksDefaults) TraceQueryStart(ctx context.Context, _ *pgx.Conn, _ pgx.TraceQueryStartData) context.Context

type NodeHealthTrackerOption

+ func WithHealthTrackerHooks(hooks ...Hook) NodeHealthTrackerOption

+ type NodeSwitchEndData struct

+ Err error

+ FromNodeID uint32

+ PoolName string

+ Reused bool

+ ToNodeID uint32

+ type NodeSwitchStartData struct

+ FromNodeID uint32

+ PoolName string

+ type OperationEndData struct

+ Attempts int

+ Err error

+ PoolName string

+ Resets int

+ Retries int

+ RetryLimitReached bool

type Option

+ func WithHooks(hooks ...Hook) Option

+ type RebalanceEndData struct

+ Acquired int

+ PoolName string

+ Pruned int

type Runner

+ func NewRunner(db Executor) Runner

+ func (r Runner) Exec(ctx context.Context, sql string, args ...any) (pgconn.CommandTag, error)

+ func (r Runner) InTx(ctx context.Context, opts pgx.TxOptions, fn func(Runner) error) error

+ func (r Runner) QueryRow[T any](ctx context.Context, rowTo pgx.RowToFunc[T], sql string, args ...any) (T, error)

+ func (r Runner) Query[T any](ctx context.Context, rowTo pgx.RowToFunc[T], sql string, args ...any) ([]T, error)

v1.0.0

Sep 4, 2026

Changes in this version

+ const CrdbAmbiguousErrorCode

+ const CrdbClockSkewMessage

+ const CrdbRetryErrCode

+ const CrdbServerNotAcceptingClients

+ const CrdbUnknownSQLState

+ const DefaultConnectRate

+ const DefaultContextPropagationBehaviour

+ const DefaultMaxRetries

+ var CtxDisableRetries = ctxDisableRetries

+ func IsResettableError(ctx context.Context, err error) bool

+ func IsRetryableError(ctx context.Context, err error) bool

+ func NewNodeHealthTracker(cfg *pgx.ConnConfig, opts ...NodeHealthTrackerOption) (_ *nodeHealthTracker, err error)

+ func RetriesDisabled(ctx context.Context) bool

+ func WithDisableRetries(ctx context.Context) context.Context

+ type ContextPropagationBehaviour int

+ const ContextPropagationDetach

+ const ContextPropagationOnAcquire

+ const ContextPropagationPassthrough

+ type Jitter interface

+ Jitter func(time.Duration) time.Duration

+ type JitteredTicker struct

+ C <-chan time.Time

+ func NewJitteredTicker(d time.Duration, j Jitter) *JitteredTicker

+ func (t *JitteredTicker) Stop()

+ type MaxRetryError struct

+ LastErr error

+ MaxRetries uint

+ func (e *MaxRetryError) Error() string

+ func (e *MaxRetryError) GRPCStatus() *status.Status

+ func (e *MaxRetryError) Unwrap() error

+ type NodeBalancer interface

+ Rebalance func(ctx context.Context, pool *Pool)

+ Run func(ctx context.Context, pool *Pool)

+ func NewNodeConnectionBalancer(opts ...NodeConnectionBalancerOption) NodeBalancer

+ type NodeConnectionBalancerOption func(*nodeConnectionBalancer)

+ func WithBalancingInterval(interval time.Duration) NodeConnectionBalancerOption

+ func WithBalancingTimeout(timeout time.Duration) NodeConnectionBalancerOption

+ func WithTopologyChangeBalancingInterval(interval, window time.Duration) NodeConnectionBalancerOption

+ type NodeHealthTracker interface

+ IsHealthy func(nodeID uint32) bool

+ NumHealthy func() int

+ SetStatus func(nodeID uint32, healthy bool)

+ type NodeHealthTrackerOption func(*nodeHealthTrackerConfig)

+ func WithPollInterval(d time.Duration) NodeHealthTrackerOption

+ func WithTopologyChangePollInterval(interval, window time.Duration) NodeHealthTrackerOption

+ type Option func(*poolCfg)

+ func WithBalancer(b NodeBalancer) Option

+ func WithConnectRate(rate time.Duration) Option

+ func WithContextPropagationBehaviour(behavior ContextPropagationBehaviour) Option

+ func WithHealthTracker(h NodeHealthTracker) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithMaxRetries(retries int) Option

+ func WithName(name string) Option

+ type Pool struct

+ func NewPool(ctx context.Context, pgxConfig *pgxpool.Config, opts ...Option) (_ *Pool, err error)

+ func (p *Pool) Acquire(ctx context.Context) (*pgxpool.Conn, error)

+ func (p *Pool) AcquireAllIdle(ctx context.Context) []*pgxpool.Conn

+ func (p *Pool) AcquireFunc(ctx context.Context, f func(*pgxpool.Conn) error) error

+ func (p *Pool) Close()

+ func (p *Pool) Config() *pgxpool.Config

+ func (p *Pool) CopyFrom(ctx context.Context, tableName pgx.Identifier, columnNames []string, ...) (int64, error)

+ func (p *Pool) ExecFunc(ctx context.Context, ...) error

+ func (p *Pool) GCMark(conn *pgx.Conn)

+ func (p *Pool) InTx(ctx context.Context, txOptions pgx.TxOptions, ...) error

+ func (p *Pool) InTxFunc(ctx context.Context, txOptions pgx.TxOptions, txFunc func(Tx) error) error

+ func (p *Pool) MaxConns() int

+ func (p *Pool) MinConns() int

+ func (p *Pool) Name() string

+ func (p *Pool) NodeID(conn *pgx.Conn) uint32

+ func (p *Pool) Ping(ctx context.Context) error

+ func (p *Pool) QueryFunc(ctx context.Context, rowsFunc func(ctx context.Context, rows pgx.Rows) error, ...) error

+ func (p *Pool) QueryRowFunc(ctx context.Context, rowFunc func(ctx context.Context, row pgx.Row) error, ...) error

+ func (p *Pool) SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults

+ func (p *Pool) Stat() *pgxpool.Stat

+ type ResettableError struct

+ Err error

+ func (e *ResettableError) Error() string

+ func (e *ResettableError) GRPCStatus() *status.Status

+ func (e *ResettableError) Unwrap() error

+ type RetryableError struct

+ Err error

+ func (e *RetryableError) Error() string

+ func (e *RetryableError) Unwrap() error

+ type Runner interface

+ ExecFunc func(ctx context.Context, ...) error

+ InTxFunc func(context.Context, pgx.TxOptions, func(Tx) error) error

+ QueryFunc func(ctx context.Context, rowsFunc func(context.Context, pgx.Rows) error, ...) error

+ QueryRowFunc func(ctx context.Context, rowFunc func(context.Context, pgx.Row) error, sql string, ...) error

+ type Tx interface

+ type UniformJitter struct

+ Min time.Duration

+ Source *rand.Rand

+ func (u UniformJitter) Jitter(d time.Duration) time.Duration

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL