models

Documentation

Index

• func Aggregate(db *mongo.Database, model Model, extra *AggregateOpts) ([]interface{}, error)
• func ConvertID(id string) primitive.ObjectID
• func ConvertIDs(ids []string) []primitive.ObjectID
• func CountDocs(db *mongo.Database, model Model, query bson.M) int64
• func DateQuery(start, end time.Time) bson.M
• func DeleteMany(db *mongo.Database, model Model, query bson.M) bool
• func DeleteOne(db *mongo.Database, model Model, query bson.M) bool
• func EmptyMongoID() primitive.ObjectID
• func FindAll(db *mongo.Database, model Model, query bson.M, queryOpts *FindOptions) []interface{}
• func FindByID(coll *mongo.Collection, id string) *mongo.SingleResult
• func GetCacheKey(model Model, id string) string
• func InsertMany(db *mongo.Database, model Model, docs []interface{}) ([]interface{}, error)
• func NewMongoID() primitive.ObjectID
• func Query(db *mongo.Database, model Model, query bson.M, queryOpts *FindOptions) (*mongo.Cursor, error)
• func Save(db *mongo.Database, cacheClient *cache.Client, model Model, id string) error
• func ToJSON(m Model) string
• func UpdateMany(db *mongo.Database, model Model, query, updateObj bson.M) error
• type AggregateOpts
• type BufferWriter
  • func NewBufferWriter() *BufferWriter
  • func (w *BufferWriter) BulkInsert(override bool)
  • func (w *BufferWriter) Flush()
  • func (w *BufferWriter) InsertDocs(d interface{})
• type FindOptions
• type Model
  • func CacheFirst(cacheClient *cache.Client, db *mongo.Database, model Model, id string) Model
  • func FindOne(db *mongo.Database, model Model, query bson.M) Model
  • func FindOneWithOpts(db *mongo.Database, model Model, query bson.M, queryOpts *FindOptions) Model

Functions

func Aggregate

func Aggregate(db *mongo.Database, model Model, extra *AggregateOpts) ([]interface{}, error)

Aggregate method will aggregate the collection and return the results accordingly

func ConvertID

func ConvertID(id string) primitive.ObjectID

ConvertID method will try to convert given string to BSON Object ID

func ConvertIDs

func ConvertIDs(ids []string) []primitive.ObjectID

ConvertIDs method will try to convert given slice to BSON Object ID slice

func CountDocs

func CountDocs(db *mongo.Database, model Model, query bson.M) int64

CountDocs method will count the documents in a table based on query supplied

func DateQuery

func DateQuery(start, end time.Time) bson.M

DateQuery will return the bson representation to query daterange between 2 time intervals

func DeleteMany

func DeleteMany(db *mongo.Database, model Model, query bson.M) bool

DeleteMany method will delete multiple documents based on the filter

func DeleteOne

func DeleteOne(db *mongo.Database, model Model, query bson.M) bool

DeleteOne method will delete a single document based on the query

func EmptyMongoID

func EmptyMongoID() primitive.ObjectID

EmptyMongoID method will return an objectID which is empty

func FindAll

func FindAll(db *mongo.Database, model Model, query bson.M, queryOpts *FindOptions) []interface{}

FindAll will try to find the documents based on the query

func FindByID

func FindByID(coll *mongo.Collection, id string) *mongo.SingleResult

FindByID method will try to find the document in collection with given id

func GetCacheKey

func GetCacheKey(model Model, id string) string

GetCacheKey method returns the cache key for model with id

func InsertMany

func InsertMany(db *mongo.Database, model Model, docs []interface{}) ([]interface{}, error)

InsertMany method will insert documents in bulk inside the collection

func NewMongoID

func NewMongoID() primitive.ObjectID

NewMongoID method will return a new BSON Objec ID

func Query

func Query(db *mongo.Database, model Model, query bson.M, queryOpts *FindOptions) (*mongo.Cursor, error)

Query method will return cursor to the database

func Save

func Save(db *mongo.Database, cacheClient *cache.Client, model Model, id string) error

Save method will save the document in db and update the cache

func ToJSON

func ToJSON(m Model) string

ToJSON method will convert the model to json string

func UpdateMany

func UpdateMany(db *mongo.Database, model Model, query, updateObj bson.M) error

UpdateMany will update the rows of the table based on the query supplied

Types

type AggregateOpts

type AggregateOpts struct {
	Match, Group bson.M
	Project      []string
	MaxTime      time.Duration
	Limit        int
}

AggregateOpts method is used for holding options while doing aggregation

type BufferWriter

type BufferWriter struct {
	Docs          []interface{}
	Table         string
	Host          string
	Count         int
	MessageClient *messaging.Message

	Conn *mongo.Database
}

BufferWriter struct holds the elements docs and ids till they are flushed to database either manually using a timed event or when the count of the resource exceeds a certain threshold value

func NewBufferWriter

func NewBufferWriter() *BufferWriter

NewBufferWriter creates a writer object for all the subsequents calls

func (*BufferWriter) BulkInsert

func (w *BufferWriter) BulkInsert(override bool)

BulkInsert checks the docs count and if the count exceeds the max buffer count then the documents are flushed to the database and all the counters are reset

func (*BufferWriter) Flush

func (w *BufferWriter) Flush()

Flush manually flushes the data to database overriding the checks

func (*BufferWriter) InsertDocs

func (w *BufferWriter) InsertDocs(d interface{})

InsertDocs method appends the click to the w.docs slice and increments the click count by creating a read write lock to handle concurrent writes to the same object

type FindOptions

type FindOptions struct {
	Sort, Hint  interface{}
	Projection  interface{}
	Limit, Skip *int64
	BatchSize   *int32
	Timeout     time.Duration
}

FindOptions struct will contain the additional find information

type Model

type Model interface {
	New() Model
	Table() string
	IsEmpty() bool
	FindOne(db *mongo.Database, id string) Model
	ClearCacheData(cacheClient *cache.Client)
}

Model interface is a generic type for all the models

func CacheFirst

func CacheFirst(cacheClient *cache.Client, db *mongo.Database, model Model, id string) Model

CacheFirst method will try to find the object with given id in cache else it will query the db and save the result in cache

func FindOne

func FindOne(db *mongo.Database, model Model, query bson.M) Model

FindOne method will try to find the object with given query

func FindOneWithOpts

func FindOneWithOpts(db *mongo.Database, model Model, query bson.M, queryOpts *FindOptions) Model

FindOneWithOpts method will try to find the object based on the query and options