GORMでTiDBに接続する

TiDB は MySQL 互換のデータベースであり、ゴーム Golang用の人気のオープンソース ORM フレームワークです。GORM はAUTO_RANDOMやデフォルトのデータベースオプションとしてTiDBをサポートの TiDB の機能に適応しています。

このチュートリアルでは、TiDB と GORM を使用して次のタスクを実行する方法を学習します。

環境を設定します。
GORM を使用して TiDB クラスターに接続します。
アプリケーションをビルドして実行します。オプションで、基本的なCRUD操作用のサンプルコードスニペット見つけることもできます。

注記：
このチュートリアルは、 TiDB Cloud Starter、 TiDB Cloud Essential、 TiDB Cloud Dedicated、および TiDB Self-Managed で機能します。

前提条件

このチュートリアルを完了するには、次のものが必要です。

行く 1.20以上。
ギット。
TiDB クラスター。

TiDB クラスターがない場合は、次のように作成できます。

(推奨) TiDB Cloud Starter クラスターの作成に従って、独自のTiDB Cloudクラスターを作成します。
ローカルテストTiDBクラスタをデプロイまたは本番のTiDBクラスタをデプロイに従ってローカルクラスターを作成します。

サンプルアプリを実行してTiDBに接続する

このセクションでは、サンプルアプリケーションコードを実行して TiDB に接続する方法を説明します。

ステップ1: サンプルアプリのリポジトリをクローンする

サンプルコードリポジトリのクローンを作成するには、ターミナルウィンドウで次のコマンドを実行します。

git clone https://github.com/tidb-samples/tidb-golang-gorm-quickstart.git
cd tidb-golang-gorm-quickstart

ステップ2: 接続情報を構成する

選択した TiDB デプロイメントオプションに応じて、TiDB クラスターに接続します。

クラスターページに移動し、ターゲットクラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログの構成が動作環境と一致していることを確認します。
- 接続タイプは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 Starterは安全な接続を必要とします。そのため、 USE_SSLをtrueに設定する必要があります。
.envファイルを保存します。

クラスターページに移動し、ターゲットクラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログで、 [接続タイプ]ドロップダウンリストから[パブリック]を選択し、 [CA 証明書]をクリックして CA 証明書をダウンロードします。
IP アクセスリストをまだ設定していない場合は、 「IP アクセスリストの設定」をクリックするか、手順IPアクセスリストを設定するに従って、最初の接続の前に設定してください。
TiDB Cloud Dedicatedは、パブリック接続タイプに加えて、プライベートエンドポイントとVPCピアリング接続タイプもサポートしています。詳細については、 TiDB Cloud専用クラスタに接続するご覧ください。
次のコマンドを実行して.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-gorm-クイックスタートリポジトリを参照してください。

TiDBに接続する

func createDB() *gorm.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 := gorm.Open(mysql.Open(dsn), &gorm.Config{
        Logger: logger.Default.LogMode(logger.Info),
    })
    if err != nil {
        panic(err)
    }

    return db
}

この関数を使用する場合、 ${tidb_host} 、 ${tidb_port} 、 ${tidb_user} 、 ${tidb_password} 、 ${tidb_db_name} TiDBクラスタの実際の値に置き換える必要があります。TiDB TiDB Cloud Starterは安全な接続を必要とするため、 ${use_ssl}をtrueに設定する必要があります。

データを挿入する

db.Create(&Player{ID: "id", Coins: 1, Goods: 1})

詳細についてはデータを挿入するを参照してください。

クエリデータ

var queryPlayer Player
db.Find(&queryPlayer, "id = ?", "id")

詳細についてはクエリデータを参照してください。

データを更新する

db.Save(&Player{ID: "id", Coins: 100, Goods: 1})

詳細についてはデータを更新するを参照してください。

データを削除する

db.Delete(&Player{ID: "id"})

詳細についてはデータを削除するを参照してください。

次のステップ

GORM の使い方をGORMのドキュメントとGORMのドキュメントのTiDBセクションからさらに学びましょう。
開発者ガイドのデータを挿入する、データを更新する、データを削除する、単一テーブルの読み取り、取引、 SQLパフォーマンスの最適化などの章で、 TiDB アプリケーション開発のベストプラクティスを学習します。
プロフェッショナルTiDB開発者コースを通じて学び、試験に合格するとTiDB認定獲得します。

ヘルプが必要ですか?

不和またはスラック、あるいはサポートチケットを送信するについてコミュニティに質問してください。