docs/docs/cn/data-sources/field-sequence/index.md
在 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 interface | sequence。 |
| 默认 Field type | string。 |
| 可选 Field type | string、integer,以实际序列配置为准。 |
| 页面组件 | 通常自动生成,配置编号规则后使用。 |
| 筛选 | 支持按编号精确查询或文本筛选。 |
| 排序 | 是否适合排序取决于编号规则。 |
| 校验 | 依赖序列规则,通常保持唯一。 |
创建后,点击字段右侧的「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、导入导出和已有数据。删除前先确认字段是否仍被业务配置引用。
:::
序列字段适合在业务编号和人工检索场景中使用。
| 场景 | 用途 |
|---|---|
| 创建记录 | 自动生成业务编号。 |
| 表格区块 | 展示、搜索和筛选编号。 |
| 详情区块 | 作为记录的可读标识。 |
| 工作流和通知 | 在审批、通知中引用业务编号。 |