Manage TiDB Cloud Serverless Branches

This document describes how to manage TiDB Cloud Serverless branches using the TiDB Cloud console. To manage it using the TiDB Cloud CLI, see ticloud branch.

Required access

To create a branch or connect to a branch, you must be in the Organization Owner role of your organization or the Project Owner role of the target project.
To view branches for clusters in a project, you must belong to that project.

For more information about permissions, see User roles.

Create a branch

Note

You can only create branches for TiDB Cloud Serverless clusters that are created after July 5, 2023. See Limitations and quotas for more limitations.

To create a branch, perform the following steps:

In the TiDB Cloud console, navigate to the Clusters page of your project, and then click the name of your target TiDB Cloud Serverless cluster to go to its overview page.
Click Branches in the left navigation pane.
Click Create Branch in the upper-right corner.
Enter the branch name, and then click Create.

Depending on the data size in your cluster, the branch creation will be completed in a few minutes.

View branches

To view branches for your cluster, perform the following steps:

In the TiDB Cloud console, navigate to the Clusters page of your project, and then click the name of your target TiDB Cloud Serverless cluster to go to its overview page.
Click Branches in the left navigation pane.
The branch list of the cluster is displayed in the right pane.

Connect to a branch

To connect to a branch, perform the following steps:

In the TiDB Cloud console, navigate to the Clusters page of your project, and then click the name of your target TiDB Cloud Serverless cluster to go to its overview page.
Click Branches in the left navigation pane.
In the row of your target branch to be connected, click ... in the Action column.
Click Connect in the drop-down list. The dialog for the connection information is displayed.
Click Generate Password or Reset Password to create or reset the root password.
Connect to the branch using the connection information.

Alternatively, you can get the connection string from the cluster overview page:

In the TiDB Cloud console, navigate to the Clusters page of your project, and then click the name of your target TiDB Cloud Serverless cluster to go to its overview page.
Click Connect in the upper-right corner.
Select the branch you want to connect to in the Branch drop-down list.
Click Generate Password or Reset Password to create or reset the root password.
Connect to the branch using the connection information.

Delete a branch

To delete a branch, perform the following steps:

In the TiDB Cloud console, navigate to the Clusters page of your project, and then click the name of your target TiDB Cloud Serverless cluster to go to its overview page.
Click Branches in the left navigation pane.
In the row of your target branch to be deleted, click ... in the Action column.
Click Delete in the drop-down list.
Confirm the deletion.

What's next

Integrate TiDB Cloud Serverless branching into your GitHub CI/CD pipeline