GORM 允许通过 index、uniqueIndex 标签创建索引，这些索引将在使用 GORM 进行AutoMigrate 或 Createtable 时创建

索引标签

GORM 可以接受很多索引设置，例如class、type、where、comment、expression、sort、collate、option

下面的示例演示了如何使用它：

  1. type User struct {
  2.     Name  string `gorm:"index"`
  3.     Name2 string `gorm:"index:idx_name,unique"`
  4.     Name3 string `gorm:"index:,sort:desc,collate:utf8,type:btree,length:10,where:name3 != 'jinzhu'"`
  5.     Name4 string `gorm:"uniqueIndex"`
  6.     Age   int64  `gorm:"index:,class:FULLTEXT,comment:hello \\, world,where:age > 10"`
  7.     Age2  int64  `gorm:"index:,expression:ABS(age)"`
  8. }
  10. // MySQL 选项
  11. type User struct {
  12.     Name string `gorm:"index:,class:FULLTEXT,option:WITH PARSER ngram INVISIBLE"`
  13. }
  15. // PostgreSQL 选项
  16. type User struct {
  17.     Name string `gorm:"index:,option:CONCURRENTLY"`
  18. }

唯一索引

uniqueIndex 标签的作用与 index 类似，它等效于 index:,unique

  1. type User struct {
  2.     Name1 string `gorm:"uniqueIndex"`
  3.     Name2 string `gorm:"uniqueIndex:idx_name,sort:desc"`
  4. }

复合索引

两个字段使用同一个索引名将创建复合索引，例如：

  1. // create composite index `idx_member` with columns `name`, `number`
  2. type User struct {
  3.     Name   string `gorm:"index:idx_member"`
  4.     Number string `gorm:"index:idx_member"`
  5. }

字段优先级

复合索引列的顺序会影响其性能，因此必须仔细考虑

您可以使用 priority 指定顺序，默认优先级值是 10，如果优先级值相同，则顺序取决于模型结构体字段的顺序

  1. type User struct {
  2.     Name   string `gorm:"index:idx_member"`
  3.     Number string `gorm:"index:idx_member"`
  4. }
  5. // column order: name, number
  7. type User struct {
  8.     Name   string `gorm:"index:idx_member,priority:2"`
  9.     Number string `gorm:"index:idx_member,priority:1"`
  10. }
  11. // column order: number, name
  13. type User struct {
  14.     Name   string `gorm:"index:idx_member,priority:12"`
  15.     Number string `gorm:"index:idx_member"`
  16. }
  17. // column order: number, name

共享复合索引

如果您正在创建带有嵌入结构的共享复合索引，您不能指定索引名称。 作为嵌入结构不止一次会导致重复的索引名称在 db。

在这种情况下，您可以使用索引标签 composite, 它意味着复合索引的id。 所有具有相同结构复合id的字段都与原始规则一样，被合并到相同的索引中。 但改进使得最受影响/嵌入结构能够通过命名策略生成索引名称。 例如:

  1. type Foo struct {
  2.   IndexA int `gorm:"index:,unique,composite:myname"`
  3.   IndexB int `gorm:"index:,unique,composite:myname"`
  4. }

如果表Foo被创建，复合索引的名称将是 idx_foo_myname。

  1. type Bar0 struct {
  2.   Foo
  3. }
  5. type Bar1 struct {
  6.   Foo
  7. }

复合索引的名称分别是 idx_bar0_myname 和 idx_bar1_myname。

复合 只能在指定索引名称时使用。

多索引

一个字段接受多个 index、uniqueIndex 标签，这会在一个字段上创建多个索引

  1. type UserIndex struct {
  2.     OID          int64  `gorm:"index:idx_id;index:idx_oid,unique"`
  3.     MemberNumber string `gorm:"index:idx_id"`
  4. }