integrations

Documentation

Index

• Variables
• type Collection
  • func NewCollectionDialer(url string, dbname string, collectionname string) (collection Collection, err error)
• type CollectionDialer
• type CollectionRepo
  • func (s *CollectionRepo) Close()
  • func (s *CollectionRepo) Count() (int, error)
  • func (s *CollectionRepo) FindAndModify(selector interface{}, update interface{}, result interface{}) (info *mgo.ChangeInfo, err error)
  • func (s *CollectionRepo) FindOne(id string, result interface{}) (err error)
  • func (s *CollectionRepo) UpsertID(id interface{}, update interface{}) (info *mgo.ChangeInfo, err error)
  • func (s *CollectionRepo) Wake()

Variables

var (
	//ErrInvalidID -- error for invalid id
	ErrInvalidID = errors.New("value is not a properly formatted hex string")
)

Types

type Collection

type Collection interface {
	Wake()
	Close()
	FindOne(id string, result interface{}) (err error)
	UpsertID(selector interface{}, update interface{}) (info *mgo.ChangeInfo, err error)
	FindAndModify(selector interface{}, update interface{}, target interface{}) (info *mgo.ChangeInfo, err error)
	Count() (int, error)
}

Collection - an interface representing a trimmed down collection object

func NewCollectionDialer

func NewCollectionDialer(url string, dbname string, collectionname string) (collection Collection, err error)

NewCollectionDialer -- dials a new mongo connection

type CollectionDialer

type CollectionDialer func(url string, dbname string, collectionname string) (collection Collection, err error)

CollectionDialer - a funciton type to dial for collections

type CollectionRepo

type CollectionRepo struct {
	Col *mgo.Collection
	// contains filtered or unexported fields
}

CollectionRepo - mgo collection adaptor

func (*CollectionRepo) Close

func (s *CollectionRepo) Close()

Close -- closes the connection

func (*CollectionRepo) Count

func (s *CollectionRepo) Count() (int, error)

Count -- counts the collection records

func (*CollectionRepo) FindAndModify

func (s *CollectionRepo) FindAndModify(selector interface{}, update interface{}, result interface{}) (info *mgo.ChangeInfo, err error)

FindAndModify -- execute a normal upsert

func (*CollectionRepo) FindOne

func (s *CollectionRepo) FindOne(id string, result interface{}) (err error)

FindOne -- finds record with given ID

func (*CollectionRepo) UpsertID

func (s *CollectionRepo) UpsertID(id interface{}, update interface{}) (info *mgo.ChangeInfo, err error)

UpsertID -- upserts the given object to the given id

func (*CollectionRepo) Wake

func (s *CollectionRepo) Wake()

Wake - will ping and reconnect if need be