Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

mongo

package module

Go to main page

Versions in this module

v1

v1.2.8

Jun 13, 2023

v1.2.1

Jun 12, 2023

v1.2.0

Jun 12, 2023

v1.1.0

Mar 15, 2023

Changes in this version

type ORM

+ func (orm *ORM) Exist() (bool, error)

v1.0.0

Jan 24, 2023

Changes in this version

+ const IndexTypeAscending

+ const IndexTypeDescending

+ const IndexTypeGeo2d

+ const IndexTypeGeo2dSphere

+ const IndexTypeGeoHaystack

+ const IndexTypeHashed

+ const IndexTypeText

+ const UpdateInc

+ const UpdatePop

+ const UpdatePull

+ const UpdatePush

+ const UpdateSet

+ const UpdateUnset

+ var ErrTargetNotSettable = errors.New("[scanner]: target is not settable! a pointer is required")

+ func ObjectID2String(v ObjectID) string

+ func ObjectIDIsZero(id T) bool

+ func SimpleAggregate()

+ func SimpleBulkWrite()

+ func SimpleCount()

+ func SimpleCreateIndex()

+ func SimpleDistinct()

+ func SimpleFindDocs()

+ func SimpleFindDocs2()

+ func SimpleFindOne()

+ func SimpleFindOneAndDelete()

+ func SimpleFindOneAndReplace()

+ func SimpleFindOneAndUpdate()

+ func SimpleInsertDoc()

+ func SimpleInsertDocs()

+ func SimpleMixQ()

+ func SimpleMongoNotQ()

+ func SimpleMongoOrmQueryInsertOne()

+ func SimpleMongoQ()

+ func SimpleNewMongoQuery()

+ func SimpleNewMongoQuery2()

+ func SimpleNewMongoQuery3()

+ func SimpleOrm()

+ func SimpleProjection()

+ func SimpleRef()

+ func SimpleUpdateMany()

+ func SimpleUpdateOne()

+ func Struct2Map(raw interface{}, excludeKey ...string) map[string]interface

+ func TransSession(cli *Client, fn func(sessionCtx SessionContext) error) error

+ type BasicFindOptions struct

+ func (op *BasicFindOptions) Projection(projectionMap map[string]interface{}) *BasicFindOptions

+ func (op *BasicFindOptions) Select(cols []string) *BasicFindOptions

+ func (op *BasicFindOptions) Sort(cols []string) *BasicFindOptions

+ type BasicUpdateOptions struct

+ func (op *BasicUpdateOptions) Upsert(b bool) *BasicUpdateOptions

+ type BulkWriteModel struct

+ func NewBulkWriteModel() *BulkWriteModel

+ func (bwm *BulkWriteModel) AddDeleteManyModel(filter *Query) *BulkWriteModel

+ func (bwm *BulkWriteModel) AddDeleteOneModel(filter *Query) *BulkWriteModel

+ func (bwm *BulkWriteModel) AddInsertOneModel(doc interface{}) *BulkWriteModel

+ func (bwm *BulkWriteModel) AddNewReplaceOneModel(filter *Query, replaceDoc map[string]interface{}, upsert bool) *BulkWriteModel

+ func (bwm *BulkWriteModel) AddUpdateManyCustomModel(filter *Query, update updateType, upDoc map[string]interface{}, upsert bool) *BulkWriteModel

+ func (bwm *BulkWriteModel) AddUpdateManyModel(filter *Query, upDoc map[string]interface{}, upsert bool) *BulkWriteModel

+ func (bwm *BulkWriteModel) AddUpdateOneCustomModel(filter *Query, update updateType, upDoc map[string]interface{}, upsert bool) *BulkWriteModel

+ func (bwm *BulkWriteModel) AddUpdateOneModel(filter *Query, upDoc map[string]interface{}, upsert bool) *BulkWriteModel

+ func (bwm *BulkWriteModel) Empty() bool

+ func (bwm *BulkWriteModel) SetOrdered(ordered bool) *BulkWriteModel

+ type BulkWriteResult struct

+ DeletedCount int64

+ InsertedCount int64

+ MatchedCount int64

+ ModifiedCount int64

+ UpsertedCount int64

+ UpsertedIDs map[int64]interface{}

+ type Client struct

+ func Connection(ctx context.Context, appName string, mongoConf *Conf) *Client

+ func NewClient(ctx context.Context, opt *ClientOptions) (*Client, error)

+ func (c *Client) Ctx() context.Context

+ func (c *Client) Database(dbName string) *Database

+ func (c *Client) NewSession(fn func(sessionCtx SessionContext) error) error

+ func (c *Client) Ping(ctx context.Context) error

+ func (c *Client) TryDatabase(dbName string) (db *Database, exist bool, err error)

+ type ClientOptions struct

+ func CreateEmptyOptions() *ClientOptions

+ func OptionsFromURI(uri string) *ClientOptions

+ type Collection struct

+ func (c *Collection) Aggregate(ctx context.Context, results interface{}, serverMaxTime *time.Duration, ...) error

+ func (c *Collection) BulkWrite(ctx context.Context, bwm *BulkWriteModel) (*BulkWriteResult, error)

+ func (c *Collection) Count(ctx context.Context, filter *Query, opts *CountOptions) (int64, error)

+ func (c *Collection) CreateManyIndex(ctx context.Context, indexList []ManyIndex) error

+ func (c *Collection) CreateOneIndex(ctx context.Context, indexName string, keys []Index, indexUnique bool) error

+ func (c *Collection) DeleteMany(ctx context.Context, filter *Query) (*DeleteResult, error)

+ func (c *Collection) DeleteOne(ctx context.Context, filter *Query) (*DeleteResult, error)

+ func (c *Collection) Distinct(ctx context.Context, fieldName string, filter *Query, ...) ([]interface{}, error)

+ func (c *Collection) FindDocs(ctx context.Context, filter *Query, results interface{}, opts *FindOptions) error

+ func (c *Collection) FindOne(ctx context.Context, filter *Query, result interface{}, opts *FindOneOptions) error

+ func (c *Collection) FindOneAndDelete(ctx context.Context, filter *Query, delDoc interface{}, opts *FindOneAndDelete) error

+ func (c *Collection) FindOneAndReplace(ctx context.Context, filter *Query, newDoc map[string]interface{}, ...) error

+ func (c *Collection) FindOneAndUpdate(ctx context.Context, filter *Query, upDoc map[string]interface{}, ...) error

+ func (c *Collection) FindOneAndUpdateCustom(ctx context.Context, filter *Query, customDoc map[string]interface{}, ...) error

+ func (c *Collection) InsertDoc(ctx context.Context, doc map[string]interface{}) (string, error)

+ func (c *Collection) InsertDocs(ctx context.Context, docs []interface{}, ordered bool) ([]string, error)

+ func (c *Collection) ReplaceOne(ctx context.Context, filter *Query, replaceDoc map[string]interface{}, ...) (*UpdateResult, error)

+ func (c *Collection) UpdateMany(ctx context.Context, filter *Query, upDoc map[string]interface{}, opts *Update) (*UpdateResult, error)

+ func (c *Collection) UpdateManyCustom(ctx context.Context, filter *Query, update updateType, ...) (*UpdateResult, error)

+ func (c *Collection) UpdateOne(ctx context.Context, filter *Query, upDoc map[string]interface{}, opts *Update) (*UpdateResult, error)

+ func (c *Collection) UpdateOneCustom(ctx context.Context, filter *Query, update updateType, ...) (*UpdateResult, error)

+ type Conf struct

+ AuthDB string

+ AuthMechanism string

+ Connect bool

+ ConnectTimeoutMS int

+ DB string

+ HostMaster string

+ HostSlave string

+ Pass string

+ ReplicaSet string

+ ServerSelectionTimeoutMS int

+ User string

+ type CountOptions struct

+ func NewCount() *CountOptions

+ func (op *CountOptions) Limit(i int64) *CountOptions

+ func (op *CountOptions) Skip(i int64) *CountOptions

+ type Database struct

+ func (db *Database) Collection(name string) *Collection

+ func (db *Database) TryCollection(name string) (c *Collection, exist bool, err error)

+ type DeleteResult struct

+ DeletedCount int64

+ type FindOneAndDelete struct

+ func NewFindOneAndDelete() *FindOneAndDelete

+ type FindOneAndReplace struct

+ func NewFindOneAndReplace() *FindOneAndReplace

+ type FindOneAndUpdate struct

+ func NewFindOneAndUpdate() *FindOneAndUpdate

+ type FindOneOptions struct

+ func NewFindOneOptions() *FindOneOptions

+ func (op *FindOneOptions) Skip(i int64) *FindOneOptions

+ type FindOptions struct

+ func NewFindOptions() *FindOptions

+ func (op *FindOptions) Limit(i int64) *FindOptions

+ func (op *FindOptions) Page(no int64, size int64) *FindOptions

+ type Foreign struct

+ ID ObjectID

+ Ref string

+ func ToRefData(r *Reference, data *T) (*Foreign[T], error)

+ func (r *Foreign[T]) GetData(ctx context.Context, db *Database) (*T, error)

+ func (r *Foreign[T]) ToData(ctx context.Context, db *Database, data interface{}) error

+ type ForeignList []*Foreign[T]

+ func ToRefListData(r *Reference, data DT) (ForeignList[T], error)

+ func (r ForeignList[T]) GetData(ctx context.Context, db *Database) ([]*T, error)

+ func (r ForeignList[T]) ToData(ctx context.Context, db *Database, data interface{}) error

+ type Index struct

+ Key string

+ Value interface{}

+ type Limit = []uint

+ type ManyIndex struct

+ IndexData []Index

+ IndexName string

+ Unique bool

+ type ORM struct

+ Q *mongoOrmQ

+ func NewORMByClient(ctx context.Context, cli *Client, dbName, tbName string, ref *Reference) *ORM

+ func NewORMByDB(ctx context.Context, db *Database, tbName string, ref *Reference) *ORM

+ func (orm *ORM) BulkWrite(bwm *BulkWriteModel) (*BulkWriteResult, error)

+ func (orm *ORM) ClearCache() *ORM

+ func (orm *ORM) Client() *Client

+ func (orm *ORM) Collection() *Collection

+ func (orm *ORM) Cond() *Query

+ func (orm *ORM) Count(clearCache bool) (int64, error)

+ func (orm *ORM) Database() *Database

+ func (orm *ORM) DeleteMany() (*DeleteResult, error)

+ func (orm *ORM) DeleteOne() (*DeleteResult, error)

+ func (orm *ORM) Distinct(b bool) *ORM

+ func (orm *ORM) InsertMany(data []interface{}, ordered bool) ([]string, error)

+ func (orm *ORM) InsertOne(data interface{}) (string, error)

+ func (orm *ORM) KeepQuery(b bool) *ORM

+ func (orm *ORM) Limit(size uint) *ORM

+ func (orm *ORM) Order(cols ...string) *ORM

+ func (orm *ORM) OverLimit(over, size uint) *ORM

+ func (orm *ORM) Page(pageNo, pageSize uint) *ORM

+ func (orm *ORM) PageData(target interface{}, pageNo, pageSize uint) (*Paging, error)

+ func (orm *ORM) Projection(col string, value interface{}) *ORM

+ func (orm *ORM) Projections(where Where) *ORM

+ func (orm *ORM) Query(pair ...interface{}) *ORM

+ func (orm *ORM) ReplaceOne(data map[string]interface{}, upsert bool) (*UpdateResult, error)

+ func (orm *ORM) Select(cols ...string) *ORM

+ func (orm *ORM) ToData(target interface{}) (err error)

+ func (orm *ORM) ToJSON() string

+ func (orm *ORM) UpdateMany(data map[string]interface{}, upsert bool) (*UpdateResult, error)

+ func (orm *ORM) UpdateManyCustom(update updateType, data map[string]interface{}, upsert bool) (*UpdateResult, error)

+ func (orm *ORM) UpdateOne(data map[string]interface{}, upsert bool) (*UpdateResult, error)

+ func (orm *ORM) UpdateOneCustom(update updateType, data map[string]interface{}, upsert bool) (*UpdateResult, error)

+ func (orm *ORM) Where(col string, value interface{}) *ORM

+ func (orm *ORM) Wheres(where Where) *ORM

+ type ObjectID = primitive.ObjectID

+ func NewObjectID() ObjectID

+ func String2ObjectID(v string) (hex ObjectID, err error)

+ func TryString2ObjectID(v string) ObjectID

+ type Order = []string

+ type Paging struct

+ PageNo int

+ PageSize int

+ PageTotal int

+ Total int

+ type Projection = map[string]interface

+ type Query struct

+ func MixQ(cond map[string]interface{}) *Query

+ func NewAnd(filter ...*Query) *Query

+ func NewNor(filter ...*Query) *Query

+ func NewOr(filter ...*Query) *Query

+ func NewQuery() *Query

+ func NotQ(key string, value interface{}) *Query

+ func Q(key string, value interface{}) *Query

+ func (q *Query) And(filter ...*Query) *Query

+ func (q *Query) Cond() map[string]interface{}

+ func (q *Query) Empty() bool

+ func (q *Query) JSON() string

+ func (q *Query) Nor(filter ...*Query) *Query

+ func (q *Query) Or(filter ...*Query) *Query

+ func (q *Query) SetRawCond(cond map[string]interface{}) *Query

+ type RefWhere = map[string]interface

+ type Reference struct

+ func NewReference() *Reference

+ func (r *Reference) AddTableDef(tbName string, def interface{})

+ func (r *Reference) BuildRefs()

+ type Replace struct

+ func NewReplace() *Replace

+ type Select = []string

+ type SessionContext = mongo.SessionContext

+ type Tb1 struct

+ ID ObjectID

+ Ref *Foreign[Tb2]

+ Ref2 ForeignList[Tb3]

+ Txt string

+ type Tb2 struct

+ ID string

+ Name string

+ Ref *Foreign[Tb3]

+ type Tb3 struct

+ ID string

+ Txt string

+ type Update struct

+ func NewUpdate() *Update

+ type UpdateResult struct

+ MatchedCount int64

+ ModifiedCount int64

+ UpsertedCount int64

+ UpsertedID interface{}

+ type Where = map[string]interface