重要

このページは英語版のページを機械翻訳しています。原文はこちらからご覧ください。

GORM を使用して TiDB に接続する

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

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

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

注記：
このチュートリアルは、TiDB サーバーレス、TiDB 専用、および TiDB セルフホストで動作します。

前提条件

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

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

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

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

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

(推奨) TiDB サーバーレスクラスターの作成に従って、独自の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 クラスターに接続します。

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-gorm-quickstartリポジトリを確認してください。

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 サーバーレスには安全な接続が必要です。したがって、 ${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 セクションから学びましょう。
TiDB アプリケーション開発単一テーブルの読み取りベストプラクティスについて取引、開発者ガイドの章 ( データの挿入など) データを更新する参照データの削除 SQLパフォーマンスの最適化ください。
プロフェッショナルとしてTiDB 開発者コースを学び、試験合格後にTiDB 認定獲得します。

助けが必要？

不和またはサポートチケットを作成するについて質問してください。