dbhook

README

dbhook

Documentation

Overview

Package dbhook implements database hooks

Index

• Variables
• func Wrap(drv driver.Driver, hks Hook) driver.Driver
• type CallerType
• type Conn
  • func (conn *Conn) Begin() (driver.Tx, error)
  • func (conn *Conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error)
  • func (conn *Conn) Close() error
  • func (conn *Conn) Prepare(query string) (driver.Stmt, error)
  • func (conn *Conn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error)
• type Driver
  • func (drv *Driver) Open(name string) (driver.Conn, error)
• type ExecerContext
  • func (conn *ExecerContext) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error)
• type ExecerQueryer
• type ExecerQueryerSessionResetter
• type Hook
• type HookCall
• type HookInput
• type HookOption
  • func WithHooksAfter(hooks ...HookCall) HookOption
  • func WithHooksBefore(hooks ...HookCall) HookOption
  • func WithHooksError(hooks ...HookCall) HookOption
• type Hooks
  • func NewHooks(opts ...HookOption) *Hooks
  • func (h *Hooks) After(ctx context.Context, input *HookInput) (context.Context, error)
  • func (h *Hooks) Before(ctx context.Context, input *HookInput) (context.Context, error)
  • func (h *Hooks) Error(ctx context.Context, input *HookInput) (context.Context, error)
• type QueryerContext
  • func (conn *QueryerContext) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error)
• type SessionResetter
  • func (s *SessionResetter) ResetSession(ctx context.Context) error
• type Stmt
  • func (stmt *Stmt) Close() error
  • func (stmt *Stmt) Exec(args []driver.Value) (driver.Result, error)
  • func (stmt *Stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error)
  • func (stmt *Stmt) NumInput() int
  • func (stmt *Stmt) Query(args []driver.Value) (driver.Rows, error)
  • func (stmt *Stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error)
• type Tx
  • func (tx *Tx) Commit() error
  • func (tx *Tx) Rollback() error

Variables

var (
	ErrNonExecer                 = errors.New("ExecerContext created for a non Execer driver.Conn")
	ErrNonQueryer                = errors.New("QueryerContext created for a non Queryer driver.Conn")
	ErrNonSessionResetter        = errors.New("ResetSession created for a non SessionResetter driver.Conn")
	ErrNamedParametersNotSupport = errors.New("sql: driver does not support the use of Named Parameters")
)

Functions

func Wrap

func Wrap(drv driver.Driver, hks Hook) driver.Driver

Types

type CallerType

type CallerType string

const (
	CallerStmt      CallerType = "stmt"
	CallerStmtExec  CallerType = "stmt_exec"
	CallerStmtQuery CallerType = "stmt_query"
	CallerExec      CallerType = "exec"
	CallerQuery     CallerType = "query"
	CallerBegin     CallerType = "begin"
	CallerCommit    CallerType = "commit"
	CallerRollback  CallerType = "rollback"
)

type Conn

type Conn struct {
	Conn        driver.Conn
	ConnBeginTx driver.ConnBeginTx
	// contains filtered or unexported fields
}

func (*Conn) Begin

func (conn *Conn) Begin() (driver.Tx, error)

Begin Deprecated. nolint:staticcheck // deprecated

func (*Conn) BeginTx

func (conn *Conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error)

func (*Conn) Close

func (conn *Conn) Close() error

func (*Conn) Prepare

func (conn *Conn) Prepare(query string) (driver.Stmt, error)

func (*Conn) PrepareContext

func (conn *Conn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error)

type Driver

type Driver struct {
	driver.Driver
	// contains filtered or unexported fields
}

func (*Driver) Open

func (drv *Driver) Open(name string) (driver.Conn, error)

type ExecerContext

type ExecerContext struct {
	*Conn
}

func (*ExecerContext) ExecContext

func (conn *ExecerContext) ExecContext(
	ctx context.Context,
	query string,
	args []driver.NamedValue,
) (driver.Result, error)

type ExecerQueryer

type ExecerQueryer struct {
	*Conn
	*ExecerContext
	*QueryerContext
}

type ExecerQueryerSessionResetter

type ExecerQueryerSessionResetter struct {
	*Conn
	*ExecerContext
	*QueryerContext
	*SessionResetter
}

type Hook

type Hook interface {
	Before(ctx context.Context, input *HookInput) (context.Context, error)
	After(ctx context.Context, input *HookInput) (context.Context, error)
	Error(ctx context.Context, input *HookInput) (context.Context, error)
}

type HookCall

type HookCall interface {
	Call(ctx context.Context, input *HookInput) (context.Context, error)
}

type HookInput

type HookInput struct {
	Caller CallerType
	Query  string
	Args   []driver.Value
	Error  error
}

type HookOption

type HookOption func(*Hooks)

func WithHooksAfter

func WithHooksAfter(hooks ...HookCall) HookOption

func WithHooksBefore

func WithHooksBefore(hooks ...HookCall) HookOption

func WithHooksError

func WithHooksError(hooks ...HookCall) HookOption

type Hooks

type Hooks struct {
	// contains filtered or unexported fields
}

func NewHooks

func NewHooks(opts ...HookOption) *Hooks

func (*Hooks) After

func (h *Hooks) After(ctx context.Context, input *HookInput) (context.Context, error)

func (*Hooks) Before

func (h *Hooks) Before(ctx context.Context, input *HookInput) (context.Context, error)

func (*Hooks) Error

func (h *Hooks) Error(ctx context.Context, input *HookInput) (context.Context, error)

type QueryerContext

type QueryerContext struct {
	*Conn
}

func (*QueryerContext) QueryContext

func (conn *QueryerContext) QueryContext(
	ctx context.Context,
	query string,
	args []driver.NamedValue,
) (driver.Rows, error)

type SessionResetter

type SessionResetter struct {
	*Conn
}

func (*SessionResetter) ResetSession

func (s *SessionResetter) ResetSession(ctx context.Context) error

type Stmt

type Stmt struct {
	Stmt driver.Stmt
	// contains filtered or unexported fields
}

func (*Stmt) Close

func (stmt *Stmt) Close() error

func (*Stmt) Exec

func (stmt *Stmt) Exec(args []driver.Value) (driver.Result, error)

Exec Deprecated. nolint:staticcheck // deprecated

func (*Stmt) ExecContext

func (stmt *Stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error)

ExecContext must honor the context timeout and return when it is canceled. nolint:dupl // it's ok

func (*Stmt) NumInput

func (stmt *Stmt) NumInput() int

func (*Stmt) Query

func (stmt *Stmt) Query(args []driver.Value) (driver.Rows, error)

Query Deprecated. nolint:staticcheck // deprecated

func (*Stmt) QueryContext

func (stmt *Stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error)

QueryContext must honor the context timeout and return when it is canceled. nolint:dupl // it's ok

type Tx

type Tx struct {
	Tx driver.Tx
	// contains filtered or unexported fields
}

func (*Tx) Commit

func (tx *Tx) Commit() error

func (*Tx) Rollback

func (tx *Tx) Rollback() error