README
¶
#Simple Model All model are struct type
package main
import (
"github.com/elsonwu/mgorm"
)
type User struct {
mgorm.Model `bson:",inline" json:",inline"` //embed all base methods
Username string `bson:"username" json:"username"`
Email string `bson:"email" json:"email"`
}
func (self *User) CollectionName() string {
return "user"
}
#Embedded Model
type User struct {
mgorm.Model `bson:",inline" json:",inline"` //embed all base methods
Username string `bson:"username" json:"username"`
Email string `bson:"email" json:"email"`
Profile UserProfile `bson:"profile" json:"profile"`
}
type UserProfile struct {
mgorm.EmbeddedModel `bson:",inline" json:"-"` //use mgorm.EmbeddedModel
SecondaryEmail string `bson:"secondary_email" json:"secondary_email"`
Website string `bson:"website" json:"website"`
}
#FindById
user := new(User)
err := mgorm.FindById(user, "51ffc45fad51987c28276e55")
if nil != err {
fmt.Println(err)
}
#Find One
user := new(User)
criteria := mgorm.NewCriteria()
criteria.AddCond("username", "==", "elsonwu")
mgorm.Find(user, criteria)
fmt.Println(user)
#Find List
criteria := mgorm.NewCriteria()
criteria.SetLimit(3)
criteria.SetOffset(10)
criteria.SetSelect([]string{"email"})
criteria.AddSort("username", mgorm.CriteriaSortDesc)
users := make([]User, 3)
mgorm.FindAll(user, criteria).All(&users)
fmt.Println(users)
#Create One
user := new(User)
if !mgorm.Save(user) {
fmt.Println(user.GetErrors())
}
#Update One
user.Email = "test@gmail.com"
if !mgorm.Save(user) {
fmt.Println(user.GetErrors())
}
#Error
user.AddError("Test the error")
if !mgorm.Save(user) {
fmt.Println(user.GetErrors())
//[Test the error]
}
#Validate
//use tag rules for field's validation
type User struct {
mgorm.Model bson:",inline" json:",inline" //embed all base methods
Username string bson:"username" json:"username"
Email string bson:"email" json:"email" rules:"email"
Profile UserProfile bson:"profile" json:"profile"
}
type UserProfile struct {
mgorm.EmbeddedModel `bson:",inline" json:"-"` //use mgorm.EmbeddedModel
SecondaryEmail string `bson:"secondary_email" json:"secondary_email" rules:"email"`
Website string `bson:"website" json:"website" rules:"url"`
}
user := new(User)
if mgorm.Validate(user) {
fmt.Println(user.GetErrors(), user.Profile.GetErrors())
}
//When you run Save method, it will call Validate method automatically.
if !user.Save() {
fmt.Println(user.GetErrors(), user.Profile.GetErrors())
}
//You can also do more validate in your model, it will run when validating
func (self *User) Validate() bool {
//Don't forget to call the parent's Validate
if !self.Model.Validate() {
return false
}
if self.Username == "Admin" {
self.AddError("You cannot use Admin as your username")
return false
}
return true
}
#Event ##built-in event
user.Username = "Admin"
//The event name is case insensitive, so here you can also use "beforesave"
user.On("BeforeSave", func() error {
if "Admin" == user.Username {
return errors.New("You cannot use Admin")
}
return nil
})
if !mgorm.Save(user) {
fmt.Println(user.GetErrors())
//[You cannot use Admin]
}
##Customized event
//You can emit the event manually
user.Username = "Admin"
user.On("TestEvent", func() error {
if "Admin" == user.Username {
return errors.New("You cannot use Admin")
}
return nil
})
//Notice: the event name is case insensitive
err := user.Emit("testevent")
if nil != err {
fmt.Println(err)
//You cannot use Admin
}
Documentation
¶
Index ¶
- Constants
- func Collection(name string) *mgo.Collection
- func DB() *mgo.Database
- func EmailValidator(fieldValue reflect.Value, fieldType reflect.StructField) error
- func Find(model IModel, criteria ICriteria) error
- func FindById(model IModel, id string) error
- func InitDB(connectString, dbName string) error
- func Insert(model IModel) bool
- func Save(model IModel) bool
- func Update(model IModel, attributes Map) bool
- func UrlValidator(fieldValue reflect.Value, fieldType reflect.StructField) error
- func Validate(model IEmbeddedModel) bool
- type Criteria
- func (self *Criteria) AddCond(field, opt string, value interface{}) ICriteria
- func (self *Criteria) AddSort(field string, sort int) ICriteria
- func (self *Criteria) GetConditions() Map
- func (self *Criteria) GetLimit() int
- func (self *Criteria) GetOffset() int
- func (self *Criteria) GetSelect() []string
- func (self *Criteria) GetSort() map[string]int
- func (self *Criteria) SetConditions(conditions Map) ICriteria
- func (self *Criteria) SetLimit(limit int) ICriteria
- func (self *Criteria) SetOffset(offset int) ICriteria
- func (self *Criteria) SetSelect(selects []string) ICriteria
- func (self *Criteria) SetSort(sort map[string]int) ICriteria
- type EmbeddedModel
- type ErrorHandler
- type Event
- type EventFn
- type ICriteria
- type IEmbeddedModel
- type IErrorHandler
- type IEvent
- type IModel
- type IValidator
- type Map
- type Model
- type Query
- type ValidateFn
Constants ¶
View Source
const CriteriaSortAsc int = 1
View Source
const CriteriaSortDesc int = -1
View Source
const EXP_EMAIL = `^[a-z0-9._%+\-]+@[a-z0-9.\-]+\.[a-z]{2,4}$`
View Source
const EXP_URL = `` /* 344-byte string literal not displayed */
Variables ¶
This section is empty.
Functions ¶
func Collection ¶
func Collection(name string) *mgo.Collection
func EmailValidator ¶
func EmailValidator(fieldValue reflect.Value, fieldType reflect.StructField) error
func UrlValidator ¶
func UrlValidator(fieldValue reflect.Value, fieldType reflect.StructField) error
func Validate ¶
func Validate(model IEmbeddedModel) bool
Types ¶
type Criteria ¶
type Criteria struct {
// contains filtered or unexported fields
}
func (*Criteria) GetConditions ¶
func (*Criteria) SetConditions ¶
type EmbeddedModel ¶
type EmbeddedModel struct {
ErrorHandler `bson:",inline" json:"-"`
Event `bson:",inline" json:"-"`
}
func (*EmbeddedModel) Validate ¶
func (self *EmbeddedModel) Validate() bool
type ErrorHandler ¶
type ErrorHandler struct {
// contains filtered or unexported fields
}
func (*ErrorHandler) AddError ¶
func (self *ErrorHandler) AddError(err string)
func (*ErrorHandler) ClearErrors ¶
func (self *ErrorHandler) ClearErrors()
func (*ErrorHandler) GetErrors ¶
func (self *ErrorHandler) GetErrors() []error
func (*ErrorHandler) HasErrors ¶
func (self *ErrorHandler) HasErrors() bool
type ICriteria ¶
type ICriteria interface {
AddSort(field string, sort int) ICriteria
SetSort(sort map[string]int) ICriteria
GetSort() map[string]int
SetSelect(selects []string) ICriteria
GetSelect() []string
GetLimit() int
SetLimit(limit int) ICriteria
GetOffset() int
SetOffset(offset int) ICriteria
GetConditions() Map
SetConditions(conditions Map) ICriteria
AddCond(field, opt string, value interface{}) ICriteria
}
func NewCriteria ¶
func NewCriteria() ICriteria
type IEmbeddedModel ¶
type IEmbeddedModel interface {
IErrorHandler
IValidator
IEvent
}
type IErrorHandler ¶
type IValidator ¶
type IValidator interface {
Validate() bool
}
type Model ¶
type Model struct {
EmbeddedModel `bson:",inline" json:"-"`
Id bson.ObjectId `bson:"_id" json:"id"`
// contains filtered or unexported fields
}
func (*Model) BeforeSave ¶
type ValidateFn ¶
type ValidateFn func(fieldValue reflect.Value, fieldType reflect.StructField) error
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.