From a5b6a35c7d81195691ff8b3db93dc350e56f1a59 Mon Sep 17 00:00:00 2001 From: Aolin Date: Wed, 15 Apr 2026 12:00:44 +0800 Subject: [PATCH 1/2] variables: add premium --- variables.json | 1 + 1 file changed, 1 insertion(+) diff --git a/variables.json b/variables.json index 693dde8ef357..69725338bda6 100644 --- a/variables.json +++ b/variables.json @@ -5,5 +5,6 @@ "starter": "TiDB Cloud Starter", "essential": "TiDB Cloud Essential", "dedicated": "TiDB Cloud Dedicated", + "premium": "TiDB Cloud Premium", "console-url": "tidbcloud.com" } From 7b92f36cb0c7bbb2392925a5974a3b584188bc94 Mon Sep 17 00:00:00 2001 From: Aolin Date: Wed, 15 Apr 2026 12:01:00 +0800 Subject: [PATCH 2/2] develop: add documents for TiDB Cloud Premium --- develop/dev-guide-gui-mysql-workbench.md | 38 +++++++++++- develop/dev-guide-gui-navicat.md | 40 ++++++++++++- ...dev-guide-sample-application-aws-lambda.md | 51 ++++++++++++++-- ...ev-guide-sample-application-golang-gorm.md | 45 +++++++++++++- ...de-sample-application-golang-sql-driver.md | 44 +++++++++++++- ...guide-sample-application-java-hibernate.md | 45 +++++++++++++- .../dev-guide-sample-application-java-jdbc.md | 46 ++++++++++++++- ...v-guide-sample-application-java-mybatis.md | 44 +++++++++++++- ...ide-sample-application-java-spring-boot.md | 44 +++++++++++++- .../dev-guide-sample-application-nextjs.md | 58 ++++++++++++++++++- ...-guide-sample-application-nodejs-mysql2.md | 42 +++++++++++++- ...guide-sample-application-nodejs-mysqljs.md | 43 +++++++++++++- ...-guide-sample-application-nodejs-prisma.md | 47 ++++++++++++++- ...ide-sample-application-nodejs-sequelize.md | 43 +++++++++++++- ...guide-sample-application-nodejs-typeorm.md | 43 +++++++++++++- ...-guide-sample-application-python-django.md | 44 +++++++++++++- ...mple-application-python-mysql-connector.md | 44 +++++++++++++- ...e-sample-application-python-mysqlclient.md | 45 +++++++++++++- ...-guide-sample-application-python-peewee.md | 44 +++++++++++++- ...guide-sample-application-python-pymysql.md | 44 +++++++++++++- ...de-sample-application-python-sqlalchemy.md | 44 +++++++++++++- ...ev-guide-sample-application-ruby-mysql2.md | 43 +++++++++++++- ...dev-guide-sample-application-ruby-rails.md | 38 +++++++++++- 23 files changed, 990 insertions(+), 29 deletions(-) diff --git a/develop/dev-guide-gui-mysql-workbench.md b/develop/dev-guide-gui-mysql-workbench.md index 3f53e2fc4e72..8d35a0a15c39 100644 --- a/develop/dev-guide-gui-mysql-workbench.md +++ b/develop/dev-guide-gui-mysql-workbench.md @@ -17,7 +17,7 @@ TiDB 是一个兼容 MySQL 的数据库。[MySQL Workbench](https://www.mysql.co > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -77,6 +77,42 @@ TiDB 是一个兼容 MySQL 的数据库。[MySQL Workbench](https://www.mysql.co 8. 如果连接测试成功,你可以看到 **Successfully made the MySQL connection** 信息。点击 **OK** 保存连接配置。 + +
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 启动 MySQL Workbench,并点击 **MySQL Connections** 标题旁边的 **+**。 + +8. 在 **Setup New Connection** 对话框中,配置以下连接参数: + + - **Connection Name**:为该连接指定一个有意义的名称。 + - **Hostname**:输入从 TiDB Cloud 连接对话框中获取的 `HOST` 参数。 + - **Port**:输入从 TiDB Cloud 连接对话框中获取的 `PORT` 参数。 + - **Username**:输入从 TiDB Cloud 连接对话框中获取的 `USERNAME` 参数。 + - **Password**:点击 **Store in Keychain ...** 或 **Store in Vault**,输入 {{{ .premium }}} 实例的密码,然后点击 **OK** 保存密码。 + +9. 点击 **Test Connection** 以验证与 {{{ .premium }}} 实例的连接。 + +10. 如果连接测试成功,你可以看到 **Successfully made the MySQL connection** 信息。点击 **OK** 保存连接配置。 +
diff --git a/develop/dev-guide-gui-navicat.md b/develop/dev-guide-gui-navicat.md index 27b18215f16a..7cc45d05771f 100644 --- a/develop/dev-guide-gui-navicat.md +++ b/develop/dev-guide-gui-navicat.md @@ -12,7 +12,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Navicat](https://www.navicat.com) 是 > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -73,6 +73,44 @@ TiDB 是一个兼容 MySQL 的数据库。[Navicat](https://www.navicat.com) 是 9. 如果连接测试成功,你可以看到 **Connection Successful** 信息。点击 **OK** 完成连接配置。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 启动 Navicat Premium,点击左上角的 **Connection**,在 **Vendor Filter** 中勾选 **PingCAP**,并双击右侧面板中的 **TiDB**。 + +8. 在 **New Connection (TiDB)** 对话框中,配置以下连接参数: + + - **Connection Name**:为该连接指定一个有意义的名称。 + - **Host**:输入从 TiDB Cloud 连接对话框中获取的 `HOST` 参数。 + - **Port**:输入从 TiDB Cloud 连接对话框中获取的 `PORT` 参数。 + - **User Name**:输入从 TiDB Cloud 连接对话框中获取的 `USERNAME` 参数。 + - **Password**:输入 {{{ .premium }}} 实例的密码。 + +9. 点击 **SSL** 选项卡,取消选择 **Use SSL** 复选框。 + +10. 点击 **Test Connection** 以验证与 {{{ .premium }}} 实例的连接。 + +11. 如果连接测试成功,你可以看到 **Connection Successful** 信息。点击 **OK** 完成连接配置。 +
diff --git a/develop/dev-guide-sample-application-aws-lambda.md b/develop/dev-guide-sample-application-aws-lambda.md index f125cefbda5d..21d5b596c841 100644 --- a/develop/dev-guide-sample-application-aws-lambda.md +++ b/develop/dev-guide-sample-application-aws-lambda.md @@ -17,7 +17,7 @@ TiDB 是一个兼容 MySQL 的数据库。[AWS Lambda 函数](https://aws.amazon > **Note** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}} 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}} 和本地部署的 TiDB。 ## 前置需求 @@ -99,13 +99,53 @@ npm install "TIDB_HOST": "{gateway-region}.aws.tidbcloud.com", "TIDB_PORT": "4000", "TIDB_USER": "{prefix}.root", - "TIDB_PASSWORD": "{password}" + "TIDB_PASSWORD": "{password}", + "TIDB_ENABLE_SSL": "true" } } ```
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 复制并粘贴对应连接字符串至 `env.json`。示例如下: + + ```json + { + "Parameters": { + "TIDB_HOST": "{host}", + "TIDB_PORT": "4000", + "TIDB_USER": "root", + "TIDB_PASSWORD": "{password}", + "TIDB_ENABLE_SSL": "false" + } + } + ``` + + 将占位符 `{}` 替换为从连接对话框中复制的参数值。 + +
+
编辑 `env.json` 文件,按照如下格式设置连接信息,将占位符 `{}` 替换为你的 TiDB 集群的连接参数值: @@ -116,7 +156,8 @@ npm install "TIDB_HOST": "{tidb_server_host}", "TIDB_PORT": "4000", "TIDB_USER": "root", - "TIDB_PASSWORD": "{password}" + "TIDB_PASSWORD": "{password}", + "TIDB_ENABLE_SSL": "false" } } ``` @@ -270,10 +311,10 @@ function connect() { user: process.env.TIDB_USER, // TiDB user, for example: {prefix}.root password: process.env.TIDB_PASSWORD, // TiDB password database: process.env.TIDB_DATABASE || 'test', // TiDB database name, default: test - ssl: { + ssl: process.env.TIDB_ENABLE_SSL === 'true' ? { minVersion: 'TLSv1.2', rejectUnauthorized: true, - }, + } : null, connectionLimit: 1, // Setting connectionLimit to "1" in a serverless function environment optimizes resource usage, reduces costs, ensures connection stability, and enables seamless scalability. maxIdle: 1, // max idle connections, the default value is the same as `connectionLimit` enableKeepAlive: true, diff --git a/develop/dev-guide-sample-application-golang-gorm.md b/develop/dev-guide-sample-application-golang-gorm.md index f3c95ec10e14..67028fb85045 100644 --- a/develop/dev-guide-sample-application-golang-gorm.md +++ b/develop/dev-guide-sample-application-golang-gorm.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[GORM](https://gorm.io/index.html) 是 > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -91,6 +91,49 @@ cd tidb-golang-gorm-quickstart 7. 保存 `.env` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 复制并粘贴对应连接字符串至 `.env` 中。示例结果如下: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + USE_SSL='false' + ``` + + 注意替换 `{}` 中的占位符为连接对话框中获得的值。 + +9. 保存 `.env` 文件。 +
diff --git a/develop/dev-guide-sample-application-golang-sql-driver.md b/develop/dev-guide-sample-application-golang-sql-driver.md index 120c50fc8ab9..f1f940a7fa10 100644 --- a/develop/dev-guide-sample-application-golang-sql-driver.md +++ b/develop/dev-guide-sample-application-golang-sql-driver.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Go-MySQL-Driver](https://github.com/g > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -92,7 +92,49 @@ cd tidb-golang-sql-driver-quickstart 7. 保存 `.env` 文件。
+
+1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 复制并粘贴对应连接字符串至 `.env` 中。示例结果如下: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + USE_SSL='false' + ``` + + 注意替换 `{}` 中的占位符为连接对话框中获得的值。 + +9. 保存 `.env` 文件。 + +
1. 在 TiDB Cloud 的 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,选择你的 TiDB Cloud Dedicated 集群,进入集群的 **Overview** 页面。 diff --git a/develop/dev-guide-sample-application-java-hibernate.md b/develop/dev-guide-sample-application-java-hibernate.md index 50c8842b4949..fcdc72272190 100644 --- a/develop/dev-guide-sample-application-java-hibernate.md +++ b/develop/dev-guide-sample-application-java-hibernate.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Hibernate](https://hibernate.org/orm/ > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -92,6 +92,49 @@ cd tidb-java-hibernate-quickstart 7. 保存 `env.sh` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `env.sh.example` 复制并重命名为 `env.sh`: + + ```shell + cp env.sh.example env.sh + ``` + +8. 复制并粘贴对应连接字符串至 `env.sh` 中。示例结果如下: + + ```shell + export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + export TIDB_PORT='4000' + export TIDB_USER='{user}' # e.g. root + export TIDB_PASSWORD='{password}' + export TIDB_DB_NAME='test' + export USE_SSL='false' + ``` + + 注意替换 `{}` 中的占位符为连接对话框中获得的值。 + +9. 保存 `env.sh` 文件。 +
diff --git a/develop/dev-guide-sample-application-java-jdbc.md b/develop/dev-guide-sample-application-java-jdbc.md index 6e2a7f208885..e31641b565fc 100644 --- a/develop/dev-guide-sample-application-java-jdbc.md +++ b/develop/dev-guide-sample-application-java-jdbc.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。JDBC 是 Java 的数据访问 API。[M > **注意** > -> - 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> - 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 > - 从 TiDB v7.4 起,如果 JDBC URL 中未配置 `connectionCollation`,且 `characterEncoding` 未配置或配置为 `UTF-8`,JDBC 连接所使用的排序规则取决于 JDBC 驱动版本。详情请参考 [JDBC 连接所使用的排序规则](/faq/sql-faq.md#jdbc-连接所使用的排序规则)。 ## 前置需求 @@ -95,6 +95,50 @@ cd tidb-java-jdbc-quickstart
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `env.sh.example` 复制并重命名为 `env.sh`: + + ```shell + cp env.sh.example env.sh + ``` + +8. 复制并粘贴对应连接字符串至 `env.sh` 中。示例结果如下: + + ```shell + export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + export TIDB_PORT='4000' + export TIDB_USER='{user}' # e.g. root + export TIDB_PASSWORD='{password}' + export TIDB_DB_NAME='test' + export USE_SSL='false' + ``` + + 注意替换 `{}` 中的占位符为连接对话框中获得的值。 + +9. 保存 `env.sh` 文件。 + +
+
1. 在 TiDB Cloud 的 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,选择你的 TiDB Cloud Dedicated 集群,进入集群的 **Overview** 页面。 diff --git a/develop/dev-guide-sample-application-java-mybatis.md b/develop/dev-guide-sample-application-java-mybatis.md index cf04ac3893cc..0cf777d8f4d0 100644 --- a/develop/dev-guide-sample-application-java-mybatis.md +++ b/develop/dev-guide-sample-application-java-mybatis.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[MyBatis](https://mybatis.org/mybatis- > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -93,7 +93,49 @@ cd tidb-java-mybatis-quickstart 7. 保存 `env.sh` 文件。
+
+1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `env.sh.example` 复制并重命名为 `env.sh`: + + ```shell + cp env.sh.example env.sh + ``` + +8. 复制并粘贴对应连接字符串至 `env.sh` 中。示例结果如下: + + ```shell + export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + export TIDB_PORT='4000' + export TIDB_USER='{user}' # e.g. root + export TIDB_PASSWORD='{password}' + export TIDB_DB_NAME='test' + export USE_SSL='false' + ``` + + 注意替换 `{}` 中的占位符为连接对话框中获得的值。 + +9. 保存 `env.sh` 文件。 + +
1. 在 TiDB Cloud 的 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,选择你的 TiDB Cloud Dedicated 集群,进入集群的 **Overview** 页面。 diff --git a/develop/dev-guide-sample-application-java-spring-boot.md b/develop/dev-guide-sample-application-java-spring-boot.md index ff2f61bfc93f..c33e83753883 100644 --- a/develop/dev-guide-sample-application-java-spring-boot.md +++ b/develop/dev-guide-sample-application-java-spring-boot.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Spring](https://spring.io/) 是当前 > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -93,7 +93,49 @@ cd tidb-java-springboot-jpa-quickstart 7. 保存 `env.sh` 文件。
+
+1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `env.sh.example` 复制并重命名为 `env.sh`: + + ```shell + cp env.sh.example env.sh + ``` + +8. 复制并粘贴对应连接字符串至 `env.sh` 中。示例结果如下: + + ```shell + export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + export TIDB_PORT='4000' + export TIDB_USER='{user}' # e.g. root + export TIDB_PASSWORD='{password}' + export TIDB_DB_NAME='test' + export USE_SSL='false' + ``` + + 注意替换 `{}` 中的占位符为连接对话框中获得的值。 + +9. 保存 `env.sh` 文件。 + +
1. 在 TiDB Cloud 的 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,选择你的 TiDB Cloud Dedicated 集群,进入集群的 **Overview** 页面。 diff --git a/develop/dev-guide-sample-application-nextjs.md b/develop/dev-guide-sample-application-nextjs.md index e7649a888157..0c0eaf817312 100644 --- a/develop/dev-guide-sample-application-nextjs.md +++ b/develop/dev-guide-sample-application-nextjs.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库,[mysql2](https://github.com/sidorares/ > **Note** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}} 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}} 和本地部署的 TiDB。 ## 前置需求 @@ -105,12 +105,63 @@ npm install TIDB_USER='{prefix}.root' TIDB_PASSWORD='{password}' TIDB_DB_NAME='test' + TIDB_ENABLE_SSL='true' ``` 7. 保存 `.env` 文件。
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```bash + # Linux + cp .env.example .env + ``` + + ```powershell + # Windows + Copy-Item ".env.example" -Destination ".env" + ``` + +8. 复制并粘贴对应连接字符串至 `.env` 中。示例结果如下: + + ```bash + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + TIDB_ENABLE_SSL='false' + ``` + + 将占位符 `{}` 替换为从连接对话框中复制的参数值。 + +9. 保存 `.env` 文件。 + +
+
1. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: @@ -133,6 +184,7 @@ npm install TIDB_USER='root' TIDB_PASSWORD='{password}' TIDB_DB_NAME='test' + TIDB_ENABLE_SSL='false' ``` 如果你在本地运行 TiDB 集群,默认的主机地址是 `127.0.0.1`,密码为空。 @@ -190,10 +242,10 @@ export function connect() { user: process.env.TIDB_USER, // TiDB user, for example: {prefix}.root password: process.env.TIDB_PASSWORD, // The password of TiDB user. database: process.env.TIDB_DATABASE || 'test', // TiDB database name, default: test - ssl: { + ssl: process.env.TIDB_ENABLE_SSL === 'true' ? { minVersion: 'TLSv1.2', rejectUnauthorized: true, - }, + } : null, connectionLimit: 1, // Setting connectionLimit to "1" in a serverless function environment optimizes resource usage, reduces costs, ensures connection stability, and enables seamless scalability. maxIdle: 1, // max idle connections, the default value is the same as `connectionLimit` enableKeepAlive: true, diff --git a/develop/dev-guide-sample-application-nodejs-mysql2.md b/develop/dev-guide-sample-application-nodejs-mysql2.md index 9d638b6b51b0..ebf91eb15984 100644 --- a/develop/dev-guide-sample-application-nodejs-mysql2.md +++ b/develop/dev-guide-sample-application-nodejs-mysql2.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[node-mysql2](https://github.com/sidor > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -107,7 +107,47 @@ npm install mysql2 dotenv --save 7. 保存 `.env` 文件。
+
+1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 编辑 `.env` 文件,按照如下格式设置连接信息,将占位符 `{}` 替换为从连接对话框中复制的参数值: + + ```dotenv + TIDB_HOST={host} + TIDB_PORT=4000 + TIDB_USER={user} + TIDB_PASSWORD={password} + TIDB_DATABASE=test + TIDB_ENABLE_SSL=false + ``` + +9. 保存 `.env` 文件。 + +
1. 在 TiDB Cloud 的 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,选择你的 TiDB Cloud Dedicated 集群,进入集群的 **Overview** 页面。 diff --git a/develop/dev-guide-sample-application-nodejs-mysqljs.md b/develop/dev-guide-sample-application-nodejs-mysqljs.md index a28331366776..51bc588f1748 100644 --- a/develop/dev-guide-sample-application-nodejs-mysqljs.md +++ b/develop/dev-guide-sample-application-nodejs-mysqljs.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[mysql.js](https://github.com/mysqljs/ > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -106,6 +106,47 @@ npm install mysql dotenv --save 7. 保存 `.env` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 编辑 `.env` 文件,按照如下格式设置连接信息,将占位符 `{}` 替换为从连接对话框中复制的参数值: + + ```dotenv + TIDB_HOST={host} + TIDB_PORT=4000 + TIDB_USER={user} + TIDB_PASSWORD={password} + TIDB_DATABASE=test + TIDB_ENABLE_SSL=false + ``` + +9. 保存 `.env` 文件。 +
diff --git a/develop/dev-guide-sample-application-nodejs-prisma.md b/develop/dev-guide-sample-application-nodejs-prisma.md index 100100ab2c5a..0bcd3d7395cd 100644 --- a/develop/dev-guide-sample-application-nodejs-prisma.md +++ b/develop/dev-guide-sample-application-nodejs-prisma.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Prisma](https://www.prisma.io/) 是 > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -109,6 +109,51 @@ npm install prisma typescript ts-node @types/node --save-dev } ``` +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 编辑 `.env` 文件,按照如下格式设置 `DATABASE_URL` 环境变量,将占位符 `{}` 替换为从连接对话框中复制的参数值: + + ```dotenv + DATABASE_URL='mysql://{user}:{password}@{host}:4000/test' + ``` + +9. 保存 `.env` 文件。 + +10. 在 `prisma/schema.prisma` 中,将连接提供者设置为 `mysql`,并将连接 URL 设置为 `env("DATABASE_URL")`: + + ```prisma + datasource db { + provider = "mysql" + url = env("DATABASE_URL") + } + ``` +
diff --git a/develop/dev-guide-sample-application-nodejs-sequelize.md b/develop/dev-guide-sample-application-nodejs-sequelize.md index a22027d370ed..82b962a6ad62 100644 --- a/develop/dev-guide-sample-application-nodejs-sequelize.md +++ b/develop/dev-guide-sample-application-nodejs-sequelize.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Sequelize](https://sequelize.org/) > **Note** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -104,6 +104,47 @@ npm install 7. 保存 `.env` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 编辑 `.env` 文件,按照如下格式设置连接信息,将占位符 `{}` 替换为从连接对话框中复制的参数值: + + ```dotenv + TIDB_HOST='{host}' + TIDB_PORT='4000' + TIDB_USER='{user}' + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + TIDB_ENABLE_SSL='false' + ``` + +9. 保存 `.env` 文件。 +
diff --git a/develop/dev-guide-sample-application-nodejs-typeorm.md b/develop/dev-guide-sample-application-nodejs-typeorm.md index 3f4f4aad361e..31cbb68d21ca 100644 --- a/develop/dev-guide-sample-application-nodejs-typeorm.md +++ b/develop/dev-guide-sample-application-nodejs-typeorm.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[TypeORM](https://typeorm.io/) 是当 > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -119,6 +119,47 @@ npm install @types/node ts-node typescript --save-dev 7. 保存 `.env` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 编辑 `.env` 文件,按照如下格式设置连接信息,将占位符 `{}` 替换为从连接对话框中复制的参数值: + + ```dotenv + TIDB_HOST={host} + TIDB_PORT=4000 + TIDB_USER={user} + TIDB_PASSWORD={password} + TIDB_DATABASE=test + TIDB_ENABLE_SSL=false + ``` + +9. 保存 `.env` 文件。 +
diff --git a/develop/dev-guide-sample-application-python-django.md b/develop/dev-guide-sample-application-python-django.md index bba752c30c92..adbd00e54e95 100644 --- a/develop/dev-guide-sample-application-python-django.md +++ b/develop/dev-guide-sample-application-python-django.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Django](https://www.djangoproject.com > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和 TiDB Self-Managed。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和 TiDB Self-Managed。 ## 前置需求 @@ -107,6 +107,48 @@ pip install -r requirements.txt 7. 保存 `.env` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 复制并粘贴对应连接字符串至 `.env` 中。示例结果如下: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + ``` + + 注意替换 `{}` 中的占位符为连接对话框中获得的值。 + +9. 保存 `.env` 文件。 +
diff --git a/develop/dev-guide-sample-application-python-mysql-connector.md b/develop/dev-guide-sample-application-python-mysql-connector.md index b473903dc0b6..ad6ce8197a01 100644 --- a/develop/dev-guide-sample-application-python-mysql-connector.md +++ b/develop/dev-guide-sample-application-python-mysql-connector.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[MySQL Connector/Python](https://dev.m > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和 TiDB Self-Managed。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和 TiDB Self-Managed。 ## 前置需求 @@ -97,6 +97,48 @@ pip install -r requirements.txt 7. 保存 `.env` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 复制并粘贴对应连接字符串至 `.env` 中。示例结果如下: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + ``` + + 注意替换 `{}` 中的占位符为连接对话框中获得的值。 + +9. 保存 `.env` 文件。 +
diff --git a/develop/dev-guide-sample-application-python-mysqlclient.md b/develop/dev-guide-sample-application-python-mysqlclient.md index b482aa8ab8a0..167867662e5e 100644 --- a/develop/dev-guide-sample-application-python-mysqlclient.md +++ b/develop/dev-guide-sample-application-python-mysqlclient.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[mysqlclient](https://github.com/PyMyS > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。 ## 前置需求 @@ -101,6 +101,49 @@ pip install -r requirements.txt 7. 保存 `.env` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 复制并粘贴对应连接字符串至 `.env` 中。示例结果如下: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + CA_PATH='' + ``` + + 注意替换 `{}` 中的占位符为连接对话框中获得的值。 + +9. 保存 `.env` 文件。 +
diff --git a/develop/dev-guide-sample-application-python-peewee.md b/develop/dev-guide-sample-application-python-peewee.md index adc6f428e76e..50d1f8d95dab 100644 --- a/develop/dev-guide-sample-application-python-peewee.md +++ b/develop/dev-guide-sample-application-python-peewee.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[peewee](https://github.com/coleifer/p > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和 TiDB Self-Managed。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和 TiDB Self-Managed。 ## 前置需求 @@ -101,6 +101,48 @@ peewee 是一个支持多种数据库的 ORM 库。它是对数据库的高层 7. 保存 `.env` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 复制并粘贴对应连接字符串至 `.env` 中。示例结果如下: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + ``` + + 注意替换 `{}` 中的占位符为连接对话框中获得的值。 + +9. 保存 `.env` 文件。 +
diff --git a/develop/dev-guide-sample-application-python-pymysql.md b/develop/dev-guide-sample-application-python-pymysql.md index a7b1c16fc4fa..5a453251d9a9 100644 --- a/develop/dev-guide-sample-application-python-pymysql.md +++ b/develop/dev-guide-sample-application-python-pymysql.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[PyMySQL](https://github.com/PyMySQL/P > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和 TiDB Self-Managed。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和 TiDB Self-Managed。 ## 前置需求 @@ -97,6 +97,48 @@ pip install -r requirements.txt 7. 保存 `.env` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 复制并粘贴对应连接字符串至 `.env` 中。示例结果如下: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + ``` + + 注意替换 `{}` 中的占位符为连接对话框中获得的值。 + +9. 保存 `.env` 文件。 +
diff --git a/develop/dev-guide-sample-application-python-sqlalchemy.md b/develop/dev-guide-sample-application-python-sqlalchemy.md index 1e62a959471e..27e6c70e9afa 100644 --- a/develop/dev-guide-sample-application-python-sqlalchemy.md +++ b/develop/dev-guide-sample-application-python-sqlalchemy.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[SQLAlchemy](https://www.sqlalchemy.or > **注意** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和 TiDB Self-Managed。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和 TiDB Self-Managed。 ## 前置需求 @@ -107,6 +107,48 @@ SQLAlchemy 是一个支持多种数据库的 ORM 库。它是对数据库的高 7. 保存 `.env` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 复制并粘贴对应连接字符串至 `.env` 中。示例结果如下: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + ``` + + 注意替换 `{}` 中的占位符为连接对话框中获得的值。 + +9. 保存 `.env` 文件。 +
diff --git a/develop/dev-guide-sample-application-ruby-mysql2.md b/develop/dev-guide-sample-application-ruby-mysql2.md index a2359537fd40..43f174dceae1 100644 --- a/develop/dev-guide-sample-application-ruby-mysql2.md +++ b/develop/dev-guide-sample-application-ruby-mysql2.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[mysql2](https://github.com/brianmario > **注意:** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 以及本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 以及本地部署的 TiDB。 ## 前置需求 @@ -107,6 +107,47 @@ bundle add mysql2 dotenv 7. 保存 `.env` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 编辑 `.env` 文件,按照如下格式设置连接信息,将占位符 `{}` 替换为从连接对话框中复制的参数值: + + ```dotenv + DATABASE_HOST={host} + DATABASE_PORT=4000 + DATABASE_USER={user} + DATABASE_PASSWORD={password} + DATABASE_NAME=test + DATABASE_ENABLE_SSL=false + ``` + +9. 保存 `.env` 文件。 +
diff --git a/develop/dev-guide-sample-application-ruby-rails.md b/develop/dev-guide-sample-application-ruby-rails.md index c4a6fb88dfba..3642bed70b40 100644 --- a/develop/dev-guide-sample-application-ruby-rails.md +++ b/develop/dev-guide-sample-application-ruby-rails.md @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库,[Rails](https://github.com/rails/rails > **注意:** > -> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 以及本地部署的 TiDB。 +> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 以及本地部署的 TiDB。 ## 前置需求 @@ -97,6 +97,42 @@ bundle add mysql2 dotenv 7. 保存 `.env` 文件。 +
+
+ +1. 在 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,点击你目标 {{{ .premium }}} 实例的名字,进入实例的 **Overview** 页面。 + +2. 在左侧导航栏中,点击 **Settings** > **Networking**。 + +3. 在 **Networking** 页面,点击 **Public Endpoint** 的 **Enable**,然后点击 **Add IP Address**。 + + 确保你的客户端 IP 地址已添加到访问列表中。 + +4. 在左侧导航栏中,点击 **Overview** 返回实例概览页面。 + +5. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。 + +6. 在连接对话框中,从 **Connection Type** 下拉列表中选择 **Public**。 + + - 如果提示 Public Endpoint 正在开启,请等待该过程完成。 + - 如果你尚未设置密码,请在对话框中点击 **Set Root Password**。 + - 如果需要验证服务器证书或连接失败且需要 CA 证书,请点击 **CA cert** 下载证书。 + - 除 **Public** 连接类型外,{{{ .premium }}} 还支持 **Private Endpoint** 连接。详情请参阅[通过 AWS PrivateLink 连接到 {{{ .premium }}}](https://docs.pingcap.com/tidbcloud/connect-to-premium-via-aws-private-endpoint/?plan=premium)。 + +7. 运行以下命令,将 `.env.example` 复制并重命名为 `.env`: + + ```shell + cp .env.example .env + ``` + +8. 编辑 `.env` 文件,按照如下格式设置 `DATABASE_URL` 环境变量,将占位符 `{}` 替换为从连接对话框中复制的参数值: + + ```dotenv + DATABASE_URL='mysql2://{user}:{password}@{host}:{port}/{database_name}' + ``` + +9. 保存 `.env` 文件。 +