db

Documentation

Index

• Variables
• func AutoMigrate(params CommandMigrateParams) error
• func Migrate(params GooseMigrateParams) error
• func New(params Params) (*gorm.DB, error)
• func NewSQL(config Config) (*sql.DB, error)
• func RegisterGoose(storage GooseStorage)
• func RegisterMigration(migrator Migrator)
• type CommandMigrateParams
• type Config
• type Dialect
• type GooseMigrateParams
• type GooseStorage
• type Migrator
• type Params

Variables

var ConfigDefault = Config{
	Dialect:  DialectMySQL,
	Host:     "localhost",
	Port:     3306,
	User:     "root",
	Password: "",
	Database: "db",
	Timezone: "UTC",
	Debug:    false,

	ConnMaxIdleTime: 3 * time.Minute,
	ConnMaxLifetime: 30 * time.Minute,
	MaxOpenConns:    runtime.NumCPU() * 4,
	MaxIdleConns:    runtime.NumCPU() * 2,
}

var Module = fx.Module(
	"db",
	fx.Decorate(func(log *zap.Logger) *zap.Logger {
		return log.Named("db")
	}),
	fx.Provide(
		New,
		NewSQL,
	),
)

Functions

func AutoMigrate

func AutoMigrate(params CommandMigrateParams) error

func Migrate

func Migrate(params GooseMigrateParams) error

func New

func New(params Params) (*gorm.DB, error)

func NewSQL

func NewSQL(config Config) (*sql.DB, error)

func RegisterGoose

func RegisterGoose(storage GooseStorage)

func RegisterMigration

func RegisterMigration(migrator Migrator)

Types

type CommandMigrateParams

type CommandMigrateParams struct {
	fx.In

	Logger *zap.Logger
	DB     *gorm.DB
	Shut   fx.Shutdowner
}

type Config

type Config struct {
	Dialect  Dialect
	DSN      string
	Host     string
	Port     int
	User     string
	Password string
	Database string
	Timezone string
	Debug    bool

	ConnMaxIdleTime time.Duration
	ConnMaxLifetime time.Duration
	MaxOpenConns    int
	MaxIdleConns    int
}

type Dialect

type Dialect string

const (
	DialectMariaDB  Dialect = "mariadb"
	DialectMySQL    Dialect = "mysql"
	DialectPostgres Dialect = "postgres"
	DialectSQLite3  Dialect = "sqlite3"
)

type GooseMigrateParams

type GooseMigrateParams struct {
	fx.In

	Args cli.Args

	Config Config

	Logger *zap.Logger
	DB     *sql.DB
	Shut   fx.Shutdowner
}

type GooseStorage

type GooseStorage fs.FS

type Migrator

type Migrator func(*gorm.DB) error

type Params

type Params struct {
	fx.In

	Logger *zap.Logger
	Config Config
	SQL    *sql.DB
	LC     fx.Lifecycle
}