postgres

package module

Go to main page

Versions in this module

v3

v3.2.0

Oct 28, 2026

Changes in this version

+ const MaximumProtocolMessageBodyCeiling

v3.1.0

Oct 28, 2026

Changes in this version

type PoolConfig

+ func ResolveNativeDSN(ctx context.Context, dsn string) (*PoolConfig, error)

v3.0.0

Oct 22, 2026

Changes in this version

+ const DefaultAcquireTimeout

+ const DefaultConfigResolutionTimeout

+ const DefaultConnectTimeout

+ const DefaultMaximumCacheEntries

+ const DefaultMaximumDSNBytes

+ const DefaultMaximumFallbacks

+ const DefaultMaximumNativeStringBytes

+ const DefaultMaximumProtocolMessageBodyBytes

+ const DefaultMaximumRuntimeParams

+ const DefaultPingTimeout

+ const DefaultShutdownTimeout

+ const DefaultTransactionCleanupTimeout

+ const MaximumConfigTimeout

+ const MaximumPoolConnections

+ const MaximumPoolLifetime

+ var ErrAcquireTimeout = errors.New("postgres: acquire timeout")

+ var ErrContextRequired = errors.New("postgres: context required")

+ var ErrHealthTimeout = errors.New("postgres: health check timeout")

+ var ErrNilTransactionCallback = errors.New("postgres: transaction callback is nil")

+ var ErrPoolClosed = errors.New("postgres: pool closed")

+ var ErrPoolExhausted = errors.New("postgres: pool exhausted")

+ var ErrShutdownTimeout = errors.New("postgres: shutdown timeout")

+ func IsCancellation(err error) bool

+ func IsCheckViolation(err error) bool

+ func IsConnectivity(err error) bool

+ func IsDeadlock(err error) bool

+ func IsExclusionViolation(err error) bool

+ func IsForeignKeyViolation(err error) bool

+ func IsKind(err error, kind ErrorKind) bool

+ func IsLockUnavailable(err error) bool

+ func IsPoolExhaustion(err error) bool

+ func IsQueryCanceled(err error) bool

+ func IsRetryable(err error) bool

+ func IsSerializationFailure(err error) bool

+ func IsTimeout(err error) bool

+ func IsUniqueViolation(err error) bool

+ func RunSavepoint(ctx context.Context, parent pgx.Tx, options SavepointOptions, ...) (err error)

+ func RunTransaction(ctx context.Context, beginner Beginner, options TransactionOptions, ...) (err error)

+ func SQLState(err error) (string, bool)

+ type Beginner interface

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

+ type Config struct

+ AcquireTimeout time.Duration

+ ConfigResolutionTimeout time.Duration

+ Configure func(context.Context, *PoolConfig) error

+ ConnectTimeout time.Duration

+ DSN string

+ HealthCheckPeriod time.Duration

+ Limits ConfigLimits

+ MaxConnIdleTime time.Duration

+ MaxConnLifetime time.Duration

+ MaxConnLifetimeJitter time.Duration

+ MaxConns int32

+ MinConns int32

+ MinIdleConns int32

+ Observer Observer

+ PingTimeout time.Duration

+ ResolveDSN func(context.Context, string) (*PoolConfig, error)

+ SessionInit func(context.Context, *pgx.Conn) error

+ ShutdownTimeout time.Duration

+ StartupPolicy StartupPolicy

+ TLS TLSConfig

+ type ConfigError struct

+ Cause error

+ Field string

+ Problem string

+ func (e *ConfigError) Error() string

+ func (e *ConfigError) Unwrap() error

+ type ConfigLimits struct

+ MaximumDSNBytes int

+ MaximumDescriptionCacheEntries int

+ MaximumFallbacks int

+ MaximumNativeStringBytes int

+ MaximumProtocolMessageBodyBytes int

+ MaximumRuntimeParams int

+ MaximumStatementCacheEntries int

+ type ErrorInfo struct

+ Cause error

+ Column string

+ Constraint string

+ Detail string

+ Hint string

+ Kind ErrorKind

+ Postgres *pgconn.PgError

+ Retryable bool

+ SQLState string

+ Schema string

+ Severity string

+ Table string

+ func Classify(err error) ErrorInfo

+ type ErrorKind string

+ const ErrorCancellation

+ const ErrorCheckViolation

+ const ErrorConnectivity

+ const ErrorDeadlock

+ const ErrorExclusionViolation

+ const ErrorForeignKeyViolation

+ const ErrorLockUnavailable

+ const ErrorNone

+ const ErrorPoolExhaustion

+ const ErrorQueryCanceled

+ const ErrorSerializationFailure

+ const ErrorTimeout

+ const ErrorUniqueViolation

+ const ErrorUnknown

+ type Health struct

+ Err error

+ Ready bool

+ Stats Stats

+ type Observation struct

+ Duration time.Duration

+ ErrorKind ErrorKind

+ HasPoolStats bool

+ Operation Operation

+ Outcome Outcome

+ Pool Stats

+ SQLState string

+ type Observer interface

+ Observe func(context.Context, Observation)

+ func NewSlogObserver(logger *slog.Logger) Observer

+ type ObserverFunc func(context.Context, Observation)

+ func (f ObserverFunc) Observe(ctx context.Context, observation Observation)

+ type Operation string

+ const OperationAcquire

+ const OperationClose

+ const OperationPing

+ const OperationSavepoint

+ const OperationTransaction

+ type Outcome string

+ const OutcomeAborted

+ const OutcomeError

+ const OutcomePanic

+ const OutcomeSuccess

+ type Pool struct

+ func Connect(ctx context.Context, input Config) (*Pool, error)

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

+ func (p *Pool) Liveness() Health

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

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

+ func (p *Pool) Readiness(ctx context.Context) Health

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

+ func (p *Pool) Stats() Stats

+ type PoolConfig = pgxpool.Config

+ func PrepareConfig(ctx context.Context, input Config) (*PoolConfig, error)

+ type SavepointOptions struct

+ CleanupTimeout time.Duration

+ Observer Observer

+ type StartupPolicy uint8

+ const StartupLazy

+ const StartupPing

+ type Stats struct

+ AcquireCount int64

+ AcquiredConns int32

+ CanceledAcquireCount int64

+ ConstructingConns int32

+ EmptyAcquireCount int64

+ EmptyAcquireWaitTime time.Duration

+ IdleConns int32

+ MaxConns int32

+ NewConnsCount int64

+ TotalConns int32

+ type TLSConfig struct

+ Config *tls.Config

+ Mode TLSMode

+ type TLSMode uint8

+ const TLSDisable

+ const TLSFromDSN

+ const TLSRequire

+ type TransactionOptions struct

+ CleanupTimeout time.Duration

+ Observer Observer

Other modules containing this package

github.com/faustbrian/go-postgres

github.com/faustbrian/go-postgres/v2

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