Back to Nocobase

Table OID

docs/docs/en/data-sources/data-modeling/collection-fields/system-info/table-oid.md

2.1.295.0 KB
Original Source

Table OID

Introduction

In NocoBase, Table OID identifies the collection to which a record belongs.

It is commonly used by inheritance collections or scenarios that need to distinguish the source collection of a record. It is mainly a system and metadata capability; ordinary business collections usually do not need it.

Use cases

Table OID fields are suitable for these business scenarios:

  • Inheritance collections
  • Distinguishing a record source collection
  • System metadata
  • Collection-level record identification

Create and configure

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

SettingDescription
Field interfaceThe field interface. Table OID uses tableoid, which determines how the field is entered and displayed in pages.
Field display nameThe name displayed for the field, such as Table OID or Source collection. 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. Table OID uses virtual by default.
Default valueThe default value. When a new record has no value, NocoBase can fill this value automatically.
Validation rulesValidation rules. Is normally maintained by the system.
DescriptionA field description. Record the field meaning, entry requirements, data source, or maintainer.

:::warning 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 Table OID field is as follows:

BehaviorDescription
Default Field interfacetableoid.
Default Field typevirtual.
Available Field typesvirtual.
Page componentIs maintained as a virtual system field.
FilteringSupports filtering where supported by system metadata.
SortingIt is usually not used for sorting.
ValidationIs normally maintained by the system.

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.

:::warning 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 Table OID field to delete it. You can also select multiple fields and delete them in the main data source.

Deleting a Table OID 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.

:::danger 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

Table OID fields are suitable for system metadata and inheritance scenarios.

ScenarioUse
Details blockDisplay source-collection metadata where needed.
System configurationDistinguish a record source collection.
WorkflowsUse collection metadata in advanced logic.
APIsReturn collection-source metadata where needed.