mirror of
https://gitee.com/johng/gf.git
synced 2024-11-30 03:07:45 +08:00
237 lines
8.6 KiB
Go
237 lines
8.6 KiB
Go
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
|
//
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
// If a copy of the MIT was not distributed with this file,
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
package gdb
|
|
|
|
import (
|
|
"fmt"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/gogf/gf/v2/os/gcache"
|
|
"github.com/gogf/gf/v2/os/glog"
|
|
)
|
|
|
|
// Config is the configuration management object.
|
|
type Config map[string]ConfigGroup
|
|
|
|
// ConfigGroup is a slice of configuration node for specified named group.
|
|
type ConfigGroup []ConfigNode
|
|
|
|
// ConfigNode is configuration for one node.
|
|
type ConfigNode struct {
|
|
Host string `json:"host"` // Host of server, ip or domain like: 127.0.0.1, localhost
|
|
Port string `json:"port"` // Port, it's commonly 3306.
|
|
User string `json:"user"` // Authentication username.
|
|
Pass string `json:"pass"` // Authentication password.
|
|
Name string `json:"name"` // Default used database name.
|
|
Type string `json:"type"` // Database type: mysql, sqlite, mssql, pgsql, oracle.
|
|
Link string `json:"link"` // (Optional) Custom link information, when it is used, configuration Host/Port/User/Pass/Name are ignored.
|
|
Role string `json:"role"` // (Optional, "master" in default) Node role, used for master-slave mode: master, slave.
|
|
Debug bool `json:"debug"` // (Optional) Debug mode enables debug information logging and output.
|
|
Prefix string `json:"prefix"` // (Optional) Table prefix.
|
|
DryRun bool `json:"dryRun"` // (Optional) Dry run, which does SELECT but no INSERT/UPDATE/DELETE statements.
|
|
Weight int `json:"weight"` // (Optional) Weight for load balance calculating, it's useless if there's just one node.
|
|
Charset string `json:"charset"` // (Optional, "utf8mb4" in default) Custom charset when operating on database.
|
|
Timezone string `json:"timezone"` // (Optional) Sets the time zone for displaying and interpreting time stamps.
|
|
MaxIdleConnCount int `json:"maxIdle"` // (Optional) Max idle connection configuration for underlying connection pool.
|
|
MaxOpenConnCount int `json:"maxOpen"` // (Optional) Max open connection configuration for underlying connection pool.
|
|
MaxConnLifeTime time.Duration `json:"maxLifeTime"` // (Optional) Max amount of time a connection may be idle before being closed.
|
|
QueryTimeout time.Duration `json:"queryTimeout"` // (Optional) Max query time for per dql.
|
|
ExecTimeout time.Duration `json:"execTimeout"` // (Optional) Max exec time for dml.
|
|
TranTimeout time.Duration `json:"tranTimeout"` // (Optional) Max exec time time for a transaction.
|
|
PrepareTimeout time.Duration `json:"prepareTimeout"` // (Optional) Max exec time time for prepare operation.
|
|
CreatedAt string `json:"createdAt"` // (Optional) The filed name of table for automatic-filled created datetime.
|
|
UpdatedAt string `json:"updatedAt"` // (Optional) The filed name of table for automatic-filled updated datetime.
|
|
DeletedAt string `json:"deletedAt"` // (Optional) The filed name of table for automatic-filled updated datetime.
|
|
TimeMaintainDisabled bool `json:"timeMaintainDisabled"` // (Optional) Disable the automatic time maintaining feature.
|
|
}
|
|
|
|
const (
|
|
DefaultGroupName = "default" // Default group name.
|
|
)
|
|
|
|
// configs is internal used configuration object.
|
|
var configs struct {
|
|
sync.RWMutex
|
|
config Config // All configurations.
|
|
group string // Default configuration group.
|
|
}
|
|
|
|
func init() {
|
|
configs.config = make(Config)
|
|
configs.group = DefaultGroupName
|
|
}
|
|
|
|
// SetConfig sets the global configuration for package.
|
|
// It will overwrite the old configuration of package.
|
|
func SetConfig(config Config) {
|
|
defer instances.Clear()
|
|
configs.Lock()
|
|
defer configs.Unlock()
|
|
configs.config = config
|
|
}
|
|
|
|
// SetConfigGroup sets the configuration for given group.
|
|
func SetConfigGroup(group string, nodes ConfigGroup) {
|
|
defer instances.Clear()
|
|
configs.Lock()
|
|
defer configs.Unlock()
|
|
configs.config[group] = nodes
|
|
}
|
|
|
|
// AddConfigNode adds one node configuration to configuration of given group.
|
|
func AddConfigNode(group string, node ConfigNode) {
|
|
defer instances.Clear()
|
|
configs.Lock()
|
|
defer configs.Unlock()
|
|
configs.config[group] = append(configs.config[group], node)
|
|
}
|
|
|
|
// AddDefaultConfigNode adds one node configuration to configuration of default group.
|
|
func AddDefaultConfigNode(node ConfigNode) {
|
|
AddConfigNode(DefaultGroupName, node)
|
|
}
|
|
|
|
// AddDefaultConfigGroup adds multiple node configurations to configuration of default group.
|
|
func AddDefaultConfigGroup(nodes ConfigGroup) {
|
|
SetConfigGroup(DefaultGroupName, nodes)
|
|
}
|
|
|
|
// GetConfig retrieves and returns the configuration of given group.
|
|
func GetConfig(group string) ConfigGroup {
|
|
configs.RLock()
|
|
defer configs.RUnlock()
|
|
return configs.config[group]
|
|
}
|
|
|
|
// SetDefaultGroup sets the group name for default configuration.
|
|
func SetDefaultGroup(name string) {
|
|
defer instances.Clear()
|
|
configs.Lock()
|
|
defer configs.Unlock()
|
|
configs.group = name
|
|
}
|
|
|
|
// GetDefaultGroup returns the { name of default configuration.
|
|
func GetDefaultGroup() string {
|
|
defer instances.Clear()
|
|
configs.RLock()
|
|
defer configs.RUnlock()
|
|
return configs.group
|
|
}
|
|
|
|
// IsConfigured checks and returns whether the database configured.
|
|
// It returns true if any configuration exists.
|
|
func IsConfigured() bool {
|
|
configs.RLock()
|
|
defer configs.RUnlock()
|
|
return len(configs.config) > 0
|
|
}
|
|
|
|
// SetLogger sets the logger for orm.
|
|
func (c *Core) SetLogger(logger *glog.Logger) {
|
|
c.logger = logger
|
|
}
|
|
|
|
// GetLogger returns the (logger) of the orm.
|
|
func (c *Core) GetLogger() *glog.Logger {
|
|
return c.logger
|
|
}
|
|
|
|
// SetMaxIdleConnCount sets the maximum number of connections in the idle
|
|
// connection pool.
|
|
//
|
|
// If MaxOpenConns is greater than 0 but less than the new MaxIdleConns,
|
|
// then the new MaxIdleConns will be reduced to match the MaxOpenConns limit.
|
|
//
|
|
// If n <= 0, no idle connections are retained.
|
|
//
|
|
// The default max idle connections is currently 2. This may change in
|
|
// a future release.
|
|
func (c *Core) SetMaxIdleConnCount(n int) {
|
|
c.config.MaxIdleConnCount = n
|
|
}
|
|
|
|
// SetMaxOpenConnCount sets the maximum number of open connections to the database.
|
|
//
|
|
// If MaxIdleConns is greater than 0 and the new MaxOpenConns is less than
|
|
// MaxIdleConns, then MaxIdleConns will be reduced to match the new
|
|
// MaxOpenConns limit.
|
|
//
|
|
// If n <= 0, then there is no limit on the number of open connections.
|
|
// The default is 0 (unlimited).
|
|
func (c *Core) SetMaxOpenConnCount(n int) {
|
|
c.config.MaxOpenConnCount = n
|
|
}
|
|
|
|
// SetMaxConnLifeTime sets the maximum amount of time a connection may be reused.
|
|
//
|
|
// Expired connections may be closed lazily before reuse.
|
|
//
|
|
// If d <= 0, connections are not closed due to a connection's age.
|
|
func (c *Core) SetMaxConnLifeTime(d time.Duration) {
|
|
c.config.MaxConnLifeTime = d
|
|
}
|
|
|
|
// String returns the node as string.
|
|
func (node *ConfigNode) String() string {
|
|
return fmt.Sprintf(
|
|
`%s@%s:%s,%s,%s,%s,%s,%v,%d-%d-%d#%s`,
|
|
node.User, node.Host, node.Port,
|
|
node.Name, node.Type, node.Role, node.Charset, node.Debug,
|
|
node.MaxIdleConnCount,
|
|
node.MaxOpenConnCount,
|
|
node.MaxConnLifeTime,
|
|
node.Link,
|
|
)
|
|
}
|
|
|
|
// GetConfig returns the current used node configuration.
|
|
func (c *Core) GetConfig() *ConfigNode {
|
|
return c.config
|
|
}
|
|
|
|
// SetDebug enables/disables the debug mode.
|
|
func (c *Core) SetDebug(debug bool) {
|
|
c.debug.Set(debug)
|
|
}
|
|
|
|
// GetDebug returns the debug value.
|
|
func (c *Core) GetDebug() bool {
|
|
return c.debug.Val()
|
|
}
|
|
|
|
// GetCache returns the internal cache object.
|
|
func (c *Core) GetCache() *gcache.Cache {
|
|
return c.cache
|
|
}
|
|
|
|
// GetGroup returns the group string configured.
|
|
func (c *Core) GetGroup() string {
|
|
return c.group
|
|
}
|
|
|
|
// SetDryRun enables/disables the DryRun feature.
|
|
func (c *Core) SetDryRun(enabled bool) {
|
|
c.config.DryRun = enabled
|
|
}
|
|
|
|
// GetDryRun returns the DryRun value.
|
|
func (c *Core) GetDryRun() bool {
|
|
return c.config.DryRun || allDryRun
|
|
}
|
|
|
|
// GetPrefix returns the table prefix string configured.
|
|
func (c *Core) GetPrefix() string {
|
|
return c.config.Prefix
|
|
}
|
|
|
|
// GetSchema returns the schema configured.
|
|
func (c *Core) GetSchema() string {
|
|
return c.schema
|
|
}
|