GUI 工具

指标面板

指标板是一个画布,你可以在上面放置图表、表格和表单控件,这些控件会从 SQL 查询中加载数据。你可以使用它来快速构建一个简单的实时报告,或者在几分钟内创建一个小型内部工具。

打开 Metrics Board

点击工具栏上的 Metrics 按钮,或导航至 Tools > Show Metrics Board。

左侧边栏列出了你的仪表板。右键点击它以创建 New... 仪表板,或执行 Rename...、Duplicate、Delete、Import Metrics Board 或 Export Metrics Board(用于将仪表板导出为文件)。

指标板窗口的工具栏包含以下按钮:

  • Status:开始或停止刷新仪表板上的数据。
  • Add:在仪表板上添加一个新对象。
  • 锁定:锁定仪表板,防止对象意外移动或编辑。
  • 网格:显示画布网格,并显示或隐藏对象之间的连接。
  • Database:返回工作区。
一个带有状态输入字段和按月收入条形图的仪表盘。
指标板

添加对象

点击工具栏中的 Add,或右键点击画布并选择 Add,然后选择一个对象。

对象 作用
数据表 以表格形式显示查询结果。
Scoreboard 显示单个值(Score)及一条 Detail 说明行。
条形图、折线图 绘制查询结果。选择 x 轴 列,以及一个或多个 y 轴 列。
饼图 从 标签 列和 值 列绘制饼图。
导出器 将查询结果导出为 CSV、JSON、SQL 或 Excel 文件。
导入器 将 CSV、JSON 或 SQL 文件导入到表中。
输入框 一个文本字段,其值会发送给其他对象。
下拉菜单 包含一组值(固定值或通过查询加载)的列表,选中项会发送至其他对象。
按钮 向已连接的物体发送事件。
Connection 使关联对象使用另一个 TablePlus 连接和数据库。
指标板的“添加”菜单
添加对象

拖动对象以移动它,拖动其边缘以调整大小。点击对象以显示其设置。

创建图表或数据表

  1. 添加一个柱状图、折线图、饼图、数据表或仪表盘。

  2. 点击该对象以打开其设置。

  3. 输入一个标签和用于加载数据的查询,例如:

    SELECT strftime('%Y-%m', ordered_at) AS month, SUM(total) AS revenue
    FROM orders
    GROUP BY month
    ORDER BY month;
    
  4. 对于图表,请选择 x-axis 和 y-axis 列(或饼图的 label 和 value)。对于得分板,请选择 Score 和 Detail 列。

  5. 选择 Refresh rate:

    • 选择 1 second 到 30 minutes 之间的间隔,对象会按指定间隔重新加载数据。
    • 选择 Refresh on Event 后,输入框、下拉菜单或按钮等其他对象发出事件时,当前对象会重新加载数据。
    • 选择 Do not auto refresh 后,对象只加载一次。需要重新加载时,请点击该对象的刷新按钮。
  6. 点击 OK。

图表的设置
图表设置

你还可以通过查询结果创建图表:在 SQL 编辑器中打开查询结果的 Chart 选项卡,然后点击 Add to Metrics Board。请参见 处理查询结果。

使用输入字段或下拉菜单进行筛选

输入字段和下拉菜单会将值传递给其他对象的查询。

  1. 添加图表、表格或计分板,并将其 Refresh rate 设置为 Refresh on Event。

  2. 在查询中,请使用 $ 变量引用该值。字符串值会按原样插入,因此请在查询中用引号将其括起来。

    SELECT first_name, last_name, email, city
    FROM customers
    WHERE country = '$country';
    
  3. 添加一个 输入框(或 下拉菜单)。在其设置中,设置变量的 名称(此处为 country,默认值为 input),并选择其提交值的时机:按回车键提交、编辑完成时提交 或 事件触发时提交(若为下拉菜单,则为 值变化时提交 或 事件触发时提交)。

  4. 将输入框连接到对象:选择输入框,然后将其拖拽至对象。

当输入字段提交后,关联的对象会重新加载并显示新值。

一个与数据表关联的输入字段
与数据表关联的输入字段

Button 会向其连接的对象发送事件。将按钮连接到设置为 Refresh on Event(或 Submit on Event)的对象,以便在点击时重新加载或提交它们。

使用助手创建仪表板

指标板拥有专属 AI 助手。在仪表板工具栏中点击 Assistant,即可在右侧显示聊天窗口,然后描述你需要的仪表板,例如“显示按月划分的收入条形图,并提供一个下拉菜单以按状态筛选”。助手可以添加、修改、连接、排列和删除对象,运行它们,并读取运行结果以修复查询。每个仪表板都拥有独立的聊天记录。

  • Assistant 按钮在 Settings > AI Agent 中显示,前提是已启用助手。请查看 LLM 插件 以设置提供商。
  • 使用助手创建仪表板:在未添加任何表作为上下文时,@ Add context 显示 Auto:助手会自动查找所需的表。
  • 其更改会立即在仪表板上显示。按 ⌘ + Z 撤销这些更改。
  • 使用助手构建仪表板:修改数据的查询需等待你的批准。助手不会运行导出器、导入器或连接对象。

使用助手创建仪表板:若要自行整理仪表板,请点击工具栏中的网格按钮,选择 Arrange Left to Right 或 Arrange Top to Bottom。TablePlus 会按照对象之间的箭头方向进行布局。

使用其他连接

默认情况下,对象会在打开面板的工作区连接上运行查询。若要使用不同的连接,请添加 Connection 对象,在设置中选择一个 TablePlus 连接及其数据库,并将其连接到需要使用该连接的对象。该连接的 安全模式 同样适用于这些对象。