database

Documentation

Index

• Variables
• func Set(db *Database)
• type Database
  • func Get() *Database
  • func New() (*Database, error)
  • func NewWithDb(mdb *mongo.Database) *Database
  • func (db *Database) DbPropsCollection() *mongo.Collection
  • func (db *Database) GetSchemaVersion(ctx context.Context) (int, int, error)
  • func (db *Database) UpdateIndexes() error
  • func (db *Database) UpdateIndexesTo(version int) error
  • func (db *Database) UpdateSchemas() error
  • func (db *Database) UpdateSchemasTo(version int) error

Variables

var MongoDatabaseName = utils.GetCloudProjectID()

MongoDatabaseName is the name of the database in MongoDB

Functions

func Set

func Set(db *Database)

Set the database object to use

Types

type Database

type Database struct {
	Mdb *mongo.Database

	apis.APIs
}

Database interface abstracts database operations

func Get

func Get() *Database

Get the database object to use

func New

func New() (*Database, error)

New returns a new database object that connects to the real database

func NewWithDb

func NewWithDb(mdb *mongo.Database) *Database

NewWithDb returns a new database object with the given Mongo database

func (*Database) DbPropsCollection

func (db *Database) DbPropsCollection() *mongo.Collection

DbPropsCollection is the collection for database properties

func (*Database) GetSchemaVersion

func (db *Database) GetSchemaVersion(ctx context.Context) (int, int, error)

GetSchemaVersion returns (cur, latest) schema version

func (*Database) UpdateIndexes

func (db *Database) UpdateIndexes() error

UpdateIndexes if necessary

func (*Database) UpdateIndexesTo

func (db *Database) UpdateIndexesTo(version int) error

UpdateIndexesTo to a particular version

func (*Database) UpdateSchemas

func (db *Database) UpdateSchemas() error

UpdateSchemas if necessary

func (*Database) UpdateSchemasTo

func (db *Database) UpdateSchemasTo(version int) error

UpdateSchemasTo to a particular version