dbutil

Jan 16, 2025

Changes in this version

type QueryHelper

+ func (qh *QueryHelper[T]) QueryManyIter(ctx context.Context, query string, args ...any) RowIter[T]

type TxnOptions

+ RetryBegin func(error, int) bool

Sep 16, 2024

Changes in this version

+ func DangerousInternalUpgradeVersionTable(ctx context.Context, db *Database) error

Aug 16, 2024

Changes in this version

+ var ErrAcquireDeadlock = errors.New("attempt to acquire connection without context in goroutine with transaction")

+ var ErrQueryDeadlock = errors.New("attempt to query without context in goroutine with transaction")

+ var ErrTransactionDeadlock = errors.New("attempt to start new transaction in goroutine with transaction")

+ var ForceDeadlockDetection bool

type Config

+ DeadlockDetection bool

type Database

+ DeadlockDetection bool

Jul 16, 2024

Changes in this version

+ type Conn interface

type Database

+ func (db *Database) AcquireConn(ctx context.Context) (Conn, error)

+ func (db *Database) DoSQLiteTransactionWithoutForeignKeys(ctx context.Context, doUpgrade func(context.Context) error) error

+ func (db *Database) Execable(ctx context.Context) Execable

+ func (db *Database) Internals() *publishDatabaseInternals

+ type TxnMode string

+ const TxnModeOff

+ const TxnModeOn

+ const TxnModeSQLiteForeignKeysOff

+ type TxnOptions struct

+ Conn Conn

+ Isolation sql.IsolationLevel

+ ReadOnly bool

+ type UnderlyingExecutableWithTx interface

+ BeginTx func(ctx context.Context, opts *sql.TxOptions) (*sql.Tx, error)

Apr 16, 2024

Changes in this version

+ type Array interface

+ type MassInsertBuilder struct

+ func NewMassInsertBuilder[Item MassInsertable[DynamicParams], StaticParams Array, DynamicParams Array](singleInsertQuery, placeholderTemplate string) *MassInsertBuilder[Item, StaticParams, DynamicParams]

+ func (mib *MassInsertBuilder[Item, StaticParams, DynamicParams]) Build(static StaticParams, data []Item) (query string, params []any)

+ type MassInsertable interface

+ GetMassInsertValues func() T

type RowIter

+ func NewSimpleReflectRowIter[T any](rows Rows, err error) RowIter[*T]

Mar 16, 2024

Changes in this version

+ func ConvertedPtr[Input Zeroable, Output any](val Input, converter func(Input) Output) *Output

+ func UnixMilliPtr(val time.Time) *int64

+ func UnixPtr(val time.Time) *int64

+ func UntypedNil[T any](val *T) any

type JSON

+ func JSONPtr[T any](val *T) JSON

+ type Zeroable interface

+ IsZero func() bool

Feb 16, 2024

Changes in this version

+ var ErrAlreadyIterated = errors.New("this iterator has been already iterated")

+ func RowIterAsMap[T any, Key comparable, Value any](ri RowIter[T], getKeyValue func(T) (Key, Value)) (map[Key]Value, error)

+ type ConvertRowFn func(Scannable) (T, error)

+ func (crf ConvertRowFn[T]) NewRowIter(rows Rows, err error) RowIter[T]

type RowIter

+ func NewRowIterWithError[T any](rows Rows, convertFn ConvertRowFn[T], err error) RowIter[T]

+ func NewSliceIterWithError[T any](items []T, err error) RowIter[T]

+ func NewSliceIter[T any](items []T) RowIter[T]

Jan 16, 2024

Changes in this version

+ func NumPtr[T constraints.Integer | constraints.Float](val T) *T

+ func ScanDataStruct[T NewableDataStruct[T]](rows Scannable) (T, error)

+ func ScanSingleColumn[T any](rows Scannable) (val T, err error)

+ func StrPtr[T ~string](val T) *string

+ func ValueOrErr[T any](val *T, err error) (*T, error)

+ type DataStruct interface

+ Scan func(row Scannable) (T, error)

type Database

+ LoggingDB loggingDB

+ func (db *Database) Exec(ctx context.Context, query string, args ...any) (sql.Result, error)

+ func (db *Database) Query(ctx context.Context, query string, args ...any) (Rows, error)

+ func (db *Database) QueryRow(ctx context.Context, query string, args ...any) *sql.Row

type Execable

+ ExecContext func(ctx context.Context, query string, args ...any) (sql.Result, error)

+ QueryContext func(ctx context.Context, query string, args ...any) (Rows, error)

+ QueryRowContext func(ctx context.Context, query string, args ...any) *sql.Row

+ type NewableDataStruct interface

+ New func() T

+ type PQErrorWithLine struct

+ Line string

+ Underlying error

+ func (pqe *PQErrorWithLine) Error() string

+ func (pqe *PQErrorWithLine) Unwrap() error

+ type QueryHelper struct

+ func MakeQueryHelper[T DataStruct[T]](db *Database, new func(qh *QueryHelper[T]) T) *QueryHelper[T]

+ func (qh *QueryHelper[T]) Exec(ctx context.Context, query string, args ...any) error

+ func (qh *QueryHelper[T]) GetDB() *Database

+ func (qh *QueryHelper[T]) New() T

+ func (qh *QueryHelper[T]) QueryMany(ctx context.Context, query string, args ...any) ([]T, error)

+ func (qh *QueryHelper[T]) QueryOne(ctx context.Context, query string, args ...any) (val T, err error)

+ type RowIter interface

+ AsList func() ([]T, error)

+ Iter func(func(T) (bool, error)) error

+ func NewRowIter[T any](rows Rows, convertFn func(Scannable) (T, error)) RowIter[T]

type UnderlyingExecable

+ ExecContext func(ctx context.Context, query string, args ...any) (sql.Result, error)

+ QueryContext func(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ QueryRowContext func(ctx context.Context, query string, args ...any) *sql.Row

Sep 6, 2023

Changes in this version

+ const ContextKeyDatabaseTransaction

+ const ContextKeyDoTxnCallerSkip

+ var ErrForeignTables = errors.New("the database contains foreign tables")

+ var ErrNotOwned = errors.New("the database is owned by")

+ var ErrTxn = errors.New("transaction")

+ var ErrTxnBegin = fmt.Errorf("%w: begin", ErrTxn)

+ var ErrTxnCommit = fmt.Errorf("%w: commit", ErrTxn)

+ var ErrUnsupportedDatabaseVersion = errors.New("unsupported database schema version")

+ var ErrUnsupportedDialect = errors.New("unsupported database dialect")

+ type Config struct

+ ReadOnlyPool PoolConfig

+ type ContextExecable interface

+ ExecContext func(ctx context.Context, query string, args ...interface{}) (sql.Result, error)

+ QueryContext func(ctx context.Context, query string, args ...interface{}) (Rows, error)

+ QueryRowContext func(ctx context.Context, query string, args ...interface{}) *sql.Row

+ type Database struct

+ Dialect Dialect

+ IgnoreForeignTables bool

+ IgnoreUnsupportedDatabase bool

+ Log DatabaseLogger

+ Owner string

+ RawDB *sql.DB

+ ReadOnlyDB *sql.DB

+ UpgradeTable UpgradeTable

+ VersionTable string

+ func NewFromConfig(owner string, cfg Config, logger DatabaseLogger) (*Database, error)

+ func NewWithDB(db *sql.DB, rawDialect string) (*Database, error)

+ func NewWithDialect(uri, rawDialect string) (*Database, error)

+ func (db *Database) Child(versionTable string, upgradeTable UpgradeTable, log DatabaseLogger) *Database

+ func (db *Database) Close() error

+ func (db *Database) ColumnExists(tx Execable, table, column string) (exists bool, err error)

+ func (db *Database) Configure(cfg Config) error

+ func (db *Database) Conn(ctx context.Context) ContextExecable

+ func (db *Database) DoTxn(ctx context.Context, opts *sql.TxOptions, fn func(ctx context.Context) error) error

+ func (db *Database) TableExists(tx Execable, table string) (exists bool, err error)

+ func (db *Database) Upgrade() error

+ func (ld *Database) Begin() (*LoggingTxn, error)

+ func (ld *Database) BeginTx(ctx context.Context, opts *sql.TxOptions) (*LoggingTxn, error)

+ type DatabaseLogger interface

+ DoUpgrade func(from, to int, message string, txn bool)

+ PrepareUpgrade func(current, compat, latest int)

+ QueryTiming func(ctx context.Context, method, query string, args []interface{}, nrows int, ...)

+ Warn func(msg string, args ...interface{})

+ WarnUnsupportedVersion func(current, compat, latest int)

+ var NoopLogger DatabaseLogger = &noopLogger{}

+ func ZeroLogger(log zerolog.Logger, cfg ...ZeroLogSettings) DatabaseLogger

+ func ZeroLoggerPtr(log *zerolog.Logger, cfg ...ZeroLogSettings) DatabaseLogger

+ type Dialect int

+ const DialectUnknown

+ const Postgres

+ const SQLite

+ func ParseDialect(engine string) (Dialect, error)

+ func (dialect Dialect) String() string

+ type Execable interface

+ Exec func(query string, args ...interface{}) (sql.Result, error)

+ Query func(query string, args ...interface{}) (Rows, error)

+ QueryRow func(query string, args ...interface{}) *sql.Row

+ type JSON struct

+ Data any

+ func (j JSON) Scan(i any) error

+ func (j JSON) Value() (driver.Value, error)

+ type LoggingExecable struct

+ UnderlyingExecable UnderlyingExecable

+ func (le *LoggingExecable) Exec(query string, args ...interface{}) (sql.Result, error)

+ func (le *LoggingExecable) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)

+ func (le *LoggingExecable) Query(query string, args ...interface{}) (Rows, error)

+ func (le *LoggingExecable) QueryContext(ctx context.Context, query string, args ...interface{}) (Rows, error)

+ func (le *LoggingExecable) QueryRow(query string, args ...interface{}) *sql.Row

+ func (le *LoggingExecable) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row

+ type LoggingRows struct

+ func (lrs *LoggingRows) Close() error

+ func (lrs *LoggingRows) ColumnTypes() ([]*sql.ColumnType, error)

+ func (lrs *LoggingRows) Columns() ([]string, error)

+ func (lrs *LoggingRows) Err() error

+ func (lrs *LoggingRows) Next() bool

+ func (lrs *LoggingRows) NextResultSet() bool

+ func (lrs *LoggingRows) Scan(dest ...any) error

+ type LoggingTxn struct

+ EndTime time.Time

+ StartTime time.Time

+ UnderlyingTx *sql.Tx

+ func (lt *LoggingTxn) Commit() error

+ func (lt *LoggingTxn) Rollback() error

+ type PoolConfig struct

+ ConnMaxIdleTime string

+ ConnMaxLifetime string

+ MaxIdleConns int

+ MaxOpenConns int

+ Type string

+ URI string

+ type Rows interface

+ Close func() error

+ ColumnTypes func() ([]*sql.ColumnType, error)

+ Columns func() ([]string, error)

+ Err func() error

+ Next func() bool

+ NextResultSet func() bool

+ Scan func(...any) error

+ type Scannable interface

+ Scan func(...interface{}) error

+ type Transaction interface

+ Commit func() error

+ Rollback func() error

+ type UnderlyingContextExecable interface

+ ExecContext func(ctx context.Context, query string, args ...interface{}) (sql.Result, error)

+ QueryContext func(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)

+ QueryRowContext func(ctx context.Context, query string, args ...interface{}) *sql.Row

+ type UnderlyingExecable interface

+ Exec func(query string, args ...interface{}) (sql.Result, error)

+ Query func(query string, args ...interface{}) (*sql.Rows, error)

+ QueryRow func(query string, args ...interface{}) *sql.Row

+ type UpgradeTable []upgrade

+ func (ut *UpgradeTable) Register(from, to, compat int, message string, txn bool, fn upgradeFunc)

+ func (ut *UpgradeTable) RegisterFS(fs fullFS)

+ func (ut *UpgradeTable) RegisterFSPath(fs fullFS, dir string)

+ type ZeroLogSettings struct

+ Caller bool

+ CallerSkipFrame int

+ TraceLogAllQueries bool