mongo

Documentation

Overview

Package mongo is an implementation of trm.Transaction interface by Transaction for mongo.Client.

Index

• func NewDefaultFactory(client client) trm.TrFactory
• type Opt
  • func WithSessionOpts(opts *options.SessionOptions) Opt
  • func WithTransactionOpts(opts *options.TransactionOptions) Opt
• type Settings
  • func MustSettings(trms trm.Settings, oo ...Opt) Settings
  • func NewSettings(trms trm.Settings, oo ...Opt) (Settings, error)
  • func (s Settings) EnrichBy(in trm.Settings) trm.Settings
  • func (s Settings) SessionOpts() *options.SessionOptions
  • func (s Settings) TransactionOpts() *options.TransactionOptions
• type Transaction
  • func NewTransaction(ctx context.Context, sessionOptions *options.SessionOptions, ...) (context.Context, *Transaction, error)
  • func (t *Transaction) Closed() <-chan struct{}
  • func (t *Transaction) Commit(ctx context.Context) error
  • func (t *Transaction) IsActive() bool
  • func (t *Transaction) Rollback(ctx context.Context) error
  • func (t *Transaction) Transaction() interface{}

Functions

func NewDefaultFactory

func NewDefaultFactory(client client) trm.TrFactory

NewDefaultFactory creates default trm.Transaction(mongo.Session).

Types

type Opt

type Opt func(*Settings) error

Opt is a type to configure Settings.

func WithSessionOpts

func WithSessionOpts(opts *options.SessionOptions) Opt

WithSessionOpts sets up options.SessionOptions for the Settings.

func WithTransactionOpts

func WithTransactionOpts(opts *options.TransactionOptions) Opt

WithTransactionOpts sets up options.TransactionOptions for the Settings.

type Settings

type Settings struct {
	trm.Settings
	// contains filtered or unexported fields
}

Settings contains settings for mongo.Transaction.

func MustSettings

func MustSettings(trms trm.Settings, oo ...Opt) Settings

MustSettings returns Settings if err is nil and panics otherwise.

func NewSettings

func NewSettings(trms trm.Settings, oo ...Opt) (Settings, error)

NewSettings creates Settings.

func (Settings) EnrichBy

func (s Settings) EnrichBy(in trm.Settings) trm.Settings

EnrichBy fills nil properties from external Settings.

func (Settings) SessionOpts

func (s Settings) SessionOpts() *options.SessionOptions

SessionOpts returns *options.SessionOptions for the trm.Transaction.

func (Settings) TransactionOpts

func (s Settings) TransactionOpts() *options.TransactionOptions

TransactionOpts returns trm.CtxKey for the trm.Transaction.

type Transaction

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

Transaction is trm.Transaction for mongo.Client.

func NewTransaction

func NewTransaction(
	ctx context.Context,
	sessionOptions *options.SessionOptions,
	trOpts *options.TransactionOptions,
	client client,
) (context.Context, *Transaction, error)

NewTransaction creates trm.Transaction for mongo.Client.

func (*Transaction) Closed

func (t *Transaction) Closed() <-chan struct{}

Closed returns a channel that's closed when transaction committed or rolled back.

func (*Transaction) Commit

func (t *Transaction) Commit(ctx context.Context) error

Commit the trm.Transaction.

func (*Transaction) IsActive

func (t *Transaction) IsActive() bool

IsActive returns true if the transaction started but not committed or rolled back.

func (*Transaction) Rollback

func (t *Transaction) Rollback(ctx context.Context) error

Rollback the trm.Transaction.

func (*Transaction) Transaction

func (t *Transaction) Transaction() interface{}

Transaction returns the real transaction mongo.Session.