goosex

Documentation

Overview

Package goosex provides shared functions used with goose to help reduce code duplication. This provides the ability to import the migrate command into individual applications and run migrations.

Index

• func MigrateUp(uri string, fsys fs.FS)
• func MigrateUpContext(ctx context.Context, uri string, fsys fs.FS)
• func RegisterCobraCommand(cmd *cobra.Command, setupFunc func())
• func SetBaseFS(fsys fs.FS)
• func SetDBURI(uri string)
• func SetLogger(l *zap.SugaredLogger)

Functions

func MigrateUp

func MigrateUp(uri string, fsys fs.FS)

MigrateUp will run migrations and is provided as an easy way to ensure migrations are ran in test suites

Deprecated: use MigrateUpContext

func MigrateUpContext

func MigrateUpContext(ctx context.Context, uri string, fsys fs.FS)

MigrateUpContext will run migrations and is provided as an easy way to ensure migrations are ran in test suites

func RegisterCobraCommand

func RegisterCobraCommand(cmd *cobra.Command, setupFunc func())

RegisterCobraCommand will add a migrate command to the cobra command provided that provides a wrapper for running goose commands.

func SetBaseFS

func SetBaseFS(fsys fs.FS)

SetBaseFS accepts an embedded golang filesystem and sets that as the location for goose migration files.

func SetDBURI

func SetDBURI(uri string)

SetDBURI accepts a URI and saves it for use by goose during migrations

func SetLogger

func SetLogger(l *zap.SugaredLogger)

SetLogger accepts a zap logger and sets it as the logger for goose output