Идентификатор таблицы данных

Введение

В NocoBase идентификатор таблицы данных (Table OID) используется для обозначения таблицы данных, к которой относится запись.

Идентификатор таблицы данных часто применяется в таблицах наследования и сценариях, где необходимо различать исходные Collection записей. Это поле в основном используется системными и метаданными.

Для обычных бизнес-таблиц обычно не требуется создавать поле идентификатора таблицы данных вручную.

Сценарии применения

Идентификатор таблицы данных подходит для следующих бизнес-сценариев:

  • Определение исходной таблицы записей таблицы наследования
  • Агрегированное отображение данных из дочерних таблиц
  • Настройка метаданных
  • Системные функции, которым необходимо различать источники Collection

Создание и настройка

На странице «Configure fields» таблицы данных нажмите «Add field» и выберите «Идентификатор таблицы данных», чтобы создать поле идентификатора таблицы данных.

20240512174746

НастройкаОписание
Field interfaceТип интерфейса поля. Идентификатору таблицы данных соответствует tableoid, который определяет способ ввода и отображения данных на странице.
Field display nameНазвание поля, отображаемое в интерфейсе, например «Идентификатор таблицы данных» или «Исходная таблица». Рекомендуется использовать понятное бизнес-пользователям название.
Field nameИмя идентификатора поля, используемое для внутренних ссылок в API, полях связей, правах доступа, рабочих процессах и других компонентах. После создания обычно не изменяется; допускаются только буквы, цифры и символы подчёркивания, при этом имя должно начинаться с буквы.
Field typeТип поля на уровне данных. Идентификатор таблицы данных обычно является полем virtual.
Default valueЗначение по умолчанию. При создании записи оно может подставляться автоматически, если пользователь не указал значение.
Validation rulesОбычно поддерживаются системой.
DescriptionОписание поля. Здесь удобно указать назначение поля, требования к заполнению, источник данных или ответственного за обслуживание.
Внимание

После создания имя поля будет использоваться блоками страниц, правами доступа, рабочими процессами и API. Перед созданием проверьте имя, чтобы избежать дополнительных затрат на изменение конфигурации в дальнейшем.

Свойства поля

Поле идентификатора таблицы данных по умолчанию ведёт себя следующим образом:

СвойствоОписание
Интерфейс Field interface по умолчаниюtableoid.
Тип Field type по умолчаниюvirtual.
Доступный тип Field typevirtual.
Компонент страницыОбычно на странице поле отображается в виде выбора таблицы данных или только для чтения.
ФильтрацияМожет использоваться для фильтрации по исходной таблице данных; это зависит от конфигурации страницы.
СортировкаОбычно не используется для сортировки.
ВалидацияПоддерживается системой или средствами работы с метаданными.

Редактирование настроек

После создания нажмите «Edit» справа от поля, чтобы изменить настройки поля идентификатора таблицы данных. Редактирование поля используется главным образом для изменения способа его отображения и использования в NocoBase, например для изменения отображаемого имени, описания, значения по умолчанию, правил валидации или специальных настроек поля.

Если поле получено из таблицы, уже синхронизированной с основной базой данных, редактирование обычно представляет собой сопоставление поля — отображение поля базы данных как Field type и Field interface в NocoBase.

НастройкаМожно редактироватьОписание
Field display nameДаИзменение отображаемого в интерфейсе имени поля без изменения имени его идентификатора.
Field nameНетИмя идентификатора поля обычно нельзя изменить в форме редактирования после создания.
Field interfaceПри определённых условияхИнтерфейс полей основной базы данных или синхронизированных полей можно изменить при сопоставлении. Это повлияет на способы ввода, отображения и валидации на странице.
Field typeПри определённых условияхТип полей основной базы данных или синхронизированных полей можно изменить при сопоставлении. Перед изменением необходимо убедиться, что существующие данные можно использовать с новым типом.
Default valueДаИзменение значения по умолчанию для новых записей.
Validation rulesДаИзменение правил валидации поля.
DescriptionДаДобавление назначения поля, требований к заполнению, источника данных или ответственного за обслуживание.
Внимание

Переключение Field type или Field interface — это не простое изменение отображаемого имени. Оно влияет на способ хранения данных, компонент ввода, правила валидации, условия фильтрации и использование переменных в рабочих процессах. При большом объёме существующих данных сначала убедитесь, что формат данных соответствует новому типу.

Удаление поля

Нажмите «Delete» справа от поля, чтобы удалить поле идентификатора таблицы данных. В основной базе данных также можно выбрать несколько полей и удалить их одновременно.

При удалении поля идентификатора таблицы данных, созданного в основной базе данных, обычно одновременно удаляются реальный столбец в базе данных и хранящиеся в нём данные. При удалении поля, синхронизированного из базы данных или сопоставленного с внешним источником данных, область воздействия зависит от соответствующего источника данных и происхождения поля.

Предупреждение

Удаление поля может повлиять на блоки страниц, формы, фильтрацию, права доступа, рабочие процессы, API, импорт и экспорт, а также существующие данные. Перед удалением убедитесь, что поле больше не используется в бизнес-конфигурации.

Использование в конфигурации страниц

Поле идентификатора таблицы данных подходит для использования в таблицах наследования и сценариях работы с метаданными.

СценарийНазначение
Блок таблицыОтображение исходной таблицы данных записи.
Блок фильтрацииФильтрация по исходной таблице данных.
Права доступа и рабочие процессыИспользование в качестве условия определения исходной таблицы.
Работа с метаданнымиОбозначение Collection, к которой относится запись.

Связанные ссылки