sqlz

Documentation

Index

• Variables
• func MustBeginTx(ctx context.Context, db sqlTxBeginner, opts *sql.TxOptions) *sql.Tx
• func MustOpenContext(ctx context.Context, driverName string, dataSourceName string) *sql.DB
• func OpenContext(ctx context.Context, driverName string, dataSourceName string) (*sql.DB, error)
• func ScanRows(rows sqlRows, structTag string, dst interface{}) error
• type NewDBOption
  • func WithNewDBOptionStructTag(structTag string) NewDBOption
• type QueryerContext
  • func NewDB(db sqlQueryerContext, opts ...NewDBOption) QueryerContext

Variables

var (
	ErrMustBePointer        = errors.New("sql: must be pointer")
	ErrMustNotNil           = errors.New("sql: must not nil")
	ErrDataTypeNotSupported = errors.New("sql: data type not supported")
)

Functions

func MustBeginTx

func MustBeginTx(ctx context.Context, db sqlTxBeginner, opts *sql.TxOptions) *sql.Tx

func MustOpenContext

func MustOpenContext(ctx context.Context, driverName string, dataSourceName string) *sql.DB

func OpenContext

func OpenContext(ctx context.Context, driverName string, dataSourceName string) (*sql.DB, error)

func ScanRows

func ScanRows(rows sqlRows, structTag string, dst interface{}) error

ScanRows scans rows to dst.

structTag is used to get column names from struct tags.

dst must be a pointer. If dst is a pointer to a struct or a slice of struct, column names are got from structTag. If dst is a pointer to a slice of primitive, ignore structTag.

Types

type NewDBOption

type NewDBOption interface {
	// contains filtered or unexported methods
}

func WithNewDBOptionStructTag

func WithNewDBOptionStructTag(structTag string) NewDBOption

type QueryerContext

type QueryerContext interface {
	// QueryContext executes a query that returns rows, typically a SELECT.
	//
	// The dst must be a pointer.
	// The args are for any placeholder parameters in the query.
	QueryContext(ctx context.Context, dst interface{}, query string, args ...interface{}) error
	// QueryRowContext executes a query that is expected to return at most one row.
	// It always returns a non-nil value or an error.
	//
	// The dst must be a pointer.
	// The args are for any placeholder parameters in the query.
	QueryRowContext(ctx context.Context, dst interface{}, query string, args ...interface{}) error
}

func NewDB

func NewDB(db sqlQueryerContext, opts ...NewDBOption) QueryerContext