• English

      • UUID

      Introduction

      In NocoBase, UUID generates a UUID unique identifier.

      It is suitable for cross-system synchronization, public API identifiers, and import or export. It exposes data scale less readily than an auto-incrementing ID. Use Snowflake ID for ordinary internal primary keys, or Nano ID and Sequence when you need shorter or readable identifiers.

      Use cases

      UUID fields are suitable for these business scenarios:

      • Cross-system synchronization IDs
      • Public API identifiers
      • Import and export identifiers
      • Non-sequential public record IDs

      Create and configure

      On the collection's Configure fields page, click Add field and select UUID to create this field.

      Configure a UUID field

      SettingDescription
      Field interfaceThe field interface. UUID uses uuid, which determines how the field is entered and displayed in pages.
      Field display nameThe name displayed for the field, such as UUID, External identifier, or Public ID. Use a name that business users can recognize.
      Field nameThe field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter.
      Field typeThe data-layer type. UUID uses uuid by default.
      Default valueThe default value. When a new record has no value, NocoBase can fill this value automatically.
      Validation rulesValidation rules. It is normally generated by the system and does not need manual validation.
      DescriptionA field description. Record the field meaning, entry requirements, data source, or maintainer.
      Note

      Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.

      Field behavior

      The default behavior of a UUID field is as follows:

      BehaviorDescription
      Default Field interfaceuuid.
      Default Field typeuuid.
      Available Field typesuuid.
      Page componentDisplays a generated UUID value in pages.
      FilteringSupports text and identifier filters where supported by the data source.
      SortingSupports sorting in Table blocks.
      ValidationIt is normally generated by the system and does not need manual validation.

      Edit configuration

      After creation, click Edit beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.

      When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.

      SettingCan be editedDescription
      Field display nameYesChanges the name displayed in the interface without changing the field identifier.
      Field nameNoThe field identifier normally cannot be changed in the edit form after creation.
      Field interfaceConditionalMain-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation.
      Field typeConditionalMain-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first.
      Default valueYesAdjusts the default value for new records.
      Validation rulesYesAdjusts field validation rules.
      DescriptionYesAdds the field meaning, entry requirements, data source, or maintainer.
      Note

      Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.

      Delete field

      Click Delete beside a UUID field to delete it. You can also select multiple fields and delete them in the main data source.

      Deleting a UUID field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.

      Warning

      Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.

      Use in pages

      UUID fields are suitable for system integration and public record identification.

      Use a UUID field in a page

      ScenarioUse
      Details blockDisplay a record UUID.
      Table blockDisplay and filter identifiers.
      APIsUse UUID values as external identifiers.
      WorkflowsPass stable identifiers to external systems.
      • Fields - Learn about field categories and mapping.
      • General collection - Create and manage fields in a collection.
      • Nano ID - Generate short random identifiers.
      • Sequence - Generate readable sequence numbers.