sql

Documentation

Index

• type Driver
  • func Open(cfg config.Config) (*sql.DB, Driver, error)
  • func (d Driver) String() string
• type Migrator
  • func NewMigrator(cfg config.Config, logger *zap.Logger) (*Migrator, error)
  • func (m *Migrator) Close() (source, db error)
  • func (m *Migrator) Run(force bool) error

Types

type Driver

type Driver uint8

Driver represents a database driver

const (

	// SQLite ...
	SQLite Driver
	// Postgres ...
	Postgres
	// MySQL ...
	MySQL
)

func Open

func Open(cfg config.Config) (*sql.DB, Driver, error)

Open opens a connection to the db

func (Driver) String

func (d Driver) String() string

type Migrator

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

Migrator is responsible for migrating the database schema

func NewMigrator

func NewMigrator(cfg config.Config, logger *zap.Logger) (*Migrator, error)

NewMigrator creates a new Migrator

func (*Migrator) Close

func (m *Migrator) Close() (source, db error)

Close closes the source and db

func (*Migrator) Run

func (m *Migrator) Run(force bool) error

Run runs any pending migrations