Documentation
¶
Overview ¶
Package pgxpool adapts pgxpool to api-toolkit database ports.
New constructs a Postgres pool adapter for ports.DatabasePool. New observability code should prefer StatSnapshot and plain-value snapshot APIs; legacy pgx-shaped stats remain compatibility-sensitive in v2.
This contrib adapter is maintained but not part of the stable core API gate.
Index ¶
- func New(dsn string) (ports.DatabasePool, error)
- func NewWithContext(ctx context.Context, dsn string) (ports.DatabasePool, error)
- type Adapter
- type Connection
- func (c *Connection) Begin(ctx context.Context) (ports.DatabaseTransaction, error)
- func (c *Connection) Exec(ctx context.Context, sql string, args ...any) (ports.DatabaseResult, error)
- func (c *Connection) Query(ctx context.Context, sql string, args ...any) (ports.DatabaseRows, error)
- func (c *Connection) QueryRow(ctx context.Context, sql string, args ...any) ports.DatabaseRow
- type Result
- type Row
- type Rows
- type Stats
- func (s *Stats) AcquireCount() int64
- func (s *Stats) AcquireDuration() time.Duration
- func (s *Stats) AcquiredConns() int32
- func (s *Stats) CanceledAcquireCount() int64
- func (s *Stats) ConstructingConns() int32
- func (s *Stats) EmptyAcquireCount() int64
- func (s *Stats) IdleConns() int32
- func (s *Stats) MaxConns() int32
- func (s *Stats) NewConnsCount() int64
- func (s *Stats) TotalConns() int32
- type Transaction
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func New ¶
func New(dsn string) (ports.DatabasePool, error)
New creates a new database pool adapter using a bounded startup context. Callers that need direct context control should use NewWithContext.
func NewWithContext ¶
NewWithContext creates a new database pool adapter with a context.
Types ¶
type Adapter ¶
Adapter wraps pgxpool.Pool to implement ports.DatabasePool.
func (*Adapter) Stat ¶
func (a *Adapter) Stat() ports.DatabaseStats
Stat returns the legacy database stats compatibility wrapper.
func (*Adapter) StatSnapshot ¶ added in v2.1.0
func (a *Adapter) StatSnapshot() ports.DatabasePoolSnapshot
StatSnapshot returns pool statistics as plain values for new call sites.
type Connection ¶
Connection wraps pgxpool.Conn to implement ports.DatabaseConnection.
func (*Connection) Begin ¶
func (c *Connection) Begin(ctx context.Context) (ports.DatabaseTransaction, error)
Begin starts a transaction.
func (*Connection) Exec ¶
func (c *Connection) Exec(ctx context.Context, sql string, args ...any) (ports.DatabaseResult, error)
Exec executes a query without returning rows.
func (*Connection) Query ¶
func (c *Connection) Query(ctx context.Context, sql string, args ...any) (ports.DatabaseRows, error)
Query executes a query and returns rows.
func (*Connection) QueryRow ¶
func (c *Connection) QueryRow(ctx context.Context, sql string, args ...any) ports.DatabaseRow
QueryRow executes a query and returns a single row.
type Result ¶
type Result struct {
pgconn.CommandTag
}
Result wraps pgconn.CommandTag to implement ports.DatabaseResult.
type Stats ¶
Stats wraps pgxpool.Stat to implement ports.DatabaseStats.
func (*Stats) AcquireCount ¶
AcquireCount returns the number of times a connection was acquired from the pool.
func (*Stats) AcquireDuration ¶
AcquireDuration returns the total duration of all connection acquisitions.
func (*Stats) AcquiredConns ¶
AcquiredConns returns the number of currently acquired connections.
func (*Stats) CanceledAcquireCount ¶
CanceledAcquireCount returns the number of times a connection acquisition was canceled.
func (*Stats) ConstructingConns ¶
ConstructingConns returns the number of connections currently being constructed.
func (*Stats) EmptyAcquireCount ¶
EmptyAcquireCount returns the number of times a connection was requested when the pool was empty.
func (*Stats) NewConnsCount ¶
NewConnsCount returns the number of new connections created.
func (*Stats) TotalConns ¶
TotalConns returns the total number of connections in the pool.
type Transaction ¶
Transaction wraps pgx.Tx to implement ports.DatabaseTransaction.
func (*Transaction) Exec ¶
func (t *Transaction) Exec(ctx context.Context, sql string, args ...any) (ports.DatabaseResult, error)
Exec executes a query without returning rows.
func (*Transaction) Query ¶
func (t *Transaction) Query(ctx context.Context, sql string, args ...any) (ports.DatabaseRows, error)
Query executes a query and returns rows.
func (*Transaction) QueryRow ¶
func (t *Transaction) QueryRow(ctx context.Context, sql string, args ...any) ports.DatabaseRow
QueryRow executes a query and returns a single row.
Source Files