TiDB Cloudと Vercel を統合する
ヴェルセルはフロントエンド開発者向けのプラットフォームで、イノベーターがインスピレーションの瞬間に作成するために必要なスピードと信頼性を提供します。
Vercel でTiDB Cloudを使用すると、MySQL 互換のリレーショナル モデルで新しいフロントエンド アプリケーションをより迅速に構築でき、復元力、拡張性、最高レベルのデータ プライバシーとセキュリティを目指して構築されたプラットフォームで自信を持ってアプリを成長させることができます。
このガイドでは、次のいずれかの方法を使用してTiDB Cloudクラスターを Vercel プロジェクトに接続する方法について説明します。
上記の両方の方法について、 TiDB Cloud はプログラムでデータベースに接続するための次のオプションを提供します。
- 直接接続: MySQL の標準接続システムを使用して、 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 Vercel 統合は、TiDB サーバーレス クラスターの作成をサポートします。後で統合プロセス中に作成することもできます。
注記:
TiDB 専用クラスターの場合、Vercel デプロイメントでは動的IPアドレス使用されるため、クラスターのトラフィック フィルターですべての IP アドレス (
0.0.0.0/0
に設定) の接続が許可されていることを確認してください。 TiDB Cloud Vercel 統合を使用する場合、 TiDB Cloud は統合ワークフローのクラスターにトラフィック フィルター0.0.0.0/0
自動的に追加します (存在しない場合)。
TiDB Cloud Vercel Integration を介して Vercel と統合するでは、組織のOrganization Owner
役割、またはTiDB Cloudのターゲット プロジェクトのProject Owner
の役割を担うことが期待されます。詳細については、 ユーザーの役割を参照してください。
1 つのTiDB Cloudクラスターは複数の Vercel プロジェクトに接続できます。
データアプリとエンドポイント
データアプリ経由でTiDB Cloudクラスターに接続する場合は、事前にTiDB Cloudにターゲット データ アプリとエンドポイントを用意しておく必要があります。何も持っていない場合は、以下を参照して作成してください。
- TiDB Cloudコンソールでは、プロジェクトのデータサービスページに移動します。
- プロジェクトの場合はデータアプリを作成する 。
- データアプリをリンクするをターゲットTiDB Cloudクラスターに割り当てます。
- エンドポイントの管理を使用すると、SQL ステートメントを実行するようにカスタマイズできます。
1 つの Vercel プロジェクトは 1 つのTiDB Cloudデータ アプリにのみ接続できます。 Vercel プロジェクトのデータ アプリを変更するには、まず現在のアプリを切断してから、新しいアプリに接続する必要があります。
TiDB Cloud Vercel 統合経由で接続する
TiDB Cloud Vercel 統合経由で接続するには、 Vercel の統合マーケットプレイスからTiDB Cloud統合ページに移動します。この方法を使用すると、接続するクラスターを選択でき、 TiDB Cloud はVercel プロジェクトに必要なすべての環境変数を自動的に生成します。
詳細な手順は次のとおりです。
- Direct connection
- Data App
TiDB Cloud Vercel の統合ページの右上領域にある「統合の追加」をクリックします。 [TiDB Cloudの追加]ダイアログが表示されます。
ドロップダウン リストで統合の範囲を選択し、 [続行]をクリックします。
統合を追加する Vercel プロジェクトを選択し、 [続行]をクリックします。
統合に必要な権限を確認し、 [統合の追加]をクリックします。次に、 TiDB Cloudコンソールの統合ページに移動します。
統合ページで次の操作を行います。
- ターゲットの Vercel プロジェクトを選択し、 [次へ]をクリックします。
- ターゲットのTiDB Cloud組織とプロジェクトを選択します。
- 接続タイプとしてクラスタを選択します。
- ターゲットのTiDB Cloudクラスターを選択します。 [クラスタ]ドロップダウン リストが空である場合、または新しい TiDB サーバーレス クラスターを選択する場合は、リスト内の[+クラスタを作成します。
- Vercel プロジェクトが使用しているフレームワークを選択します。ターゲット フレームワークがリストにない場合は、 [一般]を選択します。フレームワークが異なれば、決定される環境変数も異なります。
- [統合を追加して Vercel に戻る]をクリックします。
Vercel ダッシュボードに戻り、Vercel プロジェクトに移動し、 [設定] > [環境変数]をクリックして、ターゲット TiDB クラスターの環境変数が自動的に追加されているかどうかを確認します。
以下の変数が追加されていれば統合は完了です。
一般的な
TIDB_HOST TIDB_PORT TIDB_USER TIDB_PASSWORDTiDB 専用クラスターの場合、ルート CA は次の変数に設定されます。
TIDB_SSL_CAプリズマ
DATABASE_URL
TiDB Cloud Vercel の統合ページの右上領域にある「統合の追加」をクリックします。 [TiDB Cloudの追加]ダイアログが表示されます。
ドロップダウン リストで統合の範囲を選択し、 [続行]をクリックします。
統合を追加する Vercel プロジェクトを選択し、 [続行]をクリックします。
統合に必要な権限を確認し、 [統合の追加]をクリックします。次に、 TiDB Cloudコンソールの統合ページに移動します。
統合ページで次の操作を行います。
- ターゲットの Vercel プロジェクトを選択し、 [次へ]をクリックします。
- ターゲットのTiDB Cloud組織とプロジェクトを選択します。
- 接続タイプとしてデータ アプリを選択します。
- ターゲットの TiDB データ アプリを選択します。
- [統合を追加して Vercel に戻る]をクリックします。
Vercel ダッシュボードに戻り、Vercel プロジェクトに移動し、 [設定] > [環境変数]をクリックして、ターゲット データ アプリの環境変数が自動的に追加されているかどうかを確認します。
以下の変数が追加されていれば統合は完了です。
DATA_APP_BASE_URL DATA_APP_PUBLIC_KEY DATA_APP_PRIVATE_KEY
環境変数を手動で設定して接続する
- Direct connection
- Data App
TiDB クラスターの接続情報を取得します。
クラスターの接続ダイアログから接続情報を取得できます。ダイアログを開くには、プロジェクトのクラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動し、右上隅の[接続]をクリックします。
注記:
TiDB 専用クラスターの場合は、このステップで「どこからでもアクセスを許可」トラフィック フィルターを設定していることを確認してください。
Vercel ダッシュボード > Vercel プロジェクト >設定>環境変数に移動し、TiDB クラスターの接続情報に従って各環境変数の値を宣言するに移動します。
ここでは例として Prisma アプリケーションを使用します。以下は、TiDB サーバーレス クラスターの Prisma スキーマ ファイル内のデータソース設定です。
datasource db {
provider = "mysql"
url = env("DATABASE_URL")
}
Vercel では、次のように環境変数を宣言できます。
- キー=
DATABASE_URL
- 値=
mysql://<User>:<Password>@<Endpoint>:<Port>/<Database>?sslaccept=strict
TiDB Cloudコンソールで<User>
、 <Password>
、 <Endpoint>
、 <Port>
、および<Database>
の情報を取得できます。
データ アプリとそのエンドポイントを作成していない場合は、 データAPPを管理するとエンドポイントの管理の手順に従ってください。
Vercel ダッシュボード > Vercel プロジェクト >設定>環境変数に移動し、データ アプリの接続情報に従って各環境変数の値を宣言するに移動します。
Vercel では、次のように環境変数を宣言できます。
- キー=
DATA_APP_BASE_URL
- 値=
<DATA_APP_BASE_URL>
- キー=
DATA_APP_PUBLIC_KEY
- 値=
<DATA_APP_PUBLIC_KEY>
- キー=
DATA_APP_PRIVATE_KEY
- 値=
<DATA_APP_PRIVATE_KEY>
TiDB Cloudコンソールのデータサービスページから
<DATA_APP_BASE_URL>
、<DATA_APP_PUBLIC_KEY>
、<DATA_APP_PRIVATE_KEY>
の情報を取得できます。- キー=
接続を構成する
TiDB Cloud Vercel の統合をインストールしている場合は、統合内の接続を追加または削除できます。
Vercel ダッシュボードで、 [統合]をクリックします。
[TiDB Cloud]エントリで[管理]をクリックします。
「構成」をクリックします。
[リンクの追加]または[削除]をクリックして接続を追加または削除します。
接続を削除すると、統合ワークフローによって設定された環境変数も Vercel プロジェクトから削除されます。トラフィック フィルターとTiDB Cloudクラスターのデータは影響を受けません。