Skip to content
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
38 changes: 37 additions & 1 deletion develop/dev-guide-gui-mysql-workbench.md
Original file line number Diff line number Diff line change
Expand Up @@ -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。

## 前置需求

Expand Down Expand Up @@ -77,6 +77,42 @@ TiDB 是一个兼容 MySQL 的数据库。[MySQL Workbench](https://www.mysql.co

8. 如果连接测试成功,你可以看到 **Successfully made the MySQL connection** 信息。点击 **OK** 保存连接配置。

</div>
<div label="{{{ .premium }}}">

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** 保存连接配置。

</div>
<div label="TiDB Cloud Dedicated">

Expand Down
40 changes: 39 additions & 1 deletion develop/dev-guide-gui-navicat.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Navicat](https://www.navicat.com) 是

> **注意**
>
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -73,6 +73,44 @@ TiDB 是一个兼容 MySQL 的数据库。[Navicat](https://www.navicat.com) 是

9. 如果连接测试成功,你可以看到 **Connection Successful** 信息。点击 **OK** 完成连接配置。

</div>
<div label="{{{ .premium }}}">

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** 完成连接配置。

</div>
<div label="TiDB Cloud Dedicated">

Expand Down
51 changes: 46 additions & 5 deletions develop/dev-guide-sample-application-aws-lambda.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ TiDB 是一个兼容 MySQL 的数据库。[AWS Lambda 函数](https://aws.amazon

> **Note**
>
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}} 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}} 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -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"
}
}
```

</div>

<div label="{{{ .premium }}}">

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

将占位符 `{}` 替换为从连接对话框中复制的参数值。

</div>

<div label="本地部署的 TiDB">

编辑 `env.json` 文件,按照如下格式设置连接信息,将占位符 `{}` 替换为你的 TiDB 集群的连接参数值:
Expand All @@ -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"
}
}
```
Expand Down Expand Up @@ -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,
Expand Down
45 changes: 44 additions & 1 deletion develop/dev-guide-sample-application-golang-gorm.md
Original file line number Diff line number Diff line change
Expand Up @@ -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。

## 前置需求

Expand Down Expand Up @@ -91,6 +91,49 @@ cd tidb-golang-gorm-quickstart

7. 保存 `.env` 文件。

</div>
<div label="{{{ .premium }}}">

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` 文件。

</div>

<div label="TiDB Cloud Dedicated">
Expand Down
44 changes: 43 additions & 1 deletion develop/dev-guide-sample-application-golang-sql-driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -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。

## 前置需求

Expand Down Expand Up @@ -92,7 +92,49 @@ cd tidb-golang-sql-driver-quickstart
7. 保存 `.env` 文件。

</div>
<div label="{{{ .premium }}}">

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` 文件。

</div>
<div label="TiDB Cloud Dedicated">

1. 在 TiDB Cloud 的 [**My TiDB**](https://tidbcloud.com/tidbs) 页面中,选择你的 TiDB Cloud Dedicated 集群,进入集群的 **Overview** 页面。
Expand Down
45 changes: 44 additions & 1 deletion develop/dev-guide-sample-application-java-hibernate.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Hibernate](https://hibernate.org/orm/

> **注意**
>
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、{{{ .premium }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -92,6 +92,49 @@ cd tidb-java-hibernate-quickstart

7. 保存 `env.sh` 文件。

</div>
<div label="{{{ .premium }}}">

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` 文件。

</div>

<div label="TiDB Cloud Dedicated">
Expand Down
Loading
Loading