sqlwrapper.go

package sqlwrapper

import (
	"context"
	"database/sql"
)

// Querier can execute queries to the db.
type Querier interface {
	// Exec executes query without returning db rows, e.g. simple delete/update/insert.
	Exec(ctx context.Context, queryBuilder SQLBuilder) (sql.Result, error)
	// Get executes query returning potentially multiple db rows.
	Get(ctx context.Context, dest any, queryBuilder SQLBuilder) error
	// GetOne executes query returning either a single row or nothing (in this case sql.ErrNoRows is returned).
	GetOne(ctx context.Context, dest any, queryBuilder SQLBuilder) error
}

type QuerierRaw interface {
	// ExecRaw executes query without returning db rows, e.g. simple delete/update/insert.
	// It works exactly like Querier.Exec, but expects raw sql query and args instead of sql query builder.
	ExecRaw(ctx context.Context, query string, args ...any) (sql.Result, error)
	// GetRaw executes query returning potentially multiple db rows.
	// It works exactly like Querier.Get, but expects raw sql query and args instead of sql query builder.
	GetRaw(ctx context.Context, dest any, query string, args ...any) error
	// GetOneRaw executes query returning either a single row or nothing (in this case sql.ErrNoRows is returned).
	// It works exactly like Querier.GetOne, but expects raw sql query and args instead of sql query builder.
	GetOneRaw(ctx context.Context, dest any, query string, args ...any) error
}

type DBConnPool interface {
	Querier
	QuerierRaw
	Close() error
	BeginTx(ctx context.Context, opts *sql.TxOptions) (Tx, error)
	RunInTx(ctx context.Context, callback func(ctx context.Context, tx Tx) error) error
}

type Tx interface {
	Querier
	QuerierRaw
	Commit() error
	Rollback() error
}

type SQLBuilder interface {
	ToSql() (sqlStr string, args []interface{}, err error)
}