299 lines
9.0 KiB
Go
299 lines
9.0 KiB
Go
|
// Copyright 2023 The Xorm Authors. All rights reserved.
|
||
|
|
// Use of this source code is governed by a BSD-style
|
||
|
|
// license that can be found in the LICENSE file.
|
||
|
|
|
||
|
|
package xorm
|
||
|
|
|
||
|
|
import (
|
||
|
|
"strings"
|
||
|
|
|
||
|
|
"xorm.io/xorm/internal/utils"
|
||
|
|
"xorm.io/xorm/schemas"
|
||
|
|
)
|
||
|
|
|
||
|
|
type SyncOptions struct {
|
||
|
|
WarnIfDatabaseColumnMissed bool
|
||
|
|
// IgnoreConstrains will not add, delete or update unique constrains
|
||
|
|
IgnoreConstrains bool
|
||
|
|
// IgnoreIndices will not add or delete indices
|
||
|
|
IgnoreIndices bool
|
||
|
|
}
|
||
|
|
|
||
|
|
type SyncResult struct{}
|
||
|
|
|
||
|
|
// Sync the new struct changes to database, this method will automatically add
|
||
|
|
// table, column, index, unique. but will not delete or change anything.
|
||
|
|
// If you change some field, you should change the database manually.
|
||
|
|
func (engine *Engine) Sync(beans ...interface{}) error {
|
||
|
|
session := engine.NewSession()
|
||
|
|
defer session.Close()
|
||
|
|
return session.Sync(beans...)
|
||
|
|
}
|
||
|
|
|
||
|
|
// SyncWithOptions sync the database schemas according options and table structs
|
||
|
|
func (engine *Engine) SyncWithOptions(opts SyncOptions, beans ...interface{}) (*SyncResult, error) {
|
||
|
|
session := engine.NewSession()
|
||
|
|
defer session.Close()
|
||
|
|
return session.SyncWithOptions(opts, beans...)
|
||
|
|
}
|
||
|
|
|
||
|
|
// Sync2 synchronize structs to database tables
|
||
|
|
// Depricated
|
||
|
|
func (engine *Engine) Sync2(beans ...interface{}) error {
|
||
|
|
return engine.Sync(beans...)
|
||
|
|
}
|
||
|
|
|
||
|
|
// Sync2 synchronize structs to database tables
|
||
|
|
// Depricated
|
||
|
|
func (session *Session) Sync2(beans ...interface{}) error {
|
||
|
|
return session.Sync(beans...)
|
||
|
|
}
|
||
|
|
|
||
|
|
// Sync synchronize structs to database tables
|
||
|
|
func (session *Session) Sync(beans ...interface{}) error {
|
||
|
|
_, err := session.SyncWithOptions(SyncOptions{
|
||
|
|
WarnIfDatabaseColumnMissed: false,
|
||
|
|
IgnoreConstrains: false,
|
||
|
|
IgnoreIndices: false,
|
||
|
|
}, beans...)
|
||
|
|
return err
|
||
|
|
}
|
||
|
|
|
||
|
|
func (session *Session) SyncWithOptions(opts SyncOptions, beans ...interface{}) (*SyncResult, error) {
|
||
|
|
engine := session.engine
|
||
|
|
|
||
|
|
if session.isAutoClose {
|
||
|
|
session.isAutoClose = false
|
||
|
|
defer session.Close()
|
||
|
|
}
|
||
|
|
|
||
|
|
tables, err := engine.dialect.GetTables(session.getQueryer(), session.ctx)
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
|
||
|
|
session.autoResetStatement = false
|
||
|
|
defer func() {
|
||
|
|
session.autoResetStatement = true
|
||
|
|
session.resetStatement()
|
||
|
|
}()
|
||
|
|
|
||
|
|
var syncResult SyncResult
|
||
|
|
|
||
|
|
for _, bean := range beans {
|
||
|
|
v := utils.ReflectValue(bean)
|
||
|
|
table, err := engine.tagParser.ParseWithCache(v)
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
var tbName string
|
||
|
|
if len(session.statement.AltTableName) > 0 {
|
||
|
|
tbName = session.statement.AltTableName
|
||
|
|
} else {
|
||
|
|
tbName = engine.TableName(bean)
|
||
|
|
}
|
||
|
|
tbNameWithSchema := engine.tbNameWithSchema(tbName)
|
||
|
|
|
||
|
|
var oriTable *schemas.Table
|
||
|
|
for _, tb := range tables {
|
||
|
|
if strings.EqualFold(engine.tbNameWithSchema(tb.Name), engine.tbNameWithSchema(tbName)) {
|
||
|
|
oriTable = tb
|
||
|
|
break
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// this is a new table
|
||
|
|
if oriTable == nil {
|
||
|
|
err = session.StoreEngine(session.statement.StoreEngine).createTable(bean)
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
|
||
|
|
if !opts.IgnoreConstrains {
|
||
|
|
err = session.createUniques(bean)
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if !opts.IgnoreIndices {
|
||
|
|
err = session.createIndexes(bean)
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
continue
|
||
|
|
}
|
||
|
|
|
||
|
|
// this will modify an old table
|
||
|
|
if err = engine.loadTableInfo(session.ctx, oriTable); err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
|
||
|
|
// check columns
|
||
|
|
for _, col := range table.Columns() {
|
||
|
|
var oriCol *schemas.Column
|
||
|
|
for _, col2 := range oriTable.Columns() {
|
||
|
|
if strings.EqualFold(col.Name, col2.Name) {
|
||
|
|
oriCol = col2
|
||
|
|
break
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// column is not exist on table
|
||
|
|
if oriCol == nil {
|
||
|
|
session.statement.RefTable = table
|
||
|
|
session.statement.SetTableName(tbNameWithSchema)
|
||
|
|
if err = session.addColumn(col.Name); err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
continue
|
||
|
|
}
|
||
|
|
|
||
|
|
err = nil
|
||
|
|
expectedType := engine.dialect.SQLType(col)
|
||
|
|
curType := engine.dialect.SQLType(oriCol)
|
||
|
|
if expectedType != curType {
|
||
|
|
if expectedType == schemas.Text &&
|
||
|
|
strings.HasPrefix(curType, schemas.Varchar) {
|
||
|
|
// currently only support mysql & postgres
|
||
|
|
if engine.dialect.URI().DBType == schemas.MYSQL ||
|
||
|
|
engine.dialect.URI().DBType == schemas.POSTGRES {
|
||
|
|
engine.logger.Infof("Table %s column %s change type from %s to %s\n",
|
||
|
|
tbNameWithSchema, col.Name, curType, expectedType)
|
||
|
|
_, err = session.exec(engine.dialect.ModifyColumnSQL(tbNameWithSchema, col))
|
||
|
|
} else {
|
||
|
|
engine.logger.Warnf("Table %s column %s db type is %s, struct type is %s\n",
|
||
|
|
tbNameWithSchema, col.Name, curType, expectedType)
|
||
|
|
}
|
||
|
|
} else if strings.HasPrefix(curType, schemas.Varchar) && strings.HasPrefix(expectedType, schemas.Varchar) {
|
||
|
|
if engine.dialect.URI().DBType == schemas.MYSQL {
|
||
|
|
if oriCol.Length < col.Length {
|
||
|
|
engine.logger.Infof("Table %s column %s change type from varchar(%d) to varchar(%d)\n",
|
||
|
|
tbNameWithSchema, col.Name, oriCol.Length, col.Length)
|
||
|
|
_, err = session.exec(engine.dialect.ModifyColumnSQL(tbNameWithSchema, col))
|
||
|
|
}
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
if !(strings.HasPrefix(curType, expectedType) && curType[len(expectedType)] == '(') {
|
||
|
|
if !strings.EqualFold(schemas.SQLTypeName(curType), engine.dialect.Alias(schemas.SQLTypeName(expectedType))) {
|
||
|
|
engine.logger.Warnf("Table %s column %s db type is %s, struct type is %s",
|
||
|
|
tbNameWithSchema, col.Name, curType, expectedType)
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
} else if expectedType == schemas.Varchar {
|
||
|
|
if engine.dialect.URI().DBType == schemas.MYSQL {
|
||
|
|
if oriCol.Length < col.Length {
|
||
|
|
engine.logger.Infof("Table %s column %s change type from varchar(%d) to varchar(%d)\n",
|
||
|
|
tbNameWithSchema, col.Name, oriCol.Length, col.Length)
|
||
|
|
_, err = session.exec(engine.dialect.ModifyColumnSQL(tbNameWithSchema, col))
|
||
|
|
}
|
||
|
|
}
|
||
|
|
} else if col.Comment != oriCol.Comment {
|
||
|
|
if engine.dialect.URI().DBType == schemas.POSTGRES ||
|
||
|
|
engine.dialect.URI().DBType == schemas.MYSQL {
|
||
|
|
_, err = session.exec(engine.dialect.ModifyColumnSQL(tbNameWithSchema, col))
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if col.Default != oriCol.Default {
|
||
|
|
switch {
|
||
|
|
case col.IsAutoIncrement: // For autoincrement column, don't check default
|
||
|
|
case (col.SQLType.Name == schemas.Bool || col.SQLType.Name == schemas.Boolean) &&
|
||
|
|
((strings.EqualFold(col.Default, "true") && oriCol.Default == "1") ||
|
||
|
|
(strings.EqualFold(col.Default, "false") && oriCol.Default == "0")):
|
||
|
|
default:
|
||
|
|
engine.logger.Warnf("Table %s Column %s db default is %s, struct default is %s",
|
||
|
|
tbName, col.Name, oriCol.Default, col.Default)
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if col.Nullable != oriCol.Nullable {
|
||
|
|
engine.logger.Warnf("Table %s Column %s db nullable is %v, struct nullable is %v",
|
||
|
|
tbName, col.Name, oriCol.Nullable, col.Nullable)
|
||
|
|
}
|
||
|
|
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// indices found in orig table
|
||
|
|
foundIndexNames := make(map[string]bool)
|
||
|
|
// indices to be added
|
||
|
|
addedNames := make(map[string]*schemas.Index)
|
||
|
|
|
||
|
|
// drop indices that exist in orig and new table schema but are not equal
|
||
|
|
for name, index := range table.Indexes {
|
||
|
|
var oriIndex *schemas.Index
|
||
|
|
for name2, index2 := range oriTable.Indexes {
|
||
|
|
if index.Equal(index2) {
|
||
|
|
oriIndex = index2
|
||
|
|
foundIndexNames[name2] = true
|
||
|
|
break
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if oriIndex != nil && oriIndex.Type != index.Type {
|
||
|
|
sql := engine.dialect.DropIndexSQL(tbNameWithSchema, oriIndex)
|
||
|
|
_, err = session.exec(sql)
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
oriIndex = nil
|
||
|
|
}
|
||
|
|
|
||
|
|
if oriIndex == nil {
|
||
|
|
addedNames[name] = index
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// drop all indices that do not exist in new schema or have changed
|
||
|
|
for name2, index2 := range oriTable.Indexes {
|
||
|
|
if _, ok := foundIndexNames[name2]; !ok {
|
||
|
|
// ignore based on there type
|
||
|
|
if (index2.Type == schemas.IndexType && opts.IgnoreIndices) ||
|
||
|
|
(index2.Type == schemas.UniqueType && opts.IgnoreConstrains) {
|
||
|
|
// make sure we do not add a index with same name later
|
||
|
|
delete(addedNames, name2)
|
||
|
|
continue
|
||
|
|
}
|
||
|
|
|
||
|
|
sql := engine.dialect.DropIndexSQL(tbNameWithSchema, index2)
|
||
|
|
_, err = session.exec(sql)
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// Add new indices because either they did not exist before or were dropped to update them
|
||
|
|
for name, index := range addedNames {
|
||
|
|
if index.Type == schemas.UniqueType && !opts.IgnoreConstrains {
|
||
|
|
session.statement.RefTable = table
|
||
|
|
session.statement.SetTableName(tbNameWithSchema)
|
||
|
|
err = session.addUnique(tbNameWithSchema, name)
|
||
|
|
} else if index.Type == schemas.IndexType && !opts.IgnoreIndices {
|
||
|
|
session.statement.RefTable = table
|
||
|
|
session.statement.SetTableName(tbNameWithSchema)
|
||
|
|
err = session.addIndex(tbNameWithSchema, name)
|
||
|
|
}
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if opts.WarnIfDatabaseColumnMissed {
|
||
|
|
// check all the columns which removed from struct fields but left on database tables.
|
||
|
|
for _, colName := range oriTable.ColumnsSeq() {
|
||
|
|
if table.GetColumn(colName) == nil {
|
||
|
|
engine.logger.Warnf("Table %s has column %s but struct has not related field", engine.TableName(oriTable.Name, true), colName)
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return &syncResult, nil
|
||
|
|
}
|