PingKai Logo下载

使用 Visual Studio Code 连接 TiDB

TiDB 是兼容 MySQL 的数据库,Visual Studio Code (VS Code) 是一款轻量级但功能强大的源代码编辑器。本教程使用了 SQLTools 扩展,该扩展将 TiDB 作为官方驱动支持。

在本教程中,你可以学习如何使用 Visual Studio Code 连接到你的 TiDB 集群。

前置条件

完成本教程,你需要:

  • Visual Studio Code 1.72.0 或更高版本。
  • Visual Studio Code 的 SQLTools MySQL/MariaDB/TiDB 扩展。你可以通过以下任一方式安装:
    • 点击 此链接 启动 VS Code 并直接安装扩展。
    • 访问 VS Code Marketplace 并点击 Install。
    • 在 VS Code 的 Extensions 标签页中,搜索 mtxr.sqltools-driver-mysql 获取 SQLTools MySQL/MariaDB/TiDB 扩展,然后点击 Install。
  • 一个 TiDB 集群。

如果你还没有 TiDB 集群,可以按如下方式创建:

连接 TiDB

根据你选择的 TiDB 部署方式,连接到你的 TiDB 集群。

  1. 进入 Clusters 页面,然后点击目标集群名称进入其概览页面。

  2. 点击右上角的 Connect。会弹出连接对话框。

  3. 确保连接对话框中的配置与你的操作环境一致。

    • Connection Type 设置为 Public。
    • Branch 设置为 main。
    • Connect With 设置为 VS Code。
    • Operating System 与你的环境一致。
  4. 点击 Generate Password 生成一个随机密码。

  5. 启动 VS Code,在导航栏选择 SQLTools 扩展。在 CONNECTIONS 区域,点击 Add New Connection,并选择 TiDB 作为数据库驱动。

    VS Code SQLTools: add new connection

  6. 在设置面板中,配置以下连接参数:

    • Connection name:为该连接命名,便于识别。

    • Connection group:(可选)为该组连接命名。相同组名的连接会被归为一组。

    • Connect using:选择 Server and Port。

    • Server Address:填写平凯数据库云服务连接对话框中的 HOST 参数。

    • Port:填写平凯数据库云服务连接对话框中的 PORT 参数。

    • Database:填写你要连接的数据库名。

    • Username:填写平凯数据库云服务连接对话框中的 USERNAME 参数。

    • Password mode:选择 SQLTools Driver Credentials。

    • 在 MySQL driver specific options 区域,配置以下参数:

      • Authentication Protocol:选择 default。

      • SSL:选择 Enabled。{} 要求安全连接。在 SSL Options (node.TLSSocket) 区域,将 Certificate Authority (CA) Certificate File 字段配置为平凯数据库云服务连接对话框中的 CA 参数。

    VS Code SQLTools: configure connection settings for {}

  7. 点击 TEST CONNECTION 验证与 {} 集群的连接。

    1. 在弹窗中点击 Allow。

    2. 在 SQLTools Driver Credentials 对话框中,输入你在第 4 步创建的密码。

      VS Code SQLTools: enter password to connect to {}

  8. 如果连接测试成功,你会看到 Successfully connected! 消息。点击 SAVE CONNECTION 保存连接配置。

后续步骤

需要帮助?

在 Discord 或 Slack 社区提问,或提交支持工单。