Skip to content

Commit c733f0d

Browse files
committed
TiDB Cloud Serverless -> {{{ .starter }}}
1 parent ca0f4cf commit c733f0d

File tree

104 files changed

+372
-372
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+372
-372
lines changed

TOC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
- Develop
2020
- [Overview](/develop/dev-guide-overview.md)
2121
- Quick Start
22-
- [Build a TiDB Cloud Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
22+
- [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
2323
- [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md)
2424
- Example Applications
2525
- Java

_docHome.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hide_leftNav: true
66
summary: TiDB Documentation provides how-to guides and references for using TiDB Cloud and TiDB Self-Managed, including data migration and application building. TiDB Cloud is a fully-managed Database-as-a-Service, offering easy access to the power of a cloud-native, distributed SQL database. TiDB is an open-source distributed SQL database with MySQL compatibility, horizontal scalability, and high availability. Developers can access documentation for application development and explore additional resources such as TiDB Playground, PingCAP Education, and community engagement opportunities.
77
---
88

9-
<DocHomeContainer title="TiDB Documentation" subTitle="Explore the how-to guides and references you need to use TiDB Cloud Serverless, TiDB Cloud Dedicated and TiDB Self-Managed, migrate data, and build your applications on the database." ctaLabel="Start TiDB Cloud Serverless for Free" ctaLink="https://tidbcloud.com/free-trial">
9+
<DocHomeContainer title="TiDB Documentation" subTitle="Explore the how-to guides and references you need to use {{{ .starter }}} , TiDB Cloud Dedicated and TiDB Self-Managed, migrate data, and build your applications on the database." ctaLabel="Start {{{ .starter }}} for Free" ctaLink="https://tidbcloud.com/free-trial">
1010

1111
<DocHomeSection label="TiDB Cloud" anchor="tidb-cloud" id="tidb-cloud">
1212

@@ -20,7 +20,7 @@ Learn what TiDB Cloud is as an easy-to-use database and its key features.
2020

2121
</DocHomeCard>
2222

23-
<DocHomeCard href="/tidbcloud/tidb-cloud-quickstart" label="Get started with TiDB Cloud Serverless" icon="cloud-getstarted-mauve">
23+
<DocHomeCard href="/tidbcloud/tidb-cloud-quickstart" label="Get started with {{{ .starter }}} " icon="cloud-getstarted-mauve">
2424

2525
Guide for an easy way to get started with TiDB Cloud.
2626

@@ -32,9 +32,9 @@ Connect your application with the languages and frameworks you prefer.
3232

3333
</DocHomeCard>
3434

35-
<DocHomeCard href="/tidbcloud/vector-search-overview" label="Vector Search in TiDB Cloud Serverless (Beta)" icon="cloud-vector-mauve">
35+
<DocHomeCard href="/tidbcloud/vector-search-overview" label="Vector Search in {{{ .starter }}} (Beta)" icon="cloud-vector-mauve">
3636

37-
Explore native support of Vector Search in TiDB Cloud Serverless to build your AI application.
37+
Explore native support of Vector Search in {{{ .starter }}} to build your AI application.
3838

3939
</DocHomeCard>
4040

develop/dev-guide-aws-appflow-integration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ summary: Introduce how to integrate TiDB with Amazon AppFlow step by step.
77

88
[Amazon AppFlow](https://aws.amazon.com/appflow/) is a fully managed API integration service that you use to connect your software as a service (SaaS) applications to AWS services, and securely transfer data. With Amazon AppFlow, you can import and export data from and to TiDB into many types of data providers, such as Salesforce, Amazon S3, LinkedIn, and GitHub. For more information, see [Supported source and destination applications](https://docs.aws.amazon.com/appflow/latest/userguide/app-specific.html) in AWS documentation.
99

10-
This document describes how to integrate TiDB with Amazon AppFlow and takes integrating a TiDB Cloud Serverless cluster as an example.
10+
This document describes how to integrate TiDB with Amazon AppFlow and takes integrating a {{{ .starter }}} cluster as an example.
1111

12-
If you do not have a TiDB cluster, you can create a [TiDB Cloud Serverless](https://tidbcloud.com/console/clusters) cluster, which is free and can be created in approximately 30 seconds.
12+
If you do not have a TiDB cluster, you can create a [{{{ .starter }}} ](https://tidbcloud.com/console/clusters) cluster, which is free and can be created in approximately 30 seconds.
1313

1414
## Prerequisites
1515

@@ -66,7 +66,7 @@ git clone https://github.com/pingcap-inc/tidb-appflow-integration
6666
>
6767
> - The `--guided` option uses prompts to guide you through the deployment. Your input will be stored in a configuration file, which is `samconfig.toml` by default.
6868
> - `stack_name` specifies the name of AWS Lambda that you are deploying.
69-
> - This prompted guide uses AWS as the cloud provider of TiDB Cloud Serverless. To use Amazon S3 as the source or destination, you need to set the `region` of AWS Lambda as the same as that of Amazon S3.
69+
> - This prompted guide uses AWS as the cloud provider of {{{ .starter }}} . To use Amazon S3 as the source or destination, you need to set the `region` of AWS Lambda as the same as that of Amazon S3.
7070
> - If you have already run `sam deploy --guided` before, you can just run `sam deploy` instead, and SAM CLI will use the configuration file `samconfig.toml` to simplify the interaction.
7171

7272
If you see a similar output as follows, this Lambda is successfully deployed.
@@ -148,7 +148,7 @@ Choose the **Source details** and **Destination details**. TiDB connector can be
148148
```
149149

150150
5. After the `sf_account` table is created, click **Connect**. A connection dialog is displayed.
151-
6. In the **Connect to TiDB-Connector** dialog, enter the connection properties of the TiDB cluster. If you use a TiDB Cloud Serverless cluster, you need to set the **TLS** option to `Yes`, which lets the TiDB connector use the TLS connection. Then, click **Connect**.
151+
6. In the **Connect to TiDB-Connector** dialog, enter the connection properties of the TiDB cluster. If you use a {{{ .starter }}} cluster, you need to set the **TLS** option to `Yes`, which lets the TiDB connector use the TLS connection. Then, click **Connect**.
152152

153153
![tidb connection message](/media/develop/aws-appflow-step-tidb-connection-message.png)
154154

@@ -244,7 +244,7 @@ test> SELECT * FROM sf_account;
244244

245245
- If anything goes wrong, you can navigate to the [CloudWatch](https://console.aws.amazon.com/cloudwatch/home) page on the AWS Management Console to get logs.
246246
- The steps in this document are based on [Building custom connectors using the Amazon AppFlow Custom Connector SDK](https://aws.amazon.com/blogs/compute/building-custom-connectors-using-the-amazon-appflow-custom-connector-sdk/).
247-
- [TiDB Cloud Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) is **NOT** a production environment.
247+
- [{{{ .starter }}} ](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) is **NOT** a production environment.
248248
- To prevent excessive length, the examples in this document only show the `Insert` strategy, but `Update` and `Upsert` strategies are also tested and can be used.
249249

250250
## Need help?

develop/dev-guide-bookshop-schema-design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ You can delete the original table structure through the `--drop-tables` paramete
103103

104104
3. On the **Import Data from Amazon S3** page, configure the following source data information:
105105

106-
- **Import File Count**: for TiDB Cloud Serverless, select **Multiple files**. This field is not available in TiDB Cloud Dedicated.
106+
- **Import File Count**: for {{{ .starter }}} , select **Multiple files**. This field is not available in TiDB Cloud Dedicated.
107107
- **Included Schema Files**: select **Yes**.
108108
- **Data Format**: select **SQL**.
109109
- **Folder URI**: enter `s3://developer.pingcap.com/bookshop/`.

develop/dev-guide-build-cluster-in-cloud.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: Build a TiDB Cloud Serverless Cluster
3-
summary: Learn how to build a TiDB Cloud Serverless cluster in TiDB Cloud and connect to it.
2+
title: Build a {{{ .starter }}} Cluster
3+
summary: Learn how to build a {{{ .starter }}} cluster in TiDB Cloud and connect to it.
44
---
55

66
<!-- markdownlint-disable MD029 -->
77

8-
# Build a TiDB Cloud Serverless Cluster
8+
# Build a {{{ .starter }}} Cluster
99

1010
<CustomContent platform="tidb">
1111

12-
This document walks you through the quickest way to get started with TiDB. You will use [TiDB Cloud](https://www.pingcap.com/tidb-cloud) to create a TiDB Cloud Serverless cluster, connect to it, and run a sample application on it.
12+
This document walks you through the quickest way to get started with TiDB. You will use [TiDB Cloud](https://www.pingcap.com/tidb-cloud) to create a {{{ .starter }}} cluster, connect to it, and run a sample application on it.
1313

1414
If you need to run TiDB on your local machine, see [Starting TiDB Locally](/quick-start-with-tidb.md).
1515

@@ -21,7 +21,7 @@ This document walks you through the quickest way to get started with TiDB Cloud.
2121

2222
</CustomContent>
2323

24-
## Step 1. Create a TiDB Cloud Serverless cluster
24+
## Step 1. Create a {{{ .starter }}} cluster
2525

2626
1. If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/free-trial) to sign up for an account.
2727

@@ -31,7 +31,7 @@ This document walks you through the quickest way to get started with TiDB Cloud.
3131

3232
4. On the **Create Cluster** page, **Serverless** is selected by default. Update the default cluster name if necessary, and then select the region where you want to create your cluster.
3333

34-
5. Click **Create** to create a TiDB Cloud Serverless cluster.
34+
5. Click **Create** to create a {{{ .starter }}} cluster.
3535

3636
Your TiDB Cloud cluster will be created in approximately 30 seconds.
3737

@@ -45,15 +45,15 @@ This document walks you through the quickest way to get started with TiDB Cloud.
4545

4646
> **Note:**
4747
>
48-
> For [TiDB Cloud Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters, when you connect to your cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](https://docs.pingcap.com/tidbcloud/select-cluster-tier#user-name-prefix).
48+
> For [{{{ .starter }}} ](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters, when you connect to your cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](https://docs.pingcap.com/tidbcloud/select-cluster-tier#user-name-prefix).
4949
5050
</CustomContent>
5151

5252
<CustomContent platform="tidb-cloud">
5353

5454
> **Note:**
5555
>
56-
> For [TiDB Cloud Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters, when you connect to your cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix).
56+
> For [{{{ .starter }}} ](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters, when you connect to your cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix).
5757
5858
</CustomContent>
5959

@@ -142,17 +142,17 @@ mysql Ver 15.1 Distrib 5.5.68-MariaDB, for Linux (x86_64) using readline 5.1
142142

143143
> **Note:**
144144
>
145-
> - When you connect to a TiDB Cloud Serverless cluster, you must [use the TLS connection](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-clusters).
146-
> - If you encounter problems when connecting to a TiDB Cloud Serverless cluster, you can read [Secure Connections to TiDB Cloud Serverless Clusters](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-clusters) for more information.
145+
> - When you connect to a {{{ .starter }}} cluster, you must [use the TLS connection](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-clusters).
146+
> - If you encounter problems when connecting to a {{{ .starter }}} cluster, you can read [Secure Connections to {{{ .starter }}} Clusters](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-clusters) for more information.
147147

148148
</CustomContent>
149149

150150
<CustomContent platform="tidb-cloud">
151151

152152
> **Note:**
153153
>
154-
> - When you connect to a TiDB Cloud Serverless cluster, you must [use the TLS connection](/tidb-cloud/secure-connections-to-serverless-clusters.md).
155-
> - If you encounter problems when connecting to a TiDB Cloud Serverless cluster, you can read [Secure Connections to TiDB Cloud Serverless Clusters](/tidb-cloud/secure-connections-to-serverless-clusters.md) for more information.
154+
> - When you connect to a {{{ .starter }}} cluster, you must [use the TLS connection](/tidb-cloud/secure-connections-to-serverless-clusters.md).
155+
> - If you encounter problems when connecting to a {{{ .starter }}} cluster, you can read [Secure Connections to {{{ .starter }}} Clusters](/tidb-cloud/secure-connections-to-serverless-clusters.md) for more information.
156156

157157
</CustomContent>
158158

develop/dev-guide-create-database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This document describes how to create a database using SQL and various programmi
1111

1212
Before creating a database, do the following:
1313

14-
- [Build a TiDB Cloud Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md).
14+
- [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md).
1515
- Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md).
1616

1717
## What is database

develop/dev-guide-create-secondary-indexes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This document describes how to create a secondary index using SQL and various pr
1111

1212
Before creating a secondary index, do the following:
1313

14-
- [Build a TiDB Cloud Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md).
14+
- [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md).
1515
- Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md).
1616
- [Create a Database](/develop/dev-guide-create-database.md).
1717
- [Create a Table](/develop/dev-guide-create-table.md).

develop/dev-guide-create-table.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This document introduces how to create tables using the SQL statement and the re
1111

1212
Before reading this document, make sure that the following tasks are completed:
1313

14-
- [Build a TiDB Cloud Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md).
14+
- [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md).
1515
- Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md).
1616
- [Create a Database](/develop/dev-guide-create-database.md).
1717

@@ -292,7 +292,7 @@ ALTER TABLE `bookshop`.`ratings` SET TIFLASH REPLICA 1;
292292

293293
> **Note:**
294294
>
295-
> If your cluster does not contain **TiFlash** nodes, this SQL statement will report an error: `1105 - the tiflash replica count: 1 should be less than the total tiflash server count: 0`. You can use [Build a TiDB Cloud Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-cloud-serverless-cluster) to create a TiDB Cloud Serverless cluster that includes **TiFlash**.
295+
> If your cluster does not contain **TiFlash** nodes, this SQL statement will report an error: `1105 - the tiflash replica count: 1 should be less than the total tiflash server count: 0`. You can use [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-cloud-serverless-cluster) to create a {{{ .starter }}} cluster that includes **TiFlash**.
296296
297297
Then you can go on to perform the following query:
298298

develop/dev-guide-delete-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This document describes how to use the [DELETE](/sql-statements/sql-statement-de
1111

1212
Before reading this document, you need to prepare the following:
1313

14-
- [Build a TiDB Cloud Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
14+
- [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
1515
- Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md), [Create a Database](/develop/dev-guide-create-database.md), [Create a Table](/develop/dev-guide-create-table.md), and [Create Secondary Indexes](/develop/dev-guide-create-secondary-indexes.md)
1616
- [Insert Data](/develop/dev-guide-insert-data.md)
1717

develop/dev-guide-gui-datagrip.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ TiDB is a MySQL-compatible database, and [JetBrains DataGrip](https://www.jetbra
99

1010
> **Note:**
1111
>
12-
> This tutorial is compatible with TiDB Cloud Serverless, TiDB Cloud Dedicated, and TiDB Self-Managed.
12+
> This tutorial is compatible with {{{ .starter }}} , TiDB Cloud Dedicated, and TiDB Self-Managed.
1313
1414
You can use DataGrip in two ways:
1515

@@ -29,15 +29,15 @@ To complete this tutorial, you need:
2929

3030
**If you don't have a TiDB cluster, you can create one as follows:**
3131

32-
- (Recommended) Follow [Creating a TiDB Cloud Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster.
32+
- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster.
3333
- Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster.
3434

3535
</CustomContent>
3636
<CustomContent platform="tidb-cloud">
3737

3838
**If you don't have a TiDB cluster, you can create one as follows:**
3939

40-
- (Recommended) Follow [Creating a TiDB Cloud Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster.
40+
- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster.
4141
- Follow [Deploy a local test TiDB cluster](https://docs.pingcap.com/tidb/stable/quick-start-with-tidb#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](https://docs.pingcap.com/tidb/stable/production-deployment-using-tiup) to create a local cluster.
4242

4343
</CustomContent>
@@ -47,7 +47,7 @@ To complete this tutorial, you need:
4747
Connect to your TiDB cluster depending on the TiDB deployment option you've selected.
4848

4949
<SimpleTab>
50-
<div label="TiDB Cloud Serverless">
50+
<div label="{{{ .starter }}} ">
5151

5252
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page.
5353

@@ -76,13 +76,13 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
7676

7777
7. Copy the connection string from the TiDB Cloud connection dialog. Then, paste it into the **URL** field, and the remaining parameters will be auto-populated. An example result is as follows:
7878

79-
![Configure the URL field for TiDB Cloud Serverless](/media/develop/datagrip-url-paste.jpg)
79+
![Configure the URL field for {{{ .starter }}} ](/media/develop/datagrip-url-paste.jpg)
8080

8181
If a **Download missing driver files** warning displays, click **Download** to acquire the driver files.
8282

83-
8. Click **Test Connection** to validate the connection to the TiDB Cloud Serverless cluster.
83+
8. Click **Test Connection** to validate the connection to the {{{ .starter }}} cluster.
8484

85-
![Test the connection to a TiDB Cloud Serverless cluster](/media/develop/datagrip-test-connection.jpg)
85+
![Test the connection to a {{{ .starter }}} cluster](/media/develop/datagrip-test-connection.jpg)
8686

8787
9. Click **OK** to save the connection configuration.
8888

0 commit comments

Comments
 (0)