2014-02-12 12:49:46 -05:00
|
|
|
// Copyright 2014 The Gogs Authors. All rights reserved.
|
2018-06-20 00:06:01 -05:00
|
|
|
// Copyright 2018 The Gitea Authors. All rights reserved.
|
2014-02-12 12:49:46 -05:00
|
|
|
// Use of this source code is governed by a MIT-style
|
|
|
|
// license that can be found in the LICENSE file.
|
|
|
|
|
2021-09-19 06:49:59 -05:00
|
|
|
package db
|
2014-02-13 10:23:23 -05:00
|
|
|
|
2014-02-18 17:48:02 -05:00
|
|
|
import (
|
2019-12-15 04:51:28 -05:00
|
|
|
"context"
|
2014-10-19 00:35:24 -05:00
|
|
|
"database/sql"
|
2016-08-11 16:38:26 -05:00
|
|
|
"errors"
|
2014-02-18 17:48:02 -05:00
|
|
|
"fmt"
|
2021-09-19 06:49:59 -05:00
|
|
|
"io"
|
2020-09-06 16:52:01 -05:00
|
|
|
"reflect"
|
|
|
|
"strings"
|
2014-02-18 17:48:02 -05:00
|
|
|
|
2017-10-27 01:10:54 -05:00
|
|
|
"code.gitea.io/gitea/modules/setting"
|
|
|
|
|
2016-11-25 19:20:18 -05:00
|
|
|
// Needed for the MySQL driver
|
2014-02-18 17:48:02 -05:00
|
|
|
_ "github.com/go-sql-driver/mysql"
|
2019-10-17 04:26:49 -05:00
|
|
|
"xorm.io/xorm"
|
2020-03-22 10:12:55 -05:00
|
|
|
"xorm.io/xorm/names"
|
|
|
|
"xorm.io/xorm/schemas"
|
2016-11-25 19:20:18 -05:00
|
|
|
|
|
|
|
// Needed for the Postgresql driver
|
2014-03-17 13:03:58 -05:00
|
|
|
_ "github.com/lib/pq"
|
2014-02-18 17:48:02 -05:00
|
|
|
|
2020-03-27 09:12:39 -05:00
|
|
|
// Needed for the MSSQL driver
|
2016-12-23 20:37:35 -05:00
|
|
|
_ "github.com/denisenkom/go-mssqldb"
|
2014-02-18 17:48:02 -05:00
|
|
|
)
|
2014-02-13 10:23:23 -05:00
|
|
|
|
2021-09-19 06:49:59 -05:00
|
|
|
var (
|
|
|
|
x *xorm.Engine
|
|
|
|
tables []interface{}
|
|
|
|
initFuncs []func() error
|
|
|
|
|
|
|
|
// HasEngine specifies if we have a xorm.Engine
|
|
|
|
HasEngine bool
|
|
|
|
)
|
|
|
|
|
2014-10-19 00:35:24 -05:00
|
|
|
// Engine represents a xorm engine or session.
|
|
|
|
type Engine interface {
|
2017-02-13 22:46:46 -05:00
|
|
|
Table(tableNameOrBean interface{}) *xorm.Session
|
2017-08-22 06:39:52 -05:00
|
|
|
Count(...interface{}) (int64, error)
|
2017-02-04 11:00:07 -05:00
|
|
|
Decr(column string, arg ...interface{}) *xorm.Session
|
2021-08-12 18:11:42 -05:00
|
|
|
Delete(...interface{}) (int64, error)
|
2018-12-11 20:01:41 -05:00
|
|
|
Exec(...interface{}) (sql.Result, error)
|
2015-02-13 00:58:46 -05:00
|
|
|
Find(interface{}, ...interface{}) error
|
2015-02-10 23:44:16 -05:00
|
|
|
Get(interface{}) (bool, error)
|
2017-10-04 23:43:04 -05:00
|
|
|
ID(interface{}) *xorm.Session
|
2016-08-15 20:40:32 -05:00
|
|
|
In(string, ...interface{}) *xorm.Session
|
2017-02-04 11:00:07 -05:00
|
|
|
Incr(column string, arg ...interface{}) *xorm.Session
|
2014-10-19 00:35:24 -05:00
|
|
|
Insert(...interface{}) (int64, error)
|
2015-02-13 00:58:46 -05:00
|
|
|
InsertOne(interface{}) (int64, error)
|
2016-07-26 04:26:48 -05:00
|
|
|
Iterate(interface{}, xorm.IterFunc) error
|
2017-02-11 07:01:33 -05:00
|
|
|
Join(joinOperator string, tablename interface{}, condition string, args ...interface{}) *xorm.Session
|
2016-11-10 02:20:48 -05:00
|
|
|
SQL(interface{}, ...interface{}) *xorm.Session
|
2016-09-22 18:38:12 -05:00
|
|
|
Where(interface{}, ...interface{}) *xorm.Session
|
2019-06-12 14:41:28 -05:00
|
|
|
Asc(colNames ...string) *xorm.Session
|
2020-08-16 22:07:38 -05:00
|
|
|
Desc(colNames ...string) *xorm.Session
|
2020-01-24 14:00:29 -05:00
|
|
|
Limit(limit int, start ...int) *xorm.Session
|
|
|
|
SumInt(bean interface{}, columnName string) (res int64, err error)
|
2021-09-19 06:49:59 -05:00
|
|
|
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 00:35:24 -05:00
|
|
|
}
|
|
|
|
|
2021-09-19 06:49:59 -05:00
|
|
|
// TableInfo returns table's information via an object
|
|
|
|
func TableInfo(v interface{}) (*schemas.Table, error) {
|
|
|
|
return x.TableInfo(v)
|
|
|
|
}
|
2020-02-15 05:51:25 -05:00
|
|
|
|
2021-09-19 06:49:59 -05:00
|
|
|
// DumpTables dump tables information
|
|
|
|
func DumpTables(tables []*schemas.Table, w io.Writer, tp ...schemas.DBType) error {
|
|
|
|
return x.DumpTables(tables, w, tp...)
|
|
|
|
}
|
2016-11-25 19:20:18 -05:00
|
|
|
|
2021-09-19 06:49:59 -05:00
|
|
|
// 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 00:48:10 -05:00
|
|
|
|
2014-04-05 09:46:32 -05:00
|
|
|
func init() {
|
2016-11-25 19:20:18 -05:00
|
|
|
gonicNames := []string{"SSL", "UID"}
|
2015-08-27 10:06:14 -05:00
|
|
|
for _, name := range gonicNames {
|
2020-03-22 10:12:55 -05:00
|
|
|
names.LintGonicMapper[name] = true
|
2015-08-27 10:06:14 -05:00
|
|
|
}
|
2014-04-05 09:46:32 -05:00
|
|
|
}
|
|
|
|
|
2021-03-24 13:27:22 -05:00
|
|
|
// GetNewEngine returns a new xorm engine from the configuration
|
|
|
|
func GetNewEngine() (*xorm.Engine, error) {
|
2019-08-24 04:24:45 -05:00
|
|
|
connStr, err := setting.DBConnStr()
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2014-03-30 09:47:08 -05:00
|
|
|
}
|
2017-02-20 03:11:13 -05:00
|
|
|
|
2021-01-01 21:07:43 -05:00
|
|
|
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 10:45:14 -05:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2020-03-27 03:44:05 -05:00
|
|
|
if setting.Database.Type == "mysql" {
|
|
|
|
engine.Dialect().SetParams(map[string]string{"rowFormat": "DYNAMIC"})
|
2020-07-21 07:28:27 -05:00
|
|
|
} else if setting.Database.Type == "mssql" {
|
|
|
|
engine.Dialect().SetParams(map[string]string{"DEFAULT_VARCHAR": "nvarchar"})
|
2020-03-27 03:44:05 -05:00
|
|
|
}
|
2020-01-20 10:45:14 -05:00
|
|
|
engine.SetSchema(setting.Database.Schema)
|
|
|
|
return engine, nil
|
2014-09-04 10:19:26 -05:00
|
|
|
}
|
|
|
|
|
2021-06-13 21:22:55 -05:00
|
|
|
func syncTables() error {
|
|
|
|
return x.StoreEngine("InnoDB").Sync2(tables...)
|
|
|
|
}
|
|
|
|
|
2021-10-29 03:23:10 -05:00
|
|
|
// NewInstallTestEngine creates a new xorm.Engine for testing during install
|
|
|
|
//
|
|
|
|
// This function will cause the basic database schema to be created
|
|
|
|
func NewInstallTestEngine(ctx context.Context, migrateFunc func(*xorm.Engine) error) (err error) {
|
2021-03-24 13:27:22 -05:00
|
|
|
x, err = GetNewEngine()
|
2014-03-30 09:47:08 -05:00
|
|
|
if err != nil {
|
2021-10-29 03:23:10 -05:00
|
|
|
return fmt.Errorf("failed to connect to database: %w", err)
|
2014-03-30 09:47:08 -05:00
|
|
|
}
|
2014-09-04 10:19:26 -05:00
|
|
|
|
2020-03-22 10:12:55 -05:00
|
|
|
x.SetMapper(names.GonicMapper{})
|
2021-10-20 09:37:19 -05:00
|
|
|
x.SetLogger(NewXORMLogger(!setting.IsProd))
|
|
|
|
x.ShowSQL(!setting.IsProd)
|
2021-10-29 03:23:10 -05:00
|
|
|
|
|
|
|
x.SetDefaultContext(ctx)
|
|
|
|
|
|
|
|
if err = x.Ping(); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// We have to run migrateFunc here in case the user is re-running installation on a previously created DB.
|
|
|
|
// If we do not then table schemas will be changed and there will be conflicts when the migrations run properly.
|
|
|
|
//
|
|
|
|
// Installation should only be being re-run if users want to recover an old database.
|
|
|
|
// However, we should think carefully about should we support re-install on an installed instance,
|
|
|
|
// as there may be other problems due to secret reinitialization.
|
|
|
|
if err = migrateFunc(x); err != nil {
|
|
|
|
return fmt.Errorf("migrate: %v", err)
|
|
|
|
}
|
|
|
|
|
2021-06-13 21:22:55 -05:00
|
|
|
return syncTables()
|
2014-03-30 09:47:08 -05:00
|
|
|
}
|
|
|
|
|
2016-11-25 19:20:18 -05:00
|
|
|
// SetEngine sets the xorm.Engine
|
2014-03-29 16:50:51 -05:00
|
|
|
func SetEngine() (err error) {
|
2021-03-24 13:27:22 -05:00
|
|
|
x, err = GetNewEngine()
|
2014-02-18 17:48:02 -05:00
|
|
|
if err != nil {
|
2017-01-29 15:13:57 -05:00
|
|
|
return fmt.Errorf("Failed to connect to database: %v", err)
|
2014-02-18 17:48:02 -05:00
|
|
|
}
|
|
|
|
|
2020-03-22 10:12:55 -05:00
|
|
|
x.SetMapper(names.GonicMapper{})
|
2014-12-06 20:22:48 -05:00
|
|
|
// WARNING: for serv command, MUST remove the output to os.stdout,
|
2014-03-20 15:04:56 -05:00
|
|
|
// so use log file to instead print to stdout.
|
2019-08-24 04:24:45 -05:00
|
|
|
x.SetLogger(NewXORMLogger(setting.Database.LogSQL))
|
|
|
|
x.ShowSQL(setting.Database.LogSQL)
|
2019-10-21 16:20:47 -05:00
|
|
|
x.SetMaxOpenConns(setting.Database.MaxOpenConns)
|
|
|
|
x.SetMaxIdleConns(setting.Database.MaxIdleConns)
|
|
|
|
x.SetConnMaxLifetime(setting.Database.ConnMaxLifetime)
|
2014-03-29 16:50:51 -05:00
|
|
|
return nil
|
2014-02-18 17:48:02 -05:00
|
|
|
}
|
|
|
|
|
2016-11-25 19:20:18 -05:00
|
|
|
// NewEngine initializes a new xorm.Engine
|
2020-05-29 08:24:15 -05:00
|
|
|
// 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 04:51:28 -05:00
|
|
|
func NewEngine(ctx context.Context, migrateFunc func(*xorm.Engine) error) (err error) {
|
2014-03-29 16:50:51 -05:00
|
|
|
if err = SetEngine(); err != nil {
|
|
|
|
return err
|
2014-04-05 09:46:32 -05:00
|
|
|
}
|
2015-01-22 07:49:52 -05:00
|
|
|
|
2021-09-23 10:45:36 -05:00
|
|
|
DefaultContext = &Context{
|
|
|
|
Context: ctx,
|
|
|
|
e: x,
|
|
|
|
}
|
|
|
|
|
2019-12-15 04:51:28 -05:00
|
|
|
x.SetDefaultContext(ctx)
|
|
|
|
|
2016-11-24 09:30:36 -05:00
|
|
|
if err = x.Ping(); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2017-07-02 08:50:57 -05:00
|
|
|
if err = migrateFunc(x); err != nil {
|
2015-02-11 21:58:37 -05:00
|
|
|
return fmt.Errorf("migrate: %v", err)
|
2015-01-22 07:49:52 -05:00
|
|
|
}
|
|
|
|
|
2021-06-13 21:22:55 -05:00
|
|
|
if err = syncTables(); err != nil {
|
2016-11-28 02:25:16 -05:00
|
|
|
return fmt.Errorf("sync database struct error: %v", err)
|
2014-02-19 04:50:53 -05:00
|
|
|
}
|
2015-01-23 02:54:16 -05:00
|
|
|
|
2021-09-19 06:49:59 -05:00
|
|
|
for _, initFunc := range initFuncs {
|
|
|
|
if err := initFunc(); err != nil {
|
|
|
|
return fmt.Errorf("initFunc failed: %v", err)
|
2021-08-17 13:30:42 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-03-29 16:50:51 -05:00
|
|
|
return nil
|
2014-02-18 17:48:02 -05:00
|
|
|
}
|
2014-03-20 15:04:56 -05:00
|
|
|
|
2020-09-06 16:52:01 -05:00
|
|
|
// 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-25 19:20:18 -05:00
|
|
|
// Ping tests if database is alive
|
2014-08-06 16:21:24 -05:00
|
|
|
func Ping() error {
|
2018-04-04 04:34:27 -05:00
|
|
|
if x != nil {
|
|
|
|
return x.Ping()
|
|
|
|
}
|
|
|
|
return errors.New("database not configured")
|
2014-08-06 16:21:24 -05:00
|
|
|
}
|
|
|
|
|
2017-01-03 03:20:28 -05:00
|
|
|
// DumpDatabase dumps all data from database according the special database SQL syntax to file system.
|
2021-03-14 13:52:12 -05:00
|
|
|
func DumpDatabase(filePath, dbType string) error {
|
2020-03-22 10:12:55 -05:00
|
|
|
var tbs []*schemas.Table
|
2017-01-03 03:20:28 -05:00
|
|
|
for _, t := range tables {
|
2020-03-22 10:12:55 -05:00
|
|
|
t, err := x.TableInfo(t)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
tbs = append(tbs, t)
|
2017-01-03 03:20:28 -05:00
|
|
|
}
|
2020-09-07 17:27:17 -05:00
|
|
|
|
|
|
|
type Version struct {
|
|
|
|
ID int64 `xorm:"pk autoincr"`
|
|
|
|
Version int64
|
|
|
|
}
|
2021-05-06 18:17:43 -05:00
|
|
|
t, err := x.TableInfo(&Version{})
|
2020-09-07 17:27:17 -05:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
tbs = append(tbs, t)
|
|
|
|
|
2017-01-03 03:20:28 -05:00
|
|
|
if len(dbType) > 0 {
|
2020-03-22 10:12:55 -05:00
|
|
|
return x.DumpTablesToFile(tbs, filePath, schemas.DBType(dbType))
|
2017-01-03 03:20:28 -05:00
|
|
|
}
|
|
|
|
return x.DumpTablesToFile(tbs, filePath)
|
2014-05-04 23:55:17 -05:00
|
|
|
}
|
2019-07-06 14:24:50 -05:00
|
|
|
|
|
|
|
// MaxBatchInsertSize returns the table's max batch insert size
|
|
|
|
func MaxBatchInsertSize(bean interface{}) int {
|
2020-03-22 10:12:55 -05:00
|
|
|
t, err := x.TableInfo(bean)
|
|
|
|
if err != nil {
|
|
|
|
return 50
|
|
|
|
}
|
2019-07-06 14:24:50 -05:00
|
|
|
return 999 / len(t.ColumnsSeq())
|
|
|
|
}
|
2019-09-05 21:20:09 -05:00
|
|
|
|
|
|
|
// Count returns records number according struct's fields as database query conditions
|
|
|
|
func Count(bean interface{}) (int64, error) {
|
|
|
|
return x.Count(bean)
|
|
|
|
}
|
2019-12-08 14:15:35 -05:00
|
|
|
|
|
|
|
// 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)
|
|
|
|
}
|