sql

Documentation

Index

• Constants
• func Query[T any](db *DB, query string, pointers func(*T) []interface{}, args ...any) ([]T, error)
• func QueryContext[T any](ctx context.Context, db *DB, query string, pointers func(*T) []interface{}, ...) ([]T, error)
• type DB
  • func NewDB(driverName string, dsns []string, checker cluster.NodeChecker[*sql.DB], ...) (*DB, error)
  • func (db *DB) DoTx(f func(db dbx.DBxer[*sql.DB, *sql.Tx, *sql.TxOptions]) error, ...) error
  • func (db *DB) DoTxContext(ctx context.Context, ...) error
  • func (db *DB) Exec(query string, args ...any) (sql.Result, error)
  • func (db *DB) ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)
  • func (db *DB) Prepare(query string) (*sql.Stmt, error)
  • func (db *DB) PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
  • func (db *DB) Query(query string, args ...any) (*sql.Rows, error)
  • func (db *DB) QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error)
  • func (db *DB) QueryRow(query string, args ...any) dbx.Row
  • func (db *DB) QueryRowContext(ctx context.Context, query string, args ...any) dbx.Row
  • func (db *DB) Tx() (*sql.Tx, error)
  • func (db *DB) WithDefaultNode(criteria cluster.NodeStateCriteria) *DB
  • func (db *DB) WithReadFromNode(criteria cluster.NodeStateCriteria) *DB
  • func (db *DB) WithWriteToNode(criteria cluster.NodeStateCriteria) *DB
• type DBOpener
• type ErrRow
  • func (r *ErrRow) Err() error
  • func (r *ErrRow) Scan(dest ...any) error
• type Option
  • func WithDBOpener(dbOpener func(driverName, dsn string) (*sql.DB, error)) Option
  • func WithGenericOptions(options ...dbx.Option[*sql.DB]) Option
  • func WithInitPingTimeout(timeout time.Duration) Option

Constants

const DefaultPingTimeout = 15 * time.Second

Functions

func Query

func Query[T any](db *DB, query string,
	pointers func(*T) []interface{}, args ...any) ([]T, error)

Query is a generic query helper.

func QueryContext

func QueryContext[T any](ctx context.Context, db *DB, query string,
	pointers func(*T) []interface{}, args ...any) ([]T, error)

QueryContext is a generic query helper with context.

Types

type DB

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

func NewDB

func NewDB(driverName string, dsns []string,
	checker cluster.NodeChecker[*sql.DB], options ...Option) (*DB, error)

NewDB returns an instance of *DB.

func (*DB) DoTx

func (db *DB) DoTx(f func(db dbx.DBxer[*sql.DB, *sql.Tx, *sql.TxOptions]) error, opts *sql.TxOptions) error

DoTx executes passed function in transaction.

func (*DB) DoTxContext

func (db *DB) DoTxContext(
	ctx context.Context,
	f func(ctx context.Context, db dbx.DBxer[*sql.DB, *sql.Tx, *sql.TxOptions]) error,
	opts *sql.TxOptions) error

DoTxContext executes passed function in transaction.

func (*DB) Exec

func (db *DB) Exec(query string, args ...any) (sql.Result, error)

Exec executes query.

func (*DB) ExecContext

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

ExecContext executes query with context.

func (*DB) Prepare

func (db *DB) Prepare(query string) (*sql.Stmt, error)

Prepare prepares query.

func (*DB) PrepareContext

func (db *DB) PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)

PrepareContext prepares query with context.

func (*DB) Query

func (db *DB) Query(query string, args ...any) (*sql.Rows, error)

Query queries underlying cluster.

func (*DB) QueryContext

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

QueryContext queries underlying cluster with context.

func (*DB) QueryRow

func (db *DB) QueryRow(query string, args ...any) dbx.Row

QueryRow queries row from underlying cluster.

func (*DB) QueryRowContext

func (db *DB) QueryRowContext(ctx context.Context, query string, args ...any) dbx.Row

QueryRowContext queries row from underlying cluster with context.

func (*DB) Tx

func (db *DB) Tx() (*sql.Tx, error)

func (*DB) WithDefaultNode

func (db *DB) WithDefaultNode(criteria cluster.NodeStateCriteria) *DB

func (*DB) WithReadFromNode

func (db *DB) WithReadFromNode(criteria cluster.NodeStateCriteria) *DB

func (*DB) WithWriteToNode

func (db *DB) WithWriteToNode(criteria cluster.NodeStateCriteria) *DB

type DBOpener

type DBOpener func(driverName, dsn string) (*sql.DB, error)

type ErrRow

type ErrRow struct {
	// contains filtered or unexported fields
}

func (*ErrRow) Err

func (r *ErrRow) Err() error

func (*ErrRow) Scan

func (r *ErrRow) Scan(dest ...any) error

type Option

type Option func(db *DB)

func WithDBOpener

func WithDBOpener(dbOpener func(driverName, dsn string) (*sql.DB, error)) Option

func WithGenericOptions

func WithGenericOptions(options ...dbx.Option[*sql.DB]) Option

func WithInitPingTimeout

func WithInitPingTimeout(timeout time.Duration) Option