database

Documentation

Index

• Variables
• func Context(ctx context.Context, db *sql.DB) context.Context
• func ContextWithTimeout(ctx context.Context, db *sql.DB, timeout int) (context.Context, context.CancelFunc)
• func DBIContext(ctx context.Context, db DBI) context.Context
• func DBIMiddleware(sqlDB *sql.DB) echo.MiddlewareFunc
• func ForContext(ctx context.Context) *sql.DB
• func GetPlaceholderFormat() sq.PlaceholderFormat
• func Middleware(db *sql.DB) echo.MiddlewareFunc
• func NewDBI(sdb *sql.DB) *db
• func SetPlaceholderFormat(format sq.PlaceholderFormat)
• func WithTx(ctx context.Context, opts *sql.TxOptions, fn func(tx *sql.Tx) error) error
• type DBI
  • func DBIForContext(ctx context.Context) DBI
• type DebugTx
  • func (dt *DebugTx) Commit() error
  • func (dt *DebugTx) Rollback() error
• type FilterOptions
  • func (f *FilterOptions) GetBuilder(filter sq.Sqlizer) sq.SelectBuilder

Variables

var TxOptionsRO = &sql.TxOptions{Isolation: 0, ReadOnly: true}

TxOptionsRO read only transaction rules

Functions

func Context

func Context(ctx context.Context, db *sql.DB) context.Context

Context adds db connection to context for immediate use

func ContextWithTimeout

func ContextWithTimeout(
	ctx context.Context, db *sql.DB, timeout int) (context.Context, context.CancelFunc)

ContextWithTimeout returns a context with query timeout

func DBIContext

func DBIContext(ctx context.Context, db DBI) context.Context

DBIContext adds db connection to context for immediate use

func DBIMiddleware

func DBIMiddleware(sqlDB *sql.DB) echo.MiddlewareFunc

DBIMiddleware creates a new DBI instance per request

func ForContext

func ForContext(ctx context.Context) *sql.DB

ForContext pulls *sql.DB obj for context

func GetPlaceholderFormat

func GetPlaceholderFormat() sq.PlaceholderFormat

GetPlaceholderFormat will return the currently configured placeholder format. It can be used to set the format at the application level. This helps keep things easier to change database backends in the future. Will panic if no value is set, though the default value is "squirrel.Question" (question mark)

func Middleware

func Middleware(db *sql.DB) echo.MiddlewareFunc

Middleware will place the stripe client in the request context

func NewDBI

func NewDBI(sdb *sql.DB) *db

NewDB returns a new DB struct

func SetPlaceholderFormat

func SetPlaceholderFormat(format sq.PlaceholderFormat)

SetPlaceholderFormat will set the application level placeholder format. This should be called early in your applications startup to avoid any issues with queries depending on this value.

func WithTx

func WithTx(ctx context.Context, opts *sql.TxOptions, fn func(tx *sql.Tx) error) error

WithTx calls a function wrapped in a database transaction

Types

type DBI

type DBI interface {
	BeginTx(ctx context.Context, opts *sql.TxOptions) (*sql.Tx, error)
	CommitTx() error
	RollbackTx() error
	WillCommit() bool
	EnableCommit() bool
	DisableCommit() bool
	GetDB() *sql.DB
	HasActiveTransaction() bool
}

DBI is an interface to provide database access. This allows you to run through many queries in a single transaction. Also allows you to enable commit, commit, then disable it again for cases when you MUST write to the db.

func DBIForContext

func DBIForContext(ctx context.Context) DBI

DBIForContext pulls *sql.DB obj for context

type DebugTx

type DebugTx struct {
	*sql.Tx
	// contains filtered or unexported fields
}

DebugTx wraps a transaction with debug logging

func (*DebugTx) Commit

func (dt *DebugTx) Commit() error

func (*DebugTx) Rollback

func (dt *DebugTx) Rollback() error

type FilterOptions

type FilterOptions struct {
	Filter  sq.Sqlizer
	Limit   int
	Offset  int
	OrderBy string

	Metadata map[string]any // Used for misc. data passing
}

FilterOptions is a simple helper for sql filtering

func (*FilterOptions) GetBuilder

func (f *FilterOptions) GetBuilder(filter sq.Sqlizer) sq.SelectBuilder

GetBuilder returns a squirrel SelectBuilder based on options