txengine

Documentation

Index

• func RunTransaction(ctx context.Context, dbName string, ...) (err error)
• func RunTransactionWithLock(ctx context.Context, dbName string, lock string, durationInSec int, ...) (err error)
• type Tx
  • func WithTx(tx *sql.Tx) *Tx
  • func (o *Tx) Exec(ctx context.Context, query string, params ...any) (sql.Result, error)
  • func (o *Tx) QueryInt(ctx context.Context, query string, params ...any) (result int, err error)
• type TypedTx
  • func WithTypedTx[T any](tx *sql.Tx) *TypedTx[T]
  • func (o *TypedTx[T]) Find(ctx context.Context, tableName string, whereSQL string, params ...any) ([]*T, error)
  • func (o *TypedTx[T]) FindOne(ctx context.Context, tableName string, whereSQL string, params ...any) (*T, error)
  • func (o *TypedTx[T]) Query(ctx context.Context, query string, params ...any) (result []*T, err error)

Functions

func RunTransaction

func RunTransaction(ctx context.Context, dbName string, fn func(ctx context.Context, sqlTx *sql.Tx) error) (err error)

RunTransaction runs a transaction

func RunTransactionWithLock

func RunTransactionWithLock(ctx context.Context, dbName string, lock string, durationInSec int, fn func(ctx context.Context, sqlTx *sql.Tx) error) (err error)

RunTransactionWithLock runs a transaction with a lock for durationInSec seconds

Types

type Tx

type Tx sql.Tx

func WithTx

func WithTx(tx *sql.Tx) *Tx

WithTx converts *sql.Tx to *txengine.Tx.

With *txengine.Tx, you have access to Exec and QueryInt

func (*Tx) Exec

func (o *Tx) Exec(ctx context.Context, query string, params ...any) (sql.Result, error)

Exec given query with given db info & params

func (*Tx) QueryInt

func (o *Tx) QueryInt(ctx context.Context, query string, params ...any) (result int, err error)

QueryInt single int result by query, handy for count(*) querys

type TypedTx

type TypedTx[T any] sql.Tx

func WithTypedTx

func WithTypedTx[T any](tx *sql.Tx) *TypedTx[T]

WithTypedTx converts *sql.Tx to *txengine.TypedTx[T].

With *txengine.TypedTx[T], you have access to FindOne[T], Find[T] and Query[T]

func (*TypedTx[T]) Find

func (o *TypedTx[T]) Find(ctx context.Context, tableName string, whereSQL string, params ...any) ([]*T, error)

Find returns rows from given table type with where query

func (*TypedTx[T]) FindOne

func (o *TypedTx[T]) FindOne(ctx context.Context, tableName string, whereSQL string, params ...any) (*T, error)

FindOne returns a row from given table type with where query. If no rows found, *T will be nil. No error will be returned.

func (*TypedTx[T]) Query

func (o *TypedTx[T]) Query(ctx context.Context, query string, params ...any) (result []*T, err error)

Query rows from given table type with where query & params