GORM allows create database index with tag index, uniqueIndex, those indexes will be created when AutoMigrate or CreateTable with GORM

Index Tag

GORM accepts lots of index settings, like class, type, where, comment, expression, sort, collate, option

Check the following example for how to use it

  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 option
  11. type User struct {
  12.   Name string `gorm:"index:,class:FULLTEXT,option:WITH PARSER ngram INVISIBLE"`
  13. }
  15. // PostgreSQL option
  16. type User struct {
  17.   Name string `gorm:"index:,option:CONCURRENTLY"`
  18. }

uniqueIndex

tag uniqueIndex works similar like index, it equals to index:,unique

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

Composite Indexes

Use same index name for two fields will creates composite indexes, for example:

  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. }

Fields Priority

The column order of a composite index has an impact on its performance so it must be chosen carefully

You can specify the order with the priority option, the default priority value is 10, if priority value is the same, the order will be based on model struct’s field index

  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

Shared composite indexes

If you are creating shared composite indexes with an embedding struct, you can’t specify the index name, as embedding the struct more than once results in the duplicated index name in db.

In this case, you can use index tag composite, it means the id of the composite index. All fields which have the same composite id of the struct are put together to the same index, just like the original rule. But the improvement is it lets the most derived/embedding struct generates the name of index by NamingStrategy. For example:

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

If the table Foo is created, the name of composite index will be idx_foo_myname.

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

Respectively, the name of composite index is idx_bar0_myname and idx_bar1_myname.

composite only works if not specify the name of index.

Multiple indexes

A field accepts multiple index, uniqueIndex tags that will create multiple indexes on a field

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