Go-MySQL-Driver で TiDB に接続する
TiDB は MySQL 互換データベースであり、 Go-MySQL-ドライバー データベース/SQLインターフェイス用の MySQL 実装です。
このチュートリアルでは、TiDB と Go-MySQL-Driver を使用して次のタスクを実行する方法を学習します。
- 環境を設定します。
- Go-MySQL-Driver を使用して TiDB クラスターに接続します。
- アプリケーションをビルドして実行します。オプションで、基本的な CRUD 操作用のサンプルコードスニペットを見つけることができます。
注記:
このチュートリアルは、 TiDB Cloud Serverless、 TiDB Cloud Dedicated、および TiDB Self-Managed で機能します。
前提条件
このチュートリアルを完了するには、次のものが必要です。
TiDB クラスターがない場合は、次のように作成できます。
- (推奨) TiDB Cloud Serverless クラスターの作成に従って、独自の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 Cloud Serverless
- TiDB Cloud Dedicated
- TiDB Self-Managed
クラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログの構成が動作環境と一致していることを確認します。
接続タイプは
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 Cloud Serverless では安全な接続が必要です。そのため、
USE_SSL
の値をtrue
に設定する必要があります。.env
ファイルを保存します。
クラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログで、 [接続タイプ]ドロップダウン リストから[パブリック]を選択し、 [CA 証明書]をクリックして CA 証明書をダウンロードします。
IP アクセス リストを設定していない場合は、 「IP アクセス リストの設定」をクリックするか、手順IPアクセスリストを構成するに従って最初の接続の前に設定してください。
TiDB Dedicated は、パブリック接続タイプに加えて、プライベートエンドポイントとVPC ピアリング接続タイプもサポートしています。詳細については、 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 サンプル/tidb-golang-sql-driver クイックスタートリポジトリを参照してください。
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 TiDB Cloud Serverless では安全な接続が必要です。したがって、 ${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 のドキュメントをご覧ください。
- 開発者ガイドのデータを挿入 、 データの更新 、 データを削除する 、 単一テーブル読み取り 、 取引 、 SQLパフォーマンスの最適化などの章で、 TiDB アプリケーション開発のベスト プラクティスを学習します。
- プロフェッショナルTiDB 開発者コースを通じて学び、試験に合格するとTiDB 認定獲得します。
ヘルプが必要ですか?
TiDB コミュニティ 、またはサポートチケットを作成するについて質問します。