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

Введение

В NocoBase селектор таблиц данных (Collection select) используется для выбора одной или нескольких таблиц данных.

Селектор таблиц данных подходит для настройки плагинов, правил, управления метаданными и других подобных сценариев. Он сохраняет идентификаторы таблиц данных, а не бизнес-записи.

Если нужно выбрать записи из определённой таблицы, следует использовать поле связи, а не селектор таблиц данных.

Сценарии использования

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

  • выбор целевых таблиц данных в настройках плагина
  • указание диапазона таблиц данных в настройках правил
  • управление метаданными и настройка шаблонов
  • настройка функций, которым требуется ссылка на идентификатор Collection

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

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

20240512174047

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

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

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

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

СвойствоОписание
Интерфейс Field interface по умолчаниюcollectionSelect.
Тип Field type по умолчаниюstring.
Доступные типы Field typestring, json — в зависимости от фактической конфигурации.
Компонент страницыВ режиме редактирования используется компонент выбора таблиц данных.
ФильтрацияОбычно не используется как поле бизнес-фильтрации.
СортировкаОбычно не используется для сортировки.
ПроверкаПоддерживает базовые проверки, например обязательность заполнения.

Редактирование конфигурации

После создания нажмите «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
  • Поле связи — выбор записей из определённой таблицы