gormdb

package

v0.0.56 Latest Latest Go to latest Published: May 6, 2024 License: MIT Imports: 6 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.

This section is empty.

func GetMysqlDsn(databaseName string, config *Config) string

func GetPostgresqlDsn(databaseName string, config *Config) string

type Config struct {
	Host     string
	Port     int
	User     string
	Password string

	AutoMigrate bool
}

type DbTypeGetDatabase interface {
	GetDatabase() string
}

type DbTypeGetDsn interface {
	GetDsn(config *Config) string
}

type DbTypeGetTables interface {
	GetTables() []interface{}
}

type GormDb[T comparable] struct {
	// contains filtered or unexported fields
}

T is a type representing the database of mappings

func NewGormDb[T comparable](config *Config) *GormDb[T]

func (o *GormDb[T]) Connect() error

func (o *GormDb[T]) Get() *gorm.DB

return a gorm.DB or panic

func (o *GormDb[T]) GetDb(dbType T) *gorm.DB

return a gorm.DB or panic

if o.config.AutoMigrate is true:

will create database if not exist. database name = T.GetDatabase()
will auto migrate tables if T.GetTables() is not empty

func (o *GormDb[T]) Start(ctx context.Context) error

func (o *GormDb[T]) Stop(ctx context.Context) error