mgo

Documentation

Index

• type BreakerOption
• type DbAgent
  • func NewMajorAgent(option MajorOption) (DbAgent, error)
• type DbClient
  • func New(agent DbAgent, option Option) *DbClient
  • func (mgo *DbClient) Close(ctx context.Context) error
  • func (mgo *DbClient) Do(ctx context.Context, ...) error
  • func (mgo *DbClient) DoWithPartition(ctx context.Context, part int, ...) error
  • func (mgo *DbClient) LongTimeDo(ctx context.Context, ...) error
• type DoOption
  • func (option *DoOption) SetPartition(partID int)
• type MajorOption
• type Option
  • func (opt Option) AddClientMid(mid client.DoMiddle) Option
  • func (opt Option) SetBreaker(abnormalLimiter *rate.Limiter, recoveryWaitMax time.Duration, ...) Option
  • func (opt Option) SetParallel(parallel int) Option
  • func (opt Option) SetRecorder(recorders record.Factory) Option

Types

type BreakerOption

type BreakerOption struct {
	AbnormalLimiter *rate.Limiter
	RecoveryWaitMax time.Duration
	RecoveryWaitMin time.Duration
}

type DbAgent

type DbAgent interface {
	GetDB(ctx context.Context) (db *mongo.Database, err error)
	client.Recoverable
	client.Agent
}

func NewMajorAgent

func NewMajorAgent(option MajorOption) (DbAgent, error)

type DbClient

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

func New

func New(agent DbAgent, option Option) *DbClient

func (*DbClient) Close

func (mgo *DbClient) Close(ctx context.Context) error

func (*DbClient) Do

func (mgo *DbClient) Do(ctx context.Context, action func(ctx context.Context, db *mongo.Database) error) error

func (*DbClient) DoWithPartition

func (mgo *DbClient) DoWithPartition(ctx context.Context, part int, action func(ctx context.Context, db *mongo.Database) error) error

func (*DbClient) LongTimeDo

func (mgo *DbClient) LongTimeDo(ctx context.Context, action func(ctx context.Context, db *mongo.Database) error) error

type DoOption

type DoOption struct {
	PartID *int
}

func (*DoOption) SetPartition

func (option *DoOption) SetPartition(partID int)

type MajorOption

type MajorOption struct {
	*options.ClientOptions
	Parallel int
	Database string
}

type Option

type Option struct {
	Parallel      *int
	Record        *record.Factory
	Breaker       *BreakerOption
	ClientMiddles []client.DoMiddle
}

func (Option) AddClientMid

func (opt Option) AddClientMid(mid client.DoMiddle) Option

func (Option) SetBreaker

func (opt Option) SetBreaker(abnormalLimiter *rate.Limiter, recoveryWaitMax time.Duration, recoveryWaitMin time.Duration) Option

func (Option) SetParallel

func (opt Option) SetParallel(parallel int) Option

func (Option) SetRecorder

func (opt Option) SetRecorder(recorders record.Factory) Option