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

RailsフレームワークとActiveRecord ORMを使用してTiDBに接続する

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

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

  • 環境を設定します。
  • Rails を使用して TiDB クラスターに接続します。
  • アプリケーションをビルドして実行します。オプションで、ActiveRecord ORM を使用した基本的な CRUD 操作についてはサンプルコードスニペット参照してください。

注記：

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

前提条件

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

  • ルビー >= 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 Cloud Serverless
  • TiDB Cloud Dedicated
  • TiDB Self-Managed

  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 Cloud Serverless の場合、パブリック エンドポイントを使用するときは、 ssl_mode=verify_identityクエリ パラメータを使用して TLS 接続を有効にする必要があります。

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

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

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

  3. 接続ダイアログで、 [接続タイプ]ドロップダウン リストから[パブリック]を選択し、 [CA 証明書]をクリックして CA 証明書をダウンロードします。

    IP アクセス リストをまだ設定していない場合は、 「IP アクセス リストの設定」をクリックするか、手順IPアクセスリストを設定するに従って、最初の接続の前に設定してください。

    TiDB Cloud Dedicatedは、パブリック接続タイプに加えて、プライベートエンドポイントとVPCピアリング接続タイプもサポートしています。詳細については、 TiDB Cloud専用クラスタに接続するご覧ください。

  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 Cloud Dedicated に接続する場合は、TLS 接続を有効にすることをお勧めします。

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

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

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

    cp .env.example .env

  2. .envファイルを編集し、 DATABASE_URL {host}変数を次のように設定し、 {user} 、および{database} {password}の TiDB 接続情報に置き換え{port} 。

    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: 8.0.11-TiDB-v8.1.2)
⏳ 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-クイックスタートリポジトリを参照してください。

接続オプションを使用して 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 Cloud Serverless の場合、パブリック エンドポイントを使用するときに、 DATABASE_URLでssl_modeクエリ パラメータをverify_identityに設定して TLS 接続を有効にする必要がありますが、mysql2 gem はファイルが見つかるまで特定の順序で既存の CA 証明書を検索するため、 DATABASE_URLで SSL CA 証明書を指定する必要はありません。

データを挿入する

次のクエリは、2 つのフィールドを持つ単一の Player を作成し、作成された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 (ActiveRecord ORM が TiDB に接続するために使用) は、ファイルが見つかるまで特定の順序で既存の 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設定をお勧めします。

次のステップ

ヘルプが必要ですか?

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

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