From 08e9d9fcf4eeecc4234108cd4945a46ce073697e Mon Sep 17 00:00:00 2001 From: qiancai Date: Fri, 6 Mar 2026 15:03:18 +0800 Subject: [PATCH] add docs for the My TiDB Page --- TOC-tidb-cloud-essential.md | 1 + TOC-tidb-cloud-premium.md | 1 + TOC-tidb-cloud-starter.md | 1 + TOC-tidb-cloud.md | 1 + tidb-cloud/my-tidb.md | 68 +++++++++++++++++++++++++++++++ tidb-cloud/tidb-cloud-glossary.md | 35 +++++++++++++++- 6 files changed, 106 insertions(+), 1 deletion(-) create mode 100644 tidb-cloud/my-tidb.md diff --git a/TOC-tidb-cloud-essential.md b/TOC-tidb-cloud-essential.md index cdeb3c7ca755d..bf07240371e2c 100644 --- a/TOC-tidb-cloud-essential.md +++ b/TOC-tidb-cloud-essential.md @@ -30,6 +30,7 @@ - Manage Cluster - [Select Your Cluster Plan](/tidb-cloud/select-cluster-tier.md) + - [Use the My TiDB Page](/tidb-cloud/my-tidb.md) - Manage TiDB Cloud Clusters - [Create a TiDB Cloud Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) - Connect to Your TiDB Cloud Cluster diff --git a/TOC-tidb-cloud-premium.md b/TOC-tidb-cloud-premium.md index 299577ac3e16e..9e54e8c56e981 100644 --- a/TOC-tidb-cloud-premium.md +++ b/TOC-tidb-cloud-premium.md @@ -126,6 +126,7 @@ - Manage Instances - [Select Your Cluster Plan](/tidb-cloud/select-cluster-tier.md) + - [Use the My TiDB Page](/tidb-cloud/my-tidb.md) - Manage TiDB Cloud Instances - [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md) - Connect to Your TiDB Cloud Instance diff --git a/TOC-tidb-cloud-starter.md b/TOC-tidb-cloud-starter.md index d8fa6020884bd..50214895d1bf9 100644 --- a/TOC-tidb-cloud-starter.md +++ b/TOC-tidb-cloud-starter.md @@ -32,6 +32,7 @@ - Manage Cluster - [Select Your Cluster Plan](/tidb-cloud/select-cluster-tier.md) + - [Use the My TiDB Page](/tidb-cloud/my-tidb.md) - Manage TiDB Cloud Clusters - [Create a TiDB Cloud Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) - Connect to Your TiDB Cloud Cluster diff --git a/TOC-tidb-cloud.md b/TOC-tidb-cloud.md index 2c0959c954a6b..8082a2fcea370 100644 --- a/TOC-tidb-cloud.md +++ b/TOC-tidb-cloud.md @@ -35,6 +35,7 @@ - [Select Your Cluster Plan](/tidb-cloud/select-cluster-tier.md) - [Determine Your TiDB Size](/tidb-cloud/size-your-cluster.md) - [TiDB Cloud Performance Reference](/tidb-cloud/tidb-cloud-performance-reference.md) + - [Use the My TiDB Page](/tidb-cloud/my-tidb.md) - [Create a TiDB Cloud Dedicated Cluster](/tidb-cloud/create-tidb-cluster.md) - Connect to Your TiDB Cloud Dedicated Cluster - [Network Connection Overview](/tidb-cloud/connect-to-tidb-cluster.md) diff --git a/tidb-cloud/my-tidb.md b/tidb-cloud/my-tidb.md new file mode 100644 index 0000000000000..02b2a87b57f3b --- /dev/null +++ b/tidb-cloud/my-tidb.md @@ -0,0 +1,68 @@ +--- +title: Use the My TiDB Page +summary: Learn how to use the My TiDB Page to manage your TiDB resources and projects. +--- + +# Use the My TiDB Page to manage your TiDB resources and projects + +In the [TiDB Cloud console](https://tidbcloud.com/), [**My TiDB**](https://tidbcloud.com/tidbs) is a centralized page for all TiDB resources and projects that you can access within the current organization, helping you easily discover, access, and manage your TiDB resources. + +## What are TiDB resources and projects? + +## TiDB resources + +In TiDB Cloud, a TiDB resource is a manageable TiDB deployment unit. It can be one of the following: + +- A {{{ .starter }}}, {{{ .essential }}}, or {{{ .premium }}} [instance](/tidb-cloud/tidb-cloud-glossary.md#instance) +- A {{{ .dedicated }}} [cluster](/tidb-cloud/tidb-cloud-glossary.md#cluster) + +## TiDB projects + +In TiDB Cloud, you can use [projects](/tidb-cloud/tidb-cloud-glossary.md#project) to group and manage your TiDB resources. + +- For {{{ .starter }}}, Essential, and Premium instances, projects are optional, which means you can either group these instances in a project or keep these instances at the organization level. +- For {{{ .dedicated }}} clusters, projects are required. + +## Create TiDB resources + +To create a TiDB resource, go to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click **Create Resource** in the upper-right corner. + +For more information, see the following documents: + +- [Create a {{{ .starter }}} or Essential Instance](/tidb-cloud/starter/create-tidb-cluster-serverless.md) +- [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md) +- [Create a TiDB Cloud Dedicated Cluster](/tidb-cloud/create-tidb-cluster.md) + +## View and manage TiDB resources + +By default, the [**My TiDB**](https://tidbcloud.com/tidbs) page shows a list of all resources within your current organization that you have permission to access. + +- To open the overview page of a TiDB resource, click the name of the target resource. +- To perform quick actions on a TiDB resource, such as deleting, renaming, and importing data, click **...** in the row of the target resource. +- If your organization has many instances or clusters, you can use the filters at the top of the page to quickly find what you need. + +If you want to view your resources hierarchically by project, click the folder icon above the resource list to switch to the Project view + +- TiDB instances that do not belong to any project are displayed in a default folder named `Global instances - in [Your Org Name]`. +- TiDB instances that belong to specific projects are displayed in their corresponding project folders. +- TiDB Cloud Dedicated clusters are displayed in their corresponding project folders. These folders have a **D** in the folder icon to identify the **Dedicated** project type. + +For more information about project types, see [Project types](/tidb-cloud/tidb-cloud-glossary.md#project-types). + +## Create TiDB projects + +To create a new project, click **...** in the upper-right corner, and then click **Create Project**. For more information, see [Create a project](/tidb-cloud/manage-user-access.md#create-a-project). + +You can also create a project when creating TiDB resources. For more information, see the following documents: + +- [Create a {{{ .starter }}} or Essential Instance](/tidb-cloud/starter/create-tidb-cluster-serverless.md) +- [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md) +- [Create a TiDB Cloud Dedicated Cluster](/tidb-cloud/create-tidb-cluster.md) + +## Manage TiDB projects + +In the Project view, you can click **...** in the row of the target project to perform quick actions on the project, such as renaming the project or inviting members to the project. + +For **Dedicated** projects, you can also click the gear icon in the row of the target project to access more project management operations, such as managing networks, alert subscriptions, and project members. + +For more information, see [Manage project access](/tidb-cloud/manage-user-access.md) \ No newline at end of file diff --git a/tidb-cloud/tidb-cloud-glossary.md b/tidb-cloud/tidb-cloud-glossary.md index 83280669d6bc8..0867be73386e0 100644 --- a/tidb-cloud/tidb-cloud-glossary.md +++ b/tidb-cloud/tidb-cloud-glossary.md @@ -29,6 +29,12 @@ Chat2Query is an AI-powered feature integrated into SQL Editor that assists user In addition, TiDB Cloud provides a Chat2Query API for {{{ .starter }}} clusters hosted on AWS. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md). +### Cluster + +In TiDB Cloud, a cluster is a dedicated cloud deployment that includes explicit infrastructure details such as node topology, instance types, storage configuration, and scaling model. + +Among TiDB Cloud plans, only TiDB Cloud Dedicated clusters use this deployment model. + ### Credit TiDB Cloud offers a certain number of credits for Proof of Concept (PoC) users. One credit is equivalent to one U.S. dollar. You can use credits to pay TiDB cluster fees before the credits become expired. @@ -67,6 +73,15 @@ Unlike [Vector Search](/ai/concepts/vector-search-overview.md), which focuses on For more information, see [Full-Text Search with SQL](https://docs.pingcap.com/developer/vector-search-full-text-search-sql) and [Full-Text Search with Python](https://docs.pingcap.com/developer/vector-search-full-text-search-python). +## I + +### Instance + +An instance is a [TiDB X](/tidb-cloud/tidb-x-architecture.md) cloud deployment that represents a service-oriented TiDB offering. With this deployment model, users do not need to manage or understand the underlying cluster topology. +In TiDB Cloud product options, {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances use this deployment method. + +Among TiDB Cloud plans, {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances use this deployment model. + ## M ### member @@ -109,7 +124,18 @@ A document that defines permissions applying to a role, user, or organization, s ### project -Based on the projects created by the organization, resources such as personnel, instances, and networks can be managed separately according to projects, and resources between projects do not interfere with each other. +In TiDB Cloud, you can use projects to group and manage your TiDB resources. + +- For {{{ .starter }}}, Essential, and Premium instances, projects are optional, which means you can either group these instances in a project or keep these instances at the organization level. +- For {{{ .dedicated }}} clusters, projects are required. + +The function of a project varies by project type. Currently, there are three types of projects: + +- TiDB X project: this is the default project type when you create a project on the [My TiDB](/tidb-cloud/my-tidb.md) page. In this type of project, you can only add {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances. +- TiDB Dedicated project: this project type is used only for {{{ .dedicated }}} clusters. In this type of project, you can only add {{{ .dedicated }}} clusters. Within your organization, settings and access controls such as networks, maintenance, alert subscriptions, and encryption access can be managed separately by project, and configurations in different projects do not affect each other. +- TiDB virtual project: this is a virtual project. It is not displayed in the [TiDB Cloud console](https://tidbcloud.com/) and does not provide any management capabilities. Its acts a virtual container for {{{ .starter }}}, {{{ .essential }}}, and {{{ .premium }}} instances that do not belong to any project, so that these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. + +For more information about the differences between these project types, see [Project types](/tidb-cloud/manage-user-access.md#project-types). ### project members @@ -139,6 +165,13 @@ A separate database that can be located in the same or different region and cont TiDB Cloud measures the capacity of [changefeeds](/tidb-cloud/changefeed-overview.md) in TiCDC Replication Capacity Units (RCUs). When you create a changefeed for a cluster, you can select an appropriate specification. The higher the RCU, the better the replication performance. You will be charged for these TiCDC changefeed RCUs. For more information, see [Changefeed Cost](https://www.pingcap.com/tidb-dedicated-pricing-details/#changefeed-cost). +### Resource + +A TiDB resource is a manageable TiDB deployment unit. It can be one of the following: + +- A {{{ .starter }}}, {{{ .essential }}}, or {{{ .premium }}} [instance](#instance) +- A {{{ .dedicated }}} [cluster](#cluster) + ### Request Capacity Unit (RCU) A Request Capacity Unit (RCU) is a unit of measure used to represent the provisioned compute capacity for your {{{ .essential }}} cluster. One RCU provides a fixed amount of compute resources that can process a certain number of RUs per second. The number of RCUs you provision determines your cluster's baseline performance and throughput capacity. For more information, see [{{{ .essential }}} Pricing Details](https://www.pingcap.com/tidb-cloud-essential-pricing-details/).