docs/docs/cn/data-sources/data-modeling/collection-fields/basic/password.md
在 NocoBase 中,密码(Password) 用于录入密码类内容。
密码字段适合保存需要隐藏输入过程的内容,比如外部服务密码、临时访问口令等。它的重点是输入和展示方式,不等同于完整的密钥管理方案。
如果要保存高敏感密钥或长期凭据,优先评估专门的加密、密钥管理或环境变量方案。
密码适合这些业务场景:
在数据表的「Configure fields」页面中,点击「Add field」,选择「密码」可以创建密码字段。
| 配置 | 说明 |
|---|---|
| Field interface | 字段的界面类型。密码对应 password,决定页面中如何录入和展示。 |
| Field display name | 字段在界面中显示的名称,比如「访问密码」「连接口令」「临时口令」。建议使用业务人员能直接理解的名称。 |
| Field name | 字段标识名称,用于 API、关系字段、权限、工作流等内部引用。创建后通常不再修改,只支持字母、数字和下划线,并且必须以字母开头。 |
| Field type | 字段在数据层的类型。密码字段通常使用 password 或 string。 |
| Default value | 默认值。新增记录时,如果用户没有填写,可以自动带出默认值。 |
| Validation rules | 校验规则。可以配置长度、正则表达式或必填。 |
| Description | 字段说明。适合写字段含义、填写要求、数据来源或维护人。 |
:::warning 注意
字段名创建后会被页面区块、权限、工作流和 API 引用。创建前先确认命名,避免后续修改带来配置调整成本。
:::
密码字段的默认行为如下:
| 特性 | 说明 |
|---|---|
| 默认 Field interface | password。 |
| 默认 Field type | password。 |
| 可选 Field type | password、string。 |
| 页面组件 | 编辑模式使用密码输入框。 |
| 筛选 | 通常不建议作为筛选条件使用。 |
| 排序 | 通常不建议用于排序。 |
| 校验 | 支持长度、正则表达式、必填等校验。 |
创建后,点击字段右侧的「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、导入导出和已有数据。删除前先确认字段是否仍被业务配置引用。
:::
密码字段适合在配置表单中录入敏感文本。
| 场景 | 用途 |
|---|---|
| 表单区块 | 以密码输入框录入口令。 |
| 详情区块 | 按掩码或受限方式展示。 |
| 权限 | 限制谁可以查看或编辑密码字段。 |
| 工作流 | 谨慎作为外部请求参数使用。 |