database

Documentation

Index

• type DB
  • func New(cfg *config.Database) (DB, error)
• type Mysql
  • func (m *Mysql) Close() error
  • func (m *Mysql) DB() *gorm.DB
  • func (m *Mysql) Migrate() error

Types

type DB

type DB interface {
	// Migrate runs the auto migration for the database.
	Migrate() error
	// DB returns the underlying gorm.DB connection.
	DB() *gorm.DB
	// Close closes the database connection.
	Close() error
}

DB is an interface that defines the methods for the GORM database connection.

func New

func New(cfg *config.Database) (DB, error)

New initializes the database connection based on the configuration.

type Mysql

type Mysql struct {
	Conn *gorm.DB
	// contains filtered or unexported fields
}

Mysql is a wrapper for GORM mysql driver

func (*Mysql) Close

func (m *Mysql) Close() error

Close closes the database connection.

func (*Mysql) DB

func (m *Mysql) DB() *gorm.DB

DB returns the underlying database connection.

func (*Mysql) Migrate

func (m *Mysql) Migrate() error

Migrate runs the auto migration for the database.