Go-MySQL-Driver を使用して TiDB に接続する
TiDB は MySQL 互換データベースであり、 Go-MySQL-ドライバーはデータベース/SQLインターフェイスの MySQL 実装です。
このチュートリアルでは、TiDB と Go-MySQL-Driver を使用して次のタスクを実行する方法を学習できます。
- 環境をセットアップします。
- Go-MySQL-Driver を使用して TiDB クラスターに接続します。
- アプリケーションをビルドして実行します。オプションで、基本的な CRUD 操作のサンプルコードスニペットを見つけることができます。
注記:
このチュートリアルは、TiDB サーバーレス、TiDB 専用、および TiDB セルフホストで動作します。
前提条件
このチュートリアルを完了するには、次のものが必要です。
TiDB クラスターがない場合は、次のように作成できます。
- (推奨) TiDB サーバーレスクラスターの作成に従って、独自のTiDB Cloudクラスターを作成します。
- ローカル テスト TiDB クラスターをデプロイまたは本番TiDB クラスターをデプロイに従ってローカル クラスターを作成します。
サンプル アプリを実行して TiDB に接続する
このセクションでは、サンプル アプリケーション コードを実行して TiDB に接続する方法を説明します。
ステップ 1: サンプル アプリ リポジトリのクローンを作成する
ターミナル ウィンドウで次のコマンドを実行して、サンプル コード リポジトリのクローンを作成します。
git clone https://github.com/tidb-samples/tidb-golang-sql-driver-quickstart.git
cd tidb-golang-sql-driver-quickstart
ステップ 2: 接続情報を構成する
選択した TiDB デプロイメント オプションに応じて、TiDB クラスターに接続します。
- TiDB Serverless
- TiDB Dedicated
- TiDB Self-Hosted
クラスターページに移動し、ターゲット クラスターの名前をクリックして、その概要ページに移動します。
右上隅にある「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログの設定が動作環境と一致していることを確認してください。
エンドポイント タイプは
Public
に設定されますブランチは
main
に設定されています[接続先] は
General
に設定されていますオペレーティング システムが環境に一致します。
ヒント:
プログラムが Windows Subsystem for Linux (WSL) で実行されている場合は、対応する Linux ディストリビューションに切り替えます。
「パスワードの生成」をクリックして、ランダムなパスワードを作成します。
ヒント:
以前にパスワードを作成したことがある場合は、元のパスワードを使用するか、 「パスワードのリセット」をクリックして新しいパスワードを生成できます。
次のコマンドを実行して
.env.example
をコピーし、名前を.env
に変更します。cp .env.example .env対応する接続文字列をコピーして
.env
ファイルに貼り付けます。結果の例は次のとおりです。TIDB_HOST='{host}' # e.g. gateway01.ap-northeast-1.prod.aws.tidbcloud.com TIDB_PORT='4000' TIDB_USER='{user}' # e.g. xxxxxx.root TIDB_PASSWORD='{password}' TIDB_DB_NAME='test' USE_SSL='true'プレースホルダー
{}
、接続ダイアログから取得した接続パラメーターに必ず置き換えてください。TiDB サーバーレスには安全な接続が必要です。したがって、
USE_SSL
~true
の値を設定する必要があります。.env
ファイルを保存します。
クラスターページに移動し、ターゲット クラスターの名前をクリックして、その概要ページに移動します。
右上隅にある「接続」をクリックします。接続ダイアログが表示されます。
「どこからでもアクセスを許可」をクリックし、 「TiDB クラスター CA のダウンロード」をクリックして CA 証明書をダウンロードします。
接続文字列の取得方法の詳細については、 TiDB専用標準接続を参照してください。
次のコマンドを実行して
.env.example
をコピーし、名前を.env
に変更します。cp .env.example .env対応する接続文字列をコピーして
.env
ファイルに貼り付けます。結果の例は次のとおりです。TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com TIDB_PORT='4000' TIDB_USER='{user}' # e.g. root TIDB_PASSWORD='{password}' TIDB_DB_NAME='test' USE_SSL='false'プレースホルダー
{}
、接続ダイアログから取得した接続パラメーターに必ず置き換えてください。.env
ファイルを保存します。
次のコマンドを実行して
.env.example
をコピーし、名前を.env
に変更します。cp .env.example .env対応する接続文字列をコピーして
.env
ファイルに貼り付けます。結果の例は次のとおりです。TIDB_HOST='{host}' TIDB_PORT='4000' TIDB_USER='root' TIDB_PASSWORD='{password}' TIDB_DB_NAME='test' USE_SSL='false'必ずプレースホルダー
{}
接続パラメーターに置き換えて、USE_SSL
をfalse
に設定してください。 TiDB をローカルで実行している場合、デフォルトのホスト アドレスは127.0.0.1
で、パスワードは空です。.env
ファイルを保存します。
ステップ 3: コードを実行して結果を確認する
次のコマンドを実行してサンプル コードを実行します。
make予想される出力.txtチェックして、出力が一致するかどうかを確認します。
サンプルコードスニペット
次のサンプル コード スニペットを参照して、独自のアプリケーション開発を完了できます。
完全なサンプル コードとその実行方法については、 tidb-samples/tidb-golang-sql-driver-quickstartリポジトリを確認してください。
TiDB に接続する
func openDB(driverName string, runnable func(db *sql.DB)) {
dsn := fmt.Sprintf("%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&tls=%s",
${tidb_user}, ${tidb_password}, ${tidb_host}, ${tidb_port}, ${tidb_db_name}, ${use_ssl})
db, err := sql.Open(driverName, dsn)
if err != nil {
panic(err)
}
defer db.Close()
runnable(db)
}
この関数を使用する場合、 ${tidb_host}
、 ${tidb_port}
、 ${tidb_user}
、 ${tidb_password}
、および${tidb_db_name}
を TiDB クラスターの実際の値に置き換える必要があります。 TiDB サーバーレスには安全な接続が必要です。したがって、 ${use_ssl}
の値をtrue
に設定する必要があります。
データの挿入
openDB("mysql", func(db *sql.DB) {
insertSQL = "INSERT INTO player (id, coins, goods) VALUES (?, ?, ?)"
_, err := db.Exec(insertSQL, "id", 1, 1)
if err != nil {
panic(err)
}
})
詳細については、 データの挿入を参照してください。
クエリデータ
openDB("mysql", func(db *sql.DB) {
selectSQL = "SELECT id, coins, goods FROM player WHERE id = ?"
rows, err := db.Query(selectSQL, "id")
if err != nil {
panic(err)
}
// This line is extremely important!
defer rows.Close()
id, coins, goods := "", 0, 0
if rows.Next() {
err = rows.Scan(&id, &coins, &goods)
if err == nil {
fmt.Printf("player id: %s, coins: %d, goods: %d\n", id, coins, goods)
}
}
})
詳細については、 クエリデータを参照してください。
データを更新する
openDB("mysql", func(db *sql.DB) {
updateSQL = "UPDATE player set goods = goods + ?, coins = coins + ? WHERE id = ?"
_, err := db.Exec(updateSQL, 1, -1, "id")
if err != nil {
panic(err)
}
})
詳細については、 データを更新するを参照してください。
データの削除
openDB("mysql", func(db *sql.DB) {
deleteSQL = "DELETE FROM player WHERE id=?"
_, err := db.Exec(deleteSQL, "id")
if err != nil {
panic(err)
}
})
詳細については、 データの削除を参照してください。
便利なメモ
ドライバーまたは ORM フレームワークを使用していますか?
Golangドライバーはデータベースへの低レベルのアクセスを提供しますが、開発者は次のことを行う必要があります。
- データベース接続を手動で確立および解放します。
- データベーストランザクションを手動で管理します。
- データ行をデータ オブジェクトに手動でマップします。
複雑な SQL ステートメントを作成する必要がない限り、開発にはORMフレームワーク ( ゴームなど) を使用することをお勧めします。それはあなたに役立ちます:
- 接続とトランザクションの管理のために定型コードを減らします。
- 多数の SQL ステートメントの代わりにデータ オブジェクトを使用してデータを操作します。
次のステップ
- Go-MySQL-Driver の使用法についてはGo-MySQL-Driver のドキュメントからご覧ください。
- TiDB アプリケーション開発単一テーブルの読み取りベスト プラクティスについて取引 、 開発者ガイドの章 ( データの挿入など) データを更新する参照データの削除 SQLパフォーマンスの最適化ください。
- プロフェッショナルとしてTiDB 開発者コースを学び、試験合格後にTiDB 認定獲得します。
助けが必要?
不和またはサポートチケットを作成するについて質問してください。