2014-02-12 23:19:46 +05:30
|
|
|
// Copyright 2014 The Gogs Authors. All rights reserved.
|
2018-06-20 10:36:01 +05:30
|
|
|
// Copyright 2018 The Gitea Authors. All rights reserved.
|
2014-02-12 23:19:46 +05:30
|
|
|
// Use of this source code is governed by a MIT-style
|
|
|
|
// license that can be found in the LICENSE file.
|
|
|
|
|
2021-09-19 17:19:59 +05:30
|
|
|
package db
|
2014-02-13 20:53:23 +05:30
|
|
|
|
2014-02-19 04:18:02 +05:30
|
|
|
import (
|
2019-12-15 15:21:28 +05:30
|
|
|
"context"
|
2014-10-19 11:05:24 +05:30
|
|
|
"database/sql"
|
2016-08-12 03:08:26 +05:30
|
|
|
"errors"
|
2014-02-19 04:18:02 +05:30
|
|
|
"fmt"
|
2021-09-19 17:19:59 +05:30
|
|
|
"io"
|
2020-09-07 03:22:01 +05:30
|
|
|
"reflect"
|
|
|
|
"strings"
|
2014-02-19 04:18:02 +05:30
|
|
|
|
2017-10-27 11:40:54 +05:30
|
|
|
"code.gitea.io/gitea/modules/setting"
|
|
|
|
|
2016-11-26 05:50:18 +05:30
|
|
|
// Needed for the MySQL driver
|
2014-02-19 04:18:02 +05:30
|
|
|
_ "github.com/go-sql-driver/mysql"
|
2019-10-17 14:56:49 +05:30
|
|
|
"xorm.io/xorm"
|
2020-03-22 20:42:55 +05:30
|
|
|
"xorm.io/xorm/names"
|
|
|
|
"xorm.io/xorm/schemas"
|
2016-11-26 05:50:18 +05:30
|
|
|
|
|
|
|
// Needed for the Postgresql driver
|
2014-03-17 23:33:58 +05:30
|
|
|
_ "github.com/lib/pq"
|
2014-02-19 04:18:02 +05:30
|
|
|
|
2020-03-27 19:42:39 +05:30
|
|
|
// Needed for the MSSQL driver
|
2016-12-24 07:07:35 +05:30
|
|
|
_ "github.com/denisenkom/go-mssqldb"
|
2014-02-19 04:18:02 +05:30
|
|
|
)
|
2014-02-13 20:53:23 +05:30
|
|
|
|
2021-09-19 17:19:59 +05:30
|
|
|
var (
|
|
|
|
x *xorm.Engine
|
|
|
|
tables []interface{}
|
|
|
|
initFuncs []func() error
|
|
|
|
|
|
|
|
// HasEngine specifies if we have a xorm.Engine
|
|
|
|
HasEngine bool
|
|
|
|
)
|
|
|
|
|
2014-10-19 11:05:24 +05:30
|
|
|
// Engine represents a xorm engine or session.
|
|
|
|
type Engine interface {
|
2017-02-14 09:16:46 +05:30
|
|
|
Table(tableNameOrBean interface{}) *xorm.Session
|
2017-08-22 17:09:52 +05:30
|
|
|
Count(...interface{}) (int64, error)
|
2017-02-04 21:30:07 +05:30
|
|
|
Decr(column string, arg ...interface{}) *xorm.Session
|
2021-08-13 04:41:42 +05:30
|
|
|
Delete(...interface{}) (int64, error)
|
2018-12-12 06:31:41 +05:30
|
|
|
Exec(...interface{}) (sql.Result, error)
|
2015-02-13 11:28:46 +05:30
|
|
|
Find(interface{}, ...interface{}) error
|
2015-02-11 10:14:16 +05:30
|
|
|
Get(interface{}) (bool, error)
|
2017-10-05 10:13:04 +05:30
|
|
|
ID(interface{}) *xorm.Session
|
2016-08-16 07:10:32 +05:30
|
|
|
In(string, ...interface{}) *xorm.Session
|
2017-02-04 21:30:07 +05:30
|
|
|
Incr(column string, arg ...interface{}) *xorm.Session
|
2014-10-19 11:05:24 +05:30
|
|
|
Insert(...interface{}) (int64, error)
|
2015-02-13 11:28:46 +05:30
|
|
|
InsertOne(interface{}) (int64, error)
|
2016-07-26 14:56:48 +05:30
|
|
|
Iterate(interface{}, xorm.IterFunc) error
|
2017-02-11 17:31:33 +05:30
|
|
|
Join(joinOperator string, tablename interface{}, condition string, args ...interface{}) *xorm.Session
|
2016-11-10 12:50:48 +05:30
|
|
|
SQL(interface{}, ...interface{}) *xorm.Session
|
2016-09-23 05:08:12 +05:30
|
|
|
Where(interface{}, ...interface{}) *xorm.Session
|
2019-06-13 01:11:28 +05:30
|
|
|
Asc(colNames ...string) *xorm.Session
|
2020-08-17 08:37:38 +05:30
|
|
|
Desc(colNames ...string) *xorm.Session
|
2020-01-25 00:30:29 +05:30
|
|
|
Limit(limit int, start ...int) *xorm.Session
|
|
|
|
SumInt(bean interface{}, columnName string) (res int64, err error)
|
2021-09-19 17:19:59 +05:30
|
|
|
Sync2(...interface{}) error
|
|
|
|
Select(string) *xorm.Session
|
|
|
|
NotIn(string, ...interface{}) *xorm.Session
|
|
|
|
OrderBy(string) *xorm.Session
|
|
|
|
Exist(...interface{}) (bool, error)
|
|
|
|
Distinct(...string) *xorm.Session
|
|
|
|
Query(...interface{}) ([]map[string][]byte, error)
|
|
|
|
Cols(...string) *xorm.Session
|
2014-10-19 11:05:24 +05:30
|
|
|
}
|
|
|
|
|
2021-09-19 17:19:59 +05:30
|
|
|
// TableInfo returns table's information via an object
|
|
|
|
func TableInfo(v interface{}) (*schemas.Table, error) {
|
|
|
|
return x.TableInfo(v)
|
|
|
|
}
|
2020-02-15 16:21:25 +05:30
|
|
|
|
2021-09-19 17:19:59 +05:30
|
|
|
// DumpTables dump tables information
|
|
|
|
func DumpTables(tables []*schemas.Table, w io.Writer, tp ...schemas.DBType) error {
|
|
|
|
return x.DumpTables(tables, w, tp...)
|
|
|
|
}
|
2016-11-26 05:50:18 +05:30
|
|
|
|
2021-09-19 17:19:59 +05:30
|
|
|
// RegisterModel registers model, if initfunc provided, it will be invoked after data model sync
|
|
|
|
func RegisterModel(bean interface{}, initFunc ...func() error) {
|
|
|
|
tables = append(tables, bean)
|
|
|
|
if len(initFuncs) > 0 && initFunc[0] != nil {
|
|
|
|
initFuncs = append(initFuncs, initFunc[0])
|
|
|
|
}
|
|
|
|
}
|
2014-03-21 11:18:10 +05:30
|
|
|
|
2014-04-05 20:16:32 +05:30
|
|
|
func init() {
|
2016-11-26 05:50:18 +05:30
|
|
|
gonicNames := []string{"SSL", "UID"}
|
2015-08-27 20:36:14 +05:30
|
|
|
for _, name := range gonicNames {
|
2020-03-22 20:42:55 +05:30
|
|
|
names.LintGonicMapper[name] = true
|
2015-08-27 20:36:14 +05:30
|
|
|
}
|
2014-04-05 20:16:32 +05:30
|
|
|
}
|
|
|
|
|
2021-03-24 23:57:22 +05:30
|
|
|
// GetNewEngine returns a new xorm engine from the configuration
|
|
|
|
func GetNewEngine() (*xorm.Engine, error) {
|
2019-08-24 14:54:45 +05:30
|
|
|
connStr, err := setting.DBConnStr()
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2014-03-30 20:17:08 +05:30
|
|
|
}
|
2017-02-20 13:41:13 +05:30
|
|
|
|
2021-01-02 07:37:43 +05:30
|
|
|
var engine *xorm.Engine
|
|
|
|
|
|
|
|
if setting.Database.UsePostgreSQL && len(setting.Database.Schema) > 0 {
|
|
|
|
// OK whilst we sort out our schema issues - create a schema aware postgres
|
|
|
|
registerPostgresSchemaDriver()
|
|
|
|
engine, err = xorm.NewEngine("postgresschema", connStr)
|
|
|
|
} else {
|
|
|
|
engine, err = xorm.NewEngine(setting.Database.Type, connStr)
|
|
|
|
}
|
|
|
|
|
2020-01-20 21:15:14 +05:30
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2020-03-27 14:14:05 +05:30
|
|
|
if setting.Database.Type == "mysql" {
|
|
|
|
engine.Dialect().SetParams(map[string]string{"rowFormat": "DYNAMIC"})
|
2020-07-21 17:58:27 +05:30
|
|
|
} else if setting.Database.Type == "mssql" {
|
|
|
|
engine.Dialect().SetParams(map[string]string{"DEFAULT_VARCHAR": "nvarchar"})
|
2020-03-27 14:14:05 +05:30
|
|
|
}
|
2020-01-20 21:15:14 +05:30
|
|
|
engine.SetSchema(setting.Database.Schema)
|
|
|
|
return engine, nil
|
2014-09-04 20:49:26 +05:30
|
|
|
}
|
|
|
|
|
2021-06-14 07:52:55 +05:30
|
|
|
func syncTables() error {
|
|
|
|
return x.StoreEngine("InnoDB").Sync2(tables...)
|
|
|
|
}
|
|
|
|
|
2016-11-26 05:50:18 +05:30
|
|
|
// NewTestEngine sets a new test xorm.Engine
|
2020-07-13 14:28:55 +05:30
|
|
|
func NewTestEngine() (err error) {
|
2021-03-24 23:57:22 +05:30
|
|
|
x, err = GetNewEngine()
|
2014-03-30 20:17:08 +05:30
|
|
|
if err != nil {
|
2015-08-02 10:06:35 +05:30
|
|
|
return fmt.Errorf("Connect to database: %v", err)
|
2014-03-30 20:17:08 +05:30
|
|
|
}
|
2014-09-04 20:49:26 +05:30
|
|
|
|
2020-03-22 20:42:55 +05:30
|
|
|
x.SetMapper(names.GonicMapper{})
|
2021-01-15 02:47:03 +05:30
|
|
|
x.SetLogger(NewXORMLogger(!setting.IsProd()))
|
|
|
|
x.ShowSQL(!setting.IsProd())
|
2021-06-14 07:52:55 +05:30
|
|
|
return syncTables()
|
2014-03-30 20:17:08 +05:30
|
|
|
}
|
|
|
|
|
2016-11-26 05:50:18 +05:30
|
|
|
// SetEngine sets the xorm.Engine
|
2014-03-30 03:20:51 +05:30
|
|
|
func SetEngine() (err error) {
|
2021-03-24 23:57:22 +05:30
|
|
|
x, err = GetNewEngine()
|
2014-02-19 04:18:02 +05:30
|
|
|
if err != nil {
|
2017-01-30 01:43:57 +05:30
|
|
|
return fmt.Errorf("Failed to connect to database: %v", err)
|
2014-02-19 04:18:02 +05:30
|
|
|
}
|
|
|
|
|
2020-03-22 20:42:55 +05:30
|
|
|
x.SetMapper(names.GonicMapper{})
|
2014-12-07 06:52:48 +05:30
|
|
|
// WARNING: for serv command, MUST remove the output to os.stdout,
|
2014-03-21 01:34:56 +05:30
|
|
|
// so use log file to instead print to stdout.
|
2019-08-24 14:54:45 +05:30
|
|
|
x.SetLogger(NewXORMLogger(setting.Database.LogSQL))
|
|
|
|
x.ShowSQL(setting.Database.LogSQL)
|
2019-10-22 02:50:47 +05:30
|
|
|
x.SetMaxOpenConns(setting.Database.MaxOpenConns)
|
|
|
|
x.SetMaxIdleConns(setting.Database.MaxIdleConns)
|
|
|
|
x.SetConnMaxLifetime(setting.Database.ConnMaxLifetime)
|
2014-03-30 03:20:51 +05:30
|
|
|
return nil
|
2014-02-19 04:18:02 +05:30
|
|
|
}
|
|
|
|
|
2016-11-26 05:50:18 +05:30
|
|
|
// NewEngine initializes a new xorm.Engine
|
2020-05-29 18:54:15 +05:30
|
|
|
// This function must never call .Sync2() if the provided migration function fails.
|
|
|
|
// When called from the "doctor" command, the migration function is a version check
|
|
|
|
// that prevents the doctor from fixing anything in the database if the migration level
|
|
|
|
// is different from the expected value.
|
2019-12-15 15:21:28 +05:30
|
|
|
func NewEngine(ctx context.Context, migrateFunc func(*xorm.Engine) error) (err error) {
|
2014-03-30 03:20:51 +05:30
|
|
|
if err = SetEngine(); err != nil {
|
|
|
|
return err
|
2014-04-05 20:16:32 +05:30
|
|
|
}
|
2015-01-22 18:19:52 +05:30
|
|
|
|
2019-12-15 15:21:28 +05:30
|
|
|
x.SetDefaultContext(ctx)
|
|
|
|
|
2016-11-24 20:00:36 +05:30
|
|
|
if err = x.Ping(); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2017-07-02 19:20:57 +05:30
|
|
|
if err = migrateFunc(x); err != nil {
|
2015-02-12 08:28:37 +05:30
|
|
|
return fmt.Errorf("migrate: %v", err)
|
2015-01-22 18:19:52 +05:30
|
|
|
}
|
|
|
|
|
2021-06-14 07:52:55 +05:30
|
|
|
if err = syncTables(); err != nil {
|
2016-11-28 12:55:16 +05:30
|
|
|
return fmt.Errorf("sync database struct error: %v", err)
|
2014-02-19 15:20:53 +05:30
|
|
|
}
|
2015-01-23 13:24:16 +05:30
|
|
|
|
2021-09-19 17:19:59 +05:30
|
|
|
for _, initFunc := range initFuncs {
|
|
|
|
if err := initFunc(); err != nil {
|
|
|
|
return fmt.Errorf("initFunc failed: %v", err)
|
2021-08-18 00:00:42 +05:30
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-03-30 03:20:51 +05:30
|
|
|
return nil
|
2014-02-19 04:18:02 +05:30
|
|
|
}
|
2014-03-21 01:34:56 +05:30
|
|
|
|
2020-09-07 03:22:01 +05:30
|
|
|
// NamesToBean return a list of beans or an error
|
|
|
|
func NamesToBean(names ...string) ([]interface{}, error) {
|
|
|
|
beans := []interface{}{}
|
|
|
|
if len(names) == 0 {
|
|
|
|
beans = append(beans, tables...)
|
|
|
|
return beans, nil
|
|
|
|
}
|
|
|
|
// Need to map provided names to beans...
|
|
|
|
beanMap := make(map[string]interface{})
|
|
|
|
for _, bean := range tables {
|
|
|
|
|
|
|
|
beanMap[strings.ToLower(reflect.Indirect(reflect.ValueOf(bean)).Type().Name())] = bean
|
|
|
|
beanMap[strings.ToLower(x.TableName(bean))] = bean
|
|
|
|
beanMap[strings.ToLower(x.TableName(bean, true))] = bean
|
|
|
|
}
|
|
|
|
|
|
|
|
gotBean := make(map[interface{}]bool)
|
|
|
|
for _, name := range names {
|
|
|
|
bean, ok := beanMap[strings.ToLower(strings.TrimSpace(name))]
|
|
|
|
if !ok {
|
|
|
|
return nil, fmt.Errorf("No table found that matches: %s", name)
|
|
|
|
}
|
|
|
|
if !gotBean[bean] {
|
|
|
|
beans = append(beans, bean)
|
|
|
|
gotBean[bean] = true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return beans, nil
|
|
|
|
}
|
|
|
|
|
2016-11-26 05:50:18 +05:30
|
|
|
// Ping tests if database is alive
|
2014-08-07 02:51:24 +05:30
|
|
|
func Ping() error {
|
2018-04-04 15:04:27 +05:30
|
|
|
if x != nil {
|
|
|
|
return x.Ping()
|
|
|
|
}
|
|
|
|
return errors.New("database not configured")
|
2014-08-07 02:51:24 +05:30
|
|
|
}
|
|
|
|
|
2017-01-03 13:50:28 +05:30
|
|
|
// DumpDatabase dumps all data from database according the special database SQL syntax to file system.
|
2021-03-15 00:22:12 +05:30
|
|
|
func DumpDatabase(filePath, dbType string) error {
|
2020-03-22 20:42:55 +05:30
|
|
|
var tbs []*schemas.Table
|
2017-01-03 13:50:28 +05:30
|
|
|
for _, t := range tables {
|
2020-03-22 20:42:55 +05:30
|
|
|
t, err := x.TableInfo(t)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
tbs = append(tbs, t)
|
2017-01-03 13:50:28 +05:30
|
|
|
}
|
2020-09-08 03:57:17 +05:30
|
|
|
|
|
|
|
type Version struct {
|
|
|
|
ID int64 `xorm:"pk autoincr"`
|
|
|
|
Version int64
|
|
|
|
}
|
2021-05-07 04:47:43 +05:30
|
|
|
t, err := x.TableInfo(&Version{})
|
2020-09-08 03:57:17 +05:30
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
tbs = append(tbs, t)
|
|
|
|
|
2017-01-03 13:50:28 +05:30
|
|
|
if len(dbType) > 0 {
|
2020-03-22 20:42:55 +05:30
|
|
|
return x.DumpTablesToFile(tbs, filePath, schemas.DBType(dbType))
|
2017-01-03 13:50:28 +05:30
|
|
|
}
|
|
|
|
return x.DumpTablesToFile(tbs, filePath)
|
2014-05-05 10:25:17 +05:30
|
|
|
}
|
2019-07-07 00:54:50 +05:30
|
|
|
|
|
|
|
// MaxBatchInsertSize returns the table's max batch insert size
|
|
|
|
func MaxBatchInsertSize(bean interface{}) int {
|
2020-03-22 20:42:55 +05:30
|
|
|
t, err := x.TableInfo(bean)
|
|
|
|
if err != nil {
|
|
|
|
return 50
|
|
|
|
}
|
2019-07-07 00:54:50 +05:30
|
|
|
return 999 / len(t.ColumnsSeq())
|
|
|
|
}
|
2019-09-06 07:50:09 +05:30
|
|
|
|
|
|
|
// Count returns records number according struct's fields as database query conditions
|
|
|
|
func Count(bean interface{}) (int64, error) {
|
|
|
|
return x.Count(bean)
|
|
|
|
}
|
2019-12-09 00:45:35 +05:30
|
|
|
|
|
|
|
// IsTableNotEmpty returns true if table has at least one record
|
|
|
|
func IsTableNotEmpty(tableName string) (bool, error) {
|
|
|
|
return x.Table(tableName).Exist()
|
|
|
|
}
|
|
|
|
|
|
|
|
// DeleteAllRecords will delete all the records of this table
|
|
|
|
func DeleteAllRecords(tableName string) error {
|
|
|
|
_, err := x.Exec(fmt.Sprintf("DELETE FROM %s", tableName))
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetMaxID will return max id of the table
|
|
|
|
func GetMaxID(beanOrTableName interface{}) (maxID int64, err error) {
|
|
|
|
_, err = x.Select("MAX(id)").Table(beanOrTableName).Get(&maxID)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
// FindByMaxID filled results as the condition from database
|
|
|
|
func FindByMaxID(maxID int64, limit int, results interface{}) error {
|
|
|
|
return x.Where("id <= ?", maxID).
|
|
|
|
OrderBy("id DESC").
|
|
|
|
Limit(limit).
|
|
|
|
Find(results)
|
|
|
|
}
|