odm

package module

v0.0.0-...-2a45f3f Latest Latest Go to latest Published: Aug 2, 2018 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var MongodbURI string

This section is empty.

type DocumentBase struct {
	ID bson.ObjectId `json:"_id" bson:"_id"`
}

DocumentBase implements all the methods to the IEntity interface

func (doc *DocumentBase) GetID() bson.ObjectId

GetID returns the id of the document

func (doc *DocumentBase) SetID(ID bson.ObjectId)

SetID sets the ID field of the document

type IEntity interface {
	SetID(bson.ObjectId)
	GetID() bson.ObjectId
}

IEntity defines all the methods to be used on the documents when saved and queried on the db

type PaginationInfo struct {
	CurrentPage    int
	NumPages       int
	RecordsPerPage int
	NumRecords     int
}

type Query struct {
	// contains filtered or unexported fields
}

func (q *Query) All(docs interface{}) error

func (q *Query) Limit(n int) *Query

func (q *Query) Next(doc IEntity) bool

func (q *Query) Skip(n int) *Query

func (q *Query) Sort(fields ...string) *Query

type Repository struct {
	// contains filtered or unexported fields
}

func NewRepository(database, collection string) *Repository

func (r *Repository) Count(query bson.M) (int, error)

func (r *Repository) Delete(doc IEntity) error

func (r *Repository) Find(query bson.M) (*Query, error)

func (r *Repository) FindOne(query bson.M, doc IEntity) error

func (r *Repository) GetByID(ID bson.ObjectId, doc IEntity) error

func (r *Repository) Paginate(query bson.M, recordsPerPage, page int) (*Query, *PaginationInfo, error)

func (r *Repository) Save(doc IEntity) error