mongodb

package

v1.0.0-beta.19 Latest Latest Go to latest Published: Apr 6, 2021 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/boxgo/box

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Client() *mongo.Client
func DB(name string, opts ...*options.DatabaseOptions) *mongo.Database
type A
type Binary
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 DateTime
type Decimal128
type E
type JavaScript
type M
type MaxKey
type MinKey
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 Null
type ObjectID
type OptionFunc
- func WithCommandMonitor(monitor *event.CommandMonitor) OptionFunc
- func WithPoolMonitor(monitor *event.PoolMonitor) OptionFunc
type Regex
type Symbol
type Timestamp
type Undefined

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrDecodeToNil         = bson.ErrDecodeToNil
	ErrNilContext          = bson.ErrNilContext
	ErrNilReader           = bson.ErrNilReader
	ErrNilRegistry         = bson.ErrNilRegistry
	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
	ErrParseNaN            = primitive.ErrParseNaN
	ErrParseInf            = primitive.ErrParseInf
	ErrParseNegInf         = primitive.ErrParseNegInf
)

View Source

var (
	CompareTimestamp          = primitive.CompareTimestamp
	NewDateTimeFromTime       = primitive.NewDateTimeFromTime
	NewDecimal128             = primitive.NewDecimal128
	ParseDecimal128           = primitive.ParseDecimal128
	ParseDecimal128FromBigInt = primitive.ParseDecimal128FromBigInt
	NewObjectID               = primitive.NewObjectID
	NewObjectIDFromTimestamp  = primitive.NewObjectIDFromTimestamp
	ObjectIDFromHex           = primitive.ObjectIDFromHex
)

View Source

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

Functions ¶

func Client ¶ added in v1.0.0

func Client() *mongo.Client

func DB ¶ added in v1.0.0

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

Types ¶

type A ¶

type A = primitive.A

type Binary ¶ added in v1.0.0

type Binary = primitive.Binary

type Config ¶ added in v1.0.0

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 ¶ added in v1.0.0

func DefaultConfig(key string) *Config

func StdConfig ¶ added in v1.0.0

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

func (*Config) Build ¶ added in v1.0.0

func (c *Config) Build() *Mongo

func (*Config) Path ¶ added in v1.0.0

func (c *Config) Path() string

type D ¶

type D = primitive.D

type DateTime ¶ added in v1.0.0

type DateTime = primitive.DateTime

type Decimal128 ¶ added in v1.0.0

type Decimal128 = primitive.Decimal128

type E ¶

type E = primitive.E

type JavaScript ¶ added in v1.0.0

type JavaScript = primitive.JavaScript

type M ¶

type M = primitive.M

type MaxKey ¶ added in v1.0.0

type MaxKey = primitive.MaxKey

type MinKey ¶ added in v1.0.0

type MinKey = primitive.MinKey

type Mongo ¶

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

func (*Mongo) Client ¶ added in v1.0.0

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

func (*Mongo) DB ¶ added in v1.0.0

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 Null ¶ added in v1.0.0

type Null = primitive.Null

type ObjectID ¶ added in v1.0.0

type ObjectID = primitive.ObjectID

type OptionFunc ¶

type OptionFunc func(*Config)

func WithCommandMonitor ¶

func WithCommandMonitor(monitor *event.CommandMonitor) OptionFunc

func WithPoolMonitor ¶

func WithPoolMonitor(monitor *event.PoolMonitor) OptionFunc

type Regex ¶ added in v1.0.0

type Regex = primitive.Regex

type Symbol ¶ added in v1.0.0

type Symbol = primitive.Symbol

type Timestamp ¶ added in v1.0.0

type Timestamp = primitive.Timestamp

type Undefined ¶ added in v1.0.0

type Undefined = primitive.Undefined

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL