字段

介绍

在 NocoBase 中,Field(字段)Collection(数据表) 中用来描述数据的一项业务属性,用来描述一条记录里可以保存什么信息,以及这些信息在页面中如何输入、展示、筛选和参与业务逻辑。

定义说明
保存什么数据比如文本、数字、日期、文件、状态、关系、JSON。
页面怎么使用比如用输入框、日期选择器、下拉菜单、附件上传、关系选择器来录入和展示。
如何参与业务能力字段会被页面区块、筛选、排序、权限、工作流、API、数据导入导出等功能使用。

它可以对应:

  • 主数据库里的真实数据库列
  • 外部数据库里的已有数据库列
  • 数据库视图中的字段
  • SQL 查询结果中的字段
  • REST API 响应中的字段
  • 数据表中的关系字段、系统字段或虚拟字段

把它理解为“业务对象的一个属性”。比如:

业务对象对应 Field
客户客户名称、手机号、客户等级、负责人
订单订单编号、订单金额、订单状态、客户
合同合同名称、签约日期、合同附件、审批状态
任务任务标题、截止时间、优先级、执行人
文件文件名、大小、MIME 类型、URL

适用场景

下面按字段分类整理常见适用场景。这里先帮助你判断该选哪一类字段,具体配置、类型映射和注意事项,可以进入对应分类文档继续查看。

字段分类适用场景
文本字段适合保存名称、编号、说明、联系方式、链接地址等内容。
富文本字段适合保存正文、说明文档、处理方案、代码片段等较复杂内容。
数字字段适合保存数量、金额、评分、比例等数值。
日期和时间字段适合保存时间点、日期、时间、外部系统时间戳等内容。
状态和选项字段适合保存固定范围内的值,比如是否启用、订单状态、客户等级、客户标签。
附件字段适合上传文件,或者保存外部文件地址。
关系字段适合表达不同数据表之间的连接,比如订单属于客户、客户拥有订单、用户关联角色。
标识和编码字段适合保存内部主键、外部同步 ID、公开访问标识和业务编号。
几何图形字段适合保存空间或地理信息,比如门店位置、配送路线、服务范围。
系统字段适合保存由 NocoBase 或数据库维护的系统信息,比如 ID、创建时间、创建人、更新时间。
其他字段适合处理排序、公式、JSON 等不直接归入其他分类的字段需求。

字段的 Interface 类型

NocoBase 从 Interface 视角将字段分为了以下几类:

20240512110352

字段数据类型

每个 Field Interface 都有一个默认的数据类型,例如 Interface 为数字(Number)的字段,数据类型默认是 double,但也可以是 float、decimal 等。目前支持的数据类型有:

20240512103733

字段类型映射

主数据库新增字段的流程为:

  1. 选择 Interface 类型
  2. 配置当前 Interface 可选数据类型

20240512172416

外部数据源的字段映射流程为:

  1. 自动根据外部数据库的字段类型,映射相对应的数据类型(Field type)和 UI 类型(Field Interface)。
  2. 按需修改为更合适的数据类型和 Interface 类型

20240512172759