-
-
Notifications
You must be signed in to change notification settings - Fork 67
/
database.go
198 lines (170 loc) Β· 5.02 KB
/
database.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
package database
import (
"fmt"
"strconv"
"strings"
"sync"
"time"
"gorm.io/gorm"
"gorm.io/gorm/logger"
"goyave.dev/goyave/v3/config"
)
// Initializer is a function meant to modify a connection settings
// at the global scope when it's created.
//
// Use `db.InstantSet()` and not `db.Set()`, since the latter clones
// the gorm.DB instance instead of modifying it.
type Initializer func(*gorm.DB)
// DialectorInitializer function initializing a GORM Dialector using the given
// data source name (DSN).
type DialectorInitializer func(dsn string) gorm.Dialector
type dialect struct {
initializer DialectorInitializer
template string
}
var (
dbConnection *gorm.DB
mu sync.Mutex
models []interface{}
initializers []Initializer
dialects map[string]dialect = map[string]dialect{}
optionPlaceholders map[string]string = map[string]string{
"{username}": "database.username",
"{password}": "database.password",
"{host}": "database.host",
"{name}": "database.name",
"{options}": "database.options",
}
)
// GetConnection returns the global database connection pool.
// Creates a new connection pool if no connection is available.
//
// The connections will be closed automatically on server shutdown so you
// don't need to call "Close()" when you're done with the database.
func GetConnection() *gorm.DB {
mu.Lock()
defer mu.Unlock()
if dbConnection == nil {
dbConnection = newConnection()
}
return dbConnection
}
// Conn alias for GetConnection.
func Conn() *gorm.DB {
return GetConnection()
}
// Close the database connections if they exist.
func Close() error {
var err error = nil
mu.Lock()
defer mu.Unlock()
if dbConnection != nil {
db, _ := dbConnection.DB()
err = db.Close()
dbConnection = nil
}
return err
}
// AddInitializer adds a database connection initializer function.
// Initializer functions are meant to modify a connection settings
// at the global scope when it's created.
//
// Initializer functions are called in order, meaning that functions
// added last can override settings defined by previous ones.
func AddInitializer(initializer Initializer) {
initializers = append(initializers, initializer)
}
// ClearInitializers remove all database connection initializer functions.
func ClearInitializers() {
initializers = []Initializer{}
}
// RegisterModel registers a model for auto-migration.
// When writing a model file, you should always register it in the init() function.
// func init() {
// database.RegisterModel(&MyModel{})
// }
func RegisterModel(model interface{}) {
models = append(models, model)
}
// GetRegisteredModels get the registered models.
// The returned slice is a copy of the original, so it
// cannot be modified.
func GetRegisteredModels() []interface{} {
return append(make([]interface{}, 0, len(models)), models...)
}
// ClearRegisteredModels unregister all models.
func ClearRegisteredModels() {
models = []interface{}{}
}
// Migrate migrates all registered models.
func Migrate() {
db := GetConnection()
for _, model := range models {
if err := db.AutoMigrate(model); err != nil {
panic(err)
}
}
}
// RegisterDialect registers a connection string template for the given dialect.
//
// You cannot override a dialect that already exists.
//
// Template format accepts the following placeholders, which will be replaced with
// the corresponding configuration entries automatically:
// - "{username}"
// - "{password}"
// - "{host}"
// - "{port}"
// - "{name}"
// - "{options}"
// Example template for the "mysql" dialect:
// {username}:{password}@({host}:{port})/{name}?{options}
func RegisterDialect(name, template string, initializer DialectorInitializer) {
mu.Lock()
defer mu.Unlock()
if _, ok := dialects[name]; ok {
panic(fmt.Sprintf("Dialect %q already exists", name))
}
dialects[name] = dialect{initializer, template}
}
func newConnection() *gorm.DB {
driver := config.GetString("database.connection")
if driver == "none" {
panic("Cannot create DB connection. Database is set to \"none\" in the config")
}
logLevel := logger.Silent
if config.GetBool("app.debug") {
logLevel = logger.Info
}
dialect, ok := dialects[driver]
if !ok {
panic(fmt.Sprintf("DB Connection %q not supported, forgotten import?", driver))
}
dsn := dialect.buildDSN()
db, err := gorm.Open(dialect.initializer(dsn), &gorm.Config{
PrepareStmt: true,
Logger: logger.Default.LogMode(logLevel),
})
if err != nil {
panic(err)
}
sql, err := db.DB()
if err != nil {
panic(err)
}
sql.SetMaxOpenConns(config.GetInt("database.maxOpenConnections"))
sql.SetMaxIdleConns(config.GetInt("database.maxIdleConnections"))
sql.SetConnMaxLifetime(time.Duration(config.GetInt("database.maxLifetime")) * time.Second)
for _, initializer := range initializers {
initializer(db)
}
return db
}
func (d dialect) buildDSN() string {
connStr := d.template
for k, v := range optionPlaceholders {
connStr = strings.Replace(connStr, k, config.GetString(v), 1)
}
connStr = strings.Replace(connStr, "{port}", strconv.Itoa(config.GetInt("database.port")), 1)
return connStr
}