Back to Nocobase

数据表选择器

docs/docs/cn/data-sources/data-modeling/collection-fields/advanced/collection-select.md

2.1.295.1 KB
Original Source

数据表选择器

介绍

在 NocoBase 中,数据表选择器(Collection select) 用于选择一个或多个数据表。

数据表选择器适合插件配置、规则配置、元数据管理等场景。它保存的是数据表标识,而不是业务记录。

如果要选择某张表里的记录,应该使用关系字段,而不是数据表选择器。

适用场景

数据表选择器适合这些业务场景:

  • 插件配置中选择作用数据表
  • 规则配置中指定数据表范围
  • 元数据管理、模板配置
  • 需要引用 Collection 标识的功能配置

创建配置

在数据表的「Configure fields」页面中,点击「Add field」,选择「数据表选择器」可以创建数据表选择器字段。

配置说明
Field interface字段的界面类型。数据表选择器对应 collectionSelect,决定页面中如何录入和展示。
Field display name字段在界面中显示的名称,比如「作用数据表」「目标数据表」「数据范围」。建议使用业务人员能直接理解的名称。
Field name字段标识名称,用于 API、关系字段、权限、工作流等内部引用。创建后通常不再修改,只支持字母、数字和下划线,并且必须以字母开头。
Field type字段在数据层的类型。数据表选择器通常保存数据表标识,存储类型以实际配置为准。
Default value默认值。新增记录时,如果用户没有填写,可以自动带出默认值。
Validation rules校验规则。通常配置必填或选择范围。
Description字段说明。适合写字段含义、填写要求、数据来源或维护人。

:::warning 注意

字段名创建后会被页面区块、权限、工作流和 API 引用。创建前先确认命名,避免后续修改带来配置调整成本。

:::

字段特性

数据表选择器字段的默认行为如下:

特性说明
默认 Field interfacecollectionSelect
默认 Field typestring
可选 Field typestringjson,以实际配置为准。
页面组件编辑模式使用数据表选择组件。
筛选通常不作为业务筛选字段。
排序通常不用于排序。
校验支持必填等基础校验。

编辑配置

创建后,点击字段右侧的「Edit」可以编辑数据表选择器字段配置。编辑字段主要用于调整字段在 NocoBase 中的展示和使用方式,比如修改显示名称、说明、默认值、校验规则或字段专属配置。

如果字段来自主数据库中已经同步的表,编辑时通常是在做字段映射——把数据库字段映射为 NocoBase 的 Field type 和 Field interface。

配置允许编辑说明
Field display name修改字段在界面中的显示名称,不改变字段标识名称。
Field name字段标识名称创建后通常不能在编辑表单中修改。
Field interface条件支持主数据库字段或同步字段在字段映射时可以调整。调整后会影响页面输入、展示和校验方式。
Field type条件支持主数据库字段或同步字段在字段映射时可以调整。调整前需要确认已有数据能否按新类型使用。
Default value调整新增记录时的默认值。
Validation rules调整字段校验规则。
Description补充字段含义、填写要求、数据来源或维护人。

:::warning 注意

切换 Field type 或 Field interface 不等于简单改一个显示名称。它会影响字段的存储方式、输入组件、校验规则、筛选条件和工作流变量使用方式。已有数据较多时,先确认数据格式是否匹配。

:::

删除字段

点击字段右侧的「Delete」可以删除数据表选择器字段。主数据库中还可以勾选多个字段后批量删除。

删除主数据库中新建的数据表选择器字段时,通常会同时删除数据库中的真实列及该列已有数据。删除从数据库同步或外部数据源映射出的字段时,影响范围取决于对应数据源和字段来源。

:::danger 警告

删除字段可能影响页面区块、表单、筛选、权限、工作流、API、导入导出和已有数据。删除前先确认字段是否仍被业务配置引用。

:::

页面配置使用

数据表选择器适合在配置类表单中使用。

场景用途
表单区块选择一个或多个数据表。
详情区块展示已选择的数据表。
插件配置指定功能作用的数据表范围。
工作流或规则作为元数据配置参与逻辑。

相关链接

  • 字段 — 了解字段的作用、分类和映射逻辑
  • 普通表 — 在普通表中创建和管理字段
  • 普通表 — 了解 Collection 的使用方式
  • 关系字段 — 选择某张表中的记录