TiDB CloudとVercelを統合する

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

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

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

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

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

• クラスタ: 直接接続またはTiDB Cloud Serverless Driverを使用して、 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に設定) からの接続を許可していることを確認してください。

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

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

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

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

1. TiDB Cloudコンソールで、プロジェクトのData Serviceページに移動します。
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 Vercelとの統合をインストールしている場合は、統合内の接続を追加または削除できます。

1. Vercelダッシュボードで、 Integrationsをクリックします。

2. TiDB CloudのエントリでManageをクリックします。

3. Configureをクリックします。

4. 接続を追加または削除するには、 Add LinkまたはRemoveをクリックします。

   

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

TiDB Cloudのブランチ機能に接続します

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

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

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

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. チェックに合格したら、プレビュー環境にアクセスして変更内容を確認できます。

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

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