db via interfaces

This commit is contained in:
Sebastian Frank 2022-02-09 15:11:15 +01:00
parent 09b3faa8da
commit b0af52178c
Signed by: apairon
GPG Key ID: A0E05A8199CE3F57
5 changed files with 180 additions and 25 deletions

22
crud.go

@ -7,7 +7,6 @@ import (
"strings" "strings"
"time" "time"
mgo "gopkg.in/mgo.v2"
"gopkg.in/mgo.v2/bson" "gopkg.in/mgo.v2/bson"
) )
@ -28,7 +27,7 @@ func (e *ErrorWithStack) Stack() string {
} }
// CreateDocument creates a document from specified model // CreateDocument creates a document from specified model
func CreateDocument(db *mgo.Database, m ModelInterface) error { func CreateDocument(db *Database, m ModelInterface) error {
m.PrepareInsert() m.PrepareInsert()
c := db.C(GetCollectionName(m)) c := db.C(GetCollectionName(m))
@ -38,7 +37,7 @@ func CreateDocument(db *mgo.Database, m ModelInterface) error {
} }
// ReadDocument gets one document via its id // ReadDocument gets one document via its id
func ReadDocument(db *mgo.Database, m ModelInterface, selector bson.M) error { func ReadDocument(db *Database, m ModelInterface, selector bson.M) error {
c := db.C(GetCollectionName(m)) c := db.C(GetCollectionName(m))
q := c.FindId(m.GetID()) q := c.FindId(m.GetID())
@ -137,7 +136,7 @@ func idToObjectID(filter interface{}) {
} }
// ReadCollection gets the filtered collection of the model // ReadCollection gets the filtered collection of the model
func ReadCollection(db *mgo.Database, results interface{}, filter bson.M, selector bson.M, offset int, limit int, sort []string, pipelineModifier PipelineModifierFunction) (err error) { func ReadCollection(db *Database, results interface{}, filter bson.M, selector bson.M, offset int, limit int, sort []string, pipelineModifier PipelineModifierFunction) (err error) {
defer func() { defer func() {
if r := recover(); r != nil { if r := recover(); r != nil {
err = &ErrorWithStack{Message: fmt.Sprintf("%v", r), StackTrace: string(debug.Stack())} err = &ErrorWithStack{Message: fmt.Sprintf("%v", r), StackTrace: string(debug.Stack())}
@ -212,8 +211,7 @@ func ReadCollection(db *mgo.Database, results interface{}, filter bson.M, select
pipeline = pipelineModifier(pipeline) pipeline = pipelineModifier(pipeline)
} }
q := c.Pipe(pipeline).AllowDiskUse().Iter() _err = c.Pipe(pipeline).All(results)
_err = q.All(results)
} else { } else {
// search without pipe is faster // search without pipe is faster
@ -245,7 +243,7 @@ func ReadCollection(db *mgo.Database, results interface{}, filter bson.M, select
} }
// ReadCollectionCount gets the count of elements in filtered collection // ReadCollectionCount gets the count of elements in filtered collection
func ReadCollectionCount(db *mgo.Database, m ModelInterface, filter bson.M) (count int, err error) { func ReadCollectionCount(db *Database, m ModelInterface, filter bson.M) (count int, err error) {
defer func() { defer func() {
if r := recover(); r != nil { if r := recover(); r != nil {
err = fmt.Errorf("%v", r) err = fmt.Errorf("%v", r)
@ -257,7 +255,7 @@ func ReadCollectionCount(db *mgo.Database, m ModelInterface, filter bson.M) (cou
} }
// UpdateDocument updates a document from specified model // UpdateDocument updates a document from specified model
func UpdateDocument(db *mgo.Database, m ModelInterface, changes bson.M) error { func UpdateDocument(db *Database, m ModelInterface, changes bson.M) error {
m.PrepareUpdate() m.PrepareUpdate()
changes["updateTime"] = time.Now() changes["updateTime"] = time.Now()
@ -268,7 +266,7 @@ func UpdateDocument(db *mgo.Database, m ModelInterface, changes bson.M) error {
} }
// UpsertDocument updates a document from specified model or inserts it, of not found // UpsertDocument updates a document from specified model or inserts it, of not found
func UpsertDocument(db *mgo.Database, m ModelInterface, changes bson.M) error { func UpsertDocument(db *Database, m ModelInterface, changes bson.M) error {
m.PrepareUpdate() m.PrepareUpdate()
changes["updateTime"] = time.Now() changes["updateTime"] = time.Now()
@ -279,7 +277,7 @@ func UpsertDocument(db *mgo.Database, m ModelInterface, changes bson.M) error {
} }
// DeleteDocument deletes one document via its id // DeleteDocument deletes one document via its id
func DeleteDocument(db *mgo.Database, m ModelInterface) error { func DeleteDocument(db *Database, m ModelInterface) error {
c := db.C(GetCollectionName(m)) c := db.C(GetCollectionName(m))
err := c.RemoveId(m.GetID()) err := c.RemoveId(m.GetID())
@ -288,12 +286,12 @@ func DeleteDocument(db *mgo.Database, m ModelInterface) error {
} }
// DeleteDocuments deletes documents found by filter // DeleteDocuments deletes documents found by filter
func DeleteDocuments(db *mgo.Database, m ModelInterface, filter bson.M) (removed int, err error) { func DeleteDocuments(db *Database, m ModelInterface, filter bson.M) (removed int, err error) {
c := db.C(GetCollectionName(m)) c := db.C(GetCollectionName(m))
info, err := c.RemoveAll(filter) info, err := c.RemoveAll(filter)
if info != nil { if info != nil {
removed = info.Removed removed = info.Removed()
} }
return removed, err return removed, err

@ -4,12 +4,11 @@ import (
"fmt" "fmt"
"reflect" "reflect"
mgo "gopkg.in/mgo.v2"
"gopkg.in/mgo.v2/bson" "gopkg.in/mgo.v2/bson"
) )
// Lookup extends results with data for inline structs // Lookup extends results with data for inline structs
func Lookup(db *mgo.Database, structField string, results interface{}, selector bson.M) error { func Lookup(db *Database, structField string, results interface{}, selector bson.M) error {
t := reflect.TypeOf(results) t := reflect.TypeOf(results)
v := reflect.ValueOf(results) v := reflect.ValueOf(results)
@ -94,7 +93,7 @@ func Lookup(db *mgo.Database, structField string, results interface{}, selector
// no entries to map // no entries to map
return nil return nil
} }
sArr := make([]bson.M, lArr, lArr) sArr := make([]bson.M, lArr)
aI := 0 aI := 0
for sID := range objectIDs { for sID := range objectIDs {
sArr[aI] = bson.M{ sArr[aI] = bson.M{

159
session.go Normal file

@ -0,0 +1,159 @@
package mgocrud
import (
"errors"
mgo "gopkg.in/mgo.v2"
)
type Session struct {
session *mgo.Session
}
func (s *Session) Close() {
s.session.Close()
}
func NewSession(dial string) (*Session, error) {
session, err := mgo.Dial(dial)
if err != nil {
return nil, err
}
session.SetMode(mgo.Monotonic, true)
return &Session{session: session}, nil
}
type Database struct {
database *mgo.Database
}
func (s *Session) DB(name string) *Database {
return &Database{database: s.session.DB(name)}
}
type Collection struct {
collection *mgo.Collection
}
func (db *Database) C(name string) *Collection {
return &Collection{collection: db.database.C(name)}
}
func (db *Database) Name() string {
return db.database.Name
}
func (c *Collection) Insert(docs ...interface{}) error {
return c.collection.Insert(docs...)
}
func (c *Collection) UpdateId(id interface{}, update interface{}) error {
return c.collection.UpdateId(id, update)
}
func (c *Collection) RemoveId(id interface{}) error {
return c.collection.RemoveId(id)
}
type ChangeInfo struct {
changeInfo *mgo.ChangeInfo
}
func (ci *ChangeInfo) Matched() int {
return ci.changeInfo.Matched
}
func (ci *ChangeInfo) Removed() int {
return ci.changeInfo.Removed
}
func (ci *ChangeInfo) Updated() int {
return ci.changeInfo.Updated
}
func (c *Collection) Upsert(selector interface{}, update interface{}) (*ChangeInfo, error) {
ci, err := c.collection.Upsert(selector, update)
if err != nil {
return nil, err
}
return &ChangeInfo{changeInfo: ci}, nil
}
func (c *Collection) RemoveAll(filter interface{}) (*ChangeInfo, error) {
ci, err := c.collection.RemoveAll(filter)
if err != nil {
return nil, err
}
return &ChangeInfo{changeInfo: ci}, nil
}
type Query struct {
query *mgo.Query
}
func (c *Collection) FindId(id interface{}) *Query {
return &Query{query: c.collection.FindId(id)}
}
func (c *Collection) Find(query interface{}) *Query {
return &Query{query: c.collection.Find(query)}
}
func (q *Query) Select(selector interface{}) *Query {
q.query = q.query.Select(selector)
return q
}
func (q *Query) One(result interface{}) error {
return q.query.One(result)
}
func (q *Query) Sort(fields ...string) *Query {
q.query = q.query.Sort(fields...)
return q
}
func (q *Query) Skip(n int) *Query {
q.query = q.query.Skip(n)
return q
}
func (q *Query) Limit(n int) *Query {
q.query = q.query.Limit(n)
return q
}
func (q *Query) All(result interface{}) error {
return q.query.All(result)
}
func (q *Query) Count() (int, error) {
return q.query.Count()
}
type Index struct {
index *mgo.Index
}
func NewMgoIndex(index mgo.Index) *Index {
return &Index{index: &index}
}
func (c *Collection) EnsureIndex(index *Index) error {
if index != nil && index.index != nil {
return c.collection.EnsureIndex(*index.index)
}
return errors.New("index parameter not initialized with mgo.Index")
}
type Pipe struct {
pipe *mgo.Pipe
}
func (p *Pipe) All(result interface{}) error {
return p.pipe.All(result)
}
func (c *Collection) Pipe(pipeline interface{}) *Pipe {
return &Pipe{pipe: c.collection.Pipe(pipeline).AllowDiskUse()}
}

@ -9,7 +9,7 @@ import (
) )
// EnsureIndex ensured mongodb index reflecting model struct index tag // EnsureIndex ensured mongodb index reflecting model struct index tag
func EnsureIndex(db *mgo.Database, m ModelInterface) error { func EnsureIndex(db *Database, m ModelInterface) error {
colName := GetCollectionName(m) colName := GetCollectionName(m)
col := db.C(colName) col := db.C(colName)
@ -57,14 +57,14 @@ func EnsureIndex(db *mgo.Database, m ModelInterface) error {
case indexEl == "text": case indexEl == "text":
textFields = append(textFields, "$text:"+fieldbase+bsonField) textFields = append(textFields, "$text:"+fieldbase+bsonField)
default: default:
return fmt.Errorf("invalid index tag on collection %s.%s for field %s%s in model %+v", db.Name, colName, fieldbase, bsonField, t) return fmt.Errorf("invalid index tag on collection %s.%s for field %s%s in model %+v", db.Name(), colName, fieldbase, bsonField, t)
} }
} }
if len(index.Key) > 0 { if len(index.Key) > 0 {
// fmt.Println(bsonField, index) // fmt.Println(bsonField, index)
fmt.Printf("ensure index on collection %s.%s for field %s%s\n", db.Name, colName, fieldbase, bsonField) fmt.Printf("ensure index on collection %s.%s for field %s%s\n", db.Name(), colName, fieldbase, bsonField)
err := col.EnsureIndex(index) err := col.EnsureIndex(NewMgoIndex(index))
if err != nil { if err != nil {
return err return err
} }
@ -93,13 +93,13 @@ func EnsureIndex(db *mgo.Database, m ModelInterface) error {
if len(textFields) > 0 { if len(textFields) > 0 {
// fmt.Println("$text", textFields) // fmt.Println("$text", textFields)
fmt.Printf("ensure text index on collection %s.%s for fields %v\n", db.Name, GetCollectionName(m), textFields) fmt.Printf("ensure text index on collection %s.%s for fields %v\n", db.Name(), GetCollectionName(m), textFields)
err := col.EnsureIndex(mgo.Index{ err := col.EnsureIndex(NewMgoIndex(mgo.Index{
Name: "textindex", Name: "textindex",
Key: textFields, Key: textFields,
DefaultLanguage: "german", DefaultLanguage: "german",
Background: false, Background: false,
}) }))
if err != nil { if err != nil {
return err return err
} }

@ -2,12 +2,11 @@ package mgocrud
import ( import (
validator "gopkg.in/go-playground/validator.v8" validator "gopkg.in/go-playground/validator.v8"
mgo "gopkg.in/mgo.v2"
"gopkg.in/mgo.v2/bson" "gopkg.in/mgo.v2/bson"
) )
// ValidateObject validates object via validator tag and custom method // ValidateObject validates object via validator tag and custom method
func ValidateObject(db *mgo.Database, m ModelInterface, changes bson.M) error { func ValidateObject(db *Database, m ModelInterface, changes bson.M) error {
// first validate via struct tag // first validate via struct tag
validator := validator.New(&validator.Config{ validator := validator.New(&validator.Config{
TagName: "validator", TagName: "validator",
@ -19,7 +18,7 @@ func ValidateObject(db *mgo.Database, m ModelInterface, changes bson.M) error {
// next execute custom model validator if exists // next execute custom model validator if exists
if i, ok := m.(interface { if i, ok := m.(interface {
Validate(db *mgo.Database, changes bson.M) error Validate(db *Database, changes bson.M) error
}); ok { }); ok {
return i.Validate(db, changes) return i.Validate(db, changes)
} }