7 Commits

Author SHA1 Message Date
6b367dbd7a db methods 2022-02-09 20:09:13 +01:00
98801edbc0 db.Session() 2022-02-09 18:55:58 +01:00
7dd238342c encapsulate ErrNotFound 2022-02-09 15:53:37 +01:00
115c288a0b encapsulate ErrNotFound 2022-02-09 15:49:15 +01:00
702a05f405 session copy 2022-02-09 15:24:44 +01:00
100eb29007 db via interfaces 2022-02-09 15:15:18 +01:00
b0af52178c db via interfaces 2022-02-09 15:11:15 +01:00
6 changed files with 215 additions and 35 deletions

22
crud.go
View File

@@ -7,7 +7,6 @@ import (
"strings"
"time"
mgo "gopkg.in/mgo.v2"
"gopkg.in/mgo.v2/bson"
)
@@ -28,7 +27,7 @@ func (e *ErrorWithStack) Stack() string {
}
// CreateDocument creates a document from specified model
func CreateDocument(db *mgo.Database, m ModelInterface) error {
func (db *Database) CreateDocument(m ModelInterface) error {
m.PrepareInsert()
c := db.C(GetCollectionName(m))
@@ -38,7 +37,7 @@ func CreateDocument(db *mgo.Database, m ModelInterface) error {
}
// ReadDocument gets one document via its id
func ReadDocument(db *mgo.Database, m ModelInterface, selector bson.M) error {
func (db *Database) ReadDocument(m ModelInterface, selector bson.M) error {
c := db.C(GetCollectionName(m))
q := c.FindId(m.GetID())
@@ -137,7 +136,7 @@ func idToObjectID(filter interface{}) {
}
// 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 (db *Database) ReadCollection(results interface{}, filter bson.M, selector bson.M, offset int, limit int, sort []string, pipelineModifier PipelineModifierFunction) (err error) {
defer func() {
if r := recover(); r != nil {
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)
}
q := c.Pipe(pipeline).AllowDiskUse().Iter()
_err = q.All(results)
_err = c.Pipe(pipeline).All(results)
} else {
// 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
func ReadCollectionCount(db *mgo.Database, m ModelInterface, filter bson.M) (count int, err error) {
func (db *Database) ReadCollectionCount(m ModelInterface, filter bson.M) (count int, err error) {
defer func() {
if r := recover(); r != nil {
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
func UpdateDocument(db *mgo.Database, m ModelInterface, changes bson.M) error {
func (db *Database) UpdateDocument(m ModelInterface, changes bson.M) error {
m.PrepareUpdate()
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
func UpsertDocument(db *mgo.Database, m ModelInterface, changes bson.M) error {
func (db *Database) UpsertDocument(m ModelInterface, changes bson.M) error {
m.PrepareUpdate()
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
func DeleteDocument(db *mgo.Database, m ModelInterface) error {
func (db *Database) DeleteDocument(m ModelInterface) error {
c := db.C(GetCollectionName(m))
err := c.RemoveId(m.GetID())
@@ -288,12 +286,12 @@ func DeleteDocument(db *mgo.Database, m ModelInterface) error {
}
// DeleteDocuments deletes documents found by filter
func DeleteDocuments(db *mgo.Database, m ModelInterface, filter bson.M) (removed int, err error) {
func (db *Database) DeleteDocuments(m ModelInterface, filter bson.M) (removed int, err error) {
c := db.C(GetCollectionName(m))
info, err := c.RemoveAll(filter)
if info != nil {
removed = info.Removed
removed = info.Removed()
}
return removed, err

2
go.mod
View File

@@ -1,4 +1,4 @@
module gitbase.de/gopackage/mgocrud
module gitbase.de/gopackage/mgocrud/v2
go 1.16

View File

@@ -4,12 +4,11 @@ import (
"fmt"
"reflect"
mgo "gopkg.in/mgo.v2"
"gopkg.in/mgo.v2/bson"
)
// Lookup extends results with data for inline structs
func Lookup(db *mgo.Database, structField string, results interface{}, selector bson.M) error {
func (db *Database) Lookup(structField string, results interface{}, selector bson.M) error {
t := reflect.TypeOf(results)
v := reflect.ValueOf(results)
@@ -94,7 +93,7 @@ func Lookup(db *mgo.Database, structField string, results interface{}, selector
// no entries to map
return nil
}
sArr := make([]bson.M, lArr, lArr)
sArr := make([]bson.M, lArr)
aI := 0
for sID := range objectIDs {
sArr[aI] = bson.M{
@@ -123,7 +122,7 @@ func Lookup(db *mgo.Database, structField string, results interface{}, selector
return fmt.Errorf("ID type in objects struct %+v is not bson.ObjectId", fieldType)
}
err := ReadCollection(db, objectResults, sQuery, selector, 0, 0, nil, nil)
err := db.ReadCollection(objectResults, sQuery, selector, 0, 0, nil, nil)
if err != nil {
panic(err)
}
@@ -156,14 +155,10 @@ func Lookup(db *mgo.Database, structField string, results interface{}, selector
object := objectIDs[objectID]
field := elV.FieldByName(structField)
if object != nil && field.CanSet() {
objectVal := reflect.ValueOf(object)
if fieldIsPtr {
field.Set(objectVal)
field.Set(reflect.ValueOf(object))
} else {
field.Set(objectVal.Elem())
}
field.Set(reflect.ValueOf(object).Elem())
}
}

188
session.go Normal file
View File

@@ -0,0 +1,188 @@
package mgocrud
import (
"errors"
mgo "gopkg.in/mgo.v2"
)
var (
ErrNotFound = errors.New("not found")
)
type Session struct {
session *mgo.Session
}
func (s *Session) Close() {
s.session.Close()
}
func (s *Session) Copy() *Session {
return &Session{session: s.session.Copy()}
}
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
session *Session
}
func (s *Session) DB(name string) *Database {
return &Database{database: s.session.DB(name), session: s}
}
type Collection struct {
collection *mgo.Collection
}
func (db *Database) Session() *Session {
return db.session
}
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 {
err := q.query.One(result)
if err == mgo.ErrNotFound {
err = ErrNotFound
}
return err
}
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 {
err := q.query.All(result)
if err == mgo.ErrNotFound {
err = ErrNotFound
}
return err
}
func (q *Query) Count() (int, error) {
c, err := q.query.Count()
if err == mgo.ErrNotFound {
err = ErrNotFound
}
return c, err
}
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 {
err := p.pipe.All(result)
if err == mgo.ErrNotFound {
err = ErrNotFound
}
return err
}
func (c *Collection) Pipe(pipeline interface{}) *Pipe {
return &Pipe{pipe: c.collection.Pipe(pipeline).AllowDiskUse()}
}

View File

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

View File

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