接入并查询 TiDB Cloud Lake¶
在集成 > 外部数据源中添加 TiDB Cloud Lake 后,可在指标分析、仪表板等已支持外部数据源的查询入口中选择该数据源,并执行 TiDB Cloud Lake 原生只读 SQL。该接入由观测云服务端通过 TiDB Cloud Lake Driver 完成,不依赖 DataFlux Func。
前提条件¶
- 已获取 Lake DSN;
- Lake DSN 中包含有效的 Database 和 Warehouse;
- SQL 用户具有目标数据的只读查询权限;
- 当前账号具有外部数据源配置权限。
添加数据源¶
- 进入集成 > 外部数据源;
- 点击添加数据源;
- 在选择接入方式中选择 TiDB Cloud Lake 直连;
- 确认数据源类型为只读的 TiDB Cloud Lake;
- 填写连接属性:
| 配置项 | 是否必填 | 说明 |
|---|---|---|
| 名称 | 是 | 显示在外部数据源列表和查询数据源选择器中 |
| 描述 | 否 | 用于说明数据范围、用途或责任人 |
| Lake DSN | 是 | 粘贴从 TiDB Cloud Lake Connect 页面复制的完整 DSN |
TiDB Cloud Lake 直连不需要填写数据源 ID。通过 DataFlux Func 接入其他外部数据源时,原有 ID 字段和配置要求保持不变。
完成上述字段后:
- 点击测试连接。系统将验证 DSN、Warehouse、网络连通性和 SQL 用户的查询权限;
- 在设置权限中按需开启自定义操作权限:
- 未开启:跟随“外部数据源”默认权限;
- 已开启:仅创建人、管理员和指定成员可操作或使用该数据源;
- 保存数据源。
连接信息安全
Lake DSN 的密码仅在保存时加密传输,不会在列表、详情和查询中展示。查询由服务端执行,浏览器不会获得 DSN。
在查询中使用¶
以下步骤以指标 > 指标分析为例;仪表板等其他支持外部数据源的查询入口操作一致。
- 进入指标 > 指标分析;
- 添加数据源查询;
- 打开数据源选择器,选择刚创建的 TiDB Cloud Lake 数据源;
- 将鼠标悬停在数据源名称上,可确认数据源类型、Database 和 Warehouse;
- 输入一条原生只读 SQL;
- 点击运行查询,查看查询结果;
- 按需将查询结果保存到仪表板或其他支持的展示场景。
例如:
SELECT
service,
COUNT(*) AS log_count
FROM observability.application
WHERE event_time BETWEEN #{startTime} AND #{endTime}
GROUP BY service
ORDER BY log_count DESC
LIMIT 100;
请根据实际表结构、字段名称和 TiDB Cloud Lake SQL 语法调整示例。
SQL 使用范围¶
| 项目 | 说明 |
|---|---|
| 支持 | 单条 SELECT、WITH ... SELECT、EXPLAIN |
| 不支持 | INSERT、UPDATE、DELETE、DDL、事务、CALL、文件访问和多语句 |
| 默认超时 | 60 秒 |
| 最大返回 | 10,000 行 |
超时或超过返回限制时,请缩小查询时间范围、增加过滤条件或使用 LIMIT。
管理数据源¶
在集成 > 外部数据源页面,可按数据源类型筛选 TiDB Cloud Lake,或按名称搜索。
- 编辑:修改名称、描述、Lake DSN 或操作权限;
- 删除:删除后,引用该数据源的已有查询将无法继续执行;
- 更换密码:在 TiDB Cloud Lake 中修改密码后,重新获取 DSN 并编辑数据源。
验证结果¶
配置完成后,应同时满足:
- 外部数据源保存成功;
- 有权限的成员可以在查询数据源选择器中看到该数据源;
- 执行一条只读 SQL 后能返回结果;
- 无权限的成员无法选择或执行该数据源。
如果连接测试或查询失败,请参考常见问题。