sqlquerywrapper

Documentation

Index

• type DB
  • func New(db *sql.DB, opts ...Opt) *DB
  • func (db *DB) Begin() (*Tx, error)
  • func (db *DB) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error)
  • func (db *DB) Exec(query string, args ...interface{}) (sql.Result, error)
  • func (db *DB) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
  • func (db *DB) Query(query string, args ...interface{}) (*Rows, error)
  • func (db *DB) QueryContext(ctx context.Context, query string, args ...interface{}) (*Rows, error)
  • func (db *DB) QueryRow(query string, args ...interface{}) *Row
  • func (db *DB) QueryRowContext(ctx context.Context, query string, args ...interface{}) *Row
  • func (db *DB) WithTx(ctx context.Context, fn func(*Tx) error) error
• type Opt
  • func WithKeyAndValues(keyAndValues ...any) Opt
  • func WithLogger(logger logger) Opt
  • func WithQueryTimeout(timeout time.Duration) Opt
  • func WithSecretsRegex(secretsRegex map[string]string) Opt
  • func WithSlowQueryThreshold(slowQueryThreshold time.Duration) Opt
  • func WithStats(stats stats.Stats) Opt
  • func WithTransactionTimeout(timeout time.Duration) Opt
• type Row
  • func (r *Row) Err() error
  • func (r *Row) Scan(dest ...interface{}) error
• type Rows
  • func (r *Rows) Close() error
  • func (r *Rows) Err() error
  • func (r *Rows) Next() bool
  • func (r *Rows) Scan(dest ...interface{}) error
• type Tx
  • func (tx *Tx) Commit() error
  • func (tx *Tx) Exec(query string, args ...interface{}) (sql.Result, error)
  • func (tx *Tx) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
  • func (tx *Tx) GetTx() *sql.Tx
  • func (tx *Tx) Query(query string, args ...interface{}) (*Rows, error)
  • func (tx *Tx) QueryContext(ctx context.Context, query string, args ...interface{}) (*Rows, error)
  • func (tx *Tx) QueryRow(query string, args ...interface{}) *Row
  • func (tx *Tx) QueryRowContext(ctx context.Context, query string, args ...interface{}) *Row
  • func (tx *Tx) Rollback() error

Types

type DB

type DB struct {
	*sql.DB
	// contains filtered or unexported fields
}

func New

func New(db *sql.DB, opts ...Opt) *DB

func (*DB) Begin

func (db *DB) Begin() (*Tx, error)

Begin starts a transaction.

Use BeginTx to pass context and options to the underlying driver.

func (*DB) BeginTx

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

func (*DB) Exec

func (db *DB) Exec(query string, args ...interface{}) (sql.Result, error)

func (*DB) ExecContext

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

func (*DB) Query

func (db *DB) Query(query string, args ...interface{}) (*Rows, error)

func (*DB) QueryContext

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

func (*DB) QueryRow

func (db *DB) QueryRow(query string, args ...interface{}) *Row

func (*DB) QueryRowContext

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

func (*DB) WithTx

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

type Opt

type Opt func(*DB)

func WithKeyAndValues

func WithKeyAndValues(keyAndValues ...any) Opt

func WithLogger

func WithLogger(logger logger) Opt

func WithQueryTimeout

func WithQueryTimeout(timeout time.Duration) Opt

WithQueryTimeout imposes a timeout on each query

func WithSecretsRegex

func WithSecretsRegex(secretsRegex map[string]string) Opt

func WithSlowQueryThreshold

func WithSlowQueryThreshold(slowQueryThreshold time.Duration) Opt

func WithStats

func WithStats(stats stats.Stats) Opt

func WithTransactionTimeout

func WithTransactionTimeout(timeout time.Duration) Opt

WithTransactionTimeout imposes a timeout on the transaction

type Row

type Row struct {
	*sql.Row
	context.CancelFunc
	// contains filtered or unexported fields
}

func (*Row) Err

func (r *Row) Err() error

Err provides a way for wrapping packages to check for query errors without calling Scan.

func (*Row) Scan

func (r *Row) Scan(dest ...interface{}) error

type Rows

type Rows struct {
	*sql.Rows
	context.CancelFunc
	// contains filtered or unexported fields
}

func (*Rows) Close

func (r *Rows) Close() error

func (*Rows) Err

func (r *Rows) Err() error

func (*Rows) Next

func (r *Rows) Next() bool

func (*Rows) Scan

func (r *Rows) Scan(dest ...interface{}) error

type Tx

type Tx struct {
	*sql.Tx

	context.CancelFunc
	// contains filtered or unexported fields
}

func (*Tx) Commit

func (tx *Tx) Commit() error

func (*Tx) Exec

func (tx *Tx) Exec(query string, args ...interface{}) (sql.Result, error)

func (*Tx) ExecContext

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

func (*Tx) GetTx

func (tx *Tx) GetTx() *sql.Tx

func (*Tx) Query

func (tx *Tx) Query(query string, args ...interface{}) (*Rows, error)

func (*Tx) QueryContext

func (tx *Tx) QueryContext(ctx context.Context, query string, args ...interface{}) (*Rows, error)

func (*Tx) QueryRow

func (tx *Tx) QueryRow(query string, args ...interface{}) *Row

func (*Tx) QueryRowContext

func (tx *Tx) QueryRowContext(ctx context.Context, query string, args ...interface{}) *Row

func (*Tx) Rollback

func (tx *Tx) Rollback() error