sql

Documentation

Index

• func BuilderFor(db *sql.DB, driver Driver) sq.StatementBuilderType
• func WithMigrate(o *Options)
• func WithSSLDisabled(o *Options)
• type Driver
  • func Open(cfg config.Config, opts ...Option) (*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
• type Option
• type Options

Functions

func BuilderFor

func BuilderFor(db *sql.DB, driver Driver) sq.StatementBuilderType

BuilderFor returns a squirrel statement builder which decorates the provided sql.DB configured for the provided driver.

func WithMigrate

func WithMigrate(o *Options)

func WithSSLDisabled

func WithSSLDisabled(o *Options)

Types

type Driver

type Driver uint8

Driver represents a database driver

const (

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

func Open

func Open(cfg config.Config, opts ...Option) (*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

type Option

type Option func(*Options)

type Options

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