準備と接続
まずは新しいプロジェクトフォルダを用意し、database/sql とMySQLドライバを扱える状態を整えます。MySQL側の起動確認をしたうえで、Goから接続し、対象のデータベースとテーブルまで作成します。
1. プロジェクトの準備
Goでデータベースを扱うにあたって、まずは新しいプロジェクトフォルダを用意し、database/sql とMySQLドライバを扱える状態を整えます。
1.1 フォルダの作成
任意の場所に godb フォルダを作成し、Visual Studio Codeの「ファイル」→「フォルダーを開く」から、作成した godb フォルダを開きます。続けて、「ターミナル」→「新しいターミナル」からVisual Studio Codeのターミナルを開きます。以降の操作は、このターミナルから行います。
godb/ ← このフォルダを作成
1.2 Go のインストール確認
以下のコマンドで、Go がインストールされていることを確認します。
go version
以下のように Go のバージョンが表示されれば、インストールは確認できています。
go version go1.x.x darwin/arm64
バージョンが表示されない場合は、Goのインストール を先に実施してください。
1.3 Go モジュールの初期化
作成した godb フォルダをGoモジュールとして初期化するために、go mod init を実行します。この初期化により、以降のパッケージ導入や依存関係の管理の起点となる go.mod ファイルが作成されます。
go mod init godb
以下のような実行結果が表示されます。
go: creating new go.mod: module godb
godb フォルダに go.mod が新しく作られました。中身を確認すると、モジュール名とGoのバージョンだけが書かれたシンプルな内容になっています。
module godb
go 1.x
1.4 パッケージの導入
続いて、本章で使うパッケージを導入します。まず下記のコマンドを実行します。
go get github.com/go-sql-driver/mysql
以下のような実行結果が表示されます。依存関係のあるパッケージも一緒にダウンロード・追加されます。
go: downloading github.com/go-sql-driver/mysql v1.x.x
go: downloading filippo.io/edwards25519 v1.x.x
go: added filippo.io/edwards25519 v1.x.x
go: added github.com/go-sql-driver/mysql v1.x.x
続いて下記のコマンドを実行します。.env ファイルの書式と godotenv の基本的な使い方は「Go標準ライブラリ」の .env ファイルからの環境変数の読み込みに記載があります。
go get github.com/joho/godotenv
以下のような実行結果が表示されます。
go: downloading github.com/joho/godotenv v1.x.x
go: added github.com/joho/godotenv v1.x.x
MySQL ドライバと godotenv がバージョン付きで go.mod に追加されたことが分かります。go.mod の中身を確認すると、require ディレクティブに導入したパッケージと、その依存関係のあるパッケージが並んでいます。
module godb
go 1.x
require (
filippo.io/edwards25519 v1.x.x // indirect
github.com/go-sql-driver/mysql v1.x.x // indirect
github.com/joho/godotenv v1.x.x // indirect
)
この時点ではまだ main.go を書いていないため、go get で導入したパッケージもコード上で import していない状態です。そのため、すべてのパッケージに // indirect(間接的な依存関係)というマーカーが付いています。// indirect は「自分のコードから直接は import していないが、依存先のパッケージが利用しているため間接的に必要」という意味のマーカーで、次のステップで main.go に import を書くと、直接使うパッケージからは外れます。
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サーバが起動しているか、パスワードが正しいかを確認してください。
以降のハンズオンでは、この root ユーザとパスワードを、Goのコードから .env ファイル経由で読み込む形で接続します。ログイン確認ができたら、exit; でMySQLのプロンプトを抜けます。
exit;
3. MySQL への接続
プロジェクトの準備でドライバの導入まで済みましたが、この時点ではまだGoからMySQLに接続できるかは確認できていません。まずは接続情報をまとめた .env ファイルを用意し、そのうえで最小限のコードで接続を試して、MySQLに到達できることを確かめます。
3.1 .env ファイルの作成
MySQL への接続情報を .env ファイルにまとめ、Go のコードからは godotenv 経由で環境変数として読み込みます。
Visual Studio Codeのエクスプローラーで godb フォルダを右クリックし、「新しいファイル」を選択して .env という名前のファイルを作成します。
godb/
├── .env ← このファイルを作成
├── go.mod
└── go.sum
作成したファイルに以下の内容を記述して保存します。各項目の意味は下記のとおりです。
| 変数名 | 説明 |
|---|---|
MYSQL_USER |
接続先MySQLのユーザ名を指定する。ここでは root を使う |
MYSQL_PASSWORD |
上記ユーザのパスワードを指定する。先ほど mysql -u root -p で入力した自分のMySQLパスワードに書き換える |
MYSQL_HOST |
接続先MySQLのホスト名またはIPアドレスを指定する。ローカルで動作しているMySQLに接続するため 127.0.0.1 を使う |
MYSQL_PORT |
接続先MySQLの待ち受けポートを指定する。MySQLのデフォルトである 3306 を使う |
MYSQL_DATABASE |
接続先のデータベース名を指定する。まだ作成していないが、後続のステップで使うためこの時点で書いておく |
MYSQL_USER=root
MYSQL_PASSWORD=あなたのパスワード
MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306
MYSQL_DATABASE=godb_test
3.2 main.go の作成
Visual Studio Codeのエクスプローラーで godb フォルダを右クリックし、「新しいファイル」を選択して main.go という名前で作成してください。
godb/
├── .env
├── go.mod
├── go.sum
└── main.go ← このファイルを作成
書き方は以下のとおりです。sql.Open に DSN を渡すと接続オブジェクト(*sql.DB)が返りますが、この時点ではまだ実際の接続は行われません。続けて db.Ping() を呼ぶことで、DSN が指す MySQL に実際に到達できるかを確認します。
db, err := sql.Open("mysql", DSN) // DSN から接続オブジェクトを作る(この時点では未接続)
defer db.Close()
if err := db.Ping(); err != nil { // 実際に接続を試す
// 接続エラーの処理
}
作成したファイルに以下の内容を記述して保存します。これは、.env から接続情報を読み込み、MySQLに接続を試み、成功したら 接続成功 と表示するだけの最小コードです。
package main
import (
"database/sql"
"fmt"
"os"
_ "github.com/go-sql-driver/mysql"
"github.com/joho/godotenv"
)
func main() {
if err := godotenv.Load(); err != nil {
fmt.Println(".envファイル読み込み失敗:", err)
return
}
dsn := fmt.Sprintf(
"%s:%s@tcp(%s:%s)/?parseTime=true",
os.Getenv("MYSQL_USER"),
os.Getenv("MYSQL_PASSWORD"),
os.Getenv("MYSQL_HOST"),
os.Getenv("MYSQL_PORT"),
)
db, err := sql.Open("mysql", dsn)
if err != nil {
fmt.Println("Open失敗:", err)
return
}
defer db.Close()
if err := db.Ping(); err != nil {
fmt.Println("Ping失敗:", err)
return
}
fmt.Println("接続成功")
}
コードを解説します。
_ "github.com/go-sql-driver/mysql"
import のアンダースコアは副作用のためだけの import を意味します。ドライバの init() 関数が呼ばれ、database/sql に MySQL ドライバが登録されます。パッケージ内の関数を直接呼ばないので、_ で受けます。
if err := godotenv.Load(); err != nil {
...
}
godotenv.Load() で、カレントディレクトリの .env を読み込んで環境変数として登録し、以降の os.Getenv("MYSQL_USER") で各値を取り出せるようにしています。詳しい仕組みは「Go標準ライブラリ」の .env ファイルからの環境変数の読み込みに記載があります。
dsn := fmt.Sprintf(
"%s:%s@tcp(%s:%s)/?parseTime=true",
os.Getenv("MYSQL_USER"),
os.Getenv("MYSQL_PASSWORD"),
os.Getenv("MYSQL_HOST"),
os.Getenv("MYSQL_PORT"),
)
DSN(Data Source Name)は接続文字列です。書式は ユーザ名:パスワード@tcp(ホスト:ポート)/データベース名?パラメータ で、fmt.Sprintf で .env から読み込んだ値を組み立てています。まだデータベースを作っていないので、データベース名は空にしてあります。parseTime=true は MySQL の DATETIME を Go の time.Time として読み込む指定です。
db, err := sql.Open("mysql", dsn)
sql.Open はドライバ名とDSNを受け取り、*sql.DB を返します。この時点ではまだ実際の接続は行われません。
if err := db.Ping(); err != nil {
...
}
db.Ping() が実際に接続を試みる関数です。ここでエラーが返れば、接続情報が誤っている・MySQL が起動していない・認証に失敗した、などが考えられます。
実行して接続を確認します。
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 を実行してください。 |
| ⚠️ 「Ping失敗: dial tcp 127.0.0.1:3306: connect: connection refused」というエラーが出る場合 |
|---|
MySQLサーバが起動していない、または3306以外のポートで動作している可能性があります。まず mysql -u root -p でCLIからログインできるかを確認し、ログインできない場合はMySQLサーバを起動してください。ポートを変更している場合は、.env の MYSQL_HOST と MYSQL_PORT を実際の値に書き換えます。 |
| ⚠️ 「no required module provides package github.com/joho/godotenv」というエラーが出る場合 |
|---|
godotenv パッケージが go.mod に登録されていない状態で go run main.go を実行するとこのエラーが出ます。プロジェクトの準備で紹介した go get github.com/joho/godotenv を実行してから、もう一度 go run main.go を試してください。github.com/go-sql-driver/mysql について同じメッセージが出た場合も、同じ手順で go get github.com/go-sql-driver/mysql を実行します。 |
4. データベースとテーブルの作成
MySQLへ接続できることは確認できましたが、CRUD操作を行う受け皿となるデータベースとテーブルはまだ存在しません。ここでは、これから使う godb_test データベースと users テーブルを、GoからSQLを発行して作成します。
godb_test データベースと users テーブルの作成
Go からは database/sql の Exec メソッドを使って SQL を実行できます。CREATE DATABASE や CREATE TABLE などのSQL構文自体については SQL基本文法 に記載があります。
書き方は以下のとおりです。db.Exec は結果セットを返さないSQL(DDL / INSERT / UPDATE / DELETE)を実行するメソッドで、戻り値は sql.Result と error です。ここではDDLで戻り値の中身は使わないため、_ で捨てます。
_, err := db.Exec("SQL文字列") // 結果セットを返さないSQLを実行する
main.go を以下のように書き換えて、データベースとテーブルを作成します。これは、godb_test データベースを作り、その中に users テーブルを作成するコードです。
package main
import (
"database/sql"
"fmt"
"os"
_ "github.com/go-sql-driver/mysql"
"github.com/joho/godotenv"
)
func main() {
if err := godotenv.Load(); err != nil {
fmt.Println(".envファイル読み込み失敗:", err)
return
}
dsn := fmt.Sprintf(
"%s:%s@tcp(%s:%s)/?parseTime=true",
os.Getenv("MYSQL_USER"),
os.Getenv("MYSQL_PASSWORD"),
os.Getenv("MYSQL_HOST"),
os.Getenv("MYSQL_PORT"),
)
db, err := sql.Open("mysql", dsn)
if err != nil {
fmt.Println("Open失敗:", err)
return
}
defer db.Close()
if _, err := db.Exec("CREATE DATABASE IF NOT EXISTS godb_test"); err != nil {
fmt.Println("DB作成失敗:", err)
return
}
if _, err := db.Exec("USE godb_test"); err != nil {
fmt.Println("USE失敗:", err)
return
}
createTable := `
CREATE TABLE IF NOT EXISTS users (
id INT AUTO_INCREMENT PRIMARY KEY,
name VARCHAR(50) NOT NULL,
email VARCHAR(100) NOT NULL UNIQUE,
created_at DATETIME DEFAULT CURRENT_TIMESTAMP
)`
if _, err := db.Exec(createTable); err != nil {
fmt.Println("テーブル作成失敗:", err)
return
}
fmt.Println("DBとテーブルを準備しました")
}
コードを解説します。
if _, err := db.Exec("CREATE DATABASE IF NOT EXISTS godb_test"); err != nil {
db.Exec は結果セットを返さないSQL(INSERT / UPDATE / DELETE / DDL)に使うメソッドです。戻り値は sql.Result と error です。ここでは Result は不要なので _ で捨てています。CREATE DATABASE IF NOT EXISTS で、まだ存在しない場合のみデータベースを作ります。
createTable := `
CREATE TABLE IF NOT EXISTS users (
id INT AUTO_INCREMENT PRIMARY KEY,
name VARCHAR(50) NOT NULL,
email VARCHAR(100) NOT NULL UNIQUE,
created_at DATETIME DEFAULT CURRENT_TIMESTAMP
)`
複数行にわたる SQL はバッククォート ` で囲むと改行込みで書けます。id を主キーの自動採番、email を一意制約、created_at を作成時刻の自動設定として定義しています。
実行して、想定通りにセットアップされることを確認します。
go run main.go
以下のような実行結果が表示されます。
DBとテーブルを準備しました
期待通り、DB とテーブルの作成が完了しました。以降のコードでは、DSN のデータベース名の部分に .env の MYSQL_DATABASE(godb_test)を差し込む形にします。