创建飞书多维表格数据源

更新时间:
复制为 MD 格式

通过创建飞书多维表格数据源,可以实现Dataphin读取飞书多维表格的业务数据或向飞书多维表格写入数据。本文为您介绍如何创建飞书多维表格数据源。

前提条件

使用限制

  • 飞书多维表格的数据表支持多种字段类型,您可以通过飞书多维表格解析规则,查看飞书多维表格字段与Dataphin字段类型的映射关系。

  • 由于飞书侧限制,自20241031日起,飞书基础免费版接口累计可调用次数为1万次/月。若该调用量无法满足需求,您可升级至其他飞书版本扩容调用次数。具体请参见飞书自建应用API调用量上限调整说明

权限说明

仅支持拥有新建数据源权限点的自定义全局角色和超级管理员数据源管理员板块架构师项目管理员系统角色创建数据源。

操作步骤

  1. Dataphin首页,在顶部菜单栏选择管理中心 > 数据源管理

  2. 数据源页面,单击+新建数据源

  3. 新建数据源页面,选择飞书多维表格

    如果您最近使用过飞书多维表格,也可以在最近使用区域选择飞书多维表格。同时,您也可以在搜索框中,输入飞书多维表格的关键词,快速搜索。

  4. 新建飞书多维表格数据源页面中,配置连接数据源参数。

    1. 配置数据源的基本信息。

      参数

      说明

      数据源名称

      填写数据源名称。命名规则如下:

      • 只能包含中文、英文字母大小写、数字、下划线(_)或短划线(-)。

      • 长度不能超过64个字符。

      数据源编码

      配置数据源编码后,您可以在Flink_SQL任务或使用Dataphin JDBC客户端中,通过数据源编码.表名称数据源编码.schema.表名称的格式直接访问Dataphin数据源表,实现快捷消费;如果需要根据任务执行环境自动切换数据源,请通过${数据源编码}.table${数据源编码}.schema.table的变量格式访问。更多信息,请参见Flink SQL任务开发方式

      重要
      • 数据源编码配置成功后不支持修改。

      • 数据源编码配置成功后,才能在资产清单的对象详情页面进行数据预览。

      • Flink SQL中,目前仅支持MySQL、Hologres、MaxCompute、Oracle、StarRocks、Hive、SelectDB、GaussDB(DWS)数据源。

      数据源描述

      对飞书多维表格数据源的简单描述。不得超过128个字符。

      数据源配置

      基于业务数据源是否区分生产数据源和开发数据源:

      • 如果业务数据源区分生产数据源和开发数据源,则选择生产+开发数据源

      • 如果业务数据源不区分生产数据源和开发数据源,则选择生产数据源

      标签

      您可以根据标签给数据源进行分类打标,如何创建标签,请参见管理数据源标签

    2. 配置数据源与Dataphin的连接参数。

      若您的数据源配置选择生产+开发数据源,则需配置生产+开发数据源的连接信息。如果您的数据源配置为生产数据源,仅需配置生产数据源的连接信息。

      说明

      通常情况下,生产数据源和开发数据源需配置为非同一个数据源,以实现开发数据源与生产数据源的环境隔离,降低开发数据源对生产数据源的影响。但Dataphin也支持配置成同一个数据源,即相同参数值。

      参数

      描述

      飞书多维表格URL

      飞书多维表格地址,例如https://base.feishu.cn/base/appxxxx。详细获取步骤请参见获取多维表格链接

      APP IDAPP Secret

      输入企业版内部应用的唯一标识key和密钥。详细获取步骤请参见获取应用授权信息

  5. 选择默认资源组,该资源组用于运行与当前数据源相关任务,包括数据库SQL、离线整库迁移、数据预览等。

  6. 进行测试连接或直接单击确定进行保存,完成飞书多维表格数据源的创建。

    单击测试连接,系统将测试数据源是否可以和Dataphin进行正常的连通。若直接单击确定,系统将自动对所有已选中的集群进行测试连接,但即使所选中的集群均连接失败,数据源依然可以正常创建。

    测试连接针对公共调度集群或已经在Dataphin注册且正常使用的注册调度集群进行连接测试公共调度集群为系统默认选中,不支持取消选中。注册调度集群下不存在资源组时,不支持进行连接测试,需先创建资源组后再进行测试连接。

    • 所选集群只用于测试与当前数据源的网络连通,不用于后续相关任务的运行。

    • 测试连接时长通常在2分钟内,若超时,您可以单击image图标查看具体原因并重试。

    • 无论测试结果为连接失败连接成功成功有风险,系统都将为您记录最终结果的生成时间。

      说明

      公共调度集群的测试结果包含成功有风险连接成功连接失败三种连接状态;在Dataphin注册的注册调度集群的测试结果仅包含连接成功连接失败两种连接状态。

    • 测试结果为连接失败时,您可以单击image图标查看具体失败原因。

    • 测试结果为成功有风险时,代表应用集群连接成功、调度集群连接失败。您可以单击image图标查看日志信息。

    重要

附录

获取应用授权信息

您需要在飞书开放平台中创建企业自建应用,并获取相关授权信息,用于后续在Dataphin中创建数据源时认证使用。具体操作说明如下。

  1. 登录飞书开放平台,单击创建企业自建应用,在创建企业自建应用对话框中维护应用的相关信息,完成后单击创建image

  2. Dataphin将通过API接口读取飞书多维表格数据,因此您需要为当前应用申请飞书API接口的权限。在应用的开发者后台,单击左侧导航栏的权限管理,在API权限页签下为当前创建的应用配置所需权限。image

    您需要选中以下API权限并单击批量开通。

    • 查看、评论、编辑和管理云空间中所有文件。

    • 查看、评论、编辑和管理多维表格。

    • 查看、评论和导出多维表格。

    • 获取应用信息。

  3. 单击提示对话框中的确认并前往创建应用版本。跳转至版本管理与发布页面,单击创建版本image

    image

  4. 维护版本详情,完成后单击保存 > 申请线上发布,即可完成当前应用的发布。image

  5. 在应用的开发者后台单击凭证与基础信息,在应用凭证页面,复制并保存当前应用的App IDApp Secretimage

获取多维表格链接

登录飞书云文档,找到需要接入Dataphin的目标多维表格,复制并保存分享链接。具体操作说明如下。

  1. 在飞书云文档的文档列表中,找到需要接入Dataphin的目标多维表格,单击其操作列下拉列表中的分享image

    说明

    对于接入Dataphin的飞书多维表格,目前存在以下限制,请您提前确认表格是否符合以下限制。

    • 单个表格页列数不能超过100列,行数不能超过10000行。

    • 不支持导入包含附件、关联、查找引用字段类型的表格,您可以通过参考飞书多维表格解析规则中的字段映射详情表格,查看支持导入Dataphin的字段类型。

    • 不支持继承表格中的计算公式,导入后将仅保留数值。

  2. 分享文档对话框中设置链接分享范围image

    当链接分享范围设置为仅文档协作者可通过链接访问时,需要将当前自建应用添加到表格的文档应用中。image

  3. 单击复制链接按钮,复制并保存当前表格的分享链接。image

飞书多维表格解析规则

飞书表格数据类型分类

飞书表格数据类型

映射类型

常规

文本

String

单选

String

多选

String

人员

String

群组

不支持

日期

Date

附件

不支持

数字

Long

复选框

Boolean

超链接

String

公式

String

查看引用

不支持

业务

流程

不支持

按钮

不支持

自动编号

Long

电话号码

String

Email

String

地理位置

String

条码

String

进度

Double

货币

Double

评分

Long

高级

双向关联

不支持

单向关联

不支持

创建人

String

修改人

String

创建时间

Date

最后更新时间

Date

人员可扩展字段

部门

String

直属上级

String

工号

String

职务

String

人员类型

String

工作邮箱

String

常见问题

如果您在接入飞书多维表格时出现连接失败的报错提示,请排查是否存在以下问题:

错误原因

解决方案

添加飞书应用授权时,AppKey、AppSecret信息填写有误。image

您需要登录飞书开发者后台,重新获取待授权应用正确的AppKey、AppSecret。image

未在飞书开发者后台的权限管理页面,为飞书自建应用开启所需的API权限。image

您需要开启以下API的权限:

  • 查看、评论、编辑和管理云空间中所有文件。

  • 查看、评论、编辑和管理多维表格。

  • 查看、评论和导出多维表格。

  • 管理应用自身资源。

  • 获取应用信息。

当飞书多维表格的链接分享范围是仅文档协作者可以通过链接访问时,未添加对应的企业自建应用作为文档应用。image

您需要在飞书多维表格的文档编辑页面中,添加对应的企业自建应用为文档应用,具体操作步骤如下图所示。image

当飞书多维表格的链接分享范围是仅文档协作者可以通过链接访问时,在文档编辑页面无法选择对应的自建应用作为文档应用,导致添加文档应用失败。image

当前账户能在文档中添加到对应企业自建应用的前提是:创建应用版本时,在版本详情的可用范围中添加了当前账户。image

若您使用系统默认接入的应用信息,该三方应用可能未更新至最新版本。

您可以前往飞书管理后台进行应用版本更新。image