Skip to content

Latest commit

 

History

History
128 lines (80 loc) · 7.2 KB

integrate-tidbcloud-with-vercel.md

File metadata and controls

128 lines (80 loc) · 7.2 KB
Raw
title summary
Integrate TiDB Cloud with Vercel
Learn how to connect your TiDB Cloud clusters to Vercel projects.

Integrate TiDB Cloud with Vercel

Vercel is the platform for frontend developers, providing the speed and reliability innovators need to create at the moment of inspiration.

Using TiDB Cloud with Vercel enables you to build new frontend applications faster with a MySQL-compatible relational model and grow your app with confidence with a platform built for resilience, scale, and the highest levels of data privacy and security.

This guide describes how to connect your TiDB Cloud clusters to Vercel projects using one of the following methods:

Prerequisites

Before connection, make sure the following prerequisites are met.

A Vercel account and a Vercel project

You are expected to have an account and a project in Vercel. If you do not have any, refer to the following Vercel documents to create one:

One Vercel project can only connect to one TiDB Cloud cluster. To change the integration, you need to first disconnect the current cluster and then connect to a new cluster.

A TiDB Cloud account and a TiDB cluster

You are expected to have an account and a cluster in TiDB Cloud. If you do not have any, refer to Create a TiDB cluster.

To integrate with Vercel via the TiDB Cloud Vercel Integration, you are expected to have the "Owner" access to your organization or the "Member" access to the target project in TiDB Cloud. For more information, see Manage role access.

One TiDB Cloud cluster can connect to multiple Vercel projects.

All IP addresses allowed for traffic filter in TiDB Cloud

For Dedicated Tier clusters, make sure that the traffic filter of the cluster allows all IP addresses (set to 0.0.0.0/0) for connection, this is because Vercel deployments use dynamic IP addresses. If you use the TiDB Cloud Vercel integration, TiDB Cloud automatically adds a 0.0.0.0/0 traffic filter to your cluster in the integration workflow if there is none.

Serverless Tier clusters allow all IP addresses for connection by default, so you do not need to configure any traffic filter.

Connect via the TiDB Cloud Vercel integration

To connect via the TiDB Cloud Vercel integration, go to the TiDB Cloud integration page from the Vercel's Integrations Marketplace. Using this method, you can choose which cluster to connect to, and TiDB Cloud will automatically generate all the necessary environment variables for your Vercel projects.

The detailed steps are as follows:

  1. Click Add Integration in the upper-right area of the TiDB Cloud Vercel integration page. The Add TiDB Cloud dialog is displayed.
  2. Select the scope of your integration in the drop-down list and click CONTINUE.
  3. Select the Vercel Projects to which the integration will be added and click CONTINUE.
  4. Confirm the required permissions for integration and click ADD INTEGRATION. Then you are directed to an integration page of the TiDB Cloud console.
  5. On the left side, select the target Vercel projects and framework your Vercel projects using. If the framework isn't listed, select General. Different frameworks determine different environment variables.
  6. On the right side, select the target TiDB Cloud cluster after providing the cluster information. Each TiDB Cloud cluster belongs to an organization and a project.
  7. Click Add Integration and Return to Vercel.

Vercel Integration Page

  1. Back to your Vercel dashboard, go to your Vercel project, click Settings > Environment Variables, and confirm that the environment variables have been automatically added.

    If the variables have been added, the connection is completed.

After you have completed the integration setup and successfully connected a TiDB Cloud cluster to your Vercel projects, the information necessary for the connection is automatically set in the projects' environment variables.

General

TIDB_HOST
TIDB_PORT
TIDB_USER
TIDB_PASSWORD

For Dedicated Tier clusters, the root CA is set in this variable:

TIDB_SSL_CA

Prisma

DATABASE_URL

Connect via manually setting environment variables

  1. Follow the steps in Connect to a TiDB Cloud cluster via standard connection to get the connection information of your TiDB cluster.

    Note:

    For Dedicated Tier clusters, make sure that you have set the Allow Access from Anywhere traffic filter in this step.

  2. Go to your Vercel dashboard > Vercel project > Settings > Environment Variables, and then declare each environment variable value according to the connection information of your TiDB cluster.

Vercel Environment Variables

Here we use a Prisma application as an example. The following is a datasource setting in the Prisma schema file for a TiDB Cloud Serverless Tier cluster:

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

In Vercel, you can declare the environment variables as follows.

  • Key = DATABASE_URL
  • Value = mysql://<User>:<Password>@<Endpoint>:<Port>/<Database>?sslaccept=strict

You can get the information of <User>, <Password>, <Endpoint>, <Port>, and <Database> in the TiDB Cloud console.

Configure connections

If you have installed TiDB Cloud Vercel integration, you can add or remove connections inside the integration.

  1. In your Vercel dashboard, click Integrations.
  2. Click Manage in the TiDB Cloud entry.
  3. Click Configure.
  4. Click Add Project or Remove to add or remove connections.

Vercel Integration Configuration Page

When you remove a connection, environment variables set by the integration workflow are removed from the Vercel project either. The traffic filter and the data of the TiDB Cloud cluster are not affected.