csql

package

v0.6.2 Latest Latest Go to latest Published: Jun 5, 2022 License: MIT Imports: 10 Imported by: 26

Details

Package csql helps create and manage database connections

This section is empty.

View Source

var WireModule = wire.NewSet(
	NewDBConnection,
	NewMigrator,
	LoadConfig,

	wire.Struct(new(NewMigratorParams), "*"),
)

WireModule can be used as part of google/wire setup.

func GetConn(ctx context.Context, db *gorm.DB) *gorm.DB

GetConn returns a db connection from the context or the given default connection if context is empty.

func NewDBConnection(lc *clifecycle.Lifecycle, config Config, logger clogger.Logger) (*gorm.DB, error)

NewDBConnection creates and returns a new database connection. The connection is closed when the app exits.

type Config struct {
	Dialect string `toml:"dialect"`
	DSN     string `toml:"dsn"`
}

Config configures the csql module

func LoadConfig(appConfig cconfig.Loader) (Config, error)

LoadConfig loads the csql config from the app config

type Migration interface {
	Run() error
}

Migration can be implemented by any struct that runs a database migration

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

Migrator can run database migrations by running all of the provided migrations

func NewMigrator(p NewMigratorParams) *Migrator

NewMigrator creates a new Migrator

func (m *Migrator) Run() error

Run runs all of the provided database migrations

type NewMigratorParams struct {
	Migrations []Migration
	Logger     clogger.Logger
}

NewMigratorParams holds the params needed for NewMigrator