mongodb

README

data-mongo

Mongodb adapter for the "data" interface

Documentation

Index

• func ExpressionToBSON(criteria exp.Expression) bson.M
• type Collection
  • func NewCollection(collection *mongo.Collection) Collection
  • func (c Collection) Count(criteria exp.Expression, _ ...option.Option) (int64, error)
  • func (c Collection) Delete(object data.Object, note string) error
  • func (c Collection) HardDelete(criteria exp.Expression) error
  • func (c Collection) Iterator(criteria exp.Expression, options ...option.Option) (data.Iterator, error)
  • func (c Collection) Load(criteria exp.Expression, target data.Object) error
  • func (c Collection) Mongo() *mongo.Collection
  • func (c Collection) Query(target any, criteria exp.Expression, options ...option.Option) error
  • func (c Collection) Save(object data.Object, note string) error
• type Iterator
  • func NewIterator(context context.Context, cursor *mongo.Cursor) Iterator
  • func (iterator Iterator) Close() error
  • func (iterator Iterator) Count() int
  • func (iterator Iterator) Error() error
  • func (iterator Iterator) Next(output any) bool
• type Server
  • func New(uri string, database string) (Server, error)
  • func (server Server) Mongo() *mongo.Client
  • func (server Server) Session(ctx context.Context) (data.Session, error)
• type Session
  • func NewSession(database *mongo.Database) Session
  • func (s Session) Close()
  • func (s Session) Collection(collection string) data.Collection
  • func (s Session) Mongo() *mongo.Database

Functions

func ExpressionToBSON

func ExpressionToBSON(criteria exp.Expression) bson.M

ExpressionToBSON converts a data.Expression value into pure bson.

Types

type Collection

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

Collection wraps a mongodb.Collection with all of the methods required by the data.Collection interface

func NewCollection

func NewCollection(collection *mongo.Collection) Collection

NewCollection creates a new Collection object directly from a mongo.Collection

func (Collection) Count

func (c Collection) Count(criteria exp.Expression, _ ...option.Option) (int64, error)

func (Collection) Delete

func (c Collection) Delete(object data.Object, note string) error

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

func (Collection) HardDelete

func (c Collection) HardDelete(criteria exp.Expression) error

HardDelete physically removes an object from the database.

func (Collection) Iterator

func (c Collection) Iterator(criteria exp.Expression, options ...option.Option) (data.Iterator, error)

Iterator retrieves a group of objects from the database as an iterator

func (Collection) Load

func (c Collection) Load(criteria exp.Expression, target data.Object) error

Load retrieves a single object from the database

func (Collection) Mongo

func (c Collection) Mongo() *mongo.Collection

Mongo returns the underlying mongodb collection for libraries that need to bypass this abstraction.

func (Collection) Query

func (c Collection) Query(target any, criteria exp.Expression, options ...option.Option) error

Query retrieves a group of objects from the database and populates a target interface

func (Collection) Save

func (c Collection) Save(object data.Object, note string) error

Save inserts/updates a single object in the database.

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() error

Close closes the wrapped Cursor

func (Iterator) Count

func (iterator Iterator) Count() int

Count returns the total number of records contained by this iterator

func (Iterator) Error

func (iterator Iterator) Error() error

func (Iterator) Next

func (iterator Iterator) Next(output any) 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, error)

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) Mongo

func (server Server) Mongo() *mongo.Client

Mongo returns the underlying mongodb client for libraries that need to bypass this abstraction.

func (Server) Session

func (server Server) Session(ctx context.Context) (data.Session, error)

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 NewSession

func NewSession(database *mongo.Database) Session

NewSession generates a new Session object from a mongo.Database

func (Session) Close

func (s Session) Close()

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

func (Session) Collection

func (s Session) Collection(collection string) data.Collection

Collection returns a reference to an individual database collection.

func (Session) Mongo

func (s Session) Mongo() *mongo.Database

Mongo returns the underlying mongodb client for libraries that need to bypass this abstraction.