db

Documentation

Index

• func BulkInsert[T Table](executor gorp.SqlExecutor, db DB, allObjs ...T) error
• func ReplaceAll[T Table](db DB, objs ...T) error
• type DB
  • func NewPostgresDB(ctx context.Context, c conf.DBConfig, registry *monitoring.Registry, ...) DB
  • func (d *DB) AddTable(t Table) *gorp.TableMap
  • func (d *DB) CheckLivenessPeriodically(ctx context.Context)
  • func (d *DB) Close()
  • func (d *DB) CreateTable(table ...*gorp.TableMap) error
  • func (d *DB) SelectTimed(group string, i any, query string, args ...any) ([]any, error)
  • func (d *DB) TableExists(t Table) bool
• type Index
• type Migrater
  • func NewMigrater(db DB) Migrater
• type Migration
  • func (Migration) Indexes() []Index
  • func (Migration) TableName() string
• type Monitor
  • func NewDBMonitor(registry *monitoring.Registry) Monitor
• type Table

Functions

func BulkInsert

func BulkInsert[T Table](executor gorp.SqlExecutor, db DB, allObjs ...T) error

Bulk insert objects into the database, using an executor which can be a transaction or a database connection itself.

Note: This function does NOT support auto-incrementing primary keys.

func ReplaceAll

func ReplaceAll[T Table](db DB, objs ...T) error

Replace all old objects of a table with new objects.

Types

type DB

type DB struct {
	*gorp.DbMap
	// contains filtered or unexported fields
}

Wrapper around gorp.DbMap that adds some convenience functions.

func NewPostgresDB

func NewPostgresDB(
	ctx context.Context,
	c conf.DBConfig,
	registry *monitoring.Registry,
	monitor Monitor,
) DB

Create a new postgres database and wait until it is connected.

func (*DB) AddTable

func (d *DB) AddTable(t Table) *gorp.TableMap

Adds a Model table to the database.

func (*DB) CheckLivenessPeriodically

func (d *DB) CheckLivenessPeriodically(ctx context.Context)

Check periodically if the database is alive. If not, panic.

func (*DB) Close

func (d *DB) Close()

Convenience function to close the database connection.

func (*DB) CreateTable

func (d *DB) CreateTable(table ...*gorp.TableMap) error

Adds missing functionality to gorp.DbMap which creates one table.

func (*DB) SelectTimed

func (d *DB) SelectTimed(group string, i any, query string, args ...any) ([]any, error)

Executes a select query while monitoring its execution time.

func (*DB) TableExists

func (d *DB) TableExists(t Table) bool

Check if a table exists in the database.

type Index

type Index struct {
	Name        string
	ColumnNames []string
}

type Migrater

type Migrater interface {
	Migrate(bool)
}

func NewMigrater

func NewMigrater(db DB) Migrater

Create a new migrater with files embedded in the binary.

type Migration

type Migration struct {
	FileName string `db:"file_name"`
}

Migration model to keep track which migrations have been executed.

func (Migration) Indexes

func (Migration) Indexes() []Index

Indexes for the migration model.

func (Migration) TableName

func (Migration) TableName() string

Table under which the migration model will be stored.

type Monitor

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

func NewDBMonitor

func NewDBMonitor(registry *monitoring.Registry) Monitor

type Table

type Table interface {
	TableName() string
	Indexes() []Index
}