db

Documentation

Overview

Package db contains a variety of utility functions and test helpers for working with Sherlock's database. While we are using Gorm for everyday application-level sql operations, we are opting for golang-migrate in order to provide more robust and reversible sql migrations.

Index

• func ApplyMigrations(changeLogPath string, config *viper.Viper) error
• func Connect(config *viper.Viper) (*gorm.DB, error)

Functions

func ApplyMigrations

func ApplyMigrations(changeLogPath string, config *viper.Viper) error

ApplyMigrations is a utility function intended for use in integration tests and local development where changelogs can be applied to a local postgres instance during startup

func Connect

func Connect(config *viper.Viper) (*gorm.DB, error)

Connect is a utility function that accepts a viper instance containing database configs and returns a gorm database connection