準備と接続

まずは新しいプロジェクトフォルダを用意し、GORM・MySQLドライバ・godotenv を扱える状態を整えます。MySQL側の起動確認と対象データベースの作成を行ってから、GORMからMySQLに接続し、モデル定義とテーブル作成までを行います。

1. プロジェクトの準備

Goでデータベースを扱うにあたって、まずは新しいプロジェクトフォルダを用意し、GORM・MySQLドライバ・godotenv を扱える状態を整えます。

1.1 フォルダの作成

任意の場所に gorm-intro フォルダを作成し、Visual Studio Codeの「ファイル」→「フォルダーを開く」から、作成した gorm-intro フォルダを開きます。続けて、「ターミナル」→「新しいターミナル」からVisual Studio Codeのターミナルを開きます。以降の操作は、このターミナルから行います。

gorm-intro/  ← このフォルダを作成

1.2 Go のインストール確認

以下のコマンドで、Go がインストールされていることを確認します。

go version

以下のように Go のバージョンが表示されれば、インストールは確認できています。

go version go1.x.x darwin/arm64

バージョンが表示されない場合は、Goのインストール を先に実施してください。

1.3 Go モジュールの初期化

作成した gorm-intro フォルダをGoモジュールとして初期化するために、go mod init を実行します。この初期化により、以降のパッケージ導入や依存関係の管理の起点となる go.mod ファイルが作成されます。

go mod init gorm-intro

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

go: creating new go.mod: module gorm-intro

1.4 パッケージの導入

続いて、本章で使うパッケージを導入します。まず下記のコマンドを実行します。

go get gorm.io/gorm

以下のような実行結果が表示されます。GORMが依存関係を持つ複数のパッケージも一緒にダウンロード・追加されます。

go: downloading gorm.io/gorm v1.x.x
go: downloading github.com/jinzhu/now v1.x.x
go: downloading github.com/jinzhu/inflection v1.x.x
go: downloading golang.org/x/text v0.x.x
go: added github.com/jinzhu/inflection v1.x.x
go: added github.com/jinzhu/now v1.x.x
go: added golang.org/x/text v0.x.x
go: added gorm.io/gorm v1.x.x

続いて下記のコマンドを実行します。

go get gorm.io/driver/mysql

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

go: downloading gorm.io/driver/mysql v1.x.x
go: added filippo.io/edwards25519 v1.x.x
go: added github.com/go-sql-driver/mysql v1.x.x
go: added gorm.io/driver/mysql v1.x.x

続いて下記のコマンドを実行します。

go get github.com/joho/godotenv

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

go: downloading github.com/joho/godotenv v1.x.x
go: added github.com/joho/godotenv v1.x.x

3つのパッケージが go.mod に依存関係として追加されました。中身を確認すると、require ディレクティブに導入したパッケージと、その依存関係のあるパッケージが並んでいます。

module gorm-intro

go 1.x

require (
    filippo.io/edwards25519 v1.x.x // indirect
    github.com/go-sql-driver/mysql v1.x.x // indirect
    github.com/jinzhu/inflection v1.x.x // indirect
    github.com/jinzhu/now v1.x.x // indirect
    github.com/joho/godotenv v1.x.x // indirect
    golang.org/x/text v0.x.x // indirect
    gorm.io/driver/mysql v1.x.x // indirect
    gorm.io/gorm v1.x.x // indirect
)

この時点ではまだ main.go を書いていないため、go get で導入したパッケージもコード上で import していない状態です。そのため、すべてのパッケージに // indirect(間接的な依存関係)というマーカーが付いています。次のステップで main.go に import を書くと、直接使うパッケージからは // indirect が外れます。

2. MySQL の起動確認

本章では、GoからMySQLへの接続を試す前に、MySQL自体が起動していて、想定するユーザでログインできることをCLIから確認します。

2.1 MySQL のインストール確認

まずは、MySQLがインストールされていることをバージョン表示で確認します。

mysql --version

以下のようにMySQLのバージョンが表示されれば、インストールは確認できています。

mysql  Ver 8.x.x for macos on arm64 (Homebrew)

バージョンが表示されない場合は、MySQLのインストール を先に実施してください。

2.2 MySQL へのログイン確認

次に、root ユーザでMySQLにログインできることを確認します。

mysql -u root -p

パスワードを求められるので、MySQLインストール時に設定したパスワードを入力します。以下のようにMySQLのプロンプトに切り替われば、ログインは成功しています。

mysql>

ログインできない場合は、MySQLサーバが起動しているか、パスワードが正しいかを確認してください。

3. データベースの作成

ハンズオンで使う gorm_intro データベースを作成します。GORMは既存のデータベースへ接続してその中のテーブル操作を担うライブラリで、データベースそのものの作成(CREATE DATABASE)はカバーしていません。そのため、この段階だけはMySQL CLIから直接SQLを発行します。GORMではなく素のSQLで作りたい場合は、前章で扱った database/sql の db.Exec("CREATE DATABASE ...") でも同じことができます。

先ほどログインしたMySQLのプロンプトで、以下のSQLを実行します。

CREATE DATABASE gorm_intro;

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

Query OK, 1 row affected (0.01 sec)

続いて、gorm_intro データベースが作成されたことを SHOW DATABASES で確認します。

SHOW DATABASES;

以下のように、gorm_intro が一覧に含まれていれば作成できています。

+--------------------+
| Database           |
+--------------------+
| information_schema |
| gorm_intro         |
| mysql              |
| performance_schema |
| sys                |
+--------------------+

以降のハンズオンではこのデータベースにテーブルを追加していきます。作成が確認できたら、exit; でMySQLのプロンプトを抜けます。

exit;

4. GORM への接続

データベースの用意ができたので、GORMからそのデータベースに接続できることを確認します。まず接続情報をまとめた .env ファイルを用意し、そのうえで最小限のコードで接続を試します。

4.1 .env ファイルの作成

Goのコード内にパスワードを直接書くと、コードを変更するたびに書き換える必要があり、うっかりGitに含めてしまうリスクもあります。ここでは、接続情報を .env ファイルにまとめて、Goのコードからは環境変数として読み込む形にします。

Visual Studio Codeのエクスプローラーで gorm-intro フォルダを右クリックし、「新しいファイル」を選択して .env という名前のファイルを作成します。

gorm-intro/
├── .env  ← このファイルを作成
├── go.mod
└── go.sum

作成したファイルに以下の内容を記述して保存します。MYSQL_PASSWORD の値は、先ほど mysql -u root -p で入力した自分のMySQLパスワードに書き換えてください。

MYSQL_USER=root
MYSQL_PASSWORD=あなたのパスワード
MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306
MYSQL_DATABASE=gorm_intro

.env は KEY=VALUE の形式で1行1変数を書くシンプルなテキストファイルです。以降の main.go では、先ほど導入した godotenv パッケージがこの内容を読み込み、Goから環境変数として取り出せるようになります。

4.2 main.go の作成

Visual Studio Codeのエクスプローラーで gorm-intro フォルダを右クリックし、「新しいファイル」を選択して main.go という名前で作成します。

gorm-intro/
├── .env
├── go.mod
├── go.sum
└── main.go  ← このファイルを作成

書き方は以下のとおりです。gorm.Open にドライバ設定と DSN を渡すと *gorm.DB が返ります。以降のGORM操作はすべてこの *gorm.DB に対して行います。

db, err := gorm.Open(mysql.Open(DSN), &gorm.Config{})   // GORM で接続を開く

作成したファイルに以下の内容を記述して保存します。これは、.env から接続情報を読み込み、GORMでMySQLに接続を試み、成功したら 接続成功 と表示するだけの最小コードです。

package main

import (
    "fmt"
    "os"

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

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
    }

    sqlDB, err := db.DB()
    if err != nil {
        fmt.Println("DB取得失敗:", err)
        return
    }
    if err := sqlDB.Ping(); err != nil {
        fmt.Println("Ping失敗:", err)
        return
    }
    fmt.Println("接続成功")
}

コードを解説します。

import (
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

gorm.io/gorm はGORM本体、gorm.io/driver/mysql はGORMからMySQLに接続するためのドライバです。GORMは複数のRDBに対応しており、使用するデータベースごとに専用のドライバをインポートします。今回はMySQLに接続するため、この2つをセットで読み込みます。

db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})

gorm.Open はドライバ設定とDSNを受け取り、*gorm.DB を返します。以降のCRUD操作はすべてこの db に対して行います。第2引数の &gorm.Config{} にはロガーやマイグレーション時のオプションを渡せますが、ここではデフォルトのままにしています。

sqlDB, err := db.DB()

db.DB() は、GORMの *gorm.DB が内部に保持している database/sql の *sql.DB を取り出すメソッドです。GORMは接続管理を *sql.DB に委ねているため、標準ライブラリの機能を使いたいときはこの *sql.DB 経由で操作します。

if err := sqlDB.Ping(); err != nil {
    ...
}

Ping() は、実際にデータベースへ到達できるかを確認するメソッドです。ここで接続確認をしておくことで、後続の処理に進む前に接続エラーを検知できます。

実行して接続を確認します。

go run main.go

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

接続成功

「接続成功」と表示されれば、GoからMySQLに接続できています。エラーが表示される場合は、以下のトラブルシューティングを確認してください。

⚠️ 「Ping失敗: Error 1045 (28000): Access denied for user 'root'@...」というエラーが出る場合
.env の MYSQL_PASSWORD が実際のMySQLパスワードと一致していない可能性が高いです。.env を、先ほど mysql -u root -p でログインできたパスワードに書き換えてから、再度 go run main.go を実行してください。
⚠️ 「dial tcp 127.0.0.1:3306: connect: connection refused」というエラーが出る場合
MySQLサーバが起動していない、または3306以外のポートで動作している可能性があります。まず mysql -u root -p でCLIからログインできるかを確認し、ログインできない場合はMySQLサーバを起動してください。ポートを変更している場合は、.env の MYSQL_HOST と MYSQL_PORT を実際の値に書き換えます。
⚠️ 「Error 1049 (42000): Unknown database 'gorm_intro'」というエラーが出る場合
.env の MYSQL_DATABASE で指定したデータベースが存在しません。先ほどの「データベースの作成」でMySQL CLIから CREATE DATABASE gorm_intro; を実行したかを確認してください。

5. モデル定義とテーブル作成

接続確認ができたので、テーブルの1行分を表す構造体(モデル)を定義し、AutoMigrate でその構造体からテーブルを自動作成します。前章では CREATE TABLE users (...) のSQLを自分で書きましたが、GORMではモデル定義に沿ってGORM側がSQLを組み立ててくれます。

5.1 モデル定義とマイグレーションの実行

書き方は以下のとおりです。モデルのフィールドにタグ `gorm:"..."` で GORM 向けの追加情報を、AutoMigrate の引数にモデルのポインタを渡してテーブル作成を指示します。

type モデル名 struct {
    ID       uint   `gorm:"primaryKey"`
    カラム名 型    `gorm:"size:50;not null;uniqueIndex"`
}

db.AutoMigrate(&モデル名{})   // モデル定義からテーブルを自動作成

main.go を以下のように書き換えます。これは、User モデルを定義し、GORMで users テーブルを自動作成するコードです。

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
    }

    if err := db.AutoMigrate(&User{}); err != nil {
        fmt.Println("マイグレーション失敗:", err)
        return
    }

    fmt.Println("マイグレーション完了")
}

実行してテーブル作成を確認します。

go run main.go

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

マイグレーション完了

コードを解説します。

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

タグ `gorm:"..."` で、GORMに対する追加情報を指定します。primaryKey は主キー、size:50 は VARCHAR(50)、not null は NOT NULL 制約、uniqueIndex は一意インデックスです。GORMは自動的に構造体名 User を複数形の users テーブルにマッピングします。

if err := db.AutoMigrate(&User{}); err != nil {
    ...
}

AutoMigrate は、モデルの定義から CREATE TABLE 相当のSQLを自動生成し、テーブルがなければ作ります。既にある場合は、必要なカラムを追加します(削除はしません)。

5.2 作成されたテーブルの確認

Goのコードから作られたテーブルが実際にMySQLに存在することを、MySQL CLIから確認します。まず root ユーザでログインします。

mysql -u root -p

ログイン後、gorm_intro データベースを使用します。

USE gorm_intro;

続いて、テーブル一覧を表示します。

SHOW TABLES;

以下のように、users テーブルが一覧に表示されます。

+----------------------+
| Tables_in_gorm_intro |
+----------------------+
| users                |
+----------------------+

続いて、users テーブルの構造を確認します。

DESCRIBE users;

以下のように、モデル定義で指定したフィールドがそのままカラムとして作られています。id は主キーで自動採番、name は VARCHAR(50) の NOT NULL、email は VARCHAR(100) の NOT NULL に加えて一意インデックス(UNI)として反映されています。

+-------+-----------------+------+-----+---------+----------------+
| Field | Type            | Null | Key | Default | Extra          |
+-------+-----------------+------+-----+---------+----------------+
| id    | bigint unsigned | NO   | PRI | NULL    | auto_increment |
| name  | varchar(50)     | NO   |     | NULL    |                |
| email | varchar(100)    | NO   | UNI | NULL    |                |
+-------+-----------------+------+-----+---------+----------------+

Goで書いた User 構造体の定義が、MySQL側のテーブル構造にそのまま反映されていることが確認できました。確認できたら、exit; でMySQLのプロンプトを抜けます。

exit;