transactional

README

transactional

Provides a sqlx transaction wrapper for http.Handler.

Documentation

Overview

Package transactional provides sqlx transactional wrappers for http handlers and functions.

Index

• type Handler
• type HandlerFunc
  • func (f HandlerFunc) ServeHTTP(tx *sqlx.Tx, w http.ResponseWriter, r *http.Request) error
• type Transactional
  • func WithDB(db *sqlx.DB) *Transactional
  • func (t *Transactional) Wrap(h Handler, eh httperr.ErrorHandler) http.Handler
  • func (t *Transactional) WrapF(h HandlerFunc, eh httperr.ErrorHandler) http.Handler
  • func (t *Transactional) WrapFn(ctx context.Context, fn func(tx *sqlx.Tx) error) error
• type Typed
  • func WithDBAndType[T any](db *sqlx.DB) *Typed[T]
  • func (t *Typed[T]) WrapFn(ctx context.Context, fn func(tx *sqlx.Tx) (T, error)) (T, error)

Types

type Handler

type Handler interface {
	ServeHTTP(tx *sqlx.Tx, w http.ResponseWriter, r *http.Request) error
}

Handler is a HTTP handler that takes a transaction and might error.

type HandlerFunc

type HandlerFunc func(tx *sqlx.Tx, w http.ResponseWriter, r *http.Request) error

HandlerFunc is Handler function.

func (HandlerFunc) ServeHTTP

func (f HandlerFunc) ServeHTTP(tx *sqlx.Tx, w http.ResponseWriter, r *http.Request) error

ServeHTTP satisfies Handler.

type Transactional

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

Transactional can wrap functions and http handlers within a transaction.

func WithDB

func WithDB(db *sqlx.DB) *Transactional

WithDB creates a new transactional using the given db.

func (*Transactional) Wrap

func (t *Transactional) Wrap(h Handler, eh httperr.ErrorHandler) http.Handler

Wrap wraps the given http handler within a transaction.

func (*Transactional) WrapF

func (t *Transactional) WrapF(h HandlerFunc, eh httperr.ErrorHandler) http.Handler

WrapF wraps the given http handler func within a transaction.

func (*Transactional) WrapFn

func (t *Transactional) WrapFn(ctx context.Context, fn func(tx *sqlx.Tx) error) error

WrapFn wraps a function within a transaction.

type Typed

type Typed[T any] struct {
	// contains filtered or unexported fields
}

Typed can wrap functions into transactions.

func WithDBAndType

func WithDBAndType[T any](db *sqlx.DB) *Typed[T]

WithDBAndType() creates a new Typed using the given db and type.

func (*Typed[T]) WrapFn

func (t *Typed[T]) WrapFn(
	ctx context.Context,
	fn func(tx *sqlx.Tx) (T, error),
) (T, error)

WrapFn wraps a function within a transaction.