database

Documentation

Index

• func Create(ctx context.Context, c *mongo.Collection, e Entity) error
• func Delete(ctx context.Context, c *mongo.Collection, e Entity) error
• func DeleteAll(ctx context.Context, c *mongo.Collection, q Query) (int64, error)
• func EnsureIndexes(ctx context.Context, c *mongo.Collection, ks ...string) error
• func Get(ctx context.Context, c *mongo.Collection, q Query, i interface{}) error
• func GetAll(ctx context.Context, c *mongo.Collection, p Pipeline, e EntityArray) error
• type BasicCriteria
  • func NewBasicCriteria() *BasicCriteria
  • func (b *BasicCriteria) AppendQuery(q Query)
  • func (b *BasicCriteria) Build() Query
  • func (b *BasicCriteria) ID(ids ...objectid.ObjectID) *BasicCriteria
  • func (b *BasicCriteria) UUID(uuids ...string) *BasicCriteria
• type BasicEntity
  • func (b *BasicEntity) GenerateIDs()
  • func (b BasicEntity) GetID() objectid.ObjectID
  • func (b BasicEntity) GetUUID() string
• type Criteria
• type Entity
• type EntityArray
• type Pipeline
• type Query
  • func And(qs ...Query) Query
  • func In(f string, i interface{}) Query
  • func Match(q Query) Query
  • func Or(qs ...Query) Query

Functions

func Create

func Create(ctx context.Context, c *mongo.Collection, e Entity) error

Create new entity in database.

func Delete

func Delete(ctx context.Context, c *mongo.Collection, e Entity) error

Delete existing entity in database.

func DeleteAll

func DeleteAll(ctx context.Context, c *mongo.Collection, q Query) (int64, error)

DeleteAll documents in collection that match query.

func EnsureIndexes

func EnsureIndexes(ctx context.Context, c *mongo.Collection, ks ...string) error

EnsureIndexes create custom and default indexes.

func Get

func Get(ctx context.Context, c *mongo.Collection, q Query, i interface{}) error

Get result of given pipeline, take a ptr to value. If no result found reset the value.

func GetAll

func GetAll(ctx context.Context, c *mongo.Collection, p Pipeline, e EntityArray) error

GetAll populates entity array with results of given pipeline.

Types

type BasicCriteria

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

BasicCriteria for documents.

func NewBasicCriteria

func NewBasicCriteria() *BasicCriteria

NewBasicCriteria .

func (*BasicCriteria) AppendQuery

func (b *BasicCriteria) AppendQuery(q Query)

AppendQuery add a new query to the list.

func (*BasicCriteria) Build

func (b *BasicCriteria) Build() Query

Build the query from criteria.

func (*BasicCriteria) ID

func (b *BasicCriteria) ID(ids ...objectid.ObjectID) *BasicCriteria

ID appender for basic criteria.

func (*BasicCriteria) UUID

func (b *BasicCriteria) UUID(uuids ...string) *BasicCriteria

UUID appender for basic criteria.

type BasicEntity

type BasicEntity struct {
	ID           objectid.ObjectID `bson:"_id" json:"-"`
	UUID         string            `bson:"uuid" json:"uuid"`
	CreationDate *time.Time        `bson:"creation_date,omitempty" json:"creation_date"`
	UpdateDate   *time.Time        `bson:"update_date,omitempty" json:"update_date"`
}

BasicEntity struct contains fields for documents.

func (*BasicEntity) GenerateIDs

func (b *BasicEntity) GenerateIDs()

GenerateIDs create values for ID and UUID.

func (BasicEntity) GetID

func (b BasicEntity) GetID() objectid.ObjectID

GetID returns ID for basic entity.

func (BasicEntity) GetUUID

func (b BasicEntity) GetUUID() string

GetUUID returns UUID for basic entity.

type Criteria

type Criteria interface {
	Build() Query
}

Criteria is used to build database query.

type Entity

type Entity interface {
	GetID() objectid.ObjectID
	GetUUID() string
	GenerateIDs()
}

Entity interface.

type EntityArray

type EntityArray interface {
	New() interface{}
}

EntityArray struct.

type Pipeline

type Pipeline []Query

Pipeline type for database request.

type Query

type Query map[string]interface{}

Query type for database request.

func And

func And(qs ...Query) Query

And returns new $and query for given list.

func In

func In(f string, i interface{}) Query

In returns new $in query for f key.

func Match

func Match(q Query) Query

Match returns new $match query from query.

func Or

func Or(qs ...Query) Query

Or returns new $or query for given list.