sdksql

Documentation

Index

• Variables
• func ArrayPostgreSQL(array any) interface{ ... }
• func Discard() any
• func Open(dsn string) (*sql.DB, error)
• type BeginTx
• type Conn
  • func RoundRobin(conns ...Conn) Conn
• type ExecContext
• type MismatchColumnsError
  • func (err *MismatchColumnsError) Error() string
• type PingContext
• type PrepareContext
• type QueryContext
• type QueryRowContext
• type RoundRobinError
  • func (err *RoundRobinError) Error() string
• type TxConn
• type WrapExec
• type WrapQuery
• type WrapQueryRow
• type WrapTransaction

Variables

var (
	ErrInvalidCommand   = sdk.Errorf("brock/sdksql: invalid command")
	ErrMultipleCommands = sdk.Errorf("brock/sdksql: multiple commands")
)

var (
	ErrInvalidArguments   = sdk.Errorf("brock/sdksql: invalid arguments for scan")
	ErrInvalidTransaction = sdk.Errorf("brock/sdksql: invalid transaction")
	ErrNoColumns          = sdk.Errorf("brock/sdksql: no columns returned")
)

var Tool tool

var Wrap wrap

Functions

func ArrayPostgreSQL

func ArrayPostgreSQL(array any) interface {
	driver.Valuer
	sql.Scanner
}

func Discard

func Discard() any

func Open

func Open(dsn string) (*sql.DB, error)

Types

type BeginTx

type BeginTx interface {
	BeginTx(ctx context.Context, opts *sql.TxOptions) (tx *sql.Tx, err error)
}

type Conn

type Conn interface {
	BeginTx
	io.Closer
	PingContext
	TxConn
}

Conn is a common interface of *sql.DB and *sql.Conn.

func RoundRobin

func RoundRobin(conns ...Conn) Conn

type ExecContext

type ExecContext interface {
	ExecContext(ctx context.Context, query string, args ...any) (res sql.Result, err error)
}

type MismatchColumnsError

type MismatchColumnsError struct{ Col, Dst int }

func (*MismatchColumnsError) Error

func (err *MismatchColumnsError) Error() string

type PingContext

type PingContext interface {
	PingContext(ctx context.Context) (err error)
}

type PrepareContext

type PrepareContext interface {
	PrepareContext(ctx context.Context, query string) (stmt *sql.Stmt, err error)
}

type QueryContext

type QueryContext interface {
	QueryContext(ctx context.Context, query string, args ...any) (rows *sql.Rows, err error)
}

type QueryRowContext

type QueryRowContext interface {
	QueryRowContext(ctx context.Context, query string, args ...any) (row *sql.Row)
}

type RoundRobinError

type RoundRobinError struct{ Total, Index int }

RoundRobinError reporting issue when getting from set of Conn from RoundRobin.

func (*RoundRobinError) Error

func (err *RoundRobinError) Error() string

type TxConn

type TxConn interface {
	ExecContext
	PrepareContext
	QueryContext
	QueryRowContext
}

TxConn is a common interface of *sql.DB, *sql.Conn, and *sql.Tx.

type WrapExec

type WrapExec interface {
	// Scan the result of ExecContext that usually return numbers of rowsAffected
	// and lastInsertID.
	Scan(rowsAffected *int, lastInsertID *int) error
}

type WrapQuery

type WrapQuery interface {
	// Scan accept do, a func that accept `i int` as index and returning list
	// of pointers.
	//  pointers == nil   // break the loop
	//  len(pointers) < 1 // skip the current loop
	//  len(pointers) > 0 // assign the pointer, MUST be same as the length of columns
	Scan(row func(i int) (pointers []any)) error
}

type WrapQueryRow

type WrapQueryRow interface {
	Scan(dest ...any) error
	Err() error
}

type WrapTransaction

type WrapTransaction interface {
	// Do the transaction and ends it with either COMMIT or ROLLBACK
	Do(tx func() error) error
}