Skip to content

v7.5: use a variable to refer to TiDB Cloud Serverless #21292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: release-7.5
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
- Develop
- [Overview](/develop/dev-guide-overview.md)
- Quick Start
- [Build a TiDB Cloud Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
- [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
- [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md)
- Example Applications
- Java
Expand Down
8 changes: 4 additions & 4 deletions _docHome.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ hide_leftNav: true
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.
---

<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">
<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">

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

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

</DocHomeCard>

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

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

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

</DocHomeCard>

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

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

</DocHomeCard>

Expand Down
10 changes: 5 additions & 5 deletions develop/dev-guide-aws-appflow-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ summary: Introduce how to integrate TiDB with Amazon AppFlow step by step.

[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.

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

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.
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.

## Prerequisites

Expand Down Expand Up @@ -66,7 +66,7 @@ git clone https://github.com/pingcap-inc/tidb-appflow-integration
>
> - 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.
> - `stack_name` specifies the name of AWS Lambda that you are deploying.
> - 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.
> - 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.
> - 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.

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

5. After the `sf_account` table is created, click **Connect**. A connection dialog is displayed.
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**.
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**.

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

Expand Down Expand Up @@ -244,7 +244,7 @@ test> SELECT * FROM sf_account;

- 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.
- 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/).
- [TiDB Cloud Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) is **NOT** a production environment.
- [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) is **NOT** a production environment.
- 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.

## Need help?
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-bookshop-schema-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ You can delete the original table structure through the `--drop-tables` paramete

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

- **Import File Count**: for TiDB Cloud Serverless, select **Multiple files**. This field is not available in TiDB Cloud Dedicated.
- **Import File Count**: for {{{ .starter }}}, select **Multiple files**. This field is not available in TiDB Cloud Dedicated.
- **Included Schema Files**: select **Yes**.
- **Data Format**: select **SQL**.
- **Folder URI**: enter `s3://developer.pingcap.com/bookshop/`.
Expand Down
26 changes: 13 additions & 13 deletions develop/dev-guide-build-cluster-in-cloud.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: Build a TiDB Cloud Serverless Cluster
summary: Learn how to build a TiDB Cloud Serverless cluster in TiDB Cloud and connect to it.
title: Build a {{{ .starter }}} Cluster
summary: Learn how to build a {{{ .starter }}} cluster in TiDB Cloud and connect to it.
---

<!-- markdownlint-disable MD029 -->

# Build a TiDB Cloud Serverless Cluster
# Build a {{{ .starter }}} Cluster

<CustomContent platform="tidb">

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.
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.

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

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

</CustomContent>

## Step 1. Create a TiDB Cloud Serverless cluster
## Step 1. Create a {{{ .starter }}} cluster {#step-1-create-a-tidb-cloud-cluster}

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

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

4. On the **Create Cluster** page, **Serverless** is selected by default. Update the default cluster name if necessary, and then select the [cluster plan](https://docs.pingcap.com/tidbcloud/select-cluster-tier#cluster-plans).

5. Click **Create** to create a TiDB Cloud Serverless cluster.
5. Click **Create** to create a {{{ .starter }}} cluster.

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

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

> **Note:**
>
> 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).
> 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).

</CustomContent>

<CustomContent platform="tidb-cloud">

> **Note:**
>
> 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).
> 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).

</CustomContent>

Expand Down Expand Up @@ -130,7 +130,7 @@ mysql Ver 15.1 Distrib 5.5.68-MariaDB, for Linux (x86_64) using readline 5.1

</SimpleTab>

2. Run the connection string obtained in [Step 1](#step-1-create-a-tidb-cloud-serverless-cluster).
2. Run the connection string obtained in [Step 1](#step-1-create-a-tidb-cloud-cluster).

{{< copyable "shell-regular" >}}

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

> **Note:**
>
> - 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).
> - 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.
> - When you connect to a {{{ .starter }}} cluster, you must [use the TLS connection](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-clusters).
> - 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.

</CustomContent>

<CustomContent platform="tidb-cloud">

> **Note:**
>
> - When you connect to a TiDB Cloud Serverless cluster, you must [use the TLS connection](/tidb-cloud/secure-connections-to-serverless-clusters.md).
> - 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.
> - When you connect to a {{{ .starter }}} cluster, you must [use the TLS connection](/tidb-cloud/secure-connections-to-serverless-clusters.md).
> - 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.

</CustomContent>

Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-create-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document describes how to create a database using SQL and various programmi

Before creating a database, do the following:

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

## What is database
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-create-secondary-indexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document describes how to create a secondary index using SQL and various pr

Before creating a secondary index, do the following:

- [Build a TiDB Cloud Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md).
- [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md).
- 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).
Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-create-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document introduces how to create tables using the SQL statement and the re

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

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

Expand Down Expand Up @@ -290,7 +290,7 @@ ALTER TABLE `bookshop`.`ratings` SET TIFLASH REPLICA 1;

> **Note:**
>
> 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**.
> 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-cluster) to create a {{{ .starter }}} cluster that includes **TiFlash**.

Then you can go on to perform the following query:

Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-delete-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document describes how to use the [DELETE](/sql-statements/sql-statement-de

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

- [Build a TiDB Cloud Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
- [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
- 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)
- [Insert Data](/develop/dev-guide-insert-data.md)

Expand Down
14 changes: 7 additions & 7 deletions develop/dev-guide-gui-datagrip.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ TiDB is a MySQL-compatible database, and [JetBrains DataGrip](https://www.jetbra

> **Note:**
>
> This tutorial is compatible with TiDB Cloud Serverless, TiDB Cloud Dedicated, and TiDB Self-Managed.
> This tutorial is compatible with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed.

You can use DataGrip in two ways:

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

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

- (Recommended) Follow [Creating a TiDB Cloud Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster.
- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster.
- 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.

</CustomContent>
<CustomContent platform="tidb-cloud">

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

- (Recommended) Follow [Creating a TiDB Cloud Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster.
- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster.
- 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.

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

<SimpleTab>
<div label="TiDB Cloud Serverless">
<div label="{{{ .starter }}}">

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.

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

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:

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

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

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

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

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

Expand Down
Loading
Loading