README
¶
Database
Database is wrapper for sqlx with clear interface, retry func and hooks.
Compatible databases: PostgreSQL, Clickhouse, CockroachDB, SQLite.
Install
go get github.com/loghole/database
Usage
package main
import (
"context"
"log"
"github.com/loghole/database"
_ "github.com/mattn/go-sqlite3"
)
func main() {
// Make connection config
cfg := &database.Config{
Database: ":memory:",
Type: database.SQLiteDatabase,
}
// Connect to Database with hooks
db, err := database.New(cfg, database.WithSimplerrHook(), database.WithRetryFunc(retry))
if err != nil {
panic(err)
}
defer db.Close()
ctx := context.Background()
// Queries
db.ExecContext(ctx, "CREATE TABLE t (id INTEGER PRIMARY KEY, text VARCHAR(5))")
db.ExecContext(ctx, "INSERT into t (id, text) VALUES(?, ?)", 1, "foo")
// Try 3 times and return error
if _, err := db.ExecContext(ctx, "INSERT into t (id, text) VALUES(?, ?)", 1, "bar"); err != nil {
log.Println(err)
}
}
func retry(retryCount int, err error) bool {
if retryCount > 3 {
return false
}
log.Println(retryCount, err)
return true
}
Custom hooks
You can write custom hooks with dbhook and use options database.WithCustomHook(hook)
Documentation
¶
Index ¶
- Constants
- type Config
- type DB
- func (db *DB) BeginTxx(ctx context.Context, opts *sql.TxOptions) (*sqlx.Tx, error)
- func (db *DB) Beginx() (*sqlx.Tx, error)
- func (db *DB) BindNamed(query string, arg interface{}) (bound string, arglist []interface{}, err error)
- func (db *DB) Close() error
- func (db *DB) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
- func (db *DB) GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
- func (db *DB) NamedExecContext(ctx context.Context, query string, arg interface{}) (sql.Result, error)
- func (db *DB) NamedQueryContext(ctx context.Context, query string, arg interface{}) (*sqlx.Rows, error)
- func (db *DB) PrepareNamedContext(ctx context.Context, query string) (*sqlx.NamedStmt, error)
- func (db *DB) PreparexContext(ctx context.Context, query string) (*sqlx.Stmt, error)
- func (db *DB) QueryxContext(ctx context.Context, query string, args ...interface{}) (*sqlx.Rows, error)
- func (db *DB) RunTxx(ctx context.Context, fn TransactionFunc) error
- func (db *DB) SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
- type DBType
- type Option
- func WithCockroachRetryFunc() Option
- func WithCustomHook(hook dbhook.Hook) Option
- func WithDefaultOptions(tracer trace.Tracer) Option
- func WithMetricsHook(collector hooks.MetricCollector) Option
- func WithPQRetryFunc(maxAttempts int) Option
- func WithPrometheusMetrics() Option
- func WithReconnectHook() Option
- func WithRetryFunc(f RetryFunc) Option
- func WithSimplerrHook() Option
- func WithTracingHook(tracer trace.Tracer) Option
- type QueryFunc
- type RetryFunc
- type TransactionFunc
Constants ¶
const DefaultRetryAttempts = 10
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type DB ¶
func (*DB) BeginTxx ¶ added in v0.6.0
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) Beginx ¶ added in v0.6.0
Beginx begins a transaction and returns an *sqlx.Tx instead of an *sql.Tx.
func (*DB) BindNamed ¶ added in v0.6.0
func (db *DB) BindNamed(query string, arg interface{}) (bound string, arglist []interface{}, err error)
BindNamed binds a query using the DB driver's bindvar type.
func (*DB) ExecContext ¶ added in v0.6.0
func (db *DB) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
ExecContext executes a query without returning any rows. The args are for any placeholder parameters in the query.
func (*DB) GetContext ¶ added in v0.6.0
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) NamedExecContext ¶ added in v0.6.0
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) NamedQueryContext ¶ added in v0.6.0
func (db *DB) NamedQueryContext(ctx context.Context, query string, arg interface{}) (*sqlx.Rows, error)
NamedQueryContext using this DB. Any named placeholder parameters are replaced with fields from arg.
func (*DB) PrepareNamedContext ¶ added in v0.6.0
PrepareNamedContext returns an sqlx.NamedStmt.
func (*DB) PreparexContext ¶ added in v0.6.0
PreparexContext returns an sqlx.Stmt instead of a sqlx.Stmt.
type Option ¶
type Option interface {
// contains filtered or unexported methods
}
func WithCockroachRetryFunc ¶
func WithCockroachRetryFunc() Option
func WithCustomHook ¶
func WithDefaultOptions ¶
func WithMetricsHook ¶ added in v0.5.0
func WithMetricsHook(collector hooks.MetricCollector) Option
func WithPQRetryFunc ¶ added in v0.6.0
func WithPrometheusMetrics ¶ added in v0.5.0
func WithPrometheusMetrics() Option
func WithReconnectHook ¶
func WithReconnectHook() Option
func WithRetryFunc ¶
func WithSimplerrHook ¶
func WithSimplerrHook() Option
Source Files
Directories