pg

Documentation

Index

• func AsDuplicate(err error, dup error) error
• func AsNotFound(err error, msg string) error
• func IsUniqueViolation(err error, constraint string) bool
• func TenantExec(ctx context.Context, db Beginner, id Identity, sql string, args ...any) (pgconn.CommandTag, error)
• func TenantScan(ctx context.Context, db Beginner, id Identity, sql string, args []any, ...) error
• func WithService(ctx context.Context, db Beginner, ...) error
• func WithTenant(ctx context.Context, db Beginner, id Identity, ...) error
• type Beginner
• type DB
  • func Connect(ctx context.Context, dsn string, opt Options) (*DB, error)
  • func WrapPool(pool *pgxpool.Pool) *DB
  • func (d *DB) Acquire(ctx context.Context) (*pgxpool.Conn, error)
  • func (d *DB) Begin(ctx context.Context) (pgx.Tx, error)
  • func (d *DB) Close()
  • func (d *DB) Ping(ctx context.Context) error
  • func (d *DB) Pool() *pgxpool.Pool
  • func (d *DB) Read(ctx context.Context, fn func(ctx context.Context, q DBTX) error) error
  • func (d *DB) Reset()
  • func (d *DB) Tx(ctx context.Context) DBTX
  • func (d *DB) Within(ctx context.Context, fn func(ctx context.Context) error) error
• type DBTX
• type Identity
• type Options

Functions

func AsDuplicate

func AsDuplicate(err error, dup error) error

func AsNotFound

func AsNotFound(err error, msg string) error

func IsUniqueViolation

func IsUniqueViolation(err error, constraint string) bool

func TenantExec

func TenantExec(ctx context.Context, db Beginner, id Identity, sql string, args ...any) (pgconn.CommandTag, error)

TenantExec runs ONE statement inside a transaction that carries the tenant GUCs, committing immediately. Multi-statement units of work belong in WithTenant. Each call costs one BEGIN/COMMIT round trip — that is the price of correct tenant scoping; do not be tempted to set session-level GUCs on a pooled connection instead (cross-tenant leak).

func TenantScan

func TenantScan(ctx context.Context, db Beginner, id Identity, sql string, args []any, dest ...any) error

TenantScan runs ONE query inside the same scoped transaction and scans a SINGLE row into dest (pgx QueryRow semantics). Deliberately NOT a rows-returning helper: streaming rows would force the transaction (and the tenant scope) to outlive the call.

func WithService

func WithService(ctx context.Context, db Beginner, fn func(ctx context.Context, tx pgx.Tx) error) error

func WithTenant

func WithTenant(ctx context.Context, db Beginner, id Identity, fn func(ctx context.Context, tx pgx.Tx) error) error

Types

type Beginner

type Beginner interface {
	Begin(ctx context.Context) (pgx.Tx, error)
}

type DB

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

func Connect

func Connect(ctx context.Context, dsn string, opt Options) (*DB, error)

func WrapPool

func WrapPool(pool *pgxpool.Pool) *DB

func (*DB) Acquire

func (d *DB) Acquire(ctx context.Context) (*pgxpool.Conn, error)

func (*DB) Begin

func (d *DB) Begin(ctx context.Context) (pgx.Tx, error)

func (*DB) Close

func (d *DB) Close()

func (*DB) Ping

func (d *DB) Ping(ctx context.Context) error

func (*DB) Pool

func (d *DB) Pool() *pgxpool.Pool

func (*DB) Read

func (d *DB) Read(ctx context.Context, fn func(ctx context.Context, q DBTX) error) error

func (*DB) Reset

func (d *DB) Reset()

func (*DB) Tx

func (d *DB) Tx(ctx context.Context) DBTX

func (*DB) Within

func (d *DB) Within(ctx context.Context, fn func(ctx context.Context) error) error

type DBTX

type DBTX interface {
	Exec(ctx context.Context, sql string, args ...any) (pgconn.CommandTag, error)
	Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
	QueryRow(ctx context.Context, sql string, args ...any) pgx.Row
}

type Identity

type Identity struct {
	WorkspaceID uuid.UUID
	UserID      uuid.UUID
}

type Options

type Options struct {
	StartupTimeout time.Duration

	ConnectTimeout time.Duration

	ReplicaDSN string

	MaxConns int32
	MinConns int32

	MaxConnLifetime  time.Duration
	MaxConnIdleTime  time.Duration
	HealthCheckEvery time.Duration

	SelfHeal *bool

	ExitOnWedge bool
}