Skip to content

yeeuu/mongo

Repository files navigation

mongo

GoDoc Build Status codecov Go Report Card

Simple ODM wraps mgo with interface.

Design

  1. Wrap MongoDB operations with interface{} for TDD development friendly. E.X. gomock
  2. Strongly-typed queryset.

Feature

  1. interface wraps for mgo.
  2. Strongly-typed queryset support.

TODO

  • 0.1.0 release
  • Test coverage
  • Travis-ci support

Limits

Do not support complex mongo query for now.

More limits need to discovery :D

All API design may change in the future until reach 1.0

Usage

type user struct {
	ID       bson.ObjectId `bson:"_id,omitempty"`
	Name     string        `bson:"name"`
	LastIP   string        `bson:"last_ip"`
	LastTime time.Time     `bson:"last_time"`
}

type userSelector struct {
	ID   *bson.ObjectId   `bson:"_id"`
	IDs  *[]bson.ObjectId `bson:"_id"`
	Name *string          `bson:"name"`
}

func (us *userSelector) Database() string {
	return "test"
}

func (us *userSelector) Collection() string {
	return "users"
}

func main() {
	sess, err := mgo.DialWithTimeout("127.0.0.1", 2*time.Second)
	if err != nil {
		panic(err)
	}
	store := mongo.NewStorage(sess)
	err = store.Query(&userSelector{}).Insert(user{Name: "hello"})
	if err != nil {
		panic(err)
}