データベースドライバの特定とインポート
使用しているDBMSをサポートするデータベースドライバが必要です。データベース用のドライバを特定するには、SQLDriversを参照してください。
ドライバをコードで使用可能にするには、他のGoパッケージと同様にインポートします。以下はその例です:
import "github.com/go-sql-driver/mysql"
ドライバパッケージから直接関数を呼び出さない場合(例えば、sql
パッケージによって暗黙的に使用される場合など)、アンダースコアでインポートパスを接頭辞付けする空のインポートを使用する必要があります:
import _ "github.com/go-sql-driver/mysql"
注意: ベストプラクティスとして、データベース操作にデータベースドライバのAPIを使用することは避けてください。代わりに、database/sql
パッケージの関数を使用してください。これにより、コードがDBMSと緩やかに結合され、必要に応じて異なるDBMSに切り替えやすくなります。
データベースハンドルのオープン
データベースハンドルは、接続文字列を受け取る`````sql.Open`````または`````sql.OpenDB`````を呼び出すことで取得できます。どちらも[`````sql.DB`````](https://pkg.go.dev/database/sql#DB)へのポインタを返します。
**注意:** データベースの資格情報をGoソースから外に出しておくことを確認してください。詳細については、[データベース資格情報の保存](#store_credentials)を参照してください。
<a name="open_connection_string"></a>
#### 接続文字列を使用したオープン
接続文字列を使用して接続したい場合は、[`````sql.Open`````関数](https://pkg.go.dev/database/sql#Open)を使用します。文字列の形式は、使用しているドライバによって異なります。
MySQLの例を以下に示します:
``````bash
db, err = sql.Open("mysql", "username:password@tcp(127.0.0.1:3306)/jazzrecords")
if err != nil {
log.Fatal(err)
}
`
ただし、接続プロパティをより構造化された方法でキャプチャすることで、より読みやすいコードが得られることが多いです。詳細はドライバによって異なります。
例えば、前述の例を以下のように置き換えることができ、MySQLドライバのConfig
を使用してプロパティを指定し、FormatDSN method
を使用して接続文字列を構築します。
// Specify connection properties.
cfg := mysql.Config{
User: username,
Passwd: password,
Net: "tcp",
Addr: "127.0.0.1:3306",
DBName: "jazzrecords",
}
// Get a database handle.
db, err = sql.Open("mysql", cfg.FormatDSN())
if err != nil {
log.Fatal(err)
}
コネクタを使用したオープン
接続文字列では利用できないドライバ固有の接続機能を活用したい場合は、sql.OpenDB function
を使用します。各ドライバは独自の接続プロパティのセットをサポートし、DBMSに特有の接続要求をカスタマイズする方法を提供することがよくあります。
前述のsql.Open
の例をsql.OpenDB
を使用するように適応させると、以下のようなコードでハンドルを作成できます:
// Specify connection properties.
cfg := mysql.Config{
User: username,
Passwd: password,
Net: "tcp",
Addr: "127.0.0.1:3306",
DBName: "jazzrecords",
}
// Get a driver-specific connector.
connector, err := mysql.NewConnector(&cfg)
if err != nil {
log.Fatal(err)
}
// Get a database handle.
db = sql.OpenDB(connector)
エラーの処理
ハンドルを作成しようとした際にエラーをチェックする必要があります。sql.Open
のように。これは接続エラーではありません。代わりに、sql.Open
がハンドルを初期化できなかった場合にエラーが発生します。これは、指定したDSNを解析できない場合などに発生する可能性があります。
接続の確認
データベースハンドルをオープンすると、sql
パッケージはすぐに新しいデータベース接続を作成しない場合があります。代わりに、コードが必要とする時に接続を作成することがあります。すぐにデータベースを使用しない場合は、接続が確立できることを確認するために、Ping
またはPingContext
を呼び出してください。
以下の例のコードは、接続を確認するためにデータベースにpingを送信します。
db, err = sql.Open("mysql", connString)
// Confirm a successful connection.
if err := db.Ping(); err != nil {
log.Fatal(err)
}
データベース資格情報の保存
データベース資格情報をGoソースに保存することは避けてください。これにより、データベースの内容が他者に露出する可能性があります。代わりに、コードの外部に保存する方法を見つけてください。ただし、コードがDBMSと認証するための資格情報を取得できるようにします。
一般的なアプローチの1つは、プログラムが開始する前に環境にシークレットを保存することです。おそらくシークレットマネージャーから読み込まれ、その後、Goプログラムはos.Getenv
を使用してそれらを読み取ることができます:
username := os.Getenv("DB_USER")
password := os.Getenv("DB_PASS")
このアプローチにより、ローカルテストのために自分で環境変数を設定することもできます。
リソースの解放
通常、リソースは、`````Close`````関数への呼び出しを遅延させることで閉じられ、リソースは囲む関数が終了する前に解放されます。
以下の例のコードは、[`````sql.Rows`````](https://pkg.go.dev/database/sql#Rows)によって保持されているリソースを解放するために`````Close`````を遅延させます。
``````bash
rows, err := db.Query("SELECT * FROM album WHERE artist = ?", artist)
if err != nil {
log.Fatal(err)
}
defer rows.Close()
// Loop through returned rows.
`