mongodb

Documentation

Index

• func ExpressionToBSON(criteria expression.Expression) bson.M
• type Iterator
  • func NewIterator(context context.Context, cursor *mongo.Cursor) Iterator
  • func (iterator Iterator) Close() *derp.Error
  • func (iterator Iterator) Next(output data.Object) bool
• type Server
  • func New(uri string, database string) Server
  • func (db Server) Session(ctx context.Context) data.Session
• type Session
  • func (s Session) Close()
  • func (s Session) Delete(collection string, object data.Object, note string) *derp.Error
  • func (s Session) List(collection string, criteria expression.Expression, options ...option.Option) (data.Iterator, *derp.Error)
  • func (s Session) Load(collection string, criteria expression.Expression, target data.Object) *derp.Error
  • func (s Session) Save(collection string, object data.Object, note string) *derp.Error

Functions

func ExpressionToBSON

func ExpressionToBSON(criteria expression.Expression) bson.M

ExpressionToBSON converts a data.Expression value into pure bson.

Types

type Iterator

type Iterator struct {
	Context context.Context
	Cursor  *mongo.Cursor
}

Iterator wraps the mongodb Cursor object

func NewIterator

func NewIterator(context context.Context, cursor *mongo.Cursor) Iterator

NewIterator returns a fully populated Iterator object

func (Iterator) Close

func (iterator Iterator) Close() *derp.Error

Close closes the wrapped Cursor

func (Iterator) Next

func (iterator Iterator) Next(output data.Object) bool

Next populates the next value from the wrapped Cursor, or returns FALSE

type Server

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

Server is an abstract representation of a MongoDB database. It implements the data.Server interface, so that it should be usable anywhere that requires a data.Server.

func New

func New(uri string, database string) Server

New returns a fully populated mongodb.Server. It requires that you provide the URI for the mongodb cluster, along with the name of the database to be used for all transactions.

func (Server) Session

func (db Server) Session(ctx context.Context) data.Session

Session returns a new client session that can be used to perform CRUD transactions on this datastore.

type Session

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

Session represents a single database session, such as a session encompassing all of the database queries to respond to a single REST service call.

func (Session) Close

func (s Session) Close()

Close cleans up any remaining connections that need to be removed.

func (Session) Delete

func (s Session) Delete(collection string, object data.Object, note string) *derp.Error

Delete removes a single object from the database, using a "virtual delete"

func (Session) List

func (s Session) List(collection string, criteria expression.Expression, options ...option.Option) (data.Iterator, *derp.Error)

List retrieves a group of objects from the database

func (Session) Load

func (s Session) Load(collection string, criteria expression.Expression, target data.Object) *derp.Error

Load retrieves a single object from the database

func (Session) Save

func (s Session) Save(collection string, object data.Object, note string) *derp.Error

Save inserts/updates a single object in the database.