TiDB CloudとVercelを統合する

ヴェルセルはフロントエンド開発者向けのプラットフォームであり、イノベーターがひらめきの瞬間に創造するために必要なスピードと信頼性を提供します。

TiDB CloudとVercelを組み合わせることで、MySQL互換のリレーショナルモデルを使用して新しいフロントエンドアプリケーションをより迅速に構築できるだけでなく、回復力、拡張性、そして最高レベルのデータプライバシーとセキュリティを備えたプラットフォームによって、自信を持ってアプリケーションを成長させることができます。

このガイドでは、以下のいずれかの方法を使用して、 TiDB CloudのリソースをVercelプロジェクトに接続する方法について説明します。

• TiDB Cloud Vercelとの連携を介して接続します。
• 環境変数を手動で設定して接続します

上記2つの方法のいずれにおいても、 TiDB Cloudはデータベースにプログラムで接続するための以下のオプションを提供します。

• クラスタ: 直接接続またはサーバーレスドライバーレス ドライバーを使用して、 TiDB Cloudクラスターを Vercel プロジェクトに接続します。
• データアプリ: HTTP エンドポイントのコレクションを通じてTiDB Cloudクラスターのデータにアクセスします。

前提条件

接続する前に、以下の前提条件が満たされていることを確認してください。

VercelアカウントとVercelプロジェクト

Vercelにアカウントとプロジェクトをお持ちであることが前提となります。お持ちでない場合は、以下のVercelドキュメントを参照して作成してください。

• 新しい個人アカウントを作成する、 新しいチームを作る。
• Vercel でプロジェクトの作成か、デプロイするアプリケーションがない場合は、 TiDB Cloud Starterテンプレート使用して試すことができます。

Vercelプロジェクトは、1つのTiDB Cloudクラスターにしか接続できません。統合を変更するには、まず現在のクラスターとの接続を解除してから、新しいクラスターに接続する必要があります。

TiDB CloudアカウントとTiDBクラスタ

TiDB Cloudにアカウントとクラスターが既に作成されている必要があります。アカウントとクラスターをお持ちでない場合は、以下の手順に従って作成してください。

• TiDB Cloud StarterまたはTiDB Cloud Essentialインスタンスを作成します。

  注記：

  TiDB Cloud Vercelとの連携では、TiDB Cloud StarterおよびTiDB Cloud Essentialインスタンスの作成がサポートされています。また、連携プロセス中に後からインスタンスを作成することも可能です。

• TiDB Cloud Dedicatedクラスターを作成する

  注記：

  TiDB Cloud Dedicatedクラスターの場合、Vercel デプロイメントは IP アドレスを使用するため、クラスターのトラフィック フィルターですべての IP アドレス ( 0.0.0.0/0 } に設定) が接続を許可されて動的IPアドレスことを確認してください。

TiDB Cloud Vercel統合を介してVercelと統合するには、組織のOrganization Ownerロール、またはTiDB Cloudのターゲット プロジェクトのProject Ownerロールに所属することが求められます。詳細については、 ユーザーロールを参照してください。

1つのTiDB Cloudクラスターは、複数のVercelプロジェクトに接続できます。

データアプリとエンドポイント

データデータアプリを介してTiDB Cloudクラスターに接続する場合は、事前にTiDB Cloudに対象のデータアプリとエンドポイントが設定されている必要があります。設定されていない場合は、以下の手順に従って作成してください。

1. TiDB Cloudコンソールで、プロジェクトのデータサービスページに移動します。
2. あなたのプロジェクトに合わせてデータアプリを作成する。
3. データアプリをリンクするターゲットのTiDB Cloudクラスターにリンクします。
4. エンドポイントを管理することで、SQL ステートメントを実行するようにカスタマイズできます。

Vercelプロジェクトは、1つのTiDB Cloudデータアプリにしか接続できません。Vercelプロジェクトのデータアプリを変更するには、まず現在のアプリとの接続を解除してから、新しいアプリに接続する必要があります。

TiDB Cloud Vercelとの連携を介して接続します。

TiDB Cloud Vercel 統合経由で接続するには、 Vercelの統合マーケットプレイスからTiDB Cloud統合ページにアクセスしてください。この方法を使用すると、接続するクラスターを選択でき、 TiDB Cloud はVercel プロジェクトに必要なすべての環境変数を自動的に生成します。

注記：

この方法は、 TiDB Cloud StarterおよびTiDB Cloud Essentialインスタンスでのみ利用可能です。TiDB Cloud Dedicatedクラスターに接続する場合は、 手動法を使用してください。

統合ワークフロー

詳細な手順は以下のとおりです。

1. TiDB Cloud Vercelとの統合ページの右上領域にある[統合の追加] をクリックします。 [TiDB Cloudの追加]ダイアログが表示されます。

2. ドロップダウンリストから統合の範囲を選択し、 「続行」をクリックしてください。

3. 統合を追加するVercelプロジェクトを選択し、 「続行」をクリックします。

4. 統合に必要な権限を確認し、 「統合を追加」をクリックしてください。すると、 TiDB Cloudコンソールの統合ページに移動します。

5. 統合ページで、以下の操作を行います。

   1. 対象となるVercelプロジェクトを選択し、 「次へ」をクリックしてください。
   2. 対象となるTiDB Cloud組織とプロジェクトを選択してください。
   3. 接続タイプとして「クラスタ」を選択してください。
   4. 対象のTiDB Cloudリソースを選択してください。クラスタのドロップダウン リストが空の場合、または新しいTiDB Cloud StarterまたはTiDB Cloud Essentialインスタンスを選択する場合は、リストの[+クラスタの作成] をクリックして作成してください。
   5. 接続するデータベースを選択してください。データベースのドロップダウンリストが空の場合、または新しいデータベースを選択する場合は、リスト内の「+ データベースの作成」をクリックして作成してください。
   6. Vercelプロジェクトで使用しているフレームワークを選択してください。対象のフレームワークが一覧にない場合は、 「一般」を選択してください。フレームワークによって環境変数が異なります。
   7. プレビュー環境用に新しいブランチを作成するために、ブランチ機能を有効にするかどうかを選択してください。
   8. 「統合を追加」をクリックしてVercelに戻ります。

6. Vercelダッシュボードに戻り、Vercelプロジェクトに移動して、 [設定] > [環境変数]をクリックし、対象のTiDBクラスタの環境変数が自動的に追加されているかどうかを確認してください。

   以下の変数が追加された場合、積分は完了です。

   一般的な

   TIDB_HOST
   TIDB_PORT
   TIDB_USER
   TIDB_PASSWORD
   TIDB_DATABASE
   

   プリズマ

   DATABASE_URL
   

   TiDB CloudサーバーレスDriver

   DATABASE_URL
   

1. TiDB Cloud Vercelとの統合ページの右上領域にある[統合の追加] をクリックします。 [TiDB Cloudの追加]ダイアログが表示されます。

2. ドロップダウンリストから統合の範囲を選択し、 「続行」をクリックしてください。

3. 統合を追加するVercelプロジェクトを選択し、 「続行」をクリックします。

4. 統合に必要な権限を確認し、 「統合を追加」をクリックしてください。すると、 TiDB Cloudコンソールの統合ページに移動します。

5. 統合ページで、以下の操作を行います。

   1. 対象となるVercelプロジェクトを選択し、 「次へ」をクリックしてください。
   2. 対象となるTiDB Cloud組織とプロジェクトを選択してください。
   3. 接続タイプとして「データアプリ」を選択してください。
   4. 対象のTiDBデータアプリを選択してください。
   5. 「統合を追加」をクリックしてVercelに戻ります。

6. Vercelダッシュボードに戻り、Vercelプロジェクトに移動して、 [設定] > [環境変数]をクリックし、対象のデータアプリの環境変数が自動的に追加されているかどうかを確認してください。

   以下の変数が追加された場合、積分は完了です。

   DATA_APP_BASE_URL
   DATA_APP_PUBLIC_KEY
   DATA_APP_PRIVATE_KEY
   

接続を設定する

TiDB Cloud Vercelとの統合をインストールしている場合は、統合内の接続を追加または削除できます。

1. Vercelダッシュボードで、 [統合]をクリックします。

2. TiDB Cloudのエントリで「管理」をクリックします。

3. 「設定」をクリックします。

4. 接続を追加または削除するには、 「リンクを追加」または「削除」をクリックします。

   

   接続を削除すると、統合ワークフローによって設定された環境変数もVercelプロジェクトから削除されます。ただし、この操作はTiDB Cloudクラスタのデータには影響しません。

TiDB Cloudのブランチ機能に接続します {#connect-with-branching}

Vercel のプレビュー展開機能を使用すると、変更を Git プロジェクトの本番ブランチにマージすることなく、ライブデプロイメントでアプリの変更をプレビューできます。TiDB TiDB Cloudブランチングを使用すると、Vercel プロジェクトのブランチごとに新しいインスタンスを作成できます。これにより、本番データに影響を与えることなく、ライブデプロイメントでアプリの変更をプレビューできます。

注記：

現在、 TiDB Cloud Branching はVercelプロジェクトとGitHubリポジトリの関連付けのみをサポートしています。

TiDB Cloud Branching を有効にするには、 TiDB Cloud Vercel統合ワークフローで次のことを確認する必要があります。

1. 接続タイプとして「クラスタ」を選択してください。
2. プレビュー環境用の新しいブランチを作成するには、ブランチ機能を有効にしてください。

Gitリポジトリに変更をプッシュすると、Vercelがプレビューデプロイメントをトリガーします。TiDB Cloudとの連携により、Gitブランチ用のTiDB Cloudクラスタのブランチが自動的に作成され、環境変数が設定されます。詳細な手順は以下のとおりです。

1. Gitリポジトリに新しいブランチを作成します。

   cd tidb-prisma-vercel-demo1
   git checkout -b new-branch
   

2. 変更を加えて、その変更をリモートリポジトリにプッシュします。

3. Vercelは、新しいブランチのプレビュー展開を開始します。

   

   1. デプロイ時に、 TiDB Cloud統合機能は、Gitブランチと同じ名前のブランチをクラスタ用に自動的に作成します。ブランチが既に存在する場合は、 TiDB Cloud統合機能はこの手順をスキップします。

      

   2. ブランチの準備が完了すると、 TiDB Cloud統合によって、Vercelプロジェクトのプレビューデプロイメントで環境変数が設定されます。

      

   3. TiDB Cloudとの連携により、ブランチの準備が整うまで待機するためのブロッキングチェックも登録されます。このチェックは手動で再実行することも可能です。

4. チェックに合格したら、プレビュー環境にアクセスして変更内容を確認できます。

注記：

Vercelのデプロイワークフローの制限により、環境変数がデプロイ時に確実に設定されるとは限りません。この場合、デプロイを再実行する必要があります。

注記：

TiDB Cloudの各組織では、デフォルトではTiDB Cloud Starterインスタンス用に最大 5 つのブランチを作成できます。制限を超えないようにするには、不要になったTiDB Cloud Starterインスタンスのブランチを削除してください。詳細については、 TiDB Cloudブランチを管理する参照してください。 .

環境変数を手動で設定して接続します

datasource db {
    provider = "mysql"
    url      = env("DATABASE_URL")
}