stdent

Documentation

Overview

Package stdent provides re-usable code for using Ent.

Index

• func AttemptFromContext(ctx context.Context) int
• func ContextWithAttempts(ctx context.Context, v int) context.Context
• func ContextWithTx[T Tx](ctx context.Context, tx T) context.Context
• func Transact0[T Tx](ctx context.Context, txr *Transactor[T], ...) (err error)
• func Transact1[T Tx, U any](ctx context.Context, txr *Transactor[T], ...) (res U, err error)
• func TxFromContext[T Tx](ctx context.Context) T
• type Client
• type Option
  • func IsolationLevel(v sql.IsolationLevel) Option
  • func ReadOnly(v bool) Option
  • func SerializationFailureCodes(v ...string) Option
  • func SerializationFailureMaxRetries(v int) Option
• type Transactor
  • func New[T Tx](client Client[T], opts ...Option) *Transactor[T]
• type Tx

Functions

func AttemptFromContext

func AttemptFromContext(ctx context.Context) int

AttemptFromContext returns which execution attempt it is. Panics if this information is not present.

func ContextWithAttempts

func ContextWithAttempts(ctx context.Context, v int) context.Context

ContextWithAttempts stores which execution attempt it is.

func ContextWithTx

func ContextWithTx[T Tx](ctx context.Context, tx T) context.Context

ContextWithTx returns a context with the Tx in it.

func Transact0

func Transact0[T Tx](
	ctx context.Context,
	txr *Transactor[T],
	fnc func(ctx context.Context, tx T) error,
) (err error)

Transact0 runs Transact1 but without a value to return.

func Transact1

func Transact1[T Tx, U any](
	ctx context.Context,
	txr *Transactor[T],
	fnc func(ctx context.Context, tx T) (U, error),
) (res U, err error)

Transact1 runs fnc in a transaction T derived from the provided Ent client while returning one value of type U. The implementation is taken from the official docs: https://entgo.io/docs/transactions#best-practices. If the context already has a transaction, it runs it in that one.

func TxFromContext

func TxFromContext[T Tx](ctx context.Context) T

TxFromContext will get a transaction of type T from the context or panic.

Types

type Client

type Client[T Tx] interface {
	BeginTx(ctx context.Context, opts *entsql.TxOptions) (T, error)
}

Client defines an Ent client that begins transactions of type T.

type Option

type Option func(opts *options)

func IsolationLevel

func IsolationLevel(v sql.IsolationLevel) Option

IsolationLevel specifies the isolation level for new transactions.

func ReadOnly

func ReadOnly(v bool) Option

ReadOnly sets the transaction to be read-only.

func SerializationFailureCodes

func SerializationFailureCodes(v ...string) Option

SerializationFailureCodes configures which PostgreSQL error codes should be considered serialization failures.

func SerializationFailureMaxRetries

func SerializationFailureMaxRetries(v int) Option

SerializationFailureMaxRetries configures the maximum number of retries in case the transacted code encounters a serialization failure.

type Transactor

type Transactor[T Tx] struct {
	// contains filtered or unexported fields
}

func New

func New[T Tx](client Client[T], opts ...Option) *Transactor[T]

type Tx

type Tx interface {
	Commit() error
	Rollback() error
}

Tx describes the constraints for an Ent transaction.