database

README

What does this directory DO?

This package provides basic database handlers for a testing mock database (PLEASE don't use in prod!) and a MongoDB handler. The database.go file also defines DatabaseAccessor which can be extended upon for custom implementations.

Documentation

Index

• type DatabaseAccessor
• type DatabaseUpdateActions
• type Direction
• type HealthCheckInterface
• type MongoDatabase
  • func (db MongoDatabase) Aggregate(table string, pipeline []map[string]interface{}) ([]map[string]interface{}, error)
  • func (db MongoDatabase) Count(table string, filter map[string]interface{}) (int64, error)
  • func (db MongoDatabase) CreateRegularIndex(table string, keys map[string]Direction, unique bool) error
  • func (db MongoDatabase) CreateTextIndex(table string, keys []string) error
  • func (db MongoDatabase) DeleteOne(table string, query map[string]interface{}) (bool, error)
  • func (db MongoDatabase) Drop(table string) error
  • func (db MongoDatabase) Find(table string, query map[string]interface{}) ([]interface{}, bool)
  • func (db MongoDatabase) FindOne(table string, query map[string]interface{}) (interface{}, bool)
  • func (db MongoDatabase) FindPaginated(table string, query map[string]interface{}, maxPages int64, lastID string) ([]map[string]interface{}, bool)
  • func (db MongoDatabase) GetUTCTimestampFromID(dbID primitive.ObjectID) (time.Time, error)
  • func (db *MongoDatabase) Initialize(uri string, database string) error
  • func (db MongoDatabase) InsertMany(table string, documents []interface{}) error
  • func (db MongoDatabase) InsertOne(table string, body map[string]interface{}) (interface{}, error)
  • func (db MongoDatabase) MonitorConnection(heartbeat time.Duration, health HealthCheckInterface)
  • func (db MongoDatabase) Transact(ctx context.Context, opts *TransactionOptions, ...) (interface{}, error)
  • func (db MongoDatabase) UpdateMany(table string, query map[string]interface{}, ...) (interface{}, error)
  • func (db MongoDatabase) UpdateOne(table string, query map[string]interface{}, ...) (interface{}, error)
• type TestDatabase
  • func (db TestDatabase) Aggregate(table string, pipeline []map[string]interface{}) ([]map[string]interface{}, error)
  • func (db TestDatabase) CreateRegularIndex(table string, keys map[string]Direction, unique bool) error
  • func (db TestDatabase) CreateTextIndex(table string, keys []string) error
  • func (db TestDatabase) DeleteOne(table string, query map[string]interface{}) (bool, error)
  • func (db TestDatabase) Drop(table string) error
  • func (db TestDatabase) Find(table string, query map[string]interface{}) ([]interface{}, bool)
  • func (db TestDatabase) FindOne(table string, query map[string]interface{}) (interface{}, bool)
  • func (db TestDatabase) FindPaginated(table string, query map[string]interface{}, maxPages int64, lastID string) ([]map[string]interface{}, bool)
  • func (db TestDatabase) GetUTCTimestampFromID(dbID primitive.ObjectID) (time.Time, error)
  • func (db TestDatabase) InsertMany(table string, documents []interface{}) error
  • func (db TestDatabase) InsertOne(table string, body map[string]interface{}) (interface{}, error)
  • func (db TestDatabase) MonitorConnection(heartbeat time.Duration, health HealthCheckInterface)
  • func (db TestDatabase) Transact(ctx context.Context, opts *TransactionOptions, ...) (interface{}, error)
  • func (db TestDatabase) UpdateMany(table string, query map[string]interface{}, ...) (interface{}, error)
  • func (db TestDatabase) UpdateOne(table string, query map[string]interface{}, ...) (interface{}, error)
• type TransactionOptions

Types

type DatabaseAccessor

type DatabaseAccessor interface {
	InsertOne(table string, body map[string]interface{}) (interface{}, error)
	InsertMany(table string, bodies []interface{}) error
	UpdateOne(table string, query map[string]interface{}, body map[DatabaseUpdateActions]map[string]interface{}) (interface{}, error)
	UpdateMany(table string, query map[string]interface{}, body map[DatabaseUpdateActions]map[string]interface{}) (interface{}, error)
	FindOne(table string, query map[string]interface{}) (interface{}, bool)
	Find(table string, query map[string]interface{}) ([]interface{}, bool)
	FindPaginated(table string, query map[string]interface{}, maxPages int64, lastID string) ([]map[string]interface{}, bool)
	DeleteOne(table string, query map[string]interface{}) (bool, error)
	CreateTextIndex(table string, keys []string) error
	CreateRegularIndex(table string, keys map[string]Direction, unique bool) error
	Drop(table string) error
	Aggregate(table string, pipeline []map[string]interface{}) ([]map[string]interface{}, error)
	GetUTCTimestampFromID(dbID primitive.ObjectID) (time.Time, error)
	MonitorConnection(heartbeat time.Duration, health HealthCheckInterface)
	Transact(ctx context.Context, opts *TransactionOptions, transaction func(sessCtx mongo.SessionContext) (interface{}, error)) (interface{}, error)
}

type DatabaseUpdateActions

type DatabaseUpdateActions string

const (
	SET  DatabaseUpdateActions = "set"
	PUSH DatabaseUpdateActions = "push"
	INC  DatabaseUpdateActions = "inc"
)

type Direction

type Direction int

Direction type to specify the index direction

const (
	Ascending  Direction = 1  // Ascending order
	Descending Direction = -1 // Descending order
)

type HealthCheckInterface

type HealthCheckInterface interface {
	SetMongoDown()
	SetMongoUp()
	IsMongoUp() bool
}

type MongoDatabase

type MongoDatabase struct {
	Ctx    context.Context
	Cancel context.CancelFunc
	// contains filtered or unexported fields
}

func (MongoDatabase) Aggregate

func (db MongoDatabase) Aggregate(table string, pipeline []map[string]interface{}) ([]map[string]interface{}, error)

func (MongoDatabase) Count

func (db MongoDatabase) Count(table string, filter map[string]interface{}) (int64, error)

func (MongoDatabase) CreateRegularIndex

func (db MongoDatabase) CreateRegularIndex(table string, keys map[string]Direction, unique bool) error

func (MongoDatabase) CreateTextIndex

func (db MongoDatabase) CreateTextIndex(table string, keys []string) error

func (MongoDatabase) DeleteOne

func (db MongoDatabase) DeleteOne(table string, query map[string]interface{}) (bool, error)

func (MongoDatabase) Drop

func (db MongoDatabase) Drop(table string) error

func (MongoDatabase) Find

func (db MongoDatabase) Find(table string, query map[string]interface{}) ([]interface{}, bool)

func (MongoDatabase) FindOne

func (db MongoDatabase) FindOne(table string, query map[string]interface{}) (interface{}, bool)

func (MongoDatabase) FindPaginated

func (db MongoDatabase) FindPaginated(table string, query map[string]interface{}, maxPages int64, lastID string) ([]map[string]interface{}, bool)

func (MongoDatabase) GetUTCTimestampFromID

func (db MongoDatabase) GetUTCTimestampFromID(dbID primitive.ObjectID) (time.Time, error)

func (*MongoDatabase) Initialize

func (db *MongoDatabase) Initialize(uri string, database string) error

func (MongoDatabase) InsertMany

func (db MongoDatabase) InsertMany(table string, documents []interface{}) error

func (MongoDatabase) InsertOne

func (db MongoDatabase) InsertOne(table string, body map[string]interface{}) (interface{}, error)

func (MongoDatabase) MonitorConnection

func (db MongoDatabase) MonitorConnection(heartbeat time.Duration, health HealthCheckInterface)

func (MongoDatabase) Transact

func (db MongoDatabase) Transact(ctx context.Context, opts *TransactionOptions, transaction func(sessCtx mongo.SessionContext) (interface{}, error)) (interface{}, error)

func (MongoDatabase) UpdateMany

func (db MongoDatabase) UpdateMany(table string, query map[string]interface{}, body map[DatabaseUpdateActions]map[string]interface{}) (interface{}, error)

func (MongoDatabase) UpdateOne

func (db MongoDatabase) UpdateOne(table string, query map[string]interface{}, body map[DatabaseUpdateActions]map[string]interface{}) (interface{}, error)

type TestDatabase

type TestDatabase struct {
	Tables map[string]map[string]interface{}
}

func (TestDatabase) Aggregate

func (db TestDatabase) Aggregate(table string, pipeline []map[string]interface{}) ([]map[string]interface{}, error)

func (TestDatabase) CreateRegularIndex

func (db TestDatabase) CreateRegularIndex(table string, keys map[string]Direction, unique bool) error

func (TestDatabase) CreateTextIndex

func (db TestDatabase) CreateTextIndex(table string, keys []string) error

func (TestDatabase) DeleteOne

func (db TestDatabase) DeleteOne(table string, query map[string]interface{}) (bool, error)

func (TestDatabase) Drop

func (db TestDatabase) Drop(table string) error

func (TestDatabase) Find

func (db TestDatabase) Find(table string, query map[string]interface{}) ([]interface{}, bool)

func (TestDatabase) FindOne

func (db TestDatabase) FindOne(table string, query map[string]interface{}) (interface{}, bool)

func (TestDatabase) FindPaginated

func (db TestDatabase) FindPaginated(table string, query map[string]interface{}, maxPages int64, lastID string) ([]map[string]interface{}, bool)

func (TestDatabase) GetUTCTimestampFromID

func (db TestDatabase) GetUTCTimestampFromID(dbID primitive.ObjectID) (time.Time, error)

func (TestDatabase) InsertMany

func (db TestDatabase) InsertMany(table string, documents []interface{}) error

func (TestDatabase) InsertOne

func (db TestDatabase) InsertOne(table string, body map[string]interface{}) (interface{}, error)

func (TestDatabase) MonitorConnection

func (db TestDatabase) MonitorConnection(heartbeat time.Duration, health HealthCheckInterface)

func (TestDatabase) Transact

func (db TestDatabase) Transact(ctx context.Context, opts *TransactionOptions, transaction func(sessCtx mongo.SessionContext) (interface{}, error)) (interface{}, error)

func (TestDatabase) UpdateMany

func (db TestDatabase) UpdateMany(table string, query map[string]interface{}, body map[DatabaseUpdateActions]map[string]interface{}) (interface{}, error)

func (TestDatabase) UpdateOne

func (db TestDatabase) UpdateOne(table string, query map[string]interface{}, body map[DatabaseUpdateActions]map[string]interface{}) (interface{}, error)

type TransactionOptions

type TransactionOptions struct {
	SessionOptions     *options.SessionOptions
	TransactionOptions *options.TransactionOptions
}