postgres

Documentation

Overview

Package postgres manages our database connection. As part of the connection process, we also ensure that all migrations have been run on the proper database. The situation where the database is simply a target for some testing has been considered as well. In this scenario, we are dropping the public schema.

There is a very basic set of getter methods that have been implemented as well. An interface has been provided such that it can be mocked out for testing that does not need an actual database running in the environment.

Package postgres is a generated GoMock package.

Index

• func Connect(config *CxnConfig, migrations []Migration) (*gorm.DB, error)
• func WipeDB(db *gorm.DB) error
• type CxnConfig
• type DatabaseService
• type DatabaseServiceImpl
  • func NewService(DB *gorm.DB) *DatabaseServiceImpl
  • func (service *DatabaseServiceImpl) CountByQuery(model any, query map[string]any) (int64, error)
  • func (service *DatabaseServiceImpl) FetchByQuery(models any, query string, params []any) error
  • func (service *DatabaseServiceImpl) FindByID(model any, ID any) error
  • func (service *DatabaseServiceImpl) FindByQuery(model any, query map[string]any) error
  • func (service *DatabaseServiceImpl) Insert(model any) error
  • func (service *DatabaseServiceImpl) PagedByQuery(models any, query string, params []any, order string, page int, perPage int, ...) (PagedData, error)
  • func (service *DatabaseServiceImpl) PagedByQueryFromSession(models any, session *gorm.DB, page int, perPage int) (PagedData, error)
• type Migration
• type MockDatabaseService
  • func NewMockDatabaseService(ctrl *gomock.Controller) *MockDatabaseService
  • func (m *MockDatabaseService) CountByQuery(model any, query map[string]any) (int64, error)
  • func (m *MockDatabaseService) EXPECT() *MockDatabaseServiceMockRecorder
  • func (m *MockDatabaseService) FetchByQuery(models any, query string, params []any) error
  • func (m *MockDatabaseService) FindByID(model, ID any) error
  • func (m *MockDatabaseService) FindByQuery(model any, query map[string]any) error
  • func (m *MockDatabaseService) PagedByQuery(models any, query string, params []any, order string, page, perPage int, ...) (PagedData, error)
  • func (m *MockDatabaseService) PagedByQueryFromSession(models any, session *gorm.DB, page, perPage int) (PagedData, error)
• type MockDatabaseServiceMockRecorder
  • func (mr *MockDatabaseServiceMockRecorder) CountByQuery(model, query any) *gomock.Call
  • func (mr *MockDatabaseServiceMockRecorder) FetchByQuery(models, query, params any) *gomock.Call
  • func (mr *MockDatabaseServiceMockRecorder) FindByID(model, ID any) *gomock.Call
  • func (mr *MockDatabaseServiceMockRecorder) FindByQuery(model, query any) *gomock.Call
  • func (mr *MockDatabaseServiceMockRecorder) PagedByQuery(models, query, params, order, page, perPage any, preloads ...any) *gomock.Call
  • func (mr *MockDatabaseServiceMockRecorder) PagedByQueryFromSession(models, session, page, perPage any) *gomock.Call
• type PagedData

Functions

func Connect

func Connect(config *CxnConfig, migrations []Migration) (*gorm.DB, error)

Connect creates a database connection through GORM according to the connection config and runs all migrations.

func WipeDB

func WipeDB(db *gorm.DB) error

WipeDB queries for all of the tables and then drops the data in this tables.

Types

type CxnConfig

type CxnConfig struct {
	Host     string
	IsTestDB bool
	Port     string
	Name     string
	Password string
	URL      string
	User     string
}

CxnConfig holds connection information used to connect to a PostgreSQL database.

type DatabaseService

type DatabaseService interface {
	CountByQuery(model any, query map[string]any) (int64, error)
	FetchByQuery(models any, query string, params []any) error
	FindByID(model any, ID any) error
	FindByQuery(model any, query map[string]any) error
	PagedByQuery(models any, query string, params []any, order string, page int, perPage int, preloads ...string) (PagedData, error)
	PagedByQueryFromSession(models any, session *gorm.DB, page int, perPage int) (PagedData, error)
}

DatabaseService sets up the interface to be used at the handler/middelware level. These should be straightforward calls that allow us to skip creating a procedure method for the most basic database interactions. At the procedural layer, the *gorm.DB struct is available directly for more complex composition. This has the intended functionality that we are not testing the database in handlers, while it is tested directly at the procedural layer.

type DatabaseServiceImpl

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

DatabaseServiceImpl satisfies the above DatabaseService interface.

func NewService

func NewService(DB *gorm.DB) *DatabaseServiceImpl

NewService hydrates the gorm database for the implementation struct methods.

func (*DatabaseServiceImpl) CountByQuery

func (service *DatabaseServiceImpl) CountByQuery(model any, query map[string]any) (int64, error)

CountByQuery recives a database model and query and fetches a count for the given params.

func (*DatabaseServiceImpl) FetchByQuery

func (service *DatabaseServiceImpl) FetchByQuery(models any, query string, params []any) error

FetchByQuery receives a slice of database models as a pointer and fetches all records matching the query.

func (*DatabaseServiceImpl) FindByID

func (service *DatabaseServiceImpl) FindByID(model any, ID any) error

FindByID receives a database model as a pointer and fetches it using the primary ID.

func (*DatabaseServiceImpl) FindByQuery

func (service *DatabaseServiceImpl) FindByQuery(model any, query map[string]any) error

FindByQuery receives a database model as a pointer and fetches it using the given query.

func (*DatabaseServiceImpl) Insert

func (service *DatabaseServiceImpl) Insert(model any) error

Insert receives a database model and inserts it into the database.

func (*DatabaseServiceImpl) PagedByQuery

func (service *DatabaseServiceImpl) PagedByQuery(models any, query string, params []any, order string, page int, perPage int, preloads ...string) (PagedData, error)

PagedByQuery receives a slice of database models and paging information to build a paged database query.

func (*DatabaseServiceImpl) PagedByQueryFromSession

func (service *DatabaseServiceImpl) PagedByQueryFromSession(models any, session *gorm.DB, page int, perPage int) (PagedData, error)

PagedByQueryFromSession receives a slice of database models and paging information to build a paged database query.

type Migration

type Migration struct {
	Executor func(*gorm.DB) error
	Key      string
}

Migration is used to hold the database key and function for creating the migration.

type MockDatabaseService

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

MockDatabaseService is a mock of DatabaseService interface

func NewMockDatabaseService

func NewMockDatabaseService(ctrl *gomock.Controller) *MockDatabaseService

NewMockDatabaseService creates a new mock instance

func (*MockDatabaseService) CountByQuery

func (m *MockDatabaseService) CountByQuery(model any, query map[string]any) (int64, error)

CountByQuery mocks base method

func (*MockDatabaseService) EXPECT

func (m *MockDatabaseService) EXPECT() *MockDatabaseServiceMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockDatabaseService) FetchByQuery

func (m *MockDatabaseService) FetchByQuery(models any, query string, params []any) error

FetchByQuery mocks base method

func (*MockDatabaseService) FindByID

func (m *MockDatabaseService) FindByID(model, ID any) error

FindByID mocks base method

func (*MockDatabaseService) FindByQuery

func (m *MockDatabaseService) FindByQuery(model any, query map[string]any) error

FindByQuery mocks base method

func (*MockDatabaseService) PagedByQuery

func (m *MockDatabaseService) PagedByQuery(models any, query string, params []any, order string, page, perPage int, preloads ...string) (PagedData, error)

PagedByQuery mocks base method

func (*MockDatabaseService) PagedByQueryFromSession

func (m *MockDatabaseService) PagedByQueryFromSession(models any, session *gorm.DB, page, perPage int) (PagedData, error)

PagedByQueryFromSession mocks base method

type MockDatabaseServiceMockRecorder

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

MockDatabaseServiceMockRecorder is the mock recorder for MockDatabaseService

func (*MockDatabaseServiceMockRecorder) CountByQuery

func (mr *MockDatabaseServiceMockRecorder) CountByQuery(model, query any) *gomock.Call

CountByQuery indicates an expected call of CountByQuery

func (*MockDatabaseServiceMockRecorder) FetchByQuery

func (mr *MockDatabaseServiceMockRecorder) FetchByQuery(models, query, params any) *gomock.Call

FetchByQuery indicates an expected call of FetchByQuery

func (*MockDatabaseServiceMockRecorder) FindByID

func (mr *MockDatabaseServiceMockRecorder) FindByID(model, ID any) *gomock.Call

FindByID indicates an expected call of FindByID

func (*MockDatabaseServiceMockRecorder) FindByQuery

func (mr *MockDatabaseServiceMockRecorder) FindByQuery(model, query any) *gomock.Call

FindByQuery indicates an expected call of FindByQuery

func (*MockDatabaseServiceMockRecorder) PagedByQuery

func (mr *MockDatabaseServiceMockRecorder) PagedByQuery(models, query, params, order, page, perPage any, preloads ...any) *gomock.Call

PagedByQuery indicates an expected call of PagedByQuery

func (*MockDatabaseServiceMockRecorder) PagedByQueryFromSession

func (mr *MockDatabaseServiceMockRecorder) PagedByQueryFromSession(models, session, page, perPage any) *gomock.Call

PagedByQueryFromSession indicates an expected call of PagedByQueryFromSession

type PagedData

type PagedData struct {
	Items      any   `json:"items"`
	Page       int   `json:"page"`
	PerPage    int   `json:"perPage"`
	TotalItems int64 `json:"totalItems"`
	TotalPages int   `json:"totalPages"`
}

PagedData is returned from the PagedByQuery method. It contains paged database records and pagination metadata.