pgxpoolv5

Documentation

Index

• Constants
• func Query[T any](ctx context.Context, db *DB, query string, pointers func(*T) []interface{}, ...) ([]T, error)
• type DB
  • func NewDB(dsns []string, options ...Option) (*DB, error)
  • func (db *DB) CopyFrom(ctx context.Context, tableName pgx.Identifier, columnNames []string, ...) (int64, error)
  • func (db *DB) DoTx(f func(db dbx.DBxer[*pgxpool.Pool, pgx.Tx, pgx.TxOptions]) error, ...) error
  • func (db *DB) DoTxContext(ctx context.Context, ...) error
  • func (db *DB) Exec(ctx context.Context, sql string, arguments ...any) (pgconn.CommandTag, error)
  • func (db *DB) Prepare(ctx context.Context, name, sql string) (*pgconn.StatementDescription, error)
  • func (db *DB) Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
  • func (db *DB) QueryRow(ctx context.Context, sql string, args ...any) pgx.Row
  • func (db *DB) SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults
  • func (db *DB) Tx() (pgx.Tx, error)
  • func (db *DB) WithCtx(ctx context.Context) *DB
  • func (db *DB) WithDefaultNodeStrategy(strategy dbx.GetNodeStragegy) *DB
  • func (db *DB) WithNodeWaitTimeout(timeout time.Duration) *DB
  • func (db *DB) WithReadFromNodeStrategy(strategy dbx.GetNodeStragegy) *DB
  • func (db *DB) WithWriteToNodeStrategy(strategy dbx.GetNodeStragegy) *DB
• type Option
  • func WithGenericOptions(options ...dbx.Option[*pgxpool.Pool]) Option
  • func WithNodeChecker(nodeChecker cluster.NodeChecker[*pgxpool.Pool]) Option
  • func WithPoolCloser(poolCloser cluster.ConnCloser[*pgxpool.Pool]) Option
  • func WithPoolOpener(poolOpener PoolOpener) Option
• type PoolOpener
  • func CustomPoolOpener(poolOpener PoolOpener, callbacks ...func(*pgxpool.Pool) error) PoolOpener
  • func DefaultPoolOpener() PoolOpener

Constants

const DefaultPingTimeout = 15 * time.Second

Functions

func Query

func Query[T any](ctx context.Context, db *DB, query string,
	pointers func(*T) []interface{}, args ...any) ([]T, error)

Query is a generic query helper with context.

Types

type DB

type DB struct {
	*dbx.DB[*pgxpool.Pool]
	// contains filtered or unexported fields
}

func NewDB

func NewDB(dsns []string, options ...Option) (*DB, error)

func (*DB) CopyFrom

func (db *DB) CopyFrom(ctx context.Context, tableName pgx.Identifier, columnNames []string, rowSrc pgx.CopyFromSource) (int64, error)

func (*DB) DoTx

func (db *DB) DoTx(f func(db dbx.DBxer[*pgxpool.Pool, pgx.Tx, pgx.TxOptions]) error, opts pgx.TxOptions) error

func (*DB) DoTxContext

func (db *DB) DoTxContext(
	ctx context.Context,
	f func(ctx context.Context, db dbx.DBxer[*pgxpool.Pool, pgx.Tx, pgx.TxOptions]) error,
	opts pgx.TxOptions) error

func (*DB) Exec

func (db *DB) Exec(ctx context.Context, sql string, arguments ...any) (pgconn.CommandTag, error)

func (*DB) Prepare

func (db *DB) Prepare(ctx context.Context, name, sql string) (*pgconn.StatementDescription, error)

func (*DB) Query

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

func (*DB) QueryRow

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

func (*DB) SendBatch

func (db *DB) SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults

func (*DB) Tx

func (db *DB) Tx() (pgx.Tx, error)

func (*DB) WithCtx

func (db *DB) WithCtx(ctx context.Context) *DB

func (*DB) WithDefaultNodeStrategy

func (db *DB) WithDefaultNodeStrategy(strategy dbx.GetNodeStragegy) *DB

func (*DB) WithNodeWaitTimeout

func (db *DB) WithNodeWaitTimeout(timeout time.Duration) *DB

func (*DB) WithReadFromNodeStrategy

func (db *DB) WithReadFromNodeStrategy(strategy dbx.GetNodeStragegy) *DB

func (*DB) WithWriteToNodeStrategy

func (db *DB) WithWriteToNodeStrategy(strategy dbx.GetNodeStragegy) *DB

type Option

type Option func(*DB)

func WithGenericOptions

func WithGenericOptions(options ...dbx.Option[*pgxpool.Pool]) Option

func WithNodeChecker

func WithNodeChecker(nodeChecker cluster.NodeChecker[*pgxpool.Pool]) Option

func WithPoolCloser

func WithPoolCloser(poolCloser cluster.ConnCloser[*pgxpool.Pool]) Option

func WithPoolOpener

func WithPoolOpener(poolOpener PoolOpener) Option

type PoolOpener

type PoolOpener func(ctx context.Context, dsn string) (*pgxpool.Pool, error)

func CustomPoolOpener

func CustomPoolOpener(poolOpener PoolOpener, callbacks ...func(*pgxpool.Pool) error) PoolOpener

func DefaultPoolOpener

func DefaultPoolOpener() PoolOpener