database

Oct 8, 2026

Changes in this version

type ListenOptions

+ ReacquireAfter int

Sep 30, 2026

Changes in this version

+ func ConnQueryContext[T any](ctx context.Context, c *Conn, sql string, args ...any) ([]T, error)

+ func ConnQueryRowContext[T any](ctx context.Context, c *Conn, sql string, args ...any) (T, bool, error)

+ func ConnScalarContext[T any](ctx context.Context, c *Conn, sql string, args ...any) (T, error)

+ func QueryContext[T any](ctx context.Context, db *DB, sql string, args ...any) (out []T, err error)

+ func QueryRowContext[T any](ctx context.Context, db *DB, sql string, args ...any) (out T, found bool, err error)

+ func ScalarContext[T any](ctx context.Context, db *DB, sql string, args ...any) (out T, err error)

+ func TxQueryContext[T any](ctx context.Context, tx *Tx, sql string, args ...any) ([]T, error)

+ func TxQueryRowContext[T any](ctx context.Context, tx *Tx, sql string, args ...any) (T, bool, error)

+ func TxScalarContext[T any](ctx context.Context, tx *Tx, sql string, args ...any) (T, error)

type Conn

+ func (c *Conn) ExecuteContext(ctx context.Context, sql string, args ...any) (int64, error)

+ func (c *Conn) TransactionalContext(ctx context.Context, fn func(ctx context.Context, tx *Tx) error) error

+ type ContextQueryHook interface

+ AfterQueryContext func(context.Context, QueryInfo)

+ BeforeQueryContext func(context.Context, QueryInfo)

type DB

+ func (db *DB) ExecuteContext(ctx context.Context, sql string, args ...any) (n int64, err error)

+ func (db *DB) PingContext(ctx context.Context) error

+ func (db *DB) TransactionalContext(ctx context.Context, fn func(ctx context.Context, tx *Tx) error) error

type Options

+ func WithInstrumentation(inst instrument.Instrumentation) Options

type Tx

+ func (tx *Tx) ExecuteContext(ctx context.Context, sql string, args ...any) (int64, error)

Sep 30, 2026

Changes in this version

+ type SQLX struct

+ func NewSQLX(ctx context.Context, opts ...Options) (*SQLX, error)

+ func OpenSQLXFromEnv(ctx context.Context) (*SQLX, error)

+ func (db *SQLX) BeginTx(ctx context.Context, opts *sql.TxOptions) (*sqlx.Tx, error)

+ func (db *SQLX) Options() Options

Sep 29, 2026

Changes in this version

type DB

+ func NewWithOptions(ctx context.Context, opts ...Options) (*DB, error)

type Options

+ func Default() Options

Sep 3, 2026

Changes in this version

+ const OpExec

+ const OpQuery

+ const OpQueryRow

+ const OpScalar

+ var ErrInvalidView = errors.New("database: DBView not initialized; use DB.WithCommandTimeout")

+ var ErrNilPrimary = errors.New("database: cluster requires a non-nil primary DB")

+ var ErrNoRows = pgx.ErrNoRows

+ func ClusterQueryRow[T any](cl *Cluster, sql string, args ...any) (T, bool, error)

+ func ClusterQuery[T any](cl *Cluster, sql string, args ...any) ([]T, error)

+ func ClusterScalar[T any](cl *Cluster, sql string, args ...any) (T, error)

+ func ConnIter[T any](c *Conn, sql string, args []any, fn func(row T) error) error

+ func ConnQueryRow[T any](c *Conn, sql string, args ...any) (T, bool, error)

+ func ConnQuery[T any](c *Conn, sql string, args ...any) ([]T, error)

+ func ConnScalar[T any](c *Conn, sql string, args ...any) (T, error)

+ func DoValue[T any](p RetryPolicy, fn func() (T, error)) (T, error)

+ func EnsureTable(db *DB, name, ddl string) error

+ func Iter[T any](db *DB, sql string, args []any, fn func(row T) error) error

+ func QueryRow[T any](db *DB, sql string, args ...any) (T, bool, error)

+ func Query[T any](db *DB, sql string, args ...any) ([]T, error)

+ func Scalar[T any](db *DB, sql string, args ...any) (T, error)

+ func TxIter[T any](tx *Tx, sql string, args []any, fn func(row T) error) error

+ func TxQueryRow[T any](tx *Tx, sql string, args ...any) (T, bool, error)

+ func TxQuery[T any](tx *Tx, sql string, args ...any) ([]T, error)

+ func TxScalar[T any](tx *Tx, sql string, args ...any) (T, error)

+ func Validate(o Options) error

+ func ViewQueryRow[T any](v *DBView, sql string, args ...any) (T, bool, error)

+ func ViewQuery[T any](v *DBView, sql string, args ...any) ([]T, error)

+ func ViewScalar[T any](v *DBView, sql string, args ...any) (T, error)

+ type Batch struct

+ func (b *Batch) Len() int

+ func (b *Batch) Queue(sql string, args ...any)

+ type BatchResults struct

+ func (br *BatchResults) Close() error

+ func (br *BatchResults) ExecResult() (int64, error)

+ func (br *BatchResults) RowScan(dest ...any) error

+ type Cluster struct

+ func NewCluster(primary *DB, replicas ...*DB) (*Cluster, error)

+ func (cl *Cluster) Execute(sql string, args ...any) (int64, error)

+ func (cl *Cluster) Primary() *DB

+ func (cl *Cluster) Replica() *DB

+ func (cl *Cluster) Transactional(fn func(tx *Tx) error) error

+ func (cl *Cluster) TransactionalLevel(level string, fn func(tx *Tx) error) error

+ type Conn struct

+ func Connect(ctx context.Context, opts Options) (*Conn, error)

+ func ConnectFromEnv(ctx context.Context) (*Conn, error)

+ func (c *Conn) Begin() (*Tx, error)

+ func (c *Conn) BulkInsert(table string, columns []string, rows [][]any) (int64, error)

+ func (c *Conn) Close() error

+ func (c *Conn) Execute(sql string, args ...any) (int64, error)

+ func (c *Conn) Listen(channel string, handler func(payload string)) (stop func() error, err error)

+ func (c *Conn) ListenWithReconnect(channel string, handler func(payload string), opts ListenOptions) (stop func() error, err error)

+ func (c *Conn) Notify(channel string, payload string) error

+ func (c *Conn) Transactional(fn func(tx *Tx) error) error

+ func (c *Conn) TransactionalLevel(level string, fn func(*Tx) error) error

+ type DB struct

+ func MustNew(ctx context.Context, opts ...Options) *DB

+ func New(ctx context.Context, opts ...Options) (*DB, error)

+ func OpenFromEnv(ctx context.Context) (*DB, error)

+ func (db *DB) Acquire() (*Conn, error)

+ func (db *DB) Close() error

+ func (db *DB) EnableMetrics(reg prometheus.Registerer) (*MetricsHandle, error)

+ func (db *DB) Execute(sql string, args ...any) (int64, error)

+ func (db *DB) Options() Options

+ func (db *DB) Ping() error

+ func (db *DB) Transactional(fn func(tx *Tx) error) error

+ func (db *DB) TransactionalLevel(level string, fn func(*Tx) error) error

+ func (db *DB) WithCommandTimeout(d time.Duration) *DBView

+ type DBView struct

+ func (v *DBView) CommandTimeout() time.Duration

+ func (v *DBView) Execute(sql string, args ...any) (int64, error)

+ type ListenOptions struct

+ MaxBackoff time.Duration

+ RetryDelay time.Duration

+ type MetricsCollector struct

+ func NewMetricsCollector(reg prometheus.Registerer) *MetricsCollector

+ func (mc *MetricsCollector) AfterHook(info QueryInfo)

+ func (mc *MetricsCollector) BeforeHook(QueryInfo)

+ func (mc *MetricsCollector) Collect() []prometheus.Collector

+ type MetricsHandle struct

+ func (h *MetricsHandle) Close()

+ func (h *MetricsHandle) Collector() *MetricsCollector

+ type Options struct

+ CommandTimeout time.Duration

+ ConnectionTimeout time.Duration

+ Database string

+ HideQueryArgs bool

+ Host string

+ Password string

+ PoolMaxSize int

+ PoolMinSize int

+ Port int

+ QueryHooks []QueryHook

+ RetryBaseDelay time.Duration

+ RetryEnabled bool

+ RetryMaxCount int

+ SlowQuery time.Duration

+ Username string

+ func DefaultOptions() Options

+ func LoadFromEnv() Options

+ type PageResult struct

+ Items []T

+ Page int

+ PageSize int

+ TotalCount int64

+ func (p PageResult[T]) HasNextPage() bool

+ type Pool interface

+ Begin func(ctx context.Context) (pgx.Tx, error)

+ Close func()

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

+ Ping func(ctx context.Context) error

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

+ QueryRow func(ctx context.Context, sql string, args ...any) pgx.Row

+ Stat func() PoolStats

+ type PoolStats struct

+ Idle int64

+ InUse int64

+ Max int64

+ type QueryHook interface

+ AfterHook func(info QueryInfo)

+ BeforeHook func(info QueryInfo)

+ type QueryHookFunc struct

+ After func(QueryInfo)

+ Before func(QueryInfo)

+ func (f QueryHookFunc) AfterHook(i QueryInfo)

+ func (f QueryHookFunc) BeforeHook(i QueryInfo)

+ type QueryInfo struct

+ Args []any

+ Duration time.Duration

+ Err error

+ Op string

+ Rows int64

+ SQL string

+ type Repository struct

+ func NewRepositoryForTable[T any](db *DB, table string) *Repository[T]

+ func NewRepository[T any](db *DB) *Repository[T]

+ func (r *Repository[T]) Count(spec Specification) (int64, error)

+ func (r *Repository[T]) Exists(spec Specification) (bool, error)

+ func (r *Repository[T]) Find(spec Specification) ([]T, error)

+ func (r *Repository[T]) FindOne(spec Specification) (T, bool, error)

+ func (r *Repository[T]) GetAll() ([]T, error)

+ func (r *Repository[T]) GetByID(id any) (T, bool, error)

+ func (r *Repository[T]) Paginate(spec Specification, page, pageSize int) (PageResult[T], error)

+ func (r *Repository[T]) Table() string

+ func (r *Repository[T]) Update(entity T, setCols []string, whereSpec Specification) (int64, error)

+ func (r *Repository[T]) Upsert(entity T, conflictCols, updateCols []string) (int64, error)

+ func (r *Repository[T]) UpsertDoNothing(entity T, conflictCols []string) (int64, error)

+ type Result struct

+ Data T

+ Duration time.Duration

+ Err error

+ func Failure[T any](err error, duration time.Duration) Result[T]

+ func Success[T any](data T, duration time.Duration) Result[T]

+ func (r Result[T]) IsSuccess() bool

+ type RetryPolicy struct

+ func NewRetryPolicy(enabled bool, maxCount int, baseDelay time.Duration) RetryPolicy

+ func (p RetryPolicy) Do(fn func() error) error

+ func (p RetryPolicy) IsTransient(err error) bool

+ type Specification struct

+ Args []any

+ OrderBy string

+ SQL string

+ type Tx struct

+ func (c *Tx) Execute(sql string, args ...any) (int64, error)

+ func (tx *Tx) Batch() *Batch

+ func (tx *Tx) Commit() error

+ func (tx *Tx) Rollback() error

+ func (tx *Tx) SendBatch(b *Batch) *BatchResults