CRUD 操作

users テーブルに対して、Create によるレコードの追加、Find による全件取得、First / Where による1件取得、Save / Updates による更新、Delete による削除までを順に扱います。前章と同じく、各操作の main.go はその操作だけを実行するスタンドアロン形式で書き換えていきます。

1. ユーザの追加(Create)

INSERTに相当するのが db.Create(&u) です。前章の database/sql では db.Exec("INSERT INTO ...", ...) と書きましたが、GORMではSQLを書かずに構造体を渡すだけでINSERTを発行できます。

書き方は以下のとおりです。GORMは自動採番された ID を構造体の ID に書き戻すため、Create 後に構造体の ID を読むと、DB側で振られたIDを取得できます。エラーは戻り値の .Error フィールドから取り出します。

u := モデル名{フィールド: 値, ...}
if err := db.Create(&u).Error; err != nil {
    // エラー処理
}
// u.ID に自動採番された ID が入る

main.go を以下のように書き換えます。これは、User を1件作成して、自動採番されたIDを表示するコードです。

package main

import (
    "fmt"
    "os"

    "github.com/joho/godotenv"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

type User struct {
    ID    uint   `gorm:"primaryKey"`
    Name  string `gorm:"size:50;not null"`
    Email string `gorm:"size:100;not null;uniqueIndex"`
}

func main() {
    if err := godotenv.Load(); err != nil {
        fmt.Println(".envファイル読み込み失敗:", err)
        return
    }

    dsn := fmt.Sprintf(
        "%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&parseTime=True&loc=Local",
        os.Getenv("MYSQL_USER"),
        os.Getenv("MYSQL_PASSWORD"),
        os.Getenv("MYSQL_HOST"),
        os.Getenv("MYSQL_PORT"),
        os.Getenv("MYSQL_DATABASE"),
    )
    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
    if err != nil {
        fmt.Println("Open失敗:", err)
        return
    }

    u := User{Name: "Taro", Email: "taro@example.com"}
    if err := db.Create(&u).Error; err != nil {
        fmt.Println("Create失敗:", err)
        return
    }
    fmt.Println("作成したユーザID:", u.ID)
}

実行してユーザを追加します。

go run main.go

以下のような実行結果が表示されます。

作成したユーザID: 1

AUTO_INCREMENT が自動で 1 を割り振り、そのIDが u.ID に書き戻されて表示されました。

コードを解説します。

u := User{Name: "Taro", Email: "taro@example.com"}
if err := db.Create(&u).Error; err != nil {
    ...
}
fmt.Println("作成したユーザID:", u.ID)

User のインスタンスを作り、db.Create(&u) でINSERTします。GORMは自動採番されたIDを u.ID に書き戻すため、Create 後に u.ID を読むと、DB側で振られたIDを取得できます。db.Create は *gorm.DB を返し、その .Error フィールドでエラーの有無を確認します。

2. ユーザ一覧の取得(Find)

SELECTの結果を全件取得するのが db.Find(&users) です。前章の database/sql では db.Query + rows.Next + rows.Scan のループを書いていましたが、GORMではGoのスライスを渡すだけで、各行を構造体として詰めてくれます。

書き方は以下のとおりです。スライスを渡すと SELECT * FROM テーブル名 相当のSQLが自動発行され、各行が構造体として詰められます。

var スライス []モデル名
if err := db.Find(&スライス).Error; err != nil {
    // エラー処理
}

main.go を以下のように書き換えます。これは、users テーブルの全レコードを取り出して1件ずつ表示するコードです。前ステップで登録した1件がそのまま残っている前提です。

package main

import (
    "fmt"
    "os"

    "github.com/joho/godotenv"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

type User struct {
    ID    uint   `gorm:"primaryKey"`
    Name  string `gorm:"size:50;not null"`
    Email string `gorm:"size:100;not null;uniqueIndex"`
}

func main() {
    if err := godotenv.Load(); err != nil {
        fmt.Println(".envファイル読み込み失敗:", err)
        return
    }

    dsn := fmt.Sprintf(
        "%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&parseTime=True&loc=Local",
        os.Getenv("MYSQL_USER"),
        os.Getenv("MYSQL_PASSWORD"),
        os.Getenv("MYSQL_HOST"),
        os.Getenv("MYSQL_PORT"),
        os.Getenv("MYSQL_DATABASE"),
    )
    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
    if err != nil {
        fmt.Println("Open失敗:", err)
        return
    }

    var users []User
    if err := db.Find(&users).Error; err != nil {
        fmt.Println("Find失敗:", err)
        return
    }

    fmt.Println("--- ユーザ一覧 ---")
    for _, u := range users {
        fmt.Printf("[%d] %s <%s>\n", u.ID, u.Name, u.Email)
    }
}

実行してユーザ一覧を確認します。

go run main.go

以下のような実行結果が表示されます。

--- ユーザ一覧 ---
[1] Taro <taro@example.com>

前ステップの Create で追加された1件のユーザが [ID] Name <email> の形で表示されました。

コードを解説します。

var users []User
if err := db.Find(&users).Error; err != nil {
    ...
}

db.Find(&users) は「テーブルの全レコードを users スライスに詰める」動きをします。SELECT * FROM users に相当するSQLが自動生成され、各行が User構造体にマッピングされます。前章のように for rows.Next() { rows.Scan(...) } を書く必要はありません。

3. 1件の取得(First / Where)

主キーで1件だけ取り出すのが db.First(&u, id) です。前章の database/sql では QueryRow + Scan + sql.ErrNoRows の分岐を書いていましたが、GORMでは First の戻り値のエラーが gorm.ErrRecordNotFound かどうかで判定します。

書き方は以下のとおりです。主キーで1件取り出し、見つからないときは gorm.ErrRecordNotFound が返ります。

var 変数 モデル名
err := db.First(&変数, 主キー値).Error   // 主キーで1件取得。見つからないと gorm.ErrRecordNotFound

main.go を以下のように書き換えます。これは、id = 1 のユーザを First で1件だけ取得し、存在するかどうかで分岐して表示するコードです。前ステップで登録した id = 1 のユーザが残っている前提です。

package main

import (
    "errors"
    "fmt"
    "os"

    "github.com/joho/godotenv"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

type User struct {
    ID    uint   `gorm:"primaryKey"`
    Name  string `gorm:"size:50;not null"`
    Email string `gorm:"size:100;not null;uniqueIndex"`
}

func main() {
    if err := godotenv.Load(); err != nil {
        fmt.Println(".envファイル読み込み失敗:", err)
        return
    }

    dsn := fmt.Sprintf(
        "%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&parseTime=True&loc=Local",
        os.Getenv("MYSQL_USER"),
        os.Getenv("MYSQL_PASSWORD"),
        os.Getenv("MYSQL_HOST"),
        os.Getenv("MYSQL_PORT"),
        os.Getenv("MYSQL_DATABASE"),
    )
    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
    if err != nil {
        fmt.Println("Open失敗:", err)
        return
    }

    var one User
    if err := db.First(&one, 1).Error; err != nil {
        if errors.Is(err, gorm.ErrRecordNotFound) {
            fmt.Println("ID=1 のユーザは見つかりませんでした")
        } else {
            fmt.Println("First失敗:", err)
        }
        return
    }
    fmt.Printf("取得: [%d] %s <%s>\n", one.ID, one.Name, one.Email)
}

実行して1件取得できることを確認します。

go run main.go

以下のような実行結果が表示されます。

取得: [1] Taro <taro@example.com>

主キー 1 のレコードが取得され、one に詰め込まれた内容がそのまま表示されました。

コードを解説します。

if err := db.First(&one, 1).Error; err != nil {
    if errors.Is(err, gorm.ErrRecordNotFound) {
        fmt.Println("ID=1 のユーザは見つかりませんでした")
    } else {
        ...
    }
    return
}

db.First(&one, 1) は「主キー 1 のレコードを one に詰める」動きをします。見つからない場合は gorm.ErrRecordNotFound が返るので、errors.Is で他のエラーと区別して扱います。前章の sql.ErrNoRows と同じ役割です。

主キー以外の条件で取り出したい場合は Where を組み合わせます。書き方は以下のとおりです。プレースホルダに値を渡すため、SQLインジェクション対策も自動で行われます。

db.Where("カラム名 = ?", 値).First(&変数)   // 条件にマッチする最初の1件を取得

main.go の First の呼び出しの後ろに、以下のコードを追記します。これは、email = "taro@example.com" のユーザを取り出す例です。

    var byEmail User
    if err := db.Where("email = ?", "taro@example.com").First(&byEmail).Error; err != nil {
        fmt.Println("Where失敗:", err)
        return
    }
    fmt.Println("メール検索:", byEmail.Name)

go run main.go コマンドで実行します。以下のような実行結果が表示されます。

取得: [1] Taro <taro@example.com>
メール検索: Taro

email = 'taro@example.com' に一致するレコードの Name(Taro)が取得できました。

db.Where("email = ?", "taro@example.com").First(&byEmail)

Where の第一引数はSQLの式(プレースホルダ付き)、第二引数以降が値です。GORM内部でプリペアドステートメントに変換されるため、SQLインジェクション対策は自動で行われます。.First(&byEmail) で条件にマッチする最初の1件を取り出します。

4. ユーザの更新(Save / Updates)

db.Save(&u) は構造体の全カラムをUPDATEします。前章の database/sql では UPDATE users SET カラム = ? WHERE id = ? のSQLを組み立てていましたが、GORMでは構造体のフィールドを書き換えて Save に渡すだけで、GORM側がSQLを組み立てます。

書き方は以下のとおりです。First などで取り出したレコードのフィールドを書き換えたあと、db.Save(&u) を呼ぶと、構造体の全カラムがそのままUPDATEされます。

変数.カラム名 = 新しい値
db.Save(&変数)   //構造体の全カラムを UPDATE

main.go を以下のように書き換えます。これは、id = 1 のユーザを取得したうえで、Name を Taro Yamada に更新するコードです。前ステップまでで登録した id = 1 のユーザが残っている前提です。

package main

import (
    "fmt"
    "os"

    "github.com/joho/godotenv"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

type User struct {
    ID    uint   `gorm:"primaryKey"`
    Name  string `gorm:"size:50;not null"`
    Email string `gorm:"size:100;not null;uniqueIndex"`
}

func main() {
    if err := godotenv.Load(); err != nil {
        fmt.Println(".envファイル読み込み失敗:", err)
        return
    }

    dsn := fmt.Sprintf(
        "%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&parseTime=True&loc=Local",
        os.Getenv("MYSQL_USER"),
        os.Getenv("MYSQL_PASSWORD"),
        os.Getenv("MYSQL_HOST"),
        os.Getenv("MYSQL_PORT"),
        os.Getenv("MYSQL_DATABASE"),
    )
    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
    if err != nil {
        fmt.Println("Open失敗:", err)
        return
    }

    var one User
    if err := db.First(&one, 1).Error; err != nil {
        fmt.Println("First失敗:", err)
        return
    }

    one.Name = "Taro Yamada"
    if err := db.Save(&one).Error; err != nil {
        fmt.Println("Save失敗:", err)
        return
    }
    fmt.Println("更新完了:", one.Name)
}

実行して更新を確認します。

go run main.go

以下のような実行結果が表示されます。

更新完了: Taro Yamada

Name カラムが Taro Yamada にUPDATEされ、書き換え後の値が表示されました。今回は Find の実行を省略していますが、先ほどの Find のコードをもう一度実行すると、id = 1 の Name が Taro から Taro Yamada に変わっていることが確認できます。

コードを解説します。

var one User
if err := db.First(&one, 1).Error; err != nil { ... }

one.Name = "Taro Yamada"
if err := db.Save(&one).Error; err != nil { ... }

まず First で id = 1 のレコードを one に取り出し、そのフィールドを書き換えてから db.Save(&one) で永続化します。Save は全カラムをUPDATEするので、フィールド変更を伴わないカラムも一緒に上書きされます。

一部のカラムだけ更新したい場合は Updates を使います。書き方は以下のとおりです。

db.Model(&対象).Updates(モデル名{カラム名: 新しい値})   // 指定カラムだけ UPDATE(ゼロ値のフィールドは除外)

main.go の Save の呼び出しの後ろに、以下を追記します。これは、Name カラムだけを Taro T. に更新する例です。

    if err := db.Model(&one).Updates(User{Name: "Taro T."}).Error; err != nil {
        fmt.Println("Updates失敗:", err)
        return
    }
    fmt.Println("Updates後:", one.Name)

go run main.go コマンドで実行します。以下のような実行結果が表示されます。

更新完了: Taro Yamada
Updates後: Taro T.

Name カラムだけが Taro T. にUPDATEされ、Email は元の値のまま残ります。

db.Model(&one).Updates(User{Name: "Taro T."})

Model(&one) で対象レコードを指定し、Updates(...) に渡した構造体のフィールドだけを更新します。Updates に構造体を渡すと、ゼロ値のフィールドは更新対象から除外されます。空文字で更新したい場合はマップを使うなどの工夫が必要です(詳しくは GORM Update に記載があります)。

5. ユーザの削除(Delete)

db.Delete(&u) でDELETE文を発行します。前章の database/sql では db.Exec("DELETE FROM users WHERE id = ?", 1) と書きましたが、GORMでは対象レコードの構造体を渡すだけで、その ID を主キーとするDELETEを発行してくれます。

gorm.Model が持つ DeletedAt のような「削除日時カラム」がある場合は論理削除になりますが、今回のモデルには入れていないため物理削除になります。書き方は以下のとおりです。

db.Delete(&変数)   // 変数.ID を主キーとして DELETE

main.go を以下のように書き換えます。これは、id = 1 のユーザを取得したうえで削除するコードです。前ステップまでで登録した id = 1 のユーザが残っている前提です。

package main

import (
    "fmt"
    "os"

    "github.com/joho/godotenv"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

type User struct {
    ID    uint   `gorm:"primaryKey"`
    Name  string `gorm:"size:50;not null"`
    Email string `gorm:"size:100;not null;uniqueIndex"`
}

func main() {
    if err := godotenv.Load(); err != nil {
        fmt.Println(".envファイル読み込み失敗:", err)
        return
    }

    dsn := fmt.Sprintf(
        "%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&parseTime=True&loc=Local",
        os.Getenv("MYSQL_USER"),
        os.Getenv("MYSQL_PASSWORD"),
        os.Getenv("MYSQL_HOST"),
        os.Getenv("MYSQL_PORT"),
        os.Getenv("MYSQL_DATABASE"),
    )
    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
    if err != nil {
        fmt.Println("Open失敗:", err)
        return
    }

    var one User
    if err := db.First(&one, 1).Error; err != nil {
        fmt.Println("First失敗:", err)
        return
    }

    if err := db.Delete(&one).Error; err != nil {
        fmt.Println("Delete失敗:", err)
        return
    }
    fmt.Println("削除完了")
}

実行して削除を確認します。

go run main.go

以下のような実行結果が表示されます。

削除完了

one.ID を主キーとするDELETE文が発行され、users テーブルから該当レコードが物理的に削除されました。今回は Find の実行を省略していますが、先ほどの Find のコードをもう一度実行すると、id = 1 のレコードが一覧に表示されなくなっていることが確認できます。

コードを解説します。

var one User
if err := db.First(&one, 1).Error; err != nil { ... }

if err := db.Delete(&one).Error; err != nil { ... }

db.First(&one, 1) で削除対象を取り出したあと、db.Delete(&one) で one.ID の値を主キーとしてレコードを削除します。今回のモデルには論理削除用のフィールドがないため、DB上から物理的に削除されます。