dbpg

Documentation

Overview

Package dbpg provides PostgreSQL connection management with master-slave support.

Index

• func Array(a *[]string) any
• type DB
  • func New(masterDSN string, slaveDSNs []string, opts *Options) (*DB, error)
  • func (db *DB) BatchExec(ctx context.Context, in <-chan string)
  • func (db *DB) BeginTx(ctx context.Context, opts *sql.TxOptions) (*sql.Tx, error)
  • func (db *DB) BeginTxWithRetry(ctx context.Context, strategy retry.Strategy, opts *sql.TxOptions) (*sql.Tx, error)
  • func (db *DB) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
  • func (db *DB) ExecWithRetry(ctx context.Context, strategy retry.Strategy, query string, ...) (sql.Result, error)
  • func (db *DB) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)
  • func (db *DB) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row
  • func (db *DB) QueryRowWithRetry(ctx context.Context, strategy retry.Strategy, query string, ...) (*sql.Row, error)
  • func (db *DB) QueryWithRetry(ctx context.Context, strategy retry.Strategy, query string, ...) (*sql.Rows, error)
  • func (db *DB) WithTx(ctx context.Context, fn func(*sql.Tx) error) error
  • func (db *DB) WithTxWithRetry(ctx context.Context, strategy retry.Strategy, fn func(*sql.Tx) error) error
• type Options

Functions

func Array

func Array(a *[]string) any

Array returns an object that can be passed to Scan for []string.

Types

type DB

type DB struct {
	Master *sql.DB
	Slaves []*sql.DB
	// contains filtered or unexported fields
}

DB represents a database connection with master and slave nodes.

func New

func New(masterDSN string, slaveDSNs []string, opts *Options) (*DB, error)

New creates a new DB instance with master and slave connections.

func (*DB) BatchExec

func (db *DB) BatchExec(ctx context.Context, in <-chan string)

BatchExec executes multiple queries asynchronously in a batch.

func (*DB) BeginTx

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

BeginTx starts a transaction on the master database.

func (*DB) BeginTxWithRetry

func (db *DB) BeginTxWithRetry(
	ctx context.Context,
	strategy retry.Strategy,
	opts *sql.TxOptions,
) (*sql.Tx, error)

BeginTxWithRetry starts a transaction with a retry strategy on the master database.

func (*DB) ExecContext

func (db *DB) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)

ExecContext executes a command on the master database.

func (*DB) ExecWithRetry

func (db *DB) ExecWithRetry(
	ctx context.Context,
	strategy retry.Strategy,
	query string,
	args ...interface{},
) (sql.Result, error)

ExecWithRetry executes a command with a retry strategy.

func (*DB) QueryContext

func (db *DB) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)

QueryContext executes a query on a slave if available, otherwise on the master.

func (*DB) QueryRowContext

func (db *DB) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row

QueryRowContext executes a single-row query on a slave if available, otherwise on the master.

func (*DB) QueryRowWithRetry

func (db *DB) QueryRowWithRetry(
	ctx context.Context,
	strategy retry.Strategy,
	query string,
	args ...interface{},
) (*sql.Row, error)

QueryRowWithRetry executes a single-row query with a retry strategy.

func (*DB) QueryWithRetry

func (db *DB) QueryWithRetry(
	ctx context.Context,
	strategy retry.Strategy,
	query string,
	args ...interface{},
) (*sql.Rows, error)

QueryWithRetry executes a query with a retry strategy.

func (*DB) WithTx

func (db *DB) WithTx(ctx context.Context, fn func(*sql.Tx) error) error

WithTx executes a function within a transaction on the master database.

func (*DB) WithTxWithRetry

func (db *DB) WithTxWithRetry(
	ctx context.Context,
	strategy retry.Strategy,
	fn func(*sql.Tx) error,
) error

WithTxWithRetry executes a function within a transaction on the master database with retry strategy.

type Options

type Options struct {
	MaxOpenConns    int
	MaxIdleConns    int
	ConnMaxLifetime time.Duration
}

Options defines database connection configuration options.