goosedb

package

v0.0.0-...-0decd24 Latest Latest Go to latest Published: Nov 7, 2023 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var ErrTableDoesNotExist = errors.New("goosedb: table does not exist")

func EnsureDBVersion(conf *DBConf, db *sql.DB) (int64, error)

EnsureDBVersion retrieves the current version for this DB, creating and initializing the DB version table if it doesn't exist.

func GetDBVersion(conf *DBConf) (int64, error)

wrapper for EnsureDBVersion for callers that don't already have their own DB instance

func OpenDBFromDBConf(conf *DBConf) (*sql.DB, error)

OpenDBFromDBConf wraps database/sql.DB.Open() and configures the newly opened DB based on the given DBConf.

Callers must Close() the returned DB.

func RunMigrations(conf *DBConf, migrationsDir string, target int64) error

func RunMigrationsOnDb(conf *DBConf, migrationsDir string, target int64, db *sql.DB) (err error)

Runs migration on a specific database instance.

type DBConf struct {
	MigrationsDir string
	Env           string
	Driver        DBDriver
	PgSchema      string
}

func NewDBConf(p, env string, pgschema string) (*DBConf, error)

extract configuration details from the given file

type DBDriver struct {
	Name    string
	OpenStr string
	Import  string
	Dialect SqlDialect
}

DBDriver encapsulates the info needed to work with a specific database driver

func (drv *DBDriver) IsValid() bool

ensure we have enough info about this driver

type MySqlDialect struct{}

type PostgresDialect struct{}

type SqlDialect interface {
	// contains filtered or unexported methods
}

SqlDialect abstracts the details of specific SQL dialects for goose's few SQL specific statements

type Sqlite3Dialect struct{}