db

Documentation

Overview

Package db provides utilities to configure and connect to a database

Package db provides utilities to configure and connect to a database

Index

• type Config
  • func NewConfig() Config
• type Connection
  • func NewConnection(cfg Config) (Connection, error)
• type ConnectionError
  • func (ce *ConnectionError) Error() string

Types

type Config

type Config interface {
	ConnStr() string
	DbName() string
}

Config interface defines methods for retreiving config information

func NewConfig

func NewConfig() Config

NewConfig constructs and returns a new Config

type Connection

type Connection interface {
	DB() *gorm.DB
}

Connection interface defines a method for retrieving the *gorm.DB

func NewConnection

func NewConnection(cfg Config) (Connection, error)

NewConnection takes a db.Config and returns a Connection and an error

type ConnectionError

type ConnectionError struct{}

ConnectionError custom error type

func (*ConnectionError) Error

func (ce *ConnectionError) Error() string

Error implements the error interface