dbcontext

Documentation

Overview

Package dbcontext provides DB transaction support for transactions tha span method calls of multiple repositories and services.

Index

• type DB
  • func New(db *dbx.DB) *DB
  • func (db *DB) DB() *dbx.DB
  • func (db *DB) TransactionHandler() routing.Handler
  • func (db *DB) Transactional(ctx context.Context, f func(ctx context.Context) error) error
  • func (db *DB) With(ctx context.Context) dbx.Builder
• type TransactionFunc

Types

type DB

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

DB represents a DB connection that can be used to run SQL queries.

func New

func New(db *dbx.DB) *DB

New returns a new DB connection that wraps the given dbx.DB instance.

func (*DB) DB

func (db *DB) DB() *dbx.DB

DB returns the dbx.DB wrapped by this object.

func (*DB) TransactionHandler

func (db *DB) TransactionHandler() routing.Handler

TransactionHandler returns a middleware that starts a transaction. The transaction started is kept in the context and can be accessed via With().

func (*DB) Transactional

func (db *DB) Transactional(ctx context.Context, f func(ctx context.Context) error) error

Transactional starts a transaction and calls the given function with a context storing the transaction. The transaction associated with the context can be accesse via With().

func (*DB) With

func (db *DB) With(ctx context.Context) dbx.Builder

With returns a Builder that can be used to build and execute SQL queries. With will return the transaction if it is found in the given context. Otherwise it will return a DB connection associated with the context.

type TransactionFunc

type TransactionFunc func(ctx context.Context, f func(ctx context.Context) error) error

TransactionFunc represents a function that will start a transaction and run the given function.