txutil

Documentation

Overview

Package txutil provides safe transaction-encapsulation functions which have retry semantics as necessary.

Index

• func IsInsideTx(ctx context.Context) bool
• func WithTx(ctx context.Context, db tagsql.DB, txOpts *sql.TxOptions, ...) (err error)

Functions

func IsInsideTx

func IsInsideTx(ctx context.Context) bool

IsInsideTx returns whether ctx is from a WithTx call.

func WithTx

func WithTx(ctx context.Context, db tagsql.DB, txOpts *sql.TxOptions, fn func(context.Context, tagsql.Tx) error) (err error)

WithTx starts a transaction on the given sql.DB. The transaction is started in the appropriate manner, and will be restarted if appropriate. While in the transaction, fn is called with a handle to the transaction in order to make use of it. If fn returns an error, the transaction is rolled back. If fn returns nil, the transaction is committed.

If fn has any side effects outside of changes to the database, they must be idempotent! fn may be called more than one time.