TiDB Cloud
TiDB Self-Managed
Learning Center
お問い合わせ
🚀
新しい TiDB Labs を探索し、ブラウザから直接分散型 SQL データベースを学び、RAG アプリを構築しましょう。

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

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

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

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

注記：

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

前提条件

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

  • ルビー >= 3.0 がマシンにインストールされている
  • バンドラーマシンにインストールされています
  • ギットマシンにインストールされています
  • 実行中の 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 クラスターに接続します。

  • TiDB Serverless
  • TiDB Dedicated
  • TiDB Self-Hosted

  1. クラスターページに移動し、ターゲット クラスターの名前をクリックして、その概要ページに移動します。

  2. 右上隅にある「接続」をクリックします。接続ダイアログが表示されます。

  3. 接続ダイアログの設定が動作環境と一致していることを確認してください。

    • エンドポイント タイプはPublicに設定されます。
    • ブランチはmainに設定されます。
    • [接続先] はGeneralに設定されます。
    • [オペレーティング システム] は、アプリケーションを実行するオペレーティング システムと一致します。

  4. パスワードをまだ設定していない場合は、 「パスワードの生成」をクリックしてランダムなパスワードを生成します。

  5. 次のコマンドを実行して.env.exampleをコピーし、名前を.envに変更します。

    cp .env.example .env

  6. .envファイルを編集し、次のように環境変数を設定し、接続ダイアログ内の対応するプレースホルダー<>接続パラメーターに置き換えます。

    DATABASE_HOST=<host>
DATABASE_PORT=4000
DATABASE_USER=<user>
DATABASE_PASSWORD=<password>
DATABASE_NAME=test
DATABASE_ENABLE_SSL=true

    注記

    TiDB サーバーレスの場合、パブリック エンドポイントを使用する場合は、TLS 接続をDATABASE_ENABLE_SSL経由で有効にする必要があります。

  7. .envファイルを保存します。

  1. クラスターページに移動し、ターゲット クラスターの名前をクリックして、その概要ページに移動します。

  2. 右上隅にある「接続」をクリックします。接続ダイアログが表示されます。

  3. 「どこからでもアクセスを許可」をクリックし、 「TiDB クラスター CA のダウンロード」をクリックして CA 証明書をダウンロードします。

    接続文字列の取得方法の詳細については、 TiDB専用標準接続を参照してください。

  4. 次のコマンドを実行して.env.exampleをコピーし、名前を.envに変更します。

    cp .env.example .env

  5. .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 専用クラスターに接続する場合は、TLS 接続を有効にすることをお勧めします。

    TLS 接続を有効にするには、 DATABASE_ENABLE_SSLをtrueに変更し、 DATABASE_SSL_CA使用して接続ダイアログからダウンロードした CA 証明書のファイル パスを指定します。

  6. .envファイルを保存します。

  1. 次のコマンドを実行して.env.exampleをコピーし、名前を.envに変更します。

    cp .env.example .env

  2. .envファイルを編集し、次のように環境変数を設定し、対応するプレースホルダー<>独自の TiDB 接続情報に置き換えます。

    DATABASE_HOST=<host>
DATABASE_PORT=4000
DATABASE_USER=<user>
DATABASE_PASSWORD=<password>
DATABASE_NAME=test

    TiDB をローカルで実行している場合、デフォルトのホスト アドレスは127.0.0.1で、パスワードは空です。

  3. .envファイルを保存します。

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

次のコマンドを実行してサンプル コードを実行します。

ruby app.rb

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

🔌 Connected to TiDB cluster! (TiDB version: 5.7.25-TiDB-v7.1.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-quickstartリポジトリを確認してください。

接続オプションを使用して 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 サーバーレスの場合、パブリック エンドポイントを使用する場合は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 証明書を検索できます。

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

CA 証明書のパスを手動で指定することは可能ですが、マシンや環境が異なれば CA 証明書が異なる場所に保存される可能性があるため、複数環境の展開シナリオでは重大な不便が生じる可能性があります。したがって、さまざまな環境間での導入の柔軟性と容易さを考慮して、 sslca ～ nilを設定することをお勧めします。

次のステップ

助けが必要？

質問は不和チャンネルでお願いします。

このページは役に立ちましたか？