orm

Documentation

Index

• Constants
• Variables
• func GetDB(name string) (*gorm.DB, error)
• func New(names ...string) error
• func NewInstance(c *Config) (db *gorm.DB)
• func NewLogWriter(log log.Logger) logger.Writer
• type Config
  • func LoadConf(name string) (ret *Config, err error)
• type LoggerWriter
  • func (l *LoggerWriter) Printf(s string, v ...interface{})
• type Manager
  • func NewManager() *Manager
  • func (m *Manager) GetInstance(name string) (*gorm.DB, error)

Constants

const (
	// DriverMySQL mysql driver
	DriverMySQL = "mysql"
	// DriverPostgres postgresSQL driver
	DriverPostgres = "postgres"
	// DriverClickhouse
	DriverClickhouse = "clickhouse"

	// DefaultDatabase default db name
	DefaultDatabase = "default"
)

Variables

var (
	// DBMap store database instance
	DBMap = make(map[string]*gorm.DB)
	// DBLock database locker
	DBLock sync.Mutex
	// logWriter log writer
	LogWriter logger.Writer
)

Functions

func GetDB

func GetDB(name string) (*gorm.DB, error)

GetDB get a database

func New

func New(names ...string) error

New create a or multi database client

func NewInstance

func NewInstance(c *Config) (db *gorm.DB)

NewInstance connect to database and create a db instance

func NewLogWriter

func NewLogWriter(log log.Logger) logger.Writer

Types

type Config

type Config struct {
	Driver          string
	Name            string
	Addr            string
	UserName        string
	Password        string
	ShowLog         bool
	MaxIdleConn     int
	MaxOpenConn     int
	Timeout         string // connect timeout
	ReadTimeout     string
	WriteTimeout    string
	ConnMaxLifeTime time.Duration
	SlowThreshold   time.Duration // 慢查询时长，默认500ms
	EnableTrace     bool
}

Config database config

func LoadConf

func LoadConf(name string) (ret *Config, err error)

LoadConf load database config

type LoggerWriter

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

func (*LoggerWriter) Printf

func (l *LoggerWriter) Printf(s string, v ...interface{})

type Manager

type Manager struct {
	*sync.RWMutex
	// contains filtered or unexported fields
}

Manager define a manager

func NewManager

func NewManager() *Manager

NewManager create a database manager

func (*Manager) GetInstance

func (m *Manager) GetInstance(name string) (*gorm.DB, error)

GetInstance return a database client