GORM V2 自动迁移和迁移接口的方法

简介: GORM V2 自动迁移和迁移接口的方法

01

概念


在项目开发中,我们可能会随时调整声明的模型,比如添加字段和索引,使用 GORM 的自动迁移功能,可以始终让我们的数据库表保持最新。此外,GORM 还提供了一些迁移接口的方法,可以帮助我们方便操作数据库表、字段和索引。

02

自动迁移


AutoMigrate 用于自动迁移您的 schema,保持您的 schema 是最新的。AutoMigrate 会创建表,缺少的外键,约束,列和索引,并且会更改现有列的类型(如果其大小、精度、是否为空可更改)。但不会删除未使用的列,以保护您的数据。


执行 AutoMigrate,需要先声明模型。

db.AutoMigrate(&User{})
db.AutoMigrate(&User{}, &Product{}, &Order{})
// 创建表时添加后缀
db.Set("gorm:table_options", "ENGINE=InnoDB").AutoMigrate(&User{})


AutoMigrate 会自动创建数据库外键约束,您可以在初始化时禁用此功能。


db, err := gorm.Open(sqlite.Open("gorm.db"), &gorm.Config{
  DisableForeignKeyConstraintWhenMigrating: true,
})

03

迁移接口的方法


  • 操作数据库返回当前操作的数据库名
currentDBName := gormDB.Migrator().CurrentDatabase()
fmt.Printf("当前操作的数据库名:%s\n", currentDBName)
  • 操作数据库表
    操作数据库表,必须先声明模型。
  • 创建数据表
err := gormDB.Migrator().CreateTable(&Student{})
if err != nil {
  fmt.Printf("创建数据库表失败,错误:%s\n", err)
  return
}
fmt.Println("创建数据库表成功")
  • 默认情况下,GORM 会约定使用 ID 作为表的主键,可以通过标签 primaryKey 将其它字段设为主键。

    通过将多个字段设为主键,以达到创建复合主键,整型字段设为主键,默认为启用 AutoIncrement,如果需要禁用,使用标签autoIncrement:false。

    GORM 约定使用结构体名的复数形式作为表名,不过也可以根据需求修改,可以实现Tabler 接口来更改默认表名,不过这种方式不支持动态变化,它会被缓存下来以便后续使用,如果想要使用动态表名,可以使用Scopes,关于 Scopes 的使用方法,本文暂不展开。

    GORM 约定使用结构体的字段名作为数据表的字段名,可以通过标签 column 修改。

  • 删除数据表
// gormDB.Migrator().DropTable("students")
gormDB.Migrator().DropTable(&Student{})

  • 修改数据表名称
gormDB.Migrator().RenameTable("students", "stu")
// gormDB.Migrator().RenameTable(&Student{}, &Stu{})
  • 查询数据库表是否已存在
isExist := gormDB.Migrator().HasTable(&Student{})
// isExist := gormDB.Migrator().HasTable("students")
fmt.Printf("数据库表是否存在:%t\n", isExist)
  • 操作数据库表的字段
  • 添加字段添加字段,必须先声明模型
type Student struct {
    Score uint
}
err := gormDB.Migrator().AddColumn(&Student{}, "Score")
if err != nil {
    fmt.Printf("添加字段错误,err:%s\n", err)
    return
}
  • 删除字段
gormDB.Migrator().DropColumn(&Student{}, "email")
  • 修改字段与添加字段相同,必须先声明模型
type Student struct{
    Name string
    UserName string
}
gormDB.Migrator().RenameColumn(&Student{}, "name", "user_name")
  • 查询字段
isExistField := gormDB.Migrator().HasColumn(&Student{}, "name")
fmt.Printf("字段是否存在:%t\n", isExistField)
  • 操作数据库表的索引
  • 创建索引
  • 创建索引,必须先在声明模型中,使用标签定义索引。
  • 方式 1:
err = gormDB.Migrator().CreateIndex(&Student{}, "Name")
if err != nil {
  fmt.Printf("创建索引失败1,err:%s\n", err)
  return
}

方式 2:

err = gormDB.Migrator().CreateIndex(&Student{}, "idx_name")
if err != nil {
  fmt.Printf("创建索引失败2,err:%s\n", err)
  return
}
  • 删除索引
gormDB.Migrator().DropIndex(&Student{}, "idx_name")
// gormDB.Migrator().DropIndex(&Student{}, "UserName")
  • 修改索引与创建索引相同,修改索引,也必须先在声明模型中,使用标签定义索引。方式 1:(未执行成功,可能是 GORM V2 的 BUG)
err = gormDB.Migrator().RenameIndex(&Student{}, "Name", "UserName")
if err != nil {
  fmt.Printf("修改索引名称失败,err:%s\n", err)
  return
}

方式 1,错误信息:


修改索引名称失败,err:Error 1176: Key 'Name' doesn't exist in table 'students'

方式 2:


gormDB.Migrator().RenameIndex(&Student{}, "idx_name", "idx_user_name")

查看索引


isExistIndex := gormDB.Migrator().HasIndex(&Student{}, "Name")
// isExistIndex := gormDB.Migrator().HasIndex(&Student{}, "idx_name")
fmt.Printf("查询索引是否存在:%t\n", isExistIndex)


迁移接口的方法,确实给开发工作带来了方便,但是个人建议除非特殊原因,否则尽量通过在声明模型中修改数据库表的字段和索引。





目录
相关文章
|
8月前
|
关系型数据库 MySQL API
|
8月前
|
关系型数据库 MySQL 数据库连接
gorm连接mysql数据库以及建表和自动迁移
gorm连接mysql数据库以及建表和自动迁移
120 0
|
8月前
|
SQL Java 数据库
dts在数据迁移过程中,出现“无效的表或视图名”错误
dts在数据迁移过程中,如果出现“无效的表或视图名”错误
703 6
|
8月前
|
关系型数据库 MySQL 数据库
dts在数据迁移过程中,如果出现“默认值超出目标数据库支持范围”的错误
dts在数据迁移过程中,如果出现“默认值超出目标数据库支持范围”的错误
90 1
|
安全 数据库连接 数据库
sscms迁移服务器,修改数据库连接字符串
sscms迁移服务器,修改数据库连接字符串,siteserver
305 0
sscms迁移服务器,修改数据库连接字符串
|
SQL 缓存 搜索推荐
Gorm学习(三)基础:迁移(数据库建表以及字段设置)
在项目开发中,我们可能会随时调整声明的模型,比如添加字段和索引,使用 GORM 的自动迁移功能,可以始终让我们的数据库表结构保持最新。
1244 0
Gorm学习(三)基础:迁移(数据库建表以及字段设置)
|
关系型数据库 MySQL
DTS任务为什么一直处于"修改同步对象中"
DTS任务为什么一直处于"修改同步对象中"
|
数据库
TD8.0迁移到QC9.2,自动迁移失败,手动迁移
源机器A:TD8.0+SQLServer2000目标机器B:QC9.2+SQLServer2000 一:自动迁移,1、在A在A上安装QC迁移工具,然后在B中点击TOOLS>>Migration Tool,打算迁移,报错如下:    解决办法:查找TDProjectMigrationProj.
944 0