mgorm

README

mgorm

Another Mongodb Library with ORM. Inspired by 'gorm' and 'pymongo' and based on 'globalsign/mgo'

Documentation

Index

• func GetRawSession(alias string) *mgo.Session
• func GetSession(alias string) *mgo.Session
• func Init(urls map[string]string) error
• func InitWithInfo(infos map[string]*mgo.DialInfo) error
• func IsErrDuplicate(err error) bool
• func IsErrNotFound(err error) bool
• type CloseFunc
• type FindOpt
  • func Limit(limit int) FindOpt
  • func Skip(skip int) FindOpt
  • func Sort(fields ...string) FindOpt
• type Iter
  • func (it *Iter) Close() error
• type Model
  • func NewModel(alias, db, collection string) Model
  • func (m *Model) C() (*mgo.Collection, CloseFunc)
  • func (m *Model) Count(selector interface{}) (int, error)
  • func (m *Model) CreateIndex(index mgo.Index) error
  • func (m *Model) Delete(selector bson.M) error
  • func (m *Model) DeleteAll(selector bson.M) error
  • func (m *Model) FindAll(result, selector interface{}, opts ...FindOpt) error
  • func (m *Model) FindID(result, id interface{}) error
  • func (m *Model) FindOne(result, selector interface{}) error
  • func (m *Model) GetIter(selector interface{}) *Iter
  • func (m *Model) Insert(docs ...interface{}) error
  • func (m *Model) Update(selector, update interface{}, opts ...UpdateOpt) error
  • func (m *Model) UpdateAll(selector, update interface{}) error
  • func (m *Model) UpdateID(id, update interface{}, opts ...UpdateOpt) error
• type OID
  • func ParseOIDFromString(s string) (OID, error)
  • func (o *OID) DecodeMsgpack(dec *msgpack.Decoder) error
  • func (o *OID) EncodeMsgpack(enc *msgpack.Encoder) error
  • func (o OID) GetBSON() (interface{}, error)
  • func (o OID) MarshalJSON() ([]byte, error)
  • func (o OID) ObjectID() bson.ObjectId
  • func (o *OID) SetBSON(raw bson.Raw) error
  • func (o OID) String() string
  • func (o *OID) UnmarshalJSON(b []byte) error
• type UpdateOpt
  • func Upsert() UpdateOpt

Functions

func GetRawSession

func GetRawSession(alias string) *mgo.Session

GetSession return original session for specified server alias

func GetSession

func GetSession(alias string) *mgo.Session

GetSession return an copy of original session for specified server alias

func Init

func Init(urls map[string]string) error

Init load configs: usls: <mongo-alias:url>

func InitWithInfo

func InitWithInfo(infos map[string]*mgo.DialInfo) error

func IsErrDuplicate

func IsErrDuplicate(err error) bool

IsErrDuplicate check if duplicate-key error

func IsErrNotFound

func IsErrNotFound(err error) bool

IsErrNotFound check if not-found error

Types

type CloseFunc

type CloseFunc func()

CloseFunc use for close session

type FindOpt

type FindOpt func(*findOpts)

FindOpt is option for find

func Limit

func Limit(limit int) FindOpt

Limit for result

func Skip

func Skip(skip int) FindOpt

Skip on cursor

func Sort

func Sort(fields ...string) FindOpt

Sort result

type Iter

type Iter struct {
	*mgo.Iter
	// contains filtered or unexported fields
}

Iter wrap original iter, add close function

func (*Iter) Close

func (it *Iter) Close() error

Close ...

type Model

type Model struct {
	MongoAlias     string
	DBName         string
	CollectionName string
}

Model for collection

func NewModel

func NewModel(alias, db, collection string) Model

NewModel make new model

func (*Model) C

func (m *Model) C() (*mgo.Collection, CloseFunc)

C get original colletion for Model

func (*Model) Count

func (m *Model) Count(selector interface{}) (int, error)

Count documents matching selector

func (*Model) CreateIndex

func (m *Model) CreateIndex(index mgo.Index) error

CreateIndex for Collection

func (*Model) Delete

func (m *Model) Delete(selector bson.M) error

Delete document matching selector

func (*Model) DeleteAll

func (m *Model) DeleteAll(selector bson.M) error

DeleteAll find all document matching selector and delete them

func (*Model) FindAll

func (m *Model) FindAll(result, selector interface{}, opts ...FindOpt) error

FindAll documents matching selector

func (*Model) FindID

func (m *Model) FindID(result, id interface{}) error

FindID find document by id

func (*Model) FindOne

func (m *Model) FindOne(result, selector interface{}) error

FindOne document by selector

func (*Model) GetIter

func (m *Model) GetIter(selector interface{}) *Iter

GetIter make an iter for selector

func (*Model) Insert

func (m *Model) Insert(docs ...interface{}) error

Insert documents

func (*Model) Update

func (m *Model) Update(selector, update interface{}, opts ...UpdateOpt) error

Update document matching selector

func (*Model) UpdateAll

func (m *Model) UpdateAll(selector, update interface{}) error

UpdateAll finds all documents matching the provided selector document and update them

func (*Model) UpdateID

func (m *Model) UpdateID(id, update interface{}, opts ...UpdateOpt) error

UpdateID updata document matching ID

type OID

type OID bson.ObjectId

OID fit for json, bson and msgpack

func ParseOIDFromString

func ParseOIDFromString(s string) (OID, error)

ParseOIDFromString parse oid from string

func (*OID) DecodeMsgpack

func (o *OID) DecodeMsgpack(dec *msgpack.Decoder) error

DecodeMsgpack decode oid from Msgpack

func (*OID) EncodeMsgpack

func (o *OID) EncodeMsgpack(enc *msgpack.Encoder) error

EncodeMsgpack encode oid to Msgpack

func (OID) GetBSON

func (o OID) GetBSON() (interface{}, error)

GetBSON for saving to mongodb

func (OID) MarshalJSON

func (o OID) MarshalJSON() ([]byte, error)

MarshalJSON marshal oid to json

func (OID) ObjectID

func (o OID) ObjectID() bson.ObjectId

ObjectID value of OID

func (*OID) SetBSON

func (o *OID) SetBSON(raw bson.Raw) error

SetBSON for getting from mongodb

func (OID) String

func (o OID) String() string

String of OID

func (*OID) UnmarshalJSON

func (o *OID) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshal oid from json

type UpdateOpt

type UpdateOpt func(*updateOpts)

UpdateOpt is option for update

func Upsert

func Upsert() UpdateOpt

Upsert option