Goのsql.Openは必ずしも接続を確立しない

タイトルのとおり、sql.Openは必ずしも接続を確立しないようです。

https://pkg.go.dev/database/sql#Open

Open may just validate its arguments without creating a connection to the database. To verify that the data source name is valid, call DB.Ping.

DeepL翻訳

Openは、データベースへの接続を作成せずに引数を検証するだけかもしれません。データ・ソース名が有効かどうかを確認するには、DB.Ping を呼び出します。

なので、DBの接続を確実にチェックしたいなら、Ping()を使います。

ヘルスチェックするときにも使えそう。

package main

import (
	"database/sql"
	"fmt"
	"os"

	_ "github.com/go-sql-driver/mysql"
)

var (
	dbUser     = os.Getenv("DB_USER")
	dbPassword = os.Getenv("DB_PASSWORD")
	dbDatabase = os.Getenv("DB_NAME")
	dbConn     = fmt.Sprintf("%s:%s@tcp(127.0.0.1:3306)/%s?parseTime=true", dbUser, dbPassword, dbDatabase)
)

func main() {
	db, err := sql.Open("mysql", dbConn)
	if err != nil {
		fmt.Println("fail to connect DB")
		return
	}

	if err := db.Ping(); err != nil {
		fmt.Println("fail to ping DB")
		return
	}
}

参考図書