sql

Documentation

Index

• func Connect(driver, dsn string, n int, opts ...DBSetupOpt) (*sqlx.DB, error)
• func CreateDBIfNotExist(dsn string) error
• type DBSetupOpt
  • func CloseDB() DBSetupOpt
  • func CreateDB(dbname string) DBSetupOpt
  • func Migrate(dsn string, service string, sqlPath string) DBSetupOpt

Functions

func Connect

func Connect(driver, dsn string, n int, opts ...DBSetupOpt) (*sqlx.DB, error)

Connect tries to connect to a database up to n times. There are `DBSetupOpt`s to do things like run migrations, create system objects, etc.

func CreateDBIfNotExist

func CreateDBIfNotExist(dsn string) error

Types

type DBSetupOpt

type DBSetupOpt func(*sql.DB) error

DBSetupOpt is a function to perform some setup task on a database.

func CloseDB

func CloseDB() DBSetupOpt

func CreateDB

func CreateDB(dbname string) DBSetupOpt

CreateDB creates and "USE"s a database.

func Migrate

func Migrate(dsn string, service string, sqlPath string) DBSetupOpt

Migrate runs migrations. It's supposed to run in production, so assume the target database is CockroachDB.