GORMV2 hint句

こんにちは、Anti-Pattern Inc.の塚本です。

PostgreSQLのUPSERTみたいな事をやりたくて、GORM V2を使用してこんなコードを書きました。

レコードの存在有無に関わらず、レコードを挿入又は更新する場合、Assign関数を使用しこの様なコードになります。

dto := sampleDTO{
  CompanyMemberID:   memberID,
  UserID:            userID,
}
r.db.Conn(ctx).
  Where("company_member_id = ? AND user_id = ?", memberID, userID).
    Assign(&dto).
    FirstOrCreate(&sampleDTO{})

これを実装している時に、GORMのAPIを確認していたのですが、

V2になって対応され気になった機能について、確認してみました。

取得結果をMapに格納

result := map[string]interface{}{}
udtos := []userDTO{}
r.db.Conn(ctx).
    Model(&userDTO{}).
  Where("id = ?", userID).
  First(&result)
}

mapのkeyがカラム名、mapのvalueがDBの値が格納されたmapで取得できました

Hints

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

PostgreSQLはSQL実行時にオプティマイザが統計情報を参照して、最も効率が良いと予想される実行計画が選択され、実行されます。ただし、それが必ずしも最適なものとは限りません。その際に利用する一つの手としてhint句があります。

PostgreSQLでhint句使えないと思ってましたが違うんですね。

https://pghintplan.osdn.jp/pg_hint_plan.html

拡張モジュールを使います。

GORM V2ではこの3つが指定できる様です

・Optimizer Hints

・Index Hints

・Comment Hints

https://gorm.io/docs/hints.html
import "gorm.io/hints"

db.Clauses(hints.UseIndex("idx_user_name")).Find(&User{})
// SELECT * FROM `users` USE INDEX (`idx_user_name`)

db.Clauses(hints.ForceIndex("idx_user_name", "idx_user_id").ForJoin()).Find(&User{})
// SELECT * FROM `users` FORCE INDEX FOR JOIN (`idx_user_name`,`idx_user_id`)"

db.Clauses(
  hints.ForceIndex("idx_user_name", "idx_user_id").ForOrderBy(),
  hints.IgnoreIndex("idx_user_name").ForGroupBy(),
).Find(&User{})
// SELECT * FROM `users` FORCE INDEX FOR ORDER BY (`idx_user_name`,`idx_user_id`) IGNORE INDEX FOR GROUP BY (`idx_user_name`)"

上記のインデックスのヒント句を試してみたかったのですが、拡張モジュールのインストールに手間取りタイムアップ・・・・次回再チャレンジしたいと思います!