database

Documentation

Index

• func GetDBConn(ctx context.Context, uri string, dbName string) (dbConn *mongo.Database, err error)
• func GetDBConnDefault(ctx context.Context) (dbConn *mongo.Database, err error)
• func Migrate(ctx context.Context, dbConn *mongo.Database) (err error)
• func Rollback(ctx context.Context, dbConn *mongo.Database) (err error)
• func Status(ctx context.Context, dbConn *mongo.Database) (err error)
• type MigrationInterface

Functions

func GetDBConn

func GetDBConn(
	ctx context.Context,
	uri string,
	dbName string,
) (dbConn *mongo.Database, err error)

Get DB connection instance

func GetDBConnDefault

func GetDBConnDefault(ctx context.Context) (dbConn *mongo.Database, err error)

Get default DB connection instance

func Migrate

func Migrate(ctx context.Context, dbConn *mongo.Database) (err error)

Run the migrations.

func Rollback

func Rollback(ctx context.Context, dbConn *mongo.Database) (err error)

Rollback the migrations.

func Status

func Status(ctx context.Context, dbConn *mongo.Database) (err error)

Check database migration status.

Types

type MigrationInterface

type MigrationInterface interface {
	// Get unique migration name.
	Name() (collectionName string)
	// Do the migration.
	Up(ctx context.Context, dbConn *mongo.Database) (err error)
	// Undo the migration.
	Down(ctx context.Context, dbConn *mongo.Database) (err error)
}

Common migration functionalities.