mysql2でTiDBに接続する

TiDB は MySQL 互換のデータベースであり、Ruby 用の最も人気のある MySQL ドライバーのMySQL2です。

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

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

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

前提条件

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

ルビー >= 3.0 がマシンにインストールされている
バンドラーマシンにインストールされています
ギットマシンにインストールされています
TiDBクラスタが稼働中

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

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

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

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

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

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

git clone https://github.com/tidb-samples/tidb-ruby-mysql2-quickstart.git
cd tidb-ruby-mysql2-quickstart

ステップ2: 依存関係をインストールする

次のコマンドを実行して、サンプルアプリに必要なパッケージ ( mysql2とdotenvを含む) をインストールします。

bundle install

既存のプロジェクトの依存関係をインストールする

既存のプロジェクトの場合は、次のコマンドを実行してパッケージをインストールします。

bundle add mysql2 dotenv

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

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

クラスターページに移動し、ターゲットクラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログの構成が動作環境と一致していることを確認します。
- 接続タイプはPublicに設定されています。
- ブランチはmainに設定されています。
- Connect With がGeneralに設定されています。
- オペレーティングシステムは、アプリケーションを実行するオペレーティングシステムと一致します。
まだパスワードを設定していない場合は、 「パスワードの生成」をクリックしてランダムなパスワードを生成します。
次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。
```
cp .env.example .env
```
.envファイルを編集し、環境変数を次のように設定し、接続ダイアログで対応するプレースホルダー{}接続パラメータに置き換えます。
```
DATABASE_HOST={host}
DATABASE_PORT=4000
DATABASE_USER={user}
DATABASE_PASSWORD={password}
DATABASE_NAME=test
DATABASE_ENABLE_SSL=true
```
注記
TiDB CloudスターターおよびTiDB Cloudエッセンシャル場合、パブリックエンドポイントを使用する場合は、 DATABASE_ENABLE_SSL経由で TLS 接続を有効にする必要があります。
.envファイルを保存します。

クラスターページに移動し、ターゲットクラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログで、 [接続タイプ]ドロップダウンリストから[パブリック]を選択し、 [CA 証明書]をクリックして CA 証明書をダウンロードします。
IP アクセスリストをまだ設定していない場合は、 「IP アクセスリストの設定」をクリックするか、手順IPアクセスリストを設定するに従って、最初の接続の前に設定してください。
TiDB Cloud Dedicatedは、パブリック接続タイプに加えて、プライベートエンドポイントとVPCピアリング接続タイプもサポートしています。詳細については、 TiDB Cloud専用クラスタに接続するご覧ください。
次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。
```
cp .env.example .env
```
.envファイルを編集し、環境変数を次のように設定し、接続ダイアログで対応するプレースホルダー{}接続パラメータに置き換えます。
```
DATABASE_HOST={host}
DATABASE_PORT=4000
DATABASE_USER={user}
DATABASE_PASSWORD={password}
DATABASE_NAME=test
DATABASE_ENABLE_SSL=true
DATABASE_SSL_CA={downloaded_ssl_ca_path}
```
注記
パブリックエンドポイントを使用してTiDB Cloud Dedicated クラスターに接続する場合は、TLS 接続を有効にすることをお勧めします。
TLS 接続を有効にするには、 DATABASE_ENABLE_SSLからtrue変更し、 DATABASE_SSL_CA使用して接続ダイアログからダウンロードした CA 証明書のファイルパスを指定します。
.envファイルを保存します。

次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。
```
cp .env.example .env
```
.envファイルを編集し、環境変数を次のように設定し、対応するプレースホルダー{}独自の TiDB 接続情報に置き換えます。
```
DATABASE_HOST={host}
DATABASE_PORT=4000
DATABASE_USER={user}
DATABASE_PASSWORD={password}
DATABASE_NAME=test
```
TiDB をローカルで実行している場合、デフォルトのホストアドレスは127.0.0.1で、パスワードは空になります。
.envファイルを保存します。

ステップ4: コードを実行して結果を確認する

サンプルコードを実行するには、次のコマンドを実行します。

ruby app.rb

接続が成功すると、コンソールに次のように TiDB クラスターのバージョンが出力されます。

🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.5.3)
⏳ Loading sample game data...
✅ Loaded sample game data.

🆕 Created a new player with ID 12.
ℹ️ Got Player 12: Player { id: 12, coins: 100, goods: 100 }
🔢 Added 50 coins and 50 goods to player 12, updated 1 row.
🚮 Deleted 1 player data.

サンプルコードスニペット

次のサンプルコードスニペットを参照して、独自のアプリケーション開発を完了することができます。

完全なサンプルコードとその実行方法については、 tidb-samples/tidb-ruby-mysql2-クイックスタートリポジトリを参照してください。

接続オプションを使用して TiDB に接続する

次のコードは、環境変数で定義されたオプションを使用して TiDB への接続を確立します。

require 'dotenv/load'
require 'mysql2'
Dotenv.load # Load the environment variables from the .env file

options = {
  host: ENV['DATABASE_HOST'] || '127.0.0.1',
  port: ENV['DATABASE_PORT'] || 4000,
  username: ENV['DATABASE_USER'] || 'root',
  password: ENV['DATABASE_PASSWORD'] || '',
  database: ENV['DATABASE_NAME'] || 'test'
}
options.merge(ssl_mode: :verify_identity) unless ENV['DATABASE_ENABLE_SSL'] == 'false'
options.merge(sslca: ENV['DATABASE_SSL_CA']) if ENV['DATABASE_SSL_CA']
client = Mysql2::Client.new(options)

注記
TiDB CloudスターターとTiDB Cloudエッセンシャル場合、パブリックエンドポイントを使用するときはDATABASE_ENABLE_SSLで TLS 接続を有効にする必要がありますが、mysql2 gem はファイルが見つかるまで特定の順序で既存の CA 証明書を検索するため、 DATABASE_SSL_CAで SSL CA 証明書を指定する必要はありません。

データを挿入する

次のクエリは、 2 つのフィールドを持つ単一のプレーヤーを作成し、 last_insert_id返します。

def create_player(client, coins, goods)
  result = client.query(
    "INSERT INTO players (coins, goods) VALUES (#{coins}, #{goods});"
  )
  client.last_id
end

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

クエリデータ

次のクエリは、ID によって特定のプレーヤーのレコードを返します。

def get_player_by_id(client, id)
  result = client.query(
    "SELECT id, coins, goods FROM players WHERE id = #{id};"
  )
  result.first
end

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

データを更新する

次のクエリは、ID によって特定のプレーヤーのレコードを更新しました。

def update_player(client, player_id, inc_coins, inc_goods)
  result = client.query(
    "UPDATE players SET coins = coins + #{inc_coins}, goods = goods + #{inc_goods} WHERE id = #{player_id};"
  )
  client.affected_rows
end

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

データを削除する

次のクエリは、特定のプレーヤーのレコードを削除します。

def delete_player_by_id(client, id)
  result = client.query(
    "DELETE FROM players WHERE id = #{id};"
  )
  client.affected_rows
end

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

ベストプラクティス

デフォルトでは、mysql2 gem は、ファイルが見つかるまで特定の順序で既存の CA 証明書を検索できます。

Debian、Ubuntu、Gentoo、Arch、または Slackware の場合は/etc/ssl/certs/ca-certificates.crt
RedHat、Fedora、CentOS、Mageia、Vercel、または Netlify の場合は/etc/pki/tls/certs/ca-bundle.crt
OpenSUSEの場合は/etc/ssl/ca-bundle.pem
macOS または Alpine (docker コンテナ) の場合は/etc/ssl/cert.pem

CA証明書のパスを手動で指定することも可能ですが、複数の環境に展開する場合、異なるマシンや環境でCA証明書が異なる場所に保存される可能性があるため、大きな不便が生じる可能性があります。そのため、異なる環境への展開における柔軟性と容易さを確保するため、 sslca ～ nil設定をお勧めします。

次のステップ

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

ヘルプが必要ですか?

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