Documentation ¶
Overview ¶
Package sqlx provides general purpose extensions to database/sql.
It is intended to seamlessly wrap database/sql and provide convenience methods which are useful in the development of database driven applications. None of the underlying database/sql methods are changed. Instead all extended behavior is implemented through new methods defined on wrapper types.
Additions include scanning into structs, named query support, rebinding queries for different drivers, convenient shorthands for common error handling and more.
Index ¶
- Constants
- Variables
- func BindDriver(driverName string, bindType int)
- func BindNamed(bindType int, query string, arg interface{}) (string, []interface{}, error)
- func BindType(driverName string) int
- func Get(q Queryer, dest interface{}, query string, args ...interface{}) error
- func GetContext(ctx context.Context, q QueryerContext, dest interface{}, query string, ...) error
- func In(query string, args ...interface{}) (string, []interface{}, error)
- func LoadFile(e Execer, path string) (*sql.Result, error)
- func LoadFileContext(ctx context.Context, e ExecerContext, path string) (*sql.Result, error)
- func MapScan(r ColScanner, dest map[string]interface{}) error
- func MustExec(e Execer, query string, args ...interface{}) sql.Result
- func MustExecContext(ctx context.Context, e ExecerContext, query string, args ...interface{}) sql.Result
- func Named(query string, arg interface{}) (string, []interface{}, error)
- func NamedExec(e Ext, query string, arg interface{}) (sql.Result, error)
- func NamedExecContext(ctx context.Context, e ExtContext, query string, arg interface{}) (sql.Result, error)
- func NamedGet(e Ext, dest interface{}, query string, arg interface{}) error
- func NamedGetContext(ctx context.Context, e ExtContext, dest interface{}, query string, ...) error
- func NamedSelect(e Ext, dest interface{}, query string, arg interface{}) error
- func NamedSelectContext(ctx context.Context, e ExtContext, dest interface{}, query string, ...) error
- func NewDefaultLog(l Level) *defaultLog
- func Rebind(bindType int, query string) string
- func Select(q Queryer, dest interface{}, query string, args ...interface{}) error
- func SelectContext(ctx context.Context, q QueryerContext, dest interface{}, query string, ...) error
- func SetLog(lg Log)
- func SliceScan(r ColScanner) ([]interface{}, error)
- func StructScan(rows rowsi, dest interface{}) error
- type ColScanner
- type Conn
- func (c *Conn) BeginTxx(ctx context.Context, opts *sql.TxOptions) (*Tx, error)
- func (c *Conn) GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
- func (c *Conn) PreparexContext(ctx context.Context, query string) (*Stmt, error)
- func (c *Conn) QueryRowxContext(ctx context.Context, query string, args ...interface{}) *Row
- func (c *Conn) QueryxContext(ctx context.Context, query string, args ...interface{}) (*Rows, error)
- func (c *Conn) Rebind(query string) string
- func (c *Conn) SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
- type DB
- func Connect(driverName, dataSourceName string) (*DB, error)
- func ConnectContext(ctx context.Context, driverName, dataSourceName string) (*DB, error)
- func MustConnect(driverName, dataSourceName string) *DB
- func MustOpen(driverName, dataSourceName string) *DB
- func NewDb(db *sql.DB, driverName string) *DB
- func Open(driverName, dataSourceName string) (*DB, error)
- func (db *DB) BeginTxx(ctx context.Context, opts *sql.TxOptions) (*Tx, error)
- func (db *DB) Beginx() (*Tx, error)
- func (db *DB) BindNamed(query string, arg interface{}) (string, []interface{}, error)
- func (db *DB) Connx(ctx context.Context) (*Conn, error)
- func (db *DB) DriverName() string
- func (db *DB) Get(dest interface{}, query string, args ...interface{}) error
- func (db *DB) GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
- func (db *DB) MapperFunc(mf func(string) string)
- func (db *DB) MustBegin() *Tx
- func (db *DB) MustBeginTx(ctx context.Context, opts *sql.TxOptions) *Tx
- func (db *DB) MustExec(query string, args ...interface{}) sql.Result
- func (db *DB) MustExecContext(ctx context.Context, query string, args ...interface{}) sql.Result
- func (db *DB) NamedExec(query string, arg interface{}) (sql.Result, error)
- func (db *DB) NamedExecContext(ctx context.Context, query string, arg interface{}) (sql.Result, error)
- func (db *DB) NamedGet(dest interface{}, query string, arg interface{}) error
- func (db *DB) NamedGetContext(ctx context.Context, dest interface{}, query string, arg interface{}) error
- func (db *DB) NamedQuery(query string, arg interface{}) (*Rows, error)
- func (db *DB) NamedQueryContext(ctx context.Context, query string, arg interface{}) (*Rows, error)
- func (db *DB) NamedSelect(dest interface{}, query string, arg interface{}) error
- func (db *DB) NamedSelectContext(ctx context.Context, dest interface{}, query string, arg interface{}) error
- func (db *DB) NamedSelectPage(dest interface{}, total *int64, query string, arg interface{}, page *Page) error
- func (db *DB) NamedSelectPageContext(ctx context.Context, dest interface{}, total *int64, query string, ...) error
- func (db *DB) PrepareNamed(query string) (*NamedStmt, error)
- func (db *DB) PrepareNamedContext(ctx context.Context, query string) (*NamedStmt, error)
- func (db *DB) Preparex(query string) (*Stmt, error)
- func (db *DB) PreparexContext(ctx context.Context, query string) (*Stmt, error)
- func (db *DB) QueryRowx(query string, args ...interface{}) *Row
- func (db *DB) QueryRowxContext(ctx context.Context, query string, args ...interface{}) *Row
- func (db *DB) Queryx(query string, args ...interface{}) (*Rows, error)
- func (db *DB) QueryxContext(ctx context.Context, query string, args ...interface{}) (*Rows, error)
- func (db *DB) Rebind(query string) string
- func (db *DB) Select(dest interface{}, query string, args ...interface{}) error
- func (db *DB) SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
- func (db *DB) Unsafe() *DB
- type Execer
- type ExecerContext
- type Ext
- type ExtContext
- type Level
- type Log
- type NamedStmt
- func (n *NamedStmt) Close() error
- func (n *NamedStmt) Exec(arg interface{}) (sql.Result, error)
- func (n *NamedStmt) ExecContext(ctx context.Context, arg interface{}) (sql.Result, error)
- func (n *NamedStmt) Get(dest interface{}, arg interface{}) error
- func (n *NamedStmt) GetContext(ctx context.Context, dest interface{}, arg interface{}) error
- func (n *NamedStmt) MustExec(arg interface{}) sql.Result
- func (n *NamedStmt) MustExecContext(ctx context.Context, arg interface{}) sql.Result
- func (n *NamedStmt) Query(arg interface{}) (*sql.Rows, error)
- func (n *NamedStmt) QueryContext(ctx context.Context, arg interface{}) (*sql.Rows, error)
- func (n *NamedStmt) QueryRow(arg interface{}) *Row
- func (n *NamedStmt) QueryRowContext(ctx context.Context, arg interface{}) *Row
- func (n *NamedStmt) QueryRowx(arg interface{}) *Row
- func (n *NamedStmt) QueryRowxContext(ctx context.Context, arg interface{}) *Row
- func (n *NamedStmt) Queryx(arg interface{}) (*Rows, error)
- func (n *NamedStmt) QueryxContext(ctx context.Context, arg interface{}) (*Rows, error)
- func (n *NamedStmt) Select(dest interface{}, arg interface{}) error
- func (n *NamedStmt) SelectContext(ctx context.Context, dest interface{}, arg interface{}) error
- func (n *NamedStmt) Unsafe() *NamedStmt
- type Page
- type Preparer
- type PreparerContext
- type Queryer
- type QueryerContext
- type Row
- func (r *Row) ColumnTypes() ([]*sql.ColumnType, error)
- func (r *Row) Columns() ([]string, error)
- func (r *Row) Err() error
- func (r *Row) MapScan(dest map[string]interface{}) error
- func (r *Row) Scan(dest ...interface{}) error
- func (r *Row) SliceScan() ([]interface{}, error)
- func (r *Row) StructScan(dest interface{}) error
- type Rows
- type Sqly
- type SqlyContext
- type Stmt
- func (s *Stmt) Get(dest interface{}, args ...interface{}) error
- func (s *Stmt) GetContext(ctx context.Context, dest interface{}, args ...interface{}) error
- func (s *Stmt) MustExec(args ...interface{}) sql.Result
- func (s *Stmt) MustExecContext(ctx context.Context, args ...interface{}) sql.Result
- func (s *Stmt) QueryRowx(args ...interface{}) *Row
- func (s *Stmt) QueryRowxContext(ctx context.Context, args ...interface{}) *Row
- func (s *Stmt) Queryx(args ...interface{}) (*Rows, error)
- func (s *Stmt) QueryxContext(ctx context.Context, args ...interface{}) (*Rows, error)
- func (s *Stmt) Select(dest interface{}, args ...interface{}) error
- func (s *Stmt) SelectContext(ctx context.Context, dest interface{}, args ...interface{}) error
- func (s *Stmt) Unsafe() *Stmt
- type Tx
- func (tx *Tx) BindNamed(query string, arg interface{}) (string, []interface{}, error)
- func (tx *Tx) DriverName() string
- func (tx *Tx) Get(dest interface{}, query string, args ...interface{}) error
- func (tx *Tx) GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
- func (tx *Tx) MustExec(query string, args ...interface{}) sql.Result
- func (tx *Tx) MustExecContext(ctx context.Context, query string, args ...interface{}) sql.Result
- func (tx *Tx) NamedExec(query string, arg interface{}) (sql.Result, error)
- func (tx *Tx) NamedExecContext(ctx context.Context, query string, arg interface{}) (sql.Result, error)
- func (tx *Tx) NamedGet(dest interface{}, query string, arg interface{}) error
- func (tx *Tx) NamedGetContext(ctx context.Context, dest interface{}, query string, arg interface{}) error
- func (tx *Tx) NamedQuery(query string, arg interface{}) (*Rows, error)
- func (tx *Tx) NamedQueryContext(ctx context.Context, query string, arg interface{}) (*Rows, error)
- func (tx *Tx) NamedSelect(dest interface{}, query string, arg interface{}) error
- func (tx *Tx) NamedSelectContext(ctx context.Context, dest interface{}, query string, arg interface{}) error
- func (tx *Tx) NamedSelectPage(dest interface{}, total *int64, query string, arg interface{}, page *Page) error
- func (tx *Tx) NamedSelectPageContext(ctx context.Context, dest interface{}, total *int64, query string, ...) error
- func (tx *Tx) NamedStmt(stmt *NamedStmt) *NamedStmt
- func (tx *Tx) NamedStmtContext(ctx context.Context, stmt *NamedStmt) *NamedStmt
- func (tx *Tx) PrepareNamed(query string) (*NamedStmt, error)
- func (tx *Tx) PrepareNamedContext(ctx context.Context, query string) (*NamedStmt, error)
- func (tx *Tx) Preparex(query string) (*Stmt, error)
- func (tx *Tx) PreparexContext(ctx context.Context, query string) (*Stmt, error)
- func (tx *Tx) QueryRowx(query string, args ...interface{}) *Row
- func (tx *Tx) QueryRowxContext(ctx context.Context, query string, args ...interface{}) *Row
- func (tx *Tx) Queryx(query string, args ...interface{}) (*Rows, error)
- func (tx *Tx) QueryxContext(ctx context.Context, query string, args ...interface{}) (*Rows, error)
- func (tx *Tx) Rebind(query string) string
- func (tx *Tx) Select(dest interface{}, query string, args ...interface{}) error
- func (tx *Tx) SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
- func (tx *Tx) Stmtx(stmt interface{}) *Stmt
- func (tx *Tx) StmtxContext(ctx context.Context, stmt interface{}) *Stmt
- func (tx *Tx) Unsafe() *Tx
Constants ¶
const ( UNKNOWN = iota QUESTION DOLLAR NAMED AT )
Bindvar types supported by Rebind, BindMap and BindStruct.
Variables ¶
var NameMapper = strings.ToLower
NameMapper is used to map column names to struct field names. By default, it uses strings.ToLower to lowercase struct field names. It can be set to whatever you want, but it is encouraged to be set before sqlx is used as name-to-field mappings are cached after first use on a type.
Functions ¶
func BindDriver ¶
BindDriver sets the BindType for driverName to bindType.
func BindNamed ¶
BindNamed binds a struct or a map to a query with named parameters. DEPRECATED: use sqlx.Named` instead of this, it may be removed in future.
func Get ¶
Get does a QueryRow using the provided Queryer, and scans the resulting row to dest. If dest is scannable, the result must only have one column. Otherwise, StructScan is used. Get will return sql.ErrNoRows like row.Scan would. Any placeholder parameters are replaced with supplied args. An error is returned if the result set is empty.
func GetContext ¶
func GetContext(ctx context.Context, q QueryerContext, dest interface{}, query string, args ...interface{}) error
GetContext does a QueryRow using the provided Queryer, and scans the resulting row to dest. If dest is scannable, the result must only have one column. Otherwise, StructScan is used. Get will return sql.ErrNoRows like row.Scan would. Any placeholder parameters are replaced with supplied args. An error is returned if the result set is empty.
func In ¶
In expands slice values in args, returning the modified query string and a new arg list that can be executed by a database. The `query` should use the `?` bindVar. The return value uses the `?` bindVar.
func LoadFile ¶
LoadFile exec's every statement in a file (as a single call to Exec). LoadFile may return a nil *sql.Result if errors are encountered locating or reading the file at path. LoadFile reads the entire file into memory, so it is not suitable for loading large data dumps, but can be useful for initializing schemas or loading indexes.
FIXME: this does not really work with multi-statement files for mattn/go-sqlite3 or the go-mysql-driver/mysql drivers; pq seems to be an exception here. Detecting this by requiring something with DriverName() and then attempting to split the queries will be difficult to get right, and its current driver-specific behavior is deemed at least not complex in its incorrectness.
func LoadFileContext ¶
LoadFileContext exec's every statement in a file (as a single call to Exec). LoadFileContext may return a nil *sql.Result if errors are encountered locating or reading the file at path. LoadFile reads the entire file into memory, so it is not suitable for loading large data dumps, but can be useful for initializing schemas or loading indexes.
FIXME: this does not really work with multi-statement files for mattn/go-sqlite3 or the go-mysql-driver/mysql drivers; pq seems to be an exception here. Detecting this by requiring something with DriverName() and then attempting to split the queries will be difficult to get right, and its current driver-specific behavior is deemed at least not complex in its incorrectness.
func MapScan ¶
func MapScan(r ColScanner, dest map[string]interface{}) error
MapScan scans a single Row into the dest map[string]interface{}. Use this to get results for SQL that might not be under your control (for instance, if you're building an interface for an SQL server that executes SQL from input). Please do not use this as a primary interface! This will modify the map sent to it in place, so reuse the same map with care. Columns which occur more than once in the result will overwrite each other!
func MustExec ¶
MustExec execs the query using e and panics if there was an error. Any placeholder parameters are replaced with supplied args.
func MustExecContext ¶
func MustExecContext(ctx context.Context, e ExecerContext, query string, args ...interface{}) sql.Result
MustExecContext execs the query using e and panics if there was an error. Any placeholder parameters are replaced with supplied args.
func Named ¶
Named takes a query using named parameters and an argument and returns a new query with a list of args that can be executed by a database. The return value uses the `?` bindvar.
func NamedExec ¶
NamedExec uses BindStruct to get a query executable by the driver and then runs Exec on the result. Returns an error from the binding or the query execution itself.
func NamedExecContext ¶
func NamedExecContext(ctx context.Context, e ExtContext, query string, arg interface{}) (sql.Result, error)
NamedExecContext uses BindStruct to get a query executable by the driver and then runs Exec on the result. Returns an error from the binding or the query execution itself.
func NamedGet ¶
NamedGet binds a named query and then runs Query on the result using the provided Ext (sqlx.Tx, sql.DB) and StructScan the row into dest. The *sql.Rows are closed automatically.
func NamedGetContext ¶
func NamedGetContext(ctx context.Context, e ExtContext, dest interface{}, query string, arg interface{}) error
NamedGetContext binds a named query and then runs Query on the result using the provided Ext (sqlx.Tx, sql.DB) and StructScan the row into dest. The *sql.Rows are closed automatically.
func NamedSelect ¶
NamedSelect binds a named query and then runs Query on the result using the provided Ext (sqlx.Tx, sql.DB) and StructScans each row into dest, which must be a slice. If the slice elements are scannable, then the result set must have only one column. Otherwise, StructScan is used. The *sql.Rows are closed automatically.
func NamedSelectContext ¶
func NamedSelectContext(ctx context.Context, e ExtContext, dest interface{}, query string, arg interface{}) error
NamedSelectContext binds a named query and then runs Query on the result using the provided Ext (sqlx.Tx, sql.DB) and StructScans each row into dest, which must be a slice. If the slice elements are scannable, then the result set must have only one column. Otherwise, StructScan is used. The *sql.Rows are closed automatically.
func NewDefaultLog ¶
func NewDefaultLog(l Level) *defaultLog
func Select ¶
Select executes a query using the provided Queryer, and StructScans each row into dest, which must be a slice. If the slice elements are scannable, then the result set must have only one column. Otherwise, StructScan is used. The *sql.Rows are closed automatically. Any placeholder parameters are replaced with supplied args.
func SelectContext ¶
func SelectContext(ctx context.Context, q QueryerContext, dest interface{}, query string, args ...interface{}) error
SelectContext executes a query using the provided Queryer, and StructScans each row into dest, which must be a slice. If the slice elements are scannable, then the result set must have only one column. Otherwise, StructScan is used. The *sql.Rows are closed automatically. Any placeholder parameters are replaced with supplied args.
func SliceScan ¶
func SliceScan(r ColScanner) ([]interface{}, error)
SliceScan a row, returning a []interface{} with values similar to MapScan. This function is primarily intended for use where the number of columns is not known. Because you can pass an []interface{} directly to Scan, it's recommended that you do that as it will not have to allocate new slices per row.
func StructScan ¶
func StructScan(rows rowsi, dest interface{}) error
StructScan all rows from an sql.Rows or an sqlx.Rows into the dest slice. StructScan will scan in the entire rows result, so if you do not want to allocate structs for the entire result, use Queryx and see sqlx.Rows.StructScan. If rows is sqlx.Rows, it will use its mapper, otherwise it will use the default.
Types ¶
type ColScanner ¶
type ColScanner interface { Columns() ([]string, error) Scan(dest ...interface{}) error Err() error }
ColScanner is an interface used by MapScan and SliceScan
type Conn ¶
Conn is a wrapper around sql.Conn with extra functionality
func (*Conn) BeginTxx ¶
BeginTxx begins a transaction and returns an *sqlx.Tx instead of an *sql.Tx.
The provided context is used until the transaction is committed or rolled back. If the context is canceled, the sql package will roll back the transaction. Tx.Commit will return an error if the context provided to BeginxContext is canceled.
func (*Conn) GetContext ¶
func (c *Conn) GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
GetContext using this Conn. Any placeholder parameters are replaced with supplied args. An error is returned if the result set is empty.
func (*Conn) PreparexContext ¶
PreparexContext returns an sqlx.Stmt instead of a sql.Stmt.
The provided context is used for the preparation of the statement, not for the execution of the statement.
func (*Conn) QueryRowxContext ¶
QueryRowxContext queries the database and returns an *sqlx.Row. Any placeholder parameters are replaced with supplied args.
func (*Conn) QueryxContext ¶
QueryxContext queries the database and returns an *sqlx.Rows. Any placeholder parameters are replaced with supplied args.
type DB ¶
DB is a wrapper around sql.DB which keeps track of the driverName upon Open, used mostly to automatically bind named queries using the right bindvars.
func ConnectContext ¶
ConnectContext to a database and verify with a ping.
func MustConnect ¶
MustConnect connects to a database and panics on error.
func MustOpen ¶
MustOpen is the same as sql.Open, but returns an *sqlx.DB instead and panics on error.
func NewDb ¶
NewDb returns a new sqlx DB wrapper for a pre-existing *sql.DB. The driverName of the original database is required for named query support.
func (*DB) BeginTxx ¶
BeginTxx begins a transaction and returns an *sqlx.Tx instead of an *sql.Tx.
The provided context is used until the transaction is committed or rolled back. If the context is canceled, the sql package will roll back the transaction. Tx.Commit will return an error if the context provided to BeginxContext is canceled.
func (*DB) DriverName ¶
DriverName returns the driverName passed to the Open function for this DB.
func (*DB) Get ¶
Get using this DB. Any placeholder parameters are replaced with supplied args. An error is returned if the result set is empty.
func (*DB) GetContext ¶
func (db *DB) GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
GetContext using this DB. Any placeholder parameters are replaced with supplied args. An error is returned if the result set is empty.
func (*DB) MapperFunc ¶
MapperFunc sets a new mapper for this db using the default sqlx struct tag and the provided mapper function.
func (*DB) MustBegin ¶
MustBegin starts a transaction, and panics on error. Returns an *sqlx.Tx instead of an *sql.Tx.
func (*DB) MustBeginTx ¶
MustBeginTx starts a transaction, and panics on error. Returns an *sqlx.Tx instead of an *sql.Tx.
The provided context is used until the transaction is committed or rolled back. If the context is canceled, the sql package will roll back the transaction. Tx.Commit will return an error if the context provided to MustBeginContext is canceled.
func (*DB) MustExec ¶
MustExec (panic) runs MustExec using this database. Any placeholder parameters are replaced with supplied args.
func (*DB) MustExecContext ¶
MustExecContext (panic) runs MustExec using this database. Any placeholder parameters are replaced with supplied args.
func (*DB) NamedExec ¶
NamedExec using this DB. Any named placeholder parameters are replaced with fields from arg.
func (*DB) NamedExecContext ¶
func (db *DB) NamedExecContext(ctx context.Context, query string, arg interface{}) (sql.Result, error)
NamedExecContext using this DB. Any named placeholder parameters are replaced with fields from arg.
func (*DB) NamedGet ¶
NamedGet using this DB. Any named placeholder parameters are replaced with fields from arg. An error is returned if the result set is empty.
func (*DB) NamedGetContext ¶
func (db *DB) NamedGetContext(ctx context.Context, dest interface{}, query string, arg interface{}) error
NamedGetContext using this DB. Any named placeholder parameters are replaced with fields from arg. An error is returned if the result set is empty.
func (*DB) NamedQuery ¶
NamedQuery using this DB. Any named placeholder parameters are replaced with fields from arg.
func (*DB) NamedQueryContext ¶
NamedQueryContext using this DB. Any named placeholder parameters are replaced with fields from arg.
func (*DB) NamedSelect ¶
NamedSelect using this DB. Any named placeholder parameters are replaced with fields from arg.
func (*DB) NamedSelectContext ¶
func (db *DB) NamedSelectContext(ctx context.Context, dest interface{}, query string, arg interface{}) error
NamedSelectContext using this DB. Any named placeholder parameters are replaced with fields from arg.
func (*DB) NamedSelectPage ¶
func (db *DB) NamedSelectPage(dest interface{}, total *int64, query string, arg interface{}, page *Page) error
NamedSelectPage using this DB. Any named placeholder parameters are replaced with fields from arg.
func (*DB) NamedSelectPageContext ¶
func (db *DB) NamedSelectPageContext(ctx context.Context, dest interface{}, total *int64, query string, arg interface{}, page *Page) error
NamedSelectPageContext using this DB. Any named placeholder parameters are replaced with fields from arg.
func (*DB) PrepareNamed ¶
PrepareNamed returns an sqlx.NamedStmt
func (*DB) PrepareNamedContext ¶
PrepareNamedContext returns an sqlx.NamedStmt
func (*DB) PreparexContext ¶
PreparexContext returns an sqlx.Stmt instead of a sql.Stmt.
The provided context is used for the preparation of the statement, not for the execution of the statement.
func (*DB) QueryRowx ¶
QueryRowx queries the database and returns an *sqlx.Row. Any placeholder parameters are replaced with supplied args.
func (*DB) QueryRowxContext ¶
QueryRowxContext queries the database and returns an *sqlx.Row. Any placeholder parameters are replaced with supplied args.
func (*DB) Queryx ¶
Queryx queries the database and returns an *sqlx.Rows. Any placeholder parameters are replaced with supplied args.
func (*DB) QueryxContext ¶
QueryxContext queries the database and returns an *sqlx.Rows. Any placeholder parameters are replaced with supplied args.
func (*DB) Select ¶
Select using this DB. Any placeholder parameters are replaced with supplied args.
type ExecerContext ¶
type ExecerContext interface {
ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
}
ExecerContext is an interface used by MustExecContext and LoadFileContext
type Ext ¶
Ext is a union interface which can bind, query, and exec, used by NamedQuery and NamedExec.
type ExtContext ¶
type ExtContext interface { QueryerContext ExecerContext // contains filtered or unexported methods }
ExtContext is a union interface which can bind, query, and exec, with Context used by NamedQueryContext and NamedExecContext.
type NamedStmt ¶
NamedStmt is a prepared statement that executes named queries. Prepare it how you would execute a NamedQuery, but pass in a struct or map when executing.
func (*NamedStmt) Exec ¶
Exec executes a named statement using the struct passed. Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) ExecContext ¶
ExecContext executes a named statement using the struct passed. Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) Get ¶
Get using this NamedStmt Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) GetContext ¶
GetContext using this NamedStmt Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) MustExec ¶
MustExec execs a NamedStmt, panicing on error Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) MustExecContext ¶
MustExecContext execs a NamedStmt, panicing on error Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) Query ¶
Query executes a named statement using the struct argument, returning rows. Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) QueryContext ¶
QueryContext executes a named statement using the struct argument, returning rows. Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) QueryRow ¶
QueryRow executes a named statement against the database. Because sqlx cannot create a *sql.Row with an error condition pre-set for binding errors, sqlx returns a *sqlx.Row instead. Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) QueryRowContext ¶
QueryRowContext executes a named statement against the database. Because sqlx cannot create a *sql.Row with an error condition pre-set for binding errors, sqlx returns a *sqlx.Row instead. Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) QueryRowx ¶
QueryRowx this NamedStmt. Because of limitations with QueryRow, this is an alias for QueryRow. Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) QueryRowxContext ¶
QueryRowxContext this NamedStmt. Because of limitations with QueryRow, this is an alias for QueryRow. Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) Queryx ¶
Queryx using this NamedStmt Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) QueryxContext ¶
QueryxContext using this NamedStmt Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) Select ¶
Select using this NamedStmt Any named placeholder parameters are replaced with fields from arg.
func (*NamedStmt) SelectContext ¶
SelectContext using this NamedStmt Any named placeholder parameters are replaced with fields from arg.
type PreparerContext ¶
type PreparerContext interface {
PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
}
PreparerContext is an interface used by PreparexContext.
type Queryer ¶
type Queryer interface { Query(query string, args ...interface{}) (*sql.Rows, error) Queryx(query string, args ...interface{}) (*Rows, error) QueryRowx(query string, args ...interface{}) *Row }
Queryer is an interface used by Get and Select
type QueryerContext ¶
type QueryerContext interface { QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) QueryxContext(ctx context.Context, query string, args ...interface{}) (*Rows, error) QueryRowxContext(ctx context.Context, query string, args ...interface{}) *Row }
QueryerContext is an interface used by GetContext and SelectContext
type Row ¶
Row is a reimplementation of sql.Row in order to gain access to the underlying sql.Rows.Columns() data, necessary for StructScan.
func (*Row) ColumnTypes ¶
func (r *Row) ColumnTypes() ([]*sql.ColumnType, error)
ColumnTypes returns the underlying sql.Rows.ColumnTypes(), or the deferred error
func (*Row) Columns ¶
Columns returns the underlying sql.Rows.Columns(), or the deferred error usually returned by Row.Scan()
func (*Row) Scan ¶
Scan is a fixed implementation of sql.Row.Scan, which does not discard the underlying error from the internal rows object if it exists.
func (*Row) StructScan ¶
StructScan a single Row into dest.
type Rows ¶
Rows is a wrapper around sql.Rows which caches costly reflect operations during a looped StructScan
func NamedQuery ¶
NamedQuery binds a named query and then runs Query on the result using the provided Ext (sqlx.Tx, sqlx.Db). It works with both structs and with map[string]interface{} types.
func NamedQueryContext ¶
func NamedQueryContext(ctx context.Context, e ExtContext, query string, arg interface{}) (*Rows, error)
NamedQueryContext binds a named query and then runs Query on the result using the provided Ext (sqlx.Tx, sqlx.Db). It works with both structs and with map[string]interface{} types.
func (*Rows) StructScan ¶
StructScan is like sql.Rows.Scan, but scans a single Row into a single Struct. Use this and iterate over Rows manually when the memory load of Select() might be prohibitive. *Rows.StructScan caches the reflect work of matching up column positions to fields to avoid that overhead per scan, which means it is not safe to run StructScan on the same Rows instance with different struct types.
type Sqly ¶
type Sqly interface { NamedExec(query string, arg interface{}) (sql.Result, error) Exec(query string, args ...interface{}) (sql.Result, error) NamedQuery(query string, arg interface{}) (*Rows, error) Select(dest interface{}, query string, args ...interface{}) error NamedSelect(dest interface{}, query string, arg interface{}) error Get(dest interface{}, query string, args ...interface{}) error NamedGet(dest interface{}, query string, args interface{}) error NamedSelectPage(dest interface{}, total *int64, query string, arg interface{}, page *Page) error }
type SqlyContext ¶
type SqlyContext interface { NamedExecContext(ctx context.Context, query string, arg interface{}) (sql.Result, error) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) NamedQueryContext(ctx context.Context, query string, arg interface{}) (*Rows, error) SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error NamedSelectContext(ctx context.Context, dest interface{}, query string, arg interface{}) error GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error NamedGetContext(ctx context.Context, dest interface{}, query string, args interface{}) error NamedSelectPageContext(ctx context.Context, dest interface{}, total *int64, query string, arg interface{}, page *Page) error }
type Stmt ¶
Stmt is an sqlx wrapper around sql.Stmt with extra functionality
func PreparexContext ¶
PreparexContext prepares a statement.
The provided context is used for the preparation of the statement, not for the execution of the statement.
func (*Stmt) Get ¶
Get using the prepared statement. Any placeholder parameters are replaced with supplied args. An error is returned if the result set is empty.
func (*Stmt) GetContext ¶
GetContext using the prepared statement. Any placeholder parameters are replaced with supplied args. An error is returned if the result set is empty.
func (*Stmt) MustExec ¶
MustExec (panic) using this statement. Note that the query portion of the error output will be blank, as Stmt does not expose its query. Any placeholder parameters are replaced with supplied args.
func (*Stmt) MustExecContext ¶
MustExecContext (panic) using this statement. Note that the query portion of the error output will be blank, as Stmt does not expose its query. Any placeholder parameters are replaced with supplied args.
func (*Stmt) QueryRowx ¶
QueryRowx using this statement. Any placeholder parameters are replaced with supplied args.
func (*Stmt) QueryRowxContext ¶
QueryRowxContext using this statement. Any placeholder parameters are replaced with supplied args.
func (*Stmt) Queryx ¶
Queryx using this statement. Any placeholder parameters are replaced with supplied args.
func (*Stmt) QueryxContext ¶
QueryxContext using this statement. Any placeholder parameters are replaced with supplied args.
func (*Stmt) Select ¶
Select using the prepared statement. Any placeholder parameters are replaced with supplied args.
func (*Stmt) SelectContext ¶
SelectContext using the prepared statement. Any placeholder parameters are replaced with supplied args.
type Tx ¶
Tx is an sqlx wrapper around sql.Tx with extra functionality
func (*Tx) DriverName ¶
DriverName returns the driverName used by the DB which began this transaction.
func (*Tx) Get ¶
Get within a transaction. Any placeholder parameters are replaced with supplied args. An error is returned if the result set is empty.
func (*Tx) GetContext ¶
func (tx *Tx) GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
GetContext within a transaction and context. Any placeholder parameters are replaced with supplied args. An error is returned if the result set is empty.
func (*Tx) MustExec ¶
MustExec runs MustExec within a transaction. Any placeholder parameters are replaced with supplied args.
func (*Tx) MustExecContext ¶
MustExecContext runs MustExecContext within a transaction. Any placeholder parameters are replaced with supplied args.
func (*Tx) NamedExec ¶
NamedExec a named query within a transaction. Any named placeholder parameters are replaced with fields from arg.
func (*Tx) NamedExecContext ¶
func (tx *Tx) NamedExecContext(ctx context.Context, query string, arg interface{}) (sql.Result, error)
NamedExecContext using this Tx. Any named placeholder parameters are replaced with fields from arg.
func (*Tx) NamedGet ¶
NamedGet using this Tx. Any named placeholder parameters are replaced with fields from arg. An error is returned if the result set is empty.
func (*Tx) NamedGetContext ¶
func (tx *Tx) NamedGetContext(ctx context.Context, dest interface{}, query string, arg interface{}) error
NamedGetContext using this Tx. Any named placeholder parameters are replaced with fields from arg. An error is returned if the result set is empty.
func (*Tx) NamedQuery ¶
NamedQuery within a transaction. Any named placeholder parameters are replaced with fields from arg.
func (*Tx) NamedQueryContext ¶
NamedQueryContext using this Tx. Any named placeholder parameters are replaced with fields from arg.
func (*Tx) NamedSelect ¶
NamedSelect a named query within a transaction. Any named placeholder parameters are replaced with fields from arg.
func (*Tx) NamedSelectContext ¶
func (tx *Tx) NamedSelectContext(ctx context.Context, dest interface{}, query string, arg interface{}) error
NamedSelectContext using this Tx. Any named placeholder parameters are replaced with fields from arg.
func (*Tx) NamedSelectPage ¶
func (tx *Tx) NamedSelectPage(dest interface{}, total *int64, query string, arg interface{}, page *Page) error
NamedSelectPage a named query within a transaction. Any named placeholder parameters are replaced with fields from arg.
func (*Tx) NamedSelectPageContext ¶
func (tx *Tx) NamedSelectPageContext(ctx context.Context, dest interface{}, total *int64, query string, arg interface{}, page *Page) error
NamedSelectPageContext a named query within a transaction. Any named placeholder parameters are replaced with fields from arg.
func (*Tx) NamedStmt ¶
NamedStmt returns a version of the prepared statement which runs within a transaction.
func (*Tx) NamedStmtContext ¶
NamedStmtContext returns a version of the prepared statement which runs within a transaction.
func (*Tx) PrepareNamed ¶
PrepareNamed returns an sqlx.NamedStmt
func (*Tx) PrepareNamedContext ¶
PrepareNamedContext returns an sqlx.NamedStmt
func (*Tx) PreparexContext ¶
PreparexContext returns an sqlx.Stmt instead of a sql.Stmt.
The provided context is used for the preparation of the statement, not for the execution of the statement.
func (*Tx) QueryRowx ¶
QueryRowx within a transaction. Any placeholder parameters are replaced with supplied args.
func (*Tx) QueryRowxContext ¶
QueryRowxContext within a transaction and context. Any placeholder parameters are replaced with supplied args.
func (*Tx) Queryx ¶
Queryx within a transaction. Any placeholder parameters are replaced with supplied args.
func (*Tx) QueryxContext ¶
QueryxContext within a transaction and context. Any placeholder parameters are replaced with supplied args.
func (*Tx) Select ¶
Select within a transaction. Any placeholder parameters are replaced with supplied args.
func (*Tx) SelectContext ¶
func (tx *Tx) SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
SelectContext within a transaction and context. Any placeholder parameters are replaced with supplied args.
func (*Tx) Stmtx ¶
Stmtx returns a version of the prepared statement which runs within a transaction. Provided stmt can be either *sql.Stmt or *sqlx.Stmt.
func (*Tx) StmtxContext ¶
StmtxContext returns a version of the prepared statement which runs within a transaction. Provided stmt can be either *sql.Stmt or *sqlx.Stmt.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package reflectx implements extensions to the standard reflect lib suitable for implementing marshalling and unmarshalling packages.
|
Package reflectx implements extensions to the standard reflect lib suitable for implementing marshalling and unmarshalling packages. |