通过 DataFlux Func 接入¶
DataFlux Func 是脚本开发和执行平台。外部数据源通过已部署的 Func 及其连接器访问数据,再将结果交给观测云查询和展示。
这种方式适合已有 Func 的环境,也适合需要脚本加工、第三方 API 调用或自定义图表数据结构的场景。与 QueryHub 不同,Func 的连接配置和脚本在 Func 平台中管理;已有 Func 数据源继续沿用原有 ID 和查询方式。
准备工作¶
- 已部署并接入目标工作空间的 DataFlux Func;尚未部署时,参考 Func 快速开始。
- Func 所在环境可以访问目标数据源,所用账号具备需要的查询权限。
在控制台添加数据源¶
- 进入集成 > 外部数据源,点击添加数据源。
- 选择通过 DataFlux Func 接入。
- 从列表中选择已接入的 DataFlux Func。
- 选择数据源类型,再填写连接信息。
| 配置项 | 含义与填写方式 |
|---|---|
| DataFlux Func | 负责连接目标数据源的 Func 实例,应选择网络可达、已关联当前工作空间的实例 |
| 数据源类型 | 目标数据库或服务的实际类型,可选项以所选 Func 的连接器能力为准 |
| 数据源 ID | 用于标识该接入配置。按页面要求设置;复用已有 Func 连接器时,与其连接器 ID 保持一致,不使用数据库名或 API Key 代替 |
| 标题 | 数据源在列表和查询选择器中的显示名称 |
| 主机地址、端口 | 数据源的实际连接地址,由数据库或服务管理员提供;不填写管理控制台网址 |
| 数据库 | 关系型数据库连接要访问的数据库名称,不是表名 |
| 用户名、密码 | 目标数据库或服务的访问凭据,不是工作空间登录账号 |
不同连接器的字段会有所不同。按页面展示填写当前类型所需的信息,完成后测试连接并保存;配置操作权限时,沿用工作空间和外部数据源的权限规则。
在查询中使用¶
- 在指标分析或图表中添加数据源查询。
- 选择通过 Func 接入的数据源。
- 输入该连接器支持的原生查询语句,执行查询或刷新结果。
- 根据返回结构选择展示方式。
例如,MySQL 表 orders 包含 id、total、status 时,可查询已支付订单:
这里使用所选 Func 连接器支持的语法,不通过修改查询文本切换为 QueryHub。
需要脚本处理时¶
如果直接查询不能满足需求,可在 Func 中创建对应类型的连接器,通过连接器 ID 获取对象,并编写自定义函数处理结果:
这里的 mysql 是 Func 中 MySQL 连接器的 ID,不是数据源类型名称、表名或工作空间 ID。
- 查询外部 MySQL 时,创建并使用 MySQL 类型的连接器。
- 脚本还需要调用观测云API 时,再按需创建相应连接器,并配置工作空间 API Key。
API Key 可在管理 > API Key 管理中创建,说明见 API Key 管理。不要把工作空间 API Key 填入数据库密码字段。
完整步骤和返回格式见自定义查询函数。
管理和维护¶
在集成 > 外部数据源中查看数据源类型、ID、关联 Func 和状态,并按权限编辑或删除配置。
- 已有数据源的 ID 和查询引用保持原有规则;不因新增 QueryHub 入口而自动迁移。
- 数据库密码或网络变化后,更新实际使用的 Func 连接配置并重新验证查询。
- 删除连接前,确认相关图表和脚本的引用关系;删除后,原有引用可能无法继续查询。
已有 TiDB Cloud Lake 专用接入请继续参考对应指南,不需要改成 Func 连接器。
