業務中にGoのゼロ値を含む構造体を用いてDBに挿入するとNULLを設定したいカラムにNULLが設定されない現象に遭遇したのでその解決法を残しておきます。

Goのゼロ値について

Goのゼロ値というのは簡単に言うと、定義した変数の初期値を設定せずに使用した際に自動的に初期値として設定される値のことです。以下は主要なデータ型のゼロ値です。

GORMとDBのNULL許容カラム

GORMはGoでのデータベース操作を簡単にするORMライブラリです。Go触ってる人からするとお馴染みですね。

ですがこのGORMは構造体のフィールド値がゼロ値であっても、そのフィールドのデフォルト値として扱います。

そのため、ゼロ値のフィールドはデータベースにNULLとして保存されません。

例：

type User struct {
     ID     uint
     Name   string
     Age    int
}

user := User{Name: "Tanaka"}
db.Create(&user)

上記の例ではAgeフィールドのゼロ値は0になり、データベース上にはNULLではなく0として挿入されます。

これにより構造体のフィールドがゼロ値を持っている状態でGORMを介してデータを入れた際に、初期値としてNULLが設定されることを期待していたカラムにNULLではなくゼロ値が入ってしまう、という現象になるわけですね。

解決策

初期値としてNULLを入れたい場合はフィールドをポインタ型にすればOKです。

type User struct {
     ID     uint
     Name   string
     Age    *int
}

ポインタ型にすることでAgeフィールドの初期値がnilになり、DBにはNULLとして挿入されます。

まとめ

DBの更新時にNULLでアップデートをしたり、更新対象がゼロ値だった場合に更新対象としてみなされなかったりします。今回は作成時も気を付けないといけないということで一つ学びになりました。

GORM公式ドキュメント