TiDB CloudとVercelの統合

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

TiDB Cloud をVercel と併用することで、MySQL 互換のリレーショナル モデルを使用して新しいフロントエンド アプリケーションをより迅速に構築し、回復力、拡張性、最高レベルのデータ プライバシーとセキュリティを実現するプラットフォームを使用して自信を持ってアプリを拡張できます。

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

• TiDB Cloud Vercel統合を介して接続
• 環境変数を手動で設定して接続する

上記の両方の方法では、 TiDB Cloud はプログラムによってデータベースに接続するための次のオプションを提供します。

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

前提条件

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

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

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

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

1つの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専用クラスタを作成する

  注記：

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

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 ステートメントを実行するようにカスタマイズできます。

1つのVercelプロジェクトは1つのTiDB Cloudデータアプリにのみ接続できます。Vercelプロジェクトのデータアプリを変更するには、まず現在のアプリを切断し、新しいアプリに接続する必要があります。

TiDB Cloud Vercel統合を介して接続

TiDB Cloud Vercel統合を介して接続するには、 Vercelの統合マーケットプレイスからTiDB Cloud統合ページに進みます。この方法では、接続するクラスターを選択すると、 TiDB CloudがVercelプロジェクトに必要なすべての環境変数を自動的に生成します。

注記：

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

統合ワークフロー

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

接続を構成する

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

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

2. TiDB Cloudエントリで[管理] をクリックします。

3. ［構成］をクリックします。

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

   

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

TiDB Cloudブランチに接続する {#connect-with-branching}

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

注記：

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

TiDB Cloudブランチを有効にするには、 TiDB Cloud Vercel 統合ワークフローで次の点を確認する必要があります。

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

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

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の各組織では、デフォルトで最大5つのTiDB Cloud Starterクラスタブランチを作成できます。この制限を超えないようにするには、不要になったクラスタブランチを削除してください。詳細については、 TiDB Cloudブランチの管理ご覧ください。

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

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