txs

Documentation

Overview

Example (PkgLevelTxFunctions)

package main

import (
	"context"

	"github.com/adamluzsi/frameless/pkg/txs"
)

func main() {
	ctx := context.Background()

	_ = func(ctx context.Context) (rerr error) {
		tx, _ := txs.Begin(ctx)
		defer txs.Finish(&rerr, tx)

		txs.OnRollback(tx, func() {
			// something to do
		})
		return nil
	}(ctx)
}

Index

• Constants
• func Begin(ctx context.Context) (context.Context, error)
• func Commit(ctx context.Context) error
• func Finish(returnError *error, tx context.Context)
• func OnRollback[StepFn onRollbackStepFn](ctx context.Context, step StepFn) error
• func Rollback(ctx context.Context) error
• type TxRollbackError
  • func (err *TxRollbackError) Error() string
  • func (err *TxRollbackError) Unwrap() error

Examples

• Package (PkgLevelTxFunctions)

Constants

const (
	ErrTxDone errorutil.Error = "transaction is already finished"
	ErrNoCtx  errorutil.Error = "context.Context not given"
	ErrNoTx   errorutil.Error = "no transaction present in the current context"
)

Functions

func Begin

func Begin(ctx context.Context) (context.Context, error)

func Commit

func Commit(ctx context.Context) error

func Finish

func Finish(returnError *error, tx context.Context)

func OnRollback

func OnRollback[StepFn onRollbackStepFn](ctx context.Context, step StepFn) error

func Rollback

func Rollback(ctx context.Context) error

Types

type TxRollbackError

type TxRollbackError struct {
	Err   error
	Cause error
}

func (*TxRollbackError) Error

func (err *TxRollbackError) Error() string

func (*TxRollbackError) Unwrap

func (err *TxRollbackError) Unwrap() error