GORM provides optimizer/index/comment hints support

https://github.com/go-gorm/hints

Optimizer Hints

  1. import "gorm.io/hints"
  3. db.Clauses(hints.New("hint")).Find(&User{})
  4. // SELECT * /*+ hint */ FROM `users`

Index Hints

  1. import "gorm.io/hints"
  3. db.Clauses(hints.UseIndex("idx_user_name")).Find(&User{})
  4. // SELECT * FROM `users` USE INDEX (`idx_user_name`)
  6. db.Clauses(hints.ForceIndex("idx_user_name", "idx_user_id").ForJoin()).Find(&User{})
  7. // SELECT * FROM `users` FORCE INDEX FOR JOIN (`idx_user_name`,`idx_user_id`)"
  9. db.Clauses(
  10.   hints.ForceIndex("idx_user_name", "idx_user_id").ForOrderBy(),
  11.   hints.IgnoreIndex("idx_user_name").ForGroupBy(),
  12. ).Find(&User{})
  13. // SELECT * FROM `users` FORCE INDEX FOR ORDER BY (`idx_user_name`,`idx_user_id`) IGNORE INDEX FOR GROUP BY (`idx_user_name`)"

Comment Hints

  1. import "gorm.io/hints"
  3. db.Clauses(hints.Comment("select", "master")).Find(&User{})
  4. // SELECT /*master*/ * FROM `users`;
  6. db.Clauses(hints.CommentBefore("insert", "node2")).Create(&user)
  7. // /*node2*/ INSERT INTO `users` ...;
  9. db.Clauses(hints.CommentAfter("select", "node2")).Create(&user)
  10. // /*node2*/ INSERT INTO `users` ...;
  12. db.Clauses(hints.CommentAfter("where", "hint")).Find(&User{}, "id = ?", 1)
  13. // SELECT * FROM `users` WHERE id = ? /* hint */