Back to Nocobase

序列

docs/docs/cn/data-sources/field-sequence/index.md

2.1.265.0 KB
Original Source

序列

介绍

在 NocoBase 中,序列(Sequence) 用于生成业务编号。

序列字段适合订单号、合同号、工单号、申请单号等需要可读规则的编号。它和主键不同,更偏业务展示和人工识别。

如果只需要内部唯一标识,使用 Snowflake ID、UUID 或 Nano ID。

适用场景

序列适合这些业务场景:

  • 订单号、合同号
  • 工单号、申请单号
  • 资产编号、设备编号
  • 带前缀、日期或递增规则的编号

创建配置

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

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

:::warning 注意

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

:::

字段特性

序列字段的默认行为如下:

特性说明
默认 Field interfacesequence
默认 Field typestring
可选 Field typestringinteger,以实际序列配置为准。
页面组件通常自动生成,配置编号规则后使用。
筛选支持按编号精确查询或文本筛选。
排序是否适合排序取决于编号规则。
校验依赖序列规则,通常保持唯一。

编辑配置

创建后,点击字段右侧的「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、导入导出和已有数据。删除前先确认字段是否仍被业务配置引用。

:::

页面配置使用

序列字段适合在业务编号和人工检索场景中使用。

场景用途
创建记录自动生成业务编号。
表格区块展示、搜索和筛选编号。
详情区块作为记录的可读标识。
工作流和通知在审批、通知中引用业务编号。

相关链接