Skip to content

README-zh.md

Latest commit

 

History

History
141 lines (96 loc) · 6.03 KB

README-zh.md

File metadata and controls

141 lines (96 loc) · 6.03 KB

如何用 JDBC 连接到 TiDB

Java CI with Maven

English | 中文

这是 PingCAP 为 JDBC 编写的用于连接 TiDB 的示例项目

TiDB 是一个兼容 MySQL 的数据库。MySQL Connector/J 是 MySQL 对 JDBC 的实现。

前置要求

开始实践

1. 克隆示例代码仓库到本地

git clone https://github.com/tidb-samples/tidb-java-jdbc-quickstart.git
cd tidb-java-jdbc-quickstart

2. 配置连接信息

(选项 1) TiDB Serverless

  1. 在 TiDB Cloud 控制台中，打开 Clusters 页面，选择你的 TiDB Serverless 集群，进入 Overview 页面，点击右上角的 Connect 按钮。

  2. 确认窗口中的配置和你的运行环境一致。

    • Endpoint Type 为 Public
    • Connect With 为 General
    • Operating System 为你的运行环境

    如果你在 Windows Subsystem for Linux (WSL) 中运行，请切换为对应的 Linux 发行版。

  3. 点击 Generate password 生成密码。

    如果你之前已经生成过密码，可以直接使用原密码，或点击 Reset Password 重新生成密码。

  4. 运行以下命令，将 env.sh.example 复制并重命名为 env.sh：

    cp env.sh.example env.sh

  5. 复制并粘贴对应连接字符串至 env.sh 中。需更改部分示例结果如下。

    export TIDB_HOST='{gateway-region}.aws.tidbcloud.com'
export TIDB_PORT='4000'
export TIDB_USER='{prefix}.root'
export TIDB_PASSWORD='{password}'
export TIDB_DB_NAME='test'
export USE_SSL='true'

    注意替换 {} 中的占位符为 Connect 窗口中获得的值。

    TiDB Serverless 要求使用 secure connection，因此 USE_SSL 的值应为 true。

  6. 保存文件。

(选项 2) TiDB Dedicated

  1. 在 TiDB Cloud Web Console 中，选择你的 TiDB Dedicated 集群，进入 Overview 页面，点击右上角的 Connect 按钮。点击 Allow Access from Anywhere。

    更多配置细节，可参考 TiDB Dedicated 标准连接教程.

  2. 运行以下命令，将 env.sh.example 复制并重命名为 env.sh：

    cp env.sh.example env.sh

  3. 复制并粘贴对应的连接字符串至 env.sh 中。需更改部分示例结果如下。

    export TIDB_HOST='{host}.clusters.tidb-cloud.com'
export TIDB_PORT='4000'
export TIDB_USER='{prefix}.root'
export TIDB_PASSWORD='{password}'
export TIDB_DB_NAME='test'
export USE_SSL='false'

    注意替换 {} 中的占位符为 Connect 窗口中获得的值，并配置前面步骤中下载好的证书路径。

  4. 保存文件。

(选项 3) 自建 TiDB

  1. 运行以下命令，将 env.sh.example 复制并重命名为 env.sh：

    cp env.sh.example env.sh

  2. 复制并粘贴对应的连接字符串至 env.sh 中。需更改部分示例结果如下。

    export TIDB_HOST='{tidb_server_host}'
export TIDB_PORT='4000'
export TIDB_USER='root'
export TIDB_PASSWORD='{password}'
export TIDB_DB_NAME='test'
export USE_SSL='false'

    注意替换 {} 中的占位符为你的 TiDB 对应的值。如果你在本机运行 TiDB，默认 Host 地址为 127.0.0.1，密码为空。

  3. 保存文件。

3. 运行示例代码

make

4. 期望输出

期望的输出

注意事项

关于 MySQL Connector/J 的更多使用方法及细节，可以参考 MySQL Connector/J 官方文档。

下一步