mongodb

Documentation

Index

• Variables
• func Client() *mongo.Client
• func DB(name string, opts ...*options.DatabaseOptions) *mongo.Database
• type A
• type Config
  • func DefaultConfig(key string) *Config
  • func StdConfig(key string, optionFunc ...OptionFunc) *Config
  • func (c *Config) Build() *Mongo
  • func (c *Config) Path() string
• type D
• type E
• type M
• type Mongo
  • func (mgo *Mongo) Client() *mongo.Client
  • func (mgo *Mongo) DB(db string, opts ...*options.DatabaseOptions) *mongo.Database
  • func (mgo *Mongo) Name() string
  • func (mgo *Mongo) Serve(ctx context.Context) error
  • func (mgo *Mongo) Shutdown(ctx context.Context) error
• type Monitor
  • func (mon *Monitor) CommandMonitor() *event.CommandMonitor
  • func (mon *Monitor) PoolEventMonitor() *event.PoolMonitor
• type OptionFunc
  • func WithCommandMonitor(monitor *event.CommandMonitor) OptionFunc
  • func WithPoolMonitor(monitor *event.PoolMonitor) OptionFunc

Variables

var (
	ErrClientDisconnected  = mongo.ErrClientDisconnected
	ErrEmptySlice          = mongo.ErrEmptySlice
	ErrInvalidIndexValue   = mongo.ErrInvalidIndexValue
	ErrMissingResumeToken  = mongo.ErrMissingResumeToken
	ErrMultipleIndexDrop   = mongo.ErrMultipleIndexDrop
	ErrNilCursor           = mongo.ErrNilCursor
	ErrNilDocument         = mongo.ErrNilDocument
	ErrNoDocuments         = mongo.ErrNoDocuments
	ErrNonStringIndexName  = mongo.ErrNonStringIndexName
	ErrUnacknowledgedWrite = mongo.ErrUnacknowledgedWrite
	ErrWrongClient         = mongo.ErrWrongClient
)

var (
	Default = StdConfig("default").Build()
)

Functions

func Client

func Client() *mongo.Client

func DB

func DB(name string, opts ...*options.DatabaseOptions) *mongo.Database

Types

type A

type A = bson.A

type Config

type Config struct {
	URI                  string `config:"uri" desc:"mongodb uri string."`
	EnableCommandMonitor bool   `config:"commandMonitor"`
	EnablePoolMonitor    bool   `config:"poolMonitor"`
	// contains filtered or unexported fields
}

func DefaultConfig

func DefaultConfig(key string) *Config

func StdConfig

func StdConfig(key string, optionFunc ...OptionFunc) *Config

func (*Config) Build

func (c *Config) Build() *Mongo

func (*Config) Path

func (c *Config) Path() string

type D

type D = bson.D

type E

type E = bson.E

type M

type M = bson.M

type Mongo

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

func (*Mongo) Client

func (mgo *Mongo) Client() *mongo.Client

func (*Mongo) DB

func (mgo *Mongo) DB(db string, opts ...*options.DatabaseOptions) *mongo.Database

func (*Mongo) Name

func (mgo *Mongo) Name() string

func (*Mongo) Serve

func (mgo *Mongo) Serve(ctx context.Context) error

func (*Mongo) Shutdown

func (mgo *Mongo) Shutdown(ctx context.Context) error

type Monitor

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

func (*Monitor) CommandMonitor

func (mon *Monitor) CommandMonitor() *event.CommandMonitor

func (*Monitor) PoolEventMonitor

func (mon *Monitor) PoolEventMonitor() *event.PoolMonitor

type OptionFunc

type OptionFunc func(*Config)

func WithCommandMonitor

func WithCommandMonitor(monitor *event.CommandMonitor) OptionFunc

func WithPoolMonitor

func WithPoolMonitor(monitor *event.PoolMonitor) OptionFunc