sql

README

go-x-sql

Improved sql package for go

TODO

• Abstract out mysql/cockroachdb/pg differences
  • X Setting to replace ?, ?, ? with $1, $2, $3 for postgres/cockroachdb
  • Use RETURNING Id to get Id from cockroachdb: https://www.cockroachlabs.com/docs/insert.html#go
  • Improve error handling: see http://go-database-sql.org/errors.html#identifying-specific-database-errors (and use https://github.com/VividCortex/mysqlerr for mysql errors, and pg for pg errors)
  • Allow for INSERT INTO SET col1=?, col2=? in pg/cockroachdb
  • Fix go-x-sql_test.go to share more code for pg and mysql tests

No prepared statements?

No. They cause more problems than they're worth. See http://go-database-sql.org/prepared.html#avoiding-prepared-statements and http://go-database-sql.org/prepared.html#prepared-statements-in-transactions for details.

Documentation

Index

• Variables
• func IsDuplicateEntryError(err error) bool
• type API
• type Db
  • func Connect(driverName, dataSourceString string, dbNamesMapper DbNameConventionMapper) (Db, error)
  • func MustConnect(driverName, dataSourceString string, dbNamesMapper DbNameConventionMapper) Db
• type DbNameConventionMapper
• type Tx
• type TxFn

Variables

var (
	ErrNoRows       = sql.ErrNoRows
	ErrRowsAffected = errors.New("Affected unexpected number of rows")
)

var (
	Must     = must
	MustInt  = mustInt
	MustBool = mustBool

	CheckDest = checkDest
)

var (
	DbNameConventionCamelCase_Capitalized   = func(str string) string { return str }
	DbNameConventionCamelCase_uncapitalized = func(str string) string { return uncapitalize(str) }
	DbNameConvention_under_score            = func(str string) string { return camelCaseTo_under_score(str) }
	DbNameConventionUPPERCASE               = func(str string) string { return toUPPERCASE(str) }
	DbNameConventionUPPER_CASE_UNDER_SCORE  = func(str string) string { return toUPPERCASE(camelCaseTo_under_score(str)) }
)

Functions

func IsDuplicateEntryError

func IsDuplicateEntryError(err error) bool

Types

type API

type API interface {
	Select(dest interface{}, query string, args ...interface{}) error
	SelectOne(dest interface{}, query string, args ...interface{}) error
	SelectOneMaybe(dest interface{}, query string, args ...interface{}) (bool, error)
	InsertAndGetId(query string, args ...interface{}) (id int64, err error)
	InsertIgnoreId(query string, args ...interface{}) error
	InsertIgnoreDuplicate(query string, args ...interface{}) (bool, error)
	Update(query string, args ...interface{}) (rowsAffected int64, err error)
	UpdateOne(query string, args ...interface{}) error
	UpdateNum(expectedRowsAffected int64, query string, args ...interface{}) error
	Exec(query string, args ...interface{}) error
	MustExec(query string, args ...interface{})
}

type Db

type Db interface {
	API
	SetDatabase(db string) error
	Transact(TxFn) error
}

func Connect

func Connect(driverName, dataSourceString string, dbNamesMapper DbNameConventionMapper) (Db, error)

func MustConnect

func MustConnect(driverName, dataSourceString string, dbNamesMapper DbNameConventionMapper) Db

type DbNameConventionMapper

type DbNameConventionMapper func(goCamelCaseName string) (dbColumnName string)

DbNameConventionMapper is a function that takes a go struct field name and returns its corresponding database column name.

type Tx

type Tx interface {
	API
}

type TxFn

type TxFn func(tx Tx) error