多应用+插件架构,代码干净,二开方便,首家独创一键云编译技术,文档视频完善,免费商用码云13.8K 广告
# 迁移 ## AutoMigrate AutoMigrate 用于自动迁移您的 schema,保持您的 schema 是最新的。 **注意:**AutoMigrate***\* 只会创建表,它会忽略外键、约束、列和索引。为了保护您的数据,它**不会**更改现有列的类型或删除未使用的列。 ```go db.AutoMigrate(&User{}) db.AutoMigrate(&User{}, &Product{}, &Order{}) // 创建表时添加后缀 db.Set("gorm:table_options", "ENGINE=InnoDB").AutoMigrate(&User{}) ``` **注意** AutoMigrate 会自动创建数据库外键约束,您可以在初始化时禁用此功能,例如: ```go db, err := gorm.Open(sqlite.Open("gorm.db"), &gorm.Config{ DisableForeignKeyConstraintWhenMigrating: true, }) ``` ## Migrator 接口 GORM 提供了 Migrator 接口,该接口为每个数据库提供了统一的 API 接口,可用来为您的数据库构建独立迁移,例如: SQLite 不支持 `ALTER COLUMN`、`DROP COLUMN`,当你试图修改表结构,GORM 将创建一个新表、复制所有数据、删除旧表、重命名新表。 一些版本的 MySQL 不支持 rename 列,索引。GORM 将基于您使用 MySQL 的版本执行不同 SQL ```go type Migrator interface { // AutoMigrate AutoMigrate(dst ...interface{}) error // Database CurrentDatabase() string FullDataTypeOf(*schema.Field) clause.Expr // Tables CreateTable(dst ...interface{}) error DropTable(dst ...interface{}) error HasTable(dst interface{}) bool RenameTable(oldName, newName interface{}) error // Columns AddColumn(dst interface{}, field string) error DropColumn(dst interface{}, field string) error AlterColumn(dst interface{}, field string) error HasColumn(dst interface{}, field string) bool RenameColumn(dst interface{}, oldName, field string) error ColumnTypes(dst interface{}) ([]*sql.ColumnType, error) // Constraints CreateConstraint(dst interface{}, name string) error DropConstraint(dst interface{}, name string) error HasConstraint(dst interface{}, name string) bool // Indexes CreateIndex(dst interface{}, name string) error DropIndex(dst interface{}, name string) error HasIndex(dst interface{}, name string) bool RenameIndex(dst interface{}, oldName, newName string) error } ``` ### 当前数据库 返回当前使用的数据库名 ```go db.Migrator().CurrentDatabase() ``` ### 表 ```go // 为 `User` 创建表 db.Migrator().CreateTable(&User{}) // 将 "ENGINE=InnoDB" 添加到创建 `User` 的 SQL 里去 db.Set("gorm:table_options", "ENGINE=InnoDB").CreateTable(&User{}) // 检查 `User` 对应的表是否存在 db.Migrator().HasTable(&User{}) db.Migrator().HasTable("users") // 如果存在表则删除(删除时会忽略、删除外键约束) db.Migrator().DropTable(&User{}) db.Migrator().DropTable("users") // 重命名表 db.Migrator().RenameTable(&User{}, &UserInfo{}) db.Migrator().RenameTable("users", "user_infos") ``` ### 列 ```go type User struct { Name string } // 添加 name 字段 db.Migrator().AddColumn(&User{}, "Name") // 删除 name 字段 db.Migrator().DropColumn(&User{}, "Name") // 修改 name 字段 db.Migrator().AlterColumn(&User{}, "Name") // 检查字段是否存在 db.Migrator().HasColumn(&User{}, "Name") type User struct { Name string NewName string } // 重命名字段 db.Migrator().RenameColumn(&User{}, "Name", "NewName") db.Migrator().RenameColumn(&User{}, "name", "new_name") // 获取字段类型 db.Migrator().ColumnTypes(&User{}) ([]*sql.ColumnType, error) ``` ### 约束 ```go type UserIndex struct { Name string `gorm:"check:name_checker,name <> 'jinzhu'"` } // 创建约束 db.Migrator().CreateConstraint(&User{}, "name_checker") // 删除约束 db.Migrator().DropConstraint(&User{}, "name_checker") // 检查约束是否存在 db.Migrator().HasConstraint(&User{}, "name_checker") ``` ### 索引 ```go type User struct { gorm.Model Name string `gorm:"size:255;index:idx_name,unique"` } // 为 Name 字段创建索引 db.Migrator().CreateIndex(&User{}, "Name") db.Migrator().CreateIndex(&User{}, "idx_name") // 为 Name 字段删除索引 db.Migrator().DropIndex(&User{}, "Name") db.Migrator().DropIndex(&User{}, "idx_name") // 检查索引是否存在 db.Migrator().HasIndex(&User{}, "Name") db.Migrator().HasIndex(&User{}, "idx_name") type User struct { gorm.Model Name string `gorm:"size:255;index:idx_name,unique"` Name2 string `gorm:"size:255;index:idx_name_2,unique"` } // 修改索引名 db.Migrator().RenameIndex(&User{}, "Name", "Name2") db.Migrator().RenameIndex(&User{}, "idx_name", "idx_name_2") ``` ## 约束 GORM 会在自动迁移和创建表时创建约束,查看 [约束](http://v2.gorm.io/zh_CN/docs/constraints.html) 或 [数据库索引](http://v2.gorm.io/zh_CN/docs/indexes.html) 获取详情 ## 其他迁移工具 GORM 的 AutoMigrate 在大多数情况下都工作得很好,但如果您正在寻找更严格的迁移工具,GORM 提供一个通用数据库接口,可能对您有帮助。 ```go // returns `*sql.DB` db.DB() ``` 查看 [通用接口](http://v2.gorm.io/zh_CN/docs/generic_interface.html) 获取详情。