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

Rails Framework と ActiveRecord ORM を使用して TiDB に接続する

TiDB は MySQL 互換データベース、 レールは Ruby で書かれた一般的な Web アプリケーション フレームワーク、 ActiveRecord ORMは Rails のオブジェクト リレーショナル マッピングです。

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

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

注記：

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

前提条件

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

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

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

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

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

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

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

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

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

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

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

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

bundle add mysql2 dotenv

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

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

  • TiDB Serverless
  • TiDB Dedicated
  • TiDB Self-Hosted

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

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

  3. 接続ダイアログで、 [接続先]ドロップダウン リストからRailsを選択し、エンドポイント タイプのデフォルト設定をPublicのままにします。

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

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

    cp .env.example .env

  6. .envファイルを編集し、 DATABASE_URL環境変数を次のように設定し、接続ダイアログから接続文字列を変数値としてコピーします。

    DATABASE_URL=mysql2://<user>:<password>@<host>:<port>/<database_name>?ssl_mode=verify_identity

    注記

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

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

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

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

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

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

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

    cp .env.example .env

  5. .envファイルを編集し、次のようにDATABASE_URL環境変数を設定し、接続ダイアログから接続文字列を変数値としてコピーし、 sslcaクエリ パラメータを接続ダイアログからダウンロードした CA 証明書のファイル パスに設定します。

    DATABASE_URL=mysql2://<user>:<password>@<host>:<port>/<database>?ssl_mode=verify_identity&sslca=/path/to/ca.pem

    注記

    パブリック エンドポイントを使用して TiDB Dended に接続する場合は、TLS 接続を有効にすることをお勧めします。

    TLS 接続を有効にするには、 ssl_modeクエリ パラメータの値をverify_identityに変更し、 sslcaの値を接続ダイアログからダウンロードした CA 証明書のファイル パスに変更します。

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

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

    cp .env.example .env

  2. .envファイルを編集し、次のようにDATABASE_URL環境変数を設定し、 <user> 、 <password> 、 <host> 、 <port> 、および<database>独自の TiDB 接続情報に置き換えます。

    DATABASE_URL=mysql2://<user>:<password>@<host>:<port>/<database>

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

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

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

  1. データベースとテーブルを作成します。

    bundle exec rails db:create
bundle exec rails db:migrate

  2. サンプル データをシードします。

    bundle exec rails db:seed

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

    bundle exec rails runner ./quickstart.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-rails-quickstartリポジトリを確認してください。

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

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

default: &default
  adapter: mysql2
  encoding: utf8mb4
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  url: <%= ENV["DATABASE_URL"] %>

development:
  <<: *default

test:
  <<: *default
  database: quickstart_test

production:
  <<: *default

注記

TiDB サーバーレスの場合、パブリック エンドポイントを使用するときにssl_modeクエリ パラメーターをverify_identity in DATABASE_URLに設定することで TLS 接続を有効にする必要がありますが、mysql2 gem は既存の CA 証明書を検索するため、 DATABASE_URL介して SSL CA 証明書を指定する必要はありません。ファイルが検出されるまでの特定の順序。

データの挿入

次のクエリは、2 つのフィールドを持つ単一のプレーヤーを作成し、作成されたPlayerオブジェクトを返します。

new_player = Player.create!(coins: 100, goods: 100)

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

クエリデータ

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

player = Player.find_by(id: new_player.id)

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

データを更新する

次のクエリはPlayerオブジェクトを更新します。

player.update(coins: 50, goods: 50)

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

データの削除

次のクエリはPlayerオブジェクトを削除します。

player.destroy

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

ベストプラクティス

デフォルトでは、mysql2 gem (TiDB に接続するために ActiveRecord ORM によって使用される) は、ファイルが検出されるまで特定の順序で既存の CA 証明書を検索します。

  1. /etc/ssl/certs/ca-certificates.crt # Debian / Ubuntu / Gentoo / Arch / Slackware
  2. /etc/pki/tls/certs/ca-bundle.crt # RedHat / Fedora / CentOS / Mageia / Vercel / Netlify
  3. /etc/ssl/ca-bundle.pem # OpenSUSE
  4. /etc/ssl/cert.pem # MacOS / Alpine (Docker コンテナ)

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

次のステップ

助けが必要？

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

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