使用 AI 辅助 SQL 编辑器探索你的数据

你可以在 TiDB Cloud 控制台中使用内置的 AI 辅助 SQL 编辑器，最大化你的数据价值。

在 SQL 编辑器中，你可以手动编写 SQL 查询，或者只需在 macOS 上按下 ⌘ + I（或在 Windows 或 Linux 上按下 Control + I），即可指示 Chat2Query (beta) 自动生成 SQL 查询。这样，你无需本地 SQL 客户端即可对数据库运行 SQL 查询。你可以直观地在表格或图表中查看查询结果，并轻松检查查询日志。

使用场景

SQL 编辑器推荐的使用场景如下：

利用 Chat2Query 的 AI 能力，快速生成、调试或重写复杂的 SQL 查询。
快速测试 TiDB 的 MySQL 兼容性。
使用你自己的数据集，轻松探索 TiDB 的 SQL 特性。

限制

AI 生成的 SQL 查询可能并非 100% 准确，你可能需要对其进行完善。
SQL 编辑器仅支持部署在 AWS 上、版本为 v6.5.0 及以上的 TiDB 集群。
SQL 编辑器默认对 TiDB Cloud Serverless 集群开放。若要在 TiDB Cloud Dedicated 集群上使用 SQL 编辑器和 Chat2Query，请联系 TiDB Cloud 支持。

访问 SQL 编辑器

进入你的项目的 Clusters 页面。
提示：
你可以使用左上角的下拉框在组织、项目和集群之间切换。
点击你的集群名称，然后在左侧导航栏点击 SQL Editor。
注意
在以下情况下，SQL Editor 入口会显示为灰色且不可点击。
- 你的 TiDB Cloud Dedicated 集群版本低于 v6.5.0。若要使用 SQL 编辑器，你需要联系 TiDB Cloud 支持升级你的集群。
- 你的 TiDB Cloud Dedicated 集群刚刚创建，SQL 编辑器的运行环境仍在准备中。此时请等待几分钟，Chat2Query 即可使用。
- 你的 TiDB Cloud Dedicated 集群已被暂停。

启用或禁用 AI 生成 SQL 查询

PingCAP 将用户数据的隐私和安全放在首位。SQL 编辑器中 Chat2Query 的 AI 能力仅需访问数据库 schema 以生成 SQL 查询，不会访问你的数据本身。更多信息请参见 Chat2Query 隐私常见问题。

首次访问 Chat2Query 时，你会看到一个对话框，询问是否允许 PingCAP 和 Amazon Bedrock 使用你的代码片段进行服务研究和改进。

若要启用 AI 生成 SQL 查询，勾选复选框并点击 Save and Get Started。
若要禁用 AI 生成 SQL 查询，直接关闭该对话框即可。

首次访问后，你仍可按如下方式更改 AI 设置：

启用 AI：在 Chat2Query 右上角点击 Enable AI power for data exploration。
禁用 AI：在 TiDB Cloud 控制台左下角点击，点击 Account Settings，切换到 AI & Privacy 标签页，然后关闭 AI-powered Data Exploration 选项。

编写并运行 SQL 查询

在 SQL 编辑器中，你可以使用你自己的数据集编写并运行 SQL 查询。

编写 SQL 查询。
针对 macOS：
- 如果已启用 AI，只需按下 ⌘ + I，输入你的指令并按 Enter，即可让 AI 自动生成 SQL 查询。
  对于 Chat2Query 生成的 SQL 查询，点击 Accept 接受该查询并继续编辑。如果查询不符合你的需求，点击 Discard 拒绝该查询。你也可以点击 Regenerate 让 Chat2Query 重新生成查询。
- 如果未启用 AI，则手动编写 SQL 查询。
针对 Windows 或 Linux：
- 如果已启用 AI，只需按下 Ctrl + I，输入你的指令并按 Enter，即可让 AI 自动生成 SQL 查询。
  对于 Chat2Query 生成的 SQL 查询，点击 Accept 接受该查询并继续编辑。如果查询不符合你的需求，点击 Discard 拒绝该查询。你也可以点击 Regenerate 让 Chat2Query 重新生成查询。
- 如果未启用 AI，则手动编写 SQL 查询。
运行 SQL 查询。
针对 macOS：
- 如果编辑器中只有一个查询，按 ⌘ + Enter 或点击 Run 即可运行。
- 如果编辑器中有多个查询，想要顺序运行其中一个或多个，选中目标查询的行，然后按 ⌘ + Enter 或点击 Run。
- 若要顺序运行编辑器中的所有查询，按 ⇧ + ⌘ + Enter，或选中所有查询的行后点击 Run。
针对 Windows 或 Linux：
- 如果编辑器中只有一个查询，按 Ctrl + Enter 或点击 Run 即可运行。
- 如果编辑器中有多个查询，想要顺序运行其中一个或多个，选中目标查询的行，然后按 Ctrl + Enter 或点击 Run。
- 若要顺序运行编辑器中的所有查询，按 Shift + Ctrl + Enter，或选中所有查询的行后点击 Run。

运行查询后，你可以在页面底部立即看到查询日志和结果。

注意

返回结果有 8 MiB 的大小限制。

使用 Chat2Query 重写 SQL 查询

在 SQL 编辑器中，你可以使用 Chat2Query 重写已有的 SQL 查询，以优化性能、修复错误或满足其他特定需求。

用光标选中你想要重写的 SQL 查询行。
按照你的操作系统，使用快捷键调用 Chat2Query 进行重写：
- macOS 上为 ⌘ + I
- Windows 或 Linux 上为 Control + I
输入你的指令后按 Enter，让 AI 进行重写。
调用 Chat2Query 后，你会看到建议的重写内容以及以下选项：
- Accept：点击此项接受建议的重写并继续编辑。
- Discard：如果建议的重写不符合你的预期，点击此项拒绝。
- Regenerate：根据你的反馈或补充指令，点击此项让 Chat2Query 重新生成重写内容。

注意

Chat2Query 使用 AI 算法提供优化和修正建议。建议你在最终确定查询前，仔细审核这些建议。

管理 SQL 文件

在 SQL 编辑器中，你可以将 SQL 查询保存在不同的 SQL 文件中，并按如下方式管理 SQL 文件：

新增 SQL 文件：点击 SQL Files 标签页上的 +。
重命名 SQL 文件：将光标移到文件名上，点击文件名旁的 ...，然后选择 Rename。
删除 SQL 文件：将光标移到文件名上，点击文件名旁的 ...，然后选择 Delete。注意，当 SQL Files 标签页上只有一个 SQL 文件时，无法删除该文件。

通过 API 访问 Chat2Query

除了通过 UI 访问 Chat2Query，你还可以通过 API 访问 Chat2Query。为此，你需要先创建一个 Chat2Query Data App。

在 Chat2Query 中，你可以按如下方式访问或创建 Chat2Query Data App：

点击右上角的 ...，然后点击 Access Chat2Query via API。
在弹出的对话框中，执行以下操作之一：
- 创建新的 Chat2Query Data App，点击 New Chat2Query Data App。
- 访问已有的 Chat2Query Data App，点击目标 Data App 的名称。

更多信息请参见 Get started with Chat2Query API。

从 SQL 文件生成接口

对于 TiDB 集群，TiDB Cloud 提供了 Data Service (beta) 功能，使你可以通过自定义 API endpoint 以 HTTPS 请求访问 TiDB Cloud 数据。在 SQL 编辑器中，你可以通过以下步骤从 SQL 文件生成 Data Service (beta) 的接口：

将光标移到文件名上，点击文件名旁的 ...，然后选择 Generate endpoint。
在 Generate endpoint 对话框中，选择你要为其生成接口的 Data App，并输入接口名称。
点击 Generate。接口生成后会显示其详情页。

更多信息请参见 Manage an endpoint。

管理 SQL 编辑器设置

在 SQL 编辑器中，你可以更改以下设置：

查询结果的最大行数
是否在 Schemas 标签页显示系统数据库 schema

更改设置的步骤如下：

在 SQL Editor 右上角点击 ... 并选择 Settings。
根据需要更改设置。
点击 Save。